currency 0.2.1 → 0.3.0

data/Manifest.txt

@@ -20,6 +20,8 @@ Rakefile
 README
 Releases
 test/ar_test_base.rb
+test/ar_simple_test.rb
+test/ar_column_test.rb
 test/money_test.rb
 test/test_base.rb
 test/xe_test.rb

data/Rakefile

@@ -12,7 +12,7 @@ require 'hoe'
 PKG_Name = 'Currency'
 PKG_NAME = PKG_Name.gsub(/[a-z][A-Z]/) {|x| "#{x[0,1]}_#{x[1,1]}"}.downcase
 
-hoe = Hoe.new("currency", '0.2.1') do |p|
+hoe = Hoe.new("currency", '0.3.0') do |p|
   p.author = 'Kurt Stephens'
   p.description = %{Currency models currencies, monetary values, foreign exchanges.}
   p.email = "ruby-#{PKG_NAME}@umleta.com"

data/Releases

@@ -1,5 +1,10 @@
 = Currency Release History
 
+== Release 0.3.0: 2006/10/31
+
+* ActiveRecord money :*_field options are now named :*_column.
+* More ActiveRecord tests
+
 == Release 0.2.1: 2006/10/31
 
 * Fixed Manifest.txt

data/lib/currency/active_record.rb

@@ -12,7 +12,7 @@ module Currency
 
 # == ActiveRecord Suppport
 #
-# This package also contains ActiveRecord support for money values:
+# Support for Money attributes in ActiveRecord::Base subclasses:
 #
 #    require 'currency'
 #    require 'currency/active_record'
@@ -33,90 +33,109 @@ module Currency
       #    :currency => :USD
       #
       # Defines the Currency to use for storing a normalized Money 
-      # value.  This allows SQL summary operations, 
+      # value.  
+      #
+      # All Money values will be converted to this Currency before
+      # storing in the column.  This allows SQL summary operations, 
       # like SUM(), MAX(), AVG(), etc., to produce meaningful results,
       # regardless of the initial currency specified.  If this
       # option is used, subsequent reads will be in the specified
       # normalization :currency.  Defaults to :USD.
       #
-      #    :currency_field => undef
+      #    :currency_column => undef
       #
-      # Defines the name of the CHAR(3) column that is used to store and
+      # Defines the name of the CHAR(3) column used to store and
       # retrieve the Money's Currency code.  If this option is used, each
       # record may use a different Currency to store the result, such
       # that SQL summary operations, like SUM(), MAX(), AVG(), 
       # may return meaningless results.
       #
-      #    :currency_preferred_field => undef
+      #    :currency_preferred_column => undef
       #
       # Defines the name of a CHAR(3) column used to store and
       # retrieve the Money's Currency code.  This option can be used
-      # with normalize Money values to retrieve the Money value 
+      # with normalized Money values to retrieve the Money value 
       # in its original Currency, while
-      # allowing SQL summary operations on a normalized Money value
+      # allowing SQL summary operations on the normalized Money values
       # to still be valid.
       #
       def money(attr_name, *opts)
-        opts = Hash.[](*opts)
+        opts = Hash[*opts]
 
         attr_name = attr_name.to_s
 
         currency = opts[:currency]
 
-        currency_field = opts[:currency_field]
-        if currency_field
-          currency = "read_attribute(:#{currency_field})"
+        currency_column = opts[:currency_column]
+        if currency_column && ! currency_column.kind_of?(String)
+          currency_column = currency_column.to_s
+          currency_column = "#{attr_name}_currency"
+        end
+        if currency_column
+          read_currency = "read_attribute(:#{currency_column.to_s})"
+          write_currency = "write_attribute(:#{currency_column}, #{attr_name}_money.nil? ? nil : #{attr_name}_money.currency.code.to_s)"
         end
 
-        currency_preferred_field = opts[:currency_preferred_field]
-        if currency_preferred_field
-          read_preferred_currency = "@#{attr_name} = @#{attr_name}.convert(read_attribute(:#{:currency_preferred_field}))"
-          write_preferred_currency = "write_attribute(:#{currency_preferred_field}, @#{attr_name}_money.currency.code)"
+        currency_preferred_column = opts[:currency_preferred_column]
+        if currency_preferred_column
+          currency_preferred_column = currency_preferred_column.to_s
+          read_preferred_currency = "@#{attr_name} = @#{attr_name}.convert(read_attribute(:#{currency_preferred_column}))"
+          write_preferred_currency = "write_attribute(:#{currency_preferred_column}, @#{attr_name}_money.currency.code)"
         end
 
         currency ||= ':USD'
 
-        validate = ''
-        validate = "validates_numericality_of :#{attr_name}" unless opts[:allow_nil]
+        read_currency ||= currency
+
+        validate = "# Validation\n"
+        validate << "\nvalidates_numericality_of :#{attr_name}\n" unless opts[:allow_nil]
+        validate << "\nvalidates_format_of :#{currency_column}, :with => /^[A-Z][A-Z][A-Z]$/\n" if currency_column && ! opts[:allow_nil]
 
         module_eval (x = <<-"end_eval"), __FILE__, __LINE__
 #{validate}
+
 def #{attr_name}
   # $stderr.puts "  \#{self.class.name}##{attr_name}"
   unless @#{attr_name}
     #{attr_name}_rep = read_attribute(:#{attr_name})
     unless #{attr_name}_rep.nil?
-      @#{attr_name} = Money.new_rep(#{attr_name}_rep, #{currency})
+      @#{attr_name} = Currency::Money.new_rep(#{attr_name}_rep, #{read_currency} || #{currency})
       #{read_preferred_currency}
     end
   end
   @#{attr_name}
 end
+
 def #{attr_name}=(value)
   if value.nil?
     ;
   elsif value.kind_of?(Integer) || value.kind_of?(String) || value.kind_of?(Float)
-    #{attr_name}_money = Money.new(value, #{currency})
+    #{attr_name}_money = Currency::Money.new(value, #{currency})
     #{write_preferred_currency}
   elsif value.kind_of?(Money)
+    #{attr_name}_money = value
     #{write_preferred_currency}
-    #{attr_name}_money = value.convert(#{currency})
+    #{write_currency ? write_currency : "#{attr_name}_money = #{attr_name}_money.convert(#{currency})"}
   else
-    throw "Bad money format \#{value.inspect}"
+    throw Currency::Exception::InvalidMoneyValue.new(value)
   end
+
   @#{attr_name} = #{attr_name}_money
