Deprecate Money.default_backend/0 in favour of Money.default_backend!/0

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 **Note** `ex_money` 5.17.0 and later is supported on Elixir 1.12 and later versions only.
 
+## Money v5.19.0
+
+This is the changelog for Money v5.19.0 released on January 1st, 2024.  For older changelogs please consult the release tag on [GitHub](https://github.com/kipcole9/money/tags)
+
+### Deprecations
+
+* `Money.default_backend/0` is deprecated in favor of `Money.default_backend!/0` whose naming better expresses the side effect of an exception being raised if no default backend is configured.
+
+### Bug Fixes
+
+* Surface an error exception if, when starting the exchange rates service, no ex_cldr backend is configured.
+
 ## Money v5.18.0
 
 This is the changelog for Money v5.18.0 released on September 18th, 2024.  For older changelogs please consult the release tag on [GitHub](https://github.com/kipcole9/money/tags)

README.md

@@ -100,7 +100,7 @@ An optional callback module can also be defined.  This module defines a `rates_r
       log_failure: :warning,
       log_info: :info,
       log_success: nil,
-      json_library: Jason,
+      json_library: Jason on Elixir up to 1.17, JSON on Elixir 1.18+,
       default_cldr_backend: MyApp.Cldr,
       exclude_protocol_implementations: []
 
@@ -129,7 +129,7 @@ An optional callback module can also be defined.  This module defines a `rates_r
 
 * `:retriever_options` is available for exchange rate retriever module developers as a place to add retriever-specific configuration information.  This information should be added in the `init/1` callback in the retriever module.  See `Money.ExchangeRates.OpenExchangeRates.init/1` for an example.
 
-* `:json_library` determines which json library to be used for decoding.  Two common options are `Poison` and `Jason`. The default is `Cldr.Config.json_library/0` which is currently configured by default as `Jason`.
+* `:json_library` determines which json library to be used for decoding.  Two common options are `Poison` and `Jason`. The default is `Cldr.Config.json_library/0` which will attempt to use `Json` (built in as of Elixir 1.18) or `:json` (built into OTP as of OTP 27).
 
 * `:exclude_protocol_implementations` is a protocol module, or list of protocol modules, that will not be defined by `ex_money`. The default is `[]`. The protocol implementations influenced by this option at `Json.Encoder`, `Phoenix.HTML.Safe` and `Gringotts.Money`.
 

config/dev.exs

@@ -9,7 +9,7 @@ config :ex_money,
   log_failure: :warning,
   log_info: :info,
   log_success: :info,
-  json_library: Jason,
+  # json_library: Jason,
   exchange_rates_cache: Money.ExchangeRates.Cache.Dets,
   default_cldr_backend: Money.Cldr
 

lib/money.ex

@@ -538,14 +538,14 @@ defmodule Money do
   any entries in `:except` are removed from the `:only`
   entries.
 
-    * `:all`, the default, considers all currencies
+    * `:all`, the default, considers all currencies.
 
     * `:current` considers those currencies that have a `:to`
-      date of nil and which also is a known ISO4217 currency
+      date of nil and which also is a known ISO4217 currency.
 
-    * `:historic` is the opposite of `:current`
+    * `:historic` is the opposite of `:current`.
 
-    * `:tender` considers currencies that are legal tender
+    * `:tender` considers currencies that are legal tender.
 
     * `:unannotated` considers currencies that don't have
       "(some string)" in their names.  These are usually
@@ -704,9 +704,10 @@ defmodule Money do
   ## Arguments
 
   * `money` is any valid `t:Money.t/0` type returned
-    by `Money.new/2`
+    by `Money.new/2`.
 
-  * `options` is a keyword list of options or a `%Cldr.Number.Format.Options{}` struct
+  * `options` is a keyword list of options or a `t:Cldr.Number.Format.Options.t/0`
+    struct.
 
   ## Returns
 
@@ -736,7 +737,7 @@ defmodule Money do
   * `:no_fraction_if_integer` is a boolean which, if `true`, will set `:fractional_digits`
     to `0` if the money value is an integer value.
 
-  * Any other options are passed to `Cldr.Number.to_string/3`
+  * Any other options are passed to `Cldr.Number.to_string/3`.
 
   ## Examples
 
@@ -769,7 +770,7 @@ defmodule Money do
   end
 
   def to_string(%Money{} = money, options) when is_list(options) do
-    default_options = [backend: Money.default_backend(), currency: money.currency]
+    default_options = [backend: Money.default_backend!(), currency: money.currency]
     format_options = Map.get(money, :format_options, [])
 
     options =
@@ -2992,7 +2993,7 @@ defmodule Money do
       """
   end
 
-  @doc deprecated: "Use Money.default_backend!/0"
+  @deprecated "Use Money.default_backend!/0"
   def default_backend do
     default_backend!()
   end

mix.exs

@@ -1,7 +1,7 @@
 defmodule Money.Mixfile do
   use Mix.Project
 
-  @version "5.18.1"
+  @version "5.19.0"
 
   def project do
     [

test/money_test.exs

@@ -559,7 +559,7 @@ defmodule MoneyTest do
     Application.put_env(:ex_money, :default_cldr_backend, nil)
     Application.put_env(:ex_cldr, :default_backend, Test.Cldr)
 
-    assert Money.default_backend() == Test.Cldr
+    assert Money.default_backend!() == Test.Cldr
 
     Application.put_env(:ex_money, :default_cldr_backend, money_backend)
     Application.put_env(:ex_cldr, :default_backend, cldr_backend)