Replace list and preloads options with query

Author: tfwright

README.md

@@ -77,7 +77,7 @@ every aspect of a particular resource view, like the edit form.
 
 * `actions` - functions that operate on a specific record
 * `tasks` - functions that operate on a resource as a whole
-* `list_with` - function used to fetch records
+* `query_with` - function used to fetch a batch of records
 * `render_with` - function used to encode field values in views
 * `create_with` - function used to insert a record
 * `update_with` - function used to update a record

README.md.eex

@@ -77,7 +77,7 @@ every aspect of a particular resource view, like the edit form.
 
 * `actions` - functions that operate on a specific record
 * `tasks` - functions that operate on a resource as a whole
-* `list_with` - function used to fetch records
+* `query_with` - function used to fetch a batch of records
 * `render_with` - function used to encode field values in views
 * `create_with` - function used to insert a record
 * `update_with` - function used to update a record

lib/live_admin.ex

@@ -24,10 +24,9 @@ defmodule LiveAdmin do
       type: :atom,
       type_doc: "Ecto Repo used to query resource"
     ],
-    list_with: [
+    query_with: [
       type: {:or, [:atom, {:tuple, [:atom, :atom]}]},
-      type_doc:
-        "`t:func_ref/0` returning `{records, count}` used to fetch records in Index component"
+      type_doc: "`t:func_ref/0` returning an Ecto queryable"
     ],
     render_with: [
       type: {:or, [:atom, {:tuple, [:atom, :atom]}]},

lib/live_admin/components/alert_bar.ex

@@ -20,7 +20,13 @@ defmodule LiveAdmin.Components.AlertBar do
     ~H"""
     <div id="alert-bar">
       <%= for {{alert, type}, index} <- Enum.with_index(@alerts) do %>
-        <div class={"alert-bar #{type}"} id={"alert-#{index}"} phx-hook=".AlertItem" data-index={index} data-type={type}>
+        <div
+          class={"alert-bar #{type}"}
+          id={"alert-#{index}"}
+          phx-hook=".AlertItem"
+          data-index={index}
+          data-type={type}
+        >
           <div class="alert-content">
             <%= if index == 0 && Enum.count(@alerts) > 1 do %>
               <div

lib/live_admin/components/resource/index.ex

@@ -297,13 +297,10 @@ defmodule LiveAdmin.Components.Container.Index do
   end
 
   @impl true
-  def handle_event(
-        "task",
-        params = %{"name" => name},
-        socket = %{
-          assigns: %{session: session, resource: resource, config: config}
-        }
-      ) do
+  def handle_event("task", params = %{"name" => name}, socket) do
+    session = socket.assigns.session
+    resource = socket.assigns.resource
+
     {_, m, f, _, _} =
       LiveAdmin.fetch_function(resource, session, :tasks, String.to_existing_atom(name))
 
@@ -313,7 +310,7 @@ defmodule LiveAdmin.Components.Container.Index do
       Task.Supervisor.async_nolink(LiveAdmin.Task.Supervisor, fn ->
         try do
           case apply(m, f, [
-                 Resource.query(resource, Map.get(socket.assigns, :search), config) | args
+                 Resource.query(resource, socket.assigns.search, socket.assigns.config) | args
                ]) do
             {:ok, message} ->
               LiveAdmin.PubSub.announce(session.id, :success, message)
@@ -438,62 +435,6 @@ defmodule LiveAdmin.Components.Container.Index do
      )}
   end
 
-  def handle_event("add_filter", _, socket = %{assigns: assigns}) do
-    new_search =
-      socket.assigns.search
-      |> LiveAdmin.View.parse_search()
-      |> Enum.concat([{"*", "_"}])
-      |> Enum.map_join(" ", fn
-        {field, param} -> "#{field}:#{param}"
-      end)
-
-    {:noreply,
-     push_patch(socket,
-       to:
-         route_with_params(socket.assigns,
-           params: index_link_params(assigns, search: new_search)
-         )
-     )}
-  end
-
-  def handle_event("remove_filter", %{"index" => i}, socket = %{assigns: assigns}) do
-    new_search =
-      socket.assigns.search
-      |> LiveAdmin.View.parse_search()
-      |> List.delete_at(i)
-      |> Enum.map_join(" ", fn
-        {field, param} -> "#{field}:#{param}"
-      end)
-
-    {:noreply,
-     push_patch(socket,
-       to:
-         route_with_params(socket.assigns,
-           params: index_link_params(assigns, search: new_search)
-         )
-     )}
-  end
-
-  def handle_event("update_filters", %{"filters" => filter_params}, socket = %{assigns: assigns}) do
-    new_search =
-      filter_params
-      |> Map.values()
-      |> Enum.filter(fn p -> p["param"] != "" end)
-      |> Enum.map_join(" ", fn
-        %{"field" => "any", "param" => param} -> "*:#{param}"
-        %{"field" => field, "param" => param} -> "#{field}:#{param}"
-        {field, param} -> "#{field}:#{param}"
-      end)
-
-    {:noreply,
-     push_patch(socket,
-       to:
-         route_with_params(socket.assigns,
-           params: index_link_params(assigns, search: new_search)
-         )
-     )}
-  end
-
   defp index_link_params(assigns, overrides \\ []) do
     assigns
     |> Map.take([:search, :page, :sort_attr, :sort_dir, :prefix, :per])

lib/live_admin/resource.ex

@@ -9,6 +9,8 @@ defmodule LiveAdmin.Resource do
   > to query it, __live_admin_config__/0.
   """
 
+  require Integer
+
   import Ecto.Query
   import LiveAdmin
 
@@ -22,11 +24,7 @@ defmodule LiveAdmin.Resource do
   """
   defmacro __using__(opts) do
     opts_schema =
-      LiveAdmin.base_configs_schema() ++
-        [
-          schema: [type: :atom, default: __CALLER__.module],
-          preload: [type: {:or, [:keyword_list, nil]}, default: nil]
-        ]
+      LiveAdmin.base_configs_schema() ++ [schema: [type: :atom, default: __CALLER__.module]]
 
     quote bind_quoted: [opts: opts, opts_schema: opts_schema] do
       opts = NimbleOptions.validate!(opts, opts_schema)
@@ -56,7 +54,6 @@ defmodule LiveAdmin.Resource do
   def find(key, resource, prefix, repo) do
     resource.__live_admin_config__()
     |> Keyword.fetch!(:schema)
-    |> preload(^preloads(resource))
     |> repo.get(key, prefix: prefix)
   end
 
@@ -75,34 +72,30 @@ defmodule LiveAdmin.Resource do
     end
   end
 
-  def query(resource, search, config) do
-    resource.__live_admin_config__()
-    |> Keyword.fetch!(:schema)
-    |> then(fn query ->
-      case search do
-        q when not is_nil(q) and byte_size(q) > 0 ->
-          apply_search(query, q, fields(resource, config))
-
-        _ ->
-          query
-      end
-    end)
-    |> preload(^preloads(resource))
-  end
-
   def list(resource, opts, session, repo, config) do
-    resource
-    |> LiveAdmin.fetch_config(:list_with, config)
-    |> case do
-      nil ->
-        build_list(resource, opts, session, repo, config)
+    opts =
+      opts
+      |> Enum.into(%{})
+      |> Map.put_new(:page, 1)
+      |> Map.put_new(:per, session.index_page_size)
+      |> Map.put_new(:sort_dir, :asc)
+      |> Map.put_new(:sort_attr, LiveAdmin.primary_key!(resource))
 
-      {mod, func_name} ->
-        apply(mod, func_name, [resource, opts, session])
+    query =
+      resource
+      |> query(opts[:search], config)
+      |> limit(^opts[:per])
+      |> offset(^((opts[:page] - 1) * opts[:per]))
+      |> order_by(^[{opts[:sort_dir], opts[:sort_attr]}])
 
-      name when is_atom(name) ->
-        apply(resource, name, [opts, session])
-    end
+    {
+      repo.all(query, prefix: opts[:prefix]),
+      repo.aggregate(
+        query |> exclude(:limit) |> exclude(:offset),
+        :count,
+        prefix: opts[:prefix]
+      )
+    }
   end
 
   def change(resource, record \\ nil, params \\ %{}, config)
@@ -202,35 +195,19 @@ defmodule LiveAdmin.Resource do
     end
   end
 
-  defp build_list(resource, opts, session, repo, config) do
-    opts =
-      opts
-      |> Enum.into(%{})
-      |> Map.put_new(:page, 1)
-      |> Map.put_new(:per, session.index_page_size)
-      |> Map.put_new(:sort_dir, :asc)
-      |> Map.put_new(:sort_attr, LiveAdmin.primary_key!(resource))
-
-    query =
-      resource
-      |> query(opts[:search], config)
-      |> limit(^opts[:per])
-      |> offset(^((opts[:page] - 1) * opts[:per]))
-      |> order_by(^[{opts[:sort_dir], opts[:sort_attr]}])
-
-    {
-      repo.all(query, prefix: opts[:prefix]),
-      repo.aggregate(
-        query |> exclude(:limit) |> exclude(:offset),
-        :count,
-        prefix: opts[:prefix]
-      )
-    }
-  end
-
   defp apply_search(query, q, fields) do
-    q
-    |> LiveAdmin.View.parse_search()
+    parts = String.split(q, ~r{([^\s]*:)}, include_captures: true, trim: true)
+
+    if parts |> Enum.count() |> Integer.is_odd() do
+      [{"*", q}]
+    else
+      parts
+      |> Enum.map(&String.trim/1)
+      |> Enum.chunk_every(2)
+      |> Enum.map(fn
+        [column, param] -> {String.replace(column, ":", ""), param}
+      end)
+    end
     |> case do
       field_queries when is_list(field_queries) ->
         field_queries
@@ -312,21 +289,28 @@ defmodule LiveAdmin.Resource do
 
   defp parse_map_param(param), do: param
 
-  defp preloads(resource) do
+  def query(resource, search, config) do
     resource.__live_admin_config__()
-    |> Keyword.fetch!(:preload)
+    |> Keyword.get(:query_with)
     |> case do
       nil ->
         resource.__live_admin_config__()
         |> Keyword.fetch!(:schema)
-        |> parent_associations()
-        |> Enum.map(& &1.field)
+        |> then(fn query ->
+          case search do
+            q when not is_nil(q) and byte_size(q) > 0 ->
+              apply_search(query, q, fields(resource, config))
+
+            _ ->
+              query
+          end
+        end)
 
-      {m, f, []} ->
-        apply(m, f, [resource])
+      {m, f} ->
+        apply(m, f, [resource, search] ++ args)
 
-      preloads when is_list(preloads) ->
-        preloads
+      f when is_atom(f) ->
+        apply(resource, f, [search])
     end
   end
 

lib/live_admin/router.ex

@@ -107,7 +107,7 @@ defmodule LiveAdmin.Router do
       |> Keyword.put_new(:render_with, Application.get_env(:live_admin, :render_with))
       |> Keyword.put_new(:delete_with, Application.get_env(:live_admin, :delete_with))
       |> Keyword.put_new(:create_with, Application.get_env(:live_admin, :create_with))
-      |> Keyword.put_new(:list_with, Application.get_env(:live_admin, :list_with))
+      |> Keyword.put_new(:query_with, Application.get_env(:live_admin, :query_with))
       |> Keyword.put_new(:update_with, Application.get_env(:live_admin, :update_with))
       |> Keyword.put_new(:label_with, Application.get_env(:live_admin, :label_with))
       |> Keyword.put_new(:title_with, Application.get_env(:live_admin, :title_with))

lib/live_admin/view.ex

@@ -2,8 +2,6 @@ defmodule LiveAdmin.View do
   use Phoenix.Component
   use PhoenixHTMLHelpers
 
-  require Integer
-
   import LiveAdmin.Components
   import Phoenix.HTML
 
@@ -24,7 +22,8 @@ defmodule LiveAdmin.View do
 
   embed_templates("components/layout/*")
 
-  def __mix_recompile__?, do: Path.join(__DIR__, "../../dist/js/app.js") |> File.read!() != @app_js
+  def __mix_recompile__?,
+    do: Path.join(__DIR__, "../../dist/js/app.js") |> File.read!() != @app_js
 
   def render("layout.html", assigns), do: layout(assigns)
 
@@ -41,21 +40,6 @@ defmodule LiveAdmin.View do
   def sort_param_name(field), do: :"#{field}_sort"
   def drop_param_name(field), do: :"#{field}_drop"
 
-  def parse_search(q) do
-    parts = String.split(q, ~r{([^\s]*:)}, include_captures: true, trim: true)
-
-    if parts |> Enum.count() |> Integer.is_odd() do
-      [{"*", q}]
-    else
-      parts
-      |> Enum.map(&String.trim/1)
-      |> Enum.chunk_every(2)
-      |> Enum.map(fn
-        [column, param] -> {String.replace(column, ":", ""), param}
-      end)
-    end
-  end
-
   def get_function_keys(resource, config, function) do
     resource
     |> LiveAdmin.fetch_config(function, config)