papla 0.0.5 → 0.1.0

data/CHANGELOG.md

@@ -1,20 +1,24 @@
+### 0.1.0 (2012-04-20)
+
+* Support Money
+
 ### 0.0.5 (2012-01-21)
 
 * Make converting decimal points more robust
 
 ### 0.0.4 (2012-01-21)
 
-* support English locale
+* Support English locale
 
 ### 0.0.3 (2012-01-16)
 
-* provide localization using I18n
+* Provide localization using I18n
 
 ### 0.0.2 (2011-01-09)
 
-* display decimal part of floats as cents/100
+* Display decimal part of floats as cents/100
 
 ### 0.0.1 (2011-01-03)
 
-* initial release
-* support converting numbers from 0 up to 999 999 999 to Polish words
+* Initial release
+* Support converting numbers from 0 up to 999 999 999 to Polish words

data/README.md

@@ -54,7 +54,7 @@ Papla[2.999] # => "Trzy 00/100"
 
 This feature is planned for future releases.
 
-## Integration with Money, I18n and Rails
+## Integration with I18n and Money
 
 ### I18n
 
@@ -64,9 +64,22 @@ for details of keys used. Currently `:pl` and `:en` locales are supported.
 Note: English support is not fully correct, e.g. `123` becomes
 `"One hundred twenty three"` and not `"One hundred and twenty three"`.
 
-### Money, Rails
+### Money
 
-This feature is planned for future releases.
+If you're using the `money` gem, you can pass in an instance of `Money` to Papla.
+The returned string will contain the dollars part as words,
+the cents part as 'xx/100' and the currency string (e.g. `EUR`).
+
+Example:
+
+```ruby
+eleven_and_a_half_pounds = Money.new(1150, 'GBP')
+Papla[eleven_and_a_half_pounds] # => "Jedenaście 50/100 GBP"
+
+I18n.locale = :en
+discounted_price = Money.new(9999, 'PLN')
+Papla[discounted_price] # => "Ninety nine 99/100 PLN"
+```
 
 ## Documentation
 

data/lib/papla.rb

@@ -1,9 +1,9 @@
-require 'bigdecimal'
-require 'bigdecimal/util'
-require 'papla/backend'
-require 'papla/version'
-
 module Papla
+  autoload :Backend, 'papla/backend'
+  autoload :FixnumConverter, 'papla/fixnum_converter'
+  autoload :FloatConverter, 'papla/float_converter'
+  autoload :MoneyConverter, 'papla/money_converter'
+
   # Converts a number to Polish or English words,
   # capitalizing the first letter of the whole phrase.
   #
@@ -40,96 +40,35 @@ module Papla
   #   Papla[87.654321] # => "Osiemdziesiąt siedem 65/100"
   #   Papla[2.999] # => "Trzy 00/100"
   #
+  # If you're using the `money` gem, you can pass in an instance
+  # of `Money` to Papla. The returned string will contain the dollars
+  # part as words, the cents part as 'xx/100' and the currency
+  # string (e.g. `EUR`).
+  #
+  # Example:
+  #
+  #   eleven_and_a_half_pounds = Money.new(1150, 'GBP')
+  #   Papla[eleven_and_a_half_pounds] # => "Jedenaście 50/100 GBP"
+  #
+  #   I18n.locale = :en
+  #   discounted_price = Money.new(9999, 'PLN')
+  #   Papla[discounted_price] # => "Ninety nine 99/100 PLN"
+  #
   # @param [Fixnum] number the number to convert
   # @return [String] the phrase in Polish or English
   def self.[](number)
-    validate!(number)
-    number = prepare(number)
-    basic_number = number.to_i
-    basic_phrase = build_basic_phrase(basic_number)
-
-    case number
-    when Float; append_cents(basic_phrase, number)
-    else basic_phrase
-    end
+    converter = converter_for(number)
+    converter.new.convert(number)
   end
 
   private
 
-  def self.prepare(number)
+  def self.converter_for(number)
     case number
-    when Float; number.round(2)
-    else number
-    end
-  end
-
-  def self.build_basic_phrase(basic_number)
-    if basic_number.zero?
-      spell_zero
-    else
-      groups = group(basic_number)
-      groups_as_words = convert_groups(groups)
-      groups_as_words.flatten.join(' ')
-    end.capitalize
-  end
-
-  def self.group(number)
-    groups = []
-
-    while number > 0
-      number, group = number.divmod(1000)
-      groups.unshift(group)
+    when defined?(Money) && Money then MoneyConverter
+    when Float then FloatConverter
+    when Fixnum then FixnumConverter
+    else raise ArgumentError, "Unsupported type: #{klass}"
     end
-
-    groups
-  end
-
-  def self.convert_groups(groups)
-    bound = groups.count - 1
-    result = []
-
-    groups.each_with_index do |group, i|
-      if group > 0
-        result << convert_small_number(group)
-        result << spell_rank(bound - i, group) if i < bound
-      end
-    end
-
-    result
-  end
-
-  def self.convert_small_number(number)
-    if number.zero?
-      []
-    elsif number < 20
-      [spell_ones(number)]
-    elsif number < 100
-      tens, remainder = number.divmod(10)
-      [spell_tens(tens), convert_small_number(remainder)]
-    else
-      hundreds, remainder = number.divmod(100)
-      [spell_hundreds(hundreds), convert_small_number(remainder)]
-    end
-  end
-
-  def self.validate!(number)
-    max = 999_999_999
-    raise ArgumentError, "#{number} is too big, only numbers up to #{max} are supported" if number > max
-  end
-
-  def self.append_cents(basic_phrase, number)
-    cents = 100 * (number.to_d - number.to_i)
-    spell_cents(basic_phrase, cents)
-  end
-
-  def self.backend
-    @backend ||= Backend.new
   end
