action_tracer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6886a0826048909019cd75d52f9ea682833b56addca3f7cd7636e313fe1c79b
-  data.tar.gz: e2f352937846c839de2837534f5b60be2c210623182d1a24d4d06323d35c8e0f
+  metadata.gz: 833bc9f0ef13dc38365b9fed4b4ec1e6d31e3836ae07a44f366e2eb4d198e2d1
+  data.tar.gz: ae5c7acf603370367d3f77bd7999cfdc51ddce60a886951c4f3b05ca2c4ad442
 SHA512:
-  metadata.gz: '075917e7971d4b75385e425ca49428fc63093cfb4496fe96fd30d84e8e23a382d5ffe77a8b8c4950031528f2f67d01f8b967d44216104add9399dc63d3572a21'
-  data.tar.gz: fabc09fb2d4911362b9c732603e9901cfda1807c01a682b5c69fd2c40932707009faa2836f21e4dbf797a9bb10bc5e689662442ef8946de94190e94f4dfec9d0
+  metadata.gz: 9a8db105412a32d90e32e5f76947b8740dbc0dbdeebca1981304e1d09bd6922778a02f72e6d62c341df003eef120230bd7d0530b1eb8c797ee4c26d78d8fcc43
+  data.tar.gz: a1a9685cb4d7e8c3fad3560dd645c0ac7044ec3c1824f9a7abe75d4b0b123d905ea4713344231fef1a0ce78cbb5ac121fac22bbf6e92a939868a89e750102a73

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.2.0
+
+* Stop using TracePoint and just override ActiveSupport::Callbacks::CallTemplate
+We don't necessary passing environment variable anymore!

data/README.md

@@ -15,31 +15,7 @@ Support for Rails application with ActiveController::API is comming soon.
 
 ## Usage
 
-Run rails server or run rspec with `ACTION_TRACER=1` to log actions and filters for `log/action_tracer.log`.
-
-```bash
-$ ACTION_TRACER=1 rails server
-```
-
-You can also run rspec for your request specs.
-
-```bash
-$ ACTION_TRACER=1 rspec
-```
-
-If you use docker-compose, pass environment variable:
-
-```yml
-version: 3
-services:
-  web:
-    build: .
-    command: bundle exec rails s -p 3000
-    environment:
-      ACTION_TRACER: 1
-    volumes:
-      # ...
-```
+Run rails server or run rspec and check `log/action_tracer.log`.
 
 ### Example
 
@@ -78,7 +54,7 @@ private
 end
 ```
 
-When you run rails server with `ACTION_TRACER=1` and access `/awesome` (action is `#index`),    
+When you run rails server and access `/awesome` (action is `#index`),  
 it will put logs for `log/action_tracer.log` like this:
 
 ```log
@@ -124,9 +100,6 @@ We can't recgnize the filter is actually executed or not.
 ## CommingFeatures
 
 - Support for Rails application with ActiveController::API
-- Add non-checking mode
-  - Memorizing filters are applied or not is very costly.  
-  Add non-checking mode filters are actually applied or not.
 - Log rotate
 
 ## Contributing

data/lib/action_tracer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "action_tracer/version"
-require "action_tracer/railtie" if ENV["ACTION_TRACER"]
+require "action_tracer/railtie"
 require "action_tracer/filters"
 require "action_tracer/logger"
 require "action_tracer/action_tracer"

data/lib/action_tracer/action_tracer.rb

@@ -5,9 +5,7 @@ module ActionTracer
 
   class << self
     def log(controller)
-      filter_collector.enable
       result = yield
-      filter_collector.disable
       Filters.build(controller).print
       applied_filters.clear
       ActionTracer.logger.info ""
@@ -15,25 +13,6 @@ module ActionTracer
       result
     end
 
-    def filter_collector
-      @filter_collector ||= TracePoint.new(:return) do |tp|
-        # NOTE: ActiveSupport::Callbacks::CallTemplate is a private class
-        if tp.method_id == :expand && tp.defined_class == ActiveSupport::Callbacks::CallTemplate
-          if tp.return_value&.first.is_a? ActionController::Base
-            # target, block, method, *arguments = tp.return_value
-            case tp.return_value[2]
-            when :instance_exec # filter is a proc
-              applied_filters << tp.return_value[1]
-            when String         # filter is an object
-              applied_filters << tp.return_value[1]
-            when Symbol         # filter is a method
-              applied_filters << tp.return_value[2]
-            end
-          end
-        end
-      end
-    end
-
     def applied_filters
       @applied_filters ||= []
     end

data/lib/action_tracer/filters.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module ActionTracer
+  APPLIED = { true => "APPLIED", false => "NO_APPLIED", unrecognized: "UNRECOGNIZED", action: "ACTION" }.freeze
+
   class Filter
-    APPLIED = { true => "APPLIED", false => "NO_APPLIED" }.freeze
     PROC = :Proc
     attr_reader :applied
 
@@ -16,7 +17,7 @@ module ActionTracer
       if @method.respond_to? :source_location
         [APPLIED[@applied], @filter, *@method.source_location]
       else
-        ["UNRECOGNIZED", @method]
+        [APPLIED[:unrecognized], @method]
       end
     end
   end
@@ -42,7 +43,7 @@ module ActionTracer
 
     def print
       invoked_before.map(&:to_a).each { |filter| ActionTracer.logger.info filter }
-      ActionTracer.logger.info ["ACTION", @action.name, *@action.source_location]
+      ActionTracer.logger.info [APPLIED[:action], @action.name, *@action.source_location]
       invoked_after.map(&:to_a).reverse_each { |filter| ActionTracer.logger.info filter }
     end
 

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActionTracer
+  module MonkeyPatches
+    module ActiveSupport
+      module Callbacks
+        module CallTemplate
+          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
+        end
+      end
+    end
+  end
+end

data/lib/action_tracer/railtie.rb

@@ -22,6 +22,8 @@ module ActionTracer
   class Railtie < ::Rails::Railtie
     initializer "action_tracer" do
       ActiveSupport.on_load(:action_controller) do
+        require "action_tracer/monkey_patches/active_support/callbacks"
+        ::ActiveSupport::Callbacks::CallTemplate.prepend ActionTracer::MonkeyPatches::ActiveSupport::Callbacks::CallTemplate
         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.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - makicamel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,6 +106,7 @@ files:
 - lib/action_tracer/filters.rb
 - lib/action_tracer/logger.rb
 - lib/action_tracer/monkey_patches/abstract_controller/callbacks.rb
+- lib/action_tracer/monkey_patches/active_support/callbacks.rb
 - lib/action_tracer/railtie.rb
 - lib/action_tracer/version.rb
 homepage: https://github.com/makicamel/action_tracer