cm-admin 1.5.40 → 1.5.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f475032d34987ece76840fc174951e055960b8dfbd98ee71b8b57616eddc501d
-  data.tar.gz: e745cc4fafd087fcbc19edcb14d66a11c15ec04d072d6e0a8512a34f3438a91a
+  metadata.gz: 25d1608feb2a0f90e9e8e8202d8898e511a1e1bbb4bc463e0a327190eeedb27a
+  data.tar.gz: 7a2ccc290b1545db664634cb915f81a8dca27630c024e38cbbb9fbf1898cee72
 SHA512:
-  metadata.gz: 804bebee2f580d8ad4b63c389bc5f5af3c84de8ebc3aa71ead30392baf104a25b106983138d3ac12cbdabce6ebdb7987ddc864ed9cdf26174c7bc0fdc7cbbddf
-  data.tar.gz: bb9ef705565cafdd1229281da4ad28dedf126557943779390db4c1c53f8d5d88f9b0bd4220c3d609e5cf19070a9a8c502c6c0f7cfbd9413d8502783aa327c932
+  metadata.gz: 15783cf2216b6390a976eeacc314f5a89b0b696ee777648c2e8bcd9e58fff27e625b1b5f29336d0ac31327833e148b5fb8c563b984df79e1e8d5c321ba27b23a
+  data.tar.gz: 2d3672c631061c354c3e2b72589ceb8b4e5d42f81b3efd9eed9f8b55a743336d434c4ea826bd3a66c3befb11bc770a8c647ddf879c9b86fa1c10296f4c2d265f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cm-admin (1.5.39)
+    cm-admin (1.5.42)
       caxlsx_rails
       cocoon (~> 1.2.15)
       csv-importer (~> 0.8.2)
@@ -12,7 +12,6 @@ PATH
       rails (>= 6.0)
       slim (~> 4.1.0)
       webpacker (~> 5.4.3)
-      yard
 
 GEM
   remote: https://rubygems.org/
@@ -258,7 +257,6 @@ GEM
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    yard (0.9.36)
     zeitwerk (2.6.15)
 
 PLATFORMS

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/javascripts/cm_admin/filters.js

@@ -42,9 +42,8 @@ var getFilteredData = function(filterType, filterValue, filterColumn=null) {
   // Generate the queryString by concatenating the filterParams and
   // searchParams that are already applied, if searchParams are present.
   var searchParams = window.location.search
-  var searchParamshash = getParamsAsObject(searchParams)
-  var tempsearchParamshash = delete searchParamshash['page']
-  if (tempsearchParamshash.length > 0) {
+  var searchParamsHash = getParamsAsObject(searchParams)
+  if (Object.keys(searchParamsHash).length > 0) {
     // Delete the previous applied value for multi_select filter from the
     // searchParams as altering the array with new and old value will create
     // more complicated logic. The new value is passed and structured in

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

@@ -41,13 +41,3 @@ $(document).on("click", '[data-behaviour="form_submit"]', function (e) {
     return $('[data-behaviour="form_submit"]').button("loading");
   }
 });
-
-$(document).on("change", '[data-behaviour="multiple-checkbox"]', function (e) {
-  const inputField = e.target.previousElementSibling;
-
-  if (e.target.checked) {
-    inputField.setAttribute("disabled", "disabled");
-  } else {
-    inputField.removeAttribute("disabled");
-  }
-});

data/app/controllers/cm_admin/resource_controller.rb

@@ -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/cm_admin.gemspec

@@ -37,6 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('rails', '>= 6.0')
   spec.add_runtime_dependency 'slim', '~> 4.1.0'
   spec.add_runtime_dependency 'webpacker', '~> 5.4.3'
-  spec.add_runtime_dependency 'yard'
   spec.add_dependency 'importmap-rails'
 end

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

@@ -8,9 +8,15 @@ module CmAdmin
       # @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
+      # @param view_type [Symbol] view type of page +:table+, +:card+ or +:kanban+
       # @example Index page
-      #  cm_index(page_title: "Home", page_description: 'Home page', partial: 'pages/home', view_type: :table)
+      #  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)
@@ -19,12 +25,21 @@ module CmAdmin
 
       # Create a view for show page
       #
-      # @param page_title [String] or [Symbol] the title of page, if symbol passed, it will be a method name on model
+      # @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: "Home", page_description: 'Home page', partial: 'pages/home')
+      #   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)
@@ -39,7 +54,12 @@ module CmAdmin
       # @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: "Home", redirect_to: ->(current_object) { "/pages/#{current_object.id}" })
+      #   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)
@@ -54,7 +74,12 @@ module CmAdmin
       # @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: "Home", redirect_to: ->(current_object) { "/pages/#{current_object.id}" })
+      #   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)
@@ -102,13 +127,15 @@ module CmAdmin
       # @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_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')
+      #   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')
@@ -129,6 +156,10 @@ module CmAdmin
       # @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)
@@ -142,6 +173,8 @@ module CmAdmin
 
       # @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)
@@ -154,10 +187,10 @@ module CmAdmin
 
       # 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 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 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
@@ -207,21 +240,29 @@ module CmAdmin
       # @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 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 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 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 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' }
+      #   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?)
+      #   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
       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_description:,
@@ -240,13 +281,17 @@ module CmAdmin
       # @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 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 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' }
+      #   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:, display_name:, display_if:, modal_configuration:,
@@ -258,7 +303,7 @@ module CmAdmin
 
       # 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 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
@@ -268,12 +313,13 @@ module CmAdmin
       #  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:, filter_type:, options:)
       end
 
       # Set sort direction for filters
-      # @param direction [Symbol] the direction of sort, `:asc`, `:desc`
+      # @param direction [Symbol] the direction of sort, +:asc+, +:desc+
       # @example Setting sort direction
       #  sort_direction(:asc)
       def sort_direction(direction = :desc)

data/lib/cm_admin/models/form_field.rb

@@ -9,7 +9,7 @@ module CmAdmin
                     :placeholder, :display_if, :html_attrs, :target, :col_size, :ajax_url, :helper_text
 
       VALID_INPUT_TYPES = %i[
-        integer decimal string single_select multi_select date date_time text switch custom_single_select
+        integer decimal string single_select multi_select date date_time text switch custom_single_select checkbox_group
         single_file_upload multi_file_upload hidden rich_text check_box radio_button custom_string custom_date
       ].freeze
 

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '1.5.40'
+  VERSION = '1.5.42'
 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

@@ -57,15 +57,15 @@ 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
           concat form_obj.check_box cm_field.field_name,
-                             merge_wrapper_options(
-                               {
-                                 class: "field-control form-check-input #{required_class}",
-                                 disabled: cm_field.disabled.call(form_obj.object),
-                                 value:,
-                                 role: 'switch'
-                               }, cm_field.html_attrs
-                             )
-            concat content_tag(:div, cm_field.field_name.to_s.titleize, class: 'cm-switch-label')
+                                    merge_wrapper_options(
+                                      {
+                                        class: "field-control form-check-input #{required_class}",
+                                        disabled: cm_field.disabled.call(form_obj.object),
+                                        value:,
+                                        role: 'switch'
+                                      }, cm_field.html_attrs
+                                    )
+          concat content_tag(:div, cm_field.label, class: 'cm-switch-label')
         end
       end
 
@@ -239,12 +239,42 @@ module CmAdmin
         end
       end
 
-      def cm_check_box_field(form_obj, cm_field, value, required_class, target_action, _ajax_url)
-        format_check_box_options(value, form_obj, cm_field, required_class, target_action)
+      def cm_check_box_field(form_obj, cm_field, _value, required_class, target_action, _ajax_url)
+        content_tag :div, class: 'form-check' do
+          concat form_obj.check_box cm_field.field_name,
+                                    merge_wrapper_options(
+                                      {
+                                        class: "form-check-input #{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
+                                    )
+          concat content_tag(:div, cm_field.label, class: 'cm-checkbox-label')
+        end
+      end
+
+      def cm_checkbox_group_field(form_obj, cm_field, value, required_class, _target_action, _ajax_url)
+        original_value = form_obj.object.send(cm_field.field_name)
+        content_tag :div do
+          concat form_obj.text_field cm_field.field_name, name: "#{@model.name.underscore}[#{cm_field.field_name}][]",
+                                                          value: nil, hidden: true
+          value.each do |key, val|
+            is_checked = original_value.include?(val)
+            concat format_check_box(val || key, key, form_obj, cm_field, required_class, is_checked)
+          end
+        end
       end
 
-      def cm_radio_button_field(form_obj, _cm_field, value, _required_class, _target_action, _ajax_url)
-        format_radio_button_options(value, form_obj)
+      def cm_radio_button_field(form_obj, cm_field, value, _required_class, _target_action, _ajax_url)
+        content_tag :div do
+          value.each do |key, val|
+            concat format_radio_option(val || key, key, cm_field, form_obj)
+          end
+        end
       end
 
       def cm_hidden_field(form_obj, cm_field, value, _required_class, _target_action, _ajax_url)
@@ -269,89 +299,23 @@ module CmAdmin
         end
       end
 
-      def format_check_box_options(value, form_obj, cm_field, required_class, target_action)
-        if value.instance_of?(Array)
-          format_check_box_array(value, form_obj, cm_field, required_class, target_action)
-        else
-          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
-
-      def format_check_box_array(options, form_obj, cm_field, required_class, target_action)
-        content_tag :div do
-          options.each do |key, val|
-            concat format_check_box(val, key, form_obj, cm_field, required_class, target_action)
-          end
-        end
-      end
-
-      def format_check_box(val, key, form_obj, cm_field, required_class, target_action)
-        content_tag :div, class: 'cm-checkbox-section' do
-          concat format_check_box_tag(val, form_obj, cm_field, required_class, target_action)
-          concat content_tag(:div, key, class: 'cm-checkbox-label')
-        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-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
-            concat form_obj.text_field cm_field.field_name, name: "#{@model.name.underscore}[#{cm_field.field_name}][]", value: '0', hidden: true
-          end
-          concat check_box_tag "#{@model.name.underscore}[#{cm_field.field_name}][]", '1', val,
+      def format_check_box(val, key, form_obj, cm_field, required_class, is_checked)
+        content_tag :div, class: 'form-check' do
+          concat check_box_tag "#{@model.name.underscore}[#{cm_field.field_name}][]", val, is_checked,
                                merge_wrapper_options(
                                  {
-                                   class: "cm-checkbox multiple-checkbox #{required_class} #{target_action.present? ? 'linked-field-request' : ''}",
-                                   disabled: cm_field.disabled.call(form_obj.object),
-                                   data: {
-                                     behaviour: 'multiple-checkbox',
-                                     target_action: target_action&.name,
-                                     target_url: target_action&.name ? cm_admin.send("#{@model.name.underscore}_#{target_action&.name}_path", ':param_1') : ''
-                                   }
+                                   class: "form-check-input #{required_class}",
+                                   disabled: cm_field.disabled.call(form_obj.object)
                                  }, cm_field.html_attrs
                                )
+          concat content_tag(:div, key, class: 'cm-checkbox-label')
         end
       end
 
-      def format_radio_button_options(options, form_obj)
-        content_tag :div do
-          options.each do |val, key|
-            concat format_radio_option(val, key, form_obj)
-          end
-        end
-      end
-
-      def format_radio_option(val, key, form_obj)
-        content_tag :div, class: 'cm-radio-section' do
-          concat format_radio_button(val, form_obj)
-          concat content_tag(:div, key, class: 'cm-radio-label')
-        end
-      end
-
-      def format_radio_button(val, form_obj)
-        content_tag :div, class: 'cm-radio-tag' do
-          concat form_obj.radio_button :level, val, class: 'field-control cm-radio'
+      def format_radio_option(val, key, cm_field, form_obj)
+        content_tag :div, class: 'form-check' do
+          concat form_obj.radio_button cm_field.field_name, val, merge_wrapper_options({ class: 'form-check-input' }, cm_field.html_attrs)
+          concat content_tag(:div, key, class: 'form-check-label')
         end
       end
 

data/lib/cm_admin/view_helpers/form_helper.rb

@@ -112,7 +112,7 @@ module CmAdmin
             concat input_field_for_column(form_obj, field)
           else
             concat(content_tag(:div, class: "form-field #{field.disabled ? 'disabled' : ''}") do
-              if field.label
+              if field.label && %i[check_box switch].exclude?(field.input_type)
                 concat form_obj.label field.label, field.label, class: 'field-label'
                 concat tag.br
               end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 1.5.40
+  version: 1.5.42
 platform: ruby
 authors:
 - Michael
@@ -11,10 +11,10 @@ authors:
 - Pranav
 - Mahaveer
 - Austin
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -142,20 +142,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.4.3
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
@@ -221,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
@@ -506,7 +493,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/commutatus/cm-admin
   source_code_uri: https://github.com/commutatus/cm-admin
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -521,8 +508,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: CmAdmin is a robust gem designed to assist in creating admin panels for Rails
   applications