cm-admin 1.5.35 → 1.5.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e040c173b4dc72d86d645df5fd314f10cee91457e38589ebe85cc6ce4d15936a
-  data.tar.gz: 0d423f9be6c3b5b99f44ff8618b11aaf67032404875a251eb346b10edf0c5389
+  metadata.gz: 7206f32a1a0f0a94b11d1005a34b2cabc4418aad7f1481be333e8b4eca2e760f
+  data.tar.gz: 58e0f084865aa2fe6846593d32533f48cbb8415e25316fcef1649cca5a961962
 SHA512:
-  metadata.gz: f1c2c45019460ba876581ff9bfd28a56e94192212718610f37ccc6d7f13d88294f9fb72c85e41a074c68c3bc4b1eea645867a7d80228ed11bd68a1375a4dcc1c
-  data.tar.gz: 516878f3063839d82fc0393dd6b66abd3e250671508f0d738d4689249e42f3ccce227e21e197cccb59c0dbad4875739ff6c483676bc66fd1d2528700cf8ebed1
+  metadata.gz: b657c82c245e115ef8b5ef3481c75de30fe9c39873a3ae41537733cffca35470ef4d8dd8d31a570c3bc1b7bc446942b67ec2140bfe7029a94f85fe517966569f
+  data.tar.gz: 9181f431af0474e8df9cfdf05b87a46d850dde9ab9d53e68c04f7e1457df89fef109bf39b4972f4fd5123a7a048227a951488b17331778259902951959c840d9

data/Gemfile.lock

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

data/cm_admin.gemspec

@@ -3,8 +3,8 @@ require_relative 'lib/cm_admin/version'
 Gem::Specification.new do |spec|
   spec.name          = 'cm-admin'
   spec.version       = CmAdmin::VERSION
-  spec.authors       = ['Michael', 'Anbazhagan', 'Ayza', 'Barath', 'Pranav', 'Mahaveer']
-  spec.email         = ['mkv@commutatus.com', 'anbublacky@gmail.com', 'ayza@commutatus.com', 'barath@commutatus.com', 'pranav@commutatus.com', 'mahaveer@commutatus.com']
+  spec.authors       = %w[Michael Anbazhagan Ayza Barath Pranav Mahaveer Austin]
+  spec.email         = ['mkv@commutatus.com', 'anbublacky@gmail.com', 'ayza@commutatus.com', 'barath@commutatus.com', 'pranav@commutatus.com', 'mahaveer@commutatus.com', 'austin@commutatus.com']
 
   spec.summary       = 'CmAdmin is a robust gem designed to assist in creating admin panels for Rails applications'
   spec.description   = 'CmAdmin providing a streamlined and efficient solution for building customized admin panels within the context of Rails applications. Its robust features empower developers to effortlessly generate and manage administrative interfaces with precision and ease.'

data/lib/cm_admin/models/dsl_method.rb

@@ -28,27 +28,26 @@ module CmAdmin
       end
 
       def page_title(title)
-        if @current_action
-          @current_action.page_title = title
-        end
+        return unless @current_action
+
+        @current_action.page_title = title
       end
 
       def page_description(description)
-        if @current_action
-          @current_action.page_description = description
-        end
+        return unless @current_action
+
+        @current_action.page_description = description
       end
 
       def kanban_view(column_name, exclude: [], only: [])
-        if @current_action
-          @current_action.kanban_attr[:column_name] = column_name
-          @current_action.kanban_attr[:exclude] = exclude
-          @current_action.kanban_attr[:only] = only
-        end
+        return unless @current_action
 
+        @current_action.kanban_attr[:column_name] = column_name
+        @current_action.kanban_attr[:exclude] = exclude
+        @current_action.kanban_attr[:only] = only
       end
 
-      def scope_list(scopes=[])
+      def scope_list(scopes = [])
         return unless @current_action
 
         @current_action.scopes = scopes
@@ -59,9 +58,9 @@ module CmAdmin
           @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,
-                      action_type: :custom, display_type: :page, model_name: self.name)
+          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,
+                                               action_type: :custom, display_type: :page, model_name: name)
           @available_actions << action
           @current_action = action
           @available_tabs << CmAdmin::Models::Tab.new(tab_name, custom_action, display_if, &block)
@@ -74,9 +73,9 @@ module CmAdmin
         @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Row.new(@current_action, @model, display_if, &block)
       end
 
-      def cm_section(section_name, display_if: nil, col_size: nil, &block)
+      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, col_size, &block)
+        @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.
@@ -84,13 +83,11 @@ module CmAdmin
         cm_section(section_name, display_if: display_if, &block)
       end
 
-      def column(field_name, options={})
+      def column(field_name, options = {})
         @available_fields[@current_action.name.to_sym] ||= []
-        if @available_fields[@current_action.name.to_sym].select{|x| x.lockable}.size > 0 && options[:lockable]
-          raise 'Only one column can be locked in a table.'
-        end
+        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]
 
-        duplicate_columns = @available_fields[@current_action.name.to_sym].filter{|x| x.field_name.to_sym == field_name}
+        duplicate_columns = @available_fields[@current_action.name.to_sym].filter { |x| x.field_name.to_sym == field_name }
         terminate = false
 
         if duplicate_columns.size.positive?
@@ -103,15 +100,15 @@ module CmAdmin
           end
         end
 
-        unless terminate
-          @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Column.new(field_name, options)
-        end
+        return if terminate
+
+        @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Column.new(field_name, options)
       end
 
-      def all_db_columns(options={})
-        field_names = self.instance_variable_get(:@ar_model)&.columns&.map{|x| x.name.to_sym}
+      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
-          excluded_fields = (Array.new << options[:exclude]).flatten.map(&:to_sym)
+          excluded_fields = ([] << options[:exclude]).flatten.map(&:to_sym)
           field_names -= excluded_fields
         end
         field_names.each do |field_name|
@@ -130,19 +127,20 @@ module CmAdmin
       #     end
       #   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: lambda { |arg| return 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: self.current_action.name, display_type: display_type, display_if: display_if,
+          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)
+          model_name: self.name, url_params: url_params, &block
+        )
         @available_actions << action
         # self.class.class_eval(&block)
       end
 
-      def bulk_action(name: nil, display_name: nil, display_if: lambda { |arg| return true }, redirection_url: nil, icon_name: nil, verb: nil, display_type: nil, modal_configuration: {}, route_type: nil, partial: nil, &block)
+      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,
@@ -151,7 +149,7 @@ module CmAdmin
         @available_actions << bulk_action
       end
 
-      def filter(db_column_name, filter_type, options={})
+      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)
       end
 

data/lib/cm_admin/models/row.rb

@@ -1,24 +1,24 @@
 module CmAdmin
   module Models
     class Row
-
       # Description
       # A row is like a container which holds a list of form_field or section.
       # These list of fields or section are iterated and displayed on new/edit page.
       # A row is like a wrapper on the HTML, which adds a div element 'row' class from bootstrap.
 
-      attr_accessor :sections, :display_if, :row_fields
+      attr_accessor :sections, :display_if, :row_fields, :html_attrs
 
-      def initialize(current_action, cm_model, display_if, &block)
+      def initialize(current_action, cm_model, display_if, html_attrs, &block)
         @sections = []
         @row_fields = []
-        @display_if = display_if || lambda { |arg| return true }
+        @display_if = display_if || ->(arg) { true }
+        @html_attrs = html_attrs || {}
         @current_action = current_action
         @cm_model = cm_model
         instance_eval(&block)
       end
 
-      def form_field(field_name, options={}, arg=nil)
+      def form_field(field_name, options = {}, arg = nil)
         if @current_action.is_nested_field
           @nested_table_fields[@current_action.nested_table_name] ||= []
           @nested_table_fields[@current_action.nested_table_name] << CmAdmin::Models::FormField.new(field_name, options[:input_type], options)
@@ -27,7 +27,7 @@ module CmAdmin
         end
       end
 
-      def field(field_name, options={})
+      def field(field_name, options = {})
         if @current_nested_field
           @current_nested_field.fields << CmAdmin::Models::Field.new(field_name, options)
         else
@@ -35,13 +35,13 @@ module CmAdmin
         end
       end
 
-      def cm_section(section_name, col_size: nil, display_if: nil, &block)
-        @sections << CmAdmin::Models::Section.new(section_name, @current_action, @model, display_if, col_size, &block)
+      def cm_section(section_name, col_size: nil, display_if: nil, html_attrs: nil, &block)
+        @sections << 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.
-      def cm_show_section(section_name, col_size: nil, display_if: nil, &block)
-        cm_section(section_name, col_size: col_size, display_if: display_if, &block)
+      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
     end
   end

data/lib/cm_admin/models/section.rb

@@ -1,15 +1,14 @@
 module CmAdmin
   module Models
     class Section
-
       # Description
       # A section is like a container which holds a list of fields or form fields
       # These list of fields are iterated and displayed on show/new/edit page.
       # It also contains rows, which contains sections and fields.
 
-      attr_accessor :section_name, :section_fields, :display_if, :current_action, :cm_model, :nested_table_fields, :rows, :col_size, :current_nested_field
+      attr_accessor :section_name, :section_fields, :display_if, :current_action, :cm_model, :nested_table_fields, :rows, :col_size, :current_nested_field, :html_attrs
 
-      def initialize(section_name, current_action, cm_model, display_if, col_size, &block)
+      def initialize(section_name, current_action, cm_model, display_if, html_attrs, col_size, &block)
         @section_fields = []
         @rows = []
         @nested_table_fields = []
@@ -17,12 +16,13 @@ module CmAdmin
         @section_name = section_name
         @current_action = current_action
         @cm_model = cm_model
-        @display_if = display_if || lambda { |arg| return true }
+        @html_attrs = html_attrs || {}
+        @display_if = display_if || ->(arg) { true }
         @current_nested_field = nil
         instance_eval(&block)
       end
 
-      def field(field_name, options={})
+      def field(field_name, options = {})
         if @current_nested_field
           @current_nested_field.fields << CmAdmin::Models::Field.new(field_name, options)
         else
@@ -30,7 +30,7 @@ module CmAdmin
         end
       end
 
-      def form_field(field_name, options={}, arg=nil)
+      def form_field(field_name, options = {}, arg = nil)
         if @current_nested_field
           @current_nested_field.fields << CmAdmin::Models::FormField.new(field_name, options[:input_type], options)
         else
@@ -38,7 +38,7 @@ module CmAdmin
         end
       end
 
-      def nested_form_field(field_name, options={}, &block)
+      def nested_form_field(field_name, options = {}, &block)
         # @current_action.is_nested_field = true
         # @current_action.nested_table_name = field_name
         nested_field = CmAdmin::Models::NestedField.new(field_name, options)
@@ -55,7 +55,6 @@ module CmAdmin
         @rows ||= []
         @rows << CmAdmin::Models::Row.new(@current_action, @model, display_if, &block)
       end
-
     end
   end
-end
+end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '1.5.35'
+  VERSION = '1.5.36'
 end

data/lib/cm_admin/view_helpers/form_helper.rb

@@ -6,7 +6,7 @@ module CmAdmin
   module ViewHelpers
     module FormHelper
       include FormFieldHelper
-      REJECTABLE = %w(id created_at updated_at)
+      REJECTABLE = %w[id created_at updated_at]
 
       def generate_form(resource, cm_model)
         if resource.new_record?
@@ -16,11 +16,9 @@ module CmAdmin
           action = :edit
           method = :patch
         end
-        if cm_model.available_fields[action].empty?
-          return form_with_all_fields(resource, method)
-        else
-          return form_with_mentioned_fields(resource, cm_model.available_fields[action], method)
-        end
+        return form_with_all_fields(resource, method) if cm_model.available_fields[action].empty?
+
+        form_with_mentioned_fields(resource, cm_model.available_fields[action], method)
       end
 
       def form_with_all_fields(resource, method)
@@ -47,7 +45,7 @@ module CmAdmin
             elsif entity.class == CmAdmin::Models::Section
               next unless entity.display_if.call(form_obj.object)
 
-              concat(content_tag(:div, class: 'row') do
+              concat(content_tag(:div, class: 'row', **entity.html_attrs) do
                 concat create_sections(resource, form_obj, entity)
               end)
             end
@@ -80,7 +78,7 @@ module CmAdmin
             end
           end)
         end
-        return
+        nil
       end
 
       def set_form_for_fields(resource, form_obj, section)
