cm-admin 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea557439972b4bf69c93412b81415aed76726933fde6e45599ee6f08bdc9e5be
-  data.tar.gz: f1b704b48795f36a0b8efe342dc4f4de49351112c47a2e6fd6dfbec982fa5bc1
+  metadata.gz: 60f28f773c4032f2bed61d3b0524ab635b13face45767f444fbc841e490bc597
+  data.tar.gz: 42433de9bf7714a37d0fe14bb99a6944bced6886d06cef2083c540e9acf33e93
 SHA512:
-  metadata.gz: ce7a4d687dcbcd2db7eafaaf77fa45f0d0048b3ba3bfef259c5eb9c7510a569d7c2d9e4876342973d343aca20d295959df33455dbd150e684bea4deb17418f7b
-  data.tar.gz: 4c823776edeb548873d43caf016c402cf102eac48d41b5c9d94e6a7bfd8fbd31ab61dea523215d3d55192312387c0f56465bd5591fb6461f69a771240a81d411
+  metadata.gz: d224d531688d916b36f07bce3d1e3b0a58939dbf5d847158d1bd051fd4c36750cfeae50986244c3be6e92690e427881b3fa5571b52cd1fe42b6e6edd029f8ac2
+  data.tar.gz: be325872f019d39cc6b86cd06a0bc933631548e6da7f292b40a9f1bf2fc5b6149644b43305db3f803a4788239b1a8e25e5e53f848ba013afcc2d0cce6ef842b6

data/Gemfile.lock

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

data/app/controllers/cm_admin/resource_controller.rb

@@ -9,7 +9,7 @@ module CmAdmin
       @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::Scope".constantize.new(Current.user, @model.name.constantize).resolve
+      records = "CmAdmin::#{@model.name}Policy::IndexScope".constantize.new(Current.user, @model.name.constantize).resolve
       records = apply_scopes(records)
       if (['table', 'card'].include?(params[:view_type]) || [:table, :card].include?(@current_action.view_type))
         @ar_object = filter_by(params, records, filter_params: @model.filter_params(params))
@@ -31,7 +31,7 @@ module CmAdmin
 
     def cm_show(params)
       @current_action = CmAdmin::Models::Action.find_by(@model, name: 'show')
-      scoped_model = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve
+      scoped_model = "CmAdmin::#{@model.name}Policy::ShowScope".constantize.new(Current.user, @model.name.constantize).resolve
       @ar_object = fetch_ar_object(scoped_model, params[:id])
       @alerts = @model.alerts
       resource_identifier
@@ -133,7 +133,7 @@ module CmAdmin
     end
 
     def cm_custom_method(params)
-      records = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve
+      records = "CmAdmin::#{@model.name}Policy::#{@action.name.classify}Scope".constantize.new(Current.user, @model.name.constantize).resolve
       @current_action = @action
       if  @action.parent == 'index'
         records = apply_scopes(records)
@@ -175,7 +175,7 @@ module CmAdmin
     end
 
     def cm_custom_action_modal(params)
-      scoped_model = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve
+      scoped_model = "CmAdmin::#{@model.name}Policy::#{params[:action_name].classify}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 }
@@ -240,7 +240,8 @@ module CmAdmin
       @current_action = CmAdmin::Models::Action.find_by(@model, name: action_name.to_s)
       return unless @current_action
 
-      @ar_object = fetch_ar_object(@model.ar_model.name.classify.constantize, params[:id])
+      scoped_model = "CmAdmin::#{@model.name}Policy::#{action_name.classify}Scope".constantize.new(Current.user, @model.ar_model.name.classify.constantize).resolve
+      @ar_object = fetch_ar_object(scoped_model, params[:id])
       return @ar_object unless @current_action.child_records
 
       child_records = @ar_object.send(@current_action.child_records)
@@ -277,7 +278,7 @@ module CmAdmin
       else
         sort_column = 'created_at'
       end
-      records = "CmAdmin::#{@model.name}Policy::Scope".constantize.new(Current.user, @model.name.constantize).resolve if records.nil?
+      records = "CmAdmin::#{@model.name}Policy::#{@current_action.name.classify}Scope".constantize.new(Current.user, @model.name.constantize).resolve if records.nil?
       records = records.order("#{sort_column} #{@current_action.sort_direction}")
       final_data = CmAdmin::Models::Filter.filtered_data(filter_params, records, cm_model.filters)
       pagy, records = pagy(final_data)

data/app/models/concerns/cm_admin/cm_role.rb

@@ -3,9 +3,10 @@ module CmAdmin::CmRole
   included do
     cm_admin do
       actions only: []
-      set_icon "fa fa-database"
+      set_icon 'fa fa-database'
       cm_index do
-        page_title 'Role'
+        page_title 'Roles & Permissions'
+        set_display_name 'Role'
 
         filter [:name], :search, placeholder: 'Search'
 
@@ -20,10 +21,13 @@ module CmAdmin::CmRole
           # allowed_params = params.permit(role_permission: []).to_h
           @role = CmRole.find(params[:id])
           params[:role_permission].except(:submit).each do |model_name, action_arr|
-            @role.cm_permissions.where(ar_model_name: model_name).where.not(action_name: action_arr.select{ |k,v| k if v.has_key?('is_checked')}.keys).destroy_all
+            action_names = action_arr.select { |k, v| k if v.key?('is_checked') }.keys
+            action_names << 'create' if action_names.include?('new')
+            action_names << 'update' if action_names.include?('edit')
+            @role.cm_permissions.where(ar_model_name: model_name).where.not(action_name: action_names).destroy_all
             action_arr.each do |action_name, selected_option|
               if selected_option.has_key?('is_checked')
-                permission = @role.cm_permissions.where(action_name: action_name, ar_model_name: model_name).first_or_create
+                permission = @role.cm_permissions.where(action_name:, ar_model_name: model_name).first_or_create
                 permission.update(scope_name: selected_option['scope_name'])
               end
             end
@@ -34,7 +38,7 @@ module CmAdmin::CmRole
           cm_show_section 'Role details' do
             field :name
             field :created_at, field_type: :date, format: '%d %b, %Y'
-            field :updated_at, field_type: :date, format: '%d %b, %Y'    
+            field :updated_at, field_type: :date, format: '%d %b, %Y'
           end
         end
         tab :permissions, 'permissions', layout_type: 'cm_association_show', partial: '/cm_admin/roles/permissions'
@@ -53,4 +57,4 @@ module CmAdmin::CmRole
       end
     end
   end
-end
+end

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

@@ -2,7 +2,8 @@
   .form-page__body
     .form-container
       = form_for CmPermission.new, url: cm_admin.send('cm_role_create_role_permission_path', @ar_object), method: :post do |f|
-        - CmAdmin.config.cm_admin_models.each do |model|
+        - cm_models = CmAdmin.config.cm_admin_models.sort_by{|k, v| k.display_name}
+        - cm_models.each do |model|
           - next if model.override_policy == true
           .row
             .col.form-container

data/docs/RoleManagement.md

@@ -62,6 +62,21 @@ end
 4. Include `CmRole` in the `config.included_models` section of `config/initializers/zcm_admin.rb`.  
 5. Assign `cm_role_id` to `1` for any user in the `User` Model, and use that user to log in.
 
+## Setting up scopes
+
+By default, `Full Access` scopes is added to each permission item. To add additional scopes, use the following syntax:
+
+```ruby
+...
+cm_admin do
+  actions only: []
+  set_icon "fa fa-user"
+  set_policy_scopes [{scope_name: 'test_supplier_filter', display_name: 'By Test Supplier'}]
+  cm_index do
+    page_title 'User'
+  end
+end
+
 ## Overriding Policies
 
 By default, roles and policies are enabled for all models in the application. To override a policy, use the following syntax:
@@ -90,3 +105,24 @@ end
 ```
 
 This structure helps ensure that your application's role and permission management is both flexible and secure.
+
+
+## Permission based fields
+
+We can apply permission logic to display a field on the interface. You can do this with the following syntax.
+
+```ruby
+...
+tab :details, '' do
+  row do
+    cm_show_section 'Details' do
+      field :status, field_type: :tag, tag_class: Item::STATUS_TAG_COLOR, display_if: -> (record) {
+        scoped_model = CmAdmin::ItemPolicy::ArchiveScope.new(Current.user, ::Item).resolve
+        return scoped_model.find_by(id: record.id).present?
+      }
+    end
+  end
+end
+
+```
+

data/lib/cm_admin/model.rb

@@ -36,6 +36,7 @@ module CmAdmin
 
     def initialize(entity, &block)
       @name = entity.name
+      @display_name = entity.name
       @ar_model = entity
       @is_visible_on_sidebar = true
       @icon_name = 'fa fa-th-large'
@@ -196,28 +197,32 @@ module CmAdmin
       end if $available_actions.present?
       policy = CmAdmin.const_set "#{ar_model.name}Policy", klass
 
-      klass =  Class.new(policy) do
-        def initialize(user, scope)
-          @user = user
-          @scope = scope
-        end
-    
-        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)
-          if permission.present? && permission.scope_name.present?
-            scope.send(permission.scope_name)
-          else
-            scope.all
+      $available_actions.each do |action|
+        next if ['custom_action_modal', 'custom_action', 'create', 'update'].include?(action.name)
+
+        klass = Class.new(policy) do
+          def initialize(user, scope)
+            @user = user
+            @scope = scope
+          end
+
+          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)
+            if permission.present? && permission.scope_name.present?
+              scope.send(permission.scope_name)
+            else
+              scope.all
+            end
           end
+
+          private
+
+          attr_reader :user, :scope
         end
-    
-        private
-    
-        attr_reader :user, :scope
-      end
 
-      policy.const_set 'Scope', klass
+        policy.const_set "#{action.name.classify}Scope", klass
+      end
     end
   end
 end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '2.1.4'
+  VERSION = '2.1.5'
 end

data/lib/cm_admin/view_helpers/page_info_helper.rb

@@ -39,7 +39,8 @@ module CmAdmin
 
       def custom_action_items(custom_action, current_action_name)
         if custom_action.name.present? && policy([:cm_admin, @model.name.classify.constantize]).send(:"#{custom_action.name}?")
-          if custom_action.display_if.call(@ar_object)
+          scoped_model = "CmAdmin::#{@model.name}Policy::#{custom_action.name.classify}Scope".constantize.new(Current.user, @model.name.constantize).resolve
+          if custom_action.display_if.call(@ar_object) && scoped_model.find_by(id: params[:id])
             case custom_action.display_type
             when :icon_only
               custom_action_icon(custom_action, current_action_name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Michael