money_attribute 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874e817fa1e157ee49e460c8848dabff3fe525d9849571d21045de2694dd0770
-  data.tar.gz: 933dcdd5adc296d9aa635da79fc181e15652ed884c2e3b1231655a5652a2beca
+  metadata.gz: 47ae4d496ececb42ec6ab60e278b3b523518c057074ead9610d90395ae4c5cb7
+  data.tar.gz: 3f26f8a306a4d64cf982ca0d079cdf7738dc10b3acaed2ccb2036b67755b83e9
 SHA512:
-  metadata.gz: b5547742974245c1cffd5b690fa4c763e79224e553c90c2e19e88cdccb0d2c7ccdf669f9000e1917abe01fb880c2a50b0b2b475ffebf3fdfe01b787b0f4630ad
-  data.tar.gz: d0b760447e051fb0a1dc15492ba737676af935443ad5dcec4fb18988c898db37bf5980781d52cc64a4c60c651d03646ad77bb63ffdb6cb046c6d19f67cc7d092
+  metadata.gz: d2ef7b83fee1736f8944ebfcec5348b7c69a9b15f018b8080689c30dd4387aa2cfa10b4a459bf3ff36a117f2c22a7ce1e98909e2e6a5d3e56eada694c46b0080
+  data.tar.gz: 8e1da01132bb2309f0c5fc10ec00648a035c761e6ca3f3fa7ac43f3ed7e19d324831f8142d939225aab7c273308507c428a115509b911e2c1944cbfc12ae704e

data/README.md

@@ -27,7 +27,7 @@ class CreateProducts < ActiveRecord::Migration[8.1]
   def change
     create_table :products do |t|
       t.string :name
-      t.money  :price
+      t.money_attribute :price
       t.timestamps
     end
   end
@@ -91,17 +91,19 @@ The generator creates `config/initializers/money_attribute.rb`.
 
 ## Migration helpers
 
-MoneyAttribute adds `add_money` / `remove_money` for existing tables and `t.money` / `t.remove_money` for `create_table` / `change_table` blocks:
+MoneyAttribute adds `add_money_attribute` / `remove_money_attribute` for existing tables and `t.money_attribute` / `t.remove_money_attribute` for `create_table` / `change_table` blocks.
+
+By default `t.money_attribute :price` creates a `decimal(16,4)` amount column and a `string` currency column — both nullable, no default. Pass `amount: { type: :integer }` to store subunits instead, or `currency: false` to skip the currency column entirely.
 
 ```ruby
 class CreateProducts < ActiveRecord::Migration[8.1]
   def change
     create_table :products do |t|
       t.string :name
-      t.money  :price          # price (decimal) + price_currency (string)
-      t.money  :price_amount   # price_amount + price_currency (strips _amount suffix)
-      t.money  :fee, currency: false             # single column, no currency
-      t.money  :tax, type: :bigint               # bigint amount + currency
+      t.money_attribute :price          # price (decimal) + price_currency (string)
+      t.money_attribute :price_amount   # price_amount + price_currency (strips _amount suffix)
+      t.money_attribute :fee, currency: false             # single column, no currency
+      t.money_attribute :tax, amount: { type: :bigint }   # bigint amount + currency
       t.timestamps
     end
   end
@@ -109,9 +111,9 @@ end
 
 class AddPriceToProducts < ActiveRecord::Migration[8.1]
   def change
-    add_money :products, :price                 # add price + price_currency
-    add_money :products, :discount, type: :integer
-    remove_money :products, :obsolete_fee       # reversible in change
+    add_money_attribute :products, :price                 # add price + price_currency
+    add_money_attribute :products, :discount, amount: { type: :integer }
+    remove_money_attribute :products, :obsolete_fee       # reversible in change
   end
 end
 ```
@@ -120,11 +122,22 @@ end
 
 | Migration call | Columns created | Model declaration |
 |---|---|---|
-| `t.money :price` | `price` decimal + `price_currency` string | `money_attribute :price` |
-| `t.money :price_amount` | `price_amount` decimal + `price_currency` string | `money_attribute :price` |
-| `t.money :price, currency: false` | `price` decimal | `money_attribute :price` |
-| `t.money :price, type: :integer` | `price` integer + `price_currency` string | `money_attribute :price` |
-| `t.money :price, amount: :a, currency: :c` | `a` + `c` | `money_attribute :price, mapping: { amount: :a, currency: :c }` |
+| `t.money_attribute :price` | `price` decimal + `price_currency` string | `money_attribute :price` |
+| `t.money_attribute :price_amount` | `price_amount` decimal + `price_currency` string | `money_attribute :price` |
+| `t.money_attribute :price, currency: false` | `price` decimal | `money_attribute :price` |
+| `t.money_attribute :price, amount: { type: :integer }` | `price` integer + `price_currency` string | `money_attribute :price` |
+| `t.money_attribute :price, amount: { column: :a }, currency: { column: :c }` | `a` + `c` | `money_attribute :price, mapping: { amount: :a, currency: :c }` |
+| `t.money_attribute :price, currency: { limit: 3 }` | `price` decimal + `price_currency` string(3) | `money_attribute :price` |
+| `t.money_attribute :price, amount: { precision: 14, scale: 2, null: false }, currency: { limit: 3, default: 'USD' }` | `price` decimal(14,2) NOT NULL + `price_currency` string(3) DEFAULT 'USD' | `money_attribute :price` |
+| `t.remove_money_attribute :price` | Removes `price` + `price_currency` | `money_attribute :price` |
+
+Inside `change_table`:
+
+```ruby
+change_table :products do |t|
+  t.remove_money_attribute :obsolete_fee   # removes obsolete_fee + obsolete_fee_currency
+end
+```
 
 ## Configuration
 
@@ -188,7 +201,7 @@ If none of those keys are set, `format` is used as a plain string (simple format
 
 | | Fixed currency (single column) | Multi-currency (amount + currency) |
 |---|---|---|
-| **Migration** | `t.money :price` (or `t.decimal :price`) | `t.money :price` (or `t.decimal :price_amount` + `t.string :price_currency`) |
+| **Migration** | `t.money_attribute :price` (or `t.decimal :price`) | `t.money_attribute :price` (or `t.decimal :price_amount` + `t.string :price_currency`) |
 | **Model** | `money_attribute :price, currency: 'USD'` | `money_attribute :price` |
 | **When to use** | Column always holds the same currency | Each row can hold a different currency |
 | **Column type** | `decimal`, `integer`, or `bigint` | `decimal`, `integer`, or `bigint` for amount; `string` for currency |
@@ -224,6 +237,8 @@ offer = Offer.new(price: '12')
 offer.price.currency.code # => "USD"
 ```
 
+Unlike fixed-currency attributes, composite mode does not enforce a specific currency — any registered currency is accepted at assignment.
+
 ## Column type detection
 
 Declare the column as `decimal`, `integer`, or `bigint` — the gem adapts:
@@ -268,7 +283,14 @@ class Invoice < ApplicationRecord
 end
 ```
 
-The mapping keys are `:amount` and `:currency`; values are your database column names.
+The mapping keys are `:amount` and `:currency`; values are your database column names. You can provide only one key — the other falls back to the `<name>_amount` / `<name>_currency` convention:
+
+```ruby
+class Invoice < ApplicationRecord
+  money_attribute :total, mapping: { amount: :total_amount }
+  # currency column inferred as `total_currency`
+end
+```
 
 ## Column resolution
 
@@ -279,8 +301,10 @@ When you declare `money_attribute :name`, the gem resolves which database column
 | 1 | `mapping:` provided | As specified | Explicit composite |
 | 2 | `name_currency` column exists | `name` + `name_currency` | Composite (multi-currency) |
 | 3 | `name == 'amount'` AND `currency` column exists | `amount` + `currency` | Composite (multi-currency) |
-| 4 | `name_amount` + `name_currency` columns exist | `name_amount` + `name_currency` | Composite (multi-currency) |
-| 5 | `name` column exists (no currency partner) | `name` alone | Single-column (fixed-currency) |
+| 4 | `name` column exists (no currency partner) | `name` alone | Single-column (fixed-currency) |
+| 5 | None of the above (name column missing) | `name_amount` + `name_currency` (convention) | Composite (multi-currency) |
+
+Step 5 raises `ArgumentError` if the convention columns don't exist in the table.
 
 **Example**
 

data/lib/money_attribute/migration_extensions/helper.rb

@@ -8,42 +8,52 @@ module MoneyAttribute
       def parse_money_args(accessor, options = {})
         name = accessor.to_s
 
-        amount_col = options.key?(:amount) ? options[:amount].to_s : name
-
-        if options.key?(:currency)
-          currency_col = if options[:currency] == false
-                           nil
-                         else
-                           options[:currency].to_s
-                         end
+        if options.key?(:amount) && options[:amount].is_a?(Hash)
+          amount_col = options[:amount][:column]&.to_s || name
+          opts = options[:amount]
+          amount_opts = {
+            type: opts[:type],
+            null: opts[:null],
+            default: opts[:default],
+            precision: opts[:precision],
+            scale: opts[:scale]
+          }.compact
         else
-          stripped = name.end_with?('_amount') ? name.sub(/_amount$/, '') : name
-          currency_col = "#{stripped}_currency"
+          amount_col = name
+          amount_opts = {}
         end
 
-        col_type = options[:type] || :decimal
-
-        amount_opts = {}
-        amount_opts[:type] = col_type
+        amount_opts[:type] ||= :decimal
 
-        if options.key?(:amount) && options[:amount].is_a?(Hash)
-          amount_opts[:null]      = options[:amount][:null]      if options[:amount].key?(:null)
-          amount_opts[:default]   = options[:amount][:default]   if options[:amount].key?(:default)
-          amount_opts[:precision] = options[:amount][:precision] if options[:amount].key?(:precision)
-          amount_opts[:scale]     = options[:amount][:scale]     if options[:amount].key?(:scale)
-        end
-
-        if col_type == :decimal && !amount_opts.key?(:precision) && !amount_opts.key?(:scale)
+        if amount_opts[:type] == :decimal && !amount_opts.key?(:precision) && !amount_opts.key?(:scale)
           amount_opts[:precision] = 16
           amount_opts[:scale]     = 4
+        elsif amount_opts[:type] != :decimal
+          amount_opts.delete(:precision)
+          amount_opts.delete(:scale)
         end
 
-        currency_opts = {}
-        currency_opts[:limit] = options[:currency_limit] if options[:currency_limit]
-
-        if options[:currency].is_a?(Hash)
-          currency_opts[:null]    = options[:currency][:null]    if options[:currency].key?(:null)
-          currency_opts[:default] = options[:currency][:default] if options[:currency].key?(:default)
+        stripped = name.end_with?('_amount') ? name.sub(/_amount$/, '') : name
+        default_currency_col = if name == 'amount' && !(options[:currency].is_a?(Hash) && options[:currency][:column])
+                                 'currency'
+                               else
+                                 "#{stripped}_currency"
+                               end
+
+        if options.key?(:currency) && options[:currency].is_a?(Hash)
+          currency_col = options[:currency][:column]&.to_s || default_currency_col
+          opts = options[:currency]
+          currency_opts = {
+            limit: opts[:limit],
+            null: opts[:null],
+            default: opts[:default]
+          }.compact
+        elsif options[:currency] == false
+          currency_col = nil
+          currency_opts = {}
+        else
+          currency_col = default_currency_col
+          currency_opts = {}
         end
 
         [amount_col, currency_col, amount_opts, currency_opts]

data/lib/money_attribute/migration_extensions/schema_statements.rb

@@ -7,14 +7,14 @@ module MoneyAttribute
     module SchemaStatements
       include Helper
 
-      def add_money(table_name, accessor, options = {})
+      def add_money_attribute(table_name, accessor, options = {})
         amount_col, currency_col, amount_opts, currency_opts = parse_money_args(accessor, options)
 
         add_column(table_name, amount_col, amount_opts[:type], **amount_opts.except(:type))
         add_column(table_name, currency_col, :string, **currency_opts) if currency_col
       end
 
-      def remove_money(table_name, accessor, options = {})
+      def remove_money_attribute(table_name, accessor, options = {})
         amount_col, currency_col, = parse_money_args(accessor, options)
 
         remove_column(table_name, amount_col)

data/lib/money_attribute/migration_extensions/table_definition.rb

@@ -7,14 +7,14 @@ module MoneyAttribute
     module TableDefinition
       include Helper
 
-      def money(accessor, options = {})
+      def money_attribute(accessor, options = {})
         amount_col, currency_col, amount_opts, currency_opts = parse_money_args(accessor, options)
 
         column(amount_col, amount_opts[:type], **amount_opts.except(:type))
         column(currency_col, :string, **currency_opts) if currency_col
       end
 
-      def remove_money(accessor, options = {})
+      def remove_money_attribute(accessor, options = {})
         amount_col, currency_col, = parse_money_args(accessor, options)
 
         remove_column(amount_col)

data/lib/money_attribute/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MoneyAttribute
-  VERSION = '0.11.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money_attribute
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Gilson Ferraz