cheddar 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15dc85d5c075af82c10d629eec87942083ed29db
-  data.tar.gz: 0bc5241b7d3aadd2e297b6e549e280a925556355
+  metadata.gz: 7e8151013fa487bc106e835cac6b8ac23e4e13e9
+  data.tar.gz: f4de428cc0e68549f76f6e1a79a067f1311c64a8
 SHA512:
-  metadata.gz: 5f8694ca7425d0c2afe3293ef7ffebdf612d3698f0bbc960359c021234117d11ab4a125e52dc488f987053ac6155b95fa178dd9088cb9f3778b1e1d88ee68a5b
-  data.tar.gz: 801490639ce8ee9cdc7d58406c0e0ad0a48eb1ab1605e36eb45ecc5534cad42c5028c01815c4e5af7d6053d1259f4bd1c1eb9d3a176cf8833fd0d7c61aa50779
+  metadata.gz: 2c4e72de10182b35e8d05ca5135c1a1201d16d29bd35774842ddbb150b6de1ec140c0dd5dc5641fccc302b78d1ebeabcc62dcc10f58748a9035f9d1b7172d055
+  data.tar.gz: 757311abc64a95866954612f23eca49e1330829bea585ab9c7dda82e30efe87e73b81e2f03f49b5725523b67aa215f2b90d868253360577c598898727b61293a

data/lib/cheddar.rb

@@ -1,66 +1,140 @@
+#
+# The +Cheddar+ class converts human input strings to numbers.
+#
 class Cheddar
-
   attr_accessor :enabled_dialects
 
-  def initialize
+  def initialize #:notnew: nothing special going on here
     @mapping = {}
     @enabled_dialects = []
   end
 
+  #
+  # Get the list of currently available dialects
+  #
   def available_dialects
-    @mapping.keys
+    mapping.keys
   end
 
+  #
+  # Add human_to_number method to the String class
+  #
   def cheddarize
     String.send(:define_method, :human_to_number) do
       Cheddar.parse(self)
     end
   end
 
+  # Define a word to number mapping for the current dialect
+  #
+  # :call-seq:
+  #   define(word, number) -> number
+  #
+  # ==== Parameters
+  #
+  # * +word+ - string to be mapped to number
+  # * +number+ - Number to return when an occurrence of string is found
+  #
   def define(word, number)
-    @mapping[@current_dialect] ||= {}
-    @mapping[@current_dialect][word] = number
+    mapping[current_dialect] ||= {}
+    mapping[current_dialect][word] = number
   end
 
+  # Set the current dialect being operated on when using the define method
+  # and optionally pass in a block to define the dialect
+  #
+  # :call-seq:
+  #   dialect(dialect_name) -> {'word' => value...}
+  #   dialect(dialect_name){ block } -> {'word' => value...}
+  #
+  # ==== Parameters
+  #
+  # * +dialect_name+ - symbol for dialect being worked on
+  #
+  # ==== Example
+  #
+  #   ch = Cheddar.new
+  #   ch.dialect(:example) do |d|
+  #     d.define 'e', 20
+  #   end
+  #   ch.parse('1 e') #=> 20
+  #
   def dialect(dia)
-    @current_dialect = dia
+    self.current_dialect = dia
     yield self.class.instance if block_given?
-    @mapping[dia]
+    mapping[dia]
   end
 
+  #
+  # convert the given string to it's numeric equivalent
+  #
+  # ==== Parameters
+  #
+  # * +string+ - string to be parsed as a number
+  #
   def parse(string)
     str = string.downcase
 
-    @enabled_dialects.each do |d|
-      @mapping[d].each do |num_name, value|
-        unless num_name.is_a? Regexp
-          str.gsub!(Regexp.new("(^|\s)#{num_name.to_s}($|\s)"), "* #{value}")
-        else
-          str.gsub!(num_name, "* #{value}")
-        end
-      end
+    enabled_dialects.each do |d|
+      mapping[d].each { |num_name, value| apply_mapping(num_name, value, str) }
     end
 
     str.gsub!(/[^\d\*\.]/, '')
 
