minting 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af1a3786bbef7fd2c9d3614ccd5076e0ad6f77fb35bd0d34e636355bafd4714
-  data.tar.gz: 520dfe15e4a3ddcd180a898769266d27502af54e3ad70503ed734ad351564639
+  metadata.gz: 005a740f595e3f1b579b2108feb4cd742706588a75b1df41179775d311fb002e
+  data.tar.gz: b1c2d55e378cca46adde3e6edd7253bb0914707768c19fd00e568288921540ff
 SHA512:
-  metadata.gz: bd835b1ff970861a98dff3f056feb8903e2cb5145f0b60e52372d754daa65d60461e5200cc07de954963c0f31d954f8a8f54faf0a4f16746119e1195dc3c206e
-  data.tar.gz: 5f4e58dea85c7129e00aeef897810053136ba8d30cd49a4f199376b0e4f45885680bf1225b518dd479174e473da6e538efe30831e834e2ce41b3fdaf0a81235c
+  metadata.gz: 48f40d6cceeb16d9ffc357297dae0961ba0473f4d9ed1271ac6e144a0a468b42dd8a553b661485317eba56d88665b08b1302c4620af1a58bb6f07ab9aa996da3
+  data.tar.gz: bc77e69b3e39d3bde0ebb47e60bb1225d0a9062e2a1f201924c3e32924ad65711c28ef492ac4c5d63b06bb376510d07e7d2d69a3efbc17805e89d703c3c15812

data/README.md

@@ -16,6 +16,11 @@ Fast, precise, and developer-friendly money handling for Ruby.
 
 **Rails**? Use the [minting-rails](https://github.com/gferraz/minting-rails) companion gem
 
+## Resources
+
+- [API Documentation](https://www.rubydoc.info/gems/minting/frames)
+- [Git Repository](https://github.com/gferraz/minting)
+
 ## Quick start
 
 ```ruby
@@ -185,6 +190,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
@@ -202,9 +250,9 @@ Mint.parse('USD 1,234.56')     #=> [USD 1234.56]
 
 ## Roadmap
 
-- Improve formatting features
+- Add support to configure thousand and decimal separators in parse (evaluating)
 - Localization (I18n-aware formatting)
-- Basic exchange-rate conversions
+- Basic exchange-rate conversions - infrastructure only, not integrations yet
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,8 @@
+require 'bundler/audit/task'
 require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'rubycritic/rake_task'
 require 'yard'
 
 CLOBBER.include %w[doc/css doc/js doc/Mint doc/*.html tmp .yardoc]
@@ -37,11 +39,19 @@ Rake::TestTask.new('bench:competitive') do |t|
   t.pattern = 'test/performance/competitive/**/*_benchmark.rb'
 end
 
-RuboCop::RakeTask.new(:cop)
+Bundler::Audit::Task.new
+
+RuboCop::RakeTask.new(:cop) do |task|
+  task.patterns = ['lib']
+end
+
+RubyCritic::RakeTask.new do |task|
+  task.name = 'critic'
+end
 
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb']
-  t.options = ['-o doc/api'] # Place the documentos in doc/api
+  #t.options = ['-o doc'] # Place the documentos in doc/api
   t.stats_options = ['--list-undoc']
 end