minting-rails 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bebeb146f003c49cd0f1c667648090a35f96d5d22edfec3c6616f5f45d812988
-  data.tar.gz: f6084d3f41dce76e7b437505566a1a606f54a92419cac641e017d33a9a2d0400
+  metadata.gz: 205d9eb9b1d27048756b4f65f2e65781ae71f131d1d838a1834ea733349d3bf4
+  data.tar.gz: ea2dfd05351ae59717737a0770480c1eeb6cf484264c9daea064c87ac80dd4a0
 SHA512:
-  metadata.gz: 46539fbf075c057d2fb2727320975b13dd20f5efbe5a0ad2955d51f78f1720ecb4e9a3e7f52c9428f798dabf13a04a258403df6fe0735fff901a0c8e6e2ccf08
-  data.tar.gz: 66528813c392c867719ea9dcecf24fbc78a8bdd9fe9b234d6ca82c201b6d6da533ebd3058b0610223def05344e10843505a3c30fe13d65acd5593717b2d8fce2
+  metadata.gz: a3e434d199296b8d9a22db937b2b40af35eec147a7fdc1d4a1c1a387a3a0300b806381f2e98cb3a3dfc40371b1087f1529a3a81b399b91dff4d4f454034f39c4
+  data.tar.gz: 8552a6d4d6c8f6567a4300c6540b04c00ca220b52b3deb0f0ba00af1fb40d0c974110eb97f04d3d0acb8d037f32852d61cd4a55a6b8d2dc17cbc398c9e58c6d4

data/README.md

@@ -2,7 +2,7 @@
 
 Minting::Rails brings [Minting](https://github.com/gferraz/minting) money objects to Active Record models.
 
-It adds a `money_attribute` model helper, registers a `:mint_money` Active Record type, and includes small convenience methods such as `12.to_money(:USD)`, `12.dollars`, and `'12.00'.mint(:BRL)`.
+It adds a `money_attribute` model helper, registers a `:mint_money` Active Record type, and includes small convenience methods such as `12.to_money('USD')`, `12.dollars`, and `'12.00'.mint('BRL')`.
 
 ## What it does
 
@@ -15,7 +15,7 @@ It adds a `money_attribute` model helper, registers a `:mint_money` Active Recor
 
 - Ruby 3.3 or newer.
 - Rails 7.1.3.2 or newer.
-- Minting 1.0.0 or newer.
+- Minting 1.6.0 or newer.
 
 ## Installation
 
@@ -45,6 +45,7 @@ Configure Minting in `config/initializers/minting.rb`:
 Mint.configure do |config|
   config.enabled_currencies = :all
   config.default_currency = 'USD'
+  config.default_format = '%<symbol>s%<amount>f'
 end
 ```
 
@@ -63,7 +64,7 @@ You can also register custom currencies before enabling or using them:
 Mint.configure do |config|
   config.added_currencies = [
     { currency: 'CRC', subunit: 2, symbol: 'CRC' },
-    { currency: 'NGN', subunit: 2, symbol: 'NGN' }
+    { currency: 'NGN', subunit: 2, symbol: 'NGN' } # subunit is the number of digits after the decimal; USD has 2, JPY has 0, BHD has 3
   ]
 
   config.enabled_currencies = :all
@@ -120,7 +121,7 @@ product.discount
 Assigning a `Mint::Money` with a different currency raises `ArgumentError`:
 
 ```ruby
-Product.new(price: 12.to_money(:EUR))
+Product.new(price: 12.to_money('EUR'))
 # raises ArgumentError because the attribute only accepts USD
 ```
 
@@ -154,7 +155,7 @@ end
 The attribute is composed from `price_amount` and `price_currency`:
 
 ```ruby
-offer = Offer.new(price: 15.to_money(:EUR))
+offer = Offer.new(price: 15.to_money('EUR'))
 
 offer.price
 # => #<Mint::Money ... EUR 15.00>
@@ -224,7 +225,7 @@ t.bigint :price
 
 No model change is needed. The column type drives the behavior.
 
-> **Note:** Integer storage avoids decimal rounding issues and is more efficient for large tables. 
+> **Note:** Integer storage is more efficient for large tables. Use Decimal when you need to stay close to SQL standards for interoperability with other systems
 
 ### Default Currency
 
@@ -244,26 +245,26 @@ If your amount and currency columns do not follow the `<name>_amount` and `<name
 ```ruby
 class Invoice < ApplicationRecord
   money_attribute :total, mapping: {
-    total_amount: :amount,
-    currency_code: :currency
+    amount: :total_amount,
+    currency: :currency_code
   }
 end
 ```
 
-The mapping keys are your database columns. The values must identify which column stores the `:amount` and which stores the `:currency`.
+The mapping keys are `:amount` and `:currency`. The values are your database columns.
 
 ## Querying
 
 Fixed-currency attributes can be queried with `Mint::Money` values:
 
 ```ruby
-Product.where(price: 15.to_money(:USD))
+Product.where(price: 15.to_money('USD'))
 ```
 
 Composed attributes can also be queried with a money object:
 
 ```ruby
-Offer.where(price: 15.to_money(:EUR))
+Offer.where(price: 15.to_money('EUR'))
 ```
 
 You can still query the backing columns directly when that is clearer:
@@ -277,12 +278,14 @@ Offer.where(price_amount: 15, price_currency: 'EUR')
 Minting::Rails adds a few small helpers:
 
 ```ruby
-12.to_money(:USD)
-12.mint(:BRL)
+12.to_money('USD')
+12.mint('BRL')
 12.dollars
+1.dollar
+1.euro
 12.euros
-'12.50'.to_money(:USD)
-'12.50'.mint(:BRL)
+'12.50'.to_money('USD')
+'12.50'.mint('BRL')
 ```
 
 These return `Mint::Money` instances.
@@ -303,16 +306,6 @@ bundle exec rake test
 
 The repository includes a dummy Rails application under `test/dummy` for exercising the engine in a Rails environment.
 
-## Releasing
-
-Update the version in `lib/minting/money_attribute/version.rb`, update release notes, and build the gem:
-
-```sh
-gem build minting-rails.gemspec
-```
-
-Publishing is configured for RubyGems.org.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [gferraz/minting-rails](https://github.com/gferraz/minting-rails).

data/lib/generators/templates/minting.rb

@@ -27,22 +27,6 @@ Mint.configure do |config|
   #
   config.default_currency = 'BRL'
 
-  # Specify a rounding mode (not yet implemented)
-  # Any one of:
-  #
-  # BigDecimal::ROUND_UP,
-  # BigDecimal::ROUND_DOWN,
-  # BigDecimal::ROUND_HALF_UP,
-  # BigDecimal::ROUND_HALF_DOWN,
-  # BigDecimal::ROUND_HALF_EVEN,
-  # BigDecimal::ROUND_CEILING,
-  # BigDecimal::ROUND_FLOOR
-  #
-  # set to BigDecimal::ROUND_HALF_EVEN by default
-  #
-  # config.rounding_mode = BigDecimal::ROUND_HALF_UP
-
-  # Set default money format globally.
   # Default value is nil meaning "ignore this option".
   # Example:
   #

data/lib/minting/money_attribute/money_attribute.rb

@@ -42,7 +42,7 @@ module Mint
 
       def find_money_attributes(name, mapping:)
         composite = if mapping.present?
-                      { amount: mapping.key(:amount).to_s, currency: mapping.key(:currency).to_s }
+                      { amount: mapping[:amount].to_s, currency: mapping[:currency].to_s }
                     else
                       { amount: "#{name}_amount", currency: "#{name}_currency" }
                     end

data/lib/minting/money_attribute/parser.rb

@@ -4,25 +4,24 @@ module Mint
   # MoneyAttribute
   module MoneyAttribute
     class Parser
-      def initialize(currency)
+      def initialize(currency = Mint.default_currency)
         @default_currency = currency
       end
 
-      def call(amount, currency = @default_currency)
+      def parse(amount, currency = @default_currency)
         currency = Mint.assert_valid_currency!(currency)
         case amount
         when NilClass    then nil
-        when Mint::Money then amount
         when Numeric     then Mint::Money.create(amount, currency)
         when String      then Mint::Money.create(amount.to_r, currency)
+        when Mint::Money
+         return amount if amount.currency == currency
+         raise TypeError, "Cannot automatically convert #{amount} to #{currency.code}"
         else
-          if amount.respond_to? :to_money
-            amount.to_money(currency)
-          else
-            Mint.parse(amount, currency)
-          end
+          Mint.parse(amount, currency)
         end
       end
+      alias_method  :call, :parse
     end
   end
 end

data/lib/minting/money_attribute/version.rb

@@ -2,6 +2,6 @@
 
 module Mint
   module MoneyAttribute
-    VERSION = '0.5.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/minting/railties.rb

@@ -15,7 +15,7 @@ module Mint
         else
           code, subunit, symbol = *currency_data
         end
-        Mint.register_currency(code:, subunit:, symbol:)
+        Mint.register_currency(code:, subunit:, symbol:) 
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minting-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Gilson Ferraz
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement