merge new version

.gitattributes

@@ -0,0 +1,4 @@
+* linguist-vendored
+*.ex linguist-vendored=false
+*.exs linguist-vendored=false
+

.github/FUNDING.yml

@@ -1,12 +1,13 @@
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: aesmail
 patreon: # Replace with a single Patreon username
-open_collective: # kaffy
+open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: aesmail
+liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
 custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Kaffy CI (Elixir 1.10)
+name: Kaffy CI (Elixir)
 
 on:
   push:
@@ -9,26 +9,32 @@ on:
 jobs:
   test:
     name: Test ${{matrix.otp}} / Elixir  ${{matrix.elixir}}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        otp: ['21', '22', '23', '24']
-        elixir: ['1.10.3', '1.11.4', '1.12']
+        otp: ['22', '23', '24', '25']
+        elixir: ['1.12.3', '1.13.4', '1.14.5', '1.15.5']
         # Exclude invalid combinations of Elixir and OTP
         exclude:
-          - otp: '21'
-            elixir: '1.12'
-          - otp: '24'
-            elixir: '1.10.3'
-        # Include the release candidate for the next Elixir, but don't 
+          - otp: '22'
+            elixir: '1.14.5'
+          - otp: '22'
+            elixir: '1.15.5'
+          - otp: '23'
+            elixir: '1.15.5'
+          - otp: '25'
+            elixir: '1.12.3'
+          - otp: '25'
+            elixir: '1.13.4'
+        # Include the release candidate for the next Elixir, but don't
         # fail CI.
-        include:
-          - elixir: '1.13'
-            otp: '24'
-            experimental: true
+        # include:
+        #   - elixir: '1.13'
+        #     otp: '24'
+        #     experimental: true
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Elixir
       uses: erlef/setup-beam@v1
       with:

CHANGELOG.md

@@ -5,6 +5,79 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.10.2 (2023-10-09)
+
+### Fixes
+- Fix regression introduced in v0.10.1 which made Kaffy ignore all admin modules.
+
+## v0.10.1 (2023-10-09)
+
+### Fixes
+- Fix a crash when Kaffy mistakenly treats erlang modules as Elixir modules (PR #300)
+
+## v0.10.0 (2023-10-06)
+
+### Fixes
+- belongs_to fields didn't respect the `:readonly` option (PR #297).
+
+## v0.10.0-rc.3 (2023-09-28)
+
+### Fixes
+- Fix regression when trying to save a resource with an array field.
+
+### Added
+- Support searching fields with `id`, `integer` and `decimal` types.
+
+## v0.10.0-rc.2 (2023-09-10)
+
+### Fixes
+- Fix a crash when deleting resources from the resource page through the "Delete" button.
+
+## v0.10.0-rc.1 (2023-09-09)
+
+### Fixes
+- Crash when updating records.
+- Removes elixir and phoenix deprecation warnings [PR#288](https://github.com/aesmail/kaffy/pull/288)
+
+### Added
+- Support for filtering `{:array, :string}` fields [PR#285](https://github.com/aesmail/kaffy/pull/262)
+- Per-context dashboard [PR#287](https://github.com/aesmail/kaffy/pull/287)
+
+### Changed
+- Minimum phoenix version is now 1.6. This means that the minimum Elixir version is now 1.12 (see support policy).
+
+## v0.10.0-rc.0 (2023-09-02)
+
+### Fixes
+- Fix changeset errors [PR#262](https://github.com/aesmail/kaffy/pull/262)
+- Preload resources before trying to convert resource to existing atom. [PR#266](https://github.com/aesmail/kaffy/pull/266)
+- Include `many_to_many` fields in `fields_to_be_removed/1`.
+- Fix array fields not being saved properly.
+- Fix `:readonly` and `:editable` options for datetime fields.
+- Default to `nil` for `belongs_to` fields.
+- Fix issue with datetime fields sometimes being updated unexpectedly.
+
+### Changed
+- Minimum Elixir version is now 1.11.4.
+- Add `phoenix_view` package to deps.
+- Let specify the full 'path' for FontAwesome fonts [PR#186](https://github.com/aesmail/kaffy/pull/186)
+- Lazy load default kaffy field value [PR#255](https://github.com/aesmail/kaffy/pull/255)
+- Update phoenix html to address deprecated form_for [PR#260](https://github.com/aesmail/kaffy/pull/260)
+- Use left_join when building search query [PR#273](https://github.com/aesmail/kaffy/pull/273)
+- Remove the "- Kaffy" suffix from page titles.
+
+### Added
+-  Support hiding menu entries [PR#248](https://github.com/aesmail/kaffy/pull/248)
+- Add support for composite primary keys [PR#270](https://github.com/aesmail/kaffy/pull/270)
+- Index page description [PR#274](https://github.com/aesmail/kaffy/pull/274)
+- Footer can be specified in config [PR#275](https://github.com/aesmail/kaffy/pull/275)
+- Provide more flexibility for customizing the `admin_logo` and `admin_logo_mini` options.
+- Add the ability to "bulk delete" resources from the index page.
+- Hide save and delete buttons on the show page based on available actions.
+- Add `Kaffy.Utils.auto_detect_resources/0` which returns the list of auto-detected resources (Kaffy's attempt at discovering the list of schema/admin modules).
+
+
+
 ## v0.9.4 (2022-10-31)
 
 ### Fixed

README.md

@@ -1,6 +1,5 @@
 # Kaffy
 
-[![Sponsor](https://opencollective.com/kaffy/tiers/sponsor/badge.svg?label=sponsor&color=brightgreen)](https://opencollective.com/kaffy)
 [![Module Version](https://img.shields.io/hexpm/v/kaffy.svg)](https://hex.pm/packages/kaffy)
 [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/kaffy/)
 [![Total Download](https://img.shields.io/hexpm/dt/kaffy.svg)](https://hex.pm/packages/kaffy)
@@ -52,24 +51,44 @@ without the need to touch the current codebase. It was inspired by django's love
 
 ## Sponsors
 
-Become a sponsor through Kaffy's [OpenCollective](https://opencollective.com/kaffy) page.
+Sponsor the [development of Kaffy](https://github.com/sponsors/aesmail) through GitHub Sponsors.
 
 ## Demo
 
 [Check out the simple demo here](https://kaffy.fly.dev/admin/)
 
 ## Minimum Requirements
 
-- Elixir 1.10.0
-- Phoenix 1.5.0
+Starting with v0.10.0, Kaffy will officially support the latest two phoenix versions.
+
+| Kaffy   | Supported phoenix versions |
+|---------|----------------------------|
+| v0.10.0 | 1.6, 1.7.0                 |
+| v0.9.X  | 1.5, 1.6, 1.7.0            |
+|         |                            |
+
+
+## Support Policy
+
+The latest released `major.minor` version will be supported. For example, if the latest version is `0.9.0`, then `0.9.1` will be released with bug fixes. If a new version `0.10.0` is released, then `0.9.1` will no longer receive bug fixes or security patches.
 
 ## Installation
 
 #### Add `:kaffy` as a dependency
 ```elixir
 def deps do
   [
-    {:kaffy, "~> 0.9.2"}
+    {:kaffy, "~> 0.10.0"}
+  ]
+end
+```
+
+If you are using `kaffy` v0.9.x with `phoenix` 1.7, you need to add `phoenix_view` to your dependencies:
+```elixir
+def deps do
+  [
+    {:phoenix_view, "~> 2.0.2"},
+    {:kaffy, "~> 0.9.4"}
   ]
 end
 ```
@@ -96,9 +115,21 @@ plug Plug.Static,
 
 # in your config/config.exs
 config :kaffy,
-  otp_app: :my_app,
-  ecto_repo: MyApp.Repo,
-  router: MyAppWeb.Router
+  # required keys
+  otp_app: :my_app, # required
+  ecto_repo: MyApp.Repo, # required
+  router: MyAppWeb.Router, # required
+  # optional keys
+  admin_title: "My Awesome App",
+  admin_logo: [
+    url: "https://example.com/img/logo.png",
+    style: "width:200px;height:66px;"
+  ],
+  admin_logo_mini: "/images/logo-mini.png",
+  hide_dashboard: true,
+  home_page: [schema: [:accounts, :user]],
+  enable_context_dashboards: true, # since v0.10.0
+  admin_footer: "Kaffy © 2023" # since v0.10.0
 ```
 
 Note that providing pipelines with the `:pipe_through` option will add those pipelines to kaffy's `:kaffy_browser` pipeline which is defined as follows:
@@ -112,6 +143,17 @@ pipeline :kaffy_browser do
   plug :put_secure_browser_headers
 end
 ```
+### Phoenix version 1.7
+Note that if you use Phoenix version 1.7 you also need to manually add the use of phoenix views in your project.
+Follow the instructions at https://hexdocs.pm/phoenix_view/Phoenix.View.html
+
+You will also need to change `helpers: false` to `true` in the `myapp_web.ex` file as shown in example below.
+```elixir
+  # lib/myapp_web.ex
+  def router do
+    quote do
+      use Phoenix.Router, helpers: true # <- set to true
+```
 
 ## Customizations
 
@@ -131,7 +173,9 @@ config :kaffy,
   admin_title: "My Awesome App",
   admin_logo: "/images/logo.png",
   admin_logo_mini: "/images/logo-mini.png",
+  admin_footer: "Kaffy &copy; 2023",
   hide_dashboard: false,
+  enable_context_dashboards: true,
   home_page: [kaffy: :dashboard],
   ecto_repo: MyApp.Repo,
   router: MyAppWeb.Router,
@@ -146,7 +190,7 @@ defmodule MyApp.Kaffy.Config do
         resources: [ # this line used to be "schemas" in pre v0.9
           post: [schema: MyApp.Blog.Post, admin: MyApp.SomeModule.Anywhere.PostAdmin],
           comment: [schema: MyApp.Blog.Comment],
-          tag: [schema: MyApp.Blog.Tag]
+          tag: [schema: MyApp.Blog.Tag, in_menu: false]
         ]
       ],
       inventory: [
@@ -226,7 +270,8 @@ Widgets have shared options:
 - `:order` (optional) is the displaying order of the widget. Widgets are display in order based on this value. The default value is 999.
 - `:width` (optional) is the width the widget should occupy on the page. Valid values are 1 to 12. The default for tidbits is 3 and the others 6.
 - `:percentage` (required for progress widgets) is the percentage value for the progress. This must be an integer.
-- `:icon` (optional for tidbit widgets) is the icon displayed next to the tidbit's `content`. Any FontAwesome-valid icon is valid here. For example: `thumbs-up`.
+- `:full_icon` (optional for tidbit widgets) is the icon displayed next to the tidbit's `content`. You have to specify the full name given by FontAwesome like `fas fa-thumbs-up`.
+- `:icon` (optional for tidbit widgets) is the icon displayed next to the tidbit's `content`. Any FontAwesome-valid icon is valid here. For example: `thumbs-up`. But it's limited to the `fas` group. For full defintion see `:full_icon`.
 
 When defining a chart widget, the content must be a map with the following required keys:
 
@@ -414,6 +459,16 @@ defmodule MyApp.Blog.PostAdmin do
 end
 ```
 
+If you need to hide the "New <Schema>" button, you can define the `default_actions/1` function in your admin module:
+
+```elixir
+defmodule MyApp.Blog.PostAdmin do
+  def default_actions(_schema) do
+    # default actions are [:new, :edit, :delete] by default.
+    [:delete] # cannot create or edit posts, can only delete.
+  end
+end
+```
 
 ### Form Pages
 
@@ -477,12 +532,25 @@ def form_fields(_schema) do
       end
     }
   ]
- ```
+end
+```
+
+If you don't want users to be able to edit or delete records, you can define the `default_actions/1` function in your admin module:
+
+```elixir
+defmodule MyApp.Blog.PostAdmin do
+  def default_actions(_schema) do
+    # default actions are [:new, :edit, :delete] by default.
+    [:new] # only create records, cannot edit or delete.
+  end
+end
+```
 
 #### Association Forms
 
 A `belongs_to` association should be referenced by the field name, *not* the association name. For example, a schema with the following association:
 
+
 ```elixir
 schema "my_model" do
   ...
@@ -666,14 +734,14 @@ Kaffy has support for Ecto's [embedded schemas](https://hexdocs.pm/ecto/Ecto.Sch
 
 Kaffy provides very basic search capabilities.
 
-Currently, only `:string` and `:text` fields are supported for search.
+Supported field types are: `:string`, `:textarea`, `:richtext`, `:id`, `:integer`, and `:decimal`.
 
 If you need to customize the list of fields to search against, define the `search_fields/1` function.
 
 ```elixir
 defmodule MyApp.Blog.PostAdmin do
   def search_fields(_schema) do
-    [:title, :slug, :body]
+    [:id, :title, :body, :views]
   end
 end
 ```
@@ -687,16 +755,16 @@ defmodule MyApp.Blog.PostAdmin do
     [
       :title,
       :body,
+      :view,
       category: [:name, :description]
     ]
   end
 end
 ```
 
 This function takes a schema and returns a list of schema fields that you want to search.
-All the fields must be of type `:string` or `:text`.
 
-If this function is not defined, Kaffy will return all `:string` and `:text` fields by default.
+If this function is not defined, Kaffy will return all fields with supported types by default.
 
 ### Authorization
 

config/config.exs

@@ -1,4 +1,4 @@
-use Mix.Config
+import Config
 
 # Use Jason for JSON parsing in Phoenix
 # config :phoenix, :json_library, Jason

lib/kaffy/pagination.ex

@@ -4,7 +4,7 @@ defmodule Kaffy.Pagination do
   # number of pages to show on the showleft/right of the current page
   @pagination_delta 2
 
-  def get_pages(0, 0), do: []
+  def get_pages(1, 0), do: []
 
   def get_pages(current_page, total_page) do
     showleft = current_page - @pagination_delta