money_helper 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df602a2214fc58f6ccf9041f9cce6cc87ba22609f6d8314b6a497b5802de48ff
-  data.tar.gz: 46e3888d004f525559bf11b657e7cb504eb9c12f5dcaed61a56b18f1469a1e64
+  metadata.gz: 8fc38d5c4921667c0f06286f5058378d60658b3f991dd7a343f5ab597384560c
+  data.tar.gz: c88db16a193d5674d9f902466aace23c8b7b1a0f71b89733589a05be7059049b
 SHA512:
-  metadata.gz: 1b5f70766be6b1091e40266cb5c3cbcb34d0457e37511e60537935bc4408dada70693d0141e3c95840894f3a3d34658a99cd1354c413b58c97484047448dcecc
-  data.tar.gz: 7eb7051305203fed98bed96d14c2651c989fc498c58859802a85bdd26e7dda11792cef78ad9c0290530b3cd7bd69d4c94c2664cfc0bb4f487584c68e86016e25
+  metadata.gz: 1c258cca4d8ac444695faedd9245d1f805bcb5534bcf6f864dffdcfe330bf8f54f6c10caf800e32c1c2621bc523f6277acde3821a16c6a11edf31b777cdbdc6b
+  data.tar.gz: 8133b959081243c17b6d160ec72a802ed79648989c60ebaca8546a8509cc145b1148f89de4cc1e4ee89cc51459cc0e54fcf58f29a7d5fd412b4f1a93a85744fa

data/.circleci/config.yml

@@ -38,10 +38,8 @@ workflows:
       - test:
           matrix:
             parameters:
-              ruby_version: ["2.5", "2.6", "2.7"]
-              activesupport_version: ["40", "41", "42", "50", "51", "52", "edge"]
+              ruby_version: ["2.6", "2.7", "3.0"]
+              activesupport_version: ["52", "60", "61", "edge"]
             exclude:
-              - ruby_version: "2.5"
-                activesupport_version: "edge"
               - ruby_version: "2.6"
                 activesupport_version: "edge"

data/.rubocop.yml

@@ -1,14 +1,18 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   Exclude:
     - vendor/**/*
     - gemfiles/vendor/**/*
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 512
 
 Metrics:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 512
-
 Style/Documentation:
   Enabled: false
 
@@ -17,5 +21,3 @@ Naming/MethodName:
 
 Style/AsciiComments:
   Enabled: false
-
-inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,12 +1,14 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-04-19 14:01:54 -0400 using RuboCop version 0.67.2.
+# on 2021-09-21 17:26:48 UTC using RuboCop version 1.21.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-Lint/IneffectiveAccessModifier:
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
   Exclude:
-    - 'lib/money_helper.rb'
+    - 'money_helper.gemspec'

data/Appraisals

@@ -1,25 +1,15 @@
-appraise 'activesupport_40' do
-  gem 'activesupport', '~> 4.0.0'
-end
-
-appraise 'activesupport_41' do
-  gem 'activesupport', '~> 4.1.0'
-end
+# frozen_string_literal: true
 
-appraise 'activesupport_42' do
-  gem 'activesupport', '~> 4.2.0'
-end
-
-appraise 'activesupport_50' do
-  gem 'activesupport', '~> 5.0.0'
+appraise 'activesupport_52' do
+  gem 'activesupport', '~> 5.2.6'
 end
 
-appraise 'activesupport_51' do
-  gem 'activesupport', '~> 5.1.0'
+appraise 'activesupport_60' do
+  gem 'activesupport', '~> 6.0.4'
 end
 
-appraise 'activesupport_52' do
-  gem 'activesupport', '~> 5.2.1'
+appraise 'activesupport_61' do
+  gem 'activesupport', '~> 6.1.4'
 end
 
 appraise 'activesupport_edge' do

data/CHANGELOG.md

@@ -1,5 +1,6 @@
-### 2.0.1 (Next)
+### 3.0.0 (Next)
 
