Merge branch 'master' into feature/dynamic-primary-keys

Author: aesmail

lib/kaffy/resource_admin.ex

@@ -13,6 +13,35 @@ defmodule Kaffy.ResourceAdmin do
   All functions are optional.
   """
 
+  @doc """
+  Allows a description to be injected into the index view of a resource's index
+  view. This is helpful when you want to provide information to the user about the index page.
+  Return value can be a string, or {:safe, string) tuple.  If :safe tuple is used, HTML will be rendered.
+
+  `index_description/1` takes a schema and must return a `String.t()` or tuple `{:safe, String.t()}`.
+
+  If `index_description/1` is not defined, Kaffy will return nil.
+
+  ## Examples:
+
+  ```elixir
+  def index_description(resource) do
+    "This will show up on the index page."
+  end
+
+  def index_description(resource) do
+    {:safe, "This will show up on the index page.  <b>This will be bold!</b>."}
+  end
+  ```
+  """
+  def index_description(resource) do
+    Utils.get_assigned_value_or_default(
+      resource,
+      :index_description,
+      ResourceSchema.index_description(resource)
+    )
+  end
+
   @doc """
   `index/1` takes the schema module and should return a keyword list of fields and
   their options.

lib/kaffy/resource_query.ex

@@ -135,7 +135,7 @@ defmodule Kaffy.ResourceQuery do
 
           Enum.reduce(search_fields, query, fn
             {association, fields}, q ->
-              query = from(s in q, join: a in assoc(s, ^association))
+              query = from(s in q, left_join: a in assoc(s, ^association))
 
               Enum.reduce(fields, query, fn f, current_query ->
                 from([..., r] in current_query,

lib/kaffy/resource_schema.ex

@@ -19,6 +19,8 @@ defmodule Kaffy.ResourceSchema do
     end
   end
 
+  def index_description(_schema), do: nil
+
   def index_fields(schema) do
     Keyword.drop(fields(schema), fields_to_be_removed(schema))
   end
@@ -311,6 +313,9 @@ defmodule Kaffy.ResourceSchema do
       {_f, %{type: :map}} ->
         true
 
+      {_f, %{type: {:array, _}}} ->
+        true
+
       f when is_atom(f) ->
         f == :map
 

lib/kaffy/utils.ex

@@ -9,6 +9,14 @@ defmodule Kaffy.Utils do
     env(:admin_title, "Kaffy")
   end
 
+  @doc """
+  Returns the :admin_footer config if present, otherwise returns default copyright.
+  """
+  @spec footer() :: String.t() | {:safe, String.t()}
+  def footer() do
+    env(:admin_footer, "Copyright © 2022 Kaffy. All rights reserved.")
+  end
+
   @doc """
   Returns the static path to the asset.
   """
@@ -355,7 +363,8 @@ defmodule Kaffy.Utils do
           stylesheets: stylesheets ++ acc.stylesheets,
           javascripts: javascripts ++ acc.javascripts
         }
-      end)
+      end
+    )
   end
 
   defp env(key, default \\ nil) do

lib/kaffy_web/templates/layout/app.html.eex

@@ -155,7 +155,9 @@
 
           <footer class="footer">
             <div class="d-sm-flex justify-content-center justify-content-sm-between">
-              <span class="text-muted text-center text-sm-left d-block d-sm-inline-block">Copyright © 2022 Kaffy. All rights reserved.</span>
+              <%= if copyright = Kaffy.Utils.footer() do %>
+                <span class="text-muted text-center text-sm-left d-block d-sm-inline-block"><%= copyright %></span>
+              <% end %>
             </div>
           </footer>
 

lib/kaffy_web/templates/resource/index.html.eex

@@ -22,6 +22,14 @@
 
     <div class="card-body table-responsive w-100">
       <div class="card-description">
+        <%= if index_description = Kaffy.ResourceAdmin.index_description(@my_resource) do %>
+          <div class="row">
+              <div class="col-auto mr-auto">
+                  <p><%= index_description %></p>
+              </div>
+          </div>
+        <% end %>
+
         <div class="row">
 
           <div class="col-auto mr-auto">

mix.exs

@@ -2,7 +2,7 @@ defmodule Kaffy.MixProject do
   use Mix.Project
 
   @source_url "https://github.com/aesmail/kaffy"
-  @version "0.9.5-rc.0"
+  @version "0.10.0-rc.0"
 
   def project do
     [

test/resource_admin_test.exs

@@ -8,12 +8,14 @@ defmodule Kaffy.ResourceAdminTest do
 
   defmodule CactusAdmin do
     def plural_name(_), do: "Cacti"
+    def index_description(_), do: {:safe, "Person Admin <b>Description</b>"}
   end
 
   defmodule Person do
   end
 
   defmodule PersonAdmin do
+    def index_description(_), do: "Person Admin Description"
   end
 
   defmodule PetAdmin do
@@ -94,4 +96,20 @@ defmodule Kaffy.ResourceAdminTest do
       assert ResourceAdmin.deserialize_id([schema: Owner, admin: OwnerETFAdmin], "g2gCYQFhAg") == [person_id: 1, pet_id: 2]
     end
   end
+  
+  describe "index_description/1" do
+    test "nil if index_description is not defined as function in admin" do
+      refute ResourceAdmin.index_description(schema: Nested.Node, admin: NestedNodeAdmin)
+    end
+
+    test "string if index_description is defined as function in admin" do
+      assert ResourceAdmin.index_description(schema: Person, admin: PersonAdmin) ==
+               "Person Admin Description"
+    end
+
+    test "{:safe, html} if index_description is defined as function in admin" do
+      assert ResourceAdmin.index_description(schema: Cactus, admin: CactusAdmin) ==
+               {:safe, "Person Admin <b>Description</b>"}
+    end
+  end
 end