money-rails 0.7.0 → 0.7.1

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.7.1
+- Fix error when instantiating new model in mongoid extension (GH-60)
+
 ## 0.7.0
 - Added custom validator for Money fields (GH-36)
 - Added mongodb service test support for travis CI
@@ -13,6 +16,7 @@
 - Allow immediate subclasses to inherit monetized_attributes
 - Stopped support for MRI < 1.9.2
 - Fixed issue related to symbolized keys in Mongoid (GH-40)
+- Added add_money/remove_money & t.money/t.remove_money methods for ActiveRecord migrations
 
 TODOs (for upcoming releases):
  - decouple validator from active_record
@@ -31,7 +35,7 @@ TODOs (for upcoming releases):
 - Replaced deprecated composed_of with a custom implementation for
   activerecord. (GH-20)
 - Refactored testing structure to support multiple ORMs/ODMS.
-- Added Mongoid 2.x basic support. It uses serialization 
+- Added Mongoid 2.x basic support. It uses serialization
   (a differrent approach than activerecord for now). (GH-19)
 
 ## 0.4.0

data/README.md

@@ -44,6 +44,31 @@ configuration parameters for the rails app.
 
 ### ActiveRecord
 
+#### Migration helpers
+
+If you want to add money field to product model you may use ```add_money``` helper. That
+helper might be customized inside ```MoneyRails.configure``` block. You should customize
+```add_money``` helper to match the most common use case and utilize it across all migrations.
+
+```ruby
+class MonetizeProduct < ActiveRecord::Migration
+  def change
+    add_money :products, :price
+
+    # OR
+
+    change_table :products do |t|
+      t.money :price
+    end
+  end
+end
+```
+
+```add_money``` helper is revertable, so you may use it inside ```change``` migrations.
+If you writing separate ```up``` and ```down``` methods, you may use ```remove_money``` helper.
+
+#### Usage example
+
 For example, we create a Product model which has an integer price_cents column
 and we want to handle it by using a Money object instead:
 

data/config/locales/money.en.yml

@@ -1,5 +1,5 @@
 en:
   errors:
     messages:
-      invalid_currencym: Must be a valid currency (eg. '100', '5%{decimal}24', or '123%{thousands}456%{decimal}78')
+      invalid_currency: Must be a valid currency (eg. '100', '5%{decimal}24', or '123%{thousands}456%{decimal}78')
 

data/lib/generators/templates/money.rb

@@ -23,6 +23,26 @@ MoneyRails.configure do |config|
   #
   #config.include_validations = true
 
+  # Default ActiveRecord migration configuration values for columns:
+  #
+  # config.amount_column = { prefix: '',           # column name prefix
+  #                          postfix: '_cents',    # column name  postfix
+  #                          column_name: nil,     # full column name (overrides prefix, postfix and accessor name)
+  #                          type: :integer,       # column type
+  #                          present: true,        # column will be created
+  #                          null: false,          # other options will be treated as column options
+  #                          default: 0
+  #                        }
+  #
+  # config.currency_column = { prefix: '',
+  #                            postfix: '_currency',
+  #                            column_name: nil,
+  #                            type: :string,
+  #                            present: true,
+  #                            null: false,
+  #                            default: 'USD'
+  #                          }
+
   # Register a custom currency
   #
   # Example:

data/lib/money-rails/active_model/validator.rb

@@ -19,36 +19,40 @@ module MoneyRails
         if !raw_value.blank?
           # remove currency symbol, and negative sign
           currency = record.send("currency_for_#{attr}")
-          raw_value = raw_value.to_s.gsub(currency.symbol, "").gsub(/^-/, "")
+          decimal_mark = I18n.t('number.currency.format.separator', default: currency.decimal_mark)
+          thousands_separator = I18n.t('number.currency.format.delimiter', default: currency.thousands_separator)
+          symbol = I18n.t('number.currency.format.unit', default: currency.symbol)
 
-          decimal_pieces = raw_value.split(currency.decimal_mark)
+          raw_value = raw_value.to_s.gsub(symbol, "").gsub(/^-/, "")
+
+          decimal_pieces = raw_value.split(decimal_mark)
 
           # check for numbers like 12.23.45
           if decimal_pieces.length > 2
