spook_and_puff_money 0.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Spook and Puff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+# SpookAndPuff::Money
+
+This is yet another Ruby class made to represent money. This one is dead simple. It doesn't integrate with any frameworks, it simply enforces precison by ensuring all operands -- for methods like +, -, / etc. -- are BigDecimals. 
+
+It also provides a few other conveniences like formatting.
+
+It is primarily intended for our own projects, but is offered here as an open sourced project, because.

data/lib/spook_and_puff/money.rb

@@ -0,0 +1,249 @@
+require 'bigdecimal'
+
+# The main Spook and Puff module which namespaces our projects. Yay?
+module SpookAndPuff
+  # The money class represents monetary values with a precision of up to seven 
+  # digits. When used as part of a comparison or mathmatical operation it
+  # always ensures the other operand is coerced into a BigDecimal. This ensures
+  # the precision is maintained.
+  class Money
+    include Comparable
+
+    # Stores the raw BigDecimal instance that a Money instance wraps.
+    attr_reader :raw
+
+    # Initializes the money class from a BigDecimal instance.
+    #
+    # @param [BigDecimal, String] value
+    #
+    # @return self
+    #
+    # @raise TypeError
+    #
+    # @todo This potentially should only handle BigDecimal, Money and String
+    def initialize(value)
+      @raw = case value
+      when BigDecimal then value.round(7)
+      when String     then BigDecimal.new(value).round(7)
+      else raise TypeError.new("Money can only be initalized with a BigDecimal or String not #{value.class}.")
+      end
+    end
+
+    # Value comparison.
+    #
+    # @param [Money, Numeric, String] other
+    #
+    # @return Money
+    #
+    # @raise ArgumentError
+    def ==(other)
+      @raw == for_comparison(other)
+    end
+
+    # @param [Money, Numeric, String] other
+    #
+    # @return Money
+    #
+    # @raise ArgumentError
+    def <=>(other)
+      @raw <=> for_comparison(other)
+    end
+
+    # Multiplication. Numerics and strings only.
+    #
+    # @param [Integer, Fixnum, String] other
+    #
+    # @return Money
+    #
+    # @raise ArgumentError
+    def *(other)
+      Money.new(@raw * coerce(other))
+    end
+
+    # Division. Numerics and strings only.
+    #
+    # @param [Integer, Fixnum, String] other
+    #
+    # @return Money
+    #
+    # @raise ArgumentError
+    def /(other)
+      Money.new(@raw / coerce(other))
+    end
+
+    # Minus.
+    #
+    # @param [Money, Numeric, String] other
+    #
+    # @return Money
+    #
+    # @raise ArgumentError
+    def -(other)
+      Money.new(@raw - for_operation(other, 'subtraction'))
+    end
+
+    # Add.
+    #
+    # @param [Money, Numeric, String] other
+    #
+    # @return Money
+    #
+    # @raise ArgumentError
+    def +(other)
+      Money.new(@raw + for_operation(other, 'addition'))
+    end
+
+    # Unary minus. This negates the money value
+    #
+    # @return Money
+    def -@
+      Money.new(-@raw)
+    end
+
+    # Unary plus. Just returns the reciever.
+    #
+    # @return Money
+    def +@
+      self
+    end
+
+    # Returns a new Money instance with the absolute value.
+    #
+    # @return Money
+    def abs
+      Money.new(@raw.abs)
+    end
+
+    # Returns a BigDecimal representation of the value in cents.
+    #
+    # @return BigDecimal
+    def cents
+      @raw * BigDecimal.new('100')
+    end
+
+    # Returns the raw BigDecimal value.
+    #
+    # @return BigDecimal
+    def to_big_decimal
+      @raw
+    end
+
+    # Checks for zero value.
+    #
+    # @return [true, false]
+    def zero?
+      @raw == 0
+    end
+
+    # Checks to see if the value is positive i.e. non-negative, non-zero.
+    #
+    # @return [true, false]
+    def positive?
+      @raw > 0
+    end
+
+    # Checks to see if the value is positive.
+    #
+    # @return [true, false]
+    def non_negative?
+      @raw > -1
+    end
+
+    # Checks to see if the value is less than zero.
+    #
+    # @return [true, false]
+    def negative?
+      @raw < 0
+    end
+
+    # Calculates an amount based on the provided percentage.
+    #
+    # @param [Numeric, String] percentage
+    #
+    # @return Money
+    #
+    # @raise TypeError
+    def percent(percentage)
+      Money.new(@raw * (coerce(percentage) / BigDecimal.new('100')))
+    end
+
+    # Calculates the proportion of the provided amount as a percentage.
+    #
+    # @param SpookAndPuff::Money amount
+    #
+    # @return BigDecimal
+    #
+    # @raise TypeError
+    def proportion(amount)
+      amount.raw / @raw * BigDecimal('100')
+    end
+
+    # Rounds to the specified places; defaults to two.
+    # 
+    # @param Integer places
+    #
+    # @return Money
+    def round(places = 2)
+      Money.new(@raw.round(places))
+    end
+
+    # Returns a currency formatted string.
+    #
+    # @return String
+    def to_s
+      "$%.2f" % @raw.round(2)
+    end
+
+    private
+
+    # Grabs the raw value of a Money instance, erroring with a message 
+    # about comparison if it's the wrong type.
+    #
+    # @param SpookAndPuff::Money other
+    #
+    # @return BigDecimal
+    #
+    # @raise ArgumentError
+    def for_comparison(other)
+      unless other.is_a?(Money)
+        raise ArgumentError.new("#{other.class} cannot be compared with SpookAndPuff::Money")
+      end
+
+      other.raw
+    end
+
+    # Grabs the raw value of a Money instance, erroring with a message 
+    # about comparison if it's the wrong type.
+    #
+    # @param SpookAndPuff::Money other
+    # @param String op
+    #
+    # @return BigDecimal
+    #
+    # @raise ArgumentError
+    def for_operation(other, op)
+      unless other.is_a?(Money)
+        raise ArgumentError.new("Cannot perform #{op} on SpookAndPuff::Money with #{other.class}")
+      end
+
+      other.raw
+    end
+
+    # Coerces the provided value into a BigDecimal. It will handle any 
+    # Numeric or string.
+    #
+    # @param [Numeric, String] other
+    #
+    # @return BigDecimal
+    #
+    # @raise TypeError
+    def coerce(other)
+      case other
+      when BigDecimal then other
+      when String then BigDecimal.new(other)
+      when Integer, Fixnum, Bignum then BigDecimal.new(other.to_s)
+      else raise TypeError
+      end
+    end
+  end # Money
+end # SpookAndPuff

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: spook_and_puff_money
+version: !ruby/object:Gem::Version
+  version: '0.5'
+  prerelease: 
+platform: ruby
+authors:
+- Luke Sutton
+- Ben Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.6.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: 
+email:
+- lukeandben@spookandpuff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spook_and_puff/money.rb
+- MIT-LICENSE
+- README.md
+homepage: http://spookandpuff.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple money class.
+test_files: []
+has_rdoc: