simple_money 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+SimpleMoney 0.2.1
+=================
+
+Features
+--------
+- Added #%, #<=>, #==, #abs and #divmod
+- Cleanup/Enhanced documentation
+
+Bug fixes
+---------
+- Update all calculations to respect options set on object (rounding method,
+  currency, etc) when return a new object as a result of the calculation
+
 SimpleMoney 0.2.0
 =================
 

data/lib/simple_money/money.rb

@@ -220,6 +220,8 @@ class Money
   #  representation the object should be created using.
   #
   # @raise [ArgumentError] Will raise an ArgumentError if as is not valid.
+  # @raise [ArgumentError] Will raise an ArgumentError if rounding method is
+  #  not valid.
   #
   # @example
   #   Money.new                        #=> #<Money:... @cents: 0>
@@ -287,6 +289,8 @@ class Money
   #
   # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
   #  object.
+  # @raise [ArgumentError] Will raise an ArgumentError if currency of n is
+  #  incompatible.
   #
   # @example
   #   Money.new(1) + Money.new(2) #=> #<Money:... @cents: 3>
@@ -296,7 +300,12 @@ class Money
       n.currency == currency
     )
 
-    Money.new(self.cents + n.cents, :as => :cents)
+    Money.new(
+      self.cents + n.cents,
+      :as => :cents,
+      :rounding_method => rounding_method,
+      :currency => currency
+    )
   end
 
   ##
@@ -308,6 +317,8 @@ class Money
   #
   # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
   #  object.
+  # @raise [ArgumentError] Will raise an ArgumentError if currency of n is
+  #  incompatible.
   #
   # @example
   #   Money.new(2) - Money.new(1) #=> #<Money:... @cents: 1>
@@ -317,7 +328,12 @@ class Money
       n.currency == currency
     )
 
-    Money.new(self.cents - n.cents, :as => :cents)
+    Money.new(
+      self.cents - n.cents,
+      :as => :cents,
+      :rounding_method => rounding_method,
+      :currency => currency
+    )
   end
 
   ##
@@ -338,7 +354,9 @@ class Money
 
     Money.new(
       BigDecimal(self.cents.to_s) * BigDecimal(n.to_s),
-      :as => :cents
+      :as => :cents,
+      :rounding_method => rounding_method,
+      :currency => currency
     )
   end
 
@@ -352,10 +370,12 @@ class Money
   #
   # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
   #  object or Numeric.
+  # @raise [ArgumentError] Will raise an ArgumentError if currency of n is
+  #  incompatible.
   #
   # @example
   #   Money.new(10) / Money.new(5) #=> 2
-  #   Money.new(10) /              #=> #<Money:... @cents: 2>
+  #   Money.new(10) / 5            #=> #<Money:... @cents: 2>
   def /(n)
     case n
     when Money
@@ -367,12 +387,153 @@ class Money
     when Numeric
       result, overflow = BigDecimal(self.cents.to_s).divmod(BigDecimal(n.to_s))
       self.class.overflow = self.class.overflow + overflow
-      Money.new(result, :as => :cents)
+      Money.new(
+        result,
+        :as => :cents,
+        :rounding_method => rounding_method,
+        :currency => currency
+      )
+    else
+      raise ArgumentError, "n must be a Money or Numeric"
+    end
+  end
+
+  ##
+  # Modulo self by a Money/Numeric; return the results as a new Numeric/Money.
+  #
+  # @param [Money,Numeric] n The object to modulo. 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
+  #  object or Numeric.
+  # @raise [ArgumentError] Will raise an ArgumentError if n is an incompatible
+  #  currency.
+  #
+  # @example
+  #   Money.new(10) % Money.new(5) #=> 2
+  #   Money.new(10) % 5            #=> #<Money:... @cents: 2>
+  def %(n)
+    case n
+    when Money
+      raise ArgumentError, "n is an incompatible currency" unless (
+        n.currency == currency
+      )
+
+      BigDecimal(self.cents.to_s) % BigDecimal(n.cents.to_s)
+    when Numeric
+      Money.new(
+        BigDecimal(self.cents.to_s) % BigDecimal(n.to_s),
+        :as => :cents,
+        :rounding_method => rounding_method,
+        :currency => currency
+      )
+    else
+      raise ArgumentError, "n must be a Money or Numeric"
+    end
+  end
+
+  def divmod(n)
+    case n
+    when Money
+      raise ArgumentError, "n is an incompatible currency" unless (
+        n.currency == currency
+      )
+
+      a, b = BigDecimal(self.cents.to_s).divmod(BigDecimal(n.cents.to_s))
+      [
+        a,
+        Money.new(
+          b,
+          :as => :cents,
+          :rounding_method => rounding_method,
+          :currency => currency
+        )
+      ]
+    when Numeric
+      a, b = BigDecimal(self.cents.to_s).divmod(BigDecimal(n.to_s))
+      [
+        Money.new(
+          a,
+          :as => :cents,
+          :rounding_method => rounding_method,
+          :currency => currency
+        ),
+        Money.new(
+          b,
+          :as => :cents,
+          :rounding_method => rounding_method,
+          :currency => currency
+        )
+      ]
     else
       raise ArgumentError, "n must be a Money or Numeric"
     end
   end
 
+  ##
+  # Compare self to n. When self < n, return -1. When self > n, return 1. When
+  # self == n, return 0.
+  #
+  # @param [Money] n The object to compare with.
+  #
+  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
+  #  object or Numeric.
+  # @raise [ArgumentError] Will raise an ArgumentError if n is an incompatible
+  #  currency.
+  #
+  # @example
+  #   Money.new(1_00) <=> Money.new(2_00) #=> -1
+  #   Money.new(2_00) <=> Money.new(1_00) #=> 1
+  #   Money.new(1_00) <=> Money.new(1_00) #=> 0
+  def <=>(n)
+    raise ArgumentError, "n must be a Money" unless n.is_a? Money
+    raise ArgumentError, "n is an incompatible currency" unless (
+      n.currency == currency
+    )
+
+    self.cents <=> n.cents
+  end
+
+  ##
+  # Compare self to n. When self == n, return true, otherwise false.
+  #
+  # @param [Money] n The object to compare with.
+  #
+  # @raise [ArgumentError] Will raise an ArgumentError unless n is a Money
+  #  object or Numeric.
+  # @raise [ArgumentError] Will raise an ArgumentError if n is an incompatible
+  #  currency.
+  #
+  # @example
+  #   Money.new(1_00) == Money.new(2_00) #=> false
+  #   Money.new(2_00) == Money.new(2_00) #=> true
+  def ==(n)
+    raise ArgumentError, "n must be a Money" unless n.is_a? Money
+    raise ArgumentError, "n is an incompatible currency" unless (
+      n.currency == currency
+    )
+
+    self.cents == n.cents
+  end
+
+  ##
+  # Return a new Money object using the absolute value of cents.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   Money.new(-1_00).abs #=> #<Money:... cents: 100>
+  def abs
+    Money.new(
+      self.cents.abs,
+      :as => :cents,
+      :rounding_method => rounding_method,
+      :currency => currency
+    )
+  end
+
   ##
   # Returns cents formatted as a string, based on any options passed.
   #

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Shane Emmons
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -05:00
+date: 2011-01-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency