minting 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af1a3786bbef7fd2c9d3614ccd5076e0ad6f77fb35bd0d34e636355bafd4714
-  data.tar.gz: 520dfe15e4a3ddcd180a898769266d27502af54e3ad70503ed734ad351564639
+  metadata.gz: 66e576bf9b9ddb1ff390e5e5ecda0f73800b3ab8577baec9b03cc6f9962915d3
+  data.tar.gz: f43875174cd1ab47a0da044e4f877dd6618f5850e363d1f505484a6874346f7e
 SHA512:
-  metadata.gz: bd835b1ff970861a98dff3f056feb8903e2cb5145f0b60e52372d754daa65d60461e5200cc07de954963c0f31d954f8a8f54faf0a4f16746119e1195dc3c206e
-  data.tar.gz: 5f4e58dea85c7129e00aeef897810053136ba8d30cd49a4f199376b0e4f45885680bf1225b518dd479174e473da6e538efe30831e834e2ce41b3fdaf0a81235c
+  metadata.gz: 586c212f24ddfac8b7fb2a619aac93d02af67588c05d2ff222aca680970b80b3aa65998e175d68250d0352843794feee751dcd5da1edb7965318079bbf21d9ab
+  data.tar.gz: b289c844b36dc08099f1ae3ea963ef689e6cd876060d372e185a7f10cd1f3a0f6ec59ae943aacc03598becd869eb00a0402ecebad02d175e1070d3817d13b770

data/README.md

@@ -185,6 +185,49 @@ Option 3: Install it yourself with:
 gem install minting
 ```
 
+## Configuration
+
+### Optional top‑level `Money` and `Currency`
+
+By default, Minting keeps everything namespaced under `Mint`:
+
+```ruby
+price    = Mint::Money.create(10, "USD")
+currency = Mint::Currency.new(code: "USD", symbol: "$", subunit: 2, priority: 0)
+```
+
+To avoid polluting the global namespace (and to coexist nicely with other gems), **Minting dont automatically defines `Money` or `Currency` at the top level automatically**.
+
+If you prefer the shorter `Money` / `Currency` constants in your application code, you can opt in explicitly.
+
+There are two ways to enable shorter constants:
+
+1. Require dsl in your app
+
+```ruby
+require "minting"
+require "minting/dsl"  # opt‑in top‑level Money / Currency
+```
+
+2. Call a configuration method
+
+```ruby
+Minting.use_top_level_constants!
+```
+
+After this, you can use:
+
+```ruby
+price = Money.create(10, "USD")     # equivalent to Mint::Money.create
+tax   = Money.money(2.50, "USD")   # via Mint.money, still available
+cur   = Currency.new(code: "EUR", symbol: "€", subunit: 2, priority: 0)
+```
+
+#### When to use this
+
+- **Good fit:** application code, especially in Rails apps, where `Money` reads nicely in models and views.
+- **Not recommended:** reusable gems/libraries. In that case, stick to the namespaced API (`Mint::Money`, `Mint::Currency`) to avoid conflicts with other libraries.
+
 ## Parsing strings
 
 ```ruby

data/lib/minting/mint/aliases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Optional top‑level aliases for application use.
+# Not required automatically.
+
+Money = Mint::Money
+Currency = Mint::Currency

data/lib/minting/mint/dsl.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Mint refinements
+module Mint
+  refine Numeric do
+    def reais = Mint.money(self, 'BRL')
+
+    def dollars = Mint.money(self, 'USD')
+
+    def euros = Mint.money(self, 'EUR')
+
+    def to_money(currency) = Mint.money(self, currency)
+
+    alias_method :dollar, :dollars
+    alias_method :euro, :euros
+    alias_method :mint, :to_money
+  end
+
+  refine String do
+    def to_money(currency) = Mint.money(to_r, currency)
+  end
+
+  def self.use_top_level_constants!
+    if !defined?(::Money) && !defined?(::Currency)
+      require 'minting/mint/aliases'
+    elsif ::Money == Mint::Money && ::Currency == Mint::Currency
+      warn 'Warning: Money and Currency already defined as Mint aliases, skipping'
+    else
+      raise NameError, 'Cannot define top-level Money or Currency constants: already defined'
+    end
+  end
+end

data/lib/minting/mint.rb

@@ -3,9 +3,9 @@
 require 'minting/mint/currency/currency'
 require 'minting/mint/currency/currency_registry'
 require 'minting/mint/currency/world_currencies'
+require 'minting/mint/dsl'
 require 'minting/mint/mint'
 require 'minting/mint/parser'
-require 'minting/mint/refinements'
 require 'minting/money/allocation'
 require 'minting/money/arithmetics'
 require 'minting/money/coercion'

data/lib/minting/version.rb

@@ -3,5 +3,5 @@
 # Root namespace for the Minting library.
 module Minting
   # Current version of the Minting gem.
-  VERSION = '1.6.2'
+  VERSION = '1.6.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minting
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Gilson Ferraz
@@ -43,12 +43,13 @@ files:
 - lib/minting.rb
 - lib/minting/data/world-currencies.yaml
 - lib/minting/mint.rb
+- lib/minting/mint/aliases.rb
 - lib/minting/mint/currency/currency.rb
 - lib/minting/mint/currency/currency_registry.rb
 - lib/minting/mint/currency/world_currencies.rb
+- lib/minting/mint/dsl.rb
 - lib/minting/mint/mint.rb
 - lib/minting/mint/parser.rb
-- lib/minting/mint/refinements.rb
 - lib/minting/money/allocation.rb
 - lib/minting/money/arithmetics.rb
 - lib/minting/money/coercion.rb

data/lib/minting/mint/refinements.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-# Mint refinements
-module Mint
-  refine Numeric do
-    def reais
-      Mint.money(self, 'BRL')
-    end
-
-    def dollars
-      Mint.money(self, 'USD')
-    end
-
-    def euros
-      Mint.money(self, 'EUR')
-    end
-
-    def to_money(currency)
-      Mint.money(self, currency)
-    end
-
-    alias_method :dollar, :dollars
-    alias_method :euro, :euros
-    alias_method :mint, :to_money
-  end
-
-  refine String do
-    def to_money(currency) = Mint.money(to_r, currency)
-  end
-end