feat: Generate Transcriptions context and schema

lib/medical_transcription/transcriptions.ex

@@ -0,0 +1,104 @@
+defmodule MedicalTranscription.Transcriptions do
+  @moduledoc """
+  The Transcriptions context.
+  """
+
+  import Ecto.Query, warn: false
+  alias MedicalTranscription.Repo
+
+  alias MedicalTranscription.Transcriptions.Transcription
+
+  @doc """
+  Returns the list of transcriptions.
+
+  ## Examples
+
+      iex> list_transcriptions()
+      [%Transcription{}, ...]
+
+  """
+  def list_transcriptions do
+    Repo.all(Transcription)
+  end
+
+  @doc """
+  Gets a single transcription.
+
+  Raises `Ecto.NoResultsError` if the Transcription does not exist.
+
+  ## Examples
+
+      iex> get_transcription!(123)
+      %Transcription{}
+
+      iex> get_transcription!(456)
+      ** (Ecto.NoResultsError)
+
+  """
+  def get_transcription!(id), do: Repo.get!(Transcription, id)
+
+  @doc """
+  Creates a transcription.
+
+  ## Examples
+
+      iex> create_transcription(%{field: value})
+      {:ok, %Transcription{}}
+
+      iex> create_transcription(%{field: bad_value})
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def create_transcription(attrs \\ %{}) do
+    %Transcription{}
+    |> Transcription.changeset(attrs)
+    |> Repo.insert()
+  end
+
+  @doc """
+  Updates a transcription.
+
+  ## Examples
+
+      iex> update_transcription(transcription, %{field: new_value})
+      {:ok, %Transcription{}}
+
+      iex> update_transcription(transcription, %{field: bad_value})
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def update_transcription(%Transcription{} = transcription, attrs) do
+    transcription
+    |> Transcription.changeset(attrs)
+    |> Repo.update()
+  end
+
+  @doc """
+  Deletes a transcription.
+
+  ## Examples
+
+      iex> delete_transcription(transcription)
+      {:ok, %Transcription{}}
+
+      iex> delete_transcription(transcription)
+      {:error, %Ecto.Changeset{}}
+
+  """
+  def delete_transcription(%Transcription{} = transcription) do
+    Repo.delete(transcription)
+  end
+
+  @doc """
+  Returns an `%Ecto.Changeset{}` for tracking transcription changes.
+
+  ## Examples
+
+      iex> change_transcription(transcription)
+      %Ecto.Changeset{data: %Transcription{}}
+
+  """
+  def change_transcription(%Transcription{} = transcription, attrs \\ %{}) do
+    Transcription.changeset(transcription, attrs)
+  end
+end

lib/medical_transcription/transcriptions/transcription.ex

@@ -0,0 +1,26 @@
+defmodule MedicalTranscription.Transcriptions.Transcription do
+  @moduledoc """
+  Transcription schema
+  """
+
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  @primary_key {:id, :binary_id, autogenerate: true}
+  @foreign_key_type :binary_id
+  schema "transcriptions" do
+    field :filename, :string
+    field :recording_length_in_seconds, :integer
+
+    belongs_to :user, MedicalTranscription.Accounts.User
+
+    timestamps(type: :utc_datetime)
+  end
+
+  @doc false
+  def changeset(transcription, attrs) do
+    transcription
+    |> cast(attrs, [:user_id, :filename, :recording_length_in_seconds])
+    |> validate_required([:user_id, :filename])
+  end
+end

priv/repo/migrations/20240202211853_create_transcriptions.exs

@@ -0,0 +1,14 @@
+defmodule MedicalTranscription.Repo.Migrations.CreateTranscriptions do
+  use Ecto.Migration
+
+  def change do
+    create table(:transcriptions, primary_key: false) do
+      add :id, :binary_id, primary_key: true
+      add :filename, :string, null: false
+      add :recording_length_in_seconds, :integer, null: true
+      add :user_id, references(:users, type: :binary_id, on_delete: :delete_all), null: false
+
+      timestamps(type: :utc_datetime)
+    end
+  end
+end

test/medical_transcription/transcriptions_test.exs

@@ -0,0 +1,78 @@
+defmodule MedicalTranscription.TranscriptionsTest do
+  use MedicalTranscription.DataCase
+
+  alias MedicalTranscription.Transcriptions
+
+  describe "transcriptions" do
+    alias MedicalTranscription.Transcriptions.Transcription
+
+    import MedicalTranscription.TranscriptionsFixtures
+    import MedicalTranscription.AccountsFixtures
+
+    @invalid_attrs %{filename: nil, recording_length_in_seconds: nil}
+
+    test "list_transcriptions/0 returns all transcriptions" do
+      transcription = transcription_fixture()
+      assert Transcriptions.list_transcriptions() == [transcription]
+    end
+
+    test "get_transcription!/1 returns the transcription with given id" do
+      transcription = transcription_fixture()
+      assert Transcriptions.get_transcription!(transcription.id) == transcription
+    end
+
+    test "create_transcription/1 with valid data creates a transcription" do
+      user = user_fixture()
+
+      valid_attrs = %{
+        user_id: user.id,
+        filename: "some filename",
+        recording_length_in_seconds: 42
+      }
+
+      assert {:ok, %Transcription{} = transcription} =
+               Transcriptions.create_transcription(valid_attrs)
+
+      assert transcription.filename == "some filename"
+      assert transcription.recording_length_in_seconds == 42
+    end
+
+    test "create_transcription/1 with invalid data returns error changeset" do
+      assert {:error, %Ecto.Changeset{}} = Transcriptions.create_transcription(@invalid_attrs)
+    end
+
+    test "update_transcription/2 with valid data updates the transcription" do
+      transcription = transcription_fixture()
+      update_attrs = %{filename: "some updated filename", recording_length_in_seconds: 43}
+
+      assert {:ok, %Transcription{} = transcription} =
+               Transcriptions.update_transcription(transcription, update_attrs)
+
+      assert transcription.filename == "some updated filename"
+      assert transcription.recording_length_in_seconds == 43
+    end
+
+    test "update_transcription/2 with invalid data returns error changeset" do
+      transcription = transcription_fixture()
+
+      assert {:error, %Ecto.Changeset{}} =
+               Transcriptions.update_transcription(transcription, @invalid_attrs)
+
+      assert transcription == Transcriptions.get_transcription!(transcription.id)
+    end
+
+    test "delete_transcription/1 deletes the transcription" do
+      transcription = transcription_fixture()
+      assert {:ok, %Transcription{}} = Transcriptions.delete_transcription(transcription)
+
+      assert_raise Ecto.NoResultsError, fn ->
+        Transcriptions.get_transcription!(transcription.id)
+      end
+    end
+
+    test "change_transcription/1 returns a transcription changeset" do
+      transcription = transcription_fixture()
+      assert %Ecto.Changeset{} = Transcriptions.change_transcription(transcription)
+    end
+  end
+end

test/support/fixtures/transcriptions_fixtures.ex

@@ -0,0 +1,31 @@
+defmodule MedicalTranscription.TranscriptionsFixtures do
+  @moduledoc """
+  This module defines test helpers for creating
+  entities via the `MedicalTranscription.Transcriptions` context.
+  """
+
+  import MedicalTranscription.AccountsFixtures
+
+  @doc """
+  Generate a transcription.
+  """
+  def transcription_fixture(attrs \\ %{}) do
+    user_id =
+      cond do
+        Map.has_key?(attrs, :user_id) -> attrs.user_id
+        Map.has_key?(attrs, :user) -> attrs.user.id
+        true -> user_fixture().id
+      end
+
+    {:ok, transcription} =
+      attrs
+      |> Enum.into(%{
+        user_id: user_id,
+        filename: "some filename",
+        recording_length_in_seconds: 42
+      })
+      |> MedicalTranscription.Transcriptions.create_transcription()
+
+    transcription
+  end
+end