add accounts doctests

lib/lokal/accounts/user.ex

@@ -9,6 +9,14 @@ defmodule Lokal.Accounts.User do
   alias Ecto.{Changeset, UUID}
   alias Lokal.{Accounts.User, Invites.Invite}
 
+  @derive {Jason.Encoder,
+           only: [
+             :id,
+             :email,
+             :confirmed_at,
+             :role,
+             :locale
+           ]}
   @derive {Inspect, except: [:password]}
   @primary_key {:id, :binary_id, autogenerate: true}
   @foreign_key_type :binary_id
@@ -31,14 +39,16 @@ defmodule Lokal.Accounts.User do
           password: String.t(),
           hashed_password: String.t(),
           confirmed_at: NaiveDateTime.t(),
-          role: atom(),
-          invites: [Invite.t()],
+          role: role(),
           locale: String.t() | nil,
+          invites: [Invite.t()],
           inserted_at: NaiveDateTime.t(),
           updated_at: NaiveDateTime.t()
         }
   @type new_user :: %User{}
   @type id :: UUID.t()
+  @type changeset :: Changeset.t(t() | new_user())
+  @type role :: :admin | :user
 
   @doc """
   A user changeset for registration.
@@ -57,26 +67,24 @@ defmodule Lokal.Accounts.User do
       validations on a LiveView form), this option can be set to `false`.
       Defaults to `true`.
   """
-  @spec registration_changeset(t() | new_user(), attrs :: map()) :: Changeset.t(t() | new_user())
-  @spec registration_changeset(t() | new_user(), attrs :: map(), opts :: keyword()) ::
-          Changeset.t(t() | new_user())
-  def registration_changeset(user, attrs, opts \\ []) do
-    user
-    |> cast(attrs, [:email, :password, :role, :locale])
+  @spec registration_changeset(attrs :: map()) :: changeset()
+  @spec registration_changeset(attrs :: map(), opts :: keyword()) :: changeset()
+  def registration_changeset(attrs, opts \\ []) do
+    %User{}
+    |> cast(attrs, [:email, :password, :locale])
     |> validate_email()
     |> validate_password(opts)
   end
 
   @doc """
   A user changeset for role.
-
   """
-  @spec role_changeset(t(), role :: atom()) :: Changeset.t(t())
+  @spec role_changeset(t() | new_user() | changeset(), role()) :: changeset()
   def role_changeset(user, role) do
-    user |> cast(%{"role" => role}, [:role])
+    user |> change(role: role)
   end
 
-  @spec validate_email(Changeset.t(t() | new_user())) :: Changeset.t(t() | new_user())
+  @spec validate_email(changeset()) :: changeset()
   defp validate_email(changeset) do
     changeset
     |> validate_required([:email])
@@ -88,8 +96,8 @@ defmodule Lokal.Accounts.User do
     |> unique_constraint(:email)
   end
 
-  @spec validate_password(Changeset.t(t() | new_user()), opts :: keyword()) ::
-          Changeset.t(t() | new_user())
+  @spec validate_password(changeset(), opts :: keyword()) ::
+          changeset()
   defp validate_password(changeset, opts) do
     changeset
     |> validate_required([:password])
@@ -100,8 +108,7 @@ defmodule Lokal.Accounts.User do
     |> maybe_hash_password(opts)
   end
 
-  @spec maybe_hash_password(Changeset.t(t() | new_user()), opts :: keyword()) ::
-          Changeset.t(t() | new_user())
+  @spec maybe_hash_password(changeset(), opts :: keyword()) :: changeset()
   defp maybe_hash_password(changeset, opts) do
     hash_password? = Keyword.get(opts, :hash_password, true)
     password = get_change(changeset, :password)
@@ -120,7 +127,7 @@ defmodule Lokal.Accounts.User do
 
   It requires the email to change otherwise an error is added.
   """
-  @spec email_changeset(t(), attrs :: map()) :: Changeset.t(t())
+  @spec email_changeset(t(), attrs :: map()) :: changeset()
   def email_changeset(user, attrs) do
     user
     |> cast(attrs, [:email])
@@ -143,8 +150,8 @@ defmodule Lokal.Accounts.User do
       validations on a LiveView form), this option can be set to `false`.
       Defaults to `true`.
   """
-  @spec password_changeset(t(), attrs :: map()) :: Changeset.t(t())
-  @spec password_changeset(t(), attrs :: map(), opts :: keyword()) :: Changeset.t(t())
+  @spec password_changeset(t(), attrs :: map()) :: changeset()
+  @spec password_changeset(t(), attrs :: map(), opts :: keyword()) :: changeset()
   def password_changeset(user, attrs, opts \\ []) do
     user
     |> cast(attrs, [:password])
@@ -155,7 +162,7 @@ defmodule Lokal.Accounts.User do
   @doc """
   Confirms the account by setting `confirmed_at`.
   """
-  @spec confirm_changeset(t() | Changeset.t(t())) :: Changeset.t(t())
+  @spec confirm_changeset(t() | changeset()) :: changeset()
   def confirm_changeset(user_or_changeset) do
     now = NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)
     user_or_changeset |> change(confirmed_at: now)
@@ -173,7 +180,7 @@ defmodule Lokal.Accounts.User do
     Bcrypt.verify_pass(password, hashed_password)
   end
 
-  def valid_password?(_, _) do
+  def valid_password?(_invalid_user, _invalid_password) do
     Bcrypt.no_user_verify()
     false
   end
@@ -181,7 +188,7 @@ defmodule Lokal.Accounts.User do
   @doc """
   Validates the current password otherwise adds an error to the changeset.
   """
-  @spec validate_current_password(Changeset.t(t()), String.t()) :: Changeset.t(t())
+  @spec validate_current_password(changeset(), String.t()) :: changeset()
   def validate_current_password(changeset, password) do
     if valid_password?(changeset.data, password),
       do: changeset,
@@ -191,7 +198,7 @@ defmodule Lokal.Accounts.User do
   @doc """
   A changeset for changing the user's locale
   """
-  @spec locale_changeset(t() | Changeset.t(t()), locale :: String.t() | nil) :: Changeset.t(t())
+  @spec locale_changeset(t() | changeset(), locale :: String.t() | nil) :: changeset()
   def locale_changeset(user_or_changeset, locale) do
     user_or_changeset
     |> cast(%{"locale" => locale}, [:locale])