more_money 0.0.5

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+setup.rb
+lib/more_money.rb
+lib/more_money/version.rb
+lib/more_money/core_extensions.rb
+lib/more_money/more_money.rb
+test/test_helper.rb
+test/more_money_test.rb

data/README.txt

@@ -0,0 +1,3 @@
+README for more_money
+=====================
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'more_money', 'version')
+
+AUTHOR = "blank"  # can also be an array of Authors
+EMAIL = "your contact email for bug fixes and info"
+DESCRIPTION = "handles money objects using just integer as backend"
+GEM_NAME = "more_money" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "more_money" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
+
+
+NAME = "more_money"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (MoreMoney::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "more_money documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end
+          

data/lib/more_money/core_extensions.rb

@@ -0,0 +1,32 @@
+# 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] : MoreMoney::Money.default_currency
+    
+    # Get the cents amount
+    matches = scan(/(\-?\d+(\.(\d+))?)/)
+    cents = matches[0] ? (matches[0][0].to_f * 100) : 0
+    
+    MoreMoney::Money.new(cents, currency)
+  end
+end
+
+class NilClass
+  def to_money(currency = MoreMoney::Money.default_currency)
+    MoreMoney::Money.new(nil, currency)
+  end
+end

data/lib/more_money/more_money.rb

@@ -0,0 +1,291 @@
+# === 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
+#   
+#
+module MoreMoney
+  class MoneyMissingExchangeRate < StandardError# :nodoc:
+  end
+
+  class MoneyInvalidCurrency < StandardError# :nodoc:
+  end
+
+  class Money
+    include Comparable
+
+    attr_reader :currency
+
+    CURRENCIES = {}
+
+    DEFAULT_FORMATS = {}
+
+    EXCHANGE_RATES = {}
+
+    #the current default currency
+    def self.default_currency
+      @default_currency
+    end
+
+    #set the default currency
+    def self.default_currency=(currency)
+      @default_currency = currency
+    end
+
+    #set the exchange rate from a currency to anothe one
+    #
+    #  MoreMoney::Money.set_exchange_rate('USD', 'BGP', 0.51)
+    #
+    #the rate can be specified as a callable object which will be called
+    #at the moment of the conversion
+    def self.set_exchange_rate(starting_currency, destination_currency, rate)
+      EXCHANGE_RATES[[starting_currency, destination_currency]] = rate
+    end
+
+    #set a formatting default which will be used for any currency which has
+    #no formatting defaults otherwise specified
+    #
+    #  MoreMoney::Money.set_default_format(0, 'free')
+    #
+    def self.set_default_format(cents, default_format)
+      DEFAULT_FORMATS[cents] = default_format
+    end
+
+    #returns the exchange rate from the first currency to the second one
+    #
+    #  MoreMoney::Money.get_exchange_rate(starting_currency, destination_currency)
+    #
+    def self.get_exchange_rate(starting_currency, destination_currency)
+      rate = EXCHANGE_RATES[[starting_currency, destination_currency]]
+      return rate.respond_to?(:call) ? rate.call : rate
+    end
+
+    #adds a currency to the set of available ones.
+    #
+    #  MoreMoney::Money.add_currency({:code => 'USD', :symbol => '$', :description => 'us_dollar'})
+    #
+    #the line above will add the US dollar currency, the description will be
+    #used to create the method MoreMoney::Money.us_dollar(cents) which can be
+    #used to instantiate new Money object with USD as a currency
+    #
+    #2 optional parameters can be specified: :format, :format_defaults
+    #
+    #:format option can be specified to
+    #control the formatting method for the specific currency
+    #the :format parameter will be called passing 4 arguments:
+    #  cents, currency, currency symbol, rules
+    #
+    #:format_defaults need to be an hash with the cents value as keys and the
+    #custom string format to use
+    #
+    #  MoreMoney::Money.add_currency({:code => 'USD', :symbol => '$', :description => 'us_dollar'})
+    #
+    #  MoreMoney::Money.new(0, 'USD').format
+    #
+    #  => '$ 0.00'
+    #
+    #  MoreMoney::Money.add_currency({:code => 'USD', :symbol => '$', :description => 'us_dollar', :format_defaults => { 0 => 'free' }})
+    #
+    #  MoreMoney::Money.new(0, 'USD').format
+    #
+    #  => 'free'
+    #
+    def self.add_currency(currency_hash)
+      code = currency_hash.delete(:code)
+      CURRENCIES[code]= currency_hash
+      if currency_hash[:description]
+        (class << self; self; end).module_eval do
+          define_method(currency_hash[:description]) do |cents|
+            Money.new(cents, code) 
+          end
+        end
+      end
+    end
+
+    #loads some currencies, see the code to know which one
+    def self.load_std_currencies
+      add_currency({:code => 'USD', :symbol => '$', :description => 'us_dollar'})
+      add_currency({:code => 'GBP', :symbol => '£', :description => 'gb_pound'})
+      add_currency({:code => 'EUR', :symbol => '€', :description => 'euro'})
+      add_currency({:code => 'AUD', :symbol => '$', :description => 'au_dollar'})
+      add_currency({:code => 'CAD', :symbol => '$', :description => 'ca_dollar'})
+      add_currency({:code => 'CHF', :symbol => 'CHF', :description => 'ch_franc'})
+      add_currency({:code => 'JPY', :symbol => '¥', :description => 'jp_yen'})
+    end
+
+    # Creates a new money object. 
+    #
+    #  Money.new(100) 
+    # 
+    def initialize(cents, currency = Money.default_currency)
+      raise MoneyInvalidCurrency, "#{currency} is not defined as a currency" unless CURRENCIES.key?(currency)
+      @currency = currency
+      @cents = cents.nil? ? nil : cents.round
+    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 cents == nil
+        return true if other_money.cents == nil
+      elsif currency == other_money.currency
+        return 0 <=> other_money.cents if cents == nil
+        return cents <=> 0 if other_money.cents == nil
+           
+        cents <=> other_money.cents
+      else
+        cents <=> other_money.exchange_to(currency).cents
+      end
+    end
+
+    #sums two money objects
+    def +(other_money)
+      return other_money.dup if cents.nil? || cents.zero?
+      return dup if other_money.cents.nil? || other_money.cents.zero?
+  
+      if currency == other_money.currency
+        Money.new(cents + other_money.cents, other_money.currency)
+      else
+        Money.new(cents + other_money.exchange_to(currency).cents,currency)
+      end   
+    end
+
+    #subtracts a money object from another one
+    def -(other_money)
+
+      return Money.new(0 - other_money.cents, other_money.currency) if self.cents.nil? || self.cents.zero?
+      return self.dup if other_money.cents.nil? || other_money.cents.zero?
+  
+      if currency == other_money.currency
+        Money.new(cents - other_money.cents, other_money.currency)
+      else
+        Money.new(cents - other_money.exchange_to(currency).cents, currency)
+      end   
+    end
+
+
+    # multiply money by fixnum
+    def *(fixnum)
+      return self.dup if self.cents.nil?
+      Money.new(cents * fixnum, currency)
+    end
+
+    # divide money by fixnum
+    def /(fixnum)
+      return self.dup if self.cents.nil?
+      Money.new(cents / fixnum, currency)
+    end
+
+    # Test if the money amount is zero
+    def zero?
+      return false if cents.nil?
+      cents == 0
+    end
+
+    # get the cents value of the object
+    def cents
+      @cents.nil? ? nil : @cents.to_i
+    end
+
+    # Format the price according rules
+    # Currently supported are :with_currency, :with_thousands, :no_cents and :html
+    #
+    # with_currency: 
+    #
+    #  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"
+    #
+    # with_thousands: 
+    #
+    #  Money.us_dollar(100000).format() => "$ 1000.00"
+    #  Money.us_dollar(100000).format(:with_thousands) => "$ 1,000.00"
+    #
+    # 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 CURRENCIES[currency][:format_defaults][cents] if CURRENCIES[currency][:format_defaults] && CURRENCIES[currency][:format_defaults][cents]
+      rules = rules.flatten
+      return CURRENCIES[currency][:format].call(cents, currency, CURRENCIES[currency][:symbol], rules) if CURRENCIES[currency][:format]
+      return DEFAULT_FORMATS[cents] if DEFAULT_FORMATS[cents]
+
+
+      if rules.include?(:no_cents)
+        formatted = sprintf("%d", cents.to_f / 100  )          
+      else
+        formatted = sprintf("%.2f", cents.to_f / 100  )      
+      end
+      
+      if rules.include?(:with_thousands)
+        formatted = formatted.reverse!.split('')
+        newstr = []
+        3.times { newstr << formatted.shift } unless rules.include?(:no_cents)
+        formatted.each_with_index do |num, index|
+          newstr << ',' if index !=0 && index % 3 == 0
+          newstr << num
+        end
+        formatted = newstr.to_s.reverse!
+      end
+
+      #if rules.include?(:with_symbol)
+      formatted = "#{CURRENCIES[currency][:symbol]} #{formatted}"
+      #end
+ 
+      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.new(100, 'USD').to_s => "1.00"
+    def to_s
+      sprintf("%.2f", cents.to_f / 100  )
+    end
+
+    # Recieve the amount of this money object in another currency   
+    def exchange_to(other_currency)
+      return self if other_currency == currency
+      raise MoneyMissingExchangeRate if Money.get_exchange_rate(currency, other_currency).nil?
+      Money.new(cents * Money.get_exchange_rate(currency, other_currency), other_currency)
+    end  
+
+    # Create a new money object with value 0
+    def self.empty(currency = default_currency)
+      Money.new(0, currency)
+    end
+    # Conversation to self
+    def to_money
+      self
+    end  
+  end
+end

data/lib/more_money/version.rb

@@ -0,0 +1,9 @@
+module MoreMoney #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 5
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/more_money.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'more_money/**/*.rb')].sort.each { |lib| require lib }