cm-admin 4.4.1 → 4.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b70f3ad1b412c2d150bd0d44c4c6427b1601ee13d560a5ac2a1d30c557f3e490
-  data.tar.gz: c414a509252f571277c60f52e6b24f1bddc54df4a954992dbbd2091e426235b0
+  metadata.gz: 2f200f0b81773d02d7dd472b90c0dcdc124cd3797e7a09b06cef05b42b597132
+  data.tar.gz: 31ebaa25c7016f262697e52f76bc695db07595286d8ac088175390d09eea1ffe
 SHA512:
-  metadata.gz: a6750b96ba62abb6a05263f58edb6a1084c35e21ee42d4b9678fad0609b91e23989b2881d5685ae6c6b95e9af487d7225cdf4df09f106ab5a3bb6a1171a7c2b4
-  data.tar.gz: 4568370042d25f4a350d484067c3028c5916e3d8f3bca251078a11b679d41df243b76d99f4caf2030b1389023354d1b48a95fb9b00a46ed9b15889817c7ef7cd
+  metadata.gz: a655ebbf63906cd67dd83f3e2a68eaff22c1d215a4e6b0eb1ea7e05b471ccb24907a65552236ca893161fa64979cb03c825d4b922637de73124fb601174df8d3
+  data.tar.gz: 9ebfab98bc9321b20141765412dbb229e6c994195a3f82de0c1420c423bea0fe6790aaaaf57147a92a9c850713e051f471e49f35e9d64f5e1d31a470fab6268a

data/.github/workflows/test.yml

@@ -7,6 +7,10 @@ jobs:
     if: "!contains(github.event.head_commit.message, '[skip-tests]')"
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        rails-version: ["7.1", "7.2", "8.0"]
+
     services:
       postgres:
         image: postgres:17
@@ -28,10 +32,16 @@ jobs:
 
       - name: Install dependencies
         working-directory: feature-app
-        run: bundle install
+        env:
+          RAILS_TEST_VERSION: ${{ matrix.rails-version }}
+        run: |
+          bundle install
+          bundle exec appraisal install
 
       - name: Set up database
         working-directory: feature-app
+        env:
+          RAILS_TEST_VERSION: ${{ matrix.rails-version }}
         run: |
           cp config/database.yml.ci config/database.yml
           RAILS_ENV=test bundle exec rails db:create
@@ -39,8 +49,12 @@ jobs:
 
       - name: Precompile assets
         working-directory: feature-app
+        env:
+          RAILS_TEST_VERSION: ${{ matrix.rails-version }}
         run: RAILS_ENV=test bundle exec rails assets:precompile
 
       - name: Run RSpec tests
         working-directory: feature-app
-        run: bundle exec rspec
+        env:
+          RAILS_TEST_VERSION: ${{ matrix.rails-version }}
+        run: bundle exec appraisal rails-${{ matrix.rails-version }} rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cm-admin (4.4.1)
+    cm-admin (4.4.8)
       caxlsx_rails
       cocoon (~> 1.2.15)
       csv (>= 3.3.0)
@@ -158,13 +158,13 @@ GEM
       timeout
     net-smtp (0.5.0)
       net-protocol
