shopify-money 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9f1cbeeb932d4f9f9d1abb4ef49ae366e9f5467
-  data.tar.gz: a257d7dd55acb578b89690f153a8a613bc334089
+  metadata.gz: 964eb834ae37a4f224f6ce79f5dcd75ae544d8a6
+  data.tar.gz: 400e4c5737f8960c44ebb8d89b78f8fcc7506db2
 SHA512:
-  metadata.gz: ed81f64a2a63282fa961088381634c8d2d414ea30120f2e39049afb6cb6e5f85a36069d550f6ba956636481b9ccbde8eae8428347e5b105ecfd16b22146b2b5e
-  data.tar.gz: 7edd2b3d5dd0ec6d0f695a0959fd55f25e4c1bfefdd7c96171825b77085a353892d954d6edb00a49a7a224b57e019982f981554b3c8896b1ab02c443e4682115
+  metadata.gz: 11c8e67a85e4709618df2f7443bd6102929e12883339fa8ad55ea7c9a2b2c3b951fe980250ef421b0b7d8066770eac6bad9fe6ea74493095722b00d610ae2b28
+  data.tar.gz: 2b4abc9631217467ac967254cd41e5921635acacc351fd69d949fb51e342a6fe8bcf437a0c75d01b078dc5182bd598c157e5c7a1b3089df128832f648e93d4a6

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+cache: bundler
+branches:
+  only:
+  - master
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+before_install:
+  # https://github.com/travis-ci/travis-ci/issues/8978#issuecomment-354036443
+  - gem update --system
+  - gem install bundler

data/README.md

@@ -1,6 +1,6 @@
 # money
 
