money-rails 0.8.1 → 0.9.0

data/CHANGELOG.md

@@ -1,8 +1,24 @@
 # Changelog
 
-## master
-
-## 0.8.0
+## master (next release)
+- Add testing tasks for rails 4.x
+- Fix issue with Numeric values in MoneyValidator (GH-83).
+- Fix test helper
+- Fix issue with money validator (GH-102).
+- Change validation logic. Support Subunit and Money field
+  validation with NumericalityValidator options.
+  Moreover, now Money objects are normalized and pass through
+  all validation steps.
+- Add support for the global configuration of the sign_before_setting formatting option.
+
+## 0.8.1
+- Remove unnecessary files from gem build.
+- Add options to ActionView helpers that enable the usage of any of the rules ::Money.format allows.
+- Fix "setting amount_column for default_currency" to only accept
+  postfix for default_currency with subunit.
+- Add mongoid 4 support.
+
+## 0.8.0 (yanked)
 - Added defaults for amount and currency columns in database schema, based on the default currency.
 - Use a better default subunit_unit name (choose the value of column.postfix set in the config).
 - Began support of Rails 4.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/RubyMoney/money-rails.png?branch=master)](http://travis-ci.org/RubyMoney/money-rails)
 [![Dependency Status](https://gemnasium.com/RubyMoney/money-rails.png)](https://gemnasium.com/RubyMoney/money-rails)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/RubyMoney/money-rails)
+[![Code Climate](https://codeclimate.com/github/RubyMoney/money-rails.png)](https://codeclimate.com/github/RubyMoney/money-rails)
 
 ## Introduction
 
@@ -40,6 +40,17 @@ $ rails g money_rails:initializer
 There, you can define the default currency value and set other
 configuration parameters for the rails app.
 
+### Setup for money-rails development
+
+Our tests are executed with several ORMs - see `Rakefile` for details. To install all required gems run these:
+
+    bundle install --gemfile=gemfiles/mongoid2.gemfile
+    bundle install --gemfile=gemfiles/mongoid3.gemfile
+    bundle install --gemfile=gemfiles/rails3.gemfile
+    bundle install --gemfile=gemfiles/rails4.gemfile
+
+Then you can run the test suite with `rake`,
+
 ## Usage
 
 ### ActiveRecord
@@ -117,6 +128,11 @@ monetized field, you can use the `:allow_nil` parameter like this:
 # in Product model
 monetize :optional_price_cents, :allow_nil => true
 
+# in Migration
+def change
+  add_money :products, :optional_price, amount: { null: true, default: nil }
+end
+
 # then blank assignments are permitted
 product.optional_price = nil
 product.save # returns without errors
@@ -127,7 +143,7 @@ product.optional_price_cents # => nil
 #### Numericality validation options
 
 You can also pass along
-[numericality validation options](http://guides.rubyonrails.org/active_record_validations_callbacks.html#numericality)
+[numericality validation options](http://guides.rubyonrails.org/active_record_validations.html#numericality)
 such as this:
 
 ```ruby
@@ -138,6 +154,13 @@ monetize :price_in_a_range_cents, :allow_nil => true,
   }
 ```
 
+Or, if you prefer, you can skip validations entirely for the attribute. This is useful if chosen attributes
+are aggregate methods and you wish to avoid executing them on every record save.
+
+```ruby
+monetize :price_in_a_range_cents, :disable_validation => true
+```
+
 ### Mongoid 2.x and 3.x
 
 `Money` is available as a field type to supply during a field definition:
@@ -354,6 +377,7 @@ MoneyRails.configure do |config|
   #
   # config.no_cents_if_whole = nil
   # config.symbol = nil
+  # config.sign_before_symbol = nil
 end
 ```
 
@@ -372,6 +396,7 @@ end
 * ```no_cents_if_whole```: Force `Money#format` method to use its value as the default for ```no_cents_if_whole``` key.
 * ```symbol```: Use its value as the default for ```symbol``` key in
   `Money#format` method.
+* ```sign_before_symbol```: Force `Money#format` to place the negative sign before the currency symbol.
 * ```amount_column```: Provide values for the amount column (holding the fractional part of a money object).
 * ```currency_column```: Provide default values or even disable (`present: false`) the currency column.
 
@@ -467,4 +492,4 @@ You can see a full list of the currently supported interpreters in [travis.yml](
 
 ## License
 
-MIT License. Copyright 2012 RubyMoney.
+MIT License. Copyright 2012-2013 RubyMoney.

data/Rakefile

@@ -32,6 +32,18 @@ namespace :spec do
     sh "BUNDLE_GEMFILE='gemfiles/mongoid2.gemfile' bundle exec rake -t spec"
   end
 
+  desc "Run Tests against rails 4"
+  task :rails4 do
+    sh "BUNDLE_GEMFILE='gemfiles/rails4.gemfile' bundle --quiet"
+    sh "BUNDLE_GEMFILE='gemfiles/rails4.gemfile' bundle exec rake -t spec"
+  end
+
+  desc "Run Tests against rails 3"
+  task :rails3 do
+    sh "BUNDLE_GEMFILE='gemfiles/rails3.gemfile' bundle --quiet"
+    sh "BUNDLE_GEMFILE='gemfiles/rails3.gemfile' bundle exec rake -t spec"
+  end
+
   desc "Run Tests against activerecord"
   task :activerecord do
     sh "bundle --quiet"
@@ -48,9 +60,13 @@ namespace :spec do
     sh "BUNDLE_GEMFILE='gemfiles/mongoid2.gemfile' bundle --quiet"
     sh "BUNDLE_GEMFILE='gemfiles/mongoid2.gemfile' bundle exec rake -t spec"
 
-    # ActiveRecord
-    sh "bundle --quiet"
-    sh "bundle exec rake -t spec"
+    # rails 4
+    sh "BUNDLE_GEMFILE='gemfiles/rails4.gemfile' bundle --quiet"
+    sh "BUNDLE_GEMFILE='gemfiles/rails4.gemfile' bundle exec rake -t spec"
+
+    # rails 3
+    sh "BUNDLE_GEMFILE='gemfiles/rails3.gemfile' bundle --quiet"
+    sh "BUNDLE_GEMFILE='gemfiles/rails3.gemfile' bundle exec rake -t spec"
   end
 end
 

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

@@ -9,21 +9,36 @@ module MoneyRails
         subunit_attr = record.class.monetized_attributes[attr.to_sym]
         return unless record.changed_attributes.keys.include? subunit_attr
 
+        raw_value = nil
+
         # WARNING: Currently this is only defined in ActiveRecord extension!
         before_type_cast = "#{attr}_money_before_type_cast"
-        raw_value = record.send(before_type_cast) if record.respond_to?(before_type_cast.to_sym)
+        raw_value = record.send(before_type_cast) if record.respond_to?(
+          before_type_cast.to_sym)
 
-        # Skip it if raw_value is already a Money object
-        return if raw_value.is_a?(Money) || raw_value.nil?
+        # If raw value is nil and changed subunit is nil, then
+        # nil is a assigned value, elsewhere we should treat the
+        # subunit value as the one assigned.
+        if raw_value.nil?
+          if record.send(subunit_attr)
+            raw_value = record.send(subunit_attr)
+          end
+        end
 
-        if !raw_value.blank?
+        return if options[:allow_nil] && raw_value.nil?
+
+        # Skip normalization for Numeric values
+        # which can directly be handled by NumericalityValidator
+        if raw_value.present? && !raw_value.is_a?(Numeric)
           # remove currency symbol, and negative sign
           currency = record.send("currency_for_#{attr}")
-          decimal_mark = I18n.t('number.currency.format.separator', default: currency.decimal_mark)
-          thousands_separator = I18n.t('number.currency.format.delimiter', default: currency.thousands_separator)
+          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)
 
-          raw_value = raw_value.to_s.gsub(symbol, "")
+          raw_value = raw_value.to_s.strip.gsub(symbol, "")
           abs_raw_value = raw_value.gsub(/^-/, "")
 
           decimal_pieces = abs_raw_value.split(decimal_mark)
@@ -57,6 +72,7 @@ module MoneyRails
             .gsub(decimal_mark, '.')
             .gsub(/[\s_]/, '')
         end
+
         super(record, attr, raw_value)
       end
     end

data/lib/money-rails/active_record/monetizable.rb

@@ -21,10 +21,13 @@ module MoneyRails
               ":with_currency or :with_model_currency")
           end
 
-          # Optional accessor to be run on an instance to detect currency 
+          # Optional accessor to be run on an instance to detect currency
           instance_currency_name = options[:with_model_currency] ||
-            options[:model_currency] || "currency"
-          instance_currency_name = instance_currency_name.to_s
+            options[:model_currency] ||
+            MoneyRails::Configuration.currency_column[:column_name]
+
+          instance_currency_name = instance_currency_name &&
+            instance_currency_name.to_s
 
           # This attribute allows per column currency values
           # Overrides row and default currency
@@ -55,32 +58,76 @@ module MoneyRails
             end
           end unless respond_to? :monetized_attributes
 
-          # Include numericality validation if needed
-          if MoneyRails.include_validations
-            validation_options = {
+          # Include numericality validations if needed.
+          # There are two validation options:
+          #
+          # 1. Subunit field validation (e.g. cents should be > 100)
+          # 2. Money field validation (e.g. euros should be > 10)
+          #
+          # All the options which are available for Rails numericality
+          # validation, are also available for both types.
+          # E.g.
+          #   monetize :price_in_a_range_cents, :allow_nil => true,
+          #     :subunit_numericality => {
+          #       :greater_than_or_equal_to => 0,
+          #       :less_than_or_equal_to => 10000,
+          #     },
+          #     :numericality => {
+          #       :greater_than_or_equal_to => 0,
+          #       :less_than_or_equal_to => 100,
+          #       :message => "Must be greater than zero and less than $100"
+          #     }
+          #
+          # To disable validation entirely, use :disable_validation, E.g:
+          #   monetize :price_in_a_range_cents, :disable_validation => true
+          if MoneyRails.include_validations && !options[:disable_validation]
+
+            subunit_validation_options =
+              unless options.has_key? :subunit_numericality
+                true
+              else
+                options[:subunit_numericality]
+              end
+
+            money_validation_options =
+              unless options.has_key? :numericality
+                true
+              else
+                options[:numericality]
+              end
+
+            # This is a validation for the subunit
+            validates subunit_name, {
               :allow_nil => options[:allow_nil],
-              :numericality => true
+              :numericality => subunit_validation_options
             }
-            validates subunit_name, validation_options
 
-            validation_options = { :allow_nil => options[:allow_nil] }
-            validation_options = options[:numericality].merge(validation_options) if options[:numericality]
-            
             # Allow only Money objects or Numeric values!
-            validates name.to_sym, 'money_rails/active_model/money' => validation_options
+            validates name.to_sym, {
+              :allow_nil => options[:allow_nil],
+              'money_rails/active_model/money' => money_validation_options
+            }
           end
 
           define_method name do |*args|
+
+            # Get the cents
             amount = send(subunit_name, *args)
+
+            # Get the currency object
             attr_currency = send("currency_for_#{name}")
 
-            # Dont create a new Money instance if the values haven't changed
+            # Get the cached value
             memoized = instance_variable_get("@#{name}")
+
+            # Dont create a new Money instance if the values haven't been changed.
             return memoized if memoized && memoized.cents == amount &&
               memoized.currency == attr_currency
 
+            # If amount is NOT nil (or empty string) load the amount in a Money
             amount = Money.new(amount, attr_currency) unless amount.blank?
 
+            # Cache and return the value (it may be nil)
             instance_variable_set "@#{name}", amount
           end
 
@@ -89,6 +136,7 @@ module MoneyRails
             # Lets keep the before_type_cast value
             instance_variable_set "@#{name}_money_before_type_cast", value
 
+            # Use nil or get a Money object
             if options[:allow_nil] && value.blank?
               money = nil
             else
@@ -99,14 +147,27 @@ module MoneyRails
               end
             end
 
+            # Update cents
             send("#{subunit_name}=", money.try(:cents))
-            send("#{instance_currency_name}=", money.try(:currency).try(:iso_code)) if self.respond_to?("#{instance_currency_name}=")
 
+            # Update currency iso value if there is an instance currency attribute
+            if instance_currency_name.present? &&
+              self.respond_to?("#{instance_currency_name}=")
+
+              send("#{instance_currency_name}=",
+                   money.try(:currency).try(:iso_code))
+            end
+
+            # Save and return the new Money object
             instance_variable_set "@#{name}", money
           end
 
           define_method "currency_for_#{name}" do
-            if self.respond_to?(instance_currency_name) && send(instance_currency_name).present? 
+            if instance_currency_name.present? &&
+              self.respond_to?(instance_currency_name) &&
+              send(instance_currency_name).present? &&
+              Money::Currency.find(send(instance_currency_name))
+
               Money::Currency.find(send(instance_currency_name))
             elsif field_currency_name
               Money::Currency.find(field_currency_name)
@@ -123,7 +184,7 @@ module MoneyRails
 
           # Hook to ensure the reset of before_type_cast attr
           # TODO: think of a better way to avoid this
-          after_validation do
+          after_save do
             instance_variable_set "@#{name}_money_before_type_cast", nil
           end
         end

data/lib/money-rails/configuration.rb

@@ -51,7 +51,7 @@ module MoneyRails
     #   MoneyRails.configure do |config|
     #     config.default_bank = EuCentralBank.new
     #   end
-    delegate :default_bank=, :to => :Money
+    delegate :default_bank=, :default_bank, :to => :Money
 
     # Provide exchange rates
     delegate :add_rate, :to => :Money
@@ -73,5 +73,8 @@ module MoneyRails
 
     mattr_accessor :symbol
     @@symbol = nil
+
+    mattr_accessor :sign_before_symbol
+    @@sign_before_symbol = nil
   end
 end

data/lib/money-rails/helpers/action_view_extension.rb

@@ -25,8 +25,8 @@ module MoneyRails
       end
     end
 
-    def humanized_money_with_symbol(value)
-      humanized_money(value, :symbol => true)
+    def humanized_money_with_symbol(value, options={})
+      humanized_money(value, options.merge(:symbol => true))
     end
 
     def money_without_cents(value, options={})

data/lib/money-rails/money.rb

@@ -10,7 +10,8 @@ class Money
     # TODO: Add here more setting options
     defaults = {
       no_cents_if_whole: MoneyRails::Configuration.no_cents_if_whole,
-      symbol: MoneyRails::Configuration.symbol
+      symbol: MoneyRails::Configuration.symbol,
+      sign_before_symbol: MoneyRails::Configuration.sign_before_symbol
     }.reject { |k,v| v.nil? }
 
     rules.reverse_merge!(defaults)

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

@@ -3,8 +3,8 @@ class Money
   # Converts an object of this instance into a database friendly value.
   def mongoize
     {
-      :cents        => cents,
-      :currency_iso => currency.iso_code
+      :cents        => cents.mongoize,
+      :currency_iso => currency.iso_code.mongoize
     }
   end
 

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

@@ -17,12 +17,12 @@ class Money
   def serialize(object)
     case
     when object.is_a?(Money)
-        {
-          :cents        => object.cents,
-          :currency_iso => object.currency.iso_code
-        }
+      {
+        :cents        => object.cents.is_a?(BigDecimal) ? object.cents.to_s : object.cents,
+        :currency_iso => object.currency.iso_code
+      }
     when object.respond_to?(:to_money)
-        serialize(object.to_money)
+      serialize(object.to_money)
     else nil
     end
   end

data/lib/money-rails/test_helpers.rb

@@ -17,29 +17,29 @@ module MoneyRails
       match do |target|
         matched = true
         money_attr = @as.presence || attr.to_s.sub(/_cents$/, "")
-        matched = false unless target.send(money_attr).instance_of? Money
-        if @currency_iso
-          matched = false unless target.send(money_attr.to_sym).currency.id == @currency_iso
-        end
+        matched = false if !target.respond_to?(money_attr) ||
+          !target.send(money_attr).instance_of?(Money) ||
+          (@currency_iso &&
+           target.send(money_attr.to_sym).currency.id != @currency_iso)
         matched
       end
 
       description do
-        description = "monetize #{expected}"
+        description = "monetize #{attr}"
         description << " as #{@as}" if @as
         description << " with currency #{@currency_iso}" if @currency_iso
         description
       end
 
       failure_message_for_should do |actual|
-        msg = "expected that #{actual} would be monetized"
+        msg = "expected that #{attr} of #{actual} would be monetized"
         msg << " as #{@as}" if @as
         msg << " with currency #{@currency_iso}" if @currency_iso
         msg
       end
 
       failure_message_for_should_not do |actual|
-        msg = "expected that #{actual} would not be monetized"
+        msg = "expected that #{attr} of #{actual} would not be monetized"
         msg << " as #{@as}" if @as
         msg << " with currency #{@currency_iso}" if @currency_iso
         msg