-    eval(str)
+    Kernel.eval(str)
   end
 
+  #
+  # Add human_to_number method to the String class using the Cheddar singleton
+  #
   def self.cheddarize
-    self.instance.cheddarize
+    instance.cheddarize
   end
 
+  # Get/Configure the Cheddar instance
+  #
+  # :call-seq:
+  #   Cheddar.config -> instance
+  #   Cheddar.config { block } -> instance
+  #
+  # ==== Example
+  #
+  #   Cheddar.config do |c|
+  #     ch.dialect(:example) do |d|
+  #       d.define 'e', 20
+  #     end
+  #   end
+  #
   def self.config
-    yield self.instance if block_given?
-    self.instance
+    yield instance if block_given?
+    instance
   end
 
+  #
+  # Get the singleton instance of cheddar applied by cheddarize
+  #
   def self.instance
     @instance ||= new
   end
 
+  #
+  # Parse using the singleton instance
+  #
   def self.parse(string)
-    self.instance.parse(string)
+    instance.parse(string)
+  end
+
+  private
+
+  attr_reader :mapping
+  attr_accessor :current_dialect
+
+  def apply_mapping(num_name, value, str)
+    if num_name.is_a? Regexp
+      str.gsub!(num_name, "* #{value}")
+    else
+      str.gsub!(Regexp.new("(^|\s)#{num_name}($|\s)"), "* #{value}")
+    end
   end
 end
 
@@ -69,13 +143,16 @@ Cheddar.config do |c|
   c.dialect(:en_us) do |d|
     d.define :hundred, 100
     d.define :thousand, 1000
-    %w(m b tr quadr quint sext sept oct non dec undec duodec tredec quattuordec quindec sexdec septemdec octodec novemdec vigint).inject(1000) do |m,p|
+    %w(m b tr quadr quint sext sept oct non dec undec duodec tredec quattuordec
+       quindec sexdec septemdec octodec novemdec vigint).reduce(1000) do |m, p|
       d.define "#{p}illion", 1000 * m
     end
   end
 
   c.dialect(:slang_us) do |d|
-    %w(bacon bills bread buck cabbage cash cheddar cheese clams dolla dollar dough green greenback kale lettuce loot moolah paper potato potatoes scratch scrip).each { |p| d.define p, 1 }
+    %w(bacon bills bread buck cabbage cash cheddar cheese clams dolla dollar
+       dough green greenback kale lettuce loot moolah paper potato
+       potatoes scratch scrip).each { |p| d.define p, 1 }
     %w(benjamin c-note jackson twankie).each { |p| d.define p, 100 }
     d.define 'dead presidents', 1
     d.define 'long green', 1
@@ -86,6 +163,17 @@ Cheddar.config do |c|
     d.define 'big ones', 1000
   end
 
-  c.enabled_dialects = [:en_us, :slang_us]
+  c.dialect(:slang_gb) do |d|
+    %w(alan cherry maggie nicker nugget pound quid sov).each do |p|
+      d.define p, 1
+    end
+    %w(plenty purple score).each { |p| d.define p, 20 }
+    %w(bullseye mcgarret nifty pinky thrifty).each { |p| d.define p, 50 }
+    %w(cenny century longun oneer).each { |p| d.define p, 100 }
+    %w(bag gorilla grand large rio).each { |p| d.define p, 1000 }
+    d.define 'pony', 25
+  end
+
+  c.enabled_dialects = [:en_us, :slang_us, :slang_gb]
 
 end

metadata

@@ -1,17 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: cheddar
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kenny Parnell
 - Jonathan Roes
+- Alex Forbes-Reed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies: []
-description: Convert human readable strings to numbers. Also handles gangster terminology.
+description: |2
+      Convert human readable strings to numbers.
+      Also handles gangster terminology.
 email: k.parnell@gmail.com
 executables: []
 extensions: []
@@ -43,3 +46,4 @@ signing_key:
 specification_version: 4
 summary: Little library to convert human readable strings to numbers.
 test_files: []
+has_rdoc: