action_tracer 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0061b0039b327ef7923b1ccb60a49d3ecc299f93fbf13061087b90f0ae511865
-  data.tar.gz: bba51412925a6b3d23aeabc2e68c58ce6c572323a7ac4ba749f0de077dcc42af
+  metadata.gz: 7214356083ad06c96fe92939aa010ea7ad918d2273431eedecd9edfe3d358f3d
+  data.tar.gz: 13e9c9b139723297a2a92407786761a7f1df0bfc58a793e980daaa7232d665f8
 SHA512:
-  metadata.gz: 25be298bf88d787985c8b056fec084b225623de7d904b1872a541fcd3da338214ed31169492e4fceae38ca7568c2592280ce3b7483f608a3c8f6fba7cbfd717d
-  data.tar.gz: 4f90d3dfef39cdf116bff177057a74d8f889a33a23e66a6e68685057acef8cc4e15ae8d432d413848621d6009309f65c14718d2738c2551a02a0ff234e2d4a2f
+  metadata.gz: da46b25d92b0c5fba47b21cda6ccd555a6bf89dd9bcb40be436bbc55b7dc4c7cc4cce1d662927d26f492bc0fda5eba4f2ff1cddc0347b2f7f3450978dd0c7beb
+  data.tar.gz: 074af54035733e26735e927a84e0e1bc2717a28cddb583af30035deae31f29d3bd9391eed8830b4a684eb40355f75b67b6fbd031fd48d0775dfdd4ad2112613f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.5
+
+* Be able to inject logger.
+* Fix around_action ordering bug.
+* Be able to omit source_location path.
+
 ## 0.2.4
 
 * Fix bug for Rails7.x support.

data/README.md

@@ -60,12 +60,12 @@ it will put logs for `log/action_tracer.log` like this:
 ```log
 I, [2020-09-27T03:25:43.018298 #1]  INFO -- : ["APPLIED", :set_turbolinks_location_header_from_session, "/usr/local/bundle/gems/turbolinks-5.2.1/lib/turbolinks/redirection.rb", 43]
 I, [2020-09-27T03:25:43.019410 #1]  INFO -- : ["APPLIED", :verify_authenticity_token, "/usr/local/bundle/gems/actionpack-5.1.7/lib/action_controller/metal/request_forgery_protection.rb", 211]
-I, [2020-09-27T03:25:43.021131 #1]  INFO -- : ["APPLIED", :require_login, "/myapp/app/controllers/awesome_controller.rb", 17]
-I, [2020-09-27T03:25:43.022063 #1]  INFO -- : ["NO_APPLIED", :set_awesome, "/myapp/app/controllers/awesome_controller.rb", 25]
-I, [2020-09-27T03:25:43.023716 #1]  INFO -- : ["APPLIED", :with_readonly, "/myapp/app/controllers/awesome_controller.rb", 21]
-I, [2020-09-27T03:25:43.025547 #1]  INFO -- : ["ACTION", :index, "/myapp/app/controllers/awesome_controller.rb", 7]
-I, [2020-09-27T03:25:43.026297 #1]  INFO -- : ["APPLIED", :with_readonly, "/myapp/app/controllers/awesome_controller.rb", 21]
-I, [2020-09-27T03:25:43.027203 #1]  INFO -- : ["APPLIED", :store_location, "/myapp/app/controllers/awesome_controller.rb", 27]
+I, [2020-09-27T03:25:43.021131 #1]  INFO -- : ["APPLIED", :require_login, "app/controllers/awesome_controller.rb", 17]
+I, [2020-09-27T03:25:43.022063 #1]  INFO -- : ["NO_APPLIED", :set_awesome, "app/controllers/awesome_controller.rb", 25]
+I, [2020-09-27T03:25:43.023716 #1]  INFO -- : ["APPLIED", :with_readonly, "app/controllers/awesome_controller.rb", 21]
+I, [2020-09-27T03:25:43.025547 #1]  INFO -- : ["ACTION", :index, "app/controllers/awesome_controller.rb", 7]
+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 -- : 
 ```
@@ -78,7 +78,7 @@ Notice `around_action` is put 2 times around action though called 1 time.
 Normally log is put in this format:
 
 ```ruby
-["APPLIED", :require_login, "/myapp/app/controllers/awesome_controller.rb", 17]
+["APPLIED", :require_login, "app/controllers/awesome_controller.rb", 17]
 ```
 
 1. State. One of `APPLIED`, `NO_APPLIED` and `ACTION`.  
@@ -86,7 +86,7 @@ Normally log is put in this format:
 `NO_APPLIED`: Filter is registered but not executed.  
 `ACTION`: Called action.
 2. Method name. When filter is a Proc, just put `:Proc`.
-3. File path. It's absolute path.
+3. File path. In your application directory, it's omitted path. See Configuration section for details.
 4. Method line no.
 
 When filter is an object, log is put in this format:
@@ -95,7 +95,31 @@ When filter is an object, log is put in this format:
 ["UNRECOGNIZED", #<Awesome::Object:0x00007f95c35768f8>]
 ```
 
-We can't recgnize the filter is actually executed or not.
+We can't recognize the filter is actually executed or not.
+
+### Configuration
+
+To customize how to output log, add `config/initializers/action_tracer.rb`:
+
+```ruby
+ActionTracer.configure do |config|
+  # when you want to omit source_location path
+  config.omitted_source_location_paths = ["#{Dir.pwd}/"]
+  # e.g.
+  # config.omitted_source_location_paths = []
+  #   ["APPLIED", :require_login, "/Users/makicamel/works/github.com/makicamel/myapp/app/controllers/awesome_controller.rb", 17]
+  # config.omitted_source_location_paths = ["#{Dir.pwd}/"]
+  #   ["APPLIED", :require_login, "app/controllers/awesome_controller.rb", 17]
+
+  # when you want to output log to stdout
+  config.logger = Rails.logger
+end
+```
+
+- `omitted_source_location_paths`: Omitted source_location path. In default `["#{Dir.pwd}/"]`.
+- `logger`: Injectable logger. For example, to specify to output log to stdout.
+- `directory`: The directory to put log. In default `/log/`.
+- `file_name`: The log file name. In default `action_tracer.log`.
 
 ## CommingFeatures
 

data/lib/action_tracer/configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ActionTracer
+  class Configration
+    attr_writer :app_path, :directory, :file_name, :logger, :omitted_source_location_paths
+
+    def app_path
+      @app_path ||= Dir.pwd
+    end
+
+    def directory
+      @directory ||= '/log/'
+    end
+
+    def file_name
+      @file_name ||= 'action_tracer.log'
+    end
+
+    def logger
+      @logger ||= Logger.new(app_path + directory + file_name)
+    end
+
+    def omitted_source_location_paths
+      @omitted_source_location_paths ||= ["#{Dir.pwd}/"]
+    end
+
+    def omitted_source_location_path
+      @omitted_source_location_path ||= %r{#{omitted_source_location_paths.join('|')}}
+    end
+  end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configration.new
+    end
+
+    def logger
+      @logger ||= @config.logger
+    end
+  end
+end

data/lib/action_tracer/filters.rb

@@ -7,19 +7,30 @@ module ActionTracer
     PROC = :Proc
     attr_reader :applied
 
-    def initialize(filter, method:)
+    def initialize(filter, kind:, method:)
       @filter = filter.is_a?(Symbol) ? filter : PROC
+      @kind = kind
       @method = method
       @applied = ActionTracer.applied_filters.include? filter
     end
 
     def to_a
       if @method.respond_to? :source_location
-        [APPLIED[@applied], @filter, *@method.source_location]
+        source_location, line_number = *@method.source_location
+        source_location = source_location.sub(::ActionTracer.config.omitted_source_location_path, '')
+        [APPLIED[@applied], @filter, source_location, line_number].compact
       else
         [APPLIED[:unrecognized], @method]
       end
     end
+
+    def before?
+      @kind == :before || @kind == :around
+    end
+
+    def after?
+      @kind == :after || @kind == :around
+    end
   end
 
   class Action
@@ -34,7 +45,9 @@ module ActionTracer
     end
 
     def to_a
-      [APPLIED[:action], @name, *@method.source_location]
+      source_location, line_number = *@method.source_location
+      source_location = source_location.sub(::ActionTracer.config.omitted_source_location_path, '')
+      [APPLIED[:action], @name, source_location, line_number].compact
     end
 
     def self.nil_method
@@ -44,23 +57,23 @@ module ActionTracer
   end
 
   class Filters
-    def initialize(before = [], after = [], around = [], action:)
-      @before = before
-      @after = after
-      @around = around
+    def initialize(filters:, action:)
+      @filters = filters
       @action = action
     end
 
     class << self
       def build(controller)
-        filters = { before: [], after: [], around: [] }
-        raw_filters = controller.__callbacks[:process_action].send(:chain).group_by(&:kind)
-        raw_filters.each do |kind, filter|
-          filters[kind] = filter.map { |f| f.__send__(filter_method) }.map do |f|
-            Filter.new(f, method: f.is_a?(Symbol) ? controller.method(f) : f)
-          end
+        raw_filters = controller.__callbacks[:process_action].__send__(:chain)
+        filters = raw_filters.map do |raw_filter|
+          filter = raw_filter.__send__(filter_method)
+          Filter.new(
+            filter,
+            kind: raw_filter.kind,
+            method: filter.is_a?(Symbol) ? controller.method(filter) : filter
+          )
         end
-        new(filters[:before], filters[:after], filters[:around], action: Action.build(controller))
+        new(filters: filters, action: Action.build(controller))
       end
 
       private
@@ -73,17 +86,17 @@ module ActionTracer
     def print
       invoked_before.map(&:to_a).each { |filter| ActionTracer.logger.info filter }
       ActionTracer.logger.info @action.to_a
-      invoked_after.map(&:to_a).reverse_each { |filter| ActionTracer.logger.info filter }
+      invoked_after.map(&:to_a).each { |filter| ActionTracer.logger.info filter }
     end
 
     private
 
     def invoked_before
-      @before + @around
+      @filters.select(&:before?)
     end
 
     def invoked_after
-      @after + @around
+      @filters.select(&:after?).reverse
     end
   end
 end

data/lib/action_tracer/railtie.rb

@@ -3,22 +3,6 @@
 require "forwardable"
 
 module ActionTracer
-  class Config
-    attr_reader :path
-
-    def initialize(directory:, file:)
-      @path = directory + file
-    end
-  end
-
-  def self.app_path
-    @app_path ||= Dir.pwd
-  end
-
-  def self.config(directory: "/log/", file: "action_tracer.log")
-    @config ||= Config.new(directory: app_path + directory, file: file)
-  end
-
   class Railtie < ::Rails::Railtie
     initializer "action_tracer" do
       ActiveSupport.on_load(:action_controller) do

data/lib/action_tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionTracer
-  VERSION = "0.2.4"
+  VERSION = '0.2.5'
 end

data/lib/action_tracer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "action_tracer/version"
+require "action_tracer/configuration"
 require "action_tracer/railtie"
 require "action_tracer/filters"
-require "action_tracer/logger"
 require "action_tracer/action_tracer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_tracer
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - makicamel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,8 +89,8 @@ files:
 - bin/setup
 - lib/action_tracer.rb
 - lib/action_tracer/action_tracer.rb
+- lib/action_tracer/configuration.rb
 - 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

data/lib/action_tracer/logger.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-
-module ActionTracer
-  class Logger < ActiveSupport::LogSubscriber
-    extend Forwardable
-    def_delegators :@logger, :info
-
-    def initialize
-      @logger = ::Logger.new(ActionTracer.config.path)
-    end
-  end
-
-  def self.logger
-    @logger ||= Logger.new
-  end
-end