phosney-money 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 ishmael
+
+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.rdoc

@@ -0,0 +1,17 @@
+= money
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 ishmael. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "phosney-money"
+    gem.summary = %Q{Class aiding in the handling of Money.}
+    gem.description = %Q{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.}
+    gem.email = "ishmael@blackbalto.com"
+    gem.homepage = "http://github.com/ishmael/money"
+    gem.authors = ["Manuel Silva"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.files.include 'lib/**/*.rb'
+    #gem.files = FileList['lib/**/*.rb']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "money #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/money/bank/no_exchange_bank.rb

@@ -0,0 +1,9 @@
+class NoExchangeBank# :nodoc:
+
+  def exchange(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/money/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 exchange(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,64 @@
+class Numeric
+  # Convert the number to a +Money+ object.
+  #
+  #   100.to_money      #=> #<Money @cents=10000>
+  #
+  # Takes an optional precision, which defaults to 2
+  def to_money(precision = 2)
+    Money.new(self * 10**precision, Money.default_currency, precision)
+  end
+end
+
+class Float
+  # Convert the float to a +Money+ object.
+  #
+  #   3.75.to_money     #=> #<Money @cents=375>
+  #
+  # It takes an optional precision, which defaults to 2 or the number of digits
+  # after the decimal point if it's more than 2.
+  def to_money(precision = nil)
+    to_s.to_money(precision)
+  end
+end
+
+class String
+  # Convert the String to a +Money+ object.
+  #
+  #   '100'.to_money    #=> #<Money @cents=10000>
+  #   '100.37'.to_money #=> #<Money @cents=10037>
+  #   '.37'.to_money    #=> #<Money @cents=37>
+  #
+  # It takes an optional precision argument which defaults to 2 or the number of
+  # digits after the decimal point if it's more than 2.
+  #
+  #   '3.479'.to_money  # => #<Money @cents=3479 @precision=3>
+  #
+  # Locale support:
+  #   If
+  #    number.format.separator = ","
+  #    number.format.separator = "."
+  #  Then
+  #    '100,37'.to_money #=> #<Money @cents=10037>
+  #
+  def to_money(precision = nil)
+    # Get the currency
+    matches = scan /([A-Z]{2,3})/ 
+    currency = matches[0] ? matches[0][0] : Money.default_currency
+
+    separator = I18n.translate("number.format.separator", :default => ".")
+    delimiter = I18n.translate("number.format.delimiter", :default => ",")
+
+    if !precision
+      matches = scan(Regexp.new("\\#{separator}(\\d+)"))
+      precision =  matches[0] ? matches[0][0].length : 2
+      precision = 2 if precision < 2
+    end
+    
+    # Get the cents amount
+    str = self =~ /^(\.|,)/ ? "0#{self}" : self
+    matches = str.scan(Regexp.new("(\\-?[\\d\\#{delimiter}]+(\\#{separator}(\\d+))?)"))
+    cents = matches[0] ? (matches[0][0].gsub(delimiter, '').gsub(',','.').to_f * 10**precision) : 0
+
+    Money.new(cents, currency, precision)
+  end
+end

data/lib/money/rails.rb

@@ -0,0 +1,41 @@
+require 'money'
+
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    module Money #:nodoc:
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def money(name, options = {})
+          allow_nil = options.has_key?(:allow_nil) ? options.delete(:allow_nil) : true
+          options = {:precision => 2, :cents => "#{name}_in_cents".to_sym }.merge(options)
+          mapping = [[options[:cents], 'cents']]
+          mapping << [options[:currency].to_s, 'currency'] if options[:currency]
+          composed_of name, :class_name => 'Money', :mapping => mapping, :allow_nil => allow_nil,
+            :converter => lambda{ |m|
+              if !allow_nil && m.nil?
+                currency = options[:currency] || ::Money.default_currency
+                m = ::Money.new(0, currency, options[:precision])
+              end
+              m.to_money(options[:precision])
+            },
+            :constructor => lambda{ |*args| 
+              cents, currency = args
+              cents ||= 0
+              currency ||= ::Money.default_currency
+              ::Money.new(cents, currency, options[:precision]) 
+            }
+
+          define_method "#{name}_with_cleanup=" do |amount|
+            send "#{name}_without_cleanup=", amount.blank? ? nil : amount.to_money(options[:precision])
+          end
+          alias_method_chain "#{name}=", :cleanup
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Money

data/lib/money.rb

@@ -0,0 +1,254 @@
+require 'support/cattr_accessor'
+require 'money/bank/no_exchange_bank'
+require 'money/bank/variable_exchange_bank'
+require 'money/core_extensions'
+
+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
+  
+  # String to use when formating zero values
+  cattr_accessor :zero
+
+  # 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
+
+  def -@
+    Money.new(-cents, currency, precision)
+  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 self.class.zero if zero? && self.class.zero
+    
+    rules = rules.flatten
+     case self.currency
+      when 'EUR'
+        formatted = to_format(rules.include?(:no_cents) ? 0 : 2) +"\u20AC" 
+      when 'GBP'
+        formatted = "\u00A3" + to_format(rules.include?(:no_cents) ? 0 : 2)
+      when 'USD'
+        formatted = "$" + to_format(rules.include?(:no_cents) ? 0 : 2)
+      when 'CAD'
+       formatted = "$" + to_format(rules.include?(:no_cents) ? 0 : 2)
+      else
+        formatted = "$" + to_format(rules.include?(:no_cents) ? 0 : 2)
+      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.ca_dollar(100).to_s => "1.00"
+  #
+  # Locale support:
+  #   If
+  #    number.currency.separator = ","
+  #    number.currency.separator = "."
+  #  Then
+  #    Money.ca_dollar(100).to_s => "1,00"
+  #
+  def to_s(show_precision = precision)
+    s_separator = I18n.translate("number.format.separator", :default => ".")
+    if show_precision > 0
+      sprintf("%.#{show_precision}f", to_f  ).gsub('.', s_separator)
+    else
+      sprintf("%d", cents.to_f / 10 ** (precision - show_precision)  ).gsub('.', s_separator)
+    end
+  end
+  
+  def to_format(show_precision = precision)
+    if show_precision > 0
+      sprintf("%.#{show_precision}f", to_f  ).gsub('.', separator)
+    else
+      sprintf("%d", cents.to_f / 10 ** (precision - show_precision)  ).gsub('.', separator)
+    end
+  end
+  
+  def to_chart(*rules)
+    rules = rules.flatten
+    case self.currency
+      when 'EUR'
+        formatted =  to_s(rules.include?(:no_cents) ? 0 : 2) +"&#x20AC;" 
+      when 'GBP'
+        formatted = "&#x00A3;" +  to_s(rules.include?(:no_cents) ? 0 : 2)
+      when 'USD'
+        formatted = "&#x0024;" +  to_s(rules.include?(:no_cents) ? 0 : 2)
+      when 'CAD'
+       formatted = "&#x0024;" + to_s(rules.include?(:no_cents) ? 0 : 2)
+      else
+        formatted = "&#x0024;" +  to_s(rules.include?(:no_cents) ? 0 : 2)
+      end
+    formatted
+  end
+  
+  def separator
+    case self.currency
+      when 'EUR'
+          ','
+      when 'GBP'
+        ','
+      when 'USD'
+        '.'
+      when 'CAD'
+       '.'
+      else
+        '.'
+      end
+  end
+  
+  def to_f
+    cents.to_f / 10 ** precision
+  end
+
+  # Recieve the amount of this money object in another currency   
+  def exchange_to(other_currency)
+    self.class.bank.exchange(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, currency, 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(precision = nil)
+    precision ? to_precision(precision) : self
+  end  
+end

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 unless instance_methods.include?('cattr_reader')
+  
+  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  unless instance_methods.include?('cattr_writer')
+  
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end unless instance_methods.include?('cattr_accessor')
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'money'
+
+class Test::Unit::TestCase
+end

data/test/test_money.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMoney < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: phosney-money
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Manuel Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+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: ishmael@blackbalto.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/money.rb
+- lib/money/bank/no_exchange_bank.rb
+- lib/money/bank/variable_exchange_bank.rb
+- lib/money/core_extensions.rb
+- lib/money/rails.rb
+- lib/support/cattr_accessor.rb
+- test/helper.rb
+- test/test_money.rb
+has_rdoc: true
+homepage: http://github.com/ishmael/money
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Class aiding in the handling of Money.
+test_files: 
+- test/helper.rb
+- test/test_money.rb