cm-admin 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758deeaf34976fadccc5e68a438f0ba2cc3fe7f519431ffe750c740c162b92c7
-  data.tar.gz: 770661bd71b01b11ec2f50c4a88adf8a182d6d082e0b8415ef099df8559e8279
+  metadata.gz: 19fd7ec610f3f8b02370549dfac1e314ece5c44f57466727666058c83f4f5905
+  data.tar.gz: fe9a9c73585456a365364b1e44305e229a242a19bf832da849117bc1fb3f47a6
 SHA512:
-  metadata.gz: e87eb00d34c7c2e601078d815d6137ef4eddb22d543294d33301a102b3f9ff2931f46e353a832db435441df81cb32d198d06824bd8cef82984440fc0ef5186d5
-  data.tar.gz: 594fcf9d069ef492dfb469e22cb4b609ea3b6d4c6acbf1404080c3d9e8b18ed2fa416ef2122a7035c9a53dc8dc915ae6724a768e1aa74fec16bd5735c9879cef
+  metadata.gz: 8fef781ecc5b1bfc28f04fdc4bbdea3c6463cddb39aa4cddddfcb84d359af8528ce77c8f33eb98a505e95214c468883c89185f61cb7b320b614c91813f1bef10
+  data.tar.gz: '068f711e3e85d6019af1d40256c1bff7a11fd69016e11be5285e48598d13dd652d1ae7447cae179279063f2f7edd1f85398f4a140a83bf41bc494c4332d1318c'

data/Gemfile.lock

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

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/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.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 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-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -344,7 +344,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