cm-admin 1.5.39 → 1.5.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fefeb86ee44a447393ca13e95d50acef37ecad2512b85518b24aaf09d307b777
-  data.tar.gz: 993f0514720d1af46c50f43ce7f2a00086b1823b0621b726e0f3c400170c30ab
+  metadata.gz: c64d865b82c2abfd0975930a349a1ba2f63ee85d5ecbf0a4e627d3cbc1629bb1
+  data.tar.gz: 5ce41edd98628d3b20315a5ca44c5be95daf578bbdd53c97192f114f58110545
 SHA512:
-  metadata.gz: 602dbdb98de4efd9c28149c8b3bb501d41274d36c13aa8053cb5e3c2e1e2b9581bfeeeb35d1650eebd81787c164cf821df146e5c030eb2ba882246dbc2d5e033
-  data.tar.gz: 7c90ad69eafc91876869dbbe5064d59fd698435d49bcdca6fca5fc43049055b0a0786dd0a563ba05e8cf09551b17114c2f5bf9195833b6dd90aab62d983294c5
+  metadata.gz: 7327d73ee5028535163d62e4f3dbc7197389132178331c9bf76e4e0bb463166a06fb74186c4c32c0a50871c37ead0895e7f4b43157646bb3a5ff59b3e5e7e207
+  data.tar.gz: fefcc76ae24e4cc066c9dc70831fa5f1974bfe03563c49863e319180adec9577eb0dcb6acae9a4d35d4b587a7a2b602d3a09e0cab4c4b03ae8eac1e12eddd286

data/.github/workflows/deploy-yard-docs.yml

@@ -0,0 +1,45 @@
+name: Deploy Yard Docs
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+      - name: Install Yard gem
+        run: gem install yard
+      - name: Build Yard Docs
+        run: yardoc lib/cm_admin/models/dsl_method.rb
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          name: github-pages # name of the artifact
+          path: ./doc
+          if-no-files-found: error
+
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages # artifact name
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

data/CNAME

@@ -0,0 +1 @@
+docs.cm-admin.commutatus.com

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cm-admin (1.5.39)
+    cm-admin (1.5.41)
       caxlsx_rails
       cocoon (~> 1.2.15)
       csv-importer (~> 0.8.2)

data/README.md

@@ -37,13 +37,19 @@ For demo repo check [here](https://github.com/commutatus/cm-admin-panel-demo)
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Deployment
+
+To release a new version of the Gem you can use Github Actions.
+
+Go to Actions tab in your repository and click on `Bump Gem` workflow.
+You will see `Run workflow` button click on it and choose `Bump Type`, then click `Run Workflow` and it will bump the version of the gem and push the changes to the repository.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/commutatus/cm-admin).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/javascripts/cm_admin/application.js

@@ -1,12 +1,12 @@
-import './scaffolds.js';
-import './shared_scaffolds.js';
-
-import './bulk_actions.js'
-import './cocoon.js'
-import './exports.js'
-import './filters.js'
-import './form_validation.js'
-import './quick_search.js'
-import './custom.js'
-import './kanban.js'
+import "./scaffolds.js";
+import "./shared_scaffolds.js";
 
+import "./bulk_actions.js";
+import "./cocoon.js";
+import "./exports.js";
+import "./filters.js";
+import "./form_validation.js";
+import "./quick_search.js";
+import "./custom.js";
+import "./kanban.js";
+import "./custom_action";

data/app/assets/javascripts/cm_admin/custom_action.js

@@ -0,0 +1,30 @@
+import * as bootstrap from "bootstrap";
+window.bootstrap = bootstrap;
+
+document.addEventListener("turbo:load", function () {
+  $('[data-action="fetch-modal"]').on("click", function (e) {
+    const actionName = $(this).attr("data-action_name");
+    const modelName = $(this).attr("data-model_name");
+    const recordId = $(this).attr("data-record_id");
+    const modalContainer = $(
+      "[data-behaviour='custom-action-modal-container']"
+    );
+    const routeMount = document.location.href.split("/")[3];
+
+    if (!actionName || !modelName || !recordId || !modalContainer) return;
+    $.ajax({
+      url: `/${routeMount}/${modelName}/${recordId}/custom_action_modal/${actionName}`,
+      method: "GET",
+      success: function (response) {
+        modalContainer.html(response);
+        const actionModal = new bootstrap.Modal(
+          modalContainer.children().first()
+        );
+        actionModal.show();
+      },
+      error: function (error) {
+        console.error("Error:", error);
+      },
+    });
+  });
+});

data/app/assets/stylesheets/cm_admin/components/_input.scss

