shopify-money 1.0.0.pre → 1.0.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddeb1f02ca7fda02ed007433687bf2fdbce36e9b11d64724753cf2e2420507c0
-  data.tar.gz: de0de61cbe5c6ae02b2fbf333e4136edbfcd1c2388441c219ffb1a00e2d0a963
+  metadata.gz: ae5e66176d7c6e79d5c6346a3ca6915489d3750d7bb67aa68973c52a0198cb3f
+  data.tar.gz: 7219d1edd8665498e64eb06e6212028d8ec559dd5ce9206cbe698e5b1e42d2ed
 SHA512:
-  metadata.gz: 86ef224eb66a9d8d6249b921cdd9162594babac0e5fa7525f2e9e5125ad94ab02e395bef9af508d4f6d08622d2c3fa6628b902aac3de803ef81fd30fcae0464c
-  data.tar.gz: 7332ed67b6d7389123131538c7c05faae5b9e67a4b77ae66c21f0d2bbd7031f4994576fdaa14c54294ad2969c70ffe1e70958528f16116e944fa6457d5c80d6e
+  metadata.gz: 4188d1251f442d347b287b3b3ac69c08f716b149ef9cc8a78f2c8e75fb563524f3818a9b8116cf2d433117a9e66cbb96b428aed9bf8cd9f9e79eaefa94ca5c45
+  data.tar.gz: 9e70a02a0acdf5eca299ad5f4b201b3fb44a98977d972d08db4167938f24793b732a55f25d6ea3585c8c63d92b014bc108083cce1aef1659b65c628f3ab0b27f

data/README.md

@@ -18,7 +18,7 @@ money_column expects a DECIMAL(21,3) database field.
 
 ## Installation
 
-    gem 'shopify-money', require: 'money'
+    gem 'shopify-money'
 
 ## Upgrading to v1.0
 

data/config/currency_historic.yml

@@ -73,6 +73,20 @@ mtl:
   thousands_separator: ","
   iso_numeric: '470'
   smallest_denomination: 1
+std:
+  priority: 100
+  iso_code: STD
+  name: São Tomé and Príncipe Dobra
+  symbol: Db
+  alternate_symbols: []
+  subunit: Cêntimo
+  subunit_to_unit: 100
+  symbol_first: false
+  html_entity: ''
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: '678'
+  smallest_denomination: 10000
 tmm:
   priority: 100
   iso_code: TMM

data/config/currency_iso.yml

@@ -2029,9 +2029,9 @@ ssp:
   thousands_separator: ","
   iso_numeric: '728'
   smallest_denomination: 5
-std:
+stn:
   priority: 100
-  iso_code: STD
+  iso_code: STN
   name: São Tomé and Príncipe Dobra
   symbol: Db
   alternate_symbols: []
@@ -2041,8 +2041,8 @@ std:
   html_entity: ''
   decimal_mark: "."
   thousands_separator: ","
-  iso_numeric: '678'
-  smallest_denomination: 10000
+  iso_numeric: '930'
+  smallest_denomination: 1
 svc:
   priority: 100
   iso_code: SVC
@@ -2304,6 +2304,24 @@ uzs:
   thousands_separator: ","
   iso_numeric: '860'
   smallest_denomination: 100
+ved:
+  priority: 100
+  iso_code: VED
+  name: Venezuelan Bolívar soberano
+  symbol: Bs.D.
+  alternate_symbols: []
+  subunit: Céntimo
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: ''
+  decimal_mark: ","
+  thousands_separator: "."
+  iso_numeric: '926'
+  # "On 1 Oct 2021, [...] another (redenomination) happened, but called 'Nueva expresión monetaria', 
+  # or new monetary expression, which removed 6 zeroes from the currency without affecting its denomination."
+  # The VED has banknotes in denominations of 5, 10, 20, 50, and 100, and coins in 50 céntimos and 1 Bs.D.
+  # Source: https://en.wikipedia.org/wiki/Venezuelan_bol%C3%ADvar
+  smallest_denomination: 1
 ves:
   priority: 100
   iso_code: VES

data/lib/money/money.rb

@@ -128,12 +128,14 @@ class Money
 
   def +(other)
     arithmetic(other) do |money|
+      return self if money.value == 0 && !no_currency?
       Money.new(value + money.value, calculated_currency(money.currency))
     end
   end
 
   def -(other)
     arithmetic(other) do |money|
+      return self if money.value == 0 && !no_currency?
       Money.new(value - money.value, calculated_currency(money.currency))
     end
   end
@@ -146,6 +148,7 @@ class Money
         raise ArgumentError, "Money objects can only be multiplied by a Numeric"
       end
     end
+    return self if numeric == 1
     Money.new(value.to_r * numeric, currency)
   end
 
