verbose_cancancan 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 894cfad8bd3a07f8455bd7d37720b3289123db0afb9c6e66dda92dbdc775bad5
-  data.tar.gz: eab446beeb6ba948ab8959127bb20ba2abd2c9091593c583f422678334d1d6cd
+  metadata.gz: 16f2ffacc1c88314db8618166040f6032cea28576450dc2854e4316834fb3e28
+  data.tar.gz: '0487e37445d759e16c7aad9e6f1eead08f40411d392c39d65d358a3b884fc1d9'
 SHA512:
-  metadata.gz: d12fd5faddc6ef40bcadee9fe600dd548ea12224b8220160d7ee6f756ad64c84e54787b848396620a841a4b06ad7a845ac5d58875e71a823bda8258efc30e41c
-  data.tar.gz: d1c5b4cdaeaa2a178c033a1f6268b703ef9f05f84a0d2f3625adfddb8ffc0b78a88908da9415841486a2c11497cd311620b3e383e716d1ba811287ff57581921
+  metadata.gz: '068b7555d874f6e01e2244b931a4370213ab0789cc44cc9eb1dd5d838fa6f6e31549c63d27cdc78274ff46c47c36e57b4d9359becc212a0afece3525b1671ecf'
+  data.tar.gz: '06794b457710e86b80c5e7b6619624bf49e045f213efdcca9a1a1481dfd1a0dda7b76d0e81127de3b9da6942155f7e5f2a55780a8d4bae8e7c58a6a5e996e574'

data/lib/verbose_cancancan/ability.rb

@@ -1,7 +1,11 @@
 module VerboseCancancan
+  module Ability
 
+    extend ActiveSupport::Concern
 
-  module Ability
+    prepended do
+      delegate :colourize, :logger, to: VerboseCancancan, prefix: :verb
+    end
 
     def can?(action, subject, attribute = nil, *extra_args)
       match = extract_subjects(subject).lazy.map do |a_subject|
@@ -15,17 +19,16 @@ module VerboseCancancan
       match ? match.base_behavior : false
     end
 
-    # Only logged the rule if authorize! or load_and_authorize! is called, to avoid cluttering the terminal with can? checks. 
+    # Only logged the rule if authorize! or load_and_authorize! is called, to avoid cluttering the terminal due to can? checks. 
     def log_rule? = caller.find { |path| path.include?('authorize!') }
 
-
     def log_rule(matched_rule, action, subject)
       subject = pretty_subject(subject)
 
       if matched_rule
-        VerboseCancancan.logger.info matched_rule_info(matched_rule, subject, action)
+        verb_logger.info matched_rule_info(matched_rule, subject, action)
       else
-        VerboseCancancan.logger.info no_rule_matched(subject, action)
+        verb_logger.info no_rule_matched(subject, action)
       end
     end
 
@@ -33,32 +36,32 @@ module VerboseCancancan
       auth_status = rule.base_behavior ? auth_success : auth_failed
       rule_type   = rule.base_behavior ? 'Can' : 'Cannot'
 
-      "#{auth_status} #{rule_type} Rule applied for #{colourize(subject, :cyan)} (Action: #{colourize(action, :yellow)})\n  ↳  #{rule.path}"
+      "#{auth_status} Rule of #{rule_type} type applied for #{verb_colourize(subject, :magenta)} (Action: #{verb_colourize(action, :green)})\n  ↳  #{rule.path}"
     end
 
     def no_rule_matched(subject, action)
-      "#{auth_failed} No matching rule for #{colourize(subject, :cyan)} (Action: #{colourize(action, :yellow)})"
+      "#{auth_failed} No matching rule for #{verb_colourize(subject, :magenta)} (Action: #{verb_colourize(action, :green)})"
     end
 
     def pretty_subject(subject)
       if subject.is_a?(ActiveRecord::Base)
+        # In case of member actions subject is `ActiveRecord::Base`
+
         "#{subject.class.name} (ID: #{subject.id})"
       else
+        # In case of Collection actions subject can be
+        #  1. Hash if resources are being loaded through parent. => { parent_resource => resource_class }
+        #  2. ActiveRecord::Model if if resources are not loaded through parent.
+
         orignal_subject = subject.is_a?(Hash) ? subject.values.first : subject
 
         orignal_subject.respond_to?(:name) ? orignal_subject.name : orignal_subject
       end
     end
 
-    def auth_failed
-      colourize('[❌ AUTHORIZATION FAILED]', :red)
-    end
-
-    def auth_success
-      colourize('[✅ AUTHORIZATION SUCCESS]', :green)
-    end
+    def auth_failed  = verb_colourize('[❌ AUTHORIZATION FAILED]', :red)
 
-    def colourize(...) = VerboseCancancan.colourize(...)
+    def auth_success = verb_colourize('[✅ AUTHORIZATION SUCCESS]', :green)
 
   end
 end

data/lib/verbose_cancancan/controller_resource.rb