-[![Build Status](https://circleci.com/gh/Shopify/money.png?circle-token=88060f61185838446bb65723d96658bdd74ebb3c)](https://circleci.com/gh/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) [![codecov](https://codecov.io/gh/Shopify/money/branch/master/graph/badge.svg)](https://codecov.io/gh/Shopify/money)
 
 
 money_column expects a decimal 8,3 database field.

data/lib/money/helpers.rb

@@ -6,7 +6,7 @@ class Money
     module_function
 
     NUMERIC_REGEX = /\A\s*[\+\-]?\d*(\.\d+)?\s*\z/
-    DECIMAL_ZERO = BigDecimal.new(0).freeze
+    DECIMAL_ZERO = BigDecimal(0).freeze
     MAX_DECIMAL = 21
 
     def value_to_decimal(num)
@@ -19,11 +19,11 @@ class Money
         when nil, 0, ''
           DECIMAL_ZERO
         when Integer
-          BigDecimal.new(num)
+          BigDecimal(num)
         when Float
-          BigDecimal.new(num, Float::DIG)
+          BigDecimal(num, Float::DIG)
         when Rational
-          BigDecimal.new(num, MAX_DECIMAL)
+          BigDecimal(num, MAX_DECIMAL)
         when String
           string_to_decimal(num)
         else
@@ -57,12 +57,12 @@ class Money
 
     def string_to_decimal(num)
       if num =~ NUMERIC_REGEX
-        return BigDecimal.new(num)
+        return BigDecimal(num)
       end
 
       Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
       begin
-        BigDecimal.new(num)
+        BigDecimal(num)
       rescue ArgumentError
         DECIMAL_ZERO
       end

data/lib/money/version.rb

@@ -1,3 +1,3 @@
 class Money
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/money_column/active_record_hooks.rb

@@ -5,7 +5,7 @@ module MoneyColumn
     end
 
     def reload(*)
-      clear_money_column_cache
+      clear_money_column_cache if persisted?
       super
     end
 
@@ -17,7 +17,7 @@ module MoneyColumn
     private
 
     def clear_money_column_cache
-      @money_column_cache.clear if persisted?
+      @money_column_cache.clear
     end
 
     def init_internals
@@ -25,69 +25,101 @@ module MoneyColumn
       super
     end
 
+    def read_money_attribute(column)
+      column = column.to_s
+      options = self.class.money_column_options[column]
+
+      return @money_column_cache[column] if @money_column_cache[column]
+
+      value = self[column]
+
+      return if value.nil? && !options[:coerce_null]
+
+      @money_column_cache[column] = Money.new(value, options[:currency] || send(options[:currency_column]))
+    end
+
+    def write_money_attribute(column, money)
+      column = column.to_s
+      options = self.class.money_column_options[column]
+
+      @money_column_cache[column] = nil
+
+      if money.blank?
+        return self[column] = nil
+      end
+
+      currency_raw_source = options[:currency] || (send(options[:currency_column]) rescue nil)
+      currency_source = Money::Helpers.value_to_currency(currency_raw_source)
+
+      if !money.is_a?(Money)
+        return self[column] = Money.new(money, currency_source).value
+      end
+
+      if currency_raw_source && !currency_source.compatible?(money.currency)
+        Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency}.")
+      end
+
+      self[column] = money.value
+      self[options[:currency_column]] = money.currency.to_s unless options[:currency_read_only] || money.no_currency?
+    end
+
     module ClassMethods
+      attr_reader :money_column_options
+
       def money_column(*columns, currency_column: nil, currency: nil, currency_read_only: false, coerce_null: false)
-        raise ArgumentError, 'cannot set both currency_column and a fixed currency' if currency && currency_column
-
-        if currency
-          currency_iso = Money::Currency.find!(currency).to_s
-          currency_read_only = true
-        elsif currency_column
-          clear_cache_on_currency_change(currency_column)
-        else
-          raise ArgumentError, 'must set one of :currency_column or :currency options'
+        @money_column_options ||= {}
+
+        options = normalize_money_column_options(
+          currency_column: currency_column,
+          currency: currency,
+          currency_read_only: currency_read_only,
+          coerce_null: coerce_null
+        )
+
+        if options[:currency_column]
+          clear_cache_on_currency_change(options[:currency_column])
         end
-        currency_column = currency_column.to_s.freeze
 
         columns.flatten.each do |column|
           column_string = column.to_s.freeze
+
+          @money_column_options[column_string] = options
+
           attribute(column_string, MoneyColumn::ActiveRecordType.new)
-          money_column_reader(column_string, currency_column, currency_iso, coerce_null)
-          money_column_writer(column_string, currency_column, currency_iso, currency_read_only)
+
+          define_method column do
+            read_money_attribute(column_string)
+          end
+
+          define_method "#{column}=" do |money|
+            write_money_attribute(column_string, money)
+          end
         end
       end
 
       private
 
-      def clear_cache_on_currency_change(currency_column)
-        define_method "#{currency_column}=" do |value|
-          @money_column_cache.clear
-          super(value)
+      def normalize_money_column_options(options)
+        raise ArgumentError, 'cannot set both :currency_column and :currency options' if options[:currency] && options[:currency_column]
+        raise ArgumentError, 'must set one of :currency_column or :currency options' unless options[:currency] || options[:currency_column]
+
+        if options[:currency]
+          options[:currency] = Money::Currency.find!(options[:currency]).to_s.freeze
+          options[:currency_read_only] = true
         end
-      end
 
-      def money_column_reader(column, currency_column, currency_iso, coerce_null)
-        define_method column do
-          return @money_column_cache[column] if @money_column_cache[column]
-          value = read_attribute(column)
-          return if value.nil? && !coerce_null
-          iso = currency_iso || send(currency_column)
-          @money_column_cache[column] = Money.new(value, iso)
+        if options[:currency_column]
+          options[:currency_column] = options[:currency_column].to_s.freeze
         end
+        options
       end
 
-      def money_column_writer(column, currency_column, currency_iso, currency_read_only)
-        define_method "#{column}=" do |money|
-          @money_column_cache[column] = nil
-
-          if money.blank?
-            write_attribute(column, nil)
-            return nil
-          end
-
-          currency_raw_source = currency_iso || (send(currency_column) rescue nil)
-          currency_source = Money::Helpers.value_to_currency(currency_raw_source)
-
-          if !money.is_a?(Money)
-            return write_attribute(column, Money.new(money, currency_source).value)
-          end
-
-          if currency_raw_source && !currency_source.compatible?(money.currency)
-            Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency}.")
-          end
+      def clear_cache_on_currency_change(currency_column)
+        return if money_column_options.any? { |_, opt| opt[:currency_column] == currency_column }
 