-    nio4r (2.7.4)
-    nokogiri (1.16.7)
+    nio4r (2.7.3)
+    nokogiri (1.18.1)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.16.7-arm64-darwin)
+    nokogiri (1.18.1-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
+    nokogiri (1.18.1-x86_64-linux-gnu)
       racc (~> 1.4)
     pagy (4.11.0)
     parallel (1.26.3)

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

@@ -1,6 +1,7 @@
 import "./scaffolds.js";
 import "./shared_scaffolds.js";
 
+import "./kanban.js";
 import "./bulk_actions.js";
 import "./cocoon.js";
 import "./exports.js";
@@ -8,5 +9,4 @@ 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/kanban.js

@@ -1,30 +1,32 @@
-$(document).on('click', '.kanban-show-more', function(e) {
-  e.preventDefault();
-  var page = $(this).data('page') + 1
-  var query_string = window.location.search
-  $.ajax('/admin/batch_order_items' + query_string, {
-    type: "GET",
-    data: {
-      page: page,
-      per_page: $(this).data('per-page'),
-      view_type: 'kanban'
-    },
-    success: function (data) {
-      apply_response_to_board(data.table.data);
-      $('.kanban-show-more').data('page', page)
-      if (data.table.paging.next_page == false) {
-        $('.kanban-show-more').addClass('disabled')
-      }
-      $('.kanban-show-more').data('page', page)
-    },
-    error: function (jqxhr, textStatus, errorThrown) {
-      alert("Something went wrong. Please try again later.\n" + errorThrown);
-    },
-  });
-})
+$(document).on("turbo:load", function() {
+  $(document).on('click', "[data-action='kanban-show-more']", function(e) {
+    e.preventDefault();
+    var page = $(this).data('page') + 1
+    var query_string = window.location.search
+    $.ajax('/admin/batch_order_items' + query_string, {
+      type: "GET",
+      data: {
+        page: page,
+        per_page: $(this).data('per-page'),
+        view_type: 'kanban'
+      },
+      success: function (data) {
+        apply_response_to_board(data.table.data);
+        $("[data-action='kanban-show-more']").data('page', page)
+        if (data.table.paging.next_page == false) {
+          $("[data-action='kanban-show-more']").addClass('disabled')
+        }
+        $("[data-action='kanban-show-more']").data('page', page)
+      },
+      error: function (jqxhr, textStatus, errorThrown) {
+        alert("Something went wrong. Please try again later.\n" + errorThrown);
+      },
+    });
+  })
 
-function apply_response_to_board(json_data) {
-  $.each(json_data, function(key, value) {
-    $('.' + key + ' .cards').append(value)
-  });
-}
+  function apply_response_to_board(json_data) {
+    $.each(json_data, function(key, value) {
+      $('.' + key + " [data-section='kanban-cards']").append(value)
+    });
+  }
+});

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

@@ -72,6 +72,11 @@ $(document).on("click", '[data-behaviour="offcanvas"]', function (e) {
   });
 });
 
+// Select2 focus on open
+$(document).on("select2:open", () => {
+  document.querySelector(".select2-search__field").focus();
+});
+
 $(document).on("click", '[data-bs-dismiss="offcanvas"]', function (e) {
   $(document).off("submit", "[data-is-drawer-form='true']");
 });

data/app/assets/stylesheets/cm_admin/base/sidebar.scss

@@ -68,26 +68,45 @@
         margin-left: 8px;
         vertical-align: text-bottom;
       }
+
       &:hover {
         color: $white;
-        background: rgba(255, 255, 255, 0.1);
+        @include white-rgba($opacity: 0.3);
       }
