money 6.13.6 → 6.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f41d31f75d5bff854667ff0d38d23b7ffa7e40f4cc4be7732aed48303bf3c3e4
-  data.tar.gz: 9291b358b1ed9cf0fd5add31910735fcc4ce32d320068e8b3607c2e95e7dd108
+  metadata.gz: 7423c34018e037ae7989b60e9cf22972afb7fa8f02037c253b0d3fd30e635fd0
+  data.tar.gz: fedcca4c2a3d6918e930526e3a207c419853852604bee8268e2d8046f59ce4cc
 SHA512:
-  metadata.gz: 4f3132b6ee0c2f4a4a49128a60316598da0e33f2fcfe9d123feac5f89f2498ffe2a166876ddfb9c628431e727fc2b88d40dc8f6660621a6ba269a36745f4ee92
-  data.tar.gz: a0ae9e326bea5273d4cb05849cf0efa30c7b210914bdca9a37ed56e5f4aece8d04f22715d326a751e5a9631d671e9bc4e6c04b1726b9b83d6c75feba9d0e094e
+  metadata.gz: 53eeeb609a252d244e9d497fd3f480c317561a8b5a1889b297f96d2298bac3c2b87b5ed1af6e5c6dfbbc0264039960f4287bd6752c7090adb7923befca9ba52e
+  data.tar.gz: 45cf7fd6f42d16a3924e515e779c283316ca204bba5dade5773f89b44118615a69736bd5231db254fb9857dc8dc5b4938343c9982cc4279d88d586f327b492e1

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 6.13.7
+- Improve deprecation warnings for the upcoming major release
+
 ## 6.13.6
 - Fix a regression introduced in 6.13.5 that broken RatesStore::Memory subclasses
 
@@ -57,7 +60,7 @@
 - Wrap all amount parts when `:html_wrap` option is used
 - Deprecate `#currency_as_string` and `#currency_as_string=` (in favour of `#with_currency`)
 - Add `#with_currency` for swapping the currency
-- Rewrite allocate/split (fixing some penny loosing issues)
+- Rewrite allocate/split (fixing some penny losing issues)
 
 ## 6.11.3
 - Fix regression: if enabled use i18n locales in Money#to_s
@@ -76,7 +79,7 @@
 - Added new symbol for bitcoin denomination
 - Specify custom rounding precision when using `infinite_precision`
 - Allow splits with sums greater than 1
-- Prevent arithmetic methods from loosing reference to the bank
+- Prevent arithmetic methods from losing reference to the bank
 - Fix coerced zero numeric subtraction
 - Fix south asian formatting to support whole numbers
 - Refactor formatting logic

data/README.md

@@ -423,6 +423,13 @@ Money.new(2.34567).round.format #=> "$0.02"
 Money.new(2.34567).round(BigDecimal::ROUND_HALF_UP, 2).format #=> "$0.0235"
 ```
 
+You can set the default rounding mode by passing one of the `BigDecimal` mode enumerables like so:
+```ruby
+Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
+```
+See [BigDecimal::ROUND_MODE](https://ruby-doc.org/stdlib-2.5.1/libdoc/bigdecimal/rdoc/BigDecimal.html#ROUND_MODE) for more information
+
+
 ## Ruby on Rails
 
 To integrate money in a Rails application use [money-rails](https://github.com/RubyMoney/money-rails).

data/lib/money/money.rb

@@ -91,35 +91,45 @@ class Money
   class << self
 
     # @!attribute [rw] default_bank
-    #   @return [Money::Bank::Base] Each Money object is associated to a bank
-    #     object, which is responsible for currency exchange. This property
-    #     allows you to specify the default bank object. The default value for
-    #     this property is an instance of +Bank::VariableExchange.+ It allows
-    #     one to specify custom exchange rates.
+    #   Used to set a default bank for currency exchange.
+    #
+    #   Each Money object is associated with a bank
+    #   object, which is responsible for currency exchange. This property
+    #   allows you to specify the default bank object. The default value for
+    #   this property is an instance of +Bank::VariableExchange.+ It allows
+    #   one to specify custom exchange rates.
+    #
+    #   @return [Money::Bank::Base]
     #
     # @!attribute default_formatting_rules
-    #   @return [Hash] Use this to define a default hash of rules for every time
-    #     +Money#format+ is called.  Rules provided on method call will be
-    #     merged with the default ones.  To overwrite a rule, just provide the
-    #     intended value while calling +format+.
+    #   Used to define a default hash of rules for every time
+    #   +Money#format+ is called.  Rules provided on method call will be
+    #   merged with the default ones.  To overwrite a rule, just provide the
+    #   intended value while calling +format+.
     #
-    #   @see +Money::Formatting#format+ for more details.
+    #   @see Money::Formatter#initialize Money::Formatter for more details
     #
     #   @example
     #     Money.default_formatting_rules = { display_free: true }
     #     Money.new(0, "USD").format                          # => "free"
     #     Money.new(0, "USD").format(display_free: false)  # => "$0.00"
     #
+    #   @return [Hash]
+    #
     # @!attribute [rw] use_i18n
-    #   @return [Boolean] Use this to disable i18n even if it's used by other
-    #     objects in your app.
+    #   Used to disable i18n even if it's used by other components of your app.
+    #
+    #   @return [Boolean]
     #
     # @!attribute [rw] infinite_precision
-    #   @return [Boolean] Use this to enable infinite precision cents
+    #   Used to enable infinite precision cents
+    #
+    #   @return [Boolean]
     #
     # @!attribute [rw] conversion_precision
-    #   @return [Integer] Use this to specify precision for converting Rational
-    #     to BigDecimal
+    #   Used to specify precision for converting Rational to BigDecimal
+    #
+    #   @return [Integer]
     attr_accessor :default_bank, :default_formatting_rules,
       :use_i18n, :infinite_precision, :conversion_precision,
       :locale_backend
@@ -132,8 +142,9 @@ class Money
   #     +Money::Currency+ instance.
   def self.default_currency
     if @using_deprecated_default_currency
-      warn '[WARNING] The default currency will change to `nil` in the next major release. Make ' \
+      warn '[WARNING] The default currency will change from `USD` to `nil` in the next major release. Make ' \
            'sure to set it explicitly using `Money.default_currency=` to avoid potential issues'
+      @using_deprecated_default_currency = false
     end
 
     if @default_currency.respond_to?(:call)
@@ -213,19 +224,22 @@ class Money
     return Thread.current[:money_rounding_mode] if Thread.current[:money_rounding_mode]
 
     if @using_deprecated_default_rounding_mode
-      warn '[WARNING] The default rounding mode will change to `ROUND_HALF_UP` in the next major ' \
-           'release. Set it explicitly using `Money.rounding_mode=` to avoid potential problems.'
+      warn '[WARNING] The default rounding mode will change from `ROUND_HALF_EVEN` to `ROUND_HALF_UP` in the ' \
+           'next major release. Set it explicitly using `Money.rounding_mode=` to avoid potential problems.'
+      @using_deprecated_default_rounding_mode = false
     end
 
     @rounding_mode
   end
 
-  # This method temporarily changes the rounding mode. It will then return the
-  # results of the block instead.
+  # Temporarily changes the rounding mode in a given block.
   #
   # @param [BigDecimal::ROUND_MODE] mode
   #
-  # @return [BigDecimal::ROUND_MODE,Yield] block results
+  # @yield The block within which rounding mode will be changed. Its return
+  #   value will also be the return value of the whole method.
+  #
+  # @return [Object] block results
   #
   # @example
   #   fee = Money.with_rounding_mode(BigDecimal::ROUND_HALF_UP) do
@@ -531,13 +545,15 @@ class Money
     exchange_to("EUR")
   end
 
-  # Splits a given amount in parts without loosing pennies. The left-over pennies will be
-  # distributed round-robin amongst the parties. This means that parties listed first will likely
-  # receive more pennies than ones that are listed later.
+  # Splits a given amount in parts without losing pennies. The left-over pennies will be
+  # distributed round-robin amongst the parties. This means that parts listed first will likely
+  # receive more pennies than ones listed later.
+  #
+  # Pass [2, 1, 1] as input to give twice as much to part1 as part2 or
+  # part3 which results in 50% of the cash to party1, 25% to part2, and 25% to part3. Passing a
+  # number instead of an array will split the amount evenly (without losing pennies when rounding).
   #
-  # @param [Array<Numeric>, Numeric] pass [2, 1, 1] to give twice as much to party1 as party2 or
-  # party3 which results in 50% of the cash to party1, 25% to party2, and 25% to party3. Passing a
-  # number instead of an array will split the amount evenly (without loosing pennies when rounding).
+  # @param [Array<Numeric>, Numeric] parts how amount should be distributed to parts
   #
   # @return [Array<Money>]
   #
@@ -575,7 +591,7 @@ class Money
 
   # Creates a formatted price string according to several rules.
   #
-  # @param [Hash] See Money::Formatter for the list of formatting options
+  # @param [Hash] rules See {Money::Formatter Money::Formatter} for the list of formatting options
   #
   # @return [String]
   #

data/lib/money/money/allocation.rb

@@ -2,9 +2,9 @@
 
 class Money
   class Allocation
-    # Splits a given amount in parts without loosing pennies.
-    # The left-over pennies will be distributed round-robin amongst the parties. This means that
-    # parties listed first will likely receive more pennies than ones that are listed later.
+    # Splits a given amount in parts without losing pennies.
+    # The left-over pennies will be distributed round-robin amongst the parts. This means that
+    # parts listed first will likely receive more pennies than the ones listed later.
     #
     # The results should always add up to the original amount.
     #

data/lib/money/version.rb

@@ -1,3 +1,3 @@
 class Money
-  VERSION = '6.13.6'
+  VERSION = '6.13.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money
 version: !ruby/object:Gem::Version
-  version: 6.13.6
+  version: 6.13.7
 platform: ruby
 authors:
 - Shane Emmons
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n