gematria 0.0.2 → 0.0.3

data/.travis.yml

@@ -1,13 +1,10 @@
 ---
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - rbx-18mode
   - rbx-19mode
-  - jruby-18mode
   - jruby-19mode
   - jruby-head
   - ruby-head

data/CHANGELOG.md

@@ -1,21 +1,17 @@
-## v0.0.4 (far future)
+# Changelog
 
-### Todo
+## v0.0.3
 
-* Pluggable/Configurable correspondence tables
-* Pluggable languages (DSL for new languages?)
-
-## v0.0.3 (near future)
-
-### Todo
-
-* Make correspondence table into its own object
-* Investigate feasability and worth of supporting Hebrew gematria
+* Removes support for 1.8.7 (due to encoding problems with Hebrew) (Now compatible with 1.9.2 - head)
+* Adds Hebrew to built-in tables (now includes English and Hebrew)
+* Adds support for custom tables
+* Requires specifying a table when instantiating
+* Changes api to use Gematria::Calculator (this may still not be stable)
 
 ## v0.0.2
 
-* Ruby 1.8.7 compatible
+* Ruby 1.8.7 compatible (Now compatible with 1.8.7 - head)
 
 ## v0.0.1
 
-* initial release
+* initial release

data/README.md

@@ -1,12 +1,10 @@
-# Gematria [![Build Status](https://travis-ci.org/adamzaninovich/gematria.png?branch=master)](https://travis-ci.org/adamzaninovich/gematria)
+# Gematria (גימטריא) [![Build Status](https://travis-ci.org/adamzaninovich/gematria.png?branch=master)](https://travis-ci.org/adamzaninovich/gematria)
 
-A Ruby gem that calculates Gematria. This version supports English text and uses a mispar hechrachi style correspondence table, but in future versions there may be support for more languages as well as user configurable correspondence tables. The gem supports raw conversion to number (by simple summation), mapping (breakdown of individual numbers), and reduction to a single digit (mispar katan mispari).
+A Ruby gem that calculates Gematria. The gem comes with built-in correspondence tables for English and Hebrew text, but allows for user-configurable tables. The gem supports raw conversion to number (by simple summation), mapping (breakdown of individual numbers), and reduction to a single digit (mispar katan mispari).
 
-The current correspondence table is as follows:
+The included correspondence tables are as follows:
 
-     a:1    b:2    c:3    d:4    e:5    f:6    g:7    h:8    i:9
-     j:10   k:20   l:30   m:40   n:50   o:60   p:70   q:80   r:90
-     s:100  t:200  u:300  v:400  w:500  x:600  y:700  z:800
+![Correspondence Tables](https://dl.dropbox.com/u/2436753/github/gematria/correspondence_tables.png)
 
 ## Documentation
 
@@ -28,17 +26,29 @@ Or install it yourself as:
 
 ## Usage
 
-    name = Gematria::English.new("Adam")
+    name = Gematria::Calculator.new("Adam", :english)
     name.converted          # => 46
     name.mapped.join(" + ") # => "1 + 4 + 1 + 40"
     name.reduced            # => 1
 
-    gematria = Gematria::English.new("Gematria is fun!")
+    gematria = Gematria::Calculator.new("Gematria is fun!", english)
     gematria.converted      # => 818
     gematria.mapped         # => [7, 5, 40, 1, 200, 90, 9, 1, 0, 9, 100, 0, 6, 300, 50, 0]
 
-    alphabet = Gematria::English.new("abcdefghijklmnopqrstuvwxyz")
-    alphabet.converted == 4095 # => true
+    alephbet = Gematria::Calculator.new('אבגדהוזחטיכלמנסעפצקרשתךםןףץ', :hebrew)
+    alephbet.converted == 4995 # => true
+
+    # defining a custom table
+
+    Gematria::Tables.add_table :mini, 'a' => 1, 'b' => 10, 'c' => 100
+    abcd = Gematria::Calculator.new('abcd', :mini)
+    abcd.mapped    # => [1,10,100,0]
+    abcd.converted # => 111
+    abcd.reduced   # => 3
+
+## Issues
+
+If you find any issues or errors with this gem, please report them on [Github Issues](http://github.com/adamzaninovich/gematria/issues).
 
 ## Contributing
 

data/ROADMAP.md

@@ -0,0 +1,9 @@
+# Roadmap
+
+## Near future
+
+* Ability to configure global default table so as to not have to specify a table name with every new instance
+
+## Far future
+
+* Nothing for now. [Suggestions](http://github.com/adamzaninovich/gematria/issues) are welcome and encouraged.

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gematria.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Gematria::VERSION
   gem.authors       = ["Adam Zaninovich"]
   gem.email         = ["adam.zaninovich@gmail.com"]
-  gem.description   = %q{A Ruby gem that calculates Gematria. This version supports English text and uses a mispar hechrachi style correspondence table, but in future versions there may be support for more languages as well as user configurable correspondence tables. The gem supports raw conversion to number (by simple summation), mapping (breakdown of individual numbers), and reduction to a single digit (mispar katan mispari).}
+  gem.description   = %q{A Ruby gem that calculates Gematria. The gem comes with built-in correspondence tables for English and Hebrew text, but allows for user-configurable tables. The gem supports raw conversion to number (by simple summation), mapping (breakdown of individual numbers), and reduction to a single digit (mispar katan mispari).}
   gem.summary       = %q{A Ruby gem that calculates Gematria}
   gem.homepage      = "http://github.com/adamzaninovich/gematria"
 

data/lib/gematria.rb

@@ -1,5 +1,22 @@
+# -*- encoding : utf-8 -*-
 require "gematria/version"
-require "gematria/english"
+require "gematria/tables"
+require "gematria/calculator"
 
 module Gematria
-end
+  # Add built-in tables
+
+  # applies "mispar hechrachi" method to English alphabet (http://www.inner.org/gematria/fourways.php)
+  Tables.add_table :english, {
+    'a' => 1,   'b' => 2,   'c' => 3,   'd' => 4,   'e' => 5,   'f' => 6,   'g' => 7,   'h' => 8,   'i' => 9,
+    'j' => 10,  'k' => 20,  'l' => 30,  'm' => 40,  'n' => 50,  'o' => 60,  'p' => 70,  'q' => 80,  'r' => 90,
+    's' => 100, 't' => 200, 'u' => 300, 'v' => 400, 'w' => 500, 'x' => 600, 'y' => 700, 'z' => 800
+  }
+
+  # Mispar gadol table
+  Tables.add_table :hebrew, {
+    'א' => 1,   'ב' => 2,   'ג' => 3,   'ד' => 4,   'ה' => 5,   'ו' => 6,   'ז' => 7,   'ח' => 8,   'ט' => 9,
+    'י' => 10,  'כ' => 20,  'ל' => 30,  'מ' => 40,  'נ' => 50,  'ס' => 60,  'ע' => 70,  'פ' => 80,  'צ' => 90,
+    'ק' => 100, 'ר' => 200, 'ש' => 300, 'ת' => 400, 'ך' => 500, 'ם' => 600, 'ן' => 700, 'ף' => 800, 'ץ' => 900
+  }
+end

data/lib/gematria/{english.rb → calculator.rb}

@@ -1,11 +1,16 @@
+# -*- encoding : utf-8 -*-
 module Gematria
-  class English < Struct.new(:text)
-    # applies "mispar hechrachi" method to English alphabet (http://www.inner.org/gematria/fourways.php)
-    CORRESPONDENCE_TABLE = {
-      :a => 1,   :b => 2,   :c => 3,   :d => 4,   :e => 5,   :f => 6,   :g => 7,   :h => 8,   :i => 9,
-      :j => 10,  :k => 20,  :l => 30,  :m => 40,  :n => 50,  :o => 60,  :p => 70,  :q => 80,  :r => 90,
-      :s => 100, :t => 200, :u => 300, :v => 400, :w => 500, :x => 600, :y => 700, :z => 800
-    }
+  class Calculator
+    
+    attr_reader :text, :table
+    def initialize(text, table_name=nil)
+      @text = text
+      if table_name.is_a? Symbol
+        @table = Tables.fetch(table_name)
+      else
+        @table = {}
+      end
+    end
 
     # Gets an array of the values for each character of text.
     #
@@ -40,8 +45,9 @@ module Gematria
     end
 
     private
+    
     def lookup_char(char)
-      CORRESPONDENCE_TABLE.fetch(char.downcase.to_sym, 0)
+      table.fetch(char.downcase, 0)
     end
 
     def do_reduction_on(number)
@@ -53,4 +59,4 @@ module Gematria
     end
 
   end
-end
+end

data/lib/gematria/tables.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+module Gematria
+  module Tables
+    TABLES = {}
+
+    module_function
+
+    # Adds a table to the table store. A valid table must be a Hash with single character string keys and numerical values. 
+    # A table that is not a Hash will raise a TypeError. The table name will be converted to a Symbol.
+    #
+    #     Tables.add_table :mini_english, 'a' => 1, 'b' => 2, 'c' => 3
+    #
+    # @param name [#to_sym] table name
+    # @param table [Hash{String => Number}] table of characters pointing to corresponding values
+    def add_table(name, table)
+      if table.is_a? Hash
+        TABLES[name.to_sym] = table
+      else
+        raise TypeError, 'Invalid table format' 
+      end     
+    end
+
+    # Fetches specified table
+    #
+    #     Tables.fetch(:mini_english) # => {'a'=>1,'b'=>2,'c'=>3}
+    #
+    # @param key [Symbol] table name as a Symbol
+    # @return [Hash{String => Number}]
+    def fetch(key)
+      TABLES.fetch(key)
+    end
+
+    # Fetches specified table (delegates to #fetch)
+    #
+    #     Tables[:mini_english] # => {'a'=>1,'b'=>2,'c'=>3}
+    #
+    # @param key [Symbol] table name as a Symbol
+    # @return [Hash{String => Number}]
+    def [](key)
+      fetch(key)
+    end
+
+  end
+end

data/lib/gematria/version.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Gematria
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/gematria/calculator_spec.rb

@@ -0,0 +1,95 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Gematria::Calculator do
+  describe "with no table specified" do
+    it "is instantiated with text and provides access to that text" do
+      gematria = Gematria::Calculator.new('mytext')
+      expect(gematria.text).to eq 'mytext'
+    end
+
+    describe "#mapped" do
+      it "returns an array of values for each character in text" do
+        gematria = Gematria::Calculator.new('abc')
+        expect(gematria.mapped).to eq [0,0,0]
+      end
+    end
+
+    describe "#converted" do
+      it "returns the sum of the letter values" do
+        gematria = Gematria::Calculator.new('abc')
+        expect(gematria.converted).to eq 0
+      end
+    end
+
+    describe "#reduced" do
+      it "returns a single digit" do
+        gematria = Gematria::Calculator.new('abc')
+        expect(gematria.reduced).to eq 0
+      end
+    end
+  end
+
+  describe "with English table specified" do
+    describe "#mapped" do
+      it "returns an array of values for each character in text" do
+        gematria = Gematria::Calculator.new('abc', :english)
+        expect(gematria.mapped).to eq [1,2,3]
+      end
+    end
+
+    describe "#converted" do
+      it "returns the sum of the letter values" do
+        gematria = Gematria::Calculator.new('abc', :english)
+        expect(gematria.converted).to eq 6
+      end
+    end
+
+    describe "#reduced" do
+      context "when converted value is a single digit" do
+        it "returns a single digit" do
+          gematria = Gematria::Calculator.new('abc', :english)
+          expect(gematria.reduced).to eq 6
+        end
+      end
+      context "when converted value is more than one digit" do
+        it "returns a single digit" do
+          gematria = Gematria::Calculator.new('abcdefghijklmnopqrstuvwxyz', :english)
+          expect(gematria.reduced).to eq 9 # 4095 -> 18 -> 9
+        end
+      end
+    end
+  end
+
+  describe "with Hebrew table specified" do
+    describe "#mapped" do
+      it "returns an array of values for each character in text" do
+        abg = Gematria::Calculator.new('אבג', :hebrew)
+        expect(abg.mapped).to eq [1,2,3]
+      end
+    end
+
+    describe "#converted" do
+      it "returns the sum of the letter values" do
+        alephbet = Gematria::Calculator.new('אבגדהוזחטיכלמנסעפצקרשתךםןףץ', :hebrew)
+        expect(alephbet.converted).to eq 4995
+      end
+    end
+
+    describe "#reduced" do
+      context "when converted value is a single digit" do
+        it "returns a single digit" do
+          abg = Gematria::Calculator.new('אבג', :hebrew)
+          expect(abg.reduced).to eq 6
+        end
+      end
+      context "when converted value is more than one digit" do
+        it "returns a single digit" do
+          alephbet = Gematria::Calculator.new('אבגדהוזחטיכלמנסעפצקרשתךםןףץ', :hebrew)
+          expect(alephbet.reduced).to eq 9 # 4995 -> 27 -> 9
+        end
+      end
+    end
+  end
+
+end

data/spec/gematria/tables_spec.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe Gematria::Tables do
+	it "has a hash to store the tables" do
+		expect(Gematria::Tables::TABLES).to be_a Hash
+	end
+
+	describe "#add_table" do
+		context "when table is valid" do
+			it "adds the table to the TABLES store" do
+				Gematria::Tables.add_table :valid, 'a'=>1,'b'=>2
+				expect(Gematria::Tables::TABLES).to include valid: {'a'=>1,'b'=>2}
+			end
+		end
+		context "when table is invalid" do
+			it "raises a TypeError" do
+				expect {
+					Gematria::Tables.add_table :invalid, [['a',1],['b',2]]
+				}.to raise_error TypeError
+			end
+		end
+	end
+
+	describe "#fetch" do
+		context "when table exists" do
+			it "returns the table" do
+				Gematria::Tables.add_table :mytable, 'a'=>1
+				expect(Gematria::Tables.fetch(:mytable)).to eq 'a'=>1
+			end
+		end
+		context "when table does not exist" do
+			it "raises a KeyError" do
+				expect {
+					Gematria::Tables.fetch(:non_existant_table)
+				}.to raise_error KeyError
+			end
+		end
+	end
+
+	describe "#[]" do
+		it "delegates to #fetch" do
+			Gematria::Tables.should_receive(:fetch).with(:key)
+			Gematria::Tables[:key]
+		end
+	end
+
+end

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
+# -*- encoding : utf-8 -*-
+require 'rubygems'
 require 'rspec'
 require 'gematria'

metadata

@@ -1,99 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gematria
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Adam Zaninovich
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-26 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: A Ruby gem that calculates Gematria. This version supports English text and uses a mispar hechrachi style correspondence table, but in future versions there may be support for more languages as well as user configurable correspondence tables. The gem supports raw conversion to number (by simple summation), mapping (breakdown of individual numbers), and reduction to a single digit (mispar katan mispari).
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby gem that calculates Gematria. The gem comes with built-in correspondence
+  tables for English and Hebrew text, but allows for user-configurable tables. The
+  gem supports raw conversion to number (by simple summation), mapping (breakdown
+  of individual numbers), and reduction to a single digit (mispar katan mispari).
+email:
 - adam.zaninovich@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
 - gematria.gemspec
 - lib/gematria.rb
-- lib/gematria/english.rb
+- lib/gematria/calculator.rb
+- lib/gematria/tables.rb
 - lib/gematria/version.rb
-- spec/gematria/english_spec.rb
+- spec/gematria/calculator_spec.rb
+- spec/gematria/tables_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/adamzaninovich/gematria
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Ruby gem that calculates Gematria
-test_files: 
-- spec/gematria/english_spec.rb
+test_files:
+- spec/gematria/calculator_spec.rb
+- spec/gematria/tables_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/gematria/english_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe Gematria::English do
-  it "is instantiated with text and provides access to that text" do
-    gematria = Gematria::English.new('mytext')
-    expect(gematria.text).to eq 'mytext'
-  end
-
-  describe "#mapped" do
-    it "returns an array of values for each character in text" do
-      gematria = Gematria::English.new('abc')
-      expect(gematria.mapped).to eq [1,2,3]
-    end
-  end
-
-  describe "#converted" do
-    it "returns the sum of the letter values" do
-      gematria = Gematria::English.new('abc')
-      expect(gematria.converted).to eq 6
-    end
-  end
-
-  describe "#reduced" do
-    context "when converted value is a single digit" do
-      it "returns a single digit" do
-        gematria = Gematria::English.new('abc')
-        expect(gematria.reduced).to eq 6
-      end
-    end
-    context "when converted value is more than one digit" do
-      it "returns a single digit" do
-        gematria = Gematria::English.new('abcdefghijklmnopqrstuvwxyz')
-        expect(gematria.reduced).to eq 9 # 4095 -> 18 -> 9
-      end
-    end
-  end
-end