-    }
-    .menu-sub-list {
-      .menu-sub-item {
-        @include font($size: $t4-text, $color: $ink-lightest-clr);
-        padding: 8px 8px 8px 45px;
-        transition: all 0.2s linear;
-        &:hover {
-          color: $white;
-          background: rgba(255, 255, 255, 0.1);
+
+      .menu-sub-list {
+        .menu-sub-item {
+          @include font($size: $t4-text, $color: $ink-lightest-clr);
+          padding: 8px 8px 8px 45px;
+          transition: all 0.2s linear;
+          &:hover {
+            color: $white;
+             @include white-rgba($opacity: 0.1);
+          }
         }
       }
     }
+
+    .submenu-item{
+      padding: 8px 24px 8px 46px;
+    }
+    
     .menu-link {
       color: inherit;
       text-decoration: none;
     }
+
+    .selected-item {
+       @include white-rgba($opacity: 0.1);
+      font-weight: bold;
+    }
+
+    
+
+    .sidebar-dropdown-svg {
+      padding-left: 8px;
+      height: 12px;
+    }
   }
 
   &__tabs-wrapper {

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

@@ -20,7 +20,7 @@
 }
 
 .cm-admin .btn-secondary {
-  @extend .btn, .btn-outline-secondary, .btn-sm, .btn-icon-spacing;
+  @extend .btn, .btn-outline-dark, .btn-sm, .btn-icon-spacing;
 }
 
 .cm-admin .btn-ghost {

data/app/assets/stylesheets/cm_admin/helpers/_mixins.scss

@@ -18,3 +18,7 @@
   transition: all .2s linear;
 }
 
+@mixin white-rgba($opacity: 0.3) { 
+  background: rgba(255, 255, 255, $opacity); 
+}
+

data/app/controllers/cm_admin/resource_controller.rb

@@ -386,7 +386,7 @@ module CmAdmin
       group_record_count = final_data.group(params[:kanban_column_name] || @current_action.kanban_attr[:column_name]).count
       per_page = params[:per_page] || 20
       page = params[:page] || 1
-      max_page = (group_record_count.values.max.to_i / per_page.to_f).ceil
+      max_page = (group_record_count.reject { |k, _v| k.nil? }.values.max.to_i / per_page.to_f).ceil
       filtered_result.paging['next_page'] = (page.to_i < max_page)
       filtered_result.column_count = group_record_count.reject { |key, _value| key.blank? }
 
@@ -402,7 +402,7 @@ module CmAdmin
         next if page.to_i > (total_count.to_i / per_page.to_f).ceil
 
         _, records = pagy(final_data.send(column), items: per_page.to_i)
-        filtered_result.data[column] = render_to_string partial: 'cm_admin/main/kanban_card', locals: { ar_collection: records }
+        filtered_result.data[column] = render_to_string partial: 'cm_admin/main/kanban_card', locals: { ar_collection: records, column_name: column }
       end
       filtered_result
     end

data/app/helpers/cm_admin/application_helper.rb

@@ -20,6 +20,30 @@ module CmAdmin
       end
     end
 
+    def cm_recognize_path(path_helper)
+      http_methods = [:get, :post, :patch, :delete, :put, :options]
+      cm_admin_path = cm_admin.send(path_helper)
+      recognized_path = nil
+      http_methods.each do |method|
+        begin
+          recognized_path = Rails.application.routes.recognize_path(cm_admin_path, method: method)
+          return recognized_path if recognized_path.present?
+        rescue ActionController::RoutingError
+          next
+        end
+      end
+    end
+
+    def validate_cm_path_policy(path_helper)
+      recognized_path= cm_recognize_path(path_helper)
+      
+      model_name = recognized_path[:controller].split('/').last.singularize.classify
+      action_name = action(recognized_path[:action])
+      @policy_model = CmAdmin::Model.find_by(name: model_name)
+      policy([:cm_admin, @policy_model&.name&.constantize]).send("#{action_name}?")
+    end
+    
+
     def action(action_name)
       case action_name.to_sym
       when :update

data/app/models/concerns/exportable.rb

@@ -68,7 +68,9 @@ module Exportable
         column = CmAdmin::Models::Column.find_by(model, :index, { name: column_name.to_sym })
         record_hash[column.field_name] = if column.field_type == :custom
                                            send(column.helper_method, record, column.field_name).to_s
-                                         else
+                                          elsif column.field_type == :enum
+                                            record.send(column.field_name).to_s.titleize
+                                          else
                                            record.send(column.field_name).to_s
                                          end
       end

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

@@ -6,11 +6,11 @@
       .kanban-list__header
           p = column_name.to_s.titleize
           p.counter = @ar_object.column_count[column_name].to_i
-      .cards 
+      .cards data-section='kanban-cards'
         = @ar_object.data[column_name]
                 
 .pagination-bar.kanban-pagination
-  .btn.btn-primary.kanban-show-more data-page=1 Show more
+  .btn.btn-primary.kanban-show-more data-action='kanban-show-more' data-page=1 Show more
 / = render partial: 'cm_admin/main/show_as_drawer'
 
 = export_modal(@model)

data/lib/cm_admin/configuration.rb

@@ -1,6 +1,6 @@
 module CmAdmin
   class Configuration
-    attr_accessor :layout, :included_models, :cm_admin_models, :enable_tracking, :project_name
+    attr_accessor :layout, :included_models, :cm_admin_models, :enable_tracking, :project_name, :sidebar
 
     def initialize
       @layout = 'admin'
@@ -8,6 +8,7 @@ module CmAdmin
       @cm_admin_models = []
       @enable_tracking = false
       @project_name = ''
+      @sidebar = []
     end
   end
 end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '4.4.1'
+  VERSION = '4.4.8'
 end

data/lib/cm_admin/view_helpers/field_display_helper.rb

@@ -162,13 +162,13 @@ module CmAdmin
       def show_attachment_value(ar_object, field)
         if ar_object.send(field.field_name).attached?
           if has_one_image_attached?(ar_object, field)
-            content_tag :a, href: ar_object.send(field.field_name).url do
+            content_tag :a, href: ar_object.send(field.field_name).url, target: '_blank' do 
               ar_object.send(field.field_name).filename.to_s
             end
           elsif has_many_image_attached?(ar_object, field)
             ar_object.send(field.field_name).map do |asset|
               content_tag(:div) do
-                content_tag :a, href: asset.url do
+                content_tag :a, href: asset.url, target: '_blank' do
                   asset.filename.to_s
                 end
               end

data/lib/cm_admin/view_helpers/navigation_helper.rb

@@ -1,13 +1,26 @@
 require 'pagy'
+
 module CmAdmin
   module ViewHelpers
-    module NavigationHelper
+    module NavigationHelper # rubocop:disable Metrics/ModuleLength
       include Pagy::Frontend
+
       def navigation_links(navigation_type)
-        CmAdmin.config.cm_admin_models.map do |model|
+        if CmAdmin.config.sidebar.present?
+          custom_navigation_links(navigation_type, CmAdmin.config.sidebar)
+        else
+          default_navigation_links(navigation_type)
+        end
+      end
+
+      private
+
+      def default_navigation_links(navigation_type)
+        CmAdmin.config.cm_admin_models.map do |model| # rubocop:disable Metrics/BlockLength
           next unless model.is_visible_on_sidebar
 
-          path = CmAdmin::Engine.mount_path + '/' + model.name.underscore.pluralize
+          path = "#{CmAdmin::Engine.mount_path}/#{model.name.underscore.pluralize}"
+
           if policy([:cm_admin, model.name.classify.constantize]).index?
             if navigation_type == 'sidebar'
               content_tag(:a, href: path) do
@@ -15,7 +28,7 @@ module CmAdmin
                   content_tag(:span, class: 'menu-icon') do
                     concat tag.i class: model.icon_name.to_s
                   end +
-                      model.model_name.titleize.pluralize
+                    model.model_name.titleize.pluralize
                 end
               end
             elsif navigation_type == 'quick_links'
@@ -35,6 +48,98 @@ module CmAdmin
           end
         end.join.html_safe
       end
+
+      # Custom Navbar Code
+      def custom_navigation_links(navigation_type, sidebar = []) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+        sidebar.filter_map do |main_item|
+          @policy_model = nil
+          next unless should_display_item?(main_item)
+
+          path = main_item[:children].present? ? collapse_path(main_item) : { href: get_route(main_item[:path]) }
+          recognized_path = main_item[:path].present? && main_item[:path].start_with?('cm_') ? cm_recognize_path(main_item[:path]) : {}
+          current_path = get_route(main_item[:path]).present? && request.params.dig(:tab_id) == (recognized_path[:controller].to_s + '#' + recognized_path[:action].to_s).gsub("/", "_").gsub("#", "_") ? 'selected-item' : ''
+
+          if navigation_type == 'sidebar'
+            content_tag(:a, path) do
+              content_tag(:div, class: "menu-item #{current_path}") do
+                content_tag(:span, class: 'menu-icon') { tag.i(class: main_item[:icon_name] || @policy_model&.icon_name || 'fa fa-th-large') } +
+                  content_tag(:span, main_item[:display_name] || @policy_model&.formatted_name.pluralize) + content_tag(:span) +
+                  (main_item[:children].present? ? tag.i(class: 'sidebar-dropdown-svg fa fa-chevron-down') : ''.html_safe)
+              end +
+                generate_sub_menu(main_item)
+            end
+          elsif navigation_type == 'quick_links'
+            (main_item[:children] || [main_item]).filter_map do |item|
+              next unless should_display_item?(item)
+
+              content_tag(:a, href: get_route(item[:path]), class: 'visible') do
+                content_tag(:div, class: 'result-item') do
+                  content_tag(:span) { tag.i(class: item[:icon_name] || @policy_model&.icon_name || 'fa fa-th-large') } +
+                    content_tag(:span, item[:display_name] || @policy_model&.formatted_name.pluralize)
+                end
+              end
+            end
+          end
+        end.join.html_safe
+      end
+
+      # Helper Methods
+      def should_display_item?(sidebar_item)
+        return true if sidebar_item[:children]&.any? { |sub_item| should_display_item?(sub_item) }
+        return validate_cm_path_policy(sidebar_item[:path]) if sidebar_item[:path]&.start_with?('cm_') && (sidebar_item[:display_if].nil? || sidebar_item[:display_if]&.call(current_user))
+        return true if sidebar_item[:display_if]&.call(current_user) || sidebar_item[:display_if].nil? && sidebar_item[:children].nil?
+
+        false
+      end
+
+      def collapse_path(main_item)
+        {
+          'data-bs-toggle' => 'collapse',
+          'href' => "##{(main_item[:display_name] || @policy_model&.display_name).parameterize}Collapse",
+          'role' => 'button',
+          'aria-expanded' => 'true',
+          'aria-controls' => "#{(main_item[:display_name] || @policy_model&.display_name).parameterize}Collapse",
+          'data-cm-nav-id' => "##{(main_item[:display_name] || @policy_model&.display_name).parameterize}Collapse"
+        }
+      end
+
+      def generate_sub_menu(sidebar_item)
+        return ''.html_safe unless sidebar_item[:children].present?
+
+        sub_menu = sidebar_item[:children].filter_map { |sub_item| sub_menu_link(sub_item) }.join.html_safe
+        sub_menu_state_class = sidebar_item[:children].any? { |sub_item| 
+        recognized_path = sub_item[:path].present? && sub_item[:path].start_with?('cm_') ? cm_recognize_path(sub_item[:path]) : {}
+        get_route(sub_item[:path]).present? && request.params.dig(:tab_id) == ((recognized_path[:controller].to_s + '#' + recognized_path[:action].to_s).gsub("/", "_").gsub("#", "_")) } ? 'show' : 'collapse'
+        content_tag(:div, id: "#{(sidebar_item[:display_name] || @policy_model&.formatted_name.pluralize).parameterize}Collapse", "data-cm-nav-id": "#{(sidebar_item[:display_name] || @policy_model&.formatted_name.pluralize).parameterize}Collapse", class: sub_menu_state_class) do
+          sub_menu
+        end
+      end
+
+      def sub_menu_link(sub_item)
+        return unless should_display_item?(sub_item)
+
+        recognized_path = sub_item[:path].present? && sub_item[:path].start_with?('cm_') ? cm_recognize_path(sub_item[:path]) : {}
+        current_path = get_route(sub_item[:path]).present? && request.params.dig(:tab_id) == ((recognized_path[:controller].to_s + '#' + recognized_path[:action].to_s).gsub("/", "_").gsub("#", "_")) ? 'selected-item' : ''
+
+        content_tag(:a, href: get_route(sub_item[:path])) do
+          content_tag(:div, class: "menu-item submenu-item #{current_path}") do
+            content_tag(:span, class: 'menu-icon') { tag.i(class: sub_item[:icon_name] || @policy_model&.icon_name || 'fa fa-th-large') } +
+              content_tag(:span, sub_item[:display_name] || @policy_model&.formatted_name.pluralize)
+          end
+        end
+      end
+
+      def get_route(path)
+        return '' unless path.present?
+
+        recognized_path = path.start_with?('cm_') ? cm_recognize_path(path) : {}
+
+
+        return cm_admin.send(path.to_sym) + "?tab_id=#{(recognized_path[:controller].to_s + '#' + recognized_path[:action].to_s).gsub("/", "_").gsub("#", "_")}" if path.start_with?('cm_')
+        return send(path.to_sym) if Rails.application.routes.url_helpers.method_defined?(path.to_sym)
+
+        path
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.4.8
 platform: ruby
 authors:
 - Michael
@@ -11,10 +11,9 @@ authors:
 - Pranav
 - Mahaveer
 - Austin
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2025-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -508,7 +507,6 @@ metadata:
   homepage_uri: https://github.com/commutatus/cm-admin
   source_code_uri: https://github.com/commutatus/cm-admin
   github_repo: ssh://github.com/commutatus/cm-admin
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -523,8 +521,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: CmAdmin is a robust gem designed to assist in creating admin panels for Rails
   applications