@@ -109,6 +109,18 @@
 }
 
 //checkbox-style
+
+.cm-checkbox-section {
+  width: 100%;
+  float: left;
+  .cm-checkbox-label {
+    float: left;
+    padding-left: 10px;
+  }
+  .cm-checkbox-tag {
+    float: left;
+  }
+}
 input.cm-checkbox[type="checkbox"] {
   position: relative;
   // display: block;

data/app/controllers/cm_admin/resource_controller.rb

@@ -89,7 +89,7 @@ module CmAdmin
     end
 
     def import
-      @model = Model.find_by({name: controller_name.titleize})
+      @model = Model.find_by({name: controller_name.classify})
       allowed_params = params.permit(file_import: [:associated_model_name, :import_file]).to_h
       file_import = ::FileImport.new(allowed_params[:file_import])
       file_import.added_by = Current.user
@@ -101,7 +101,7 @@ module CmAdmin
     end
 
     def import_form
-      @model = Model.find_by({name: controller_name.titleize})
+      @model = Model.find_by({name: controller_name.classify})
       respond_to do |format|
         format.html { render '/cm_admin/main/import_form' }
       end
@@ -172,6 +172,17 @@ module CmAdmin
       end
     end
 
+    def cm_custom_action_modal(params)
+      scoped_model = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve
+      @ar_object = fetch_ar_object(scoped_model, params[:id])
+      if params[:action_name] == 'destroy'
+        render partial: '/layouts/destroy_action_modal', locals: { ar_object: @ar_object }
+      else
+        custom_action = @model.available_actions.select { |x| x.name == params[:action_name].to_s }.first
+        render partial: '/layouts/custom_action_modal', locals: { custom_action:, ar_object: @ar_object }
+      end
+    end
+
     def get_nested_table_fields(fields)
       nested_table_fields = []
       fields.each do |field|

data/app/javascript/packs/cm_admin/application.js

@@ -1,30 +1,27 @@
-require("@rails/ujs").start()
-require("turbolinks").start()
-require("@rails/activestorage").start()
-require("stylesheets/cm_admin/application")
-require("jquery")
-require("moment")
-require("bootstrap")
-require('flatpickr')
-require("jgrowl")
-require("trix")
-require('./scaffolds.js')
-require('/app/assets/javascripts/cm_admin/shared_scaffolds.js')
-require('/app/assets/javascripts/cm_admin/form_validation.js')
-require('/app/assets/javascripts/cm_admin/quick_search.js')
-require('/app/assets/javascripts/cm_admin/filters.js')
-require('/app/assets/javascripts/cm_admin/exports.js')
-require('/app/assets/javascripts/cm_admin/bulk_actions.js')
-
-import jQuery from 'jquery'
-import LocalTime from "local-time"
-window.$ = jQuery
-window.jQuery = jQuery
-
-LocalTime.start()
-require("@nathanvda/cocoon")
-import "@fortawesome/fontawesome-free/css/all"
-import "daterangepicker"
-
+require("@rails/ujs").start();
+require("turbolinks").start();
+require("@rails/activestorage").start();
+require("stylesheets/cm_admin/application");
+require("jquery");
+require("moment");
+require("bootstrap");
+require("flatpickr");
+require("jgrowl");
+require("trix");
+require("./scaffolds.js");
+require("/app/assets/javascripts/cm_admin/shared_scaffolds.js");
+require("/app/assets/javascripts/cm_admin/form_validation.js");
+require("/app/assets/javascripts/cm_admin/quick_search.js");
+require("/app/assets/javascripts/cm_admin/filters.js");
+require("/app/assets/javascripts/cm_admin/exports.js");
+require("/app/assets/javascripts/cm_admin/bulk_actions.js");
 
+import jQuery from "jquery";
+import LocalTime from "local-time";
+window.$ = jQuery;
+window.jQuery = jQuery;
 
+LocalTime.start();
+require("@nathanvda/cocoon");
+import "@fortawesome/fontawesome-free/css/all";
+import "daterangepicker";

data/app/views/cm_admin/main/_actions_dropdown.html.slim

@@ -27,7 +27,7 @@
                   i.fa.fa-trash
                 | Destroy
           - else
-            = link_to '', data: { bs_toggle: 'modal', bs_target: "##{@model.name.classify}DestroyModal-#{ar_object.id.to_s}" } do
+            div data={action: 'fetch-modal', model_name: "#{cm_model.name.underscore.pluralize}", action_name: "destroy", record_id: "#{ar_object.id.to_s}"}
               .popup-option
                 span
                   i.fa.fa-trash
@@ -42,7 +42,7 @@
                     i class="#{custom_action.icon_name}"
                   = custom_action_title(custom_action)
             - when :modal
-              = link_to '', data: { bs_toggle: 'modal', bs_target: "##{custom_action.name.classify}Modal-#{ar_object.id.to_s}" } do
+              div data={action: 'fetch-modal', model_name: "#{cm_model.name.underscore.pluralize}", action_name: "#{custom_action.name}", record_id: "#{ar_object.id.to_s}"}
                 .popup-option
                   span
                     i class="#{custom_action.icon_name}"

data/app/views/layouts/_custom_action_modal.html.slim

@@ -8,4 +8,4 @@
         - if custom_action.partial
           = render partial: custom_action.partial, locals: { custom_action: custom_action, ar_object: ar_object }
         - else
-          = render partial: 'cm_admin/main/custom_action_modal_form', locals: { custom_action: custom_action, ar_object: ar_object }
+          = render partial: 'cm_admin/main/custom_action_modal_form', locals: { custom_action: custom_action, ar_object: ar_object }

data/app/views/layouts/_custom_action_modals.html.slim

@@ -1,24 +1,25 @@
 - custom_action_with_modals = @model.available_actions.select{ |act| act if act.display_type == :modal && act.action_type == :custom }
 - bulk_action_with_modals = @model.available_actions.select{ |act| act if act.display_type == :modal && act.action_type == :bulk_action }
 - destroy_action = @ar_object ? available_actions(@model, @ar_object, 'destroy') : nil
+
+div[data-behaviour="custom-action-modal-container"]
+
 - if @associated_model
   - custom_action_with_modals += @associated_model.available_actions.select{ |act| act if act.display_type == :modal }
+
 - if @current_action&.name == 'index'
   - bulk_action_with_modals.each do |bulk_action|
     = render partial: '/layouts/custom_action_modal', locals: { custom_action: bulk_action, ar_object: nil }
-  - @ar_object.data.each do |ar_object|
-    - custom_action_with_modals.each do |custom_action|
-      = render partial: '/layouts/custom_action_modal', locals: { custom_action: custom_action, ar_object: ar_object }
-    - if destroy_action
-      = render partial: '/layouts/destroy_action_modal', locals: { ar_object: ar_object }
+
 - elsif @current_action&.name == 'show'
   - custom_action_with_modals.each do |custom_action|
-    = render partial: '/layouts/custom_action_modal', locals: { custom_action: custom_action, ar_object: @ar_object }
+    = render partial: '/layouts/custom_action_modal', locals: { custom_action: custom_action, ar_object: @ar_object  }
   - if destroy_action
       = render partial: '/layouts/destroy_action_modal', locals: { ar_object: @ar_object }
+
 - elsif @current_action&.action_type == :custom && @associated_ar_object&.data.present?
   - @associated_ar_object.data.each do |ar_object|
     - custom_action_with_modals.select{|custom_action| custom_action.model_name == @current_action.child_records.to_s.classify}.each do |custom_action|
       = render partial: '/layouts/custom_action_modal', locals: { custom_action: custom_action, ar_object: ar_object }
     - if destroy_action
-      = render partial: '/layouts/destroy_action_modal', locals: { ar_object: ar_object }
+      = render partial: '/layouts/destroy_action_modal', locals: { ar_object: ar_object }

data/config/routes.rb

@@ -16,7 +16,7 @@ CmAdmin::Engine.routes.draw do
         send(:post, 'import', to: "#{model.name.underscore}#import", as: "#{model.name.underscore}_import")
       end
     end
-    
+
     model.available_actions.sort_by {|act| act.name}.each do |act|
       scope model.name.tableize do
         # Define route only when action trail related field is present

data/lib/cm_admin/constants.rb

@@ -34,6 +34,10 @@ module CmAdmin
     },
     custom_action: {
       verb: :post
+    },
+    custom_action_modal: {
+      verb: :get,
+      path: ':id/custom_action_modal/:action_name'
     }
   }
   REJECTABLE_FIELDS = %w(id created_at updated_at)

data/lib/cm_admin/models/dsl_method.rb

@@ -3,42 +3,109 @@ module CmAdmin
     module DslMethod
       extend ActiveSupport::Concern
 
-      def cm_index(page_title: nil, page_description: nil, partial: nil, view_type: :table, &block)
+      # Create a table for index page with pagination.
+      #
+      # @param page_title [String] the title of page
+      # @param page_description [String] the description of page
+      # @param partial [String] the partial path of page
+      # @param view_type [Symbol] view type of page +:table+, +:card+ or +:kanban+
+      # @example Index page
+      #  cm_index do
+      #    page_title 'Post'
+      #    column :title
+      #    column :created_at, field_type: :date, format: '%d %b, %Y'
+      #    column :updated_at, field_type: :date, format: '%d %b, %Y', header: 'Last Updated At'
+      #  end
+      # rdoc-image:/public/examples/cm_index.png
+      def cm_index(page_title: nil, page_description: nil, partial: nil, view_type: :table)
         @current_action = CmAdmin::Models::Action.find_by(self, name: 'index')
         @current_action.set_values(page_title, page_description, partial, view_type)
         yield
       end
 
-      def cm_show(page_title: nil, page_description: nil, partial: nil, &block)
+      # Create a view for show page
+      #
+      # @param page_title [String | Symbol] the title of page, if symbol passed, it will be a method name on model
+      # @param page_description [String] the description of page
+      # @param partial [String] the partial path of page
+      #
+      # @example Showing page
+      #   cm_show page_title: :title do
+      #     tab :profile, '' do
+      #       cm_section 'Post Details' do
+      #         field :title
+      #         field :body, field_type: :rich_text
+      #         field :is_featured
+      #         field :status, field_type: :tag, tag_class: STATUS_TAG_COLOR
+      #       end
+      #     end
+      #   end
+      def cm_show(page_title: nil, page_description: nil, partial: nil)
         @current_action = CmAdmin::Models::Action.find_by(self, name: 'show')
         @current_action.set_values(page_title, page_description, partial)
         yield
       end
 
-      def cm_edit(page_title: nil, page_description: nil, partial: nil, redirect_to: nil, &block)
+      # Create a form for edit action
+      #
+      # @param page_title [String] or [Symbol] the title of page, if symbol passed, it will be a method name on model
+      # @param page_description [String] the description of page
+      # @param partial [String] the partial path of page
+      # @param redirect_to [Proc, nil] A lambda that takes the current object and redirect to path after update
+      #
+      # @example Editing page with a redirect
+      #   cm_edit(page_title: "Edit Post", page_description: 'Enter all details to edit Post', redirect_to: ->(current_object) { "/pages/#{current_object.id}" }) do
+      #     cm_section 'Details' do
+      #       form_field :title, input_type: :string
+      #       form_field :body, input_type: :rich_text
+      #     end
+      #   end
+      def cm_edit(page_title: nil, page_description: nil, partial: nil, redirect_to: nil)
         @current_action = CmAdmin::Models::Action.find_by(self, name: 'edit')
         @current_action.set_values(page_title, page_description, partial, redirect_to)
         yield
       end
 
-      def cm_new(page_title: nil, page_description: nil, partial: nil, redirect_to: nil, &block)
+      # Create a form for new action
+      #
+      # @param page_title [String] the title of page
+      # @param page_description [String] the description of page
+      # @param partial [String] the partial path of page
+      # @param redirect_to [Proc, nil] A lambda that takes the current object and redirect to path after create
+      #
+      # @example Creating a new page with a redirect
+      #   cm_new(page_title: "Add Post", page_description: 'Enter all details to add Post', redirect_to: ->(current_object) { "/pages/#{current_object.id}" }) do
+      #     cm_section 'Details' do
+      #       form_field :title, input_type: :string
+      #       form_field :body, input_type: :rich_text
+      #     end
+      #   end
+      def cm_new(page_title: nil, page_description: nil, partial: nil, redirect_to: nil)
         @current_action = CmAdmin::Models::Action.find_by(self, name: 'new')
         @current_action.set_values(page_title, page_description, partial, redirect_to)
         yield
       end
 
+      # Set page title for current action
+      # @param title [String] the title of page
       def page_title(title)
         return unless @current_action
 
         @current_action.page_title = title
       end
 
+      # Set page description for current action
+      # @param description [String] the description of page
       def page_description(description)
         return unless @current_action
 
         @current_action.page_description = description
       end
 
+      # Set kanban view for current action
+      # @param column_name [String] the name of column
+      # @param exclude [Array] the array of fields to exclude
+      # @param only [Array] the array of fields to include
       def kanban_view(column_name, exclude: [], only: [])
         return unless @current_action
 
@@ -47,19 +114,35 @@ module CmAdmin
         @current_action.kanban_attr[:only] = only
       end
 
+      # Set scopes for current action
+      # @param scopes [Array] the array of scopes
       def scope_list(scopes = [])
         return unless @current_action
 
         @current_action.scopes = scopes
       end
 
+      # Create a new tab on show page.
+      #
+      # @param tab_name [String] or [Symbol] the name of tab
+      # @param custom_action [String] the name of custom action
+      # @param associated_model [String] the name of associated model
+      # @param layout_type [String] the layout type of tab, +cm_association_index+, +cm_association_show+
+      # @param layout [String] the layout of tab
+      # @param partial [String] the partial path of tab
+      # @param display_if [Proc] A lambda that takes the current object and return true or false
+      #
+      # @example Creating a tab
+      #   tab :comments, 'comment', associated_model: 'comments', layout_type: 'cm_association_index' do
+      #     column :message
+      #   end
       def tab(tab_name, custom_action, associated_model: nil, layout_type: nil, layout: nil, partial: nil, display_if: nil, &block)
         if custom_action.to_s == ''
           @current_action = CmAdmin::Models::Action.find_by(self, name: 'show')
           @available_tabs << CmAdmin::Models::Tab.new(tab_name, '', display_if, &block)
         else
           action = CmAdmin::Models::Action.new(name: custom_action.to_s, verb: :get, path: ':id/' + custom_action,
-                                               layout_type: layout_type, layout: layout, partial: partial, child_records: associated_model,
+                                               layout_type:, layout:, partial:, child_records: associated_model,
                                                action_type: :custom, display_type: :page, model_name: name)
           @available_actions << action
           @current_action = action
@@ -68,21 +151,53 @@ module CmAdmin
         yield if block
       end
 
+      # Create a new row on page or form.
+      # @param display_if [Proc] A lambda that takes the current object and return true or false
+      # @param html_attrs [Hash] A hash that contains html attributes
+      # @example Creating a row
+      #  row(display_if: ->(current_object) { current_object.name == 'John' }, html_attrs: { class: 'row-class' }) do
+      #    cm_section 'Details' do
+      #      form_field :title, input_type: :string
+      #    end
+      #  end
       def row(display_if: nil, html_attrs: nil, &block)
         @available_fields[@current_action.name.to_sym] ||= []
         @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Row.new(@current_action, @model, display_if, html_attrs, &block)
       end
 
+      # Create a new section on page or form.
+      # @param section_name [String] the name of section
+      # @param display_if [Proc] A lambda that takes the current object and return true or false
+      # @param col_size [Integer] the size of column according to grid view
+      # @param html_attrs [Hash] A hash that contains html attributes
+
+      # @example Creating a section
+      #  cm_section('Basic Information', display_if: ->(current_object) { current_object.name == 'John' }, col_size: 6, html_attrs: { class: 'section-class' }) do
+      #    field :title, input_type: :string
+      #  end
       def cm_section(section_name, display_if: nil, col_size: nil, html_attrs: nil, &block)
         @available_fields[@current_action.name.to_sym] ||= []
         @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Section.new(section_name, @current_action, @model, display_if, html_attrs, col_size, &block)
       end
 
-      # This method is deprecated. Use cm_section instead.
+      # @deprecated Use {#cm_section} instead of this method
       def cm_show_section(section_name, display_if: nil, html_attrs: nil, &block)
-        cm_section(section_name, display_if: display_if, html_attrs: html_attrs, &block)
+        cm_section(section_name, display_if:, html_attrs:, &block)
       end
 
+      # Create a new column on index layout.
+      # @param field_name [String] the name of field
+      # @param field_type [Symbol] the type of field, +:string+, +:text+, +:image+, +:date+, +:rich_text+, +:time+, +:integer+, +:decimal+, +:custom+, +:datetime+, +:money+, +:money_with_symbol+, +:link+, +:association+, +:enum+, +:tag+, +:attachment+, +:drawer+
+      # @param header [String] the header of field
+      # @param format [String] the format of field for date field
+      # @param helper_method [Symbol] the helper method for field, should be defined in custom_helper.rb file, will take two arguments, +record+ and +field_name+
+      # @param height [Integer] the height of field for image field
+      # @param width [Integer] the width of field for image field
+      # @params custom_link [String] the custom link for field
+      # @params tag_class [Hash] the tag class for field, example: { approved: 'completed', draft: 'active-two', rejected: 'danger' }, this will add css class to tag
+      # @params display_if [Proc] A lambda that takes the current object and return true or false
+      # @example Creating a column
+      #  column('name', field_type: :string)
       def column(field_name, options = {})
         @available_fields[@current_action.name.to_sym] ||= []
         raise 'Only one column can be locked in a table.' if @available_fields[@current_action.name.to_sym].select { |x| x.lockable }.size > 0 && options[:lockable]
@@ -105,6 +220,10 @@ module CmAdmin
         @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Column.new(field_name, options)
       end
 
+      # Get all columns for a model for index layout.
+      # @param exclude [Array] the array of fields to exclude
+      # @example Getting all columns
+      #  all_db_columns(exclude: ['id'])
       def all_db_columns(options = {})
         field_names = instance_variable_get(:@ar_model)&.columns&.map { |x| x.name.to_sym }
         if options.include?(:exclude) && field_names
@@ -116,49 +235,103 @@ module CmAdmin
         end
       end
 
-      # Custom actions
-      # eg
-      # class User < ApplicationRecord
-      #   cm_admin do
-      #     custom_action name: 'submit', verb: 'post', path: ':id/submit' do
-      #       def user_submit
-      #         Code for action here...
-      #       end
-      #     end
+      # Create a new custom action for model
+      # @param name [String] the name of action
+      # @param page_title [String] the title of page
+      # @param page_description [String] the description of page
+      # @param display_name [String] the display name of action
+      # @param verb [String] the verb of action, +get+, +post+, +put+, +patch+ or +delete+
+      # @param layout [String] the layout of action
+      # @param layout_type [String] the layout type of action, +cm_association_index+, +cm_association_show+
+      # @param partial [String] the partial path of action
+      # @param path [String] the path of action
+      # @param display_type [Symbol] the display type of action, +:button+, +:modal+
+      # @param modal_configuration [Hash] the configuration of modal
+      # @param url_params [Hash] the url params of action
+      # @param display_if [Proc] A lambda that takes the current object and return true or false
+      # @param route_type [String] the route type of action, +member+, +collection+
+      # @param icon_name [String] the icon name of action, follow font-awesome icon name
+      # @example Creating a custom action with modal
+      #   custom_action name: 'approve', route_type: 'member', verb: 'patch', icon_name: 'fa-regular fa-circle-check', path: ':id/approve', display_type: :modal, display_if: lambda(&:draft?), modal_configuration: { title: 'Approve Post', description: 'Are you sure you want approve this post', confirmation_text: 'Approve' } do
+      #     post = ::Post.find(params[:id])
+      #     post.approved!
+      #     post
+      #   end
+      # @example Creating a custom action with button
+      #   custom_action name: 'approve', route_type: 'member', verb: 'patch', icon_name: 'fa-regular fa-circle-check', path: ':id/approve', display_type: :button, display_if: lambda(&:draft?) do
+      #     post = ::Post.find(params[:id])
+      #     post.approved!
+      #     post
       #   end
-      # end
-      def custom_action(name: nil, page_title: nil, page_description: nil, display_name: nil, verb: nil, layout: nil, layout_type: nil, partial: nil, path: nil, display_type: nil, modal_configuration: {}, url_params: {}, display_if: ->(arg) { true }, route_type: nil, icon_name: 'fa fa-th-large', &block)
+      def custom_action(name: nil, page_title: nil, page_description: nil, display_name: nil, verb: nil, layout: nil, layout_type: nil, partial: nil, path: nil, display_type: nil, modal_configuration: {}, url_params: {}, display_if: ->(_arg) { true }, route_type: nil, icon_name: 'fa fa-th-large', &block)
         action = CmAdmin::Models::CustomAction.new(
-          page_title: page_title, page_description: page_description,
-          name: name, display_name: display_name, verb: verb, layout: layout,
-          layout_type: layout_type, partial: partial, path: path,
-          parent: current_action.name, display_type: display_type, display_if: display_if,
-          action_type: :custom, route_type: route_type, icon_name: icon_name, modal_configuration: modal_configuration,
-          model_name: self.name, url_params: url_params, &block
+          page_title:, page_description:,
+          name:, display_name:, verb:, layout:,
+          layout_type:, partial:, path:,
+          parent: current_action.name, display_type:, display_if:,
+          action_type: :custom, route_type:, icon_name:, modal_configuration:,
+          model_name: self.name, url_params:, &block
         )
         @available_actions << action
-        # self.class.class_eval(&block)
       end
 
-      def bulk_action(name: nil, display_name: nil, display_if: ->(arg) { true }, redirection_url: nil, icon_name: nil, verb: nil, display_type: nil, modal_configuration: {}, route_type: nil, partial: nil, &block)
+      # Create a new bulk action for model
+      # @param name [String] the name of action
+      # @param display_name [String] the display name of action
+      # @param display_if [Proc] A lambda that takes the current object and return true or false
+      # @param redirection_url [String] the redirection url of action
+      # @param icon_name [String] the icon name of action, follow font-awesome icon name
+      # @param verb [String] the verb of action, +get+, +post+, +put+, +patch+ or +delete+
+      # @param display_type [Symbol] the display type of action, +:page+, +:modal+
+      # @param modal_configuration [Hash] the configuration of modal
+      # @param route_type [String] the route type of action, +member+, +collection+
+      # @param partial [String] the partial path of action
+      # @example Creating a bulk action
+      #   bulk_action name: 'approve', display_name: 'Approve', display_if: lambda { |arg| arg.draft? }, redirection_url: '/posts', icon_name: 'fa-regular fa-circle-check', verb: :patch, display_type: :modal, modal_configuration: { title: 'Approve Post', description: 'Are you sure you want approve this post', confirmation_text: 'Approve' } do
+      #     posts = ::Post.where(id: params[:ids])
+      #     posts.each(&:approved!)
+      #     posts
+      #   end
+      def bulk_action(name: nil, display_name: nil, display_if: ->(_arg) { true }, redirection_url: nil, icon_name: nil, verb: nil, display_type: nil, modal_configuration: {}, route_type: nil, partial: nil, &block)
         bulk_action = CmAdmin::Models::BulkAction.new(
-          name: name, display_name: display_name, display_if: display_if, modal_configuration: modal_configuration,
-          redirection_url: redirection_url, icon_name: icon_name, action_type: :bulk_action,
-          verb: verb, display_type: display_type, route_type: route_type, partial: partial, &block
+          name:, display_name:, display_if:, modal_configuration:,
+          redirection_url:, icon_name:, action_type: :bulk_action,
+          verb:, display_type:, route_type:, partial:, &block
         )
         @available_actions << bulk_action
       end
 
+      # Create a new filter for model
+      # @param db_column_name [String] the name of column
+      # @param filter_type [String] the type of filter, +:date+, +:multi_select+, +:range+, +:search+, +:single_select+
+      # @param placeholder [String] the placeholder of filter
+      # @param helper_method [String] the helper method for filter, should be defined in custom_helper.rb file
+      # @param filter_with [Symbol] filter with scope name on model
+      # @param collection [Array] the collection of filter, use with single_select or multi_select
+      # @example Creating a filter
+      #  filter('name', :search)
+      #  filter('created_at', :date)
+      #  filter('status', :single_select, collection: ['draft', 'published'])
+      #  filter('status', :multi_select,  helper_method: 'status_collection')
+      #  filter('age', :range)
       def filter(db_column_name, filter_type, options = {})
-        @filters << CmAdmin::Models::Filter.new(db_column_name: db_column_name, filter_type: filter_type, options: options)
+        @filters << CmAdmin::Models::Filter.new(db_column_name:, filter_type:, options:)
       end
 
+      # Set sort direction for filters
+      # @param direction [Symbol] the direction of sort, +:asc+, +:desc+
+      # @example Setting sort direction
+      #  sort_direction(:asc)
       def sort_direction(direction = :desc)
         raise ArgumentError, "Select a valid sort direction like #{CmAdmin::Models::Action::VALID_SORT_DIRECTION.join(' or ')} instead of #{direction}" unless CmAdmin::Models::Action::VALID_SORT_DIRECTION.include?(direction.to_sym.downcase)
 
         @current_action.sort_direction = direction.to_sym if @current_action
       end
 
+      # Set sort column for filters
+      # @param column [Symbol] the column name
+      # @example Setting sort column
+      #   sort_column(:created_at)
       def sort_column(column = :created_at)
         @current_action.sort_column = column.to_sym if @current_action
       end

data/lib/cm_admin/models/row.rb

@@ -43,6 +43,12 @@ module CmAdmin
       def cm_show_section(section_name, col_size: nil, display_if: nil, html_attrs: nil, &block)
         cm_section(section_name, col_size: col_size, display_if: display_if, html_attrs: html_attrs, &block)
       end
+
+      def nested_form_section(section_name, display_if: nil, col_size: nil, html_attrs: nil, &block)
+        nested_section = CmAdmin::Models::Section.new(section_name, @current_action, @cm_model, display_if, html_attrs, col_size, &block)
+        nested_section.parent_section = self
+        @row_fields << nested_section
+      end
     end
   end
 end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '1.5.39'
+  VERSION = '1.5.41'
 end

data/lib/cm_admin/view_helpers/field_display_helper.rb

@@ -87,6 +87,7 @@ module CmAdmin
           ar_object.send(field.field_name).to_s.titleize
         when :tag
           tag_class = field.tag_class.dig("#{ar_object.send(field.field_name.to_s)}".to_sym).to_s