-
-  def self.spell_zero;                       backend.zero;                       end
-  def self.spell_ones(index);                backend.ones(index);                end
-  def self.spell_tens(index);                backend.tens(index);                end
-  def self.spell_hundreds(index);            backend.hundreds(index);            end
-  def self.spell_rank(index, number);        backend.rank(index, number);        end
-  def self.spell_cents(basic_phrase, cents); backend.cents(basic_phrase, cents); end
 end

data/lib/papla/fixnum_converter.rb

@@ -0,0 +1,71 @@
+module Papla
+  class FixnumConverter
+    def convert(number)
+      validate!(number)
+
+      if number.zero?
+        spell_zero
+      else
+        groups = group(number)
+        groups_as_words = convert_groups(groups)
+        groups_as_words.flatten.join(' ')
+      end.capitalize
+    end
+
+    private
+
+    def validate!(number)
+      max = 999_999_999
+      raise ArgumentError, "#{number} is too big, only numbers up to #{max} are supported" if number > max
+    end
+
+    def group(number)
+      groups = []
+
+      while number > 0
+        number, group = number.divmod(1000)
+        groups.unshift(group)
+      end
+
+      groups
+    end
+
+    def convert_groups(groups)
+      bound = groups.count - 1
+      result = []
+
+      groups.each_with_index do |group, i|
+        if group > 0
+          result << convert_small_number(group)
+          result << spell_rank(bound - i, group) if i < bound
+        end
+      end
+
+      result
+    end
+
+    def convert_small_number(number)
+      if number.zero?
+        []
+      elsif number < 20
+        [spell_ones(number)]
+      elsif number < 100
+        tens, remainder = number.divmod(10)
+        [spell_tens(tens), convert_small_number(remainder)]
+      else
+        hundreds, remainder = number.divmod(100)
+        [spell_hundreds(hundreds), convert_small_number(remainder)]
+      end
+    end
+
+    def backend
+      @backend ||= Backend.new
+    end
+
+    def spell_zero;                backend.zero;                end
+    def spell_ones(index);         backend.ones(index);         end
+    def spell_tens(index);         backend.tens(index);         end
+    def spell_hundreds(index);     backend.hundreds(index);     end
+    def spell_rank(index, number); backend.rank(index, number); end
+  end
+end

data/lib/papla/float_converter.rb

@@ -0,0 +1,21 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+module Papla
+  class FloatConverter < FixnumConverter
+    def convert(number)
+      number = number.round(2)
+      append_cents(super(number.to_i), number)
+    end
+
+    private
+
+    def append_cents(basic_phrase, number)
+      cents = 100 * (number.to_d - number.to_i)
+      cents = cents.round(2)
+      spell_cents(basic_phrase, cents)
+    end
+
+    def spell_cents(basic_phrase, cents); backend.cents(basic_phrase, cents); end
+  end
+end

data/lib/papla/money_converter.rb

@@ -0,0 +1,13 @@
+module Papla
+  class MoneyConverter < FloatConverter
+    def convert(number)
+      append_currency(super(number.to_f.round(2)), number)
+    end
+
+    private
+
+    def append_currency(phrase, money)
+      '%s %s' % [phrase, money.currency_as_string]
+    end
+  end
+end

data/lib/papla/version.rb

@@ -1,3 +1,3 @@
 module Papla
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/papla.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'i18n'
 
+  s.add_development_dependency 'money'
   s.add_development_dependency 'rspec', '>= 2.8.0'
   s.add_development_dependency 'rake'
 end

data/spec/en_spec.rb

@@ -236,4 +236,11 @@ describe Papla, 'en' do
       subject[111_111.2].should eq('One hundred eleven thousand one hundred eleven 20/100')
     end
   end
+
+  describe 'money' do
+    it 'concatenates dollars, cents and currency' do
+      discounted_price = Money.new(9999, 'PLN')
+      Papla[discounted_price].should eq('Ninety nine 99/100 PLN')
+    end
+  end
 end

data/spec/pl_spec.rb

@@ -237,4 +237,11 @@ describe Papla, 'pl' do
       subject[111_111.2].should eq('Sto jedenaście tysięcy sto jedenaście 20/100')
     end
   end
+
+  describe 'money' do
+    it 'concatenates dollars, cents and currency' do
+      eleven_and_a_half_pounds = Money.new(1150, 'GBP')
+      Papla[eleven_and_a_half_pounds].should eq('Jedenaście 50/100 GBP')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
+require 'money'
 require 'papla'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papla
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-28 00:00:00.000000000 Z
+date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &9548560 !ruby/object:Gem::Requirement
+  requirement: &17749220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9548560
+  version_requirements: *17749220
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: &17748560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *17748560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9547300 !ruby/object:Gem::Requirement
+  requirement: &17763960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *9547300
+  version_requirements: *17763960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9546380 !ruby/object:Gem::Requirement
+  requirement: &17763380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9546380
+  version_requirements: *17763380
 description: Papla is a Ruby gem that allows you to convert numbers into Polish and
   English words.
 email:
@@ -62,10 +73,13 @@ files:
 - Rakefile
 - lib/papla.rb
 - lib/papla/backend.rb
+- lib/papla/fixnum_converter.rb
+- lib/papla/float_converter.rb
 - lib/papla/locale/en.rb
 - lib/papla/locale/en.yml
 - lib/papla/locale/pl.rb
 - lib/papla/locale/pl.yml
+- lib/papla/money_converter.rb
 - lib/papla/version.rb
 - papla.gemspec
 - spec/en_spec.rb