money_attribute 1.2.0 → 1.3.0

data/lib/money_attribute/railtie.rb

@@ -1,6 +1,21 @@
 # frozen_string_literal: true
 
 module MoneyAttribute
+  # Rails engine integration.
+  #
+  # On boot, includes the migration and form-builder extensions into the
+  # corresponding Rails classes, wires Mint's locale backend to Rails i18n,
+  # and registers custom currencies declared in the initializer.
+  #
+  # @example Generated initializer
+  #   MoneyAttribute.configure do |config|
+  #     config.default_currency = 'BRL'
+  #     config.added_currencies = [
+  #       { currency: 'BTB', subunit: 8, symbol: '₿' }
+  #     ]
+  #   end
+  #
+  # @api private
   class Railtie < ::Rails::Railtie
     generators do
       require 'generators/money_attribute/initializer_generator'
@@ -21,17 +36,27 @@ module MoneyAttribute
     end
 
     # Configures Mint to use the Rails locale currency format.
+    #
+    # @return [void]
+    # @api private
     def self.setup_locale_backend!
       ::Mint.locale_backend = method(:build_locale_format).to_proc
     end
 
     # Builds the locale-aware currency formatting hash.
+    #
+    # @return [Hash] the +:decimal+, +:thousand+, and +:format+ keys for Mint
+    # @api private
     def self.build_locale_format
       fmt = I18n.t('number.currency.format', default: {})
       { decimal: fmt[:separator], thousand: fmt[:delimiter], format: build_format(fmt) }
     end
 
     # Builds the final currency format string or hash for Mint.
+    #
+    # @param fmt [Hash] the Rails currency format settings
+    # @return [String, Hash] a single format string or a per-sign format hash
+    # @api private
     def self.build_format(fmt)
       if %i[positive negative zero].any? { |k| fmt.key?(k) }
         build_hash_format(fmt)
@@ -41,6 +66,10 @@ module MoneyAttribute
     end
 
     # Builds a per-sign currency format hash.
+    #
+    # @param fmt [Hash] the Rails currency format settings
+    # @return [Hash] the +:positive+, +:negative+, and +:zero+ format strings
+    # @api private
     def self.build_hash_format(fmt)
       {
         positive: translate_format(fmt[:positive] || fmt[:format]),
@@ -50,11 +79,22 @@ module MoneyAttribute
     end
 
     # Translates Rails currency placeholders into Mint placeholders.
+    #
+    # @param str [String, nil] the Rails format string
+    # @return [String] the translated format string
+    # @api private
     def self.translate_format(str)
       str.to_s.gsub('%n', '%<amount>f').gsub('%u', '%<symbol>s')
     end
 
     # Registers custom currencies configured by the application.
+    #
+    # Accepts hashes with +:currency+, +:subunit+, +:symbol+ keys or the
+    # matching positional array form. Already-registered currencies are skipped.
+    #
+    # @return [void]
+    # @raise [ArgumentError] if a currency hash is missing a required key
+    # @api private
     def self.register_custom_currencies!
       Array(MoneyAttribute.config.added_currencies).each do |currency_data|
         if currency_data.respond_to?(:values_at)

data/lib/money_attribute/type.rb

@@ -7,7 +7,11 @@ module MoneyAttribute
     #
     # @param value [String, Numeric, Mint::Money, nil] the input value
     # @return [Mint::Money, Numeric, nil] a Money value for strings, otherwise delegates to super
-    def cast(value) = value.is_a?(String) ? Money.parse(value, MoneyAttribute.default_currency) : super
+    def cast(value)
+      return Money.parse(value, default_currency: MoneyAttribute.default_currency) if value.is_a?(String)
+
+      super
+    end
 
     # Validates that the value is compatible with the fixed currency type.
     #
@@ -50,7 +54,7 @@ module MoneyAttribute
     #
     # @param value [BigDecimal, nil] the raw database value
     # @return [Mint::Money, nil]
-    def deserialize(value) = value && Money.from(value, MoneyAttribute.default_currency)
+    def deserialize(value) = value&.to_money(MoneyAttribute.default_currency)
 
     # Serializes a +Mint::Money+ value into a decimal.
     #

data/lib/money_attribute/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module MoneyAttribute
-  VERSION = '1.2.0'
+  # The current gem version, following semantic versioning.
+  VERSION = '1.3.0'
 end

data/lib/money_attribute.rb

@@ -15,6 +15,7 @@ require 'money_attribute/core_ext/numeric'
 require 'money_attribute/core_ext/string'
 require 'money_attribute/configuration'
 require 'money_attribute/current'
+require 'money_attribute/column_type_validations'
 require 'money_attribute/attribute_spec'
 require 'money_attribute/attribute_spec_registry'
 require 'money_attribute/macro'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money_attribute
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Gilson Ferraz
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,7 @@ files:
 - lib/money_attribute.rb
 - lib/money_attribute/attribute_spec.rb
 - lib/money_attribute/attribute_spec_registry.rb
+- lib/money_attribute/column_type_validations.rb
 - lib/money_attribute/configuration.rb
 - lib/money_attribute/converter.rb
 - lib/money_attribute/core_ext/numeric.rb
@@ -99,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Money attributes for ActiveRecord
 test_files: []