money-rails 0.7.1 → 0.8.1

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## master
+
+## 0.8.0
+- 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.
+- Added global settings for money object formatted output (:no_cents_if_whole, :symbol options).
+- Enhanced money validator.
+- Added ability to use numericality validations on monetize (GH-70).
+- Fixed error caused by ActiveSupport::HashWithIndifferentAccess
+  (GH-62).
+- Added money-rails test helper (rspec matcher).
+
 ## 0.7.1
 - Fix error when instantiating new model in mongoid extension (GH-60)
 

data/README.md

@@ -44,29 +44,6 @@ 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
@@ -98,6 +75,39 @@ Now the model objects will have a ```discount``` attribute which
 is a Money object, wrapping the value of ```discount_subunit``` column to a
 Money instance.
 
+#### 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
+```
+
+Another example where the currency column is not including:
+
+```ruby
+class MonetizeItem < ActiveRecord::Migration
+  def change
+    add_money :items, :price, currency: { present: false }
+  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.
+
 #### Allow nil values
 
 If you want to allow the assignment of nil and/or blank values to a specific
@@ -114,6 +124,20 @@ product.optional_price # => nil
 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)
+such as this:
+
+```ruby
+monetize :price_in_a_range_cents, :allow_nil => true,
+  :numericality => {
+    :greater_than_or_equal_to => 0,
+    :less_than_or_equal_to => 10000
+  }
+```
+
 ### Mongoid 2.x and 3.x
 
 `Money` is available as a field type to supply during a field definition:
@@ -290,6 +314,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
   #
   # config.register_currency = {
@@ -303,10 +347,17 @@ MoneyRails.configure do |config|
   #   :thousands_separator => ".",
   #   :decimal_mark        => ","
   # }
+
+  # Set money formatted output globally.
+  # Default value is nil meaning "ignore this option".
+  # Options are nil, true, false.
+  #
+  # config.no_cents_if_whole = nil
+  # config.symbol = nil
 end
 ```
 
-* ```default_currecy```: Set the default (application wide) currency (USD is the default)
+* ```default_currency```: Set the default (application wide) currency (USD is the default)
 * ```include_validations```: Permit the inclusion of a ```validates_numericality_of```
   validation for each monetized field (the default is true)
 * ```register_currency```: Register one custom currency. This option can be
@@ -318,6 +369,11 @@ end
   only! This rate is added to the attached bank object.
 * ```default_bank```: The default bank object holding exchange rates etc.
   (https://github.com/RubyMoney/money#currency-exchange)
+* ```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.
+* ```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.
 
 ### Helpers
 
@@ -335,7 +391,7 @@ This will render a `span` dom element with the default currency symbol.
 ```
 This will render a formatted money value without the currency symbol and
 without the cents part if it contains only zeros (uses
-`:no_cents_fi_whole flag`).
+`:no_cents_if_whole flag`).
 
 * humanize with symbol helper
 
@@ -362,6 +418,36 @@ without the cents part.
 This will render a formatted money value including the currency symbol and
 without the cents part.
 
