fix dialyzer, credo and format

lib/cannery/accounts/user_token.ex

@@ -1,7 +1,12 @@
 defmodule Cannery.Accounts.UserToken do
+  @moduledoc """
+  Schema for serialized user session and authentication tokens
+  """
+
   use Ecto.Schema
   import Ecto.Query
-  alias Cannery.{Accounts}
+  alias Ecto.{Query, UUID}
+  alias Cannery.{Accounts.User, Accounts.UserToken}
 
   @hash_algorithm :sha256
   @rand_size 32
@@ -19,19 +24,33 @@ defmodule Cannery.Accounts.UserToken do
     field :token, :binary
     field :context, :string
     field :sent_to, :string
-    belongs_to :user, Accounts.User
+
+    belongs_to :user, User
 
     timestamps(updated_at: false)
   end
 
+  @type t :: %UserToken{
+          id: UUID.t(),
+          token: String.t(),
+          context: String.t(),
+          sent_to: String.t(),
+          user: User.t(),
+          user_id: UUID.t(),
+          inserted_at: NaiveDateTime.t()
+        }
+
+  @type new_token :: %UserToken{}
+
   @doc """
   Generates a token that will be stored in a signed place,
   such as session or cookie. As they are signed, those
   tokens do not need to be hashed.
   """
-  def build_session_token(user) do
+  @spec build_session_token(User.t()) :: {token :: String.t(), UserToken.new_token()}
+  def build_session_token(%{id: user_id}) do
     token = :crypto.strong_rand_bytes(@rand_size)
-    {token, %Accounts.UserToken{token: token, context: "session", user_id: user.id}}
+    {token, %UserToken{token: token, context: "session", user_id: user_id}}
   end
 
   @doc """
@@ -39,6 +58,7 @@ defmodule Cannery.Accounts.UserToken do
 
   The query returns the user found by the token.
   """
+  @spec verify_session_token_query(String.t()) :: {:ok, Query.t()}
   def verify_session_token_query(token) do
     query =
       from token in token_and_context_query(token, "session"),
@@ -57,16 +77,19 @@ defmodule Cannery.Accounts.UserToken do
   The token is valid for a week as long as users don't change
   their email.
   """
+  @spec build_email_token(User.t(), String.t()) :: {String.t(), UserToken.new_token()}
   def build_email_token(user, context) do
     build_hashed_token(user, context, user.email)
   end
 
+  @spec build_hashed_token(User.t(), String.t(), String.t()) ::
+          {String.t(), UserToken.new_token()}
   defp build_hashed_token(user, context, sent_to) do
     token = :crypto.strong_rand_bytes(@rand_size)
     hashed_token = :crypto.hash(@hash_algorithm, token)
 
     {Base.url_encode64(token, padding: false),
-     %Accounts.UserToken{
+     %UserToken{
        token: hashed_token,
        context: context,
        sent_to: sent_to,
@@ -79,6 +102,7 @@ defmodule Cannery.Accounts.UserToken do
 
   The query returns the user found by the token.
   """
+  @spec verify_email_token_query(String.t(), String.t()) :: {:ok, Query.t()} | :error
   def verify_email_token_query(token, context) do
     case Base.url_decode64(token, padding: false) do
       {:ok, decoded_token} ->
@@ -98,6 +122,7 @@ defmodule Cannery.Accounts.UserToken do
     end
   end
 
+  @spec days_for_context(<<_::56>>) :: non_neg_integer()
   defp days_for_context("confirm"), do: @confirm_validity_in_days
   defp days_for_context("reset_password"), do: @reset_password_validity_in_days
 
@@ -106,6 +131,7 @@ defmodule Cannery.Accounts.UserToken do
 
   The query returns the user token record.
   """
+  @spec verify_change_email_token_query(String.t(), String.t()) :: {:ok, Query.t()} | :error
   def verify_change_email_token_query(token, context) do
     case Base.url_decode64(token, padding: false) do
       {:ok, decoded_token} ->
@@ -125,18 +151,20 @@ defmodule Cannery.Accounts.UserToken do
   @doc """
   Returns the given token with the given context.
   """
+  @spec token_and_context_query(String.t(), String.t()) :: Query.t()
+  @spec token_and_context_query(User.t(), :all | nonempty_maybe_improper_list()) :: Query.t()
   def token_and_context_query(token, context) do
-    from Accounts.UserToken, where: [token: ^token, context: ^context]
+    from UserToken, where: [token: ^token, context: ^context]
   end
 
   @doc """
   Gets all tokens for the given user for the given contexts.
   """
-  def user_and_contexts_query(user, :all) do
-    from t in Accounts.UserToken, where: t.user_id == ^user.id
+  def user_and_contexts_query(%{id: user_id}, :all) do
+    from t in UserToken, where: t.user_id == ^user_id
   end
 
-  def user_and_contexts_query(user, [_ | _] = contexts) do
-    from t in Accounts.UserToken, where: t.user_id == ^user.id and t.context in ^contexts
+  def user_and_contexts_query(%{id: user_id}, [_ | _] = contexts) do
+    from t in UserToken, where: t.user_id == ^user_id and t.context in ^contexts
   end
 end