minting 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c15130af9a863ae0ed77f63bd1fe5c9bf4c89e2f64bf116be16e5ace6407ede7
-  data.tar.gz: 749015ea7226c1ea4eafaa71d25461a812b29c0ec11541d686894aa55675bfe7
+  metadata.gz: 197525ac986a8283ad9caf5fbc1c828b3c41c2da5a544b398357dccb8d6de430
+  data.tar.gz: ceed85f0f3617e83a1c50f43d4fb0a3f558f335af2f91c78c751278ef3cb0e23
 SHA512:
-  metadata.gz: 797bd7de317d1038b3b5bf154cea1f0386dd7901bc598822820a51b680f600d0fce15219f8533f5da342092378639b6c663fe979b79ce7ac07578c1c13b9e59b
-  data.tar.gz: 0fc814e5e15fc40915baef2cef206c55a773072b67587b9e32373898bdb806194b78d63cf85e804c16939aabed753d7ad2b82e7db2948f749fa017ede7ca1172
+  metadata.gz: 958922e3db6e4ee1a53a4e42feed3a1a6fb41e129ca50b7b2335b713e689d0c5172ba7d65f6b4e37f82cb6934f39a4a03f5a8d9bf55e2e5842f68caf894e9c98
+  data.tar.gz: 593f757a56e95667a80af223a8dde7c55771cbd24529a04625372c78d2266f7a86d0117b45a62bbf005aed6cd5434e33ece7ac898baee4609a73badf4add448e

data/README.md

@@ -6,21 +6,36 @@ Work in progress, please wait release 1.0.0
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Option 1: Via bundler command
+
+```shell
+bundle add minting
+bundle install
+```
+
+Option 2: add the line below to your application's Gemfile:
+
+```ruby
+gem 'minting'
+```
+
+or, if you want latest development version from Github
 
 ```ruby
 gem 'minting', git: 'https://github.com/gferraz/minting.git'
 ```
 
-And then execute:
+and execute:
 
-$ bundle
+```shell
+bundle install
+```
 
-Or install it yourself with:
+Option3: Install it yourself with:
 
-$ git clone https://github.com/gferraz/minting.git
-$ cd minting && gem build minting.gemspec
-$ gem install minting-0.2.0.gem
+```shell
+gem install minting
+````
 
 ## Usage
 
@@ -52,7 +67,7 @@ price.to_s(format: '%<symbol>s%<amount>+f') #=> "$+9.99",
 (-price).to_s(format: '%<amount>f')         #=> "-9.99",
 
 # Format with padding
-price_in_euros = euro.money(12.34, 'EUR')
+price_in_euros = Mint.money(12.34, 'EUR')
 
 price.to_s(format: '--%<amount>7d')               #=> "--      9"
 price.to_s(format: '  %<amount>10f %<currency>s') #=> "        9.99 USD"
@@ -72,21 +87,21 @@ ten_dollars.split(7) #=> [[USD 1.42], [USD 1.43], [USD 1.43], [USD 1.43], [USD 1
 ten_dollars.allocate([1, 2, 3]) #=> [[USD 1.67], [USD 3.33], [USD 5.00]]
 
 # Numeric refinements
-uning Mint
+using Mint
 
 1.dollar == Mint.money(1, 'USD') #=> true
 3.euros == Mint.money(2, 'EUR')  #=> true
 4.mint('USD') == 4.dollars #=> true
 4.to_money('USD') == 4.dollars #=> true
+
 ```
 
 ## Release 1.0 Plan
 
-- Rails
 - Localization: I18n
 - Arithmetics: div, mod
 - Mint.parse
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/gferraz/minting.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/gferraz/minting>.

data/lib/minting/mint/registry.rb

@@ -3,7 +3,11 @@
 # :nodoc
 module Mint
   def self.money(amount, currency_code)
-    Money.new(amount, currency(currency_code))
+    currency = currency(currency_code)
+    return Money.new(amount, currency) if currency
+
+    available = currencies.keys.join(', ')
+    raise ArgumentError, "Currency [#{currency_code}] not registered. Available: #{available}"
   end
 
   def self.currency(currency)
@@ -41,7 +45,7 @@ module Mint
     @currencies ||= {
       'AUD' => Currency.new('AUD', subunit: 2, symbol: '$'),
       'BRL' => Currency.new('BRL', subunit: 2, symbol: 'R$'),
-      'CAD' => Currency.new('CAD', subunit: 2, symbol: 'R$'),
+      'CAD' => Currency.new('CAD', subunit: 2, symbol: '$'),
       'CHF' => Currency.new('CHF', subunit: 2, symbol: 'Fr'),
       'CNY' => Currency.new('CNY', subunit: 2, symbol: '¥'),
       'EUR' => Currency.new('EUR', subunit: 2, symbol: '€'),

data/lib/minting/money/allocation.rb

@@ -16,7 +16,7 @@ module Mint
     def split(quantity)
       unless quantity.positive? && quantity.integer?
         raise ArgumentError,
-              'quantitity must be an integer > 0'
+              'quantity must be an integer > 0'
       end
 
       fraction = self / quantity

data/lib/minting/money/arithmetics.rb

@@ -2,7 +2,7 @@
 
 module Mint
   # :nodoc
-  # Arithmetic funcions for money ojects
+  # Arithmetic functions for money objects
   class Money
     def abs
       mint(amount.abs)

data/lib/minting/money/comparable.rb

@@ -2,7 +2,7 @@
 
 module Mint
   # :nodoc
-  # Comparision methods
+  # Comparison methods
   class Money
     include Comparable
 
@@ -16,12 +16,12 @@ module Mint
     end
 
     # @example
-    #   two_usd == Mint.money(2r, Currency['USD']) #=> [$ 2.00]
-    #   two_usd > 0                                    #=> true
-    #   two_usd > Mint.money(1r, Currency['USD'])  #=> true
+    #   two_usd == Mint.money(2r, 'USD']) #=> [$ 2.00]
+    #   two_usd > 0                       #=> true
+    #   two_usd > Mint.money(2, 'USD'])  #=> true
     #   two_usd > 1
     #   => TypeError: [$ 2.00] can't be compared to 1
-    #   two_usd > Mint.money(2, Currency['BRL'])
+    #   two_usd > Mint.money(2, 'BRL'])
     #   => TypeError: [$ 2.00] can't be compared to [R$ 2.00]
     #
     def <=>(other)

data/lib/minting/money/money.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 module Mint
-  # Money is a value object for monetary values
-  # Money is immutable
   class Money
     DEFAULT_FORMAT = '%<symbol>s%<amount>f'
 
     attr_reader :amount, :currency
 
+    # Creates a new Money immutable object with the specified amount and currency
+    # @param amount [Numeric] The monetary amount
+    # @param currency [Currency] The currency object
+    # @raise [ArgumentError] If amount is not numeric or currency is invalid
     def initialize(amount, currency)
       raise ArgumentError, 'amount must be Numeric' unless amount.is_a?(Numeric)
 
@@ -24,6 +26,10 @@ module Mint
       currency.code
     end
 
+    # Returns a new Money object with the specified amount, or self if unchanged
+    # @param new_amount [Numeric] The new amount
+    # @return [Money] A new Money object or self
+
     def mint(new_amount)
       new_amount.to_r == amount ? self : Money.new(new_amount, currency)
     end

data/lib/minting/version.rb

@@ -1,3 +1,3 @@
 module Minting
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.2'.freeze
 end

data/minting.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   # Prevent pushing this gem to RubyGems.org.
   # To allow pushes either set the 'allowed_push_host' to allow pushing to
   # a single host or delete this section to allow pushing to any host.
-  raise 'RubyGems 3.0 or newer is required' unless s.respond_to?(:metadata)
+  raise 'RubyGems 3.2 or newer is required' unless s.respond_to?(:metadata)
 
   s.metadata = {
     'bug_tracker_uri' => "#{s.homepage}/issues",
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
     'rubygems_mfa_required' => 'true'
   }
 
-  s.required_ruby_version = '>= 3.0.0'
+  s.required_ruby_version = '>= 3.2.0'
 
   s.files = Dir.glob('{bin,doc,lib}/**/*')
   s.files += %w[minting.gemspec Rakefile README.md]

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: minting
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Gilson Ferraz
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Library to manipulate currency values
 email: []
@@ -21,7 +20,6 @@ files:
 - bin/console
 - bin/setup
 - lib/minting.rb
-- lib/minting/currency.rb
 - lib/minting/mint.rb
 - lib/minting/mint/currency.rb
 - lib/minting/mint/refinements.rb
@@ -45,7 +43,6 @@ metadata:
   source_code_uri: https://github.com/gferraz/minting
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,15 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Library to manipulate currency values
 test_files: []

data/lib/minting/currency.rb

@@ -1,2 +0,0 @@
-require 'minting/currency/mint_currency'
-require 'minting/currency/currency'