lib/bank/no_exchange_bank.rb lib/bank/variable_exchange_bank.rb lib/money/core_extensions.rb lib/money/money.rb lib/support/cattr_accessor.rb tests/core_extensions_test.rb tests/money_test.rb tests/no_exchange_bank_test.rb tests/variable_exchange_bank_test.rb @@ -1,4 +1,4 @@ -Copyright (c) 2005 Tobias Luetke +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 MIT-LICENSE @@ -14,18 +14,13 @@ exporting. == Download - Preferred method of installation is gem: -gem install -s http://dist.leetsoft.com money + gem install --source http://dist.leetsoft.com money Alternatively you can get the library packed -http://dist.leetsoft.com/pkg/ - -If you plan to enhance this class please get a copy from svn so that -you can easily submit patches - -svn: svn://leetsoft.com/money/trunk + + http://dist.leetsoft.com/pkg/ == Useage @@ -34,7 +29,7 @@ object in your models. The following example requires a cents and a currency fie class ProductUnit < ActiveRecord::Base belongs_to :product - composed_of :price, :class_name => "Money", :mapping => %w(cents currency) + composed_of :price, :class_name => "Money", :mapping => [%w(cents cents) %(currency currency)] private validate :cents_not_zero @@ -47,6 +42,33 @@ object in your models. The following example requires a cents and a currency fie 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 README @@ -5,12 +5,16 @@ require 'rake/rdoctask' require 'rake/gempackagetask' require 'rake/contrib/rubyforgepublisher' -PKG_VERSION = "1.0.0" +PKG_VERSION = "1.3.2" PKG_NAME = "money" PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}" +RUBY_FORGE_PROJECT = 'money' +RUBY_FORGE_USER = 'xal' +RELEASE_NAME = "REL #{PKG_VERSION}" + PKG_FILES = FileList[ - "lib/**/*", "test/*", "[A-Z]*", "rakefile" + "lib/**/*", "tests/*", "[A-Z]*", "rakefile" ].exclude(/\bCVS\b|~$/) desc "Default Task" @@ -22,11 +26,15 @@ task :cleanup => [ :rm_packages, :clobber_rdoc ] # Run the unit tests Rake::TestTask.new("test") { |t| -# t.libs << "test" - t.pattern = 'test/*_test.rb' - t.verbose = true + t.libs << "test" + t.pattern = 'tests/*_test.rb' + t.verbose = false } +task :install => [:package] do + `gem install pkg/#{PKG_FILE_NAME}.gem` +end + # Genereate the RDoc documentation Rake::RDocTask.new { |rdoc| @@ -66,6 +74,8 @@ task :publish => [:rdoc, :package] do `ssh tobi@leetsoft.com "mkdir -p dist/api/#{PKG_NAME}"` Rake::SshDirPublisher.new("leetsoft.com", "dist/api/#{PKG_NAME}", "doc").upload `ssh tobi@leetsoft.com './gemupdate'` + `rm -rf pkg/` + `rm -rf doc/` end @@ -91,25 +101,124 @@ Rake::GemPackageTask.new(spec) do |p| p.need_zip = true end +# --- Ruby forge release manager by florian gross ------------------------------------------------- -=begin -desc "Packing generator to tgz" -task :package => [:cleanup] do - system %{ tar -czvf ../#{PKG_NAME}.tar.gz #{PKG_FILES} } -# system %{ cd ..; zip -r #{PKG_NAME}.zip #{PKG_NAME} } -end +RUBY_FORGE_PROJECT = 'money' +RUBY_FORGE_USER = 'xal' +RELEASE_NAME = "REL #{PKG_VERSION}" -desc "Sending package to server" -task :upload => [:package, :rdoc] do - publisher = Rake::CompositePublisher.new - publisher.add Rake::SshFilePublisher.new("leetsoft.com", "leetsoft.com/htdocs/rails/money", "..", "#{PKG_NAME}.tar.gz") -# publisher.add Rake::SshFilePublisher.new("leetsoft.com", "leetsoft.com/htdocs/rails/money", "..", "#{PKG_NAME}.zip") - publisher.add Rake::SshDirPublisher.new("leetsoft.com", "leetsoft.com/htdocs/rails/money", "doc") - publisher.upload -end -task :rm_packages do - system %{ cd ..; rm #{PKG_NAME}.tar.gz } -# system %{ cd ..; rm #{PKG_NAME}.zip } +desc "Publish the release files to RubyForge." +task :release => [:gem] do + files = ["gem"].map { |ext| "pkg/#{PKG_FILE_NAME}.#{ext}" } + + if RUBY_FORGE_PROJECT then + require 'net/http' + require 'open-uri' + + project_uri = "http://rubyforge.org/projects/#{RUBY_FORGE_PROJECT}/" + project_data = open(project_uri) { |data| data.read } + group_id = project_data[/[?&]group_id=(\d+)/, 1] + raise "Couldn't get group id" unless group_id + + # This echos password to shell which is a bit sucky + if ENV["RUBY_FORGE_PASSWORD"] + password = ENV["RUBY_FORGE_PASSWORD"] + else + print "#{RUBY_FORGE_USER}@rubyforge.org's password: " + password = STDIN.gets.chomp + end + + login_response = Net::HTTP.start("rubyforge.org", 80) do |http| + data = [ + "login=1", + "form_loginname=#{RUBY_FORGE_USER}", + "form_pw=#{password}" + ].join("&") + http.post("/account/login.php", data) + end + + cookie = login_response["set-cookie"] + raise "Login failed" unless cookie + headers = { "Cookie" => cookie } + + release_uri = "http://rubyforge.org/frs/admin/?group_id=#{group_id}" + release_data = open(release_uri, headers) { |data| data.read } + package_id = release_data[/[?&]package_id=(\d+)/, 1] + raise "Couldn't get package id" unless package_id + + first_file = true + release_id = "" + + files.each do |filename| + basename = File.basename(filename) + file_ext = File.extname(filename) + file_data = File.open(filename, "rb") { |file| file.read } + + puts "Releasing #{basename}..." + + release_response = Net::HTTP.start("rubyforge.org", 80) do |http| + release_date = Time.now.strftime("%Y-%m-%d %H:%M") + type_map = { + ".zip" => "3000", + ".tgz" => "3110", + ".gz" => "3110", + ".gem" => "1400" + }; type_map.default = "9999" + type = type_map[file_ext] + boundary = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor" + + query_hash = if first_file then + { + "group_id" => group_id, + "package_id" => package_id, + "release_name" => RELEASE_NAME, + "release_date" => release_date, + "type_id" => type, + "processor_id" => "8000", # Any + "release_notes" => "", + "release_changes" => "", + "preformatted" => "1", + "submit" => "1" + } + else + { + "group_id" => group_id, + "release_id" => release_id, + "package_id" => package_id, + "step2" => "1", + "type_id" => type, + "processor_id" => "8000", # Any + "submit" => "Add This File" + } + end + + query = "?" + query_hash.map do |(name, value)| + [name, URI.encode(value)].join("=") + end.join("&") + + data = [ + "--" + boundary, + "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{basename}\"", + "Content-Type: application/octet-stream", + "Content-Transfer-Encoding: binary", + "", file_data, "" + ].join("\x0D\x0A") + + release_headers = headers.merge( + "Content-Type" => "multipart/form-data; boundary=#{boundary}" + ) + + target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php" + http.post(target + query, data, release_headers) + end + + if first_file then + release_id = release_response.body[/release_id=(\d+)/, 1] + raise("Couldn't get release id") unless release_id + end + + first_file = false + end + end end -=end Rakefile @@ -1,181 +1,29 @@ -# === 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 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 - - DEFAULT = "CAD" - - EXCHANGE_RATES = { - "CAD_TO_USD" => 0.85, - "USD_TO_CAD" => 1.15, - } - - # 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) - @cents, @currency = cents, currency - 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) - if currency == other_money.currency - Money.new(cents + other_money.cents,currency) - else - Money.new(cents + other_money.exchange_to(currency).cents,currency) - end - end - - def -(other_money) - if currency == other_money.currency - Money.new(cents - other_money.cents, currency) - else - Money.new(cents - other_money.exchange_to(currency).cents, currency) - end - 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) - end - - # divide money by fixnum - def /(fixnum) - Money.new(cents / fixnum, currency) - 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 - - 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_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 CAD" - def to_s - format(:with_currency) - end - - # Recieve the amount of this money object in another currency - def exchange_to(other_currency) - rate = EXCHANGE_RATES["#{currency}_TO_#{other_currency}"] or raise "Can't find required exchange rate" - - exchanged_cents = (cents * rate).floor - Money.new(exchanged_cents, other_currency) - end - - # Create a new money object with value 0 - def self.empty(currency = DEFAULT) - 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 - - # 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 - - # Export the money class - # This is useful if you want to export Orders as XML as a means to get - # Them out of the dynamic DB and store them a bit more static - # ( Otherwise your completed orders would change in value when you put - # products on sale ) - # - # xml = XmlExporter.new - # Money.ca_dollar(1000).export(xml) - # xml.to_s => <money currency='CAD'>1000</money> - def export(exporter) - exporter.add_text("money", cents) - exporter.add_attribute("currency", currency) - end - -end \ No newline at end of file +#-- +# 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' \ No newline at end of file lib/money.rb lib/exporter/xml.rb test/money_test.rb a580bd396d12abb445f01d2b3fe15f32cd806bcf tobi tobi@da9ee5fb-4aef-0310-b2bf-b6c93f260786 http://github.com/aflatter/money/commit/0797e9da6b529cb5adf866e329b8ba960ea6ec77 0797e9da6b529cb5adf866e329b8ba960ea6ec77 2005-06-08T12:35:42-07:00 2005-06-08T12:35:42-07:00 some major updates. version bump to 1.3.1 git-svn-id: svn://leetsoft.com/money/trunk@8 da9ee5fb-4aef-0310-b2bf-b6c93f260786 8aee692f4a80cca2639e06c0dfa0aa45260f9561 tobi tobi@da9ee5fb-4aef-0310-b2bf-b6c93f260786