Update for Gettext 0.21 and later

Author: kipcole9

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Cldr_Messages v1.0.1
+
+This is the changelog for Cldr_Messages v1.0.1 released on March 18th, 2025.  For older changelogs please consult the release tag on [GitHub](https://github.com/elixir-cldr/cldr_messages/tags)
+
+### Bug Fixes
+
+* Update documentation, code and tests to reflect the Gettext API as of verison 0.20
+
 ## Cldr_Messages v1.0.0
 
 This is the changelog for Cldr_Messages v1.0.0 released on October 5th, 2023.  For older changelogs please consult the release tag on [GitHub](https://github.com/elixir-cldr/cldr_messages/tags)

README.md

@@ -173,9 +173,18 @@ end
 
 # Define a gettext module with ICU message interpolation
 defmodule MyApp.Gettext do
-  use Gettext, otp_app: :ex_cldr_messages, interpolation: MyApp.Gettext.Interpolation
+  use Gettext.Backend, otp_app: :ex_cldr_messages, interpolation: MyApp.Gettext.Interpolation
 end
 
+# Use the backend in your modules
+defmodule MyApp do
+  use Gettext, backend: MyApp.Gettext
+
+  def my_module do
+    gettext("Created at {created_at}", created_at: ~D[2022-01-22])
+  end
+end
 ```
+
 Now you can proceed to use `Gettext` in the normal manner, most typically with the `gettext/3` macro.
 

lib/cldr/messages/sigil.ex

@@ -49,10 +49,7 @@ defmodule Cldr.Message.Sigil do
       "An ICU message"
 
   However, if you want to re-use the sigil character itself on
-  the string, you need to escape it:
-
-      iex> ~M((\))
-      "()"
+  the string, you need to escape it.
 
   """
   defmacro sigil_M({:<<>>, _meta, [message]}, modifiers) when is_binary(message) do

mix.exs

@@ -1,7 +1,7 @@
 defmodule Cldr.Messages.MixProject do
   use Mix.Project
 
-  @version "1.0.0"
+  @version "1.0.1"
 
   def project do
     [
@@ -44,16 +44,16 @@ defmodule Cldr.Messages.MixProject do
 
   defp deps do
     [
-      {:ex_cldr_dates_times, "~> 2.13", optional: true},
+      {:ex_cldr_dates_times, "~> 2.22", optional: true},
       {:ex_money, "~> 5.9", optional: true},
-      {:ex_cldr_units, "~> 3.12", optional: true},
+      {:ex_cldr_units, "~> 3.18", optional: true},
       {:ex_cldr_lists, "~> 2.10", optional: true},
 
       {:nimble_parsec, "~> 1.0"},
       {:jason, "~> 1.1"},
       {:dialyxir, "~> 1.0", optional: true, only: [:dev, :test], runtime: false},
       {:ex_doc, "~> 0.20", optional: true, runtime: false},
-      {:gettext, "~> 0.19", optional: true}
+      {:gettext, "~> 0.21", optional: true}
     ]
   end
 

mix.lock

@@ -3,5 +3,5 @@ defmodule MyApp.Gettext.Interpolation2 do
 end
 
 defmodule MyApp2.Gettext do
-  use Gettext, otp_app: :ex_cldr_messages, interpolation: MyApp.Gettext.Interpolation2
+  use Gettext.Backend, otp_app: :ex_cldr_messages, interpolation: MyApp.Gettext.Interpolation2
 end

mix/my_app2_gettext.ex

@@ -1,5 +1,5 @@
 defmodule MyApp.Gettext.Use do
-  import MyApp.Gettext
+  use Gettext, backend: MyApp.Gettext
 
   def translate_compile_time(bindings \\ nil)
 

mix/my_app_gettext_use.ex

@@ -3,5 +3,5 @@ defmodule MyApp.Gettext.Interpolation do
 end
 
 defmodule MyApp.Gettext do
-  use Gettext, otp_app: :ex_cldr_messages, interpolation: MyApp.Gettext.Interpolation
+  use Gettext.Backend, otp_app: :ex_cldr_messages, interpolation: MyApp.Gettext.Interpolation
 end

mix/my_app_getttext.ex

@@ -7,7 +7,7 @@ defmodule Cldr.Messages.GettextInterpolationtest do
   import Cldr.Message.TestHelpers
 
   test "interpolates compile time translation" do
-    import MyApp.Gettext
+    use Gettext, backend: MyApp.Gettext
 
     assert "Hello World!" == Use.translate_compile_time(name: "World")
 
@@ -17,7 +17,7 @@ defmodule Cldr.Messages.GettextInterpolationtest do
   end
 
   test "interpolates runtime translation" do
-    import MyApp.Gettext
+    use Gettext, backend: MyApp.Gettext
 
     assert "runtime MXP 1.00" ==
              gettext("runtime {one, number, currency}", %{one: {1, currency: :MXP}})
@@ -29,7 +29,7 @@ defmodule Cldr.Messages.GettextInterpolationtest do
   end
 
   test "interpolates runtime translation with backend that has no message formats configured" do
-    import MyApp2.Gettext
+    use Gettext, backend: MyApp.Gettext
 
     assert "runtime MXP 1.00" ==
              gettext("runtime {one, number, currency}", %{one: {1, currency: :MXP}})
@@ -41,7 +41,7 @@ defmodule Cldr.Messages.GettextInterpolationtest do
   end
 
   test "interpolation with sigil_m" do
-    import MyApp.Gettext
+    use Gettext, backend: MyApp.Gettext
     import Cldr.Message.Sigil
 
     assert gettext(~m"runtime {one, number, currency}", %{one: {1, currency: :MXP}}) ==
@@ -54,10 +54,10 @@ defmodule Cldr.Messages.GettextInterpolationtest do
   end
 
   test "number formatting in gettext finds the CLDR backend" do
-    require MyApp.Gettext
+    use Gettext, backend: MyApp.Gettext
 
     with_no_default_backend(fn ->
-      assert MyApp.Gettext.gettext("Message {number}", number: 7) == "Message 7"
+      assert gettext("Message {number}", number: 7) == "Message 7"
     end)
   end
 
@@ -72,21 +72,21 @@ defmodule Cldr.Messages.GettextInterpolationtest do
   end
 
   test "datetime interpolation" do
-    require MyApp.Gettext
+    use Gettext, backend: MyApp.Gettext
 
     with_no_default_backend(fn ->
-      assert MyApp.Gettext.gettext("Created at {created_at}", created_at: ~D[2022-01-22]) ==
+      assert gettext("Created at {created_at}", created_at: ~D[2022-01-22]) ==
         "Created at Jan 22, 2022"
-      assert MyApp.Gettext.gettext("Created at {created_at}", created_at: ~U[2022-01-22T09:43:56.0Z]) ==
+      assert gettext("Created at {created_at}", created_at: ~U[2022-01-22T09:43:56.0Z]) ==
         "Created at Jan 22, 2022, 9:43:56 AM"
-      assert MyApp.Gettext.gettext("Created at {created_at}", created_at: ~T[09:43:56]) ==
+      assert gettext("Created at {created_at}", created_at: ~T[09:43:56]) ==
         "Created at 9:43:56 AM"
     end)
   end
 
   test "unit interpolation" do
-    require MyApp.Gettext
-    import MyApp.Gettext
+    use Gettext, backend: MyApp.Gettext
+    Cldr.put_locale MyApp.Cldr, "en"
 
     with_no_default_backend(fn ->
       assert gettext("It weighs {weight}", weight: Cldr.Unit.new!("kilogram", 23)) == "It weighs 23 kilograms"