money_column 0.1.0 → 0.2.0

data/Gemfile

@@ -3,4 +3,4 @@ source :rubygems
 # Specify gem dependencies in money_column.gemspec
 gemspec
 
-gem 'activerecord', '2.3.14'
+gem 'activesupport', '2.3.14'

data/Gemfile.lock

@@ -1,15 +1,13 @@
 PATH
   remote: .
   specs:
-    money_column (0.1.0)
-      activerecord (>= 2.3.14)
+    money_column (0.2.0)
+      activesupport (>= 2.3.14)
       money (~> 2.2.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activerecord (2.3.14)
-      activesupport (= 2.3.14)
     activesupport (2.3.14)
     diff-lcs (1.1.3)
     growl (1.0.3)
@@ -28,18 +26,16 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
-    sqlite3 (1.3.4)
     thor (0.14.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 2.3.14)
+  activesupport (= 2.3.14)
   growl (~> 1.0.3)
   guard-rspec (~> 0.5.0)
   money_column!
   rake (~> 0.9.2)
   rb-fsevent (~> 0.4.2)
   rspec (~> 2.7.0)
-  sqlite3 (~> 1.3.4)

data/README.markdown

@@ -1,29 +1,56 @@
 MoneyColumn [![build status](https://secure.travis-ci.org/chargify/money_column.png)](http://travis-ci.org/chargify/money_column)
 ===========
 
-A set of helper methods for working with money-based database columns.
+A set of helper methods for working with money-based attributes.
 
 ## How it works
 
-The money values are stored in the database in cents.  The currency is not (necessarily) stored in the same table - instead, the currency is defined by a +currency+ method on the object instance.
+Let's say you have the following Car class:
 
-Reading a money column returns a Money object (or nil, if :allow_nil is true), in the currency defined by the object instance.
+``` ruby
+class Car
+  include MoneyColumn::StoresMoney
 
-Writing a money column assigns the cents-based database-backed attribute, and is assumed to be in the
-currency of the target instance.
+  attr_accessor :price_in_cents
 
-## Example
+  stores_money :price
 
-``` ruby
-class Subscription < ActiveRecord::Base
-  belongs_to :site
-  
-  stores_money :balance
-  
   def currency
-    site.currency
+    "USD"
   end
 end
+
+So let's go ahead and store a price_in_cents for the car:
+
+``` ruby
+car = Car.new
+car.price_in_cents = 5000
 ```
 
-In this example, +balance+ provides a Money-based interface to the underlying +balance_in_cents+ database column.  The currency is delegated to the site.
+Since we want to show this in a view as `$ 50.00`, we can now do the following:
+
+``` ruby
+> car.price.format
+=> "$50.00"
+
+> car.price
+ => #<Money:0x1016e9fb8 @cents=5000, @bank=#<Money::VariableExchangeBank:0x10143f6f0 @mutex=#<Mutex:0x10143f678>, @rates={}>, @currency="USD">
+```
+
+If the `currency` instance method is defined on your class, MoneyColumn will use that. Otherwise, it will use the default currency specified in the Money gem.
+
+## Under the covers
+
+When you define `stores_money :price`, MoneyColumn looks for an attribute named `price_in_cents` to use for its conversion.
+
+If you want to explicity tell MoneyColumn where to look for the cents_attribute, do the following:
+
+``` ruby
+class CarWithSpecifiedAttribute
+  include MoneyColumn::StoresMoney
+  
+  attr_accessor :amount_in_cents
+  
+  stores_money :price, :cents_attribute => "amount_in_cents"
+end
+```

data/lib/money_column.rb

@@ -1,5 +1,6 @@
-require 'active_record'
+require 'rubygems'
 require 'money'
+require 'active_support'
 require 'money_column/stores_money'
 
 # FREEDOM PATCH - Since a money column might validly return nil, 

data/lib/money_column/stores_money.rb

@@ -7,13 +7,13 @@ module MoneyColumn
     module ClassMethods
       def stores_money(money_name, options = {})
         options.reverse_merge!({
-          :cents_column => "#{money_name}_in_cents",
+          :cents_attribute => "#{money_name}_in_cents",
           :allow_nil => true
         })
 
         class_eval <<-EOV
           def #{money_name}
-            cents = send('#{options[:cents_column]}')
+            cents = send('#{options[:cents_attribute]}')
 
             if !#{options[:allow_nil]}
               cents ||= 0
@@ -28,7 +28,7 @@ module MoneyColumn
           end
           
           def #{money_name}=(amount)
-            self.#{options[:cents_column]} = if amount.blank?
+            self.#{options[:cents_attribute]} = if amount.blank?
               nil
             else
               amount.to_money.cents
@@ -39,5 +39,3 @@ module MoneyColumn
     end
   end
 end
-
-ActiveRecord::Base.send :include, MoneyColumn::StoresMoney

data/money_column.gemspec

@@ -4,11 +4,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.7'
   
   s.name    = 'money_column'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.date    = '2011-11-30'
-  s.summary = 'A set of helper methods for working with money-based database columns.'
-  s.description = 'A set of helper methods for working with money-based database columns.'
-  s.authors = ["Michael Klett"]
+  s.summary = 'A set of helper methods for working with money-based attributes.'
+  s.description = 'A set of helper methods for working with money-based attributes.'
+  s.authors = ["Michael Klett", "Shay Frendt"]
   s.email = 'support@chargify.com'
   s.homepage = 'http://github.com/chargify/money_column'
   
@@ -17,11 +17,10 @@ Gem::Specification.new do |s|
   s.require_paths = %w[lib]
 
   # Runtime Dependencies
-  s.add_runtime_dependency('activerecord', '>= 2.3.14')
+  s.add_runtime_dependency('activesupport', '>= 2.3.14')
   s.add_runtime_dependency('money', '~> 2.2.0')
 
   # Development Dependencies
-  s.add_development_dependency('sqlite3', '~> 1.3.4')
   s.add_development_dependency('rake', '~> 0.9.2')
   s.add_development_dependency('rspec', '~> 2.7.0')
   s.add_development_dependency('guard-rspec', '~> 0.5.0')

data/spec/money_column/money_column_spec.rb

@@ -1,49 +1,114 @@
 require 'spec_helper'
 
+class Car
+  include MoneyColumn::StoresMoney
+  attr_accessor :price_in_cents
+  stores_money :price
+end
+
+class CarWithCurrency
+  include MoneyColumn::StoresMoney
+  attr_accessor :price_in_cents
+  stores_money :price
+
+  def currency
+    ::Money.default_currency
+  end
+end
+
+class CarWithNonDefaultCurrency
+  include MoneyColumn::StoresMoney
+  attr_accessor :price_in_cents
+  stores_money :price
+
+  def currency
+    "GBP"
+  end
+end
+
+class CarNilNotAllowed
+  include MoneyColumn::StoresMoney
+  attr_accessor :price_in_cents
+  stores_money :price, :allow_nil => false
+end
+
+class CarWithSpecifiedAttribute
+  include MoneyColumn::StoresMoney
+  attr_accessor :amount_in_cents
+  stores_money :price, :cents_attribute => "amount_in_cents"
+end
+
 describe "MoneyColumn" do
+  describe "getter method" do
+    it "should return a money object based on the inferred cents_attribute" do
+      car = Car.new
+      car.price_in_cents = 1000
+      car.price.should == 10.to_money
+    end
+
+    it "should return a money object based on the stated cents_attribute" do
+      car = CarWithSpecifiedAttribute.new
+      car.amount_in_cents = 5000
+      car.price.should == 50.to_money
+    end
+  end
+  
   describe "setter method" do
     it "should pass on money values" do
-      MoneyExample.new(:amount => 1.to_money).amount.should == 1.to_money
+      car = Car.new
+      car.price = 1.to_money
+      car.price.should == 1.to_money
     end
     
     it "should convert string values to money objects" do
-      MoneyExample.new(:amount => '2').amount.should == 2.to_money
+      car = CarWithCurrency.new
+      car.price = '2'
+      car.price.should == 2.to_money
     end
     
     it "should convert to money objects in the correct currency automatically" do
-      MoneyExampleWithNonDefaultCurrency.new(:amount => '4').amount.should == Money.new(400, 'GBP')
+      car = CarWithNonDefaultCurrency.new
+      car.price = '4'
+      car.price.should == Money.new(400, 'GBP')
     end
 
     it "should convert numeric values to money objects" do
-      MoneyExample.new(:amount => 3).amount.should == 3.to_money
+      car = Car.new
+      car.price = 3
+      car.price.should == 3.to_money
     end
 
     describe "when nil is allowed" do
       it "should treat blank values as nil" do
-        MoneyExample.new(:amount => '').amount.should be_nil
+        car = Car.new
+        car.price = ''
+        car.price.should be_nil
       end
     end
     
     describe "when nil isn't allowed" do
       it "should treat blank values as $0" do
-        MoneyExampleThatDoesNotAllowNil.new(:amount => '').amount.should == Money.new(0, 'USD')
+        car = CarNilNotAllowed.new
+        car.price = ''
+        car.price.should == Money.new(0, 'USD')
       end
     end
 
-    it "should allow existing amounts to be set to nil with a blank value" do
-      me = MoneyExample.new(:amount => 500.to_money)
-      me.update_attribute :amount, ''
-      me.reload
-      me.amount.should be_nil
+    it "should allow existing prices to be set to nil with a blank value" do
+      car = Car.new
+      car.price = 500.to_money
+      car.price.should_not be_nil
+      car.price = ''
+      car.price.should be_nil
     end
   end
   
   describe "declaring a money field" do
     it "should allow the field to be declared with a different cents field" do
-      me = MoneyExampleWithSpecifiedColumnName.create!(:amt => 5.to_money)
-      me.amt.should == 5.to_money
-      me.reload.amt.should == 5.to_money
-      me.amount_in_cents.should == 5.to_money.cents
+      car = CarWithSpecifiedAttribute.new
+      car.price = 5.to_money
+      car.price.should == 5.to_money
+      car.amount_in_cents.should == 5.to_money.cents
     end
   end
   

data/spec/spec_helper.rb

@@ -9,12 +9,3 @@ RSpec.configure do |config|
   config.alias_example_to :fit, :focused => true
   config.color_enabled = true
 end
-
-ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
-ActiveRecord::Base.establish_connection('sqlite3')
-
-ActiveRecord::Base.logger = Logger.new(STDERR)
-ActiveRecord::Base.logger.level = Logger::WARN
-
-# Load test database schema
-load File.dirname(__FILE__) + "/schema.rb"

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: money_column
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Klett
+- Shay Frendt
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -19,7 +20,7 @@ date: 2011-11-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -50,26 +51,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 3
-        - 4
-        version: 1.3.4
-  type: :development
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,11 +66,11 @@ dependencies:
         - 2
         version: 0.9.2
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,11 +82,11 @@ dependencies:
         - 0
         version: 2.7.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: guard-rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -113,11 +98,11 @@ dependencies:
         - 0
         version: 0.5.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: growl
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -129,11 +114,11 @@ dependencies:
         - 3
         version: 1.0.3
   type: :development
-  version_requirements: *id007
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rb-fsevent
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -145,8 +130,8 @@ dependencies:
         - 2
         version: 0.4.2
   type: :development
-  version_requirements: *id008
-description: A set of helper methods for working with money-based database columns.
+  version_requirements: *id007
+description: A set of helper methods for working with money-based attributes.
 email: support@chargify.com
 executables: []
 
@@ -166,7 +151,6 @@ files:
 - lib/money_column/stores_money.rb
 - money_column.gemspec
 - spec/money_column/money_column_spec.rb
-- spec/schema.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -202,9 +186,8 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A set of helper methods for working with money-based database columns.
+summary: A set of helper methods for working with money-based attributes.
 test_files: 
 - spec/money_column/money_column_spec.rb
-- spec/schema.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/spec/schema.rb

@@ -1,41 +0,0 @@
-ActiveRecord::Schema.define(:version => 0) do
-  create_table :money_examples, :force => true do |t|
-    t.integer :amount_in_cents
-  end
-end
-
-class MoneyExample < ActiveRecord::Base
-  stores_money :amount
-end
-
-class MoneyExampleWithCurrency < ActiveRecord::Base
-  set_table_name "money_examples"
-
-  stores_money :amount
-
-  def currency
-    ::Money.default_currency
-  end
-end
-
-class MoneyExampleWithNonDefaultCurrency < ActiveRecord::Base
-  set_table_name "money_examples"
-
-  stores_money :amount
-
-  def currency
-    "GBP"
-  end
-end
-
-class MoneyExampleWithSpecifiedColumnName < ActiveRecord::Base
-  set_table_name "money_examples"
-  
-  stores_money :amt, :cents_column => "amount_in_cents"
-end
-
-class MoneyExampleThatDoesNotAllowNil < ActiveRecord::Base
-  set_table_name "money_examples"
-
-  stores_money :amount, :allow_nil => false
-end