brandon-money 1.7.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Tobias Lutke
+
+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

@@ -0,0 +1,75 @@
+== Money class
+
+This money class is based on the example from the ActiveRecord doc:
+http://api.rubyonrails.org/classes/ActiveRecord/Aggregations/ClassMethods.html
+
+Its in production use at http://www.snowdevil.ca and I haven't found any major issues
+so far. 
+The main reason to open source it is because It might be useful to other people and 
+I hope i'll get some feedback on how to improve the class. 
+
+I bundled the exporter with the money class since some tests depend on it and I figured
+that most applications which need to deal with Money also need to deal with proper 
+exporting. 
+
+== Download
+
+Preferred method of installation is gem: 
+
+  gem install --source http://dist.leetsoft.com money 
+
+Alternatively you can get the library packed
+  
+  http://dist.leetsoft.com/pkg/
+
+== Usage
+
+Use the compose_of helper to let active record deal with embedding the money
+object in your models. The following example requires a cents and a currency field.
+
+  class ProductUnit < ActiveRecord::Base
+    belongs_to :product
+    composed_of :price, :class_name => "Money", :mapping => [%w(cents cents) %(currency currency)]
+
+    private        
+      validate :cents_not_zero
+    
+      def cents_not_zero
+        errors.add("cents", "cannot be zero or less") unless cents > 0
+      end
+    
+      validates_presence_of :sku, :currency
+      validates_uniqueness_of :sku        
+  end
+  
+== Class configuration
+
+Two const class variables are available to tailor Money to your needs. 
+If you don't need currency exchange at all, just ignore those.
+
+=== Default Currency
+
+By default Money defaults to USD as its currency. This can be overwritten using
+
+  Money.default_currency = "CAD"
+  
+If you use rails, the environment.rb is a very good place to put this. 
+
+=== Currency Exchange
+
+The second parameter is a bit more complex. It lets you provide your own implementation of the 
+currency exchange service. By default Money throws an exception when trying to call .exchange_to. 
+
+A second minimalist implementation is provided which lets you supply custom exchange rates:
+
+  Money.bank = VariableExchangeBank.new 
+  Money.bank.add_rate("USD", "CAD", 1.24515)
+  Money.bank.add_rate("CAD", "USD", 0.803115)
+  Money.us_dollar(100).exchange_to("CAD") => Money.ca_dollar(124)
+  Money.ca_dollar(100).exchange_to("USD") => Money.us_dollar(80)
+
+There is nothing stopping you from creating bank objects which scrape www.xe.com for the current rates or just return rand(2)
+  
+== Code
+
+If you have any improvements please email them to tobi [at] leetsoft.com 

data/lib/bank/no_exchange_bank.rb

@@ -0,0 +1,9 @@
+class NoExchangeBank# :nodoc:
+
+  def reduce(money, currency)
+    return money if money.currency == currency
+    raise Money::MoneyError.new("Current Money::bank does not support money exchange. Please implement a bank object that does and assign it to the Money class.")
+  end
+  
+  
+end

data/lib/bank/variable_exchange_bank.rb

@@ -0,0 +1,30 @@
+# Example useage:
+#
+#  Money.bank = VariableExchangeBank.new
+#  Money.bank.add_rate("USD", "CAD", 1.24515)
+#  Money.bank.add_rate("CAD", "USD", 0.803115)
+#  Money.us_dollar(100).exchange_to("CAD") => Money.ca_dollar(124)
+#  Money.ca_dollar(100).exchange_to("USD") => Money.us_dollar(80)
+class VariableExchangeBank 
+   
+  def add_rate(from, to, rate)
+    rates["#{from}_TO_#{to}".upcase] = rate
+  end
+  
+  def get_rate(from, to)
+    rates["#{from}_TO_#{to}".upcase] 
+  end
+  
+  def reduce(money, currency)
+    rate = get_rate(money.currency, currency) or raise Money::MoneyError.new("Can't find required exchange rate")
+    
+    Money.new((money.cents * rate).floor, currency, money.precision)
+  end
+  
+  private
+  
+  def rates
+    @rates ||= {} 
+  end
+  
+end

data/lib/money/core_extensions.rb

@@ -0,0 +1,26 @@
+# Allows Writing of 100.to_money for +Numeric+ types
+#   100.to_money => #<Money @cents=10000>
+#   100.37.to_money => #<Money @cents=10037>
+class Numeric
+  def to_money
+    Money.new(self * 100)
+  end
+end
+
+# Allows Writing of '100'.to_money for +String+ types
+# Excess characters will be discarded
+#   '100'.to_money => #<Money @cents=10000>
+#   '100.37'.to_money => #<Money @cents=10037>
+class String
+  def to_money
+    # Get the currency
+    matches = scan /([A-Z]{2,3})/ 
+    currency = matches[0] ? matches[0][0] : Money.default_currency
+    
+    # Get the cents amount
+    matches = scan /(\-?\d+(\.(\d+))?)/
+    cents = matches[0] ? (matches[0][0].to_f * 100) : 0
+    
+    Money.new(cents, currency)
+  end
+end