+          tag_class = 'neutral' if tag_class.blank?
           content_tag :span, class: "status-tag #{tag_class}" do
             ar_object.send(field.field_name).to_s.titleize.upcase
           end

data/lib/cm_admin/view_helpers/form_field_helper.rb

@@ -56,7 +56,7 @@ module CmAdmin
 
       def cm_switch_field(form_obj, cm_field, value, required_class, _target_action, _ajax_url)\
         content_tag :div, class: 'form-check form-switch' do
-          form_obj.check_box cm_field.field_name,
+          concat form_obj.check_box cm_field.field_name,
                              merge_wrapper_options(
                                {
                                  class: "field-control form-check-input #{required_class}",
@@ -65,6 +65,7 @@ module CmAdmin
                                  role: 'switch'
                                }, cm_field.html_attrs
                              )
+            concat content_tag(:div, cm_field.field_name.to_s.titleize, class: 'cm-switch-label')
         end
       end
 
@@ -272,18 +273,10 @@ module CmAdmin
         if value.instance_of?(Array)
           format_check_box_array(value, form_obj, cm_field, required_class, target_action)
         else
-          form_obj.check_box cm_field.field_name,
-                             merge_wrapper_options(
-                               {
-                                 class: "cm-checkbox #{required_class} #{target_action.present? ? 'linked-field-request' : ''}",
-                                 disabled: cm_field.disabled.call(form_obj.object),
-                                 data: {
-                                   field_name: cm_field.field_name,
-                                   target_action: target_action&.name,
-                                   target_url: target_action&.name ? cm_admin.send("#{@model.name.underscore}_#{target_action&.name}_path") : ''
-                                 }
-                               }, cm_field.html_attrs
-                             )
+          content_tag :div, class: 'cm-checkbox-section' do
+            concat single_checkbox_tag(value, form_obj, cm_field, required_class, target_action)
+            concat content_tag(:div, cm_field.field_name.to_s.titleize, class: 'cm-checkbox-label')
+          end
         end
       end
 
@@ -302,8 +295,25 @@ module CmAdmin
         end
       end
 
+      def single_checkbox_tag(value, form_obj, cm_field, required_class, target_action)
+        content_tag :div, class: 'cm-checkbox-tag' do
+          concat form_obj.check_box cm_field.field_name,
+                         merge_wrapper_options(
+                           {
+                             class: "cm-checkbox #{required_class} #{target_action.present? ? 'linked-field-request' : ''}",
+                             disabled: cm_field.disabled.call(form_obj.object),
+                             data: {
+                               field_name: cm_field.field_name,
+                               target_action: target_action&.name,
+                               target_url: target_action&.name ? cm_admin.send("#{@model.name.underscore}_#{target_action&.name}_path") : ''
+                             }
+                           }, cm_field.html_attrs
+                         )
+        end
+      end
+
       def format_check_box_tag(val, form_obj, cm_field, required_class, target_action)
-        content_tag :div, class: 'cm-radio-tag' do
+        content_tag :div, class: 'cm-checkbox-tag' do
           if val.present?
             concat form_obj.text_field cm_field.field_name, name: "#{@model.name.underscore}[#{cm_field.field_name}][]", value: '0', hidden: true, disabled: 'disabled'
           else

data/lib/cm_admin/view_helpers/form_helper.rb

@@ -74,7 +74,11 @@ module CmAdmin
         rows.each do |row|
           concat(content_tag(:div, class: 'row') do
             row.row_fields.each do |field|
-              concat set_form_field(resource, form_obj, field)
+              if field.is_a?(CmAdmin::Models::Section)
+                concat set_nested_section_form_fields(resource, form_obj, Array(field))
+              else
+                concat set_form_field(resource, form_obj, field)
+              end
             end
           end)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 1.5.39
+  version: 1.5.41
 platform: ruby
 authors:
 - Michael
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -175,6 +175,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/deploy-yard-docs.yml"
 - ".github/workflows/linters.yml"
 - ".github/workflows/release-gem.yml"
 - ".gitignore"
@@ -184,6 +185,7 @@ files:
 - ".stylelintrc.json"
 - ".travis.yml"
 - ".vscode/settings.json"
+- CNAME
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -205,6 +207,7 @@ files:
 - app/assets/javascripts/cm_admin/bulk_actions.js
 - app/assets/javascripts/cm_admin/cocoon.js
 - app/assets/javascripts/cm_admin/custom.js
+- app/assets/javascripts/cm_admin/custom_action.js
 - app/assets/javascripts/cm_admin/exports.js
 - app/assets/javascripts/cm_admin/filters.js
 - app/assets/javascripts/cm_admin/form_validation.js