+* [#27](https://github.com/artsy/money_helper/pull/27): Update `money_to_text` to pass `format` options to `Money#format` for additional features such as `no_cents` - [@agrberg](https://github.com/agrberg).
 * Your contribution here.
 
 ### 2.0.0 (2021-09-20)

data/Gemfile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
-gem 'rubocop', '0.67.2'
+# pinned so that the lock files stay in sync
+gem 'rubocop', '1.21.0'

data/README.md

@@ -39,8 +39,8 @@ MIT License, see [LICENSE][license] for details.
 
 (c) 2013-2018 [Artsy][artsy], [Sahil Yakhmi][sahil_yakhmi], [Joey Aghion][joey_aghion] and [contributors][contributors].
 
-[ci_badge]: https://circleci.com/gh/artsy/money_helper/tree/master.svg?style=shield
-[circleci]: https://circleci.com/gh/artsy/money_helper/tree/master
+[ci_badge]: https://circleci.com/gh/artsy/money_helper/tree/main.svg?style=svg
+[circleci]: https://circleci.com/gh/artsy/money_helper/tree/main
 [#16]: https://github.com/artsy/money_helper/pull/16
 [license]: LICENSE.md
 [artsy]: https://github.com/artsy

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 require 'bundler/gem_tasks'

data/UPGRADING.md

@@ -0,0 +1,44 @@
+Upgrading MoneyHelper
+=====================
+
+### Upgrading to >= 3.0.0
+
+#### `money_to_text` format options
+
+Prior to 3.0.0 `money_to_text` took a named argument `with_symbol`. The default value was `true` and assing `false` would omit the currency symbol.
+
+This data was later passed to the `Money#format` method with a default `format` string of `'%u%n'`. Users of `MoneyHelper` could not modify the format string or utilize additional format options, such as `no_cents: false`.
+
+In 3.0.0 this was changed so `money_to_text` can take an optional `format` argument which is eventually passed to `Money#format` with only the slight modification of adding in `format: '%u%n'` if this key is not present.
+
+### Upgrading to >= 2.0.0
+
+#### `money_to_text` amount is now given in minor units
+
+Prior to 2.0.0 `money_to_text` took an amount in a currency's major units and converted this value internally before passing to `Money#new` which expects values in their minor unit (i.e. For USD the major unit is Dollars and the minor unit is Cents). This version removes the autoscaling so `money_to_text` can take amounts in their minor units.
+
+Additionally, `currency`, `number_only`, and `options` were removed as postional arguments and replaced with named arguments `currency`, `with_currency`, and `with_symbol` with `'USD'`, `true` and `true` as their default arguments respectively.
+
+One minor difference is that `currency` can be omited completely where as in < 2.0.0 `''` or `nil` was required to be passed for the default of `'USD'` to be used.
+
+Finally the automatic omission of certain currency codes (USD, GBP, EUR, and MYR) is no longer supported. To replicate this behavior you must explicitly specify `with_currency: false`.
+
+The following illustrates the primary difference in usage.
+
+```ruby
+# Before 2.0.0
+
+MoneyHelper.money_to_text(123, 'USD')
+# => $123
+
+# After 2.0.0
+
+MoneyHelper.money_to_text(123) # `currency: 'USD'` is the default
+# => USD $1.23
+
+# to replicate previous behavior almost exactly
+MoneyHelper.money_to_text(12300, with_currency: false)
+# => $123.00
+
+# Note the inclusion of the cents. The ability to remove this was added in 3.0.0 as another breaking change
+```

data/gemfiles/activesupport_52.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'http://rubygems.org'
 
-gem 'activesupport', '~> 5.2.1'
-gem 'rubocop', '0.59.2'
+gem 'activesupport', '~> 5.2.6'
+gem 'rubocop', '1.21.0'
 
 gemspec path: '../'

data/gemfiles/{activesupport_40.gemfile → activesupport_60.gemfile}

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'http://rubygems.org'
 
-gem 'activesupport', '~> 4.0.0'
-gem 'rubocop', '0.59.2'
+gem 'activesupport', '~> 6.0.4'
+gem 'rubocop', '1.21.0'
 
 gemspec path: '../'

data/gemfiles/{activesupport_41.gemfile → activesupport_61.gemfile}

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'http://rubygems.org'
 
-gem 'activesupport', '~> 4.1.0'
-gem 'rubocop', '0.59.2'
+gem 'activesupport', '~> 6.1.4'
+gem 'rubocop', '1.21.0'
 
 gemspec path: '../'

data/gemfiles/activesupport_edge.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'http://rubygems.org'
@@ -6,6 +8,6 @@ git 'git://github.com/rails/rails.git' do
   gem 'activesupport', require: 'active_support'
 end
 
-gem 'rubocop', '0.59.2'
+gem 'rubocop', '1.21.0'
 
 gemspec path: '../'

data/lib/money_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'version'
 
 require 'active_support/core_ext/object/blank'
@@ -27,16 +29,15 @@ module MoneyHelper
   #   amount_minor: (Integer) amount in minor unit
   #   currency: (String) optional ISO currency code, defaulting to USD
   #   with_currency: (Boolean) optional flag to include ISO currency code, defaulting to true
-  #   with_symbol: (Boolean) optional flag to include currency symbol, defaulting to true
-  def self.money_to_text(amount_minor, currency: 'USD', with_currency: true, with_symbol: true)
+  # 　format: (Hash) optional formatting options to pass to `Money#format` e.g.:
+  #     no_cents: (Boolean) optional flag to exclude cents, defaulting to false
+  #     symbol: (Boolean) optional flag to include currency symbol, defaulting to true
+  def self.money_to_text(amount_minor, currency: 'USD', with_currency: true, format: {})
     return '' if amount_minor.blank?
 
-    money_options = {
-      format: '%u%n',
-      symbol: with_symbol
-    }
+    format_options = { format: '%u%n' }.merge(format)
 
-    formatted_amount = Money.new(amount_minor, currency).format(money_options)
+    formatted_amount = Money.new(amount_minor, currency).format(format_options)
     formatted_currency = with_currency ? currency.upcase : ''
 
     "#{formatted_currency} #{formatted_amount}".strip
@@ -73,14 +74,14 @@ module MoneyHelper
     if low.blank? && high.blank?
       ''
     elsif low.blank?
-      'Under ' + money_to_text(high, currency: currency)
+      "Under #{money_to_text(high, currency: currency)}"
     elsif high.blank?
-      money_to_text(low, currency: currency) + ' and up'
+      "#{money_to_text(low, currency: currency)} and up"
     elsif low == high
       money_to_text(low, currency: currency)
     else
       formatted_low = money_to_text(low, currency: currency)
-      formatted_high = money_to_text(high, currency: currency, with_currency: false, with_symbol: false)
+      formatted_high = money_to_text(high, currency: currency, with_currency: false, format: { symbol: false })
       [formatted_low, formatted_high].compact.join(delimiter)
     end
   end

data/lib/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MoneyHelper
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.0.0'
 end

data/money_helper.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'version'
 

data/spec/money_helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MoneyHelper do
@@ -137,18 +139,23 @@ describe MoneyHelper do
       expect(MoneyHelper.money_to_text(30_175_93, currency: 'AFN', with_currency: false)).to eql('؋30,175.93')
     end
 
-    it 'omits symbol when with_symbol is false' do
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'EUR', with_symbol: false)).to eql('EUR 30.175,93')
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AUD', with_symbol: false)).to eql('AUD 30,175.93')
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AMD', with_symbol: false)).to eql('AMD 30,175.93')
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AFN', with_symbol: false)).to eql('AFN 30,175.93')
+    it 'omits symbol when `format: symbol:` is false' do
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'EUR', format: { symbol: false })).to eql('EUR 30.175,93')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AUD', format: { symbol: false })).to eql('AUD 30,175.93')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AMD', format: { symbol: false })).to eql('AMD 30,175.93')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AFN', format: { symbol: false })).to eql('AFN 30,175.93')
+    end
+
+    it 'omits ISO code and symbol when both `with_currency` and `format: symbol:` are false' do
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'EUR', with_currency: false, format: { symbol: false })).to eql('30.175,93')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AUD', with_currency: false, format: { symbol: false })).to eql('30,175.93')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AMD', with_currency: false, format: { symbol: false })).to eql('30,175.93')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AFN', with_currency: false, format: { symbol: false })).to eql('30,175.93')
     end
 