@@ -1,15 +1,23 @@
 module VerboseCancancan
   module ControllerResource
 
+    extend ActiveSupport::Concern
+
+    prepended do
+      delegate :cleaner_backtrace, :logger, :colourize, to: VerboseCancancan, prefix: :verb
+    end
+
     def add_before_action(controller_class, method, *args)
       options = args.extract_options!
       resource_name = args.first
       before_action_method = before_callback_name(options)
-      bk_trace = VerboseCancancan.cleaner_backtrace(caller).first
+      bk_trace = verb_cleaner_backtrace(caller).first
 
       controller_class.send(before_action_method, options.slice(:only, :except, :if, :unless)) do |controller|
 
-        VerboseCancancan::ControllerResource.log_hook_added(method, controller_class, bk_trace) if VerboseCancancan::ControllerResource.log_hook_added?(method)
+        controller.class
+                  .cancan_resource_class
+                  .log_hook_added(method, controller_class, resource_name, bk_trace)
 
 
         controller.class.cancan_resource_class
@@ -17,15 +25,15 @@ module VerboseCancancan
       end
     end
 
-    def self.log_hook_added?(hook)
-      hook.to_s.include? ('authorize_resource')
-    end
+    def log_hook_added(method, controller_class, resource_name, bk_trace)
+      return if method.to_s.exclude? 'authorize_resource'
 
-    def self.log_hook_added(method, controller_class, bk_trace)
-      VerboseCancancan.logger.info "#{VerboseCancancan::ControllerResource.colourize('[⏳ CanCan Hook Added]', :green)}(#{method}) on #{controller_class} \n  ↳  #{bk_trace}"
-    end
+      log_msg = [verb_colourize('[⏳ CanCan Hook Added]', :orange), "(#{method})"]
+      log_msg << "for #{resource_name}" if resource_name
+      log_msg += ["on #{controller_class}", "\n  ↳  #{bk_trace}"]
 
-    def self.colourize(...) = VerboseCancancan.colourize(...)
+      verb_logger.info log_msg.join(' ')
+    end
 
   end
 end

data/lib/verbose_cancancan/railtie.rb

@@ -1,15 +1,17 @@
+require 'verbose_cancancan/ability'
+require 'verbose_cancancan/rule'
+require 'verbose_cancancan/controller_resource'
+
 module VerboseCancancan
+
   class Railtie < Rails::Railtie
-    initializer "my_gem.configure_rails_initialization" do
-      # some initialization behavior
-      puts "\n\n\nhola\n\n\n"
 
+    initializer 'verbose_cancancan.patch_cancancan' do
       CanCan::Rule.prepend(Rule)
       CanCan::Ability.prepend(Ability)
 
       CanCan::ControllerResource.singleton_class.prepend(VerboseCancancan::ControllerResource)
-
-
     end
+
   end
 end

data/lib/verbose_cancancan/rule.rb

@@ -1,10 +1,16 @@
 module VerboseCancancan
-
   module Rule
+    extend ActiveSupport::Concern
+
+    prepended do
+      attr_reader :path
+
+      delegate :cleaner_backtrace, to: VerboseCancancan, prefix: :verb
+    end
+
     def initialize(...)
-      @path = VerboseCancancan.cleaner_backtrace(caller).first
+      @path = verb_cleaner_backtrace(caller).first
       super
     end
   end
-
 end

data/lib/verbose_cancancan.rb

@@ -1,6 +1,3 @@
-require 'verbose_cancancan/ability'
-require 'verbose_cancancan/rule'
-require 'verbose_cancancan/controller_resource'
 require 'verbose_cancancan/railtie'
 
 module VerboseCancancan
@@ -8,9 +5,9 @@ module VerboseCancancan
   class << self
 
     def logger
-      logger = Logger.new(STDOUT)
+      logger = Rails.logger
 
-      logger.formatter = proc { |_, _, _, msg| "#{msg}\n\n" }
+      # logger.formatter = proc { |_, _, _, msg| "#{msg}\n\n" }
 
       logger
     end
@@ -23,13 +20,16 @@ module VerboseCancancan
       bk_trace.clean(locations)
     end
 
+    # TODO: Refactor Coloring approch.
     def colourize(msg, color)
       colors = {
-        clear:  "\e[0m",
-        red:    "\e[1;31m",
-        green:  "\e[1;92m",
-        yellow: "\e[33m",
-        cyan:   "\e[36m"
+        clear:   "\e[0m",
+        red:     "\e[1;31m",
+        green:   "\e[1;92m",
+        magenta: "\e[1;95m",
+        yellow:  "\e[1;93m",
+        orange:  "\e[1;38;5;214m",
+        cyan:    "\e[1;96m"
       }
 
       "#{colors[color]}#{msg}#{colors[:clear]}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbose_cancancan
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Zain Iftikhar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancancan
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: 'This gem displays the location where a rule was defined and prints the
   locations where load_and_authorize_resource and authorize! hooks are defined.