data/lib/money/money.rb

@@ -0,0 +1,202 @@
+# === Usage with ActiveRecord
+# 
+# Use the compose_of helper to let active record deal with embedding the money
+# object in your models. The following example requires a cents and a currency field.
+# 
+#   class ProductUnit < ActiveRecord::Base
+#     belongs_to :product
+#     composed_of :price, :class_name => "Money", :mapping => [ %w(cents cents), %w(currency currency) ]
+# 
+#     private        
+#       validate :cents_not_zero
+#     
+#       def cents_not_zero
+#         errors.add("cents", "cannot be zero or less") unless cents > 0
+#       end
+#     
+#       validates_presence_of :sku, :currency
+#       validates_uniqueness_of :sku        
+#   end
+#   
+class Money
+  include Comparable
+
+  attr_reader :cents, :currency, :precision
+
+  class MoneyError < StandardError# :nodoc:
+  end
+
+  # Bank lets you exchange the object which is responsible for currency
+  # exchange. 
+  # The default implementation just throws an exception. However money
+  # ships with a variable exchange bank implementation which supports
+  # custom excahnge rates:
+  #
+  #  Money.bank = VariableExchangeBank.new
+  #  Money.bank.add_rate("USD", "CAD", 1.24515)
+  #  Money.bank.add_rate("CAD", "USD", 0.803115)
+  #  Money.us_dollar(100).exchange_to("CAD") => Money.ca_dollar(124)
+  #  Money.ca_dollar(100).exchange_to("USD") => Money.us_dollar(80)
+  @@bank = NoExchangeBank.new
+  cattr_accessor :bank
+
+  @@default_currency = "USD"
+  cattr_accessor :default_currency
+
+  # Creates a new money object. 
+  #  Money.new(100) 
+  # 
+  # Alternativly you can use the convinience methods like 
+  # Money.ca_dollar and Money.us_dollar 
+  def initialize(cents, currency = default_currency, precision = 2)
+    @cents, @currency, @precision = cents.round, currency, precision
+  end
+
+  # Do two money objects equal? Only works if both objects are of the same currency
+  def eql?(other_money)
+    cents == other_money.cents && currency == other_money.currency
+  end
+
+  def <=>(other_money)
+    if currency == other_money.currency
+      cents <=> other_money.cents
+    else
+      cents <=> other_money.exchange_to(currency).cents
+    end
+  end
+
+  def +(other_money)
+    other_money = other_money.exchange_to(currency) unless other_money.currency == currency
+    
+    new_precision = [precision, other_money.precision].max
+    Money.new(to_precision(new_precision).cents + other_money.to_precision(new_precision).cents, currency, new_precision)
+  end
+
+  def -(other_money)
+    other_money = other_money.exchange_to(currency) unless other_money.currency == currency
+    
+    new_precision = [precision, other_money.precision].max
+    Money.new(to_precision(new_precision).cents - other_money.to_precision(new_precision).cents, currency, new_precision)
+  end
+
+  # get the cents value of the object
+  def cents
+    @cents.to_i
+  end
+
+  # multiply money by fixnum
+  def *(fixnum)
+    Money.new(cents * fixnum, currency, precision)
+  end
+
+  # divide money by fixnum
+  def /(fixnum)
+    Money.new(cents / fixnum, currency, precision)
+  end
+  
+  # Test if the money amount is zero
+  def zero?
+    cents == 0 
+  end
+
+
+  # Format the price according to several rules
+  # Currently supported are :with_currency, :no_cents and :html
+  #
+  # with_currency: 
+  #
+  #  Money.ca_dollar(0).format => "free"
+  #  Money.ca_dollar(100).format => "$1.00"
+  #  Money.ca_dollar(100).format(:with_currency) => "$1.00 CAD"
+  #  Money.us_dollar(85).format(:with_currency) => "$0.85 USD"
+  #
+  # no_cents:  
+  #
+  #  Money.ca_dollar(100).format(:no_cents) => "$1"
+  #  Money.ca_dollar(599).format(:no_cents) => "$5"
+  #  
+  #  Money.ca_dollar(570).format(:no_cents, :with_currency) => "$5 CAD"
+  #  Money.ca_dollar(39000).format(:no_cents) => "$390"
+  #
+  # html:
+  #
+  #  Money.ca_dollar(570).format(:html, :with_currency) =>  "$5.70 <span class=\"currency\">CAD</span>"
+  def format(*rules)
+    return "free" if cents == 0
+
+    rules = rules.flatten
+
+    formatted = "$" + to_s(rules.include?(:no_cents) ? 0 : 2)
+
+    if rules.include?(:with_currency)
+      formatted << " "
+      formatted << '<span class="currency">' if rules.include?(:html)
+      formatted << currency
+      formatted << '</span>' if rules.include?(:html)
+    end
+    formatted
+  end
+
+  # Money.ca_dollar(100).to_s => "1.00"
+  def to_s(show_precision = precision)
+    if show_precision > 0
+      sprintf("%.#{show_precision}f", cents.to_f / 10 ** precision  )
+    else
+      sprintf("%d", cents.to_f / 10 ** (precision - show_precision)  )
+    end
+  end
+
+  # Recieve the amount of this money object in another currency   
+  def exchange_to(other_currency)
+    self.class.bank.reduce(self, other_currency)
+  end
+  
+  def to_precision(new_precision)
+    difference = new_precision - precision
+    new_cents = difference > 0 ? cents * 10**difference : (cents.to_f / 10**difference.abs).round
+    Money.new(new_cents, 'USD', new_precision)
+  end
+
+  # Create a new money object with value 0
+  def self.empty(currency = default_currency)
+    Money.new(0, currency)
+  end
+
+  # Create a new money object using the Canadian dollar currency
+  def self.ca_dollar(num)
+    Money.new(num, "CAD")
+  end
+
+  # Create a new money object using the American dollar currency
+  def self.us_dollar(num)
+    Money.new(num, "USD")
+  end
+
+  # Create a new money object using the Euro currency
+  def self.euro(num)
+    Money.new(num, "EUR")
+  end
+
+  # Recieve a money object with the same amount as the current Money object
+  # in american dollar 
+  def as_us_dollar
+    exchange_to("USD")
+  end
+
+  # Recieve a money object with the same amount as the current Money object
+  # in canadian dollar 
+  def as_ca_dollar
+    exchange_to("CAD")
+  end
+
+  # Recieve a money object with the same amount as the current Money object
+  # in euro
+  def as_ca_euro
+    exchange_to("EUR")
+  end  
+
+  # Conversation to self
+  def to_money
+    self
+  end  
+end

