Adds credo and adds a check to the workflow

Author: warmwaffles

.github/workflows/ci.yml

@@ -31,6 +31,7 @@ jobs:
       - run: mix deps.compile
       - run: mix format --check-formatted
       - run: mix deps.unlock --check-unused
+      - run: mix credo --all
 
   test:
     runs-on: ${{ matrix.os }}

lib/exqlite.ex

@@ -1,2 +1,3 @@
 defmodule Exqlite do
+  @moduledoc false
 end

lib/exqlite/basic.ex

@@ -13,15 +13,14 @@ defmodule Exqlite.Basic do
     Connection.connect(database: path)
   end
 
-  def close(conn = %Connection{}) do
-    with :ok <- Sqlite3.close(conn.db) do
-      :ok
-    else
+  def close(%Connection{} = conn) do
+    case Sqlite3.close(conn.db) do
+      :ok -> :ok
       {:error, reason} -> {:error, %Error{message: reason}}
     end
   end
 
-  def exec(conn = %Connection{}, stmt, args \\ []) do
+  def exec(%Connection{} = conn, stmt, args \\ []) do
     %Query{statement: stmt} |> Connection.handle_execute(args, [], conn)
   end
 

lib/exqlite/connection.ex

@@ -127,9 +127,8 @@ defmodule Exqlite.Connection do
 
   @impl true
   def disconnect(_err, %__MODULE__{db: db}) do
-    with :ok <- Sqlite3.close(db) do
-      :ok
-    else
+    case Sqlite3.close(db) do
+      :ok -> :ok
       {:error, reason} -> {:error, %Error{message: reason}}
     end
   end
@@ -173,7 +172,7 @@ defmodule Exqlite.Connection do
   """
   @impl true
   def handle_begin(options, %{transaction_status: transaction_status} = state) do
-    # TODO: This doesn't handle more than 2 levels of transactions.
+    # This doesn't handle more than 2 levels of transactions.
     #
     # One possible solution would be to just track the number of open
     # transactions and use that for driving the transaction status being idle or

lib/exqlite/query.ex

@@ -53,25 +53,6 @@ defmodule Exqlite.Query do
       query
     end
 
-    # TODO: See also Connection.bind/3
-    #
-    # def encode(%{ref: nil} = query, _params, _opts) do
-    #   raise ArgumentError, "query #{inspect(query)} has not been prepared"
-    # end
-    #
-    # def encode(%{num_params: nil} = query, _params, _opts) do
-    #   raise ArgumentError, "query #{inspect(query)} has not been prepared"
-    # end
-    #
-    # def encode(%{num_params: num_params} = query, params, _opts)
-    #     when num_params != length(params) do
-    #   message =
-    #     "expected params count: #{inspect(num_params)}, got values: #{inspect(params)}" <>
-    #       " for query: #{inspect(query)}"
-    #
-    #   raise ArgumentError, message
-    # end
-
     def encode(_query, params, _opts) do
       params
     end

lib/exqlite/result.ex

@@ -1,4 +1,6 @@
 defmodule Exqlite.Result do
+  @moduledoc false
+
   @type t :: %__MODULE__{
           command: atom,
           columns: [String.t()] | nil,

lib/exqlite/sqlite3.ex

@@ -3,16 +3,14 @@ defmodule Exqlite.Sqlite3 do
   The interface to the NIF implementation.
   """
 
+  # If the database reference is closed, any prepared statements should be
+  # dereferenced as well. It is entirely possible that an application does
+  # not properly remove a stale reference.
   #
-  # TODO: If the database reference is closed, any prepared statements should be
-  #       dereferenced as well. It is entirely possible that an application does
-  #       not properly remove a stale reference.
-  #
-  #       Will need to add a test for this and think of possible solution.
-  #
+  # Will need to add a test for this and think of possible solution.
 
-  # TODO: Need to figure out if we can just stream results where we use this
-  #       module as a sink.
+  # Need to figure out if we can just stream results where we use this
+  # module as a sink.
 
   alias Exqlite.Sqlite3NIF
 
@@ -125,8 +123,8 @@ defmodule Exqlite.Sqlite3 do
 
   @spec fetch_all(db(), statement()) :: {:ok, [row()]} | {:error, reason()}
   def fetch_all(conn, statement) do
-    # TODO: Should this be done in the NIF? It can be _much_ faster to build a
-    # list there, but at the expense that it could block other dirty nifs from
+    # Should this be done in the NIF? It can be _much_ faster to build a list
+    # there, but at the expense that it could block other dirty nifs from
     # getting work done.
     #
     # For now this just works
@@ -159,7 +157,8 @@ defmodule Exqlite.Sqlite3 do
   end
 
   @doc """
-  Disconnect from database and then reopen as an in-memory database based on the serialized binary.
+  Disconnect from database and then reopen as an in-memory database based on
+  the serialized binary.
   """
   @spec deserialize(db(), String.t(), binary()) :: :ok | {:error, reason()}
   def deserialize(conn, database \\ "main", serialized) do

lib/exqlite/sqlite3_nif.ex

@@ -64,5 +64,5 @@ defmodule Exqlite.Sqlite3NIF do
   @spec enable_load_extension(db(), integer()) :: :ok | {:error, reason()}
   def enable_load_extension(_conn, _flag), do: :erlang.nif_error(:not_loaded)
 
-  # TODO: add statement inspection tooling https://sqlite.org/c3ref/expanded_sql.html
+  # add statement inspection tooling https://sqlite.org/c3ref/expanded_sql.html
 end

lib/exqlite/stream.ex

@@ -5,7 +5,7 @@ defmodule Exqlite.Stream do
 
   defimpl Enumerable do
     def reduce(%Exqlite.Stream{query: %Exqlite.Query{} = query} = stream, acc, fun) do
-      # TODO: Possibly need to pass a chunk size option along so that we can let
+      # Possibly need to pass a chunk size option along so that we can let
       # the NIF chunk it.
       %Exqlite.Stream{conn: conn, params: params, options: opts} = stream
 

mix.exs

@@ -40,7 +40,8 @@ defmodule Exqlite.MixProject do
       {:ex_sqlean, "~> 0.8.5", only: [:dev, :test]},
       {:elixir_make, "~> 0.6", runtime: false},
       {:ex_doc, "~> 0.27", only: :dev, runtime: false},
-      {:temp, "~> 0.4", only: [:dev, :test]}
+      {:temp, "~> 0.4", only: [:dev, :test]},
+      {:credo, "~> 1.6", only: [:dev, :test], runtime: false}
     ]
   end
 
@@ -63,7 +64,8 @@ defmodule Exqlite.MixProject do
       name: "exqlite",
       licenses: ["MIT"],
       links: %{
-        "GitHub" => "https://github.com/elixir-sqlite/exqlite"
+        "GitHub" => "https://github.com/elixir-sqlite/exqlite",
+        "Changelog" => "https://github.com/elixir-sqlite/exqlite/blob/main/CHANGELOG.md"
       }
     ]
   end