@@ -97,7 +95,7 @@ module CmAdmin
             concat set_form_field(resource, form_obj, field)
           end)
         end
-        return
+        nil
       end
 
       def set_form_field(resource, form_obj, field)
@@ -123,7 +121,7 @@ module CmAdmin
       def set_nested_form_fields(form_obj, section)
         content_tag(:div) do
           section.nested_table_fields.each do |nested_table_field|
-            concat(render partial: '/cm_admin/main/nested_table_form', locals: { f: form_obj, nested_table_field: nested_table_field })
+            concat(render(partial: '/cm_admin/main/nested_table_form', locals: { f: form_obj, nested_table_field: nested_table_field }))
           end
         end
       end
@@ -131,34 +129,31 @@ module CmAdmin
       def set_form_with_sections(resource, entities, url, method)
         url_with_query_params = extract_query_params(url)
 
-        form_for(resource, url: url_with_query_params || url, method: method, html: { class: "cm_#{resource.class.name.downcase}_form" } ) do |form_obj|
-          if params[:referrer]
-            concat form_obj.text_field "referrer", class: "normal-input", hidden: true, value: params[:referrer], name: 'referrer'
-          end
+        form_for(resource, url: url_with_query_params || url, method: method, html: { class: "cm_#{resource.class.name.downcase}_form" }) do |form_obj|
+          concat form_obj.text_field 'referrer', class: 'normal-input', hidden: true, value: params[:referrer], name: 'referrer' if params[:referrer]
           if params[:polymorphic_name].present?
-            concat form_obj.text_field params[:polymorphic_name] + '_type', class: "normal-input", hidden: true, value: params[:associated_class].classify
-            concat form_obj.text_field params[:polymorphic_name] + '_id', class: "normal-input", hidden: true, value: params[:associated_id]
+            concat form_obj.text_field params[:polymorphic_name] + '_type', class: 'normal-input', hidden: true, value: params[:associated_class].classify
+            concat form_obj.text_field params[:polymorphic_name] + '_id', class: 'normal-input', hidden: true, value: params[:associated_id]
           elsif params[:associated_class] && params[:associated_id]
-            concat form_obj.text_field params[:associated_class] + '_id', class: "normal-input", hidden: true, value: params[:associated_id]
+            concat form_obj.text_field params[:associated_class] + '_id', class: 'normal-input', hidden: true, value: params[:associated_id]
           end
 
           concat split_form_into_section(resource, form_obj, entities)
           concat tag.br
-          concat form_obj.submit 'Save', class: 'btn-cta', data: {behaviour: 'form_submit', form_class: "cm_#{form_obj.object.class.name.downcase}_form"}
+          concat form_obj.submit 'Save', class: 'btn-cta', data: { behaviour: 'form_submit', form_class: "cm_#{form_obj.object.class.name.downcase}_form" }
         end
       end
 
-
       def extract_query_params(url)
         query_params = {}
-        if params[:polymorphic_name].present? || params[:associated_id].present? && params[:associated_class].present?
-          query_params[:polymorphic_name] = params[:polymorphic_name]
-          query_params[:associated_id] = params[:associated_id]
-          query_params[:associated_class] = params[:associated_class]
-          query_params[:referrer] = params[:referrer] if params[:referrer].present?
+        return unless params[:polymorphic_name].present? || params[:associated_id].present? && params[:associated_class].present?
 
-          return url + '?' + query_params.to_query unless query_params.empty?
-        end
+        query_params[:polymorphic_name] = params[:polymorphic_name]
+        query_params[:associated_id] = params[:associated_id]
+        query_params[:associated_class] = params[:associated_class]
+        query_params[:referrer] = params[:referrer] if params[:referrer].present?
+
+        url + '?' + query_params.to_query unless query_params.empty?
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 1.5.35
+  version: 1.5.36
 platform: ruby
 authors:
 - Michael
@@ -10,10 +10,11 @@ authors:
 - Barath
 - Pranav
 - Mahaveer
+- Austin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -166,6 +167,7 @@ email:
 - barath@commutatus.com
 - pranav@commutatus.com
 - mahaveer@commutatus.com
+- austin@commutatus.com
 executables: []
 extensions: []
 extra_rdoc_files: []