@@ -219,14 +222,14 @@ class Money
     value
   end
 
-  def to_s(style = nil)
+  def to_fs(style = nil)
     units = case style
     when :legacy_dollars
       2
     when :amount, nil
       currency.minor_units
     else
-      raise ArgumentError, "Unexpected style: #{style}"
+      raise ArgumentError, "Unexpected format: #{style}"
     end
 
     rounded_value = value.round(units)
@@ -238,17 +241,19 @@ class Money
       sprintf("%s%d.%0#{units}d", sign, rounded_value.truncate, rounded_value.frac * (10 ** units))
     end
   end
+  alias_method :to_s, :to_fs
+  alias_method :to_formatted_s, :to_fs
 
-  def to_json(options = {})
-    if options.delete(:legacy_format) || Money.config.legacy_json_format
+  def to_json(options = nil)
+    if (options.is_a?(Hash) && options.delete(:legacy_format)) || Money.config.legacy_json_format
       to_s
     else
       as_json(options).to_json
     end
   end
 
-  def as_json(options = {})
-    if options.delete(:legacy_format) || Money.config.legacy_json_format
+  def as_json(options = nil)
+    if (options.is_a?(Hash) && options.delete(:legacy_format)) || Money.config.legacy_json_format
       to_s
     else
       { value: to_s(:amount), currency: currency.to_s }
@@ -256,15 +261,21 @@ class Money
   end
 
   def abs
-    Money.new(value.abs, currency)
+    abs = value.abs
+    return self if value == abs
+    Money.new(abs, currency)
   end
 
   def floor
-    Money.new(value.floor, currency)
+    floor = value.floor
+    return self if floor == value
+    Money.new(floor, currency)
   end
 
   def round(ndigits=0)
-    Money.new(value.round(ndigits), currency)
+    round = value.round(ndigits)
+    return self if round == value
+    Money.new(round, currency)
   end
 
   def fraction(rate)

data/lib/money/rails/job_argument_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Money
+  module Rails
+    class JobArgumentSerializer < ::ActiveJob::Serializers::ObjectSerializer
+      def serialize(money)
+        super("value" => money.value, "currency" => money.currency.iso_code)
+      end
+
+      def deserialize(hash)
+        Money.new(hash["value"], hash["currency"])
+      end
+
+      private
+
+      def klass
+        Money
+      end
+    end
+  end
+end
+

data/lib/money/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Money
+  class Railtie < Rails::Railtie
+    initializer "shopify-money.setup_active_job_serializer" do
+      ActiveSupport.on_load :active_job do
+        require_relative "rails/job_argument_serializer"
+        ActiveJob::Serializers.add_serializers ::Money::Rails::JobArgumentSerializer
+      end
+    end
+  end
+end

data/lib/money/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Money
-  VERSION = "1.0.0.pre"
+  VERSION = "1.0.1.pre"
 end

data/lib/money.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require_relative 'money/version'
 require_relative 'money/money_parser'
 require_relative 'money/helpers'
 require_relative 'money/currency'
@@ -11,5 +12,6 @@ require_relative 'money/deprecations'
 require_relative 'money/accounting_money_parser'
 require_relative 'money/core_extensions'
 require_relative 'money_column' if defined?(ActiveRecord)
+require_relative 'money/railtie' if defined?(Rails::Railtie)
 
 require_relative 'rubocop/cop/money' if defined?(RuboCop)

data/spec/money_spec.rb

@@ -8,6 +8,10 @@ RSpec.describe "Money" do
   let (:non_fractional_money) { Money.new(1, 'JPY') }
   let (:zero_money) { Money.new(0) }
 
+  it "has a version" do
+    expect(Money::VERSION).not_to(eq(nil))
+  end
+
   context "default currency not set" do
     it "raises an error" do
       configure(default_currency: nil) do
@@ -67,14 +71,14 @@ RSpec.describe "Money" do
     expect(non_fractional_money.to_s).to eq("1")
   end
 
-  it "to_s with a legacy_dollars style" do
-    expect(amount_money.to_s(:legacy_dollars)).to eq("1.23")
-    expect(non_fractional_money.to_s(:legacy_dollars)).to eq("1.00")
+  it "to_fs with a legacy_dollars style" do
+    expect(amount_money.to_fs(:legacy_dollars)).to eq("1.23")
+    expect(non_fractional_money.to_fs(:legacy_dollars)).to eq("1.00")
   end
 
-  it "to_s with a amount style" do
-    expect(amount_money.to_s(:amount)).to eq("1.23")
-    expect(non_fractional_money.to_s(:amount)).to eq("1")
+  it "to_fs with a amount style" do
+    expect(amount_money.to_fs(:amount)).to eq("1.23")
+    expect(non_fractional_money.to_fs(:amount)).to eq("1")
   end
 
   it "to_s correctly displays negative numbers" do
@@ -100,8 +104,16 @@ RSpec.describe "Money" do
     expect(Money.new("999999999999999999.99", "USD").to_s).to eq("999999999999999999.99")
   end
 
-  it "to_s raises ArgumentError on unsupported style" do
-    expect{ money.to_s(:some_weird_style) }.to raise_error(ArgumentError)
+  it "to_fs raises ArgumentError on unsupported style" do
+    expect{ money.to_fs(:some_weird_style) }.to raise_error(ArgumentError)
+  end
+
+  it "to_fs is aliased as to_s for backward compatibility" do
+    expect(money.method(:to_s)).to eq(money.method(:to_fs))
+  end
+
+  it "to_fs is aliased as to_formatted_s for backward compatibility" do
+    expect(money.method(:to_formatted_s)).to eq(money.method(:to_fs))
   end
 
   it "legacy_json_format makes as_json return the legacy format" do
@@ -331,6 +343,7 @@ RSpec.describe "Money" do
 
   it "returns value and currency in to_json" do
     expect(Money.new(1.00).to_json).to eq('{"value":"1.00","currency":"CAD"}')
+    expect(JSON.dump(Money.new(1.00, "CAD"))).to eq('{"value":"1.00","currency":"CAD"}')
   end
 
   it "supports absolute value" do
@@ -396,6 +409,30 @@ RSpec.describe "Money" do
     end
   end
 
+  it "does not allocate a new money object when multiplying by 1" do
+    expect((money * 1).object_id).to eq(money.object_id)
+  end
+
+  it "does not allocate a new money object when adding 0" do
+    expect((money + 0).object_id).to eq(money.object_id)
+  end
+
+  it "does not allocate a new money object when subtracting 0" do
+    expect((money - 0).object_id).to eq(money.object_id)
+  end
+
+  it "does not allocate when computing absolute value when already positive" do
+    expect((money.abs).object_id).to eq(money.object_id)
+  end
+
+  it "does not allocate when computing floor value when already floored" do
+    expect((money.floor).object_id).to eq(money.object_id)
+  end
+
+  it "does not allocate when computing floor value when already rounded" do
+    expect((money.round).object_id).to eq(money.object_id)
+  end
+
   describe "frozen with amount of $1" do
     let (:money) { Money.new(1.00) }
 

data/spec/rails/job_argument_serializer_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails_spec_helper"
+
+RSpec.describe Money::Rails::JobArgumentSerializer do
+  it "roundtrip a Money argument returns the same object" do
+    job = MoneyTestJob.new(value: Money.new(10.21, "BRL"))
+
+    serialized_job = job.serialize
+    serialized_value = serialized_job["arguments"][0]["value"]
+    expect(serialized_value["_aj_serialized"]).to eq("Money::Rails::JobArgumentSerializer")
+    expect(serialized_value["value"]).to eq(BigDecimal("10.21"))
+    expect(serialized_value["currency"]).to eq("BRL")
+
+    job2 = MoneyTestJob.deserialize(serialized_job)
+    job2.send(:deserialize_arguments_if_needed)
+
+    expect(job2.arguments.first[:value]).to eq(Money.new(10.21, "BRL"))
+  end
+end

data/spec/rails_spec_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_job"
+require_relative "spec_helper"
+
+Money::Railtie.initializers.each(&:run)
+
+class MoneyTestJob < ActiveJob::Base
+  def perform(_params)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.1.pre
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,8 @@ files:
 - lib/money/money.rb
 - lib/money/money_parser.rb
 - lib/money/null_currency.rb
+- lib/money/rails/job_argument_serializer.rb
+- lib/money/railtie.rb
 - lib/money/version.rb
 - lib/money_column.rb
 - lib/money_column/active_record_hooks.rb
@@ -150,6 +152,8 @@ files:
 - spec/money_parser_spec.rb
 - spec/money_spec.rb
 - spec/null_currency_spec.rb
+- spec/rails/job_argument_serializer_spec.rb
+- spec/rails_spec_helper.rb
 - spec/rubocop/cop/money/missing_currency_spec.rb
 - spec/rubocop/cop/money/zero_money_spec.rb
 - spec/rubocop_helper.rb
@@ -175,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Shopify's money gem
@@ -191,6 +195,8 @@ test_files:
 - spec/money_parser_spec.rb
 - spec/money_spec.rb
 - spec/null_currency_spec.rb
+- spec/rails/job_argument_serializer_spec.rb
+- spec/rails_spec_helper.rb
 - spec/rubocop/cop/money/missing_currency_spec.rb
 - spec/rubocop/cop/money/zero_money_spec.rb
 - spec/rubocop_helper.rb