-            record.errors.add(attr, I18n.t('errors.messages.invalid_currencym',
-                                           { :thousands => currency.thousands_separator,
-                                             :decimal => currency.decimal_mark }))
+            record.errors.add(attr, I18n.t('errors.messages.invalid_currency',
+                                           { :thousands => thousands_separator,
+                                             :decimal => decimal_mark }))
           end
 
-          pieces = decimal_pieces[0].split(currency.thousands_separator)
+          pieces = decimal_pieces[0].split(thousands_separator)
 
           # check for valid thousands separation
           if pieces.length > 1
-            record.errors.add(attr, I18n.t('errors.messages.invalid_currencym',
-                                           { :thousands => currency.thousands_separator,
-                                             :decimal => currency.decimal_mark })) if pieces[0].length > 3
+            record.errors.add(attr, I18n.t('errors.messages.invalid_currency',
+                                           { :thousands => thousands_separator,
+                                             :decimal => decimal_mark })) if pieces[0].length > 3
             (1..pieces.length-1).each do |index|
-              record.errors.add(attr, I18n.t('errors.messages.invalid_currencym',
-                                             { :thousands => currency.thousands_separator,
-                                               :decimal => currency.decimal_mark })) if pieces[index].length != 3
+              record.errors.add(attr, I18n.t('errors.messages.invalid_currency',
+                                             { :thousands => thousands_separator,
+                                               :decimal => decimal_mark })) if pieces[index].length != 3
             end
           end
 
           # remove thousands separators
-          raw_value = raw_value.to_s.gsub(currency.thousands_separator, '')
+          raw_value = raw_value.to_s.gsub(thousands_separator, '')
 
           # normalize decimal mark
-          raw_value = raw_value.to_s.gsub(currency.decimal_mark, '.')
+          raw_value = raw_value.to_s.gsub(decimal_mark, '.')
         end
         super(record, attr, raw_value)
       end

data/lib/money-rails/active_record/migration_extensions/options_extractor.rb

@@ -0,0 +1,19 @@
+module MoneyRails
+  module ActiveRecord
+    module MigrationExtensions
+      class OptionsExtractor
+        def self.extract(attribute, table_name, accessor, options = {})
+          default = MoneyRails::Configuration.send("#{attribute}_column").merge(options[attribute] || {})
+
+          default[:column_name] ||= [default[:prefix], accessor, default[:postfix]].join
+          default[:table_name] = table_name
+
+          excluded_keys = [:amount, :currency, :type, :prefix, :postfix, :present, :column_name, :table_name]
+          default[:options] = default.except *excluded_keys
+
+          default.slice(:present, :table_name, :column_name, :type, :options).values
+        end
+      end
+    end
+  end
+end

data/lib/money-rails/active_record/migration_extensions/schema_statements.rb

@@ -0,0 +1,21 @@
+module MoneyRails
+  module ActiveRecord
+    module MigrationExtensions
+      module SchemaStatements
+        def add_money(table_name, accessor, options={})
+          [:amount, :currency].each do |attribute|
+            column_present, *opts = OptionsExtractor.extract attribute, table_name, accessor, options
+            add_column *opts if column_present
+          end
+        end
+
+        def remove_money(table_name, accessor, options={})
+          [:amount, :currency].each do |attribute|
+            column_present, table_name, column_name, _, _ =  OptionsExtractor.extract attribute, table_name, accessor, options
+            remove_column table_name, column_name if column_present
+          end
+        end
+      end
+    end
+  end
+end

data/lib/money-rails/active_record/migration_extensions/table.rb

@@ -0,0 +1,21 @@
+module MoneyRails
+  module ActiveRecord
+    module MigrationExtensions
+      module Table
+        def money(accessor, options={})
+          [:amount, :currency].each do |attribute|
+            column_present, _, *opts = OptionsExtractor.extract attribute, :no_table, accessor, options
+            column *opts if column_present
+          end
+        end
+
+        def remove_money(accessor, options={})
+          [:amount, :currency].each do |attribute|
+            column_present, _, column_name, _, _ =  OptionsExtractor.extract attribute, :no_table, accessor, options
+            remove column_name if column_present
+          end
+        end
+      end
+    end
+  end
+end

data/lib/money-rails/configuration.rb

