Change is_decodable/1 to decodable?/1 (#138)

lib/avrora/codec.ex

@@ -10,11 +10,14 @@ defmodule Avrora.Codec do
 
   ## Examples
 
-      ...> Avrora.Codec.Plain.is_decodable(<<1, 2, 3>>)
+      ...> Avrora.Codec.Plain.decodable?(<<1, 2, 3>>)
       true
-      ...> Avrora.Codec.SchemaRegistry.is_decodable(<<1, 2, 3>>)
+      ...> Avrora.Codec.SchemaRegistry.decodable?(<<1, 2, 3>>)
       false
   """
+  @callback decodable?(payload :: binary()) :: boolean
+
+  @doc deprecated: "Use `Avrora.Codec.Plain.decodable?/1` instead."
   @callback is_decodable(payload :: binary()) :: boolean
 
   @doc """

lib/avrora/codec/object_container_file.ex

@@ -20,13 +20,22 @@ defmodule Avrora.Codec.ObjectContainerFile do
   alias Avrora.Schema.Encoder, as: SchemaEncoder
 
   @impl true
-  def is_decodable(payload) when is_binary(payload) do
+  def decodable?(payload) when is_binary(payload) do
     case payload do
       <<@magic_bytes, _::binary>> -> true
       _ -> false
     end
   end
 
+  @impl true
+  def is_decodable(payload) when is_binary(payload) do
+    Logger.warning(
+      "`Avrora.Codec.ObjectContainerFile.is_decodable/1` is deprecated, use `Avrora.Codec.ObjectContainerFile.decodable?/1` instead"
+    )
+
+    decodable?(payload)
+  end
+
   @impl true
   def extract_schema(payload) when is_binary(payload) do
     with {:ok, {headers, {_, _, _, _, _, _, full_name, _} = erlavro, _}} <- do_decode(payload),

lib/avrora/codec/plain.ex

@@ -8,11 +8,19 @@ defmodule Avrora.Codec.Plain do
 
   @behaviour Avrora.Codec
 
+  require Logger
   alias Avrora.AvroDecoderOptions
   alias Avrora.Resolver
 
   @impl true
-  def is_decodable(payload) when is_binary(payload), do: true
+  def decodable?(payload) when is_binary(payload), do: true
+
+  @impl true
+  def is_decodable(payload) when is_binary(payload) do
+    Logger.warning("`Avrora.Codec.Plain.is_decodable/1` is deprecated, use `Avrora.Codec.Plain.decodable?/1` instead")
+
+    decodable?(payload)
+  end
 
   @impl true
   def extract_schema(_payload), do: {:error, :schema_not_found}

lib/avrora/codec/schema_registry.ex

@@ -15,13 +15,22 @@ defmodule Avrora.Codec.SchemaRegistry do
   alias Avrora.Schema
 
   @impl true
-  def is_decodable(payload) when is_binary(payload) do
+  def decodable?(payload) when is_binary(payload) do
     case payload do
       <<@magic_bytes, _::binary>> -> true
       _ -> false
     end
   end
 
+  @impl true
+  def is_decodable(payload) when is_binary(payload) do
+    Logger.warning(
+      "`Avrora.Codec.SchemaRegistry.is_decodable/1` is deprecated, use `Avrora.Codec.SchemaRegistry.decodable?/1` instead"
+    )
+
+    decodable?(payload)
+  end
+
   @impl true
   def extract_schema(payload) when is_binary(payload) do
     case payload do

lib/avrora/encoder.ex

@@ -26,7 +26,7 @@ defmodule Avrora.Encoder do
   def extract_schema(payload) when is_binary(payload) do
     codec =
       [Codec.SchemaRegistry, Codec.ObjectContainerFile, Codec.Plain]
-      |> Enum.find(& &1.is_decodable(payload))
+      |> Enum.find(& &1.decodable?(payload))
 
     codec.extract_schema(payload)
   end
@@ -46,7 +46,7 @@ defmodule Avrora.Encoder do
   def decode(payload) when is_binary(payload) do
     codec =
       [Codec.SchemaRegistry, Codec.ObjectContainerFile, Codec.Plain]
-      |> Enum.find(& &1.is_decodable(payload))
+      |> Enum.find(& &1.decodable?(payload))
 
     codec.decode(payload)
   end
@@ -73,7 +73,7 @@ defmodule Avrora.Encoder do
 
       codec =
         [Codec.SchemaRegistry, Codec.ObjectContainerFile, Codec.Plain]
-        |> Enum.find(& &1.is_decodable(payload))
+        |> Enum.find(& &1.decodable?(payload))
 
       if codec == Codec.Plain do
         Logger.warning(

test/avrora/codec/object_container_file_test.exs

@@ -11,13 +11,13 @@ defmodule Avrora.Codec.ObjectContainerFileTest do
   setup :verify_on_exit!
   setup :support_config
 
-  describe "is_decodable/1" do
+  describe "decodable?/1" do
     test "when payload is a valid binary" do
-      assert Codec.ObjectContainerFile.is_decodable(payment_message())
+      assert Codec.ObjectContainerFile.decodable?(payment_message())
     end
 
     test "when payload is not a valid binary" do
-      refute Codec.ObjectContainerFile.is_decodable(<<0, 1, 2>>)
+      refute Codec.ObjectContainerFile.decodable?(<<0, 1, 2>>)
     end
   end
 

test/avrora/codec/plain_test.exs

@@ -10,13 +10,13 @@ defmodule Avrora.Codec.PlainTest do
   setup :verify_on_exit!
   setup :support_config
 
-  describe "is_decodable/1" do
+  describe "decodable?/1" do
     test "when payload is a valid binary" do
-      assert Codec.Plain.is_decodable(payment_message())
+      assert Codec.Plain.decodable?(payment_message())
     end
 
     test "when payload is not a valid binary" do
-      assert Codec.Plain.is_decodable(<<0, 1, 2>>)
+      assert Codec.Plain.decodable?(<<0, 1, 2>>)
     end
   end
 

test/avrora/codec/schema_registry_test.exs

@@ -11,13 +11,13 @@ defmodule Avrora.Codec.SchemaRegistryTest do
   setup :verify_on_exit!
   setup :support_config
 
-  describe "is_decodable/1" do
+  describe "decodable?/1" do
     test "when payload is a valid binary" do
-      assert Codec.SchemaRegistry.is_decodable(payment_message())
+      assert Codec.SchemaRegistry.decodable?(payment_message())
     end
 
     test "when payload is not a valid binary" do
-      assert Codec.SchemaRegistry.is_decodable(<<0, 1, 2>>)
+      assert Codec.SchemaRegistry.decodable?(<<0, 1, 2>>)
     end
   end