gematria 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.0.4
+
+* Ability to set global table so as to not have to specify a table name with every new instance
+
 ## v0.0.3
 
 * Removes support for 1.8.7 (due to encoding problems with Hebrew) (Now compatible with 1.9.2 - head)

data/README.md

@@ -26,22 +26,25 @@ Or install it yourself as:
 
 ## Usage
 
-    name = Gematria::Calculator.new("Adam", :english)
+    name = Gematria::Calculator.new "Adam", :english
     name.converted          # => 46
     name.mapped.join(" + ") # => "1 + 4 + 1 + 40"
     name.reduced            # => 1
 
-    gematria = Gematria::Calculator.new("Gematria is fun!", english)
+    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]
 
-    alephbet = Gematria::Calculator.new('אבגדהוזחטיכלמנסעפצקרשתךםןףץ', :hebrew)
+Settings a global table
+
+    Gematria::Tables.set_table :hebrew
+    alephbet = Gematria::Calculator.new 'אבגדהוזחטיכלמנסעפצקרשתךםןףץ'
     alephbet.converted == 4995 # => true
 
-    # defining a custom table
+Defining a custom table
 
     Gematria::Tables.add_table :mini, 'a' => 1, 'b' => 10, 'c' => 100
-    abcd = Gematria::Calculator.new('abcd', :mini)
+    abcd = Gematria::Calculator.new 'abcd', :mini
     abcd.mapped    # => [1,10,100,0]
     abcd.converted # => 111
     abcd.reduced   # => 3
@@ -83,4 +86,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/ROADMAP.md

@@ -2,7 +2,7 @@
 
 ## Near future
 
-* Ability to configure global default table so as to not have to specify a table name with every new instance
+* Nothing for now.
 
 ## Far future
 

data/lib/gematria/calculator.rb

@@ -8,7 +8,7 @@ module Gematria
       if table_name.is_a? Symbol
         @table = Tables.fetch(table_name)
       else
-        @table = {}
+        @table = Tables.current
       end
     end
 

data/lib/gematria/tables.rb

@@ -1,9 +1,29 @@
 # -*- encoding : utf-8 -*-
 module Gematria
   module Tables
+    # Stores available tables
     TABLES = {}
 
-    module_function
+    # Sets the global current table
+    #
+    #     Tables.set_table(:english)
+    #     Tables.current # => {'a'=>1,'b'=>2,...}
+    #
+    # @param table_name [Symbol] table name
+    # @return [Symbol] table name
+    def self.set_table(table_name)
+      @current = table_name
+    end
+
+    # Gets the currently selected table
+    #
+    #     Tables.set_table(:english)
+    #     Tables.current # => {'a'=>1,'b'=>2,...}
+    #
+    # @return [Hash{String => Number}]
+    def self.current
+      fetch(@current)
+    end
 
     # 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.
@@ -12,7 +32,7 @@ module Gematria
     #
     # @param name [#to_sym] table name
     # @param table [Hash{String => Number}] table of characters pointing to corresponding values
-    def add_table(name, table)
+    def self.add_table(name, table)
       if table.is_a? Hash
         TABLES[name.to_sym] = table
       else
@@ -26,8 +46,8 @@ module Gematria
     #
     # @param key [Symbol] table name as a Symbol
     # @return [Hash{String => Number}]
-    def fetch(key)
-      TABLES.fetch(key)
+    def self.fetch(key)
+      TABLES.fetch(key, {})
     end
 
     # Fetches specified table (delegates to #fetch)
@@ -36,7 +56,7 @@ module Gematria
     #
     # @param key [Symbol] table name as a Symbol
     # @return [Hash{String => Number}]
-    def [](key)
+    def self.[](key)
       fetch(key)
     end
 

data/lib/gematria/version.rb

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

data/spec/gematria/calculator_spec.rb

@@ -2,35 +2,29 @@
 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
+  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
+  context "when no table is specified" do
+    context "when a table has been set" do
+      it "uses the currently selected table" do
+        Gematria::Tables.set_table(:english)
         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
+        expect(gematria.mapped).to eq [1,2,3]
       end
     end
-
-    describe "#reduced" do
-      it "returns a single digit" do
+    context "when no table has been set" do
+      it "uses an empty table (all zeros)" do
+        Gematria::Tables.set_table(nil)
         gematria = Gematria::Calculator.new('abc')
-        expect(gematria.reduced).to eq 0
+        expect(gematria.mapped).to eq [0,0,0]
       end
-    end
+    end    
   end
 
-  describe "with English table specified" do
+  context "when English table is specified" do
     describe "#mapped" do
       it "returns an array of values for each character in text" do
         gematria = Gematria::Calculator.new('abc', :english)
@@ -61,17 +55,19 @@ describe Gematria::Calculator do
     end
   end
 
-  describe "with Hebrew table specified" do
+  describe "when Hebrew table is specified" do
+    before { Gematria::Tables.set_table :hebrew }
+
     describe "#mapped" do
       it "returns an array of values for each character in text" do
-        abg = Gematria::Calculator.new('אבג', :hebrew)
+        abg = Gematria::Calculator.new('אבג')
         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)
+        alephbet = Gematria::Calculator.new('אבגדהוזחטיכלמנסעפצקרשתךםןףץ')
         expect(alephbet.converted).to eq 4995
       end
     end
@@ -79,13 +75,13 @@ describe Gematria::Calculator do
     describe "#reduced" do
       context "when converted value is a single digit" do
         it "returns a single digit" do
-          abg = Gematria::Calculator.new('אבג', :hebrew)
+          abg = Gematria::Calculator.new('אבג')
           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)
+          alephbet = Gematria::Calculator.new('אבגדהוזחטיכלמנסעפצקרשתךםןףץ')
           expect(alephbet.reduced).to eq 9 # 4995 -> 27 -> 9
         end
       end

data/spec/gematria/tables_spec.rb

@@ -1,48 +1,76 @@
 # -*- 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
+module Gematria
+
+	describe Tables do
+		it "has a hash to store the tables" do
+			expect(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}
+		describe "#set_table" do
+			it "assigns a table to @current" do
+				Tables.set_table(:english)
+				expect(Tables.instance_variable_get :@current).to eq :english
 			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
+
+		describe "#current" do
+			context "when a table has been selected" do
+				it "returns the previously selected table" do
+					Tables.set_table(:hebrew)
+					expect(Tables.current).to eq Tables.fetch(:hebrew)
+				end
+			end
+			context "when a table has not been selected" do
+				before do
+					if Tables.instance_variable_defined? :@current
+						Tables.instance_variable_set :@current, nil
+					end
+				end
+				it "returns an empty hash" do
+					expect(Tables.current).to eq({})
+				end
 			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
+		describe "#add_table" do
+			context "when table is valid" do
+				it "adds the table to the TABLES store" do
+					Tables.add_table :valid, 'a'=>1,'b'=>2
+					expect(Tables::TABLES).to include valid: {'a'=>1,'b'=>2}
+				end
+			end
+			context "when table is invalid" do
+				it "raises a TypeError" do
+					expect {
+						Tables.add_table :invalid, [['a',1],['b',2]]
+					}.to raise_error TypeError
+				end
 			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
+
+		describe "#fetch" do
+			context "when table exists" do
+				it "returns the table" do
+					Tables.add_table :mytable, 'a'=>1
+					expect(Tables.fetch(:mytable)).to eq 'a'=>1
+				end
+			end
+			context "when table does not exist" do
+				it "returns an empty hash" do
+					expect(Tables.fetch :non_existant_table).to eq({})
+				end
 			end
 		end
-	end
 
-	describe "#[]" do
-		it "delegates to #fetch" do
-			Gematria::Tables.should_receive(:fetch).with(:key)
-			Gematria::Tables[:key]
+		describe "#[]" do
+			it "delegates to #fetch" do
+				Tables.should_receive(:fetch).with(:key)
+				Tables[:key]
+			end
 		end
+
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gematria
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: