action_tracer 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b673efea32af55f62a1376f6e31be7155c60554317588535a98a841dd477c1
-  data.tar.gz: 9b0db3964dbc4789dc64f7aaf26f598938defd70729a0f340f4aa67d2c3d9988
+  metadata.gz: 1bf1d21b80f9a16147c4b61391671280b224b733e01cb06d935e8e5cc33e2429
+  data.tar.gz: 37786c2bd84386ace0059bae5bfe08b7d76900c0aac136b807f1b593a60a52b6
 SHA512:
-  metadata.gz: 03fdc176e562858664af1e5af1323f362c45fd555b31632e0b6f8b171873d8f9a34b6dcb1c17501695ddcd28d2bbb12c3779d04c06630c2085465b339d30c3d8
-  data.tar.gz: 8eaa24e2fbb31936b392a5e753925686fc61db40ed64db17a842df8860edbd7d5ddb0d60530855c540eec93a200592245ecd45706c9d257c5fbb53b9de98be94
+  metadata.gz: 71d4924fa5180a4883e5df715e61b638e7d76f4faee62feb4e37ae0d3255eb6ac8b3c5ca75b757900fa22e1e917e813d3b7fd1bb51635f9159f718c5a026d20b
+  data.tar.gz: 4b5ed78fbbf89ac1cf7ced8362bc599791bcb49e3a337d55ab4eaed3ce6fa62a982509859533d134371cacbc6cd7330fb1187bc7986fd80fc41e6848966f3350

data/.github/workflows/main.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ['3.0', '3.1', '3.2', '3.3', '3.4']
+        rails_version: ['7.1', '7.2', '8.0', '8.1']
+        exclude:
+          - ruby_version: '3.0'
+            rails_version: '7.2'
+          - ruby_version: '3.0'
+            rails_version: '8.0'
+          - ruby_version: '3.1'
+            rails_version: '8.0'
+          - ruby_version: '3.0'
+            rails_version: '8.1'
+          - ruby_version: '3.1'
+            rails_version: '8.1'
+    runs-on: ubuntu-latest
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
+    - name: Run the default task
+      run: |
+        bundle exec rake

data/.gitignore

@@ -6,7 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
-/log/
+/log/*
+!/log/.keep
 /test/log/
 /test/tmp/
 Gemfile.lock

data/Gemfile

@@ -6,3 +6,15 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in action_tracer.gemspec
 gemspec
+
+rails_version = ENV['RAILS_VERSION']
+if rails_version
+  version = "~> #{rails_version}"
+  %w[actionpack activesupport railties].each do |gem_name|
+    gem gem_name, version
+  end
+else
+  %w[actionpack activesupport railties].each do |gem_name|
+    gem gem_name
+  end
+end

data/README.md

@@ -7,7 +7,7 @@ Log Rails application actions and filters when accepts a request.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'action_tracer', group :development, :test
+gem 'action_tracer', group: [:development, :test]
 ```
 
 Notice this gem is for Rails with ApplicationController inherited ActiveController::Base.  
@@ -27,7 +27,7 @@ class AwesomeController < ApplicationController
   before_action :set_awesome, only: :show
   around_action :with_readonly
   after_action :store_location
-  
+
   def index
    # ...
   end
@@ -67,7 +67,7 @@ I, [2020-09-27T03:25:43.025547 #1]  INFO -- : ["ACTION", :index, "app/controller
 I, [2020-09-27T03:25:43.026297 #1]  INFO -- : ["APPLIED", :with_readonly, "app/controllers/awesome_controller.rb", 21]
 I, [2020-09-27T03:25:43.027203 #1]  INFO -- : ["APPLIED", :store_location, "app/controllers/awesome_controller.rb", 27]
 I, [2020-09-27T03:25:43.030074 #1]  INFO -- : ["APPLIED", :verify_same_origin_request, "/usr/local/bundle/gems/actionpack-5.1.7/lib/action_controller/metal/request_forgery_protection.rb", 240]
-I, [2020-09-27T03:25:43.030776 #1]  INFO -- : 
+I, [2020-09-27T03:25:43.030776 #1]  INFO -- :
 ```
 
 Filters are put in the order in which is executed.  
@@ -81,9 +81,10 @@ Normally log is put in this format:
 ["APPLIED", :require_login, "app/controllers/awesome_controller.rb", 17]
 ```
 
-1. State. One of `APPLIED`, `NO_APPLIED` and `ACTION`.  
+1. State. One of `APPLIED`, `NO_APPLIED`, `NOT_TRACED` and `ACTION`.
 `APPLIED`: Filter is executed.  
 `NO_APPLIED`: Filter is registered but not executed.  
+`NOT_TRACED`: Filter is a Proc. Execution status is not traced.  
 `ACTION`: Called action.
 2. Method name. When filter is a Proc, just put `:Proc`.
 3. File path. In your application directory, it's omitted path. See Configuration section for details.

data/Rakefile

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
 
-task default: :spec
+task default: :test

data/action_tracer.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
 end

data/lib/action_tracer/action_tracer.rb

@@ -5,17 +5,39 @@ module ActionTracer
 
   class << self
     def log(controller)
-      result = yield
+      yield
     ensure
       Filters.build(controller).print
       applied_filters.clear
       ActionTracer.logger.info ""
-
-      result
     end
 
     def applied_filters
       @applied_filters ||= []
     end
+
+    def wrap_callbacks(controller)
+      klass = controller.class
+      @wrapped_classes ||= []
+      return if @wrapped_classes.include?(klass)
+
+      filter_method = Rails::VERSION::MAJOR > 6 ? :filter : :raw_filter
+      raw_filters = controller.__callbacks[:process_action].__send__(:chain)
+      klass.prepend(
+        Module.new do
+          raw_filters.each do |raw_filter|
+            filter = raw_filter.__send__(filter_method)
+            next unless filter.is_a?(Symbol)
+
+            define_method(filter) do |*args, &block|
+              ActionTracer.applied_filters << filter
+              super(*args, &block)
+            end
+          end
+        end
+      )
+
+      @wrapped_classes << klass
+    end
   end
 end

data/lib/action_tracer/filters.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActionTracer
-  APPLIED = { true => "APPLIED", false => "NO_APPLIED", unrecognized: "UNRECOGNIZED", action: "ACTION" }.freeze
+  APPLIED = { true => "APPLIED", false => "NO_APPLIED", not_traced: "NOT_TRACED", unrecognized: "UNRECOGNIZED", action: "ACTION" }.freeze
 
   class Filter
     PROC = :Proc
@@ -11,7 +11,7 @@ module ActionTracer
       @filter = filter.is_a?(Symbol) ? filter : PROC
       @kind = kind
       @method = method
-      @applied = ActionTracer.applied_filters.include? filter
+      @applied = filter.is_a?(Symbol) ? ActionTracer.applied_filters.include?(filter) : :not_traced
     end
 
     def to_a
@@ -67,10 +67,16 @@ module ActionTracer
         raw_filters = controller.__callbacks[:process_action].__send__(:chain)
         filters = raw_filters.map do |raw_filter|
           filter = raw_filter.__send__(filter_method)
+          if filter.is_a?(Symbol)
+            method = controller.method(filter)
+            method = method.super_method while method.owner.name.nil?
+          else
+            method = filter
+          end
           Filter.new(
             filter,
             kind: raw_filter.kind,
-            method: filter.is_a?(Symbol) ? controller.method(filter) : filter
+            method: method,
           )
         end
         new(filters: filters, action: Action.build(controller))

data/lib/action_tracer/monkey_patches/abstract_controller/callbacks.rb

@@ -5,6 +5,7 @@ module ActionTracer
     module AbstractController
       module Callbacks
         def process_action(*args)
+          ActionTracer.wrap_callbacks(self)
           ActionTracer.log(self) do
             super
           end

data/lib/action_tracer/monkey_patches/active_support/callbacks.rb

@@ -4,65 +4,22 @@ module ActionTracer
   module MonkeyPatches
     module ActiveSupport
       module Callbacks
+        # For Rails::VERSION::MAJOR <= 6
         module CallTemplate
-          if Rails::VERSION::MAJOR > 6
-            module MethodCall
-              def expand(*)
-                super.tap { ActionTracer.applied_filters << @method_name }
-              end
-
-              def make_lambda
-                super >> proc { |result| ActionTracer.applied_filters << @method_name; result }
-              end
-
-              def inverted_lambda
-                super >> proc { |result| ActionTracer.applied_filters << @method_name; result }
-              end
-            end
-
-            module ProcCall
-              def expand(*)
-                super.tap { ActionTracer.applied_filters << @override_target }
-              end
-
-              def make_lambda
-                super >> proc { |result| ActionTracer.applied_filters << @override_target; result }
-              end
-
-              def inverted_lambda
-                super >> proc { |result| ActionTracer.applied_filters << @override_target; result }
-              end
-            end
-
-            module InstanceExec
-              def expand(*)
-                super.tap { ActionTracer.applied_filters << @override_block }
-              end
-
-              def make_lambda
-                super >> proc { |result| ActionTracer.applied_filters << @override_block; result }
-              end
-
-              def inverted_lambda
-                super >> proc { |result| ActionTracer.applied_filters << @override_block; result }
+          def expand(*)
+            target, block, method, *arguments = super
+            if target.is_a? ActionController::Base
+              case method
+              when :instance_exec # filter is a proc
+                ActionTracer.applied_filters << block
+              when String         # filter is an object
+                ActionTracer.applied_filters << block
+              when Symbol         # filter is a method
+                ActionTracer.applied_filters << method
               end
             end
-          else
-            def expand(*)
-              target, block, method, *arguments = super
-              if target.is_a? ActionController::Base
-                case method
-                when :instance_exec # filter is a proc
-                  ActionTracer.applied_filters << block
-                when String         # filter is an object
-                  ActionTracer.applied_filters << block
-                when Symbol         # filter is a method
-                  ActionTracer.applied_filters << method
-                end
-              end
 
-              [target, block, method, *arguments]
-            end
+            [target, block, method, *arguments]
           end
         end
       end

data/lib/action_tracer/railtie.rb

@@ -6,30 +6,6 @@ module ActionTracer
   class Railtie < ::Rails::Railtie
     initializer "action_tracer" do
       ActiveSupport.on_load(:action_controller) do
-        require "action_tracer/monkey_patches/active_support/callbacks"
-        if Rails::VERSION::MAJOR > 6
-          [
-            ::ActiveSupport::Callbacks::CallTemplate::MethodCall,
-            ::ActiveSupport::Callbacks::CallTemplate::ObjectCall,
-          ].each do |klass|
-            klass.prepend ActionTracer::MonkeyPatches::ActiveSupport::Callbacks::CallTemplate::MethodCall
-          end
-          [
-            ::ActiveSupport::Callbacks::CallTemplate::InstanceExec0,
-            ::ActiveSupport::Callbacks::CallTemplate::InstanceExec1,
-            ::ActiveSupport::Callbacks::CallTemplate::InstanceExec2,
-          ].each do |klass|
-            klass.prepend ActionTracer::MonkeyPatches::ActiveSupport::Callbacks::CallTemplate::InstanceExec
-          end
-          [
-            ::ActiveSupport::Callbacks::CallTemplate::ProcCall,
-          ].each do |klass|
-            klass.prepend ActionTracer::MonkeyPatches::ActiveSupport::Callbacks::CallTemplate::ProcCall
-          end
-        else
-          ::ActiveSupport::Callbacks::CallTemplate.prepend ActionTracer::MonkeyPatches::ActiveSupport::Callbacks::CallTemplate
-        end
-
         require "action_tracer/monkey_patches/abstract_controller/callbacks"
         ::ActionController::Base.prepend ActionTracer::MonkeyPatches::AbstractController::Callbacks
 

data/lib/action_tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionTracer
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: action_tracer
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - makicamel
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Log Rails application actions and filters when accepts a request
 email:
 - unright@gmail.com
@@ -73,10 +86,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -95,11 +107,11 @@ files:
 - lib/action_tracer/monkey_patches/active_support/callbacks.rb
 - lib/action_tracer/railtie.rb
 - lib/action_tracer/version.rb
+- log/.keep
 homepage: https://github.com/makicamel/action_tracer
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Log Rails application actions and filters when accepts a request
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 1.17.2