cm-admin 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758deeaf34976fadccc5e68a438f0ba2cc3fe7f519431ffe750c740c162b92c7
-  data.tar.gz: 770661bd71b01b11ec2f50c4a88adf8a182d6d082e0b8415ef099df8559e8279
+  metadata.gz: 3bf623e4d9823428bdd3094de10b24c89415824291ad8366aca4d79e4bd34db1
+  data.tar.gz: 4dc0b0fb0646b99ae721ceb0f23652b730d4e479aa44aae9fc720fd0d199d89a
 SHA512:
-  metadata.gz: e87eb00d34c7c2e601078d815d6137ef4eddb22d543294d33301a102b3f9ff2931f46e353a832db435441df81cb32d198d06824bd8cef82984440fc0ef5186d5
-  data.tar.gz: 594fcf9d069ef492dfb469e22cb4b609ea3b6d4c6acbf1404080c3d9e8b18ed2fa416ef2122a7035c9a53dc8dc915ae6724a768e1aa74fec16bd5735c9879cef
+  metadata.gz: ec0c5593c3b28ce5857c9a7ef1873ddd279b3486a3f9562a3c1975c4f22d4ca644557303cd292e6086c2a31e42acca337734f80001698b8087702ed56ec0fe5b
+  data.tar.gz: c02bbac2b9e9e8ad80c0d75b1249bb45065b830a0ddfb37433c09122292fcbbb43fa94d2d2ce2ce59d3d140947d8ca6a878fa2dd22acca9ccbe7d687beba14c1

data/.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  test:
+    if: "!contains(github.event.head_commit.message, '[skip-tests]')"
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+
+      - name: Install dependencies
+        working-directory: feature-app
+        run: bundle install
+
+      - name: Set up database
+        working-directory: feature-app
+        run: |
+          cp config/database.yml.ci config/database.yml
+          RAILS_ENV=test bundle exec rails db:create
+          RAILS_ENV=test bundle exec rails db:migrate
+
+      - name: Precompile assets
+        working-directory: feature-app
+        run: RAILS_ENV=test bundle exec rails assets:precompile
+
+      - name: Run RSpec tests
+        working-directory: feature-app
+        run: bundle exec rspec

data/Gemfile.lock

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

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

@@ -58,4 +58,9 @@ $(document).on("click", '[data-behaviour="discard_form"]', function (e) {
   const form = $(this).closest("form");
   form[0].reset();
   window.history.back();
+});
+
+$(document).on("turbo:submit-end", function(e){
+  $('[data-behaviour="form_submit_spinner"]').addClass("visually-hidden");
+  return $('[data-behaviour="form_submit"]').removeClass("visually-hidden");
 });

data/app/controllers/cm_admin/resource_controller.rb

@@ -6,12 +6,19 @@ module CmAdmin
     helper CmAdmin::ViewHelpers
 
     skip_before_action :verify_authenticity_token, only: :reset_sort_columns
+    before_action :set_current_user_permission
+
+
+    def set_current_user_permission
+      CmCurrent.user_permissions = Current.user.cm_role.cm_permissions if Current.user.cm_role.present?
+    end
 
     def cm_index(params)
       @current_action = CmAdmin::Models::Action.find_by(@model, name: 'index')
       # Based on the params the filter and pagination object to be set
       authorize @ar_object, policy_class: "CmAdmin::#{controller_name.classify}Policy".constantize if defined? "CmAdmin::#{controller_name.classify}Policy".constantize
       records = "CmAdmin::#{@model.name}Policy::IndexScope".constantize.new(Current.user, @model.name.constantize).resolve
+      records = records.includes(@current_action.eager_load_associations) if @current_action.eager_load_associations.present?
       records = apply_scopes(records)
       @ar_object = if %w[table card].include?(params[:view_type]) || %i[table card].include?(@current_action.view_type)
                      filter_by(params, records, filter_params: @model.filter_params(params))
@@ -163,6 +170,7 @@ module CmAdmin
       @current_action = @action
       if @action.parent == 'index'
         records = apply_scopes(records)
+        records = records.includes(@model.eager_load_associations) if @model.eager_load_associations.present?
         @ar_object = filter_by(params, records, filter_params: @model.filter_params(params))
       else
         resource_identifier
@@ -304,6 +312,7 @@ module CmAdmin
       return @ar_object unless @current_action.child_records
 
       child_records = @ar_object.send(@current_action.child_records)
+      child_records = child_records.includes(@current_action.eager_load_associations) if @current_action.eager_load_associations.present?
       child_records = apply_scopes(child_records)
       @reflection = @model.ar_model.reflect_on_association(@current_action.child_records)
       @associated_model = if @reflection.klass.column_names.include?('type')

data/app/helpers/cm_admin/permission_helper.rb

@@ -0,0 +1,14 @@
+module CmAdmin
+  module PermissionHelper
+
+    # Used in mode.rb while creating policies.
+    def has_access_to?(ar_model, action)
+      find_permission_by(ar_model, action).present?
+    end
+
+    # Checks if the current user permission has access to the specified model and action
+    def find_permission_by(ar_model, action)
+      CmCurrent.user_permissions.find { |permission| permission.ar_model_name == ar_model.name && permission.action_name == action.name }
+    end
+  end
+end

data/app/models/cm_current.rb

@@ -0,0 +1,3 @@
+class CmCurrent < ActiveSupport::CurrentAttributes
+  attribute :user_permissions
+end

data/app/models/cm_permission.rb

@@ -19,4 +19,5 @@ class CmPermission < ApplicationRecord
       CmPermission.where(action_name: 'update', ar_model_name:, cm_role_id:).first&.destroy
     end
   end
+
 end

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

@@ -59,6 +59,6 @@
             == render partial: 'cm_admin/main/actions_dropdown', locals: { cm_model: @associated_model, ar_object: ar_object }
 
   .pagination-bar
-    p.count-text.m-0 Showing #{@associated_ar_object.pagy.from} to #{@associated_ar_object.pagy.to} out of #{@associated_ar_object.pagy.count}
+    p.count-text.m-0 Showing #{number_with_delimiter(@associated_ar_object.pagy.from.to_i)} to #{number_with_delimiter(@associated_ar_object.pagy.to.to_i)} out of #{number_with_delimiter(@associated_ar_object.pagy.count.to_i)}
     == render partial: 'cm_admin/main/cm_pagy_nav', locals: { pagy: @associated_ar_object.pagy }
 / = render partial: 'cm_admin/main/member_custom_action_modal', locals: { cm_model: @associated_model, ar_collection: @associated_ar_object }

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

@@ -9,10 +9,10 @@ nav.pagination-actions role="navigation" aria-label="pager"
 
   - pagy.series.each do |item|        # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
     - if item.is_a?(Integer)          # page link
-      span ==> link.call(item, item, 'class="btn-ghost"')
+      span ==> link.call(item, number_with_delimiter(item.to_i), 'class="btn-ghost"')
 
     - elsif item.is_a?(String)        # current page
-      span ==> link.call(item, item, 'class="btn-ghost active"')
+      span ==> link.call(item, number_with_delimiter(item.to_i), 'class="btn-ghost active"')
 
     - elsif item == :gap              # page gap
       span.page.gap ==> pagy_t('pagy.nav.gap')

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

@@ -50,7 +50,7 @@
           - if @model
             == render partial: 'cm_admin/main/actions_dropdown', locals: { cm_model: @model, ar_object: ar_object }
   .pagination-bar
-    p.count-text.m-0 Showing #{@ar_object.pagy.from} to #{@ar_object.pagy.to} out of #{@ar_object.pagy.count}
+    p.count-text.m-0 Showing #{number_with_delimiter(@ar_object.pagy.from.to_i)} to #{number_with_delimiter(@ar_object.pagy.to.to_i)} out of #{number_with_delimiter(@ar_object.pagy.count.to_i)}
     == render partial: 'cm_admin/main/cm_pagy_nav', locals: { pagy: @ar_object.pagy }
 
 = column_pop_up(@model)

data/app/views/cm_admin/roles/permissions.html.slim

@@ -35,5 +35,8 @@
                                 .cm-select-tag class="#{permission.present? ? '' : 'hidden'}"
                                   = select_tag(:policy_scope_name, options_for_select(model.policy_scopes.map{|policy_hash| [policy_hash[:display_name], policy_hash[:scope_name]]}, permission&.scope_name), {name: "role_permission[#{model.name}][#{action.name}][scope_name]", class: 'select-2', id: "policy-scope-#{model.name}-#{action.name}"})
           .form-submit-button-container
-            = f.submit 'Save Changes', class: "btn-cta"
-            = link_to 'Discard', cm_admin.send('cm_index_cm_role_path'), class: "btn-secondary ml-10"
+            = f.submit 'Save Changes', class: 'btn-cta', data: { behaviour: 'form_submit', form_class: "new_cm_permission", turbo_submits_with: 'Submitting...' }
+            = button_tag(type: 'button', class: 'btn-loading visually-hidden', data: { behaviour: 'form_submit_spinner' }) do
+              = content_tag(:span, '', class: 'spinner-border spinner-border-sm', role: 'status')
+              |  Submitting...
+            = link_to 'Discard', cm_admin.send('cm_index_cm_role_path'), class: "btn-secondary ml-10"

data/cm_admin.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|feature-app)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/cm_admin/model.rb

@@ -188,12 +188,14 @@ module CmAdmin
     def define_pundit_policy(ar_model)
       if $available_actions.present?
         klass = Class.new(ApplicationPolicy) do
+          include CmAdmin::PermissionHelper
           $available_actions.each do |action|
             define_method "#{action.name}?".to_sym do
               return false unless Current.user.respond_to?(:cm_role_id)
               return false if Current.user.cm_role.nil?
+              return false if CmCurrent.user_permissions.empty?
 
-              Current.user.cm_role.cm_permissions.where(action_name: action.name, ar_model_name: ar_model.name).present?
+              has_access_to?(ar_model, action)
             end
           end
         end
@@ -211,7 +213,7 @@ module CmAdmin
 
           define_method :resolve do
             # action_name = Current.request_params.dig("action")
-            permission = Current.user.cm_role.cm_permissions.find_by(action_name: action.name, ar_model_name: ar_model.name)
+            permission = find_permission_by(ar_model, action)
             if permission.present? && permission.scope_name.present?
               scope.send(permission.scope_name)
             else

data/lib/cm_admin/models/action.rb

@@ -7,7 +7,7 @@ module CmAdmin
       attr_accessor :name, :display_name, :verb, :layout_type, :layout, :partial, :path, :page_title, :page_description,
                     :child_records, :is_nested_field, :nested_table_name, :parent, :display_if, :route_type, :code_block,
                     :display_type, :action_type, :redirection_url, :sort_direction, :sort_column, :icon_name, :scopes, :view_type,
-                    :kanban_attr, :model_name, :redirect_to, :execution_mode
+                    :kanban_attr, :model_name, :redirect_to, :execution_mode, :eager_load_associations
 
       VALID_SORT_DIRECTION = Set[:asc, :desc].freeze
 
@@ -41,6 +41,7 @@ module CmAdmin
         self.route_type = nil
         self.display_type = nil
         self.view_type = :table
+        self.eager_load_associations = []
         self.kanban_attr = {}
       end
 

data/lib/cm_admin/models/dsl_method.rb

@@ -402,6 +402,17 @@ module CmAdmin
         @default_sort_column = default_column[:column]
         @default_sort_direction = default_column[:default_direction] if default_column[:default_direction].present?
       end
+
+      # Configure Eager load associations for action
+      # This will help us avoid N+1 queries
+      #
+      # @example Eager load associations
+      #  eager_load_assocations [:association_name]
+      #  eager_load_assocations [:constant]
+      #
+      def eager_load_associations(associations=[])
+        @current_action.eager_load_associations = associations if @current_action
+      end
     end
   end
 end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '4.0.0'
+  VERSION = '4.1.1'
 end

data/lib/cm_admin/view_helpers.rb

@@ -13,6 +13,7 @@ module CmAdmin
     # Included Rails view helper
     include ActionView::Helpers::FormTagHelper
     include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::NumberHelper
 
     def exportable(_klass, html_class: [])
       tag.a 'Export as excel', class: html_class.append('filter-btn modal-btn me-2'), data: { toggle: 'modal', target: '#exportmodal' } do
@@ -80,7 +81,7 @@ module CmAdmin
 
     def humanized_ar_collection_count(count, model_name)
       table_name = count == 1 ? model_name.singularize : model_name.pluralize
-      "#{count} #{table_name.humanize.downcase} found"
+      "#{number_with_delimiter(count.to_i)} #{table_name.humanize.downcase} found"
     end
 
     def toast_message(message, toast_type)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Michael
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -165,6 +165,7 @@ files:
 - ".github/workflows/deploy-yard-docs.yml"
 - ".github/workflows/linters.yml"
 - ".github/workflows/release-gem.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop-https---raw-githubusercontent-com-commutatus-cm-linters-main-rubocop-yml"
@@ -344,7 +345,9 @@ files:
 - app/controllers/cm_admin/static_controller.rb
 - app/helpers/cm_admin/application_helper.rb
 - app/helpers/cm_admin/custom_helper.rb
+- app/helpers/cm_admin/permission_helper.rb
 - app/jobs/file_import_processor_job.rb
+- app/models/cm_current.rb
 - app/models/cm_permission.rb
 - app/models/cm_role.rb
 - app/models/concerns/cm_admin/bulk_action_processor.rb