data/lib/money.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2005 Tobias Luetke
+#
+# 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.
+#++
+
+
+require File.dirname(__FILE__) + '/support/cattr_accessor'
+require File.dirname(__FILE__) + '/bank/no_exchange_bank'
+require File.dirname(__FILE__) + '/bank/variable_exchange_bank'
+require File.dirname(__FILE__) + '/money/money'
+require File.dirname(__FILE__) + '/money/core_extensions'

data/lib/support/cattr_accessor.rb

@@ -0,0 +1,57 @@
+# Extends the class object with class and instance accessors for class attributes, 
+# just like the native attr* accessors for instance attributes.
+class Class # :nodoc:
+  def cattr_reader(*syms)
+    syms.each do |sym|
+      class_eval <<-EOS
+        if ! defined? @@#{sym.id2name}
+          @@#{sym.id2name} = nil
+        end
+        
+        def self.#{sym.id2name}
+          @@#{sym}
+        end
+
+        def #{sym.id2name}
+          @@#{sym}
+        end
+
+        def call_#{sym.id2name}
+          case @@#{sym.id2name}
+            when Symbol then send(@@#{sym})
+            when Proc   then @@#{sym}.call(self)
+            when String then @@#{sym}
+            else nil
+          end
+        end
+      EOS
+    end
+  end
+  
+  def cattr_writer(*syms)
+    syms.each do |sym|
+      class_eval <<-EOS
+        if ! defined? @@#{sym.id2name}
+          @@#{sym.id2name} = nil
+        end
+        
+        def self.#{sym.id2name}=(obj)
+          @@#{sym.id2name} = obj
+        end
+
+        def self.set_#{sym.id2name}(obj)
+          @@#{sym.id2name} = obj
+        end
+
+        def #{sym.id2name}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+  end
+  
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: brandon-money
+version: !ruby/object:Gem::Version 
+  version: 1.7.2
+platform: ruby
+authors: 
+- Tobias Luetke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Class aiding in the handling of Money and Currencies. It supports easy pluggable bank objects for customized exchange strategies. Can be used as composite in ActiveRecord tables.
+email: tobi@leetsoft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- MIT-LICENSE
+- lib/bank/no_exchange_bank.rb
+- lib/bank/variable_exchange_bank.rb
+- lib/money
+- lib/money/core_extensions.rb
+- lib/money/money.rb
+- lib/money.rb
+- lib/support
+- lib/support/cattr_accessor.rb
+has_rdoc: true
+homepage: http://leetsoft.com/rails/money
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Class aiding in the handling of Money.
+test_files: []
+