cashrb 1.2.0 → 1.2.1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+cashrb v1.2.1
+=============
+ - ensure objects created from internal functions such as (+ - * / % divmod)
+   return new objects that are consistent with their parents options
+
 cashrb v1.2.0
 =============
  - allow creation using decimal values instead of cents if you'd rather

data/README.md

@@ -1,83 +1,87 @@
 cashrb
 ======
 
-Dead simple gem to work with Money/Currency without the hassle of Floats.
+Lightweight money and currency handler for working with financial calculations.
+Ensures precision without sacrificing speed. Eschews complexity by only
+providing what you need to get your job done.
 
 Usage
 -----
 
-    require 'cashrb'
-
-    # Works with cents to avoid Floating point errors
-    n = Cash.new(100)
-    n.cents #=> 100
-    n.to_s  #=> "1.00"
-    n.to_f  #=> 1.0
-
-    # Don't like passing cents, set :from => :decimal and use a decimal value
-    n = Cash.new(1.11, from: :decimal)
-    n.cents #=> 111
-    n.to_s  #=> "1.11"
-    n.to_f  #=> 1.11
-
-    # Hate cents and always want to pass a decimal, just set the default
-    Cash.default_from = :decimal
-    n = Cash.new(1.11)
-    n.cents #=> 111
-
-    # Define currency as you see fit.
-    a = Cash.new(100, currency: :usd)
-    b = Cash.new(100, currency: :eur)
-    a + b #=> Error! Cash::IncompatibleCurrency
-
-    # Default is 100 cents in a dollar. Is your currency different, then just
-    # tell it.
-    n = Cash.new(100, cents_in_dollar: 5)
-    n.cents #=> 100
-    n.to_s  #=> "20.0"
-    n.to_f  #=> 20.0
-
-    n = Cash.new(100, cents_in_dollar: 10)
-    n.cents #=> 100
-    n.to_s  #=> "10.0"
-    n.to_f  #=> 10.0
-
-    n = Cash.new(100, cents_in_dollar: 1)
-    n.cents #=> 100
-    n.to_s  #=> "100"
-    n.to_f  #=> 100.0
-
-    # The default rounding method when dealing with fractional cents is
-    # BigDecimal::ROUND_HALF_UP. Would you rather use bankers rounding; just
-    # pass it as an argument.
-    n = Cash.new(2.5)
-    n.cents #=> 3
-
-    n = Cash.new(2.5, rounding_method: BigDecimal::ROUND_HALF_EVEN)
-    n.cents #=> 2
-
-    # Sick of specifying :cents_in_whole, :rounding_method and :currency; just
-    # set their defaults.
-    Cash.default_cents_in_whole  = 10
-    Cash.default_rounding_method = BigDecimal::ROUND_DOWN
-    Cash.default_currency        = :EUR
-
-    n = Cash.new(100)
-    n.to_s     #=> "10.0"
-    n.to_f     #=> 10.0
-    n.currency #=> :EUR
-
-    n = Cash.new(1.9)
-    n.cents #=> 1
-
-    # If your currency object implements :cents_in_whole, we'll go ahead and
-    # use that.
-
-    module MyCurrency
-      def self.cents_in_whole
-        10
-      end
-    end
-
-    n = Cash.new(9, :currency => MyCurrency)
-    n.to_f #=> 0.9
+```ruby
+require 'cashrb'
+
+# Works with cents to avoid Floating point errors
+n = Cash.new(100)
+n.cents #=> 100
+n.to_s  #=> "1.00"
+n.to_f  #=> 1.0
+
+# Don't like passing cents, set :from => :decimal and use a decimal value
+n = Cash.new(1.11, from: :decimal)
+n.cents #=> 111
+n.to_s  #=> "1.11"
+n.to_f  #=> 1.11
+
+# Hate cents and always want to pass a decimal, just set the default
+Cash.default_from = :decimal
+n = Cash.new(1.11)
+n.cents #=> 111
+
+# Define currency as you see fit.
+a = Cash.new(100, currency: :usd)
+b = Cash.new(100, currency: :eur)
+a + b #=> Error! Cash::IncompatibleCurrency
+
+# Default is 100 cents in a dollar. Is your currency different, then just
+# tell it.
+n = Cash.new(100, cents_in_dollar: 5)
+n.cents #=> 100
+n.to_s  #=> "20.0"
+n.to_f  #=> 20.0
+
+n = Cash.new(100, cents_in_dollar: 10)
+n.cents #=> 100
+n.to_s  #=> "10.0"
+n.to_f  #=> 10.0
+
+n = Cash.new(100, cents_in_dollar: 1)
+n.cents #=> 100
+n.to_s  #=> "100"
+n.to_f  #=> 100.0
+
+# The default rounding method when dealing with fractional cents is
+# BigDecimal::ROUND_HALF_UP. Would you rather use bankers rounding; just
+# pass it as an argument.
+n = Cash.new(2.5)
+n.cents #=> 3
+
+n = Cash.new(2.5, rounding_method: BigDecimal::ROUND_HALF_EVEN)
+n.cents #=> 2
+
+# Sick of specifying :cents_in_whole, :rounding_method and :currency; just
+# set their defaults.
+Cash.default_cents_in_whole  = 10
+Cash.default_rounding_method = BigDecimal::ROUND_DOWN
+Cash.default_currency        = :EUR
+
+n = Cash.new(100)
+n.to_s     #=> "10.0"
+n.to_f     #=> 10.0
+n.currency #=> :EUR
+
+n = Cash.new(1.9)
+n.cents #=> 1
+
+# If your currency object implements :cents_in_whole, we'll go ahead and
+# use that.
+
+module MyCurrency
+  def self.cents_in_whole
+    10
+  end
+end
+
+n = Cash.new(9, :currency => MyCurrency)
+n.to_f #=> 0.9
+```

data/cashrb.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name        = "cashrb"
-  s.version     = "1.2.0"
+  s.version     = "1.2.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Shane Emmons"]
   s.email       = ["semmons99@gmail.com"]
   s.homepage    = "http://semmons99.github.com/cashrb/"
-  s.summary     = "Dead simple gem to work with Money/Currency without the hassle of Floats"
-  s.description = "Dead simple gem to work with Money/Currency without the hassle of Floats"
+  s.summary     = "Lightweight money and currency handler for working with financial calculations."
+  s.description = "Lightweight money and currency handler for working with financial calculations."
 
   s.required_ruby_version     = ">= 1.8.7"
   s.required_rubygems_version = ">= 1.3.6"

data/lib/cashrb/cash.rb

@@ -71,35 +71,35 @@ class Cash
   end
 
   def +(value)
-    Cash.new(@cents + value.cents)
+    Cash.new(@cents + value.cents, new_options)
   end
 
   def -(value)
-    Cash.new(@cents - value.cents)
+    Cash.new(@cents - value.cents, new_options)
   end
 
   def *(value)
-    Cash.new(@cents * bd(value))
+    Cash.new(@cents * bd(value), new_options)
   end
 
   def /(value)
     @cents / value.cents
   rescue NoMethodError
-    Cash.new(@cents / bd(value))
+    Cash.new(@cents / bd(value), new_options)
   end
 
   def %(value)
-    Cash.new(@cents % value.cents)
+    Cash.new(@cents % value.cents, new_options)
   rescue NoMethodError
-    Cash.new(@cents % bd(value))
+    Cash.new(@cents % bd(value), new_options)
   end
 
   def divmod(value)
     quotient, remainder = @cents.divmod value.cents
-    [quotient, Cash.new(remainder)]
+    [quotient, Cash.new(remainder, new_options)]
   rescue NoMethodError
     quotient, remainder = @cents.divmod bd(value)
-    [Cash.new(quotient), Cash.new(remainder)]
+    [Cash.new(quotient, new_options), Cash.new(remainder, new_options)]
   end
 
   def <=>(value)
@@ -179,4 +179,13 @@ class Cash
   rescue NoMethodError
   end
 
+  def new_options
+    {
+      :cents_in_whole  => @cents_in_whole,
+      :rounding_method => @rounding_method,
+      :currency        => @currency,
+      :from            => :cents,
+    }
+  end
+
 end

data/test/test_cash.rb

@@ -143,6 +143,16 @@ class TestCash < MiniTest::Unit::TestCase
     end
   end
 
+  def test_plus_with_modified_defaults
+    Cash.default_cents_in_whole  = 10
+    Cash.default_rounding_method = BigDecimal::ROUND_UP
+    Cash.default_currency        = :usd
+    Cash.default_from            = :decimal
+
+    rs = Cash.new(10) + Cash.new(5)
+    assert_equal Cash.new(15), rs
+  end
+
   def test_minus_with_Cash_Cash
     rs = Cash.new(6) - Cash.new(4)
     assert_equal Cash.new(2), rs
@@ -154,11 +164,31 @@ class TestCash < MiniTest::Unit::TestCase
     end
   end
 
-  def test_multiple_with_Cash_Numeric
+  def test_minus_with_modified_defaults
+    Cash.default_cents_in_whole  = 10
+    Cash.default_rounding_method = BigDecimal::ROUND_UP
+    Cash.default_currency        = :usd
+    Cash.default_from            = :decimal
+
+    rs = Cash.new(10) - Cash.new(5)
+    assert_equal Cash.new(5), rs
+  end
+
+  def test_multiply_with_Cash_Numeric
     rs = Cash.new(6) * 2
     assert_equal Cash.new(12), rs
   end
 
+  def test_multiply_with_modified_defaults
+    Cash.default_cents_in_whole  = 10
+    Cash.default_rounding_method = BigDecimal::ROUND_UP
+    Cash.default_currency        = :usd
+    Cash.default_from            = :decimal
+
+    rs = Cash.new(10) * 5
+    assert_equal Cash.new(50), rs
+  end
+
   def test_divide_with_Cash_Cash
     rs = Cash.new(6) / Cash.new(4)
     assert_equal BigDecimal("1.5"), rs
@@ -175,6 +205,16 @@ class TestCash < MiniTest::Unit::TestCase
     assert_equal Cash.new(3), rs
   end
 
+  def test_divide_with_modified_defaults
+    Cash.default_cents_in_whole  = 10
+    Cash.default_rounding_method = BigDecimal::ROUND_UP
+    Cash.default_currency        = :usd
+    Cash.default_from            = :decimal
+
+    rs = Cash.new(10) / 5
+    assert_equal Cash.new(2), rs
+  end
+
   def test_modulo_with_Cash_Cash
     rs = Cash.new(6) % Cash.new(4)
     assert_equal Cash.new(2), rs
@@ -191,6 +231,16 @@ class TestCash < MiniTest::Unit::TestCase
     assert_equal Cash.new(2), rs
   end
 
+  def test_modulo_with_modified_defaults
+    Cash.default_cents_in_whole  = 10
+    Cash.default_rounding_method = BigDecimal::ROUND_UP
+    Cash.default_currency        = :usd
+    Cash.default_from            = :decimal
+
+    rs = Cash.new(6) % 7
+    assert_equal Cash.new(0.4), rs
+  end
+
   def test_divmod_with_Cash_Cash
     rs = Cash.new(6).divmod(Cash.new(4))
     assert_equal [BigDecimal("1"), Cash.new(2)], rs
@@ -207,6 +257,16 @@ class TestCash < MiniTest::Unit::TestCase
     assert_equal [Cash.new(1), Cash.new(2)], rs
   end
 
+  def test_divmod_with_modified_defaults
+    Cash.default_cents_in_whole  = 10
+    Cash.default_rounding_method = BigDecimal::ROUND_UP
+    Cash.default_currency        = :usd
+    Cash.default_from            = :decimal
+
+    rs = Cash.new(6).divmod(40)
+    assert_equal [Cash.new(0.1), Cash.new(2)], rs
+  end
+
   def test_equal_to_when_equal_to
     rs = Cash.new(6) == Cash.new(6)
     assert rs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cashrb
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-12 00:00:00.000000000Z
+date: 2011-05-09 00:00:00.000000000Z
 dependencies: []
-description: Dead simple gem to work with Money/Currency without the hassle of Floats
+description: Lightweight money and currency handler for working with financial calculations.
 email:
 - semmons99@gmail.com
 executables: []
@@ -48,8 +48,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - minitest
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
-summary: Dead simple gem to work with Money/Currency without the hassle of Floats
+summary: Lightweight money and currency handler for working with financial calculations.
 test_files: []