Introduction of the adapter pattern for flexible datasources

.credo.exs

@@ -15,9 +15,9 @@
       strict: true,
       parse_timeout: 5000,
       color: true,
-      checks: %{
-        disabled: []
-      }
+      checks: [
+        {Credo.Check.Design.TagTODO, false}
+      ]
     }
   ]
 }

.formatter.exs

@@ -5,10 +5,9 @@ locals_without_parens = [
 
 [
   line_length: 120,
-  import_deps: [:ecto, :phoenix],
+  import_deps: [:ecto, :phoenix, :ash, :ash_postgres],
   plugins: [TailwindFormatter, Phoenix.LiveView.HTMLFormatter],
   inputs: ["*.{heex,ex,exs}", "priv/*/seeds.exs", "{config,lib,test}/**/*.{heex,ex,exs}"],
-  subdirectories: ["priv/*/migrations"],
   locals_without_parens: locals_without_parens,
   export: [locals_without_parens: locals_without_parens]
 ]

demo/.formatter.exs

@@ -1,6 +1,7 @@
 [
   line_length: 120,
-  import_deps: [:ecto, :phoenix, :backpex],
+  import_deps: [:ecto, :phoenix, :backpex, :ash, :ash_postgres],
   plugins: [TailwindFormatter, Phoenix.LiveView.HTMLFormatter],
-  inputs: ["*.{heex,ex,exs}", "priv/*/seeds.exs", "{config,lib,test}/**/*.{heex,ex,exs}"]
+  inputs: ["*.{heex,ex,exs}", "priv/*/seeds.exs", "{config,lib,test}/**/*.{heex,ex,exs}"],
+  subdirectories: ["priv/*/migrations"]
 ]

demo/config/config.exs

@@ -2,7 +2,8 @@ import Config
 
 config :demo,
   namespace: Demo,
-  ecto_repos: [Demo.Repo],
+  ecto_repos: [Demo.Repo, Demo.RepoAsh],
+  ash_domains: [Demo.Helpdesk],
   generators: [binary_id: true]
 
 config :demo, DemoWeb.Endpoint,
@@ -48,6 +49,10 @@ config :phoenix, :json_library, Jason
 
 config :demo, DemoWeb.Gettext, default_locale: "en"
 
+config :ash, include_embedded_source_by_default?: false
+
+config :ash, :policies, no_filter_static_forbidden_reads?: false
+
 config :backpex, :translator_function, {DemoWeb.CoreComponents, :translate_backpex}
 
 config :backpex, :error_translator_function, {DemoWeb.CoreComponents, :translate_error}

demo/config/runtime.exs

@@ -1,6 +1,6 @@
 import Config
 import System, only: [get_env: 1, get_env: 2, fetch_env!: 1]
-import String, only: [to_integer: 1, to_atom: 1, to_existing_atom: 1, split: 2]
+import String, only: [to_integer: 1, to_atom: 1, to_existing_atom: 1]
 
 config :demo, analytics: get_env("ANALYTICS", "false") |> to_existing_atom()
 
@@ -12,6 +12,14 @@ config :demo, Demo.Repo,
   port: get_env("DB_PORT", "5432") |> to_integer(),
   pool_size: get_env("DB_POOL_SIZE", "5") |> to_integer()
 
+config :demo, Demo.RepoAsh,
+  hostname: get_env("DB_HOSTNAME", "postgres"),
+  username: get_env("DB_USERNAME", "postgres"),
+  password: get_env("DB_PASSWORD", "postgres"),
+  database: get_env("DB_DATABASE", "postgres"),
+  port: get_env("DB_PORT", "5432") |> to_integer(),
+  pool_size: get_env("DB_POOL_SIZE", "5") |> to_integer()
+
 config :demo, DemoWeb.Endpoint,
   http: [
     port: get_env("PORT", "4000") |> to_integer()

demo/lib/demo/application.ex

@@ -11,6 +11,7 @@ defmodule Demo.Application do
       {Cluster.Supervisor, [topologies, [name: Sourceboat.ClusterSupervisor]]},
       {Phoenix.PubSub, name: Demo.PubSub},
       Demo.Repo,
+      Demo.RepoAsh,
       DemoWeb.Telemetry,
       {DemoWeb.MetricsStorage, DemoWeb.Telemetry.metrics()},
       DemoWeb.Endpoint

demo/lib/demo/factory.ex

@@ -5,6 +5,7 @@ defmodule Demo.Factory do
 
   alias Demo.Address
   alias Demo.Category
+  alias Demo.Helpdesk.Ticket
   alias Demo.Post
   alias Demo.Product
   alias Demo.ShortLink
@@ -91,6 +92,13 @@ defmodule Demo.Factory do
     }
   end
 
+  def ticket_factory do
+    %Ticket{
+      subject: Faker.Lorem.sentence(),
+      body: Faker.Lorem.paragraph()
+    }
+  end
+
   defp boolean do
     Enum.random(0..1) == 1
   end

demo/lib/demo/helpdesk/ticket.ex

@@ -0,0 +1,24 @@
+defmodule Demo.Helpdesk.Ticket do
+  @moduledoc false
+
+  use Ash.Resource,
+    domain: Demo.Helpdesk,
+    data_layer: AshPostgres.DataLayer
+
+  postgres do
+    repo Demo.RepoAsh
+    table "tickets"
+  end
+
+  actions do
+    defaults [:read]
+  end
+
+  attributes do
+    uuid_primary_key :id
+    attribute :subject, :string, allow_nil?: false
+    attribute :body, :string, allow_nil?: false
+    create_timestamp :inserted_at
+    update_timestamp :updated_at
+  end
+end

demo/lib/demo/repo.ex

@@ -3,3 +3,11 @@ defmodule Demo.Repo do
     otp_app: :demo,
     adapter: Ecto.Adapters.Postgres
 end
+
+defmodule Demo.RepoAsh do
+  use AshPostgres.Repo, otp_app: :demo
+
+  def installed_extensions do
+    ["ash-functions"]
+  end
+end

demo/lib/demo/support.ex

@@ -0,0 +1,9 @@
+defmodule Demo.Helpdesk do
+  @moduledoc false
+
+  use Ash.Domain
+
+  resources do
+    resource Demo.Helpdesk.Ticket
+  end
+end

demo/lib/demo_web/components/layouts/admin.html.heex

@@ -84,6 +84,12 @@
         <Backpex.HTML.CoreComponents.icon name="hero-tag" class="h-5 w-5" /> Tags
       </Backpex.HTML.Layout.sidebar_item>
     </Backpex.HTML.Layout.sidebar_section>
+    <Backpex.HTML.Layout.sidebar_section id="helpdesk">
+      <:label>Helpdesk</:label>
+      <Backpex.HTML.Layout.sidebar_item current_url={@current_url} navigate="/admin/tickets">
+        <Backpex.HTML.CoreComponents.icon name="hero-book-open" class="h-5 w-5" /> Tickets
+      </Backpex.HTML.Layout.sidebar_item>
+    </Backpex.HTML.Layout.sidebar_section>
   </:sidebar>
   <Backpex.HTML.Layout.flash_messages flash={@flash} />
   <%= @inner_content %>

demo/lib/demo_web/item_actions/soft_delete.ex

@@ -63,10 +63,8 @@ defmodule DemoWeb.ItemActions.SoftDelete do
 
     socket =
       try do
-        %{assigns: %{repo: repo, schema: schema, pubsub: pubsub}} = socket
-
-        {:ok, _items} =
-          Backpex.Resource.update_all(items, repo, schema, [set: [deleted_at: datetime]], "deleted", pubsub)
+        updates = [set: [deleted_at: datetime]]
+        {:ok, _items} = Backpex.Resource.update_all(items, updates, "deleted", socket.assigns.live_resource)
 
         socket
         |> clear_flash()

demo/lib/demo_web/live/address_live.ex

@@ -1,13 +1,17 @@
 defmodule DemoWeb.AddressLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.Address,
+      repo: Demo.Repo,
+      update_changeset: &Demo.Address.update_changeset/3,
+      create_changeset: &Demo.Address.create_changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.Address,
-    repo: Demo.Repo,
-    update_changeset: &Demo.Address.update_changeset/3,
-    create_changeset: &Demo.Address.create_changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "addresses",
-    event_prefix: "address_",
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "addresses",
+      event_prefix: "address_"
+    ],
     fluid?: true
 
   @impl Backpex.LiveResource

demo/lib/demo_web/live/category_live.ex

@@ -1,13 +1,17 @@
 defmodule DemoWeb.CategoryLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.Category,
+      repo: Demo.Repo,
+      update_changeset: &Demo.Category.update_changeset/3,
+      create_changeset: &Demo.Category.create_changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.Category,
-    repo: Demo.Repo,
-    update_changeset: &Demo.Category.update_changeset/3,
-    create_changeset: &Demo.Category.create_changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "categories",
-    event_prefix: "category_"
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "categories",
+      event_prefix: "category_"
+    ]
 
   @impl Backpex.LiveResource
   def singular_name, do: "Category"

demo/lib/demo_web/live/film_review_live.ex

@@ -1,13 +1,17 @@
 defmodule DemoWeb.FilmReviewLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.FilmReview,
+      repo: Demo.Repo,
+      update_changeset: &Demo.FilmReview.update_changeset/3,
+      create_changeset: &Demo.FilmReview.create_changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.FilmReview,
-    repo: Demo.Repo,
-    update_changeset: &Demo.FilmReview.update_changeset/3,
-    create_changeset: &Demo.FilmReview.create_changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "film_reviews",
-    event_prefix: "film_reviews_",
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "film_reviews",
+      event_prefix: "film_reviews_"
+    ],
     full_text_search: :generated_tsvector
 
   @impl Backpex.LiveResource
@@ -19,7 +23,7 @@ defmodule DemoWeb.FilmReviewLive do
   @impl Backpex.LiveResource
   def render_resource_slot(assigns, :index, :before_page_title) do
     ~H"""
-    <div class="alert my-4 bg-blue-100 text-sm text-blue-800">
+    <div role="alert" class="alert alert-info my-4 text-sm">
       <Backpex.HTML.CoreComponents.icon name="hero-information-circle" class="h-5 w-5" />
       <span>
         This resource uses the full-text search functionality. The search accepts web search query operators. For example, a dash (-) excludes words.

demo/lib/demo_web/live/invoice_live.ex

@@ -1,13 +1,17 @@
 defmodule DemoWeb.InvoiceLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.Invoice,
+      repo: Demo.Repo,
+      update_changeset: &Demo.Invoice.update_changeset/3,
+      create_changeset: &Demo.Invoice.create_changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.Invoice,
-    repo: Demo.Repo,
-    update_changeset: &Demo.Invoice.update_changeset/3,
-    create_changeset: &Demo.Invoice.create_changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "invoices",
-    event_prefix: "invoice_"
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "invoices",
+      event_prefix: "invoice_"
+    ]
 
   @impl Backpex.LiveResource
   def singular_name, do: "Invoice"

demo/lib/demo_web/live/post_live.ex

@@ -1,13 +1,17 @@
 defmodule DemoWeb.PostLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.Post,
+      repo: Demo.Repo,
+      update_changeset: &Demo.Post.update_changeset/3,
+      create_changeset: &Demo.Post.create_changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.Post,
-    repo: Demo.Repo,
-    update_changeset: &Demo.Post.update_changeset/3,
-    create_changeset: &Demo.Post.create_changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "posts",
-    event_prefix: "post_",
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "posts",
+      event_prefix: "post_"
+    ],
     fluid?: true
 
   @impl Backpex.LiveResource

demo/lib/demo_web/live/product_live.ex

@@ -1,13 +1,17 @@
 defmodule DemoWeb.ProductLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.Product,
+      repo: Demo.Repo,
+      update_changeset: &Demo.Product.changeset/3,
+      create_changeset: &Demo.Product.changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.Product,
-    repo: Demo.Repo,
-    update_changeset: &Demo.Product.changeset/3,
-    create_changeset: &Demo.Product.changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "products",
-    event_prefix: "product_"
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "products",
+      event_prefix: "product_"
+    ]
 
   @impl Backpex.LiveResource
   def singular_name, do: "Product"

demo/lib/demo_web/live/short_link_live.ex

@@ -2,14 +2,19 @@ defmodule DemoWeb.ShortLinkLive do
   use DemoWeb, :verified_routes
 
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.ShortLink,
+      repo: Demo.Repo,
+      update_changeset: &Demo.ShortLink.changeset/3,
+      create_changeset: &Demo.ShortLink.changeset/3
+    ],
+    primary_key: :short_key,
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.ShortLink,
-    repo: Demo.Repo,
-    update_changeset: &Demo.ShortLink.changeset/3,
-    create_changeset: &Demo.ShortLink.changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "short_links",
-    event_prefix: "short_link_"
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "short_links",
+      event_prefix: "short_link_"
+    ]
 
   @impl Backpex.LiveResource
   def singular_name, do: "Short Link"

demo/lib/demo_web/live/tag_live.ex

@@ -1,13 +1,18 @@
 defmodule DemoWeb.TagLive do
   use Backpex.LiveResource,
+    adapter_config: [
+      schema: Demo.Tag,
+      repo: Demo.Repo,
+      update_changeset: &Demo.Tag.update_changeset/3,
+      create_changeset: &Demo.Tag.create_changeset/3
+    ],
     layout: {DemoWeb.Layouts, :admin},
-    schema: Demo.Tag,
-    repo: Demo.Repo,
-    update_changeset: &Demo.Tag.update_changeset/3,
-    create_changeset: &Demo.Tag.create_changeset/3,
-    pubsub: Demo.PubSub,
-    topic: "tags",
-    event_prefix: "tag_"
+    pubsub: [
+      name: Demo.PubSub,
+      topic: "tags",
+      event_prefix: "tag_"
+    ],
+    init_order: %{by: :name, direction: :desc}
 
   @impl Backpex.LiveResource
   def singular_name, do: "Tag"