minting 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be78b384415345ebacec84c0fc7194c9cb5e8ae2c3f601db5871822987f7e95c
-  data.tar.gz: 0c852f37bca70dc4af732b824daca634a5b253d4497a10273cc9d041ccf327aa
+  metadata.gz: 9506e71f742812607fef378d4df90eaea6d2457f0d818b55b6e06b6167fa6876
+  data.tar.gz: 99b200de879dfb9ed4eaec21b02067a886c01d48116fcb669ca70b5dbf314264
 SHA512:
-  metadata.gz: 6e13eed34f93beb1a1e26cf89a89fb89a57a06529225610d8cc153c6eae28823368b47a993446e2e4deb3df30cecf31800253a7c55dd070bd6dcb074f615fb91
-  data.tar.gz: 8e2f204fbd592e93f143ed8756548d2013e909bca37d32a2fa70f41c070a3ede1946f668097faf49822a1e5e9df27cc9cf7865208faa94df47c310e06d96cd24
+  metadata.gz: 01b120551584f7f6327f2db19731367dd091bfb3e7b9db91d98cd2ff0b7e1db41d4c190acc66d8cd611fe7689ddb8872b89bebe9db6506e267df121c60fbe6f1
+  data.tar.gz: 8cc6a7ffc780a555276298432de7c2929c5ffddadc4fc28b379a8c58245b70672a777e610e464b6ea485583a8b65eb7463b37e29ff422b9e065ecd1f565cb85a

data/README.md

@@ -105,15 +105,15 @@ ten.allocate([1, 2, 3])                #=> [[USD 1.67], [USD 3.33], [USD 5.00]]
 
 ## API notes
 
-**Module names** — Require the `minting` gem; the public API lives under `Mint` (the gem module is `Minting::VERSION`).
+**Module names** — Require the `minting` gem; the public API lives under `Mint`.
 
-**Exact amounts** — Amounts are stored as `Rational` and rounded to the currency subunit. Prefer rationals or decimal strings for exact literals (`Mint.money(1999/100r, 'USD')`, `'19.99'.to_r`) instead of binary floats when precision matters.
+**Exact amounts** — Amounts are stored as `Rational` and rounded to the currency subunit.
 
 **Refinements** — `10.dollars` and similar helpers require `using Mint` in the current scope (see Usage above).
 
 **Division** — `money / 5` returns new `Money`; `money / other_money` returns a numeric ratio, not money.
 
-**Zero equality** — `Mint.money(0, 'USD') == Mint.money(0, 'EUR')` is intentionally `true`. Non-zero amounts must match currency and value.
+**Zero equality** — Any zero amount is considered equal across currencies and to numeric zero `Mint.money(0, 'USD') == Mint.money(0, 'EUR')` is intentionally `true`. Non-zero amounts must match currency and value.
 
 **Custom currencies** — `Mint.register_currency` returns the existing entry if the code is already registered; use `register_currency!` to detect duplicates.
 
@@ -192,11 +192,6 @@ This gem includes a performance suite under `test/performance`:
 - Memory and GC pressure tests
 - Competitive benchmarks vs `money` gem
 
-On a typical machine, reference numbers are:
-
-- Money creation: ~1.6M ops/sec
-- Addition: ~1.7M ops/sec
-
 Run locally:
 
 ```bash
@@ -210,6 +205,49 @@ BENCH=true rake bench:competitive
 rake bench:regression
 ```
 
+## Benchmark Summary: Minting vs Money Gem
+
+Generated by Qwen from the latest benchmark run on Ruby 4.0.1. - 2026-05-30
+
+### Key Takeaways
+
+- **Mint is consistently faster** than the Money gem across all measured operations.
+- **Mint is 2.28x faster** in the 50,000-transaction simulation.
+- **Mint object creation is 2.76x faster** than `Money.from_amount`.
+- In formatting and conversion, Mint is often **10+x **.
+- Mint’s performance advantage is especially strong for numeric conversion, string formatting, comparisons, and high-volume transaction loops.
+
+### Performance Highlights
+
+| Category | Mint | Money | Approx. Ratio |
+| --- | --- | --- | --- |
+| High-volume transactions | 195,412 ops/sec | 85,882 ops/sec | 2.28x faster |
+| `Mint.money` creation | 1.14M ops/sec | — | 2.76x faster than `Money.from_amount` |
+| `some.dollars` creation | 990k ops/sec | — | 1.15x faster than `Mint.money` |
+| `Money.new` creation | — | 715k ops/sec | Mint 1.59x faster |
+| `to_f` formatting | 8.8M–9.3M ops/sec | 0.7M ops/sec | ~12x faster |
+| `to_d` conversion | 2.1M–2.3M ops/sec | 0.73M–0.79M ops/sec | ~3x faster |
+| `to_s` formatting | 300k–420k ops/sec | 109k–132k ops/sec | ~3x faster |
+| `inspect` formatting | ~2.6–2.9M ops/sec | ~1.1–1.16M ops/sec | ~2.5x faster |
+| `to_json` formatting | ~2.0–2.2M ops/sec | ~110k–126k ops/sec | ~17x faster |
+| Currency lookup `Mint.currency('USD')` | 3.82M ops/sec | — | 1.60x faster than `Money::Currency.new` |
+| Currency lookup `Money::Currency.find('USD')` | 3.63M ops/sec | 1.67M ops/sec | 2.29x faster |
+| Addition | 1.11M ops/sec | 0.37M ops/sec | 3.0x faster |
+| Subtraction | 1.11M ops/sec | 0.36M ops/sec | 3.0x faster |
+| Multiplication | 1.28M ops/sec | 0.51M ops/sec | 2.5x faster |
+| Division | 1.04M ops/sec | 0.37M ops/sec | 2.8x faster |
+| Ratio division | 2.94M ops/sec | 0.39M ops/sec | 7.6x faster |
+| Comparison (`==`, `<`, `>`) | 2.5M–4.1M ops/sec | 0.35M–0.38M ops/sec | 7x–10x faster |
+| Allocation (`Mint.allocate`) | 279k ops/sec | 146k ops/sec | 1.9x faster |
+| Split (`Mint.split`) | 215k ops/sec | 85k ops/sec | 3.3x faster |
+
+### Commands Used
+
+```sh
+BENCH=true bundle exec ruby -Ilib:test -r ./test/test_helper.rb test/performance/competitive_performance_benchmark.rb
+BENCH=true bundle exec ruby -Ilib:test -r ./test/test_helper.rb test/performance/competitive_memory_benchmark.rb
+```
+
 ## License
 
 MIT

data/Rakefile

@@ -1,8 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 require 'rake/testtask'
+require 'yard'
 
-CLOBBER.include %w[tmp]
+CLOBBER.include %w[doc tmp .yardoc]
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -13,16 +14,16 @@ end
 
 Rake::TestTask.new(:bench) do |t|
   t.libs = %w[lib test]
-  t.pattern = 'test/**/*_benchmark.rb'
+  t.pattern = 'test/performance/*_benchmark.rb'
 end
 
-# Performance benchmark tasks
-Rake::TestTask.new('bench:performance') do |t|
+Rake::TestTask.new('bench:edge') do |t|
   t.libs = %w[lib test]
-  t.pattern = 'test/performance/*_benchmark.rb'
+  t.pattern = 'test/performance/algorithm_benchmark.rb'
   t.ruby_opts << '-r test_helper.rb'
 end
 
+
 Rake::TestTask.new('bench:regression') do |t|
   t.libs = %w[lib test]
   t.pattern = 'test/performance/regression_benchmark.rb'
@@ -31,12 +32,16 @@ end
 
 Rake::TestTask.new('bench:competitive') do |t|
   t.libs = %w[lib test]
-  t.pattern = 'test/performance/competitive_benchmark.rb'
+  t.pattern = 'test/performance/competitive_performance_benchmark.rb'
   t.ruby_opts << '-r test_helper.rb'
 end
 
-task 'bench:all' => ['bench', 'bench:performance']
-
 RuboCop::RakeTask.new(:cop)
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb'] # optional
+  t.options = [] # optional
+  t.stats_options = ['--list-undoc'] # optional
+end
+
 task default: :test