@@ -43,5 +43,12 @@ module MoneyRails
     # Use (by default) validation of numericality for each monetized field.
     mattr_accessor :include_validations
     @@include_validations = true
+
+    # Default ActiveRecord migration configuration values for columns
+    mattr_accessor :amount_column
+    @@amount_column = { postfix: '_cents', type: :integer, null: false, default: 0, present: true }
+
+    mattr_accessor :currency_column
+    @@currency_column = { postfix: '_currency', type: :string, null: false, default: 'USD', present: true }
   end
 end

data/lib/money-rails/hooks.rb

@@ -6,6 +6,11 @@ module MoneyRails
         require 'money-rails/active_model/validator'
         require 'money-rails/active_record/monetizable'
         ::ActiveRecord::Base.send :include, MoneyRails::ActiveRecord::Monetizable
+
+        %w{options_extractor schema_statements table}.each { |file| require "money-rails/active_record/migration_extensions/#{file}" }
+        ::ActiveRecord::Migration.send :include, MoneyRails::ActiveRecord::MigrationExtensions::SchemaStatements
+        ::ActiveRecord::ConnectionAdapters::TableDefinition.send :include, MoneyRails::ActiveRecord::MigrationExtensions::Table
+        ::ActiveRecord::ConnectionAdapters::Table.send :include, MoneyRails::ActiveRecord::MigrationExtensions::Table
       end
 
       # For Mongoid

data/lib/money-rails/mongoid/three.rb

@@ -28,7 +28,7 @@ class Money
       when object.is_a?(Money) then object.mongoize
       when object.is_a?(Hash) then
         object.symbolize_keys!
-        ::Money.new(object[:cents], object[:currency]).mongoize
+        ::Money.new(object[:cents], object[:currency_iso]).mongoize
       when object.respond_to?(:to_money) then
           object.to_money.mongoize
       else object

data/lib/money-rails/version.rb

@@ -1,3 +1,3 @@
 module MoneyRails
-    VERSION = "0.7.0"
+    VERSION = "0.7.1"
 end

data/spec/active_record/migration_extensions/schema_statements_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+class Item < ActiveRecord::Base; end
+
+if defined? ActiveRecord
+  describe MoneyRails::ActiveRecord::MigrationExtensions::SchemaStatements do
+    before :all do
+      @connection = ActiveRecord::Base.connection
+      @connection.drop_table :items if @connection.table_exists? :items
+      @connection.create_table :items
+      @connection.send :extend, MoneyRails::ActiveRecord::MigrationExtensions::SchemaStatements
+    end
+
+    describe 'add_money' do
+      before do
+        @connection.add_money :items, :price
+        @connection.add_money :items, :price_without_currency, currency: { present: false }
+        @connection.add_money :items, :price_with_full_options, amount: {
+          prefix: :prefix_,
+          postfix: :_postfix,
+          type: :decimal,
+          precision: 4,
+          scale: 2,
+          default: 1,
+          null: true
+        }, currency: {
+          prefix: :currency_prefix,
+          postfix: :currency_postfix,
+          column_name: :currency
+        }
+
+        Item.reset_column_information
+      end
+
+      context 'default options' do
+        describe 'amount' do
+          subject { Item.columns_hash['price_cents'] }
+
+          its (:default) { should eq 0 }
+          its (:null) { should be_false }
+          its (:type) { should eq :integer }
+        end
+
+        describe 'currency' do
+          subject { Item.columns_hash['price_currency'] }
+
+          its (:default) { should eq 'USD' }
+          its (:null) { should be_false }
+          its (:type) { should eq :string }
+        end
+      end
+
+      context 'without currency column' do
+        it { Item.columns_hash['price_without_currency_cents'].should_not be nil }
+        it { Item.columns_hash['price_without_currency_currency'].should be nil }
+      end
+
+      context 'full options' do
+        describe 'amount' do
+          subject { Item.columns_hash['prefix_price_with_full_options_postfix'] }
+
+          its (:default) { should eq 1 }
+          its (:null) { should be_true }
+          its (:type) { should eq :decimal }
+          its (:precision) { should eq 4 }
+          its (:scale) { should eq 2 }
+        end
+
+        describe 'currency' do
+          it { Item.columns_hash['currency'].should_not be nil }
+        end
+      end
+    end
+
+    describe 'remove_money' do
+      before do
+        @connection.add_money :items, :price
+        @connection.add_money :items, :price_without_currency, currency: { present: false }
+        @connection.add_money :items, :price_with_full_options, amount: { prefix: :prefix_, postfix: :_postfix }, currency: { column_name: :currency }
+
+        @connection.remove_money :items, :price
+        @connection.remove_money :items, :price_without_currency, currency: { present: false }
+        @connection.remove_money :items, :price_with_full_options, amount: { prefix: :prefix_, postfix: :_postfix }, currency: { column_name: :currency }
+
+        Item.reset_column_information
+      end
+
+      it { Item.columns_hash['price_cents'].should be nil }
+      it { Item.columns_hash['price_currency'].should be nil }
+
+      it { Item.columns_hash['price_without_currency_cents'].should be nil }
+
+      it { Item.columns_hash['prefix_price_with_full_options_postfix'].should be nil }
+      it { Item.columns_hash['currency'].should be nil }
+    end
+  end
+end

