Merge pull request #1271 from naymspace/feature/use-filtered-fields-in-ecto-adapter

Refactor fields handling

Author: Flo0807

demo/lib/demo_web/live/post_live.ex

@@ -110,7 +110,7 @@ defmodule DemoWeb.PostLive do
         module: Backpex.Fields.Textarea,
         label: "Body",
         rows: 10,
-        except: [:index, :resource_action],
+        except: [:index],
         align_label: :center
       },
       published: %{
@@ -123,7 +123,7 @@ defmodule DemoWeb.PostLive do
         module: Backpex.Fields.Boolean,
         label: "Show likes",
         select: dynamic([post: p], fragment("? > 0", p.likes)),
-        except: [:index, :resource_action, :show]
+        except: [:index, :show]
       },
       likes: %{
         module: Backpex.Fields.Number,

demo/lib/demo_web/live/product_live.ex

@@ -51,7 +51,7 @@ defmodule DemoWeb.ProductLive do
           assigns ->
             ~H"<p>{Backpex.HTML.pretty_value(@value)}</p>"
         end,
-        except: [:index, :resource_action]
+        except: [:index]
       },
       name: %{
         module: Backpex.Fields.Text,

demo/lib/demo_web/live/short_link_live.ex

@@ -22,6 +22,7 @@ defmodule DemoWeb.ShortLinkLive do
   def can?(_assigns, :delete, _item), do: false
   def can?(_assigns, _action, _item), do: true
 
+  @impl Backpex.LiveResource
   def return_to(_socket, _assigns, :edit, _form_action, _item) do
     # since the primary key might be updated, we go to the index page
     ~p"/admin/short-links"

guides/fields/visibility.md

@@ -6,7 +6,7 @@ You can change the visibility of fields in certain views.
 
 You can use the `only` and `except` options to define the views where a field should be visible. The `only` option will show the field only in the specified views, while the `except` option will show the field in all views except the specified ones. The options have to be a list of view names.
 
-The following values are supported: `:new`, `:edit`, `:show`, `:index` and `:resource_action`.
+The following values are supported: `:new`, `:edit`, `:show` and `:index`.
 
 ```elixir
 # in your resource configuration file

guides/filter/how-to-add-a-filter.md

@@ -27,7 +27,7 @@ defmodule MyAppWeb.Filters.PostCategorySelect do
   def prompt, do: "Select category ..."
 
   @impl Backpex.Filters.Select
-  def options do
+  def options(_assigns) do
     query =
       from p in Post,
         join: c in Category,

guides/live_resource/navigation.md

@@ -34,4 +34,4 @@ When working with forms (in `:new` or  `:edit` live actions), the following form
 - `:save` - When a form is successfully submitted aka the "Save" button was clicked
 - `:cancel` - When a form submission is canceled aka the "Cancel" button was clicked
 
-For all other live actions, the form_action will be `nil`.
+For all other live actions, the form_action will be `nil`.

guides/upgrading/v0.15.md

@@ -54,3 +54,34 @@ Note that it is now also possible to configure the layout as a function:
 use Backpex.LiveResource,
   layout: &MyAppWeb.admin/1
 ```
+
+## Resource and adapter functions have been updated
+
+We've updated some functions in `Backpex.Resource` and the adapter modules (`Backpex.Adapters.Ecto` and `Backpex.Adapters.Ash`) to include the fields as an additional parameter.
+
+The following functions are affected:
+
+`Backpex.Resource`:
+- `list/3` -> `Backpex.Resource.list/4`
+- `count/3` -> `Backpex.Resource.count/4`
+- `get/3` -> `Backpex.Resource.get/4`
+- `get!/3` -> `Backpex.Resource.get!/4`
+
+`Backpex.Adapter` (including `Backpex.Adapters.Ecto` and `Backpex.Adapters.Ash`):
+- `list/3` -> `c:Backpex.Adapter.list/4`
+- `count/3` -> `c:Backpex.Adapter.count/4`
+- `get/3` -> `c:Backpex.Adapter.get/4`
+
+For example:
+
+```elixir
+# before
+Resource.get(primary_value, socket.assigns, live_resource)
+# after
+Resource.get(primary_value, fields, socket.assigns, live_resource)
+```
+
+## `:only`/`:except` field option changes
+
+You no longer need to pass `:resource_action` in addition to `:index` to the fields `:only`/`:except` option.
+Before, it was needed to make fields visible behind the backdrop of the resource action modal.

guides/upgrading/v0.7.md

@@ -39,10 +39,10 @@ end
 We have updated certain functions in `Backpex.Resource`.
 
 The following functions are affected:
-- `Backpex.Resource.update/6` (`update/5` before)
-- [`Backpex.Resource.insert/6`]() (`insert/5` before)
-- [`Backpex.Resource.change/7`]()
-- [`Backpex.Resource.put_assocs/2`]() (has been removed)
+- `update/6` (`update/5` before)
+- `insert/6` (`insert/5` before)
+- `change/7`
+- `put_assocs/2` (has been removed)
 
 If you call one of these functions in your application, you will probably need to update the function call.
 
@@ -85,4 +85,4 @@ def label(_assigns, _item) do
 end
 ```
 
-Read more about the new `item` parameter in [the item action guide](/guides/actions/item-actions.md#implementing-an-item-action).
+Read more about the new `item` parameter in [the item action guide](/guides/actions/item-actions.md#implementing-an-item-action).

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(), fields :: list(), assigns :: map(), live_resource :: module()) ::
+              {: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(), fields :: list(), assigns :: map(), live_resource :: module()) :: {: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(), fields :: list(), assigns :: map(), live_resource :: module()) ::
+              {: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, _fields, _assigns, live_resource) 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, _fields, _assigns, live_resource) 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, _fields, _assigns, live_resource) do
       live_resource.adapter_config(:resource)
       |> Ash.count()
     end