simple_money 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+SimpleMoney 0.1.1
+=================
+
+Features
+--------
+ - Ensure all calculations are done using BigDecimal
+ - Implemented Money#to_s
+ - Cleaned up documentation
+ - Reorganize lib/spec for compatibility with autotest
+ - Implemented Money.overflow=
+
+Bug fixes
+---------
+ - Fixed error where overflow wasn't properly updated after calling Money#/
+
 SimpleMoney 0.1.0
-===================
+=================
+
+Features
+--------
  - Initial release.

data/README.md

@@ -10,10 +10,17 @@ Usage:
     require 'simple_money'
 
     a = Money.new(1_00, :as => :cents)
-    a.cents        #=> 100
+    a.cents                 #=> 100
     b = a * 1.555
-    b.cents        #=> 156
-    Money.overflow #=> #<BigDecimal:... '-0.5E0',4(16)>
+    b.cents                 #=> 156
+    Money.overflow          #=> #<BigDecimal:... '-0.5E0',4(16)>
+    b.to_s                  #=> "100"
+    b.to_s(:as => :decimal) #=> "1.00"
+
+Version History
+---------------
+
+See {file:CHANGELOG.md} for details.
 
 Copyright
 ---------

data/lib/simple_money/money.rb

@@ -8,17 +8,17 @@ class Money
   class << self
 
     ##
-    # The valid values for :as
+    # The valid values for as
     VALID_AS_VALUES = [:cents, :decimal]
 
     ##
-    # The valid values for :rounding_method
+    # The valid rounding methods
     VALID_ROUNDING_METHOD_VALUES = [:away_from_zero, :toward_zero,
       :nearest_up, :nearest_down, :bankers, :up, :down]
 
     ##
     # Translations from SimpleMoney rounding methods to BigDecimal rounding
-    # method.
+    # methods.
     ROUNDING_METHOD_TRANSLATION = {
       :away_from_zero => BigDecimal::ROUND_UP,
       :toward_zero    => BigDecimal::ROUND_DOWN,
@@ -30,12 +30,12 @@ class Money
     }
 
     ##
-    # @return [Symbol] The default :as used to create a new Money (defaults to
+    # @return [Symbol] The default as used to create a new Money (defaults to
     #  :cents).
     attr_reader :default_as
 
     ##
-    # Set the default :as used to create a new Money.
+    # Set the default as used to create a new Money.
     #
     # @param [Symbol] as The default to use.
     #
@@ -68,13 +68,13 @@ class Money
     end
 
     ##
-    # @return [Symbol] The default :rounding_method used when calculations do
-    #  not result in an Integer (defaults to :bankers).
+    # @return [Symbol] The default rounding method used when calculations do
+    #  not result in an Fixnum (defaults to :bankers).
     attr_reader :default_rounding_method
 
     ##
-    # Set the default :rounding_method used when calculations do not result in
-    # and Integer.
+    # Set the default rounding method used when calculations do not result in a
+    # Fixnum.
     #
     # @param [Symbol] rounding_method The default to use.
     #
@@ -94,8 +94,7 @@ class Money
     end
 
     ##
-    # Returns true if argument is a valid value for :rounding_method, otherwise
-    # false.
+    # Returns true if argument is a valid rounding method, otherwise false.
     #
     # @param [Symbol] rounding_method The value to check.
     #
@@ -110,29 +109,46 @@ class Money
 
     ##
     # @return [BigDecimal] The factional cents left over from any transactions
-    #  that were rounded.
+    #  that overflowed.
     attr_reader :overflow
 
+    ##
+    # Update the overflow to the specified amount (converted to a BigDecimal
+    # object).
+    #
+    # @param [#to_s] n The value to set the overflow to.
+    #
+    # @return [BigDecimal]
+    #
+    # @example
+    #   Money.round(1.5)
+    #   Money.overflow #=> #<BigDecimal:... '-0.5E0',4(16)>
+    #   Money.overflow = 0
+    #   Money.overflow #=> #<BigDecimal:... '0.0',4(8)>
+    def overflow=(n)
+      @overflow = BigDecimal(n.to_s)
+    end
+
     ##
     # Resets the overflow bucket to 0.
     #
     # @return [BigDecimal]
     def reset_overflow
-      @overflow = BigDecimal("0")
+      self.overflow = 0
     end
 
     ##
     # Returns n rounded to an integer using the given rounding method, or the
     # default rounding method when none is provided. When rounding, the
-    # fractional cents are added to Money.overflow.
+    # fractional cents are added to the overflow bucket.
     #
     # @param [#to_s] n The value to round.
     # @param [Symbol] rounding_method The rounding method to use.
     #
     # @return [Fixnum]
     #
-    # @raise [ArgumentError] Will raise an argument error if an invalid
-    #  rounding method is given.
+    # @raise [ArgumentError] Will raise an ArgumentError if an invalid rounding
+    #  method is given.
     #
     # @example
     #   Money.round(1.5, :bankers) #=> 2
@@ -165,17 +181,17 @@ class Money
   attr_reader :rounding_method
 
   ##
-  # Creates a new Money. If :as is set to :cents, n will be coerced to an
-  # Integer. If :as is set to :decimal, n will be coerced to a BigDecimal.
+  # Creates a new Money object. If as is set to :cents, n will be coerced to a
+  # Fixnum. If as is set to :decimal, n will be coerced to a BigDecimal.
   #
   # @param [#to_s] n Value of the new object.
-  # @param [Hash] options options used to build the new object.
+  # @param [Hash] options The options used to build the new object.
   # @option options [Symbol] :as How n is represented (defaults to
-  #  self.class.default_as). Valid values are :cents and :decimal.
+  #  self.class.default_as).
   # @option options [Symbol] :rounding_method How any calculations resulting in
   #  fractions of a cent should be rounded.
   #