data/spec/active_record/migration_extensions/table_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+class Item < ActiveRecord::Base; end
+
+if defined? ActiveRecord
+  describe MoneyRails::ActiveRecord::MigrationExtensions::SchemaStatements do
+    before :all do
+      @connection = ActiveRecord::Base.connection
+      @connection.send :extend, MoneyRails::ActiveRecord::MigrationExtensions::SchemaStatements
+    end
+
+    describe 'money' do
+      before do
+        @connection.drop_table :items if @connection.table_exists? :items
+        @connection.create_table :items do |t|
+          t.money :price
+          t.money :price_without_currency, currency: { present: false }
+          t.money :price_with_full_options, amount: {
+            prefix: :prefix_,
+            postfix: :_postfix,
+            type: :decimal,
+            precision: 4,
+            scale: 2,
+            default: 1,
+            null: true
+          }, currency: {
+            prefix: :currency_prefix,
+            postfix: :currency_postfix,
+            column_name: :currency
+          }
+        end
+
+        Item.reset_column_information
+      end
+
+      context 'default options' do
+        describe 'amount' do
+          subject { Item.columns_hash['price_cents'] }
+
+          its (:default) { should eq 0 }
+          its (:null) { should be_false }
+          its (:type) { should eq :integer }
+        end
+
+        describe 'currency' do
+          subject { Item.columns_hash['price_currency'] }
+
+          its (:default) { should eq 'USD' }
+          its (:null) { should be_false }
+          its (:type) { should eq :string }
+        end
+      end
+
+      context 'without currency column' do
+        it { Item.columns_hash['price_without_currency_cents'].should_not be nil }
+        it { Item.columns_hash['price_without_currency_currency'].should be nil }
+      end
+
+      context 'full options' do
+        describe 'amount' do
+          subject { Item.columns_hash['prefix_price_with_full_options_postfix'] }
+
+          its (:default) { should eq 1 }
+          its (:null) { should be_true }
+          its (:type) { should eq :decimal }
+          its (:precision) { should eq 4 }
+          its (:scale) { should eq 2 }
+        end
+
+        describe 'currency' do
+          it { Item.columns_hash['currency'].should_not be nil }
+        end
+      end
+    end
+
+    describe 'remove_money' do
+      before do
+        @connection.change_table :items do |t|
+          t.money :price
+          t.money :price_without_currency, currency: { present: false }
+          t.money :price_with_full_options, amount: { prefix: :prefix_, postfix: :_postfix }, currency: { column_name: :currency }
+
+          t.remove_money :price
+          t.remove_money :price_without_currency, currency: { present: false }
+          t.remove_money :price_with_full_options, amount: { prefix: :prefix_, postfix: :_postfix }, currency: { column_name: :currency }
+        end
+
+        Item.reset_column_information
+      end
+
+      it { Item.columns_hash['price_cents'].should be nil }
+      it { Item.columns_hash['price_currency'].should be nil }
+
+      it { Item.columns_hash['price_without_currency_cents'].should be nil }
+
+      it { Item.columns_hash['prefix_price_with_full_options_postfix'].should be nil }
+      it { Item.columns_hash['currency'].should be nil }
+    end
+  end
+end