gematria 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.0.5
+
+* Improved documentation
+* `Gematria::Tables` is now an instance of `Gematria::TableManager` rather than a method bucket
+
 ## v0.0.4
 
 * Ability to set global table so as to not have to specify a table name with every new instance

data/README.md

@@ -35,7 +35,7 @@ Or install it yourself as:
     gematria.converted      # => 818
     gematria.mapped         # => [7, 5, 40, 1, 200, 90, 9, 1, 0, 9, 100, 0, 6, 300, 50, 0]
 
-Settings a global table
+Setting a global table
 
     Gematria::Tables.set_table :hebrew
     alephbet = Gematria::Calculator.new 'אבגדהוזחטיכלמנסעפצקרשתךםןףץ'

data/lib/gematria.rb

@@ -1,9 +1,13 @@
 # -*- encoding : utf-8 -*-
 require "gematria/version"
-require "gematria/tables"
+require "gematria/table_manager"
 require "gematria/calculator"
 
+# A Ruby gem that calculates Gematria
 module Gematria
+  # initialize TableManager
+  Tables = TableManager.new
+
   # Add built-in tables
 
   # applies "mispar hechrachi" method to English alphabet (http://www.inner.org/gematria/fourways.php)

data/lib/gematria/calculator.rb

@@ -1,8 +1,13 @@
 # -*- encoding : utf-8 -*-
 module Gematria
+  # Performs the gematria calculations
   class Calculator
     
     attr_reader :text, :table
+
+    # Takes the text to be converted and an optional table name
+    # @param text [String] text to be converted
+    # @param table_name [Symbol] optional table name to use in conversion. If none is specified, the global will be used (see Gematria::Tables#set_table) 
     def initialize(text, table_name=nil)
       @text = text
       if table_name.is_a? Symbol
@@ -13,20 +18,18 @@ module Gematria
     end
 
     # Gets an array of the values for each character of text.
-    #
+    # @example
     #   name = Gematria::English.new("Adam")
     #   name.mapped # => [1, 4, 1, 40]
-    #
     # @return [Array<Number>] numerical values attributed to each character of the original text
     def mapped
       text.each_char.map { |c| lookup_char c }
     end
 
     # Gets the summed gematria number of text.
-    #
+    # @example
     #   name = Gematria::English.new("Adam")
     #   name.converted # => 46
-    #
     # This uses <tt>mapped</tt> internally and sums the results.
     # @return [Number] sum of the values of each character
     def converted
@@ -34,11 +37,10 @@ module Gematria
     end
 
     # Recursively reduces the <tt>converted</tt> value to a single digit mispar katan mispari style.
-    #
+    # @example
     #   name = Gematria::English.new("Adam")
     #   name.reduced # => 1
-    #
-    # For example: "Adam" -> 46 -> 10 -> 1
+    #   # "Adam" -> 46 -> 10 -> 1
     # @return [Number] single digit from reduction of <tt>converted</tt> value
     def reduced
       do_reduction_on converted

data/lib/gematria/{tables.rb → table_manager.rb}

@@ -1,64 +1,57 @@
 # -*- encoding : utf-8 -*-
 module Gematria
-  module Tables
-    # Stores available tables
-    TABLES = {}
+  # Manages a set of tables that can be used to do the gematria conversion
+  class TableManager
 
-    # Sets the global current table
-    #
-    #     Tables.set_table(:english)
-    #     Tables.current # => {'a'=>1,'b'=>2,...}
-    #
+    attr_reader :tables
+
+    def initialize
+      @tables = {}
+      @current = nil
+    end
+
+    # Sets the current table
+    # @example
+    #   Gematria::Tables.set_table(:english)
     # @param table_name [Symbol] table name
     # @return [Symbol] table name
-    def self.set_table(table_name)
+    def set_table(table_name)
       @current = table_name
     end
 
     # Gets the currently selected table