-  # @raise [ArgumentError] Will raise an ArgumentError if :as is not valid.
+  # @raise [ArgumentError] Will raise an ArgumentError if as is not valid.
   #
   # @example
   #   Money.new                        #=> #<Money:... @cents: 0>
@@ -202,20 +218,26 @@ class Money
 
     @cents = case options[:as]
              when :cents
-               Money.round(BigDecimal(n.to_s), rounding_method)
+               Money.round(
+                 BigDecimal(n.to_s), rounding_method
+               )
              when :decimal
-               Money.round(BigDecimal(n.to_s) * 100, rounding_method)
+               Money.round(
+                 BigDecimal(n.to_s) * BigDecimal("100"),
+                 rounding_method
+               )
              end
   end
 
   ##
-  # Add two Money objects; return the results as a new Money.
+  # Add two Money objects; return the results as a new Money object.
   #
   # @param [Money] n The object to add.
   #
   # @return [Money]
   #
-  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money.
+  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
+  #  object.
   #
   # @example
   #   Money.new(1) + Money.new(2) #=> #<Money:... @cents: 3>
@@ -225,13 +247,14 @@ class Money
   end
 
   ##
-  # Subtract two Money; return the results as a new Money.
+  # Subtract two Money; return the results as a new Money object.
   #
   # @param [Money] n The object to subtract.
   #
   # @return [Money]
   #
-  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money.
+  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
+  #  object.
   #
   # @example
   #   Money.new(2) - Money.new(1) #=> #<Money:... @cents: 1>
@@ -241,34 +264,37 @@ class Money
   end
 
   ##
-  # Multiply Money by a Numeric; return the results as a new Money.
+  # Multiply Money by a Numeric; return the results as a new Money object.
   #
   # @param [Numeric] n The object to multiply. n will be coerced to a
   #  BigDecimal before any calculations are done.
   #
   # @return [Money]
   #
-  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Numeric.
+  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Numeric
+  #  object.
   #
   # @example
   #   Money.new(2) * 2 #=> #<Money:... @cents: 4>
   def *(n)
     raise ArgumentError, "n must be a Numeric" unless n.is_a? Numeric
 
-    Money.new(self.cents * BigDecimal(n.to_s), :as => :cents)
+    Money.new(
+      BigDecimal(self.cents.to_s) * BigDecimal(n.to_s),
+      :as => :cents
+    )
   end
 
   ##
-  # Divide Money by a Money/Numeric; return the results as a new
-  #  Numeric/Money.
+  # Divide self by a Money/Numeric; return the results as a new Numeric/Money.
   #
   # @param [Money,Numeric] n The object to divide. If n is Numeric, it will be
   #  coerced to a BigDecimal before any calculations are done.
   #
   # @return [Numeric,Money]
   #
-  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money or
-  #  Numeric.
+  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
+  #  object or Numeric.
   #
   # @example
   #   Money.new(10) / Money.new(5) #=> 2
@@ -278,10 +304,46 @@ class Money
     when Money
       BigDecimal(self.cents.to_s) / BigDecimal(n.cents.to_s)
     when Numeric
-      Money.new(self.cents / BigDecimal(n.to_s), :as => :cents)
+      result, overflow = BigDecimal(self.cents.to_s).divmod(BigDecimal(n.to_s))
+      self.class.overflow = self.class.overflow + overflow
+      Money.new(result, :as => :cents)
     else
       raise ArgumentError, "n must be a Money or Numeric"
     end
   end
 
+  ##
+  # Returns cents formatted as a string, based on any options passed.
+  #
+  # @param [Hash] options The options used to format the string.
+  # @option options [Symbol] :as How cents should be returned (defaults to
+  #  self.class.default_as).
+  #
+  # @return [String]
+  #
+  # @raise [ArgumentError] Will raise an ArgumentError if as is not valid.
+  #
+  # @example
+  #   n = Money.new(1_00, :as => :cents)
+  #   n.to_s                  #=> "100"
+  #   n.to_s(:as => :decimal) #=> "1.00"
+  def to_s(options = {})
+    options = {
+      :as => :cents
+    }.merge(options)
+
+    raise ArgumentError, "invalid `as`" unless (
+      self.class.valid_as? options[:as]
+    )
+
+    case options[:as]
+    when :cents
+      cents.to_s
+    when :decimal
+      unit, subunit = cents.divmod(100).map(&:to_s)
+      subunit = "0#{subunit}"[-2,2]
+      "#{unit}.#{subunit}"
+    end
+  end
+
 end

metadata

@@ -3,48 +3,48 @@ name: simple_money
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+    - 0
+    - 1
+    - 1
+  version: 0.1.1
 platform: ruby
 authors: 
-- Shane Emmons
+  - Shane Emmons
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-06 00:00:00 -05:00
+date: 2011-01-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 0
+            version: 2.0.0
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :development
+    version_requirements: *id002
 description: This gem is intended for working with financial calculations where you need highly accurate results.
 email: semmons99@gmail.com
 executables: []
@@ -54,11 +54,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/simple_money/money.rb
-- lib/simple_money.rb
-- CHANGELOG.md
-- LICENSE
-- README.md
+  - lib/simple_money.rb
+  - lib/simple_money/money.rb
+  - CHANGELOG.md
+  - LICENSE
+  - README.md
 has_rdoc: true
 homepage: http://github.com/semmons99/simple_money
 licenses: []
@@ -67,27 +67,27 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 7
-      version: 1.8.7
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 1
+          - 8
+          - 7
+        version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 7
-      version: 1.3.7
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 1
+          - 3
+          - 7
+        version: 1.3.7
 requirements: []
 
 rubyforge_project: