Merge pull request #51 from bitcrowd/allow-integer-pks-for-repo-fetch

Allow integer PKs in Repo.fetch/2

CHANGELOG.md

@@ -1,5 +1,11 @@
 <!-- SPDX-License-Identifier: Apache-2.0 -->
 
+## Unreleased
+
+### Fixed
+
+* Allow any type of `id` param in `Repo.fetch/2`. Remove the (incorrect) guard restricting the `id` param to binaries, against the spec saying it would allow `any`.
+
 ## [0.16.0] - 2023-03-21
 
 ### Added

lib/bitcrowd_ecto/repo.ex

@@ -156,7 +156,7 @@ defmodule BitcrowdEcto.Repo do
       @behaviour BER
 
       @impl BER
-      def fetch(module, id, opts \\ []) when is_atom(module) and is_binary(id) do
+      def fetch(module, id, opts \\ []) when is_atom(module) do
         BER.fetch(__MODULE__, module, id, opts)
       end
 

test/bitcrowd_ecto/repo_test.exs

@@ -41,6 +41,11 @@ defmodule BitcrowdEcto.RepoTest do
     test "converts CastErrors to not_found errors" do
       assert TestRepo.fetch(TestSchema, "doesnotcast") == {:error, {:not_found, TestSchema}}
     end
+
+    test "handles any type of primary key (serial, uuid, etc)" do
+      resource = insert(:serial_primary_key_test_schema)
+      assert TestRepo.fetch(SerialPrimaryKeyTestSchema, resource.id) == {:ok, resource}
+    end
   end
 
   describe "fetch/2 with schemas with non-standard primary key" do

test/support/factory.ex

@@ -17,4 +17,8 @@ defmodule BitcrowdEcto.Factory do
       name: sequence("name")
     }
   end
+
+  def serial_primary_key_test_schema_factory do
+    %BitcrowdEcto.SerialPrimaryKeyTestSchema{}
+  end
 end

test/support/serial_primary_key_test_schema.ex

@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: Apache-2.0
+
+defmodule BitcrowdEcto.SerialPrimaryKeyTestSchema do
+  @moduledoc false
+
+  use BitcrowdEcto.Schema
+
+  schema "serial_primary_key_test_schema" do
+  end
+end

test/support/test_case.ex

@@ -17,6 +17,7 @@ defmodule BitcrowdEcto.TestCase do
 
       alias BitcrowdEcto.{
         AlternativePrimaryKeyTestSchema,
+        SerialPrimaryKeyTestSchema,
         TestRepo,
         TestSchema,
         TestSchemaWithPrefix

test/support/test_repo/migrations/20230904120000_create_serial_primary_key_test_schema.exs

@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: Apache-2.0
+
+defmodule BitcrowdEcto.TestRepo.Migrations.CreateSerialPrimaryKeyTestSchema do
+  use Ecto.Migration
+
+  def change do
+    create table(:serial_primary_key_test_schema) do
+    end
+  end
+end