-          write_attribute(column, money.value)
-          write_attribute(currency_column, money.currency.to_s) unless currency_read_only || money.no_currency?
+        define_method "#{currency_column}=" do |value|
+          clear_money_column_cache
+          super(value)
         end
       end
     end

data/spec/core_extensions_spec.rb

@@ -36,7 +36,7 @@ end
 
 RSpec.describe BigDecimal do
   before(:each) do
-    @value = BigDecimal.new("1.23")
+    @value = BigDecimal("1.23")
     @money = Money.new("1.23")
   end
 

data/spec/helpers_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe Money::Helpers do
 
   describe 'value_to_decimal' do
-    let (:amount) { BigDecimal.new('1.23') }
+    let (:amount) { BigDecimal('1.23') }
     let (:money) { Money.new(amount) }
 
     it 'returns the value of a money object' do
@@ -11,7 +11,7 @@ RSpec.describe Money::Helpers do
     end
 
     it 'returns itself if it is already a big decimal' do
-      expect(subject.value_to_decimal(BigDecimal.new('1.23'))).to eq(amount)
+      expect(subject.value_to_decimal(BigDecimal('1.23'))).to eq(amount)
     end
 
     it 'returns zero when nil' do
@@ -23,7 +23,7 @@ RSpec.describe Money::Helpers do
     end
 
     it 'returns the bigdecimal version of a integer' do
-      expect(subject.value_to_decimal(1)).to eq(BigDecimal.new('1'))
+      expect(subject.value_to_decimal(1)).to eq(BigDecimal('1'))
     end
 
     it 'returns the bigdecimal version of a float' do
@@ -60,7 +60,7 @@ RSpec.describe Money::Helpers do
     end
 
     it 'returns regular zero for a negative zero value' do
-      expect(subject.value_to_decimal(-BigDecimal.new(0))).to eq(BigDecimal.new(0))
+      expect(subject.value_to_decimal(-BigDecimal(0))).to eq(BigDecimal(0))
     end
   end
 

data/spec/money_column_spec.rb

@@ -38,6 +38,17 @@ class MoneyWithDelegatedCurrency < ActiveRecord::Base
   end
 end
 
+class MoneyWithCustomAccessors < ActiveRecord::Base
+  self.table_name = 'money_records'
+  money_column :price, currency_column: 'currency'
+  def price
+    read_money_attribute(:price)
+  end
+  def price=(value)
+    write_money_attribute(:price, value + 1)
+  end
+end
+
 RSpec.describe 'MoneyColumn' do
   let(:amount) { 1.23 }
   let(:currency) { 'EUR' }
@@ -167,7 +178,7 @@ RSpec.describe 'MoneyColumn' do
     end
 
     it 'raises an ArgumentError' do
-      expect { subject }.to raise_error(ArgumentError, 'cannot set both currency_column and a fixed currency')
+      expect { subject }.to raise_error(ArgumentError, 'cannot set both :currency_column and :currency options')
     end
   end
 
@@ -295,4 +306,19 @@ RSpec.describe 'MoneyColumn' do
       expect(MoneyRecord.find_by(price: nil)).to eq(record)
     end
   end
+
+  describe 'money column attribute accessors' do
+    it 'allows to overwrite the setter' do
+      amount = Money.new(1, 'USD')
+      expect(MoneyWithCustomAccessors.new(price: amount).price).to eq(MoneyRecord.new(price: amount).price + 1)
+    end
+
+    it 'correctly assigns the money_column_cache' do
+      amount = Money.new(1, 'USD')
+      object = MoneyWithCustomAccessors.new(price: amount)
+      expect(object.instance_variable_get(:@money_column_cache)['price']).to eql(nil)
+      expect(object.price).to eql(amount + 1)
+      expect(object.instance_variable_get(:@money_column_cache)['price']).to eql(amount + 1)
+    end
+  end
 end

data/spec/money_parser_spec.rb

@@ -315,7 +315,7 @@ RSpec.describe MoneyParser do
     end
   end
 
-  describe "parsing of fixnum" do
+  describe "parsing of integer" do
     it "parses 1" do
       expect(@parser.parse(1)).to eq(Money.new(1))
     end

data/spec/money_spec.rb

@@ -71,15 +71,15 @@ RSpec.describe "Money" do
   end
 
   it "is constructable with a BigDecimal" do
-    expect(Money.new(BigDecimal.new("1.23"))).to eq(Money.new(1.23))
+    expect(Money.new(BigDecimal("1.23"))).to eq(Money.new(1.23))
   end
 
-  it "is constructable with a Fixnum" do
+  it "is constructable with an Integer" do
     expect(Money.new(3)).to eq(Money.new(3.00))
   end
 
   it "is construcatable with a Float" do
-    expect(Money.new(3.00)).to eq(Money.new(BigDecimal.new('3.00')))
+    expect(Money.new(3.00)).to eq(Money.new(BigDecimal('3.00')))
   end
 
   it "is construcatable with a String" do
@@ -282,7 +282,7 @@ RSpec.describe "Money" do
   end
 
   it "supports to_d" do
-    expect(Money.new(1.29).to_d).to eq(BigDecimal.new('1.29'))
+    expect(Money.new(1.29).to_d).to eq(BigDecimal('1.29'))
   end
 
   it "supports to_f" do
@@ -434,7 +434,7 @@ RSpec.describe "Money" do
     end
 
     it "returns cents as a decimal value = 1.00" do
-      expect(money.value).to eq(BigDecimal.new("1.00"))
+      expect(money.value).to eq(BigDecimal("1.00"))
     end
 
     it "returns cents as 100 cents" do
@@ -445,10 +445,6 @@ RSpec.describe "Money" do
       expect(money.subunits).to eq(100)
     end
 
-    it "returns cents as a Fixnum" do
-      expect(money.subunits).to be_an_instance_of(Fixnum)
-    end
-
     it "is greater than $0" do
       expect(money).to be > Money.new(0.00)
     end
@@ -625,7 +621,7 @@ RSpec.describe "Money" do
     let (:money) { Money.new(1.125) }
 
     it "rounds 3rd decimal place" do
-      expect(money.value).to eq(BigDecimal.new("1.13"))
+      expect(money.value).to eq(BigDecimal("1.13"))
     end
   end
 
@@ -673,7 +669,7 @@ RSpec.describe "Money" do
     it "accepts numeric values" do
       expect(Money.from_amount(1)).to eq Money.from_cents(1_00)
       expect(Money.from_amount(1.0)).to eq Money.from_cents(1_00)
-      expect(Money.from_amount(BigDecimal.new("1"))).to eq Money.from_cents(1_00)
+      expect(Money.from_amount(BigDecimal("1"))).to eq Money.from_cents(1_00)
     end
 
     it "accepts string values" do
@@ -688,7 +684,7 @@ RSpec.describe "Money" do
       expect { Money.from_amount(1, "CAD") }.to_not raise_error
     end
 
-    it "accepts Rationla number" do
+    it "accepts Rational number" do
       expect(Money.from_amount(Rational("999999999999999999.999")).value).to eql(BigDecimal.new("1000000000000000000", Money::Helpers::MAX_DECIMAL))
       expect(Money.from_amount(Rational("999999999999999999.99")).value).to eql(BigDecimal.new("999999999999999999.99", Money::Helpers::MAX_DECIMAL))
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,12 +118,12 @@ files:
 - ".document"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
-- circle.yml
 - config/currency_historic.json
 - config/currency_iso.json
 - config/currency_non_iso.json

data/circle.yml

@@ -1,13 +0,0 @@
-machine:
-  ruby:
-    version: 2.3.3
-
-database:
-  override:
-    - echo "Skipping database setup"
-
-test:
-  override:
-    - bundle exec rake
-  post:
-    - bash <(curl -s https://codecov.io/bash)