+### Testing
+
+If you use Rspec there is an test helper implementation.
+Just write `require "money-rails/test_helpers"` in spec_helper.rb and
+`include MoneyRails::TestHelpers` inside a describe block you want to
+use the helper.
+
+* the `monetize` matcher
+
+```
+monetize(:price_cents).should be_true
+```
+This will ensure that a column called `price_cents` is being monetized.
+
+```
+monetize(:price_cents).as(:discount_value).should be_true
+```
+By using `as` chain you can specify the exact name to which a monetized
+column is being mapped.
+
+```
+monetize(:price_cents).with_currency(:gbp).should be_true
+```
+
+By using the `with_currency` chain you can specify the expected currency
+for the chosen money attribute. (You can also combine all the chains.)
+
+For examples on using the test_helpers look at
+[test_helpers_spec.rb](https://github.com/RubyMoney/money-rails/blob/master/spec/test_helpers_spec.rb)
+
 ## Supported ORMs/ODMs
 
 * ActiveRecord (>= 3.x)

data/Rakefile

@@ -54,7 +54,7 @@ namespace :spec do
   end
 end
 
-desc "Update AUTHORS file"
-task :authors do
-  sh "git shortlog -s | awk '{ print $2 \" \" $3 }' > AUTHORS"
+desc "Update CONTRIBUTORS file"
+task :contributors do
+  sh "git shortlog -s | awk '{ print $2 \" \" $3 }' > CONTRIBUTORS"
 end

data/lib/generators/templates/money.rb

@@ -4,7 +4,7 @@ MoneyRails.configure do |config|
 
   # To set the default currency
   #
-  #config.default_currency = :usd
+  # config.default_currency = :usd
 
   # Set default bank object
   #
@@ -21,7 +21,7 @@ MoneyRails.configure do |config|
   # To handle the inclusion of validations for monetized fields
   # The default value is true
   #
-  #config.include_validations = true
+  # config.include_validations = true
 
   # Default ActiveRecord migration configuration values for columns:
   #
@@ -58,4 +58,10 @@ MoneyRails.configure do |config|
   #   :decimal_mark        => ","
   # }
 
+  # Set money formatted output globally.
+  # Default value is nil meaning "ignore this option".
+  # Options are nil, true, false.
+  #
+  # config.no_cents_if_whole = nil
+  # config.symbol = nil
 end

data/lib/money-rails.rb

@@ -1,5 +1,6 @@
 require "money"
 require "money-rails/configuration"
+require "money-rails/money"
 require "money-rails/version"
 require 'money-rails/hooks'
 

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

@@ -23,15 +23,17 @@ module MoneyRails
           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, "").gsub(/^-/, "")
+          raw_value = raw_value.to_s.gsub(symbol, "")
+          abs_raw_value = raw_value.gsub(/^-/, "")
 
-          decimal_pieces = raw_value.split(decimal_mark)
+          decimal_pieces = abs_raw_value.split(decimal_mark)
 
-          # check for numbers like 12.23.45
-          if decimal_pieces.length > 2
+          # check for numbers like '12.23.45' or '....'
+          unless [1, 2].include? decimal_pieces.length
             record.errors.add(attr, I18n.t('errors.messages.invalid_currency',
                                            { :thousands => thousands_separator,
                                              :decimal => decimal_mark }))
+            return
           end
 
           pieces = decimal_pieces[0].split(thousands_separator)
@@ -48,11 +50,12 @@ module MoneyRails
             end
           end
 
-          # remove thousands separators
-          raw_value = raw_value.to_s.gsub(thousands_separator, '')
-
-          # normalize decimal mark
-          raw_value = raw_value.to_s.gsub(decimal_mark, '.')
+          # Remove thousands separators, normalize decimal mark,
+          # remove whitespaces and _ (E.g. 99 999 999 or 12_300_200.20)
+          raw_value = raw_value.to_s
+            .gsub(thousands_separator, '')
+            .gsub(decimal_mark, '.')
+            .gsub(/[\s_]/, '')
         end
         super(record, attr, raw_value)
       end

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

@@ -35,12 +35,12 @@ module MoneyRails
 
           # Form target name for the money backed ActiveModel field:
           # if a target name is provided then use it
-          # if there is a "_cents" suffix then just remove it to create the target name
+          # if there is a "_{column.postfix}" suffix then just remove it to create the target name
           # if none of the previous is the case then use a default suffix
           if name
             name = name.to_s
