moolah 5.2.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d6d273ed7273e3e1f788c93369570aeed0f4b4040abb8d494b84b8f3a0eda21
-  data.tar.gz: cc68a4a6bf14797382ef669ad34ef16decd87fdb7f11028067bffa62b59c9d11
+  metadata.gz: 0cfb80941d30fee4042a1186672a5463fc99d2e0b4700f1ef6138862ce5b7a19
+  data.tar.gz: ab463d36b7d644ad8f6ec3adb4a1d8104e1348623558997c7f5c66a0133166bc
 SHA512:
-  metadata.gz: 4bb4d5be819af9158b0b1491e62ed1b914fe410365168e31ca777b0e70e2e1e943da4337f6a7d6d38dab51dd2bdb8af4b4b3366d12b8c75a303f8646de59fa14
-  data.tar.gz: d188591ef2f06d424d5ba5b4c34d6fc94a334e1c1ca3494db2ddd52ec24403842fd1fcfe0f525586435d22c6fdc6e94b0c2dbe53536f1d03cb18c9a8a315d281
+  metadata.gz: '0889eaa959a7730ddbad5775f94d13b80cd316d5d6abf873d77fa9407cc43e2ab37c4d6f0f66ded04e4e49cb704bc81fa6931214b0864418d3cf70cee7364cf1'
+  data.tar.gz: 6898f7b1ea7d4ce11c885215653cac18149120f845a47f5463994a2bfa2a787f5b30409552771bc87ab57757ce64ac98c53f5df2beb861270e8f7ed73ca9d837

data/README.md

@@ -1,13 +1,9 @@
 # Moolah
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/moolah`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Moolah is a Money gem that deals with Currency and FX_RATE. It is being used in multiple repos in Hotels/Bookings.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'moolah'
 ```
@@ -20,9 +16,48 @@ Or install it yourself as:
 
     $ gem install moolah
 
+### How to upgrade to version 5
+
+For version 5, `fx_rate` is a must field while initializing a Moolah::Money object with different currency other than AUD. 
+When you initialize Moolah::Money with AUD as the currency, the fx_rate will be default to 1.0
+
+This will break projects that are using older Moolah version expect the project is using AUD as the main currency.
+
+```ruby
+gem 'moolah', -> '5.3'
+```
+
+```
+$ bundle update moolah
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### To create a new Moolah::Money object
+```ruby
+Moolah::Money.new(amount: '10', currency: 'AUD', fx_rate: '1.0000')
+```
+
+### To create a AUD dollar Moolah::Money object
+```ruby
+Moolah::Money.in_aud('10')
+```
+
+### To create a zero dollar Moolah::Money object
+```ruby
+Moolah::Money.zero(currency: 'AUD', fx_rate: '1.0000')
+```
+
+### To display a json format of the Moolah::Money object
+```ruby
+money = Moolah::Money.new(amount: '10', currency: 'AUD', fx_rate: '1.0000')
+money.as_json 
+=> {
+    'amount' => '10.00',
+    'currency' => 'AUD',
+    'fx_rate' => '1.0000'
+   }
+```
 
 ## Development
 

data/lib/moolah/currency_registry.rb

@@ -9,7 +9,7 @@ module Moolah
       def load_csv(file)
         currencies = {}
 
-        CSV.foreach(file, headers: true, header_converters: :symbol, encoding: 'ISO-8859-1') do |row|
+        CSV.foreach(file, headers: true, header_converters: :symbol, encoding: 'UTF-8') do |row|
           code = row[:code]
           currencies[code] = Currency.new(
             name: row[:currency],

data/lib/moolah/money.rb

@@ -1,30 +1,57 @@
 require 'anemic/model'
 require 'bigdecimal'
+require 'active_support'
 
 module Moolah
   class Money
     include Anemic::Model
     include Comparable
 
+    delegate :zero?, :positive?, :negative?, to: :amount
+
     attribute :amount, BigDecimal, default: BigDecimal(0)
     attribute :currency, String
     attribute :fx_rate, BigDecimal
 
     def initialize(args = {})
-      args[:currency] = 'AUD' if args[:currency].nil? || args[:currency] == ''
+      args = args.transform_keys(&:to_sym)
+
+      args[:currency] = 'AUD' if args[:currency].blank?
       args[:fx_rate] = '1.0000' if args[:currency] == 'AUD'
 
-      raise ArgumentError.new('missing keyword: :fx_rate') unless args[:fx_rate]
+      if args[:fx_rate].nil?
+        # So fx_rate appears as nil as part of the error message
+        args[:fx_rate] = nil
+        raise ArgumentError, "missing keyword: :fx_rate in #{self.class.name} (#{args.sort.to_h})"
+      end
 
       super(args)
     end
 
     def self.in_aud(amount)
-      Money.new(currency: 'AUD', amount: amount)
+      new(amount: amount)
+    end
+
+    def self.zero(currency = 'AUD', fx_rate = nil)
+      new(currency: currency, amount: 0, fx_rate: fx_rate)
     end
 
-    def self.zero(currency='AUD', fx_rate=1)
-      Money.new(currency: currency, amount: 0, fx_rate: fx_rate)
+    def to_aud
+      return Money.new if fx_rate.zero?
+
+      Money.new(amount: amount / fx_rate)
+    end
+
+    def convert_to(other)
+      money = other.is_a?(Money) ? other : Money.new(other)
+
+      converted = Money.new(
+        amount: to_aud.amount * money.fx_rate,
+        currency: money.currency,
+        fx_rate: money.fx_rate
+      )
+
+      converted.bankers_rounded
     end
 
     def formatted(symbol: true, delimit: true)
@@ -35,6 +62,10 @@ module Moolah
       formatter.format(symbol: false, delimit: false)
     end
 
+    def formatted_fx_rate
+      formatter.format_fx_rate
+    end
+
     def amount_in_cents
       (bankers_rounded.amount * 100).to_i
     end
@@ -55,27 +86,31 @@ module Moolah
       "#{self.class.name} (#{as_json})"
     end
 
-    def +(money)
-      return self unless money
-      raise ArgumentError, 'Cannot add two Money objects with different currencies' if currency != money.currency
-      raise ArgumentError, 'Cannot add two Money objects with different fx rates' if fx_rate != money.fx_rate
+    def +(other)
+      return self if other.nil?
+
+      money = other.is_a?(Money) ? other : Money.new(other)
+      raise ArgumentError, "Cannot add currency: #{currency} with given currency: #{money.currency}" if currency != money.currency
+      raise ArgumentError, "Cannot add fx rate: #{formatter.format_fx_rate} with given fx rate: #{money.formatted_fx_rate}" if fx_rate != money.fx_rate
 
       Money.new(amount: amount + money.amount, currency: currency, fx_rate: fx_rate)
     end
 
-    def -(money)
-      return self unless money
-      raise ArgumentError, 'Cannot subtract two Money objects with different currencies' if currency != money.currency
-      raise ArgumentError, 'Cannot subtract two Money objects with different fx rates' if fx_rate != money.fx_rate
+    def -(other)
+      return self if other.nil?
+
+      money = other.is_a?(Money) ? other : Money.new(other)
+      raise ArgumentError, "Cannot subtract currency: #{currency} with given currency: #{money.currency}" if currency != money.currency
+      raise ArgumentError, "Cannot subtract fx rate: #{formatter.format_fx_rate} with given fx rate: #{money.formatted_fx_rate}" if fx_rate != money.fx_rate
 
       Money.new(amount: amount - money.amount, currency: currency, fx_rate: fx_rate)
     end
 
-    def *(_money)
+    def *(_other)
       raise ArgumentError, 'Cannot multiply Money objects due to rounding issues'
     end
 
-    def /(_money)
+    def /(_other)
       raise ArgumentError, 'Cannot divide Money objects due to rounding issues'
     end
 
@@ -83,21 +118,15 @@ module Moolah
       Money.new(amount: -amount, currency: currency, fx_rate: fx_rate)
     end
 
-    def <=>(money)
-      raise ArgumentError, 'Cannot compare two Money objects with different currencies' if currency != money.currency
-      raise ArgumentError, 'Cannot compare two Money objects with different fx rates' if fx_rate != money.fx_rate
-
-      amount <=> money.amount
+    def <=>(other)
+      money = other.is_a?(Money) ? other : Money.new(other)
+      to_aud.amount <=> money.to_aud.amount
     end
 
     def bankers_rounded
       Rounder.new(self).bankers_rounded
     end
 
-    def zero?
-      amount.zero?
-    end
-
     def negate
       negated_amount = amount * -1
       negated_amount = 0 if negated_amount.to_s == '-0.0'

data/lib/moolah/version.rb

@@ -1,6 +1,6 @@
 module Moolah
   MAJOR = 5
-  MINOR = 2
+  MINOR = 6
   PATCH = ENV['PATCH_VERSION'] || 0
 
   private_constant :MAJOR, :MINOR, :PATCH

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moolah
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Marc Lee
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler