chore: apply credo suggestions (#3)

Mainly add module docs and fix some aliases.

lib/wabanex/exercise.ex

@@ -1,4 +1,7 @@
 defmodule Wabanex.Exercise do
+  @moduledoc """
+  Schema of a exercise contained within a training.
+  """
   use Ecto.Schema
 
   import Ecto.Changeset

lib/wabanex/imc.ex

@@ -1,4 +1,8 @@
 defmodule Wabanex.IMC do
+  @moduledoc """
+  Body mass index calculation
+  """
+
   def calculate(%{"filename" => filename}) do
     filename
     |> File.read()
@@ -7,11 +11,7 @@ defmodule Wabanex.IMC do
 
   defp handle_file({:ok, content}) do
     data =
-      content
-      |> String.trim()
-      |> String.split("\n")
-      |> Enum.map(&parse_line/1)
-      |> Enum.into(%{})
+      content |> String.trim() |> String.split("\n") |> Enum.map(&parse_line/1) |> Enum.into(%{})
 
     {:ok, data}
   end

lib/wabanex/training.ex

@@ -1,4 +1,7 @@
 defmodule Wabanex.Training do
+  @moduledoc """
+  Schema of a training routine for a given period of time.
+  """
   use Ecto.Schema
 
   import Ecto.Changeset

lib/wabanex/trainings/create.ex

@@ -1,5 +1,8 @@
 defmodule Wabanex.Trainings.Create do
-  alias Wabanex.{Training, Repo}
+  @moduledoc """
+  Context to create a training routine.
+  """
+  alias Wabanex.{Repo, Training}
 
   def call(params) do
     params

lib/wabanex/user.ex

@@ -1,4 +1,7 @@
 defmodule Wabanex.User do
+  @moduledoc """
+  Schema of a user in the system.
+  """
   use Ecto.Schema
 
   import Ecto.Changeset

lib/wabanex/users/create.ex

@@ -1,4 +1,7 @@
 defmodule Wabanex.Users.Create do
+  @moduledoc """
+  Context for user creation.
+  """
   alias Wabanex.{Repo, User}
 
   def call(params) do

lib/wabanex/users/get.ex

@@ -1,4 +1,7 @@
 defmodule Wabanex.Users.Get do
+  @moduledoc """
+  Context to fetch a given user and its current training.
+  """
   import Ecto.Query
 
   alias Wabanex.{Repo, Training, User}

lib/wabanex_web/resolvers/training.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Resolvers.Training do
+  @moduledoc """
+  GraphQL resolver for training operations.
+  """
   alias Wabanex.Trainings
 
   def create(%{input: params}, _context), do: Trainings.Create.call(params)

lib/wabanex_web/resolvers/user.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Resolvers.User do
+  @moduledoc """
+  GraphQL resolver for user operations.
+  """
   alias Wabanex.Users
 
   def get(%{id: user_id}, _context), do: Users.Get.call(user_id)

lib/wabanex_web/schema.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Schema do
+  @moduledoc """
+  GraphQL schema definition
+  """
   use Absinthe.Schema
 
   import_types WabanexWeb.Schema.Types.Root

lib/wabanex_web/schema/types/custom/date_range.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Schema.Types.Custom.DateRange do
+  @moduledoc """
+  Graphql date range custom type.
+  """
   use Absinthe.Schema.Notation
 
   alias Absinthe.Blueprint.Input

lib/wabanex_web/schema/types/custom/uuid4.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Schema.Types.Custom.UUID4 do
+  @moduledoc """
+  GraphQL uuid v4 custom type.
+  """
   use Absinthe.Schema.Notation
 
   alias Ecto.UUID

lib/wabanex_web/schema/types/exercise.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Schema.Types.Exercise do
+  @moduledoc """
+  GraphQL exercise type definition.
+  """
   use Absinthe.Schema.Notation
 
   @desc "Logic exercise representation"

lib/wabanex_web/schema/types/root.ex

@@ -1,10 +1,13 @@
 defmodule WabanexWeb.Schema.Types.Root do
+  @moduledoc """
+  GraphQL root query/mutation aggregator.
+  """
   use Absinthe.Schema.Notation
 
   alias Crudry.Middlewares.TranslateErrors
 
-  alias WabanexWeb.Resolvers.User, as: UserResolver
   alias WabanexWeb.Resolvers.Training, as: TrainingResolver
+  alias WabanexWeb.Resolvers.User, as: UserResolver
   alias WabanexWeb.Schema.Types
 
   import_types Types.Custom.UUID4

lib/wabanex_web/schema/types/training.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Schema.Types.Training do
+  @moduledoc """
+  GraphQL training type definition.
+  """
   use Absinthe.Schema.Notation
 
   import_types WabanexWeb.Schema.Types.Custom.DateRange

lib/wabanex_web/schema/types/user.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Schema.Types.User do
+  @moduledoc """
+  GraphQL user type definition.
+  """
   use Absinthe.Schema.Notation
 
   @desc "Logic user representation"

lib/wabanex_web/telemetry.ex

@@ -1,4 +1,7 @@
 defmodule WabanexWeb.Telemetry do
+  @moduledoc """
+  Telemetry implementation
+  """
   use Supervisor
   import Telemetry.Metrics
 

test/support/channel_case.ex

@@ -17,6 +17,8 @@ defmodule WabanexWeb.ChannelCase do
 
   use ExUnit.CaseTemplate
 
+  alias Ecto.Adapters.SQL.Sandbox
+
   using do
     quote do
       # Import conveniences for testing with channels
@@ -29,10 +31,10 @@ defmodule WabanexWeb.ChannelCase do
   end
 
   setup tags do
-    :ok = Ecto.Adapters.SQL.Sandbox.checkout(Wabanex.Repo)
+    :ok = Sandbox.checkout(Wabanex.Repo)
 
     unless tags[:async] do
-      Ecto.Adapters.SQL.Sandbox.mode(Wabanex.Repo, {:shared, self()})
+      Sandbox.mode(Wabanex.Repo, {:shared, self()})
     end
 
     :ok

test/support/conn_case.ex

@@ -17,6 +17,8 @@ defmodule WabanexWeb.ConnCase do
 
   use ExUnit.CaseTemplate
 
+  alias Ecto.Adapters.SQL.Sandbox
+
   using do
     quote do
       # Import conveniences for testing with connections
@@ -32,10 +34,10 @@ defmodule WabanexWeb.ConnCase do
   end
 
   setup tags do
-    :ok = Ecto.Adapters.SQL.Sandbox.checkout(Wabanex.Repo)
+    :ok = Sandbox.checkout(Wabanex.Repo)
 
     unless tags[:async] do
-      Ecto.Adapters.SQL.Sandbox.mode(Wabanex.Repo, {:shared, self()})
+      Sandbox.mode(Wabanex.Repo, {:shared, self()})
     end
 
     {:ok, conn: Phoenix.ConnTest.build_conn()}

test/support/data_case.ex

@@ -16,6 +16,8 @@ defmodule Wabanex.DataCase do
 
   use ExUnit.CaseTemplate
 
+  alias Ecto.Adapters.SQL.Sandbox
+
   using do
     quote do
       alias Wabanex.Repo
@@ -28,10 +30,10 @@ defmodule Wabanex.DataCase do
   end
 
   setup tags do
-    :ok = Ecto.Adapters.SQL.Sandbox.checkout(Wabanex.Repo)
+    :ok = Sandbox.checkout(Wabanex.Repo)
 
     unless tags[:async] do
-      Ecto.Adapters.SQL.Sandbox.mode(Wabanex.Repo, {:shared, self()})
+      Sandbox.mode(Wabanex.Repo, {:shared, self()})
     end
 
     :ok