-          elsif subunit_name =~ /_cents$/
-            name = subunit_name.sub(/_cents$/, "")
+          elsif subunit_name =~ /#{MoneyRails::Configuration.amount_column[:postfix]}$/
+            name = subunit_name.sub(/#{MoneyRails::Configuration.amount_column[:postfix]}$/, "")
           else
             # FIXME: provide a better default
             name = [subunit_name, "money"].join("_")
@@ -57,10 +57,17 @@ module MoneyRails
 
           # Include numericality validation if needed
           if MoneyRails.include_validations
-            validates_numericality_of subunit_name, :allow_nil => options[:allow_nil]
-
+            validation_options = {
+              :allow_nil => options[:allow_nil],
+              :numericality => true
+            }
+            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' => { :allow_nil => options[:allow_nil] }
+            validates name.to_sym, 'money_rails/active_model/money' => validation_options
           end
 
           define_method name do |*args|

data/lib/money-rails/configuration.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
 
 module MoneyRails
 
@@ -19,9 +20,15 @@ module MoneyRails
 
     # Configuration parameters
 
+    def default_currency
+      Money.default_currency
+    end
+
     # Set default currency of money library
     def default_currency=(currency_name)
       Money.default_currency = Money::Currency.new(currency_name)
+      set_amount_column_for_default_currency!
+      set_currency_column_for_default_currency!
     end
 
     # Register a custom currency
@@ -29,6 +36,15 @@ module MoneyRails
       Money::Currency.register(currency_options)
     end
 
+    def set_amount_column_for_default_currency!
+      amount_column.merge! postfix: "_#{default_currency.subunit.downcase.pluralize}" if default_currency.subunit
+    end
+
+    def set_currency_column_for_default_currency!
+      iso_code = default_currency.iso_code
+      currency_column.merge! default: iso_code
+    end
+
     # Set default bank object
     #
     # example (given that eu_central_bank is in Gemfile):
@@ -50,5 +66,12 @@ module MoneyRails
 
     mattr_accessor :currency_column
     @@currency_column = { postfix: '_currency', type: :string, null: false, default: 'USD', present: true }
+
+    # Use nil values to ignore defaults
+    mattr_accessor :no_cents_if_whole
+    @@no_cents_if_whole = nil
+
+    mattr_accessor :symbol
+    @@symbol = nil
   end
 end

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

@@ -5,32 +5,47 @@ module MoneyRails
       content_tag(:span, Money.default_currency.symbol, :class => "currency_symbol")
     end
 
-    def humanized_money(value, symbol=false)
+    def humanized_money(value, options={})
+      if !options || !options.is_a?(Hash)
+        warn "humanized_money now takes a hash of formatting options, please specify { :symbol => true }"
+        options = { :symbol => options }
+      end
+
+      options = {
+        :no_cents_if_whole => true,
+        :symbol => false
+      }.merge(options)
+
       if value.is_a?(Money)
-        value.format(:no_cents_if_whole => true, :symbol => symbol)
+        value.format(options)
       elsif value.respond_to?(:to_money)
-        value.to_money.format(:no_cents_if_whole => true, :symbol => symbol)
+        value.to_money.format(options)
       else
         ""
       end
     end
 
     def humanized_money_with_symbol(value)
-      humanized_money(value, true)
+      humanized_money(value, :symbol => true)
     end
 
-    def money_without_cents(value, symbol=false)
-      if value.is_a?(Money)
-        value.format(:no_cents => true, :symbol => symbol)
-      elsif value.respond_to?(:to_money)
-        value.to_money.format(:no_cents => true, :symbol => symbol)
-      else
-        ""
+    def money_without_cents(value, options={})
+      if !options || !options.is_a?(Hash)
+        warn "money_without_cents now takes a hash of formatting options, please specify { :symbol => true }"
+        options = { :symbol => options }
       end
+
+      options = {
+        :no_cents => true,
+        :no_cents_if_whole => false,
+        :symbol => false
+      }.merge(options)
+
+      humanized_money(value, options)
     end
 
     def money_without_cents_and_with_symbol(value)
-      money_without_cents(value, true)
+      money_without_cents(value, :symbol => true)
     end
   end
 end

data/lib/money-rails/hooks.rb

@@ -18,10 +18,8 @@ module MoneyRails
       if defined? ::Mongoid
         if ::Mongoid::VERSION =~ /^2(.*)/
           require 'money-rails/mongoid/two' # Loading the file is enough
-        end
-
-        if ::Mongoid::VERSION =~ /^3(.*)/
-          require 'money-rails/mongoid/three'
+        else
+          require 'money-rails/mongoid/money'
         end
       end