Added schema and context for app notifications

.formatter.exs

@@ -1,3 +1,5 @@
+# TODO: figure out why my vscode extension doesn't respect the formatter.exs file
+# if it's in a subdirectory
 [
   import_deps: [:ecto, :ecto_sql, :phoenix],
   subdirectories: ["priv/*/migrations"],

lib/pinchflat/platform/app_notification.ex

@@ -0,0 +1,38 @@
+defmodule Pinchflat.Platform.AppNotification do
+  @moduledoc """
+  The AppNotification schema.
+  """
+
+  use Ecto.Schema
+  import Ecto.Changeset
+
+  @allowed_fields ~w(
+    uuid
+    title
+    body
+    severity
+    notification_date
+    read_at
+  )a
+
+  @required_fields ~w(uuid title severity notification_date)a
+
+  schema "app_notifications" do
+    # NOTE: this is _not_ used as a primary key, but as a unique identifier for all installations
+    field :uuid, Ecto.UUID
+    field :title, :string
+    field :body, :string
+    field :severity, Ecto.Enum, values: Logger.levels()
+    field :notification_date, :date
+    field :read_at, :naive_datetime
+
+    timestamps(type: :utc_datetime)
+  end
+
+  @doc false
+  def changeset(app_notification, attrs) do
+    app_notification
+    |> cast(attrs, @allowed_fields)
+    |> validate_required(@required_fields)
+  end
+end

lib/pinchflat/platform/platform.ex

@@ -0,0 +1,37 @@
+defmodule Pinchflat.Platform do
+  @moduledoc """
+  The Platform context.
+  """
+
+  import Ecto.Query, warn: false
+  alias Pinchflat.Repo
+
+  alias Pinchflat.Platform.AppNotification
+
+  @doc """
+  Returns the list of app_notifications.
+
+  Returns [%AppNotification{}, ...]
+  """
+  def list_app_notifications do
+    Repo.all(AppNotification)
+  end
+
+  @doc """
+  Creates a app_notification.
+
+  Returns {:ok, %AppNotification{}} | {:error, %Ecto.Changeset{}}
+  """
+  def create_app_notification(attrs \\ %{}) do
+    %AppNotification{}
+    |> AppNotification.changeset(attrs)
+    |> Repo.insert()
+  end
+
+  @doc """
+  Returns `%Ecto.Changeset{}`
+  """
+  def change_app_notification(%AppNotification{} = app_notification, attrs \\ %{}) do
+    AppNotification.changeset(app_notification, attrs)
+  end
+end

mix.exs

@@ -88,7 +88,6 @@ defmodule Pinchflat.MixProject do
   # See the documentation for `Mix` for more info on aliases.
   defp aliases do
     [
-      format: "format --dot-formatter=tooling/.formatter.exs",
       check: "check --config=tooling/.check.exs",
       credo: "credo --config-file=tooling/.credo.exs",
       setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],

priv/notifications.json

@@ -1,6 +1,6 @@
 [
   {
-    "id": "36cd0f0c-89bf-4284-bf1c-0bc5b39e6dfe",
+    "uuid": "36cd0f0c-89bf-4284-bf1c-0bc5b39e6dfe",
     "title": "`yt-dlp` recommends disabling YouTube Cookie auth",
     "body": "`yt-dlp` has discovered an increased rate of IP bans for users who use YouTube Cookie auth. It is recommended to remove the contents of `/config/extras/cookies.txt`.",
     "severity": "alert",

priv/repo/migrations/20240617182932_create_app_notifications.exs

@@ -0,0 +1,18 @@
+defmodule Pinchflat.Repo.Migrations.CreateAppNotifications do
+  use Ecto.Migration
+
+  def change do
+    create table(:app_notifications) do
+      add :uuid, :string, null: false
+      add :title, :string, null: false
+      add :body, :string
+      add :severity, :string, null: false
+      add :notification_date, :date, null: false
+      add :read_at, :utc_datetime
+
+      timestamps(type: :utc_datetime)
+    end
+
+    create(unique_index(:app_notifications, [:uuid]))
+  end
+end

test/pinchflat/platform_test.exs

@@ -0,0 +1,48 @@
+defmodule Pinchflat.PlatformTest do
+  use Pinchflat.DataCase
+
+  import Pinchflat.PlatformFixtures
+
+  alias Pinchflat.Platform
+  alias Pinchflat.Platform.AppNotification
+
+  @invalid_attrs %{
+    title: nil,
+    severity: nil,
+    uuid: nil,
+    notification_date: nil
+  }
+
+  describe "list_app_notifications/0" do
+    test "returns all app_notifications" do
+      app_notification = app_notification_fixture()
+      assert Platform.list_app_notifications() == [app_notification]
+    end
+  end
+
+  describe "create_app_notification/1" do
+    test "creation with valid data creates an app_notification" do
+      valid_attrs = %{
+        title: "some title",
+        body: "some body",
+        severity: "info",
+        uuid: "a8a1f81b-1761-4b48-93e2-396a021c4ca6",
+        notification_date: "2024-06-10"
+      }
+
+      assert {:ok, %AppNotification{} = app_notification} = Platform.create_app_notification(valid_attrs)
+      assert app_notification.title == "some title"
+    end
+
+    test "creation with invalid data returns error changeset" do
+      assert {:error, %Ecto.Changeset{}} = Platform.create_app_notification(@invalid_attrs)
+    end
+  end
+
+  describe "change_app_notification/1" do
+    test "returns a app_notification changeset" do
+      app_notification = app_notification_fixture()
+      assert %Ecto.Changeset{} = Platform.change_app_notification(app_notification)
+    end
+  end
+end

test/support/fixtures/platform_fixtures.ex

@@ -0,0 +1,25 @@
+defmodule Pinchflat.PlatformFixtures do
+  @moduledoc """
+  This module defines test helpers for creating
+  entities via the `Pinchflat.Platform` context.
+  """
+
+  @doc """
+  Generate a app_notification.
+  """
+  def app_notification_fixture(attrs \\ %{}) do
+    {:ok, app_notification} =
+      attrs
+      |> Enum.into(%{
+        title: "a cool title",
+        body: "a cool notification",
+        notification_date: ~D[2020-01-01],
+        read_at: nil,
+        severity: :alert,
+        uuid: Ecto.UUID.generate()
+      })
+      |> Pinchflat.Platform.create_app_notification()
+
+    app_notification
+  end
+end