-    #
-    #     Tables.set_table(:english)
-    #     Tables.current # => {'a'=>1,'b'=>2,...}
-    #
+    # @example After setting the table to <tt>:english</tt> with the <tt>#set_table</tt> method
+    #   Gematria::Tables.current # => {'a'=>1,'b'=>2,...}
     # @return [Hash{String => Number}]
-    def self.current
+    def 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.
-    #
-    #     Tables.add_table :mini_english, 'a' => 1, 'b' => 2, 'c' => 3
-    #
+    # @example
+    #   Gematria::Tables.add_table :mini_english, 'a' => 1, 'b' => 2, 'c' => 3
+    # @raise [TypeError] if table is not a valid Hash
     # @param name [#to_sym] table name
     # @param table [Hash{String => Number}] table of characters pointing to corresponding values
-    def self.add_table(name, table)
+    # @return [void]
+    def add_table(name, table)
       if table.is_a? Hash
-        TABLES[name.to_sym] = table
+        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 self.fetch(key)
-      TABLES.fetch(key, {})
-    end
-
-    # Fetches specified table (delegates to #fetch)
-    #
-    #     Tables[:mini_english] # => {'a'=>1,'b'=>2,'c'=>3}
-    #
+    # @example
+    #   Gematria::Tables.fetch(:mini_english) # => {'a'=>1,'b'=>2,'c'=>3}
     # @param key [Symbol] table name as a Symbol
     # @return [Hash{String => Number}]
-    def self.[](key)
-      fetch(key)
+    def fetch(key)
+      tables.fetch(key, {})
     end
+    alias :[] :fetch
 
   end
 end

data/lib/gematria/version.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Gematria
-  VERSION = "0.0.4"
+	# Official version of gematria gem
+  VERSION = "0.0.5"
 end

data/spec/gematria/{tables_spec.rb → table_manager_spec.rb}

@@ -2,10 +2,10 @@
 require 'spec_helper'
 
 module Gematria
+	describe TableManager do
 
-	describe Tables do
 		it "has a hash to store the tables" do
-			expect(Tables::TABLES).to be_a Hash
+			expect(Tables.tables).to be_a Hash
 		end
 
 		describe "#set_table" do
@@ -38,7 +38,7 @@ module Gematria
 			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}
+					expect(Tables.tables).to include valid: {'a'=>1,'b'=>2}
 				end
 			end
 			context "when table is invalid" do
@@ -50,27 +50,21 @@ module Gematria
 			end
 		end
 
-		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
+		%w{fetch []}.each do |method_name|
+			describe "##{method_name}" do
+				context "when table exists" do
+					it "returns the table" do
+						Tables.add_table :mytable, 'a'=>1
+						expect(Tables.send method_name, :mytable).to eq 'a'=>1
+					end
 				end
-			end
-			context "when table does not exist" do
-				it "returns an empty hash" do
-					expect(Tables.fetch :non_existant_table).to eq({})
+				context "when table does not exist" do
+					it "returns an empty hash" do
+						expect(Tables.send method_name, :non_existant_table).to eq({})
+					end
 				end
 			end
 		end
 
-		describe "#[]" do
-			it "delegates to #fetch" do
-				Tables.should_receive(:fetch).with(:key)
-				Tables[:key]
-			end
-		end
-
 	end
-
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gematria
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,10 +64,10 @@ files:
 - gematria.gemspec
 - lib/gematria.rb
 - lib/gematria/calculator.rb
-- lib/gematria/tables.rb
+- lib/gematria/table_manager.rb
 - lib/gematria/version.rb
 - spec/gematria/calculator_spec.rb
-- spec/gematria/tables_spec.rb
+- spec/gematria/table_manager_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/adamzaninovich/gematria
 licenses: []
@@ -95,6 +95,6 @@ specification_version: 3
 summary: A Ruby gem that calculates Gematria
 test_files:
 - spec/gematria/calculator_spec.rb
-- spec/gematria/tables_spec.rb
+- spec/gematria/table_manager_spec.rb
 - spec/spec_helper.rb
 has_rdoc: