Pass lists explicitly to adapter and resource module

Author: Flo0807

lib/backpex/adapter.ex

@@ -27,41 +27,51 @@ defmodule Backpex.Adapter do
 
   Should return `nil` if no result was found.
   """
-  @callback get(term(), map(), module()) :: {:ok, struct() | nil} | {:error, term()}
+  @callback get(primary_value :: term(), assigns :: map(), live_resource :: module(), fields :: list()) ::
+              {:ok, struct() | nil} | {:error, term()}
 
   @doc """
   Returns a list of items by given criteria.
   """
-  @callback list(keyword(), map(), module()) :: {:ok, list()}
+  @callback list(criteria :: keyword(), assigns :: map(), live_resource :: module(), fields :: list()) :: {:ok, list()}
 
   @doc """
   Gets the total count of the current live_resource.
   Possibly being constrained the item query and the search- and filter options.
   """
-  @callback count(keyword(), map(), module()) :: {:ok, non_neg_integer()}
+  @callback count(criteria :: keyword(), assigns :: map(), live_resource :: module(), fields :: list()) ::
+              {:ok, non_neg_integer()}
 
   @doc """
   Inserts given item.
   """
-  @callback insert(struct(), module()) :: {:ok, struct()} | {:error, term()}
+  @callback insert(item :: struct(), live_resource :: module()) :: {:ok, struct()} | {:error, term()}
 
   @doc """
   Updates given item.
   """
-  @callback update(struct(), module()) :: {:ok, struct()} | {:error, term()}
+  @callback update(item :: struct(), live_resource :: module()) :: {:ok, struct()} | {:error, term()}
 
   @doc """
   Updates given items.
   """
-  @callback update_all(list(struct()), keyword(), module()) :: {:ok, non_neg_integer()}
+  @callback update_all(items :: list(struct()), updates :: keyword(), live_resource :: module()) ::
+              {:ok, non_neg_integer()}
 
   @doc """
   Applies a change to a given item.
   """
-  @callback change(struct(), map(), term(), list(), module(), keyword()) :: Ecto.Changeset.t()
+  @callback change(
+              item :: struct(),
+              attrs :: map(),
+              fields :: term(),
+              assigns :: list(),
+              live_resource :: module(),
+              opts :: keyword()
+            ) :: Ecto.Changeset.t()
 
   @doc """
   Deletes multiple items.
   """
-  @callback delete_all(list(struct()), module()) :: {:ok, term()} | {:error, term()}
+  @callback delete_all(items :: list(struct()), live_resource :: module()) :: {:ok, term()} | {:error, term()}
 end

lib/backpex/adapters/ash.ex

@@ -29,7 +29,7 @@ if Code.ensure_loaded?(Ash) do
     Returns `nil` if no result was found.
     """
     @impl Backpex.Adapter
-    def get(primary_value, _assigns, live_resource) do
+    def get(primary_value, _assigns, live_resource, _fields) do
       resource = live_resource.adapter_config(:resource)
       primary_key = live_resource.config(:primary_key)
 
@@ -42,7 +42,7 @@ if Code.ensure_loaded?(Ash) do
     Returns a list of items by given criteria.
     """
     @impl Backpex.Adapter
-    def list(_criteria, _assigns, live_resource) do
+    def list(_criteria, _assigns, live_resource, _fields) do
       live_resource.adapter_config(:resource)
       |> Ash.read()
     end
@@ -51,7 +51,7 @@ if Code.ensure_loaded?(Ash) do
     Returns the number of items matching the given criteria.
     """
     @impl Backpex.Adapter
-    def count(_criteria, _assigns, live_resource) do
+    def count(_criteria, _assigns, live_resource, _fields) do
       live_resource.adapter_config(:resource)
       |> Ash.count()
     end

lib/backpex/adapters/ecto.ex

@@ -75,9 +75,8 @@ defmodule Backpex.Adapters.Ecto do
   Gets a database record with the given primary key value.
   """
   @impl Backpex.Adapter
-  def get(primary_value, assigns, live_resource) do
+  def get(primary_value, assigns, live_resource, fields) do
     repo = live_resource.adapter_config(:repo)
-    fields = live_resource.fields(assigns.live_action, assigns)
 
     record_query(primary_value, assigns, fields, live_resource)
     |> repo.one()
@@ -88,10 +87,10 @@ defmodule Backpex.Adapters.Ecto do
   Returns a list of items by given criteria.
   """
   @impl Backpex.Adapter
-  def list(criteria, assigns, live_resource) do
+  def list(criteria, assigns, live_resource, fields) do
     repo = live_resource.adapter_config(:repo)
 
-    list_query(criteria, assigns, live_resource)
+    list_query(criteria, assigns, live_resource, fields)
     |> repo.all()
     |> then(fn items -> {:ok, items} end)
   end
@@ -100,10 +99,10 @@ defmodule Backpex.Adapters.Ecto do
   Returns the number of items matching the given criteria.
   """
   @impl Backpex.Adapter
-  def count(criteria, assigns, live_resource) do
+  def count(criteria, assigns, live_resource, fields) do
     repo = live_resource.adapter_config(:repo)
 
-    list_query(criteria, assigns, live_resource)
+    list_query(criteria, assigns, live_resource, fields)
     |> exclude(:preload)
     |> exclude(:select)
     |> subquery()
@@ -116,11 +115,10 @@ defmodule Backpex.Adapters.Ecto do
 
   TODO: Should be private.
   """
-  def list_query(criteria, assigns, live_resource) do
+  def list_query(criteria, assigns, live_resource, fields) do
     schema = live_resource.adapter_config(:schema)
     item_query = live_resource.adapter_config(:item_query)
     full_text_search = live_resource.config(:full_text_search)
-    fields = live_resource.fields(:index, assigns)
     associations = associations(fields, schema)
 
     schema

lib/backpex/live_components/form_component.ex

@@ -203,7 +203,7 @@ defmodule Backpex.FormComponent do
   defp handle_save(socket, key, params, save_type \\ "save")
 
   defp handle_save(socket, :new, params, save_type) do
-    %{assigns: %{live_resource: live_resource, item: item, live_action: live_action} = assigns} = socket
+    %{assigns: %{live_resource: live_resource, fields: fields, item: item, live_action: live_action} = assigns} = socket
 
     opts = [
       assocs: Map.get(assigns, :assocs, []),
@@ -215,7 +215,7 @@ defmodule Backpex.FormComponent do
       end
     ]
 
-    case Resource.insert(item, params, socket.assigns, live_resource, opts) do
+    case Resource.insert(item, params, socket.assigns, live_resource, fields, opts) do
       {:ok, item} ->
         return_to = return_to_path(save_type, live_resource, socket, socket.assigns, live_action, item)
 
@@ -248,7 +248,8 @@ defmodule Backpex.FormComponent do
     %{
       live_resource: live_resource,
       item: item,
-      live_action: live_action
+      live_action: live_action,
+      fields: fields
     } = socket.assigns
 
     opts = [
@@ -261,7 +262,7 @@ defmodule Backpex.FormComponent do
       end
     ]
 
-    case Resource.update(item, params, socket.assigns, live_resource, opts) do
+    case Resource.update(item, params, socket.assigns, fields, live_resource, opts) do
       {:ok, item} ->
         return_to = return_to_path(save_type, live_resource, socket, socket.assigns, live_action, item)
 

lib/backpex/live_resource/form.ex

@@ -75,12 +75,12 @@ defmodule Backpex.LiveResource.Form do
   end
 
   defp assign_item(socket, :edit = _live_action) do
-    %{live_resource: live_resource, params: params} = socket.assigns
+    %{live_resource: live_resource, fields: fields, params: params} = socket.assigns
 
     backpex_id = Map.fetch!(params, "backpex_id")
     primary_value = URI.decode(backpex_id)
 
-    item = Resource.get!(primary_value, socket.assigns, live_resource)
+    item = Resource.get!(primary_value, socket.assigns, live_resource, fields)
 
     assign(socket, :item, item)
   end

lib/backpex/live_resource/index.ex

@@ -360,11 +360,11 @@ defmodule Backpex.LiveResource.Index do
   end
 
   defp update_item(socket, item) do
-    %{live_resource: live_resource, items: items} = socket.assigns
+    %{live_resource: live_resource, fields: fields, items: items} = socket.assigns
 
     primary_value = LiveResource.primary_value(item, live_resource)
     primary_value_str = to_string(primary_value)
-    {:ok, updated_item} = Resource.get(primary_value, socket.assigns, live_resource)
+    {:ok, updated_item} = Resource.get(primary_value, socket.assigns, live_resource, fields)
 
     updated_items =
       Enum.map(items, fn current_item ->
@@ -446,7 +446,7 @@ defmodule Backpex.LiveResource.Index do
       filters: LiveResource.filter_options(valid_filter_params, filters)
     ]
 
-    {:ok, item_count} = Resource.count(count_criteria, socket.assigns, live_resource)
+    {:ok, item_count} = Resource.count(count_criteria, socket.assigns, live_resource, fields)
 
     per_page =
       params
@@ -555,7 +555,7 @@ defmodule Backpex.LiveResource.Index do
       filters: LiveResource.filter_options(valid_filter_params, filters)
     ]
 
-    {:ok, item_count} = Resource.count(count_criteria, socket.assigns, live_resource)
+    {:ok, item_count} = Resource.count(count_criteria, socket.assigns, live_resource, fields)
     %{page: page, per_page: per_page} = query_options
     total_pages = LiveResource.calculate_total_pages(item_count, per_page)
     new_query_options = Map.put(query_options, :page, LiveResource.validate_page(page, total_pages))
@@ -588,7 +588,7 @@ defmodule Backpex.LiveResource.Index do
           filters: LiveResource.filter_options(query_options, filters)
         ]
 
-        query = EctoAdapter.list_query(criteria, socket.assigns, live_resource)
+        query = EctoAdapter.list_query(criteria, socket.assigns, live_resource, fields)
 
         case Backpex.Metric.metrics_visible?(metric_visibility, live_resource) do
           true ->
@@ -611,8 +611,12 @@ defmodule Backpex.LiveResource.Index do
   end
 
   defp assign_items(socket) do
-    criteria = LiveResource.build_criteria(socket.assigns)
-    {:ok, items} = Resource.list(criteria, socket.assigns, socket.assigns.live_resource)
+    %{assigns: %{live_resource: live_resource, fields: fields} = assigns} = socket
+
+    {:ok, items} =
+      assigns
+      |> LiveResource.build_criteria()
+      |> Resource.list(assigns, live_resource, fields)
 
     assign(socket, :items, items)
   end

lib/backpex/live_resource/show.ex

@@ -51,10 +51,10 @@ defmodule Backpex.LiveResource.Show do
   end
 
   defp assign_item(socket) do
-    %{live_resource: live_resource, params: params} = socket.assigns
+    %{live_resource: live_resource, fields: fields, params: params} = socket.assigns
     backpex_id = Map.fetch!(params, "backpex_id")
     primary_value = URI.decode(backpex_id)
-    item = Resource.get!(primary_value, socket.assigns, live_resource)
+    item = Resource.get!(primary_value, socket.assigns, live_resource, fields)
 
     if not live_resource.can?(socket.assigns, :show, item), do: raise(Backpex.ForbiddenError)
 

lib/backpex/resource.ex

@@ -19,20 +19,20 @@ defmodule Backpex.Resource do
     search: {"hello", [:title, :description]}
   ]
   """
-  def list(criteria, assigns, live_resource) do
+  def list(criteria, assigns, live_resource, fields) do
     adapter = live_resource.config(:adapter)
 
-    adapter.list(criteria, assigns, live_resource)
+    adapter.list(criteria, assigns, live_resource, fields)
   end
 
   @doc """
   Gets the total count of the current live_resource.
   Possibly being constrained the item query and the search- and filter options.
   """
-  def count(criteria, assigns, live_resource) do
+  def count(criteria, assigns, live_resource, fields) do
     adapter = live_resource.config(:adapter)
 
-    adapter.count(criteria, assigns, live_resource)
+    adapter.count(criteria, assigns, live_resource, fields)
   end
 
   @doc """
@@ -46,17 +46,17 @@ defmodule Backpex.Resource do
   * `assigns` (map): The current assigns of the socket.
   * `live_resource` (module): The `Backpex.LiveResource` module.
   """
-  def get(primary_value, assigns, live_resource) do
+  def get(primary_value, assigns, live_resource, fields) do
     adapter = live_resource.config(:adapter)
 
-    adapter.get(primary_value, assigns, live_resource)
+    adapter.get(primary_value, assigns, live_resource, fields)
   end
 
   @doc """
   Same as `get/4` but returns the result or raises an error.
   """
-  def get!(primary_value, assigns, live_resource) do
-    case get(primary_value, assigns, live_resource) do
+  def get!(primary_value, assigns, live_resource, fields) do
+    case get(primary_value, assigns, live_resource, fields) do
       {:ok, nil} -> raise Backpex.NoResultsError
       {:ok, result} -> result
       {:error, _error} -> raise Backpex.NoResultsError
@@ -92,11 +92,10 @@ defmodule Backpex.Resource do
   * `attrs` (map): A map of parameters that will be passed to the `changeset_function`.
   * TODO: docs
   """
-  def insert(item, attrs, assigns, live_resource, opts) do
+  def insert(item, attrs, assigns, live_resource, fields, opts) do
     {after_save_fun, opts} = Keyword.pop(opts, :after_save_fun, &{:ok, &1})
 
     adapter = live_resource.config(:adapter)
-    fields = live_resource.fields(:new, assigns)
 
     item
     |> change(attrs, fields, assigns, live_resource, Keyword.put(opts, :action, :insert))
@@ -114,11 +113,10 @@ defmodule Backpex.Resource do
   * `attrs` (map): A map of parameters that will be passed to the `changeset_function`.
   * TODO: docs
   """
-  def update(item, attrs, assigns, live_resource, opts \\ []) do
+  def update(item, attrs, assigns, fields, live_resource, opts \\ []) do
     {after_save_fun, opts} = Keyword.pop(opts, :after_save_fun, &{:ok, &1})
 
     adapter = live_resource.config(:adapter)
-    fields = live_resource.fields(:edit, assigns)
 
     item
     |> change(attrs, fields, assigns, live_resource, Keyword.put(opts, :action, :update))