-  #{currency_field ? 'write_attribute(:#{currency_field}, #{attr_name}_money.nil? ? nil : #{attr_name}_money.currency.name)' : ''}
+  
   write_attribute(:#{attr_name}, #{attr_name}_money.nil? ? nil : #{attr_name}_money.rep)
+
   value
 end
+
 def #{attr_name}_before_type_cast
-  # FIX ME, User cannot specify Currency
+  # FIXME: User cannot specify Currency
   x = #{attr_name}
   x &&= x.format(:no_symbol, :no_currency, :no_thousands)
   x
 end
+
 end_eval
-        # $stderr.puts "   CODE = #{x}"
+        $stderr.puts "   CODE = #{x}"
       end
     end
   end

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.2.1'
+  CurrencyVersion = '0.3.0'
 end

data/lib/currency/exception.rb

@@ -12,6 +12,10 @@ module Currency
     # Error during string parsing.
     class InvalidMoneyString < Base
     end
+
+    # Error during coercion of external Money values.
+    class InvalidMoneyValue < Base
+    end
   
     # Error in Currency code formeat.
     class InvalidCurrencyCode < Base

data/test/ar_column_test.rb

@@ -0,0 +1,66 @@
+require 'test/ar_test_base'
+require 'currency'
+
+require 'rubygems'
+require 'active_record'
+require 'active_record/migration'
+require 'currency/active_record'
+
+module Currency
+
+class ArFieldTest < ArTestBase
+
+  ##################################################
+  # Basic CurrenyTest AR::B class
+  #
+
+  TABLE_NAME = 'currency_column_test'
+
+  class CurrencyColumnTestMigration < AR_M
+    def self.up
+      create_table TABLE_NAME.intern do |t|
+        t.column :name,     :string
+        t.column :amount,   :integer # Money
+        t.column :amount_currency,   :string, :size => 3 # Money.currency.code
+      end
+    end
+
+    def self.down
+      drop_table TABLE_NAME.intern
+    end
+  end
+
+  class CurrencyColumnTest < AR_B
+    set_table_name TABLE_NAME
+    money :amount, :currency_column => true
+  end 
+
+  ##################################################
+
+  def setup
+    @currency_test_migration ||= CurrencyColumnTestMigration 
+    @currency_test ||= CurrencyColumnTest
+    super
+  end
+
+  def teardown
+    super
+  end
+
+  ##################################################
+
+
+  def test_field
+    insert_records
+
+    assert_not_nil usd = @currency_test.find(@usd.id)
+    assert_equal_currency usd, @usd
+
+    assert_not_nil cad = @currency_test.find(@cad.id)
+    assert_equal_currency cad, @cad
+  end
+
+end
+
+end # module
+

data/test/ar_simple_test.rb

@@ -0,0 +1,28 @@
+require 'test/ar_test_base'
+require 'currency'
+
+require 'rubygems'
+require 'active_record'
+require 'active_record/migration'
+require 'currency/active_record'
+
+module Currency
+
+class ArSimpleTest < ArTestBase
+
+  def test_simple
+    insert_records
+
+    assert_not_nil usd = @currency_test.find(@usd.id)
+    assert_equal_currency usd, @usd
+
+    assert_not_nil cad = @currency_test.find(@cad.id)
+    assert_equal_money cad, @cad
+
+    assert_equal   cad.amount.currency.code, :USD
+  end
+
+end
+
+end # module
+

data/test/ar_test_base.rb

@@ -21,12 +21,6 @@ class ArTestBase < TestBase
 
   class CurrencyTestMigration < AR_M
     def self.up
-      begin
-        down
-      rescue Object => e
-        announce("Warning: #{e}")
-      end
-
       create_table TABLE_NAME.intern do |t|
         t.column :name,     :string
         t.column :amount,   :integer # Money
@@ -53,12 +47,14 @@ class ArTestBase < TestBase
     @currency_test_migration ||= CurrencyTestMigration 
     @currency_test ||= CurrencyTest
 
+    # schema_down
+
     schema_up
   end
 
   def teardown
     super
-    schema_down
+    # schema_down
   end
 
   def database_spec
@@ -73,12 +69,19 @@ class ArTestBase < TestBase
   end
 
   def schema_up
-    @currency_test_migration.migrate(:up)
-
+    begin
+      @currency_test_migration.migrate(:up)
+    rescue Object =>e
+      $stderr.puts "Warning: #{e}"
+    end
   end
 
   def schema_down
-    #@currency_test_migration.migrate(:down)
+    begin
+      @currency_test_migration.migrate(:down)
+    rescue Object => e
+      $stderr.puts "Warning: #{e}"
+    end
   end
 
   ##################################################
@@ -86,6 +89,8 @@ class ArTestBase < TestBase
   # 
 
   def insert_records
+    delete_records
+
     @currency_test.reset_column_information
 
     @usd = @currency_test.new(:name => '#1: USD', :amount => Money.new("12.34", :USD))
@@ -96,12 +101,12 @@ class ArTestBase < TestBase
   end
 
   def delete_records
-    # Simp
+    @currency_test.destroy_all
   end
 
   ##################################################
 
-  def assert_currency_test(a,b)
+  def assert_equal_money(a,b)
     assert_not_nil a
     assert_not_nil b
     # Make sure a and b are not the same object.
@@ -116,22 +121,22 @@ class ArTestBase < TestBase
     assert_equal   a.amount.convert(b.amount.currency).rep, b.amount.rep
   end
 
-  def test_simple
-    insert_records
-
-    assert_not_nil usd = @currency_test.find(@usd.id)
-    assert_currency_test usd, @usd
+  def assert_equal_currency(a,b)
 
-    assert_equal   usd.amount.rep, @usd.amount.rep
-    assert_equal   usd.amount.currency, @usd.amount.currency
-    assert_equal   usd.amount.currency.code, @usd.amount.currency.code
+    assert_equal_money a, b
 
-    assert_not_nil cad = @currency_test.find(@cad.id)
-    assert_currency_test cad, @cad
+    assert_equal   a.amount.rep, b.amount.rep
+    assert_equal   a.amount.currency, b.amount.currency
+    assert_equal   a.amount.currency.code, b.amount.currency.code
 
-    assert_equal   cad.amount.currency.code, :USD
+  end
 
-    delete_records
+  ##################################################
+  # 
+  # 
+  
+  def test_dummy
+    insert_records
   end
 
 end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: currency
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 date: 2006-10-31 00:00:00 -05:00
 summary: Currency models currencies, monetary values, foreign exchanges.
 require_paths: 
@@ -52,6 +52,8 @@ files:
 - README
 - Releases
 - test/ar_test_base.rb
+- test/ar_simple_test.rb
+- test/ar_column_test.rb
 - test/money_test.rb
 - test/test_base.rb
 - test/xe_test.rb