-    it 'omits ISO code and symbol when both with_currency and with_symbol are false' do
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'EUR', with_currency: false, with_symbol: false)).to eql('30.175,93')
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AUD', with_currency: false, with_symbol: false)).to eql('30,175.93')
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AMD', with_currency: false, with_symbol: false)).to eql('30,175.93')
-      expect(MoneyHelper.money_to_text(30_175_93, currency: 'AFN', with_currency: false, with_symbol: false)).to eql('30,175.93')
+    it 'omits cents when `format: no_cents:` is true' do
+      expect(MoneyHelper.money_to_text(30_175_93, with_currency: false, format: { no_cents: true, symbol: false })).to eql('30,175')
+      expect(MoneyHelper.money_to_text(30_175_93, currency: 'EUR', with_currency: false, format: { no_cents: true, symbol: false })).to eql('30.175')
     end
 
     it 'returns an empty string if amount passed in is whitespace, empty string, or nil' do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 
 require 'rubygems'

data/spec/version_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MoneyHelper do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money_helper
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sahil Yakhmi
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -87,12 +87,10 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
-- gemfiles/activesupport_40.gemfile
-- gemfiles/activesupport_41.gemfile
-- gemfiles/activesupport_42.gemfile
-- gemfiles/activesupport_50.gemfile
-- gemfiles/activesupport_51.gemfile
+- UPGRADING.md
 - gemfiles/activesupport_52.gemfile
+- gemfiles/activesupport_60.gemfile
+- gemfiles/activesupport_61.gemfile
 - gemfiles/activesupport_edge.gemfile
 - lib/money_helper.rb
 - lib/version.rb
@@ -119,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
 summary: MoneyHelper international price formatting utility.

data/gemfiles/activesupport_42.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source 'http://rubygems.org'
-
-gem 'activesupport', '~> 4.2.0'
-gem 'rubocop', '0.59.2'
-
-gemspec path: '../'

data/gemfiles/activesupport_50.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source 'http://rubygems.org'
-
-gem 'activesupport', '~> 5.0.0'
-gem 'rubocop', '0.59.2'
-
-gemspec path: '../'

data/gemfiles/activesupport_51.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source 'http://rubygems.org'
-
-gem 'activesupport', '~> 5.1.0'
-gem 'rubocop', '0.59.2'
-
-gemspec path: '../'