verbose_cancancan 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '010389ab552bdd7cee222d38b511321928ac226eff7901b65883ce2c5985eb14'
-  data.tar.gz: dc19423459a9357c33e0427ffaabd97449da5c05e4f61fed3f6958d4d3ef4996
+  metadata.gz: f06f9036e8c7dc7b482a80b5639387189062adc274da49e9771d56fd2e59ef01
+  data.tar.gz: 3a324d862ca09b0b9919657a5404d86c25e25aeb3c12bdb6e7f81649bef4e94d
 SHA512:
-  metadata.gz: c6fb9997722011082ed9e9e59b376d398f6b90a8dbe0f6ea153739b92651d271e4c7fab6b59b550dcee9b050bc311cfb85a7b1dc1290da5b5e3b317714e332db
-  data.tar.gz: 4053410a30b3a664a4dd1aaf317dcd935a82e426c01f622258dd4fedaa6b715ad06b7b0010283c16e6bcad0efddc64e028274b039f3eb1f1632adee5247c5e92
+  metadata.gz: e7bf88f2885bc343284974cc38c26b583757182e6eca8816acef6decd1881e6d91e75fa9a0ac87f14521f8ab5a9d967ecfed23353232142bb972887b66bfee57
+  data.tar.gz: 3c56243f19ab40fb42a3497ce656884d581058f00fc72403092669a09034810c9267276baf0920877d2019fdec0dbda70821f1fa980eb7fc73132d5d627812c3

data/lib/verbose_cancancan/ability.rb

@@ -0,0 +1,64 @@
+module VerboseCancancan
+
+
+  module Ability
+
+    def can?(action, subject, attribute = nil, *extra_args)
+      match = extract_subjects(subject).lazy.map do |a_subject|
+        relevant_rules_for_match(action, a_subject).detect do |rule|
+          rule.matches_conditions?(action, a_subject, attribute, *extra_args) && rule.matches_attributes?(attribute)
+        end
+      end.reject(&:nil?).first
+
+      log_rule(match, action, subject) if log_rule?
+
+      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. 
+    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)
+      else
+        VerboseCancancan.logger.info no_rule_matched(subject, action)
+      end
+    end
+
+    def matched_rule_info(rule, subject, action) 
+      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}"
+    end
+
+    def no_rule_matched(subject, action)
+      "#{auth_failed} No matching rule for #{colourize(subject, :cyan)} (Action: #{colourize(action, :yellow)})"
+    end
+
+    def pretty_subject(subject)
+      if subject.is_a?(ActiveRecord::Base)
+        "#{subject.class.name} (ID: #{subject.id})"
+      else
+        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 colourize(...) = VerboseCancancan.colourize(...)
+
+  end
+end

data/lib/verbose_cancancan/controller_resource.rb

@@ -0,0 +1,31 @@
+module VerboseCancancan
+  module ControllerResource
+
+    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
+
+      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
+                  .new(controller, resource_name, options.except(:only, :except, :if, :unless)).send(method)
+      end
+    end
+
+    def self.log_hook_added?(hook)
+      hook.to_s.include? ('authorize_resource')
+    end
+
+    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
+
+    def self.colourize(...) = VerboseCancancan.colourize(...)
+
+  end
+end

data/lib/verbose_cancancan/railtie.rb

@@ -0,0 +1,15 @@
+module VerboseCancancan
+  class Railtie < Rails::Railtie
+    initializer "my_gem.configure_rails_initialization" do
+      # some initialization behavior
+      puts "\n\n\nhola\n\n\n"
+
+      CanCan::Rule.prepend(Rule)
+      CanCan::Ability.prepend(Ability)
+
+      CanCan::ControllerResource.singleton_class.prepend(VerboseCancancan::ControllerResource)
+
+
+    end
+  end
+end

data/lib/verbose_cancancan/rule.rb

@@ -0,0 +1,12 @@
+module VerboseCancancan
+
+  module Rule
+    def initialize(...)
+      @path = VerboseCancancan.cleaner_backtrace(caller).first
+      super
+    end
+
+    def path = @path
+  end
+
+end

data/lib/verbose_cancancan.rb

@@ -1,3 +1,39 @@
-class Array
-  def zain = puts "hello world"
-end
+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 cleaner_backtrace(locations)
+      bk_trace = ActiveSupport::BacktraceCleaner.new
+      root     = "#{Rails.root}/"
+      bk_trace.add_filter { |line| line.delete_prefix(root) }
+
+      bk_trace.clean(locations)
+    end
+
+    def colourize(msg, color)
+      colors = {
+        clear:  "\e[0m",
+        red:    "\e[1;31m",
+        green:  "\e[1;92m",
+        yellow: "\e[33m",
+        cyan:   "\e[36m"
+      }
+
+      "#{colors[color]}#{msg}#{colors[:clear]}"
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbose_cancancan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Zain Iftikhar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancancan
@@ -35,7 +35,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/verbose_cancancan.rb
-homepage: 
+- lib/verbose_cancancan/ability.rb
+- lib/verbose_cancancan/controller_resource.rb
+- lib/verbose_cancancan/railtie.rb
+- lib/verbose_cancancan/rule.rb
+homepage: https://github.com/ZainIftikhar7vals/verbose_cancancan
 licenses:
 - MIT
 metadata: {}