Fix OTP 26 CI via json_polyfill, add credo and live integration tests with CI postgres

Author: kipcole9

.credo.exs

@@ -0,0 +1,36 @@
+# Credo configuration for Localize Ecto.
+#
+# Policy decisions follow the localize project (July 2026):
+#
+# * `Design.AliasUsage` is disabled. The localize family deliberately
+#   fully qualifies many calls because module names such as
+#   `Localize.List`, `Localize.Date` and `Localize.String` shadow the
+#   standard library when aliased. The preferred style is to alias
+#   submodules opportunistically when the trailing segment does NOT
+#   clash with the stdlib, and never as a bulk conversion.
+#
+# * `Refactor.Nesting` stays at the default maximum depth of 2:
+#   multi-clause helper functions with pattern matching are preferred
+#   over nested case/cond/if.
+#
+# * `Refactor.CyclomaticComplexity` stays at the default of 9;
+#   naturally-branchy functions carry inline `credo:disable`
+#   annotations with a one-line justification instead of a raised
+#   global limit.
+%{
+  configs: [
+    %{
+      name: "default",
+      strict: true,
+      files: %{
+        included: ["lib/", "test/"],
+        excluded: []
+      },
+      checks: %{
+        disabled: [
+          {Credo.Check.Design.AliasUsage, []}
+        ]
+      }
+    }
+  ]
+}

.github/workflows/ci.yml

@@ -8,6 +8,9 @@ on:
 
 env:
   MIX_ENV: test
+  PGHOST: localhost
+  PGUSER: postgres
+  PGPASSWORD: postgres
 
 permissions:
   contents: read
@@ -17,6 +20,19 @@ jobs:
     name: "Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }}${{ matrix.lint && ' (lint)' || '' }}"
     runs-on: ubuntu-latest
 
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
     strategy:
       fail-fast: false
       matrix:
@@ -77,6 +93,10 @@ jobs:
         if: matrix.lint
         run: mix format --check-formatted
 
+      - name: Run credo
+        if: matrix.lint
+        run: mix credo --strict
+
       - name: Compile (warnings as errors)
         run: mix compile --warnings-as-errors
 

mix.exs

@@ -11,6 +11,7 @@ defmodule LocalizeEcto.MixProject do
       name: "Localize Ecto",
       source_url: @source_url,
       elixir: "~> 1.17",
+      elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       description: description(),
@@ -68,14 +69,32 @@ defmodule LocalizeEcto.MixProject do
     ]
   end
 
+  defp elixirc_paths(:test), do: ["lib", "test/support"]
+  defp elixirc_paths(_), do: ["lib"]
+
   defp deps do
     [
       {:ecto, "~> 3.12"},
       {:localize, "~> 0.50"},
       {:ecto_sql, "~> 3.12", optional: true},
       {:postgrex, "~> 0.20", only: [:dev, :test]},
+      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
       {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
       {:ex_doc, "~> 0.34", only: [:dev, :release], runtime: false}
-    ]
+    ] ++ maybe_json_polyfill()
+  end
+
+  # json_polyfill (the EEP 68 :json module for OTP 26) is provided for
+  # this project's own dev/test/CI only — `only:` dependencies never
+  # enter the hex package requirements. OTP 26 consumers add
+  # {:json_polyfill, "~> 0.2 or ~> 1.0"} to their own deps, as the
+  # localize README documents. The conditional avoids fetching it on
+  # OTP >= 27, where :json is built in.
+  defp maybe_json_polyfill do
+    if Code.ensure_loaded?(:json) do
+      []
+    else
+      [{:json_polyfill, "~> 0.2 or ~> 1.0", only: [:dev, :test]}]
+    end
   end
 end

mix.lock

@@ -1,4 +1,6 @@
 %{
+  "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
+  "credo": {:hex, :credo, "1.7.19", "cc52129665fc7c15143d47838fda0f9cd6dac9ceced7bf4da6f85fcbfe64b12a", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "2d8bc95d5a7bb99dd2613621d4f08c6a3575c3fd4b62e6a2b48a100352a557b8"},
   "db_connection": {:hex, :db_connection, "2.10.2", "ae391e803a5adff104da913c2fc1c0c14a37f8b10001dcef568796e1fb7bf95c", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "510b14482330f1af6490a2fa0efd8d4f1435d1529b165647df22ac0f2df0fa93"},
   "decimal": {:hex, :decimal, "3.1.1", "430d87b04011ce6cbd4fd205be758311a81f87d552d40904abd00f015935b1d0", [:mix], [], "hexpm", "c5f25f2ced74a0587d03e6023f595db8e924c9d3922c8c8ffd9edfc4498cf1f6"},
   "dialyxir": {:hex, :dialyxir, "1.4.7", "dda948fcee52962e4b6c5b4b16b2d8fa7d50d8645bbae8b8685c3f9ecb7f5f4d", [:mix], [{:erlex, ">= 0.2.8", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b34527202e6eb8cee198efec110996c25c5898f43a4094df157f8d28f27d9efe"},
@@ -8,7 +10,9 @@
   "erlex": {:hex, :erlex, "0.2.9", "7debbbaa9f4f368b8cd648983e0f1d7963028508e9c59e9d4ed504e94ef52a55", [:mix], [], "hexpm", "8cfffc0ec7159e6d73de2ab28a588064de80f88b2798d5cbe4482cbbc200178b"},
   "ex_doc": {:hex, :ex_doc, "0.40.3", "4a972ffe64bc07dc605af487e98fc19b72a4185f55ca031b94c0552d6071c1d9", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "2756e357742fecd9749b489b85d67c9ce99c465f2e75728d9e6dc8d704b973de"},
   "expo": {:hex, :expo, "1.1.1", "4202e1d2ca6e2b3b63e02f69cfe0a404f77702b041d02b58597c00992b601db5", [:mix], [], "hexpm", "5fb308b9cb359ae200b7e23d37c76978673aa1b06e2b3075d814ce12c5811640"},
+  "file_system": {:hex, :file_system, "1.1.1", "31864f4685b0148f25bd3fbef2b1228457c0c89024ad67f7a81a3ffbc0bbad3a", [:mix], [], "hexpm", "7a15ff97dfe526aeefb090a7a9d3d03aa907e100e262a0f8f7746b78f8f87a5d"},
   "gettext": {:hex, :gettext, "1.0.2", "5457e1fd3f4abe47b0e13ff85086aabae760497a3497909b8473e0acee57673b", [:mix], [{:expo, "~> 0.5.1 or ~> 1.0", [hex: :expo, repo: "hexpm", optional: false]}], "hexpm", "eab805501886802071ad290714515c8c4a17196ea76e5afc9d06ca85fb1bfeb3"},
+  "jason": {:hex, :jason, "1.4.5", "2e3a008590b0b8d7388c20293e9dcc9cf3e5d642fd2a114e4cbbb52e595d940a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0 or ~> 3.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "b0c823996102bcd0239b3c2444eb00409b72f6a140c1950bc8b457d836b30684"},
   "localize": {:hex, :localize, "0.50.0", "adf1dfa06aa3e23596389a52bd5a819c24415eb937abc5e511fc49f77c8984b6", [:mix], [{:decimal, "~> 2.0 or ~> 3.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:elixir_make, "~> 0.4", [hex: :elixir_make, repo: "hexpm", optional: true]}, {:gettext, "~> 1.0", [hex: :gettext, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "ac5621c8b762470e5a6d24d0e7d8565491220f85fa9e09697c61b33013bb2e0d"},
   "makeup": {:hex, :makeup, "1.2.2", "882d46dc0905e9ff7abf2aab61a7e6b3dcc555533977d8a23b06019e6c89ac94", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "9a1a24e5b343b8ae16abea0822c10a6f75da27af7fa802ada5251f7579bfccfa"},
   "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},

test/localize/ecto/integration_test.exs

@@ -0,0 +1,114 @@
+defmodule Localize.Ecto.IntegrationTest do
+  # Migrations and DDL are global to the test database, so this suite
+  # is not async.
+  use ExUnit.Case, async: false
+
+  import Ecto.Query
+  import Localize.Ecto
+
+  alias Localize.Ecto.TestRepo
+
+  defmodule AddPhonebookCollation do
+    use Ecto.Migration
+
+    import Localize.Ecto.Migration
+
+    def change do
+      create_collation("de-u-co-phonebk", if_not_exists: true)
+      create_collation("de-u-co-phonebk", name: "german_phonebook", if_not_exists: true)
+    end
+  end
+
+  defmodule DropPhonebookCollation do
+    use Ecto.Migration
+
+    import Localize.Ecto.Migration
+
+    def change do
+      drop_collation("de-u-co-phonebk", name: "german_phonebook", if_exists: true)
+    end
+  end
+
+  setup_all do
+    TestRepo.query!("create table if not exists words (id serial primary key, word text)")
+    TestRepo.query!("truncate words")
+
+    for word <- ["Muller", "Müller", "Mueller", "Mahler"] do
+      TestRepo.query!("insert into words (word) values ($1)", [word])
+    end
+
+    :ok
+  end
+
+  defp migrate(:up, migration, version) do
+    Ecto.Migrator.up(TestRepo, version, migration, log: false)
+  end
+
+  defp migrate(:down, migration, version) do
+    Ecto.Migrator.down(TestRepo, version, migration, log: false)
+  end
+
+  defp collation_names do
+    "select collname from pg_collation where collname like '%phonebk%' or collname like '%phonebook%'"
+    |> TestRepo.query!()
+    |> Map.fetch!(:rows)
+    |> List.flatten()
+  end
+
+  defp words_ordered_by(locale_or_options) do
+    query = from w in "words", order_by: collate(w.word, ^locale_or_options), select: w.word
+    TestRepo.all(query)
+  end
+
+  describe "create_collation/2 and drop_collation/2 in a migration" do
+    test "creating, using, rolling back and dropping collations" do
+      assert :ok = migrate(:up, AddPhonebookCollation, 20_260_717_000_001)
+      assert "de-u-co-phonebk-x-icu" in collation_names()
+      assert "german_phonebook" in collation_names()
+
+      # Standard German sorts ü after u; phonebook order treats ü as ue.
+      assert words_ordered_by("de") == ["Mahler", "Mueller", "Muller", "Müller"]
+      assert words_ordered_by("de-u-co-phonebk") == ["Mahler", "Mueller", "Müller", "Muller"]
+
+      assert words_ordered_by(collation: "german_phonebook") ==
+               ["Mahler", "Mueller", "Müller", "Muller"]
+
+      # A collated comparison in a where clause.
+      comparison =
+        from w in "words",
+          where: collate(w.word < "Muller", "de-u-co-phonebk"),
+          order_by: w.word,
+          select: w.word
+
+      assert TestRepo.all(comparison) == ["Mahler", "Mueller", "Müller"]
+
+      # drop_collation/2 is reversible too: run its migration up, then
+      # roll both migrations back and confirm the collations are gone.
+      assert :ok = migrate(:up, DropPhonebookCollation, 20_260_717_000_002)
+      refute "german_phonebook" in collation_names()
+
+      assert :ok = migrate(:down, DropPhonebookCollation, 20_260_717_000_002)
+      assert "german_phonebook" in collation_names()
+
+      assert :ok = migrate(:down, AddPhonebookCollation, 20_260_717_000_001)
+      refute "de-u-co-phonebk-x-icu" in collation_names()
+      refute "german_phonebook" in collation_names()
+    end
+  end
+
+  describe "collate/1,2 against a live server" do
+    test "orders by locale-specific collations" do
+      assert words_ordered_by("de") == ["Mahler", "Mueller", "Muller", "Müller"]
+      assert words_ordered_by("sv") == ["Mahler", "Mueller", "Muller", "Müller"]
+    end
+
+    test "orders by the current locale" do
+      {:ok, _} = Localize.put_locale("de")
+      query = from w in "words", order_by: collate(w.word), select: w.word
+
+      assert TestRepo.all(query) == ["Mahler", "Mueller", "Muller", "Müller"]
+    after
+      Localize.put_locale("en")
+    end
+  end
+end

test/support/test_repo.ex

@@ -0,0 +1,5 @@
+defmodule Localize.Ecto.TestRepo do
+  @moduledoc false
+
+  use Ecto.Repo, otp_app: :localize_ecto, adapter: Ecto.Adapters.Postgres
+end

test/test_helper.exs

@@ -1 +1,25 @@
+# Integration tests run against a real PostgreSQL server. Connection
+# settings follow the libpq environment variables so CI (service
+# container with a password) and local development (trust auth) both
+# work without configuration changes.
+Application.put_env(:localize_ecto, Localize.Ecto.TestRepo,
+  hostname: System.get_env("PGHOST", "localhost"),
+  port: String.to_integer(System.get_env("PGPORT", "5432")),
+  username: System.get_env("PGUSER", System.get_env("USER")),
+  password: System.get_env("PGPASSWORD"),
+  database: "localize_ecto_test",
+  pool_size: 2,
+  log: false
+)
+
+repo_config = Application.get_env(:localize_ecto, Localize.Ecto.TestRepo)
+
+case Ecto.Adapters.Postgres.storage_up(repo_config) do
+  :ok -> :ok
+  {:error, :already_up} -> :ok
+  {:error, reason} -> raise "could not create test database: #{inspect(reason)}"
+end
+
+{:ok, _} = Localize.Ecto.TestRepo.start_link()
+
 ExUnit.start()