currency 0.1.1 → 0.1.2

data/Manifest.txt

@@ -0,0 +1,25 @@
+test/xe_test.rb
+test/money_test.rb
+test/test_base.rb
+lib/currency/money_helper.rb
+lib/currency/exception.rb
+lib/currency/currency_version.rb
+lib/currency/currency_factory.rb
+lib/currency/core_extensions.rb
+lib/currency/money.rb
+lib/currency/active_record.rb
+lib/currency/currency.rb
+lib/currency/exchange.rb
+lib/currency/exchange/base.rb
+lib/currency/exchange/test.rb
+lib/currency/exchange/xe.rb
+lib/currency/exchange/rate.rb
+lib/currency.rb
+examples/xe1.rb
+examples/ex1.rb
+ChangeLog
+Rakefile
+TODO
+Releases
+README
+Manifest.txt

data/Rakefile

@@ -4,324 +4,57 @@
 
 #################################################################
 
-PKG_Name = 'Currency'
-def package_version
-  '0.1.1'
-end
-def package_description
-  %{Currency models currencies, monetary values, foreign exchanges.}
-end
-
-#################################################################
-
-#require 'rubygems'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems'
+require 'hoe'
 
 #################################################################
 
-def announce(msg='')
-  STDERR.puts msg
-end
-
+PKG_Name = 'Currency'
 PKG_NAME = PKG_Name.gsub(/[a-z][A-Z]/) {|x| "#{x[0,1]}_#{x[1,1]}"}.downcase
-RUBY_FORGE_PROJECT = PKG_NAME
-
-if ENV['REL']
-  PKG_VERSION = ENV['REL']
-  CURRENT_VERSION = package_version
-else
-  PKG_VERSION = package_version
-  CURRENT_VERSION = PKG_VERSION
-end
-
-CLEAN.include("COMMENTS")
-CLOBBER.include(
-  "test/data",
-  "test/temp",
-  'scripts/*.hieraki',
-  'data__',
-  'html',
-  'pkgs/sources/sources*.gem',
-  '.config',
-  '**/debug.log',
-  '**/development.log',
-  'logs'
-  )
-
-task :default => [:test]
-
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/*test*.rb']
-end
-
-Rake::TestTask.new(:functional) do |t|
-  t.test_files = FileList['test/functional*.rb']
-end
-
-Rake::TestTask.new(:alltests) do |t|
-  t.test_files = FileList['test/{*test,functional}*.rb']
-end
 
-desc "Run the tests for a build"
-task :build_tests do
-  html_dir = ENV['TESTRESULTS'] || 'html/tests'
-  ruby %{-Ilib scripts/buildtests.rb #{html_dir}}
-  open("#{html_dir}/summary.html") do |inf|
-    open("#{html_dir}/summary.new", "w") do |outf|
-      inf.each do |line|
-	if line =~ /td align/
-	  line = "    <td align=\"left\">#{Time.now}</td><td align=\"right\">"
-	end
-	outf.puts line
-      end
-    end
-  end
-  mv "#{html_dir}/summary.html", "#{html_dir}/summary.old"
-  mv "#{html_dir}/summary.new", "#{html_dir}/summary.html"      
-end
-
-# Shortcuts for test targets
-task :tf => [:functional]
-task :tu => [:test]
-task :ta => [:alltests]
-
-task :gemtest do
-  ruby %{-Ilib -rscripts/runtest -e 'run_tests("test/test_gempaths.rb", true)'}
-end
-
-# --------------------------------------------------------------------
-# Creating a release
-
-desc "Make a new release"
-task :release => [
-  :prerelease,
-  :clobber,
-  :alltests,
-  :update_version,
-  :package,
-  :tag] do
+hoe = Hoe.new("currency", '0.1.2') do |p|
+  p.author = 'Kurt Stephens'
+  p.description = %{Currency models currencies, monetary values, foreign exchanges.}
+  p.email = "ruby-#{PKG_NAME}@umleta.com"
+  p.summary = p.description
+  p.url = "http://rubyforge.org/projects/#{PKG_NAME}"
   
-  announce 
-  announce "**************************************************************"
-  announce "* Release #{PKG_VERSION} Complete."
-  announce "* Packages ready to upload."
-  announce "**************************************************************"
-  announce 
+  p.test_globs = ['test/**/*.rb']
 end
 
-# Validate that everything is ready to go for a release.
-task :prerelease do
-  announce 
-  announce "**************************************************************"
-  announce "* Making #{PKG_Name} Release #{PKG_VERSION}"
-  announce "* (current version #{CURRENT_VERSION})"
-  announce "**************************************************************"
-  announce  
+PKG_VERSION = hoe.version
 
-  # Is a release number supplied?
-  unless ENV['REL']
-    fail "Usage: rake release REL=x.y.z [REUSE=tag_suffix]"
-  end
-
-  # Is the release different than the current release.
-  # (or is REUSE set?)
-  if PKG_VERSION == CURRENT_VERSION && ! ENV['REUSE']
-    fail "Current version is #{PKG_VERSION}, must specify REUSE=tag_suffix to reuse version"
-  end
+#################################################################
+# Version file
+#
 
-  # Are all source files checked in?
-  if ENV['RELTEST']
-    announce "Release Task Testing, skipping checked-in file test"
-  else
-    announce "Checking for unchecked-in files..."
-    data = `svn status`
-    unless data =~ /^$/
-      fail "svn status is not clean ... do you have unchecked-in files?"
-    end
-    announce "No outstanding checkins found ... OK"
-  end
+def announce(msg='')
+  STDERR.puts msg
 end
 
-task :update_version => [:prerelease] do
-  if PKG_VERSION == CURRENT_VERSION && ! ENV['FORCE']
-    announce "No version change ... skipping version update"
-  else
-    announce "Updating #{PKG_Name} version to #{PKG_VERSION}"
-    version_rb = "lib/#{PKG_NAME}/#{PKG_NAME}_version.rb"
-    open(version_rb, "w") do |f|
-      f.puts "# DO NOT EDIT"
-      f.puts "# This file is auto-generated by build scripts."
-      f.puts "# See:  rake update_version"
-      f.puts "module #{PKG_Name}"
-      f.puts "  #{PKG_Name}Version = '#{PKG_VERSION}'"
-      f.puts "end"
-    end
-    if ENV['RELTEST']
-      announce "Release Task Testing, skipping commiting of new version"
-    else
-      sh %{svn commit -m "Updated to version #{PKG_VERSION}" #{version_rb}}
-    end
-  end
-end
+version_rb = "lib/#{PKG_NAME}/#{PKG_NAME}_version.rb"
 
-# FIX ME for SVN
-task :tag => [:prerelease] do
-  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
-  reltag << ENV['REUSE'].gsub(/\./, '_') if ENV['REUSE']
-  announce "Tagging repo with [#{reltag}]"
+task :update_version => 'Rakefile' do
+  announce "Updating #{PKG_Name} version to #{PKG_VERSION}: #{version_rb}"
+  open(version_rb, "w") do |f|
+    f.puts "# DO NOT EDIT"
+    f.puts "# This file is auto-generated by build scripts."
+    f.puts "# See:  rake update_version"
+    f.puts "module #{PKG_Name}"
+    f.puts "  #{PKG_Name}Version = '#{PKG_VERSION}'"
+    f.puts "end"
+  end
   if ENV['RELTEST']
-    announce "Release Task Testing, skipping repo tagging"
+    announce "Release Task Testing, skipping commiting of new version"
   else
-    sh %{echo cvs tag #{reltag}}
+    sh %{svn commit -m "Updated to version #{PKG_VERSION}" #{version_rb}}
   end
 end
 
-# --------------------------------------------------------------------
-# Create a task to build the RDOC documentation tree.
-
-desc "Create the RDOC html files"
-rd = Rake::RDocTask.new("rdoc") { |rdoc|
-  rdoc.rdoc_dir = 'html'
-  rdoc.title    = "#{PKG_Name}"
-  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'TODO', 'Releases')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-#  rdoc.rdoc_files.include('test/**/*.rb')
-}
-
-file "html/index.html" => [:rdoc]
-
-desc "Publish the RDOCs on RubyForge"
-task :publish_rdoc => ["html/index.html"] do
-  # NOTE: This task assumes that you have an SSH alias setup for rubyforge.
-  mkdir_p "emptydir"
-  sh "scp -rq emptydir rubyforge:/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}/rdoc"
-  sh "scp -rq html/* rubyforge:/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}/rdoc"
-  rm_r "emptydir"
-end
-
-# Wiki Doc Targets
-
-desc "Upload the Hieraki Data"
-task :upload => [:upload_gemdoc]
-
-task :upload_gemdoc => ['scripts/gemdoc.hieraki'] do
-  ruby %{scripts/upload_gemdoc.rb}
-end
-
-desc "Build the Hieraki documentation"
-task :hieraki => ['scripts/gemdoc.hieraki', 'scripts/specdoc.hieraki']
-
-file 'scripts/gemdoc.hieraki' => ['scripts/gemdoc.rb', 'scripts/gemdoc.data'] do
-  chdir('scripts') do
-    ruby %{-I../lib gemdoc.rb <gemdoc.data >gemdoc.hieraki}
-  end
-end
-
-file 'scripts/specdoc.hieraki' =>
-  ['scripts/specdoc.rb', 'scripts/specdoc.data', 'scripts/specdoc.yaml'] do
-  chdir('scripts') do
-    ruby %{-I../lib specdoc.rb >specdoc.hieraki}
-  end
-end
+task version_rb => :update_version
 
-# Package tasks
+# task :test => :update_version
 
-PKG_FILES = FileList[
-  "Rakefile", "ChangeLog", "Releases", "TODO", "README", 
-#  "setup.rb",
-#  "post-install.rb",
-  "bin/*",
-  "doc/*.css", "doc/*.rb",
-  "examples/**/*",
-#  "gemspecs/**/*",
-  "lib/**/*.rb",
-#  "pkgs/**/*",
-  "redist/*.gem",
-  "scripts/*.rb",
-  "test/**/*"
-]
-PKG_FILES.exclude(%r(^(test/temp|examples/.*/*.log)(/|$)))
-
-Rake::PackageTask.new("package") do |p|
-  p.name = PKG_NAME
-  p.version = PKG_VERSION
-  p.need_tar = true
-  p.need_zip = true
-  p.package_files = PKG_FILES
-end
-
-Spec = Gem::Specification.new do |s|
-  s.name = PKG_NAME 
-  s.version = PKG_VERSION
-  s.summary = "#{PKG_Name} GEM"
-  s.description = package_description
-  s.files = PKG_FILES.to_a
-  s.require_path = 'lib'
-  s.author = "Kurt Stephens"
-  s.email = "ruby-#{PKG_NAME}@umleta.com"
-  s.homepage = "http://#{PKG_NAME}.rubyforge.org"
-  s.rubyforge_project = "#{RUBY_FORGE_PROJECT}"
-  #s.bindir = "bin"                               # Use these for applications.
-  #s.executables = ["update_rubygems"]
-  certdir = ENV['CERT_DIR']
-  if certdir
-    s.signing_key = File.join(certdir, 'gem-umleta-private_key.pem')
-    s.cert_chain  = [File.join(certdir, 'gem-umleta-public_cert.pem')]
-  end
-end
-
-# Add console output about signing the Gem
-file "pkg/#{Spec.full_name}.gem" do
-  puts "Signed with certificates in '#{ENV['CERT_DIR']}'" if ENV['CERT_DIR']
-end
-
-Rake::GemPackageTask.new(Spec) do |p| end
-
-GEMSPEC = "pkg/#{PKG_NAME}.gemspec"
-desc "Build the Gem spec file for the #{PKG_NAME} package"
-task :gemspec => GEMSPEC
-file "pkg/#{PKG_NAME}.gemspec" => ["pkg", "Rakefile"] do |t|
-  open(t.name, "w") do |f| f.puts Spec.to_yaml end
-end
-
-# Automated upload to rubyforge.org
-PACKAGE_FILES = FileList["pkg/#{PKG_NAME}-#{PKG_VERSION}.*"]
-task :upload_package do
-# From activesuport/Rakefile, 
-# See: http://dev.rubyonrails.org/svn/rails/tags/rel_1-1-6/activesupport/Rakefile
-  `rubyforge login`
-
-  files = PACKAGE_FILES
-  files.each do |filename|
-    basename  = File.basename(filename)
-    puts "Releasing #{basename}..."
-    
-    release_command = "rubyforge add_release #{RUBY_FORGE_PROJECT} #{RUBY_FORGE_PROJECT} 'REL #{PKG_VERSION}' #{filename}"
-    puts release_command
-    system(release_command)
-  end
-end
-
-
-desc "Install #{PKG_Name}"
-task :install do
-  ruby 'install.rb'
-end
-
-# Run 'gem' (using local bin and lib directories).
-# e.g.
-#     rake rungem -- install -r blahblah --test
-
-desc "Run local 'gem'"
-task :rungem do
-  ARGV.shift
-  exec "ruby -Ilib bin/gem #{ARGV.join(' ')}"
-end
 
 # Misc Tasks ---------------------------------------------------------
 

data/Releases

@@ -1,5 +1,9 @@
 = Currency Release History
 
+== Release 0.1.2: 2006/10/30
+
+* Rakefile now uses Hoe
+
 == Release 0.1.1: 2006/10/30
 
 * Fixes gem packaging errors.

data/lib/currency.rb

@@ -1,3 +1,4 @@
+# -*- ruby -*-
 
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
@@ -10,3 +11,59 @@ require 'currency/money'
 require 'currency/exchange'
 require 'currency/core_extensions'
 
+# The Currency package provides an object-oriented model of:
+#
+# * currencies 
+# * exchanges
+# * exchange rates
+# * monetary values
+#
+# The core classes are:
+#
+# * Currency::Money - uses a scaled integer representation of a monetary value and performs accurate conversions to and from string values.
+# * Currency::Currency - provides an object-oriented representation of a currency.
+# * Currency::Exchange::Base - the base class for a "currency exchange rate" provider.
+# * Currency::Exchange::Rate - represents a exchange rate between two currencies.
+#
+# Below is a basic example:
+#
+#    require 'currency'
+#    require 'currency/exchange/xe'
+#    
+#    usd = Currency::Money('6.78', :USD)
+#    puts "usd = #{usd.format}"
+#    cad = usd.convert(:CAD)
+#    puts "cad = #{cad.format}"
+#
+# The example above uses Currency::Exchange::Xe automatically get exchange rates from http://xe.com/.
+#
+# == ActiveRecord Suppport
+#
+# This package also contains ActiveRecord support for money values:
+#
+#    require 'currency'
+#    require 'currency/active_record'
+#    
+#    class Entry < ActiveRecord::Base
+#       money :amount
+#    end
+# 
+# In the example above, the entries.amount database column is an INTEGER that represents US cents. 
+# The currency code of the money value can be stored in an additional database column or a default currency can be used.
+#
+# == Future Enhancements
+#
+# * storage and retrival of historical exchange rates
+# * exchange rate polling for population of historical rates
+# * support for inflationary rates within a currency, e.g. $10 USD in the year 1955 in 2006 USD.
+# 
+# == SVN Repo
+#
+#    svn checkout svn://rubyforge.org/var/svn/currency/currency/trunk
+#
+# == Examples
+#
+# * The "test programs":http://rubyforge.org/cgi-bin/viewvc.cgi/currency/trunk/examples?root=currency
+# * The "test cases":http://rubyforge.org/cgi-bin/viewvc.cgi/currency/trunk/test/?root=currency
+#
+

data/lib/currency/currency_version.rb

@@ -2,5 +2,5 @@
 # This file is auto-generated by build scripts.
 # See:  rake update_version
 module Currency
-  CurrencyVersion = '0.1.0'
+  CurrencyVersion = '0.1.2'
 end

metadata

@@ -3,19 +3,20 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: currency
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 date: 2006-10-30 00:00:00 -05:00
-summary: Currency GEM
+summary: Currency models currencies, monetary values, foreign exchanges.
 require_paths: 
 - lib
+- test
 email: ruby-currency@umleta.com
-homepage: http://currency.rubyforge.org
+homepage: http://rubyforge.org/projects/currency
 rubyforge_project: currency
 description: Currency models currencies, monetary values, foreign exchanges.
 autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -28,14 +29,9 @@ cert_chain:
 authors: 
 - Kurt Stephens
 files: 
-- Rakefile
-- ChangeLog
-- Releases
-- TODO
-- README
-- examples/xe1.rb
-- examples/ex1.rb
-- lib/currency.rb
+- test/xe_test.rb
+- test/money_test.rb
+- test/test_base.rb
 - lib/currency/money_helper.rb
 - lib/currency/exception.rb
 - lib/currency/currency_version.rb
@@ -49,10 +45,15 @@ files:
 - lib/currency/exchange/test.rb
 - lib/currency/exchange/xe.rb
 - lib/currency/exchange/rate.rb
-- scripts/gemdoc.rb
-- test/xe_test.rb
-- test/money_test.rb
-- test/test_base.rb
+- lib/currency.rb
+- examples/xe1.rb
+- examples/ex1.rb
+- ChangeLog
+- Rakefile
+- TODO
+- Releases
+- README
+- Manifest.txt
 test_files: []
 
 rdoc_options: []
@@ -65,5 +66,13 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 

data/scripts/gemdoc.rb

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-Gem.manage_gems
-require 'rubygems/user_interaction'
-
-include Gem::DefaultUserInteraction
-
-$gm = Gem::CommandManager.instance
-
-class CaptureSay
-  attr_reader :string
-  def initialize
-    @string = ''
-  end
-  def say(msg)
-    @string << msg << "\n"
-  end
-end
-
-def pre(cmd, opts)
-  puts "<pre>"
-  cmd.invoke opts
-  puts "</pre>"
-end
-
-def table_of_contents
-  cs = CaptureSay.new
-  use_ui(cs) do
-    $gm['help'].invoke 'commands'
-  end
-    # We're only interested in the lines that actually describe a command.
-  out = cs.string.grep(/^\s+(\w+)\s+(.*)$/).join("\n")
-    # Add a link to the relevant section in the margin.
-  out.gsub(/^\s+(\w+)/) {
-    cmd_name = $1
-    "  [http://currency.rubyforge.org/wiki/wiki.pl?CurrencyReference##{cmd_name} -]  #{cmd_name}"
-  }
-end
-
-while line = gets
-  if line =~ /^!/
-    cmd, arg = line.split
-    case cmd
-    when "!usage"
-      begin
-	cmdobj = $gm[arg]
-	pre(cmdobj, "--help")
-      rescue NoMethodError
-	puts "Usage of command #{arg} failed"
-      end
-    when "!toc"
-      puts table_of_contents()
-    when "!toc-link"
-      puts "\"Table of Contents\":http://currency.rubyforge.org/read/chapter/10#toc"
-    when "!version"
-      puts Gem::RubyGemsPackageVersion
-    end
-  else
-    puts line
-  end
-end