money_column 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+# Specify gem dependencies in money_column.gemspec
+gemspec
+
+gem 'activerecord', '2.3.14'

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    money_column (0.1.0)
+      activerecord (>= 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)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.8)
+      guard (>= 0.8.4)
+    money (2.2.0)
+    rake (0.9.2.2)
+    rb-fsevent (0.4.3.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    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)
+  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/Guardfile

@@ -0,0 +1,16 @@
+# Run me with:
+#
+#   $ bundle exec guard
+
+begin
+  require 'rb-inotify'
+  require 'libnotify'
+rescue LoadError
+end
+
+guard 'rspec', :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+_spec\.rb})
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Chargify
+
+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.markdown

@@ -0,0 +1,29 @@
+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.
+
+## 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.
+
+Reading a money column returns a Money object (or nil, if :allow_nil is true), in the currency defined by the object instance.
+
+Writing a money column assigns the cents-based database-backed attribute, and is assumed to be in the
+currency of the target instance.
+
+## Example
+
+``` ruby
+class Subscription < ActiveRecord::Base
+  belongs_to :site
+  
+  stores_money :balance
+  
+  def currency
+    site.currency
+  end
+end
+```
+
+In this example, +balance+ provides a Money-based interface to the underlying +balance_in_cents+ database column.  The currency is delegated to the site.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/money_column/stores_money.rb

@@ -0,0 +1,43 @@
+module MoneyColumn
+  module StoresMoney
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+    
+    module ClassMethods
+      def stores_money(money_name, options = {})
+        options.reverse_merge!({
+          :cents_column => "#{money_name}_in_cents",
+          :allow_nil => true
+        })
+
+        class_eval <<-EOV
+          def #{money_name}
+            cents = send('#{options[:cents_column]}')
+
+            if !#{options[:allow_nil]}
+              cents ||= 0
+            end
+            
+            if cents.blank?
+              nil
+            else
+              my_currency = self.respond_to?(:currency) ? currency : ::Money.default_currency
+              Money.new(cents, my_currency)
+            end
+          end
+          
+          def #{money_name}=(amount)
+            self.#{options[:cents_column]} = if amount.blank?
+              nil
+            else
+              amount.to_money.cents
+            end
+          end
+        EOV
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, MoneyColumn::StoresMoney

data/lib/money_column.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'money'
+require 'money_column/stores_money'
+
+# FREEDOM PATCH - Since a money column might validly return nil, 
+# let's allow +format+ to be called on nil and just return nil as a string
+NilClass.class_eval do
+  def format
+    nil.to_s
+  end
+end

data/money_column.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.specification_version = 3 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.7'
+  
+  s.name    = 'money_column'
+  s.version = '0.1.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.email = 'support@chargify.com'
+  s.homepage = 'http://github.com/chargify/money_column'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = %w[lib]
+
+  # Runtime Dependencies
+  s.add_runtime_dependency('activerecord', '>= 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')
+  s.add_development_dependency('growl', '~> 1.0.3')
+  s.add_development_dependency('rb-fsevent', '~> 0.4.2')
+end

data/spec/money_column/money_column_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe "MoneyColumn" do
+  describe "setter method" do
+    it "should pass on money values" do
+      MoneyExample.new(:amount => 1.to_money).amount.should == 1.to_money
+    end
+    
+    it "should convert string values to money objects" do
+      MoneyExample.new(:amount => '2').amount.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')
+    end
+
+    it "should convert numeric values to money objects" do
+      MoneyExample.new(:amount => 3).amount.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
+      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')
+      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
+    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
+    end
+  end
+  
+end

data/spec/schema.rb

@@ -0,0 +1,41 @@
+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

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format progress

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'rspec'
+require 'money_column'
+
+RSpec.configure do |config|
+  config.filter_run :focused => true
+  config.run_all_when_everything_filtered = true
+  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

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification 
+name: money_column
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Klett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-30 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 3
+        - 14
+        version: 2.3.14
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: money
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rb-fsevent
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :development
+  version_requirements: *id008
+description: A set of helper methods for working with money-based database columns.
+email: support@chargify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/money_column.rb
+- 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
+homepage: http://github.com/chargify/money_column
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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.
+test_files: 
+- spec/money_column/money_column_spec.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb