shopify-money 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628a1b8f14e70dcedec1976591b8bbdb210c76378990410e787495fb4e04665f
-  data.tar.gz: d8f6d21d893ab98611560fd3f6c438faa81e0f78a4687849d2a55f49bb3846f2
+  metadata.gz: 9b719c9a9971dd875ee577e791f2caf49c146c9a08cdc5f9b415a8b1359645fc
+  data.tar.gz: f1e2d5250c520dd76491f2adacb6d6a9f99f91ae2fc1529c9fe9d58589d4172b
 SHA512:
-  metadata.gz: 22899e9e95b0040419a10c6275ec6a01e7d32c68e7336c749c82a4ba7af943189146bbfef3ce1b487d462f28600231700262014ba709c10fef61e47d1346115a
-  data.tar.gz: 3d070488e54598ea4a5bc2c6c8d1a9a47b59290993d92ad1ae80f89e1094da2e8609f82c50eac8cfc6dea11184259134b416406085172651599cfacd567fe38b
+  metadata.gz: 907fa206d1f4405be598d50f7d72591ab6f048c1b2b454a281d1789d958ef9ff659aacf2a440f6c7ec29f7e607e793667edb0e7dd29cd411688cb8899d917371
+  data.tar.gz: 809321fe1d30b417bed08a20719d576eb28f478edaa00e919dea0be995bc37897534563574404e689a1da9f8ce374908abb84d6ce426b07f45df039e30674f7c

data/.travis.yml

@@ -7,9 +7,6 @@ branches:
 rvm:
   - 2.7
   - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
 before_install:
   # https://github.com/travis-ci/travis-ci/issues/8978#issuecomment-354036443
   - gem update --system

data/Gemfile

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 gem "pry-byebug", require: false
-gem 'codecov', require: false
+gem 'rubocop', "~> 0.81.0", require: false
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # money
 
-[![Build Status](https://travis-ci.org/Shopify/money.svg?branch=master)](https://travis-ci.org/Shopify/money) [![codecov](https://codecov.io/gh/Shopify/money/branch/master/graph/badge.svg)](https://codecov.io/gh/Shopify/money)
+[![Build Status](https://travis-ci.org/Shopify/money.svg?branch=master)](https://travis-ci.org/Shopify/money)
 
 
 money_column expects a DECIMAL(21,3) database field.
@@ -139,6 +139,25 @@ currency on the model or attribute level.
 There are no validations generated. You can add these for the specified money
 and currency attributes as you normally would for any other.
 
+## Rubocop
+
+A RuboCop rule to enforce the presence of a currency using static analysis is available.
+
+Add to your `.rubocop.yml`
+```yaml
+require:
+  - money
+
+Money/MissingCurrency:
+  Enabled: true
+```
+
+If your application is currently handling only one currency, it can autocorrect this by specifying a currency under the `Enabled` line:
+
+```yaml
+ReplacementCurrency: 'CAD'
+```
+
 ## Contributing to money
 
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/Rakefile

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 begin
   require 'bundler/gem_tasks'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "money"

data/dev.yml

@@ -3,7 +3,7 @@
 ---
 name: money
 up:
-- ruby: 2.5.3
+- ruby: 2.6.6
 - bundler
 commands:
   test: bundle exec rspec

data/lib/money.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'money/money_parser'
 require_relative 'money/helpers'
 require_relative 'money/currency'
@@ -10,3 +11,5 @@ require_relative 'money/accounting_money_parser'
 require_relative 'money/core_extensions'
 require_relative 'money_accessor'
 require_relative 'money_column' if defined?(ActiveRecord)
+
+require_relative 'rubocop/cop/money' if defined?(RuboCop)

data/lib/money/allocator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'delegate'
 
 class Money

data/lib/money/core_extensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Allows Writing of 100.to_money for +Numeric+ types
 #   100.to_money => #<Money @cents=10000>
 #   100.37.to_money => #<Money @cents=10037>

data/lib/money/currency.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "money/currency/loader"
 
 class Money

data/lib/money/currency/loader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 
 class Money

data/lib/money/deprecations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Money.class_eval do
   ACTIVE_SUPPORT_DEFINED = defined?(ActiveSupport)
 

data/lib/money/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Money
   class Error < StandardError
   end

data/lib/money/helpers.rb

@@ -5,7 +5,6 @@ class Money
   module Helpers
     module_function
 
-    NUMERIC_REGEX = /\A\s*[\+\-]?(\d+|\d*\.\d+)\s*\z/
     DECIMAL_ZERO = BigDecimal(0).freeze
     MAX_DECIMAL = 21
 
@@ -25,7 +24,11 @@ class Money
         when Rational
           BigDecimal(num, MAX_DECIMAL)
         when String
-          string_to_decimal(num)
+          decimal = BigDecimal(num, exception: false)
+          return decimal if decimal
+
+          Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
+          DECIMAL_ZERO
         else
           raise ArgumentError, "could not parse as decimal #{num.inspect}"
         end
@@ -54,18 +57,5 @@ class Money
         raise ArgumentError, "could not parse as currency #{currency.inspect}"
       end
     end
-
-    def string_to_decimal(num)
-      if num =~ NUMERIC_REGEX
-        return BigDecimal(num)
-      end
-
-      Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
-      begin
-        BigDecimal(num)
-      rescue ArgumentError
-        DECIMAL_ZERO
-      end
-    end
   end
 end

data/lib/money/money.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 
 class Money
@@ -30,8 +31,8 @@ class Money
     end
     alias_method :empty, :zero
 
-    def parse(*args)
-      parser.parse(*args)
+    def parse(*args, **kwargs)
+      parser.parse(*args, **kwargs)
     end
 
     def from_cents(cents, currency = nil)

data/lib/money/null_currency.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Money
   class NullCurrency
 

data/lib/money/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Money
-  VERSION = "0.14.1"
+  VERSION = "0.14.2"
 end

data/lib/money_accessor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MoneyAccessor
   def self.included(base)
     base.extend(ClassMethods)

data/lib/money_column.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'money_column/active_record_hooks'
 require_relative 'money_column/active_record_type'
 require_relative 'money_column/railtie'

data/lib/money_column/active_record_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MoneyColumn
   module ActiveRecordHooks
     def self.included(base)
@@ -57,7 +58,7 @@ module MoneyColumn
       if options[:currency_read_only]
         currency_source = Money::Helpers.value_to_currency(currency_raw_source)
         if currency_raw_source && !money.currency.compatible?(currency_source)
-          Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency}.")
+          Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency} in column #{column}.")
         end
       else
         self[options[:currency_column]] = money.currency.to_s unless money.no_currency?

data/lib/money_column/active_record_type.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class MoneyColumn::ActiveRecordType < ActiveRecord::Type::Decimal
   def serialize(money)
     return nil unless money

data/lib/money_column/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MoneyColumn
   class Railtie < Rails::Railtie
     ActiveSupport.on_load :active_record do

data/lib/rubocop/cop/money.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/money/missing_currency'

data/lib/rubocop/cop/money/missing_currency.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Money
+      class MissingCurrency < Cop
+        # `Money.new()` without a currency argument cannot guarantee correctness:
+        # - no error raised for cross-currency computation (e.g. 5 CAD + 5 USD)
+        # - #subunits returns wrong values for 0 and 3 decimals currencies
+        #
+        # @example
+        #   # bad
+        #   Money.new(123.45)
+        #   Money.new
+        #   "1,234.50".to_money
+        #
+        #   # good
+        #   Money.new(123.45, 'CAD')
+        #   "1,234.50".to_money('CAD')
+        #
+
+        def_node_matcher :money_new, <<~PATTERN
+          (send (const nil? :Money) {:new :from_amount :from_cents} $...)
+        PATTERN
+
+        def_node_matcher :to_money_without_currency?, <<~PATTERN
+          (send _ :to_money)
+        PATTERN
+
+        def_node_matcher :to_money_block?, <<~PATTERN
+          (send _ _ (block_pass (sym :to_money)))
+        PATTERN
+
+        def on_send(node)
+          money_new(node) do |_amount, currency_arg|
+            return if currency_arg
+
+            add_offense(node, message: 'Money is missing currency argument')
+          end
+
+          if to_money_block?(node) || to_money_without_currency?(node)
+            add_offense(node, message: 'to_money is missing currency argument')
+          end
+        end
+
+        def autocorrect(node)
+          currency = cop_config['ReplacementCurrency']
+          return unless currency
+
+          receiver, method, _ = *node
+
+          lambda do |corrector|
+            money_new(node) do |amount, currency_arg|
+              return if currency_arg
+
+              corrector.replace(
+                node.loc.expression,
+                "#{receiver.source}.#{method}(#{amount&.source || 0}, '#{currency}')"
+              )
+            end
+
+            if to_money_without_currency?(node)
+              corrector.insert_after(node.loc.expression, "('#{currency}')")
+            elsif to_money_block?(node)
+              corrector.replace(
+                node.loc.expression,
+                "#{receiver.source}.#{method} { |x| x.to_money('#{currency}') }"
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify-money.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'money'

data/money.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 require_relative "lib/money/version"
 
 Gem::Specification.new do |s|
@@ -12,13 +13,16 @@ Gem::Specification.new do |s|
   s.licenses = "MIT"
   s.summary = "Shopify's money gem"
 
+  s.metadata['allowed_push_host'] = "https://rubygems.org"
+
   s.add_development_dependency("bundler", ">= 1.5")
   s.add_development_dependency("simplecov", ">= 0")
-  s.add_development_dependency("rails", "~> 5.0")
+  s.add_development_dependency("rails", "~> 6.0")
   s.add_development_dependency("rspec", "~> 3.2")
   s.add_development_dependency("database_cleaner", "~> 1.6")
-  s.add_development_dependency("sqlite3", "~> 1.3.6")
-  s.add_development_dependency("bigdecimal", "~> 1.4.4")
+  s.add_development_dependency("sqlite3", "~> 1.4.2")
+
+  s.required_ruby_version = '>= 2.6'
 
   s.files = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/accounting_money_parser_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe AccountingMoneyParser do

data/spec/allocator_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe "Allocator" do

data/spec/core_extensions_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.shared_examples_for "an object supporting to_money" do

data/spec/currency/loader_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Money::Currency::Loader do

data/spec/currency_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe "Currency" do

data/spec/helpers_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe Money::Helpers do
@@ -49,12 +50,6 @@ RSpec.describe Money::Helpers do
       expect(subject.value_to_decimal('invalid')).to eq(0)
     end
 
-    it 'returns the bigdecimal representation of numbers while they are deprecated' do
-      expect(Money).to receive(:deprecate).exactly(2).times
-      expect(subject.value_to_decimal('0.00123e3')).to eq(amount)
-      expect(subject.value_to_decimal("0.123e1")).to eq(amount)
-    end
-
     it 'raises on invalid object' do
       expect { subject.value_to_decimal(OpenStruct.new(amount: 1)) }.to raise_error(ArgumentError)
     end

data/spec/money_accessor_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 class NormalObject

data/spec/money_column_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 class MoneyRecord < ActiveRecord::Base

data/spec/money_parser_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe MoneyParser do

data/spec/money_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'yaml'
 

data/spec/null_currency_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe "NullCurrency" do

data/spec/rubocop/cop/money/missing_currency_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative '../../../rubocop_helper'
+require 'rubocop/cop/money/missing_currency'
+
+RSpec.describe RuboCop::Cop::Money::MissingCurrency do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  describe '#on_send' do
+    it 'registers an offense for Money.new without a currency argument' do
+      expect_offense(<<~RUBY)
+        Money.new(1)
+        ^^^^^^^^^^^^ Money is missing currency argument
+      RUBY
+    end
+
+    it 'does not register an offense for Money.new with currency argument' do
+      expect_no_offenses(<<~RUBY)
+        Money.new(1, 'CAD')
+      RUBY
+    end
+
+    it 'registers an offense for Money.new without a currency argument' do
+      expect_offense(<<~RUBY)
+        Money.new
+        ^^^^^^^^^ Money is missing currency argument
+      RUBY
+    end
+
+    it 'registers an offense for Money.from_amount without a currency argument' do
+      expect_offense(<<~RUBY)
+        Money.from_amount(1)
+        ^^^^^^^^^^^^^^^^^^^^ Money is missing currency argument
+      RUBY
+    end
+
+    it 'does not register an offense for Money.from_amount with currency argument' do
+      expect_no_offenses(<<~RUBY)
+        Money.from_amount(1, 'CAD')
+      RUBY
+    end
+
+    it 'registers an offense for Money.from_cents without a currency argument' do
+      expect_offense(<<~RUBY)
+        Money.from_cents(1)
+        ^^^^^^^^^^^^^^^^^^^ Money is missing currency argument
+      RUBY
+    end
+
+    it 'does not register an offense for Money.from_cents with currency argument' do
+      expect_no_offenses(<<~RUBY)
+        Money.from_cents(1, 'CAD')
+      RUBY
+    end
+
+    it 'registers an offense for to_money without a currency argument' do
+      expect_offense(<<~RUBY)
+        '1'.to_money
+        ^^^^^^^^^^^^ to_money is missing currency argument
+      RUBY
+    end
+
+    it 'does not register an offense for to_money with currency argument' do
+      expect_no_offenses(<<~RUBY)
+        '1'.to_money('CAD')
+      RUBY
+    end
+
+    it 'registers an offense for to_money block pass form' do
+      expect_offense(<<~RUBY)
+        ['1'].map(&:to_money)
+        ^^^^^^^^^^^^^^^^^^^^^ to_money is missing currency argument
+      RUBY
+    end
+  end
+
+  describe '#autocorrect' do
+    let(:config) do
+      RuboCop::Config.new(
+        'Money/MissingCurrency' => {
+          'ReplacementCurrency' => 'CAD'
+        }
+      )
+    end
+
+    it 'corrects Money.new without currency' do
+      new_source = autocorrect_source('Money.new(1)')
+      expect(new_source).to eq("Money.new(1, 'CAD')")
+    end
+
+    it 'corrects Money.new without amount or currency' do
+      new_source = autocorrect_source('Money.new')
+      expect(new_source).to eq("Money.new(0, 'CAD')")
+    end
+
+    it 'corrects to_money without currency' do
+      new_source = autocorrect_source('1.to_money')
+      expect(new_source).to eq("1.to_money('CAD')")
+    end
+
+    it 'corrects to_money block pass form' do
+      new_source = autocorrect_source("['1'].map(&:to_money)")
+      expect(new_source).to eq("['1'].map { |x| x.to_money('CAD') }")
+    end
+  end
+end

data/spec/rubocop_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+require 'rubocop'
+require 'rubocop/rspec/support'
+
+RSpec.configure do |config|
+  config.include RuboCop::RSpec::ExpectOffense
+end

data/spec/schema.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ActiveRecord::Schema.define do
   create_table "money_records", :force => true do |t|
     t.decimal  "price", precision: 20, scale: 3, default: '0.000'

data/spec/spec_helper.rb

@@ -1,14 +1,10 @@
+# frozen_string_literal: true
 require 'simplecov'
 SimpleCov.minimum_coverage 100
 SimpleCov.start do
   add_filter "/spec/"
 end
 
-if ENV['CI'] == 'true'
-  require 'codecov'
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
-end
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
-- !ruby/object:Gem::Dependency
-  name: bigdecimal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: 1.4.2
 description: Manage money in Shopify with a class that wont lose pennies during division!
 email: gems@shopify.com
 executables:
@@ -147,6 +133,9 @@ files:
 - lib/money_column/active_record_hooks.rb
 - lib/money_column/active_record_type.rb
 - lib/money_column/railtie.rb
+- lib/rubocop/cop/money.rb
+- lib/rubocop/cop/money/missing_currency.rb
+- lib/shopify-money.rb
 - money.gemspec
 - spec/accounting_money_parser_spec.rb
 - spec/allocator_spec.rb
@@ -159,12 +148,15 @@ files:
 - spec/money_parser_spec.rb
 - spec/money_spec.rb
 - spec/null_currency_spec.rb
+- spec/rubocop/cop/money/missing_currency_spec.rb
+- spec/rubocop_helper.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Shopify/money
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -173,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -196,5 +188,7 @@ test_files:
 - spec/money_parser_spec.rb
 - spec/money_spec.rb
 - spec/null_currency_spec.rb
+- spec/rubocop/cop/money/missing_currency_spec.rb
+- spec/rubocop_helper.rb
 - spec/schema.rb
 - spec/spec_helper.rb