verbose_cancancan 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f06f9036e8c7dc7b482a80b5639387189062adc274da49e9771d56fd2e59ef01
-  data.tar.gz: 3a324d862ca09b0b9919657a5404d86c25e25aeb3c12bdb6e7f81649bef4e94d
+  metadata.gz: a27a597ae004b18049c897a0cc3d9f15cd3904cda76b8ab9b46c453bd0e72c32
+  data.tar.gz: 16705a72c86087a22ec04e6a7d62ab1c7fb6e4e590b81ecb10a2f93e28ffa33e
 SHA512:
-  metadata.gz: e7bf88f2885bc343284974cc38c26b583757182e6eca8816acef6decd1881e6d91e75fa9a0ac87f14521f8ab5a9d967ecfed23353232142bb972887b66bfee57
-  data.tar.gz: 3c56243f19ab40fb42a3497ce656884d581058f00fc72403092669a09034810c9267276baf0920877d2019fdec0dbda70821f1fa980eb7fc73132d5d627812c3
+  metadata.gz: f11a9e2e8c94b67ab2613c06a21bc933ebf75bc2e4ee55b83d9a4a49a0005b5c485d69d79c56bb2ec7ad7124876db566b8282baff414a4b4ca6a1f851b4bf03f
+  data.tar.gz: '08db0bc76b33bd8d0657ea415ab8dbcbd5891116b3a4ec2eb389b5daee483ec5a6509b1f379e1ebd7725e32d96433765664efd9cedbe3fe94ff168b5144a60de'

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,16 @@
+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,12 +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
-
-    def path = @path
   end
-
 end

data/lib/verbose_cancancan.rb

@@ -1,19 +1,10 @@
-require 'verbose_cancancan/ability'
-require 'verbose_cancancan/rule'
-require 'verbose_cancancan/controller_resource'
 require 'verbose_cancancan/railtie'
 
 module VerboseCancancan
 
   class << self
 
-    def logger
-      logger = Logger.new(STDOUT)
-
-      logger.formatter = proc { |_, _, _, msg| "#{msg}\n\n" }
-
-      logger
-    end
+    def logger = Rails.logger
 
     def cleaner_backtrace(locations)
       bk_trace = ActiveSupport::BacktraceCleaner.new
@@ -23,13 +14,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.3
+  version: 0.0.5
 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,8 +24,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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.
+- !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 CanCanCan extension displays the location where selected rule for
+  authorization was defined and also prints the locations where load_and_authorize_resource
+  and authorize! hooks are defined.
 
   '
 email:
@@ -39,10 +68,13 @@ files:
 - lib/verbose_cancancan/controller_resource.rb
 - lib/verbose_cancancan/railtie.rb
 - lib/verbose_cancancan/rule.rb
-homepage: https://github.com/ZainIftikhar7vals/verbose_cancancan
+homepage: 
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ZainIftikhar7vals/verbose_cancancan/issues
+  documentation_uri: https://github.com/ZainIftikhar7vals/verbose_cancancan
+  homepage_uri: https://github.com/ZainIftikhar7vals/verbose_cancancan
 post_install_message: Thanks for installing!
 rdoc_options: []
 require_paths: