monetize 1.12.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fec107ece48dc97d0e602c4176dc4bee8e9dd7be4172c0a507df4efa941ddc12
-  data.tar.gz: d15c4dd9bfc270948d69e6ffb9483baa9cde97743111d0fb68b3f6f1db8d6c9d
+  metadata.gz: 77ba1cf94643805ce15012361fda9aaadf3d029483b7c5e557dae4a0cd220c2f
+  data.tar.gz: 8b9d5c77362a24cb9483d2cd02a0f35e5382a289c0eaacc8e44716408ef2a228
 SHA512:
-  metadata.gz: 2bae292db1e6349b333248bab902017130ee85741e0321e8429216c83ca17c79003f36355eaced3e21fa8e9969df5a29f8fe538fe79ecef7f951b882f8cafe10
-  data.tar.gz: f5cc392537c1d8487c3117c680f9e49d0d38ec0db67fcda73594a4a7ce0dfddd8224338eaf5e97da880a86a5e31b4181fb287b9dd8b079f47ec104fd0edbfd49
+  metadata.gz: 528b67577977e7fb1300cac86a086cc16d9a1941bb93270ed913b83c898b35b3c853583113ece518aeee68f099c0d5ee03bf559a68dffbabc4ed52aa3aaefdce
+  data.tar.gz: d64891590b9c964dc7324f57e45262471922be81248914f8c4430649a9ee17a23e019ae99171762d27b07c1888db51d23f0be580cc0977fd0fa069e3aa7a6563

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## Unreleased
+
+## 2.0.0
+- **Breaking change**: Remove deprecated `Monetize.extract_cents`.
+- **Breaking change**: Update Money gem dependency to ~> 7.0. See the [Money 7.0 upgrading guide](https://github.com/RubyMoney/money/blob/main/UPGRADING-7.0.md)
+- **Breaking change**: Drop support for Ruby < 3.1
+- Fix parsing multiple delimeters in the amount, after BigDecimal updates
+- Fix unused variable `possible_major` Ruby warning.
+
+## 1.13.0
+- **Breaking change**: check ISO currency code validity when parsing strings with `to_money`
+- Adds `expect_whole_subunits` option when fractional subunits are expected
+- Add MYR, IDR, SGD, HKD, TWD, and PHP symbol to currency conversion
+
 ## 1.12.0
 - Update `to_money` to match money-rails to_hash.
 

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Shane Emmons
+Copyright (c) 2025 Shane Emmons
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,22 +1,16 @@
 # Monetize
 
 [![Gem Version](https://badge.fury.io/rb/monetize.svg)](http://badge.fury.io/rb/monetize)
-[![Build Status](https://travis-ci.org/RubyMoney/monetize.svg?branch=master)](https://travis-ci.org/RubyMoney/monetize)
-[![Code Climate](https://codeclimate.com/github/RubyMoney/monetize.svg)](https://codeclimate.com/github/RubyMoney/monetize)
-[![Dependency Status](https://gemnasium.com/RubyMoney/monetize.svg)](https://gemnasium.com/RubyMoney/monetize)
+[![Ruby](https://github.com/RubyMoney/monetize/actions/workflows/ruby.yml/badge.svg)](https://github.com/RubyMoney/monetize/actions/workflows/ruby.yml)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 
 A library for converting various objects into `Money` objects.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Run:
 
-    gem 'monetize'
-
-And then execute:
-
-    $ bundle
+    bundle add monetize
 
 Or install it yourself as:
 
@@ -32,16 +26,6 @@ Monetize.parse("GBP 100") == Money.new(100_00, "GBP")
 "100".to_money == Money.new(100_00, "USD")
 ```
 
-`parse` will return `nil` if it is unable to parse the input. Use `parse!` instead if you want a `Monetize::Error` (or one of the subclasses) to be raised instead:
-
-```ruby
->> Monetize.parse('OMG 100')
-=> nil
-
->> Monetize.parse!('OMG 100')
-Monetize::ParseError: Unknown currency 'omg'
-```
-
 Optionally, enable the ability to assume the currency from a passed symbol. Otherwise, currency symbols will be ignored, and USD used as the default currency:
 
 ```ruby
@@ -53,6 +37,22 @@ Monetize.parse("£100") == Money.new(100_00, "GBP")
 "€100".to_money == Money.new(100_00, "EUR")
 ```
 
+Parsing can be improved where the input is not expected to contain fractional subunits.
+To do this, set `Monetize.expect_whole_subunits = true`
+
+```ruby
+Monetize.parse('EUR 10,000') == Money.new(100_00, "EUR")
+
+Monetize.expect_whole_subunits = true
+Monetize.parse('EUR 10,000') == Money.new(10_000_00, "EUR")
+```
+
+Why does this work?  If we expect fractional subunits then the parser will treat a single
+delimiter as a decimal marker if it matches the currency's decimal marker.  But often
+this is not the case - a European site will show $10.000 because that's the local format.
+As a human, if this was a stock ticker we might expect fractional cents.  If it's a retail price we know it's actually an incorrect thousands separator.
+
+
 Monetize can also parse a list of values, returning an array-like object ([Monetize::Collection](lib/collection.rb)):
 
 ```ruby

data/lib/monetize/collection.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'forwardable'
 
 module Monetize

data/lib/monetize/core_extensions/hash.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Hash
   def to_money(currency = nil)
     money_hash = self.respond_to?(:with_indifferent_access) ? self.with_indifferent_access : self

data/lib/monetize/core_extensions/numeric.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Numeric
   def to_money(currency = nil)
     Monetize.from_numeric(self, currency || Money.default_currency)

data/lib/monetize/core_extensions/string.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class String
   def to_money(currency = nil)
     Monetize.parse!(self, currency)

data/lib/monetize/core_extensions/symbol.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Symbol
   def to_currency
     Money::Currency.new(self)

data/lib/monetize/core_extensions.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'monetize/core_extensions/nil_class'
 require 'monetize/core_extensions/numeric'
 require 'monetize/core_extensions/string'

data/lib/monetize/parser.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Monetize
   class Parser
     CURRENCY_SYMBOLS = {
@@ -8,6 +6,8 @@ module Monetize
       '£'  => 'GBP',
       '₤'  => 'GBP',
       'R$' => 'BRL',
+      'RM' => 'MYR',
+      'Rp' => 'IDR',
       'R'  => 'ZAR',
       '¥'  => 'JPY',
       'C$' => 'CAD',
@@ -23,8 +23,13 @@ module Monetize
       'zł' => 'PLN',
       '₸'  => 'KZT',
       "₩"  => 'KRW',
+      'S$' => 'SGD',
+      'HK$'=> 'HKD',
+      'NT$'=> 'TWD',
+      '₱'  => 'PHP',
     }
 
+    CURRENCY_SYMBOL_REGEX = /(?<![A-Z])(#{CURRENCY_SYMBOLS.keys.map { |key| Regexp.escape(key) }.join('|')})(?![A-Z])/i
     MULTIPLIER_SUFFIXES = { 'K' => 3, 'M' => 6, 'B' => 9, 'T' => 12 }
     MULTIPLIER_SUFFIXES.default = 0
     MULTIPLIER_REGEXP = Regexp.new(format('^(.*?\d)(%s)\b([^\d]*)$', MULTIPLIER_SUFFIXES.keys.join('|')), 'i')
@@ -70,16 +75,22 @@ module Monetize
     def parse_currency
       computed_currency = nil
       computed_currency = input[/[A-Z]{2,3}/]
+      computed_currency = nil unless Monetize::Parser::CURRENCY_SYMBOLS.value?(computed_currency)
       computed_currency ||= compute_currency if assume_from_symbol?
 
-
-      computed_currency || fallback_currency || Money.default_currency
+      found = computed_currency || fallback_currency || Money.default_currency
+      raise Money::Currency::UnknownCurrency unless found
+      found
     end
 
     def assume_from_symbol?
       options.fetch(:assume_from_symbol) { Monetize.assume_from_symbol }
     end
 
+    def expect_whole_subunits?
+      options.fetch(:expect_whole_subunits) { Monetize.expect_whole_subunits }
+    end
+
     def apply_multiplier(multiplier_exp, amount)
       amount * 10**multiplier_exp
     end
@@ -89,7 +100,7 @@ module Monetize
     end
 
     def compute_currency
-      match = input.match(currency_symbol_regex)
+      match = input.match(CURRENCY_SYMBOL_REGEX)
       CURRENCY_SYMBOLS[match.to_s] if match
     end
 
@@ -109,13 +120,26 @@ module Monetize
       end
     end
 
+    def minor_has_correct_dp_for_currency_subunit?(minor, currency)
+      minor.length == currency.subunit_to_unit.to_s.length - 1
+    end
+
     def extract_major_minor_with_single_delimiter(num, currency, delimiter)
-      if delimiter == currency.decimal_mark
-        split_major_minor(num, delimiter)
-      elsif Monetize.enforce_currency_delimiters && delimiter == currency.thousands_separator
-        [num.gsub(delimiter, ''), 0]
+      if expect_whole_subunits?
+        _possible_major, possible_minor = split_major_minor(num, delimiter)
+        if minor_has_correct_dp_for_currency_subunit?(possible_minor, currency)
+          split_major_minor(num, delimiter)
+        else
+          extract_major_minor_with_tentative_delimiter(num, delimiter)
+        end
       else
-        extract_major_minor_with_tentative_delimiter(num, delimiter)
+        if delimiter == currency.decimal_mark
+          split_major_minor(num, delimiter)
+        elsif Monetize.enforce_currency_delimiters && delimiter == currency.thousands_separator
+          [num.gsub(delimiter, ''), 0]
+        else
+          extract_major_minor_with_tentative_delimiter(num, delimiter)
+        end
       end
     end
 
@@ -130,7 +154,7 @@ module Monetize
         is_decimal_mark = possible_minor.length != 3 ||
                           possible_major.length > 3 ||
                           possible_major.to_i == 0 ||
-                          delimiter == '.'
+                          (!expect_whole_subunits? && delimiter == '.')
 
         if is_decimal_mark
           [possible_major, possible_minor]
@@ -155,17 +179,11 @@ module Monetize
       result
     end
 
-    def regex_safe_symbols
-      CURRENCY_SYMBOLS.keys.map { |key| Regexp.escape(key) }.join('|')
-    end
-
     def split_major_minor(num, delimiter)
-      major, minor = num.split(delimiter)
-      [major, minor || '00']
-    end
+      splits = num.split(delimiter)
+      fail ParseError, 'Invalid amount (multiple delimiters)' if splits.length > 2
 
-    def currency_symbol_regex
-      /(?<![A-Z])(#{regex_safe_symbols})(?![A-Z])/i
+      [splits[0], splits[1] || '00']
     end
   end
 end

data/lib/monetize/version.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Monetize
-  VERSION = '1.12.0'
+  VERSION = '2.0.0'
 end

data/lib/monetize.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'money'
 require 'monetize/core_extensions'
 require 'monetize/errors'
@@ -20,6 +18,12 @@ module Monetize
     # to true to enforce the delimiters set in the currency all the time.
     attr_accessor :enforce_currency_delimiters
 
+
+    # Where this set to true, the behavior for parsing thousands separators is changed to
+    # expect that eg. €10.000 is EUR 10 000 and not EUR 10.000 - it's incredibly rare when parsing
+    # human text that we're dealing with fractions of cents.
+    attr_accessor :expect_whole_subunits
+
     def parse(input, currency = Money.default_currency, options = {})
       parse! input, currency, options
     rescue Error
@@ -64,12 +68,5 @@ module Monetize
       fail ArgumentError, "'value' should be a type of Numeric" unless value.is_a?(Numeric)
       Money.from_amount(value, currency)
     end
-
-    def extract_cents(input, currency = Money.default_currency)
-      warn '[DEPRECATION] Monetize.extract_cents is deprecated. Use Monetize.parse().cents'
-
-      money = parse(input, currency)
-      money.cents if money
-    end
   end
 end

data/monetize.gemspec

@@ -1,33 +1,31 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'monetize/version'
-require 'English'
+require "monetize/version"
 
-Gem::Specification.new do |spec|
-  spec.name          = 'monetize'
-  spec.version       = Monetize::VERSION
-  spec.authors       = ['Shane Emmons', 'Anthony Dmitriyev']
-  spec.email         = ['shane@emmons.io', 'anthony.dmitriyev@gmail.com']
-  spec.description   = 'A library for converting various objects into `Money` objects.'
-  spec.summary       = 'A library for converting various objects into `Money` objects.'
-  spec.homepage      = 'https://github.com/RubyMoney/monetize'
-  spec.license       = 'MIT'
+Gem::Specification.new do |s|
+  s.name        = "monetize"
+  s.version     = Monetize::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Shane Emmons", "Anthony Dmitriyev"]
+  s.email       = ["shane@emmons.io", "anthony.dmitriyev@gmail.com"]
+  s.homepage    = "https://github.com/RubyMoney/monetize"
+  s.summary     = "A library for converting various objects into `Money` objects."
+  s.description = "A library for converting various objects into `Money` objects."
+  s.license     = "MIT"
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  s.add_dependency "money", "~> 7.0"
 
-  spec.add_dependency 'money', '~> 6.12'
+  s.required_ruby_version = ">= 3.1"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.2'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  s.files         = `git ls-files -z -- lib/* CHANGELOG.md LICENSE monetize.gemspec README.md`.split("\x0")
+  s.require_paths = ["lib"]
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['changelog_uri'] = 'https://github.com/RubyMoney/monetize/blob/master/CHANGELOG.md'
-    spec.metadata['source_code_uri'] = 'https://github.com/RubyMoney/monetize/'
-    spec.metadata['bug_tracker_uri'] = 'https://github.com/RubyMoney/monetize/issues'
+  if s.respond_to?(:metadata)
+    s.metadata["changelog_uri"] = "https://github.com/RubyMoney/monetize/blob/master/CHANGELOG.md"
+    s.metadata["source_code_uri"] = "https://github.com/RubyMoney/monetize/"
+    s.metadata["bug_tracker_uri"] = "https://github.com/RubyMoney/monetize/issues"
+    s.metadata["rubygems_mfa_required"] = "true"
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monetize
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Shane Emmons
 - Anthony Dmitriyev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -17,56 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.12'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.12'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '7.0'
 description: A library for converting various objects into `Money` objects.
 email:
 - shane@emmons.io
@@ -75,15 +32,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/monetize.rb
 - lib/monetize/collection.rb
 - lib/monetize/core_extensions.rb
@@ -96,9 +47,6 @@ files:
 - lib/monetize/parser.rb
 - lib/monetize/version.rb
 - monetize.gemspec
-- spec/core_extensions_spec.rb
-- spec/monetize_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/RubyMoney/monetize
 licenses:
 - MIT
@@ -106,7 +54,7 @@ metadata:
   changelog_uri: https://github.com/RubyMoney/monetize/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/RubyMoney/monetize/
   bug_tracker_uri: https://github.com/RubyMoney/monetize/issues
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -114,18 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 4.0.0
 specification_version: 4
 summary: A library for converting various objects into `Money` objects.
-test_files:
-- spec/core_extensions_spec.rb
-- spec/monetize_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/workflows/ruby.yml

@@ -1,34 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rspec spec

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.ruby-version

data/.rubocop.yml

@@ -1,32 +0,0 @@
-Documentation:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Metrics/ModuleLength:
-  Enabled: false
-Style/AndOr:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/PerlBackrefs:
-  Enabled: false
-
-Style/CollectionMethods:
-  Enabled: yes
-Lint/LiteralInInterpolation:
-  Enabled: yes
-
-Metrics/LineLength:
-  Max: 120
-Metrics/ParameterLists:
-  CountKeywordArgs: false
-Style/DotPosition:
-  EnforcedStyle: trailing
-Style/EmptyElse:
-  EnforcedStyle: empty
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space

data/CONTRIBUTING.md

@@ -1,20 +0,0 @@
-# Contribution Guidelines
-
-## Steps
-
-1. Fork [the repo](https://github.com/RubyMoney/monetize)
-2. Grab dependencies: `bundle install`
-3. Make sure everything is working: `bundle exec rspec spec`
-4. Create your feature branch (`git checkout -b my-new-feature`)
-5. Make your changes
-6. Test your changes
-7. Commit your changes (`git commit -am 'Add some feature'`)
-8. Push to the branch (`git push origin my-new-feature`)
-9. Create a Pull Request
-10. Celebrate!!!!!
-
-## Notes
-
-When contributing, please make sure to update the [CHANGELOG.md](CHANGELOG.md) when you submit
-your pull request. Upon merging of your first pull request, you will be
-given commit access to the repository.

data/Gemfile

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-
-# JSON and I18n gem no longer supports ruby < 2.0.0
-if defined?(JRUBY_VERSION)
-  gem 'json'
-elsif RUBY_VERSION =~ /^1/
-  gem 'json', '~> 1.8.3'
-  gem 'tins', '~> 1.6.0'
-  gem 'term-ansicolor', '~> 1.3.0'
-  gem 'i18n', '~> 0.9'
-end
-
-gemspec

data/Rakefile

@@ -1,18 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-task default: :spec
-
-RSpec::Core::RakeTask.new
-
-task :environment do
-  require_relative 'lib/monetize'
-end
-
-desc 'Start a console with library loaded'
-task console: :environment do
-  require 'irb'
-  require 'irb/completion'
-  ARGV.clear
-  IRB.start
-end