rails_tracepoint_stack 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874f14c9b66717408755c8bae182634b457f23ae684ec5cc6eb1bb2b07aa5865
-  data.tar.gz: e23e31fd3558896656efbb58796d9fc689f535b0835e646602eaa3590fba89af
+  metadata.gz: 8403ca731eb5b9b0c54af770d35dc805260a49e4a8d6092c3ae09ee83487864c
+  data.tar.gz: b518853ab09f13da65fbdee1c49fa6683dbec7e615de3b62e42834dbcb5b0812
 SHA512:
-  metadata.gz: 13efe4146269be0aa124022ca0b7fca5eaa8a91611a9a8e1f59af24d82af70f815f9853b0a4b93b5c1dd7de9401af13341e82f59b5ace70a0b47b1298b446c6c
-  data.tar.gz: 0bdc7578909e62f51dddf52b65e2de7a37d7afc1f8cdf794427bfda3e022ac1396627c3ffc2e5ee117fd322f81f1ec4f54ebad2172ffb2571779e8c890ff8bc3
+  metadata.gz: b449b592efe2f0a92dbae19fb5cb218fc3712f8d069a3caedefc286c1e29f533c6cf13fea0833a4a50aeb689cc1ea235e57788bed060221e1caa25b7a3fdde99
+  data.tar.gz: e039bd1ad9de1c78b29ab371d80f0a3b82755d96700c7c06c209f4ea9fe67adb60f3ac939cbad42c4341176ced07d3253db1deec2bae0a5fd61926f7361626b5

data/lib/rails_tracepoint_stack/configuration.rb

@@ -1,9 +1,16 @@
 module RailsTracepointStack
   class Configuration
-    attr_accessor :ignore_patterns, :logger
+    attr_accessor :file_path_to_filter_patterns,
+      :ignore_patterns,
+      :log_format,
+      :log_external_sources,
+      :logger,
 
     def initialize
+      @file_path_to_filter_patterns = []
       @ignore_patterns = []
+      @log_format = :text
+      @log_external_sources = false
       @logger = nil
     end
   end

data/lib/rails_tracepoint_stack/filter/gem_path.rb

@@ -0,0 +1,9 @@
+module RailsTracepointStack
+  module Filter
+    class GemPath
+      def self.full_gem_path
+        @full_gem_path ||= Bundler.load.specs.map(&:full_gem_path)
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/filter/rb_config.rb

@@ -0,0 +1,9 @@
+module RailsTracepointStack
+  module Filter
+    class RbConfig
+      def self.ruby_lib_path
+        @ruby_lib_path ||= ::RbConfig::CONFIG['rubylibdir']
+      end
+    end
+  end
+end

data/lib/rails_tracepoint_stack/log_formatter.rb

@@ -0,0 +1,26 @@
+module RailsTracepointStack
+  module LogFormatter
+    def self.message(trace)
+      case RailsTracepointStack.configuration&.log_format
+      when :json
+        json trace
+      else
+        text trace
+      end
+    end
+
+    def self.text(trace)
+      "called: #{trace.class_name}##{trace.method_name} in #{trace.file_path}:#{trace.line_number} with params: #{trace.params}"
+    end
+
+    def self.json(trace)
+      {
+        class: trace.class_name,
+        method_name: trace.method_name,
+        path: trace.file_path,
+        line: trace.line_number,
+        params: trace.params
+      }.to_json
+    end
+  end
+end

data/lib/rails_tracepoint_stack/logger.rb

@@ -1,14 +1,14 @@
 module RailsTracepointStack
   class Logger
     def self.log(msg)
-      unless RailsTracepointStack.configuration&.logger
-        File.open('log/rails_tracepoint_stack.log', 'a') do |f|
+      if RailsTracepointStack.configuration&.logger
+        RailsTracepointStack.configuration.logger.info(msg)
+      else
+        # TODO: Add the support to Rails.env for the default filename
+        File.open("log/rails_tracepoint_stack.log", 'a') do |f|
           f.puts msg
         end
-      else
-        RailsTracepointStack.configuration.logger.info(msg)
       end
     end
   end
 end
-

data/lib/rails_tracepoint_stack/trace.rb

@@ -0,0 +1,30 @@
+require 'forwardable'
+
+module RailsTracepointStack
+  class Trace
+    extend Forwardable
+
+    attr_reader :params, :trace_point
+
+    def_delegator :@trace_point, :defined_class, :class_name
+    def_delegator :@trace_point, :method_id, :method_name
+    def_delegator :@trace_point, :path, :file_path
+    def_delegator :@trace_point, :lineno, :line_number
+
+    def initialize(trace_point:)
+      @trace_point = trace_point
+    end
+
+    def params
+      @params ||= fetch_params(trace_point)
+    end
+
+    private
+
+    def fetch_params(trace_point)
+      trace_point.binding.local_variables.map { |var|
+        [var, trace_point.binding.local_variable_get(var)]
+      }.to_h
+    end
+  end
+end

data/lib/rails_tracepoint_stack/trace_filter.rb

@@ -1,31 +1,63 @@
+require 'rails_tracepoint_stack/filter/gem_path'
+require 'rails_tracepoint_stack/filter/rb_config'
+
 module RailsTracepointStack
   class TraceFilter
     def self.ignore_trace?(trace:)
-      start_with_to_ignore_prefixes?(trace) || from_gempath_or_lib_path?(trace) || is_a_to_ignore_pattern?(trace)
+      if defined_file_path_to_filter_patterns?
+        not_matches_file_path_to_filter_patterns?(trace)
+      else
+        contains_to_ignore_strings?(trace) || from_gempath_or_lib_path?(trace) || is_a_to_ignore_pattern?(trace)
+      end
     end
 
     private
 
+    def self.contains_to_ignore_strings?(trace)
+      trace.file_path.start_with?('<internal:') || trace.file_path == '(eval)'
+    end
+
+    def self.from_gempath_or_lib_path?(trace)
+      !RailsTracepointStack.configuration&.log_external_sources &&
+      (
+        file_path_starts_with_gem_path?(trace) ||
+        file_path_starts_with_ruby_lib_path?(trace) ||
+        file_path_starts_with_bundler_path?(trace)
+      )
+    end
+
+    def self.is_a_to_ignore_pattern?(trace)
+      RailsTracepointStack.configuration&.ignore_patterns&.any? { |pattern| trace.file_path.match?(pattern) }
+    end
+
+    def self.file_path_starts_with_gem_path?(trace)
+     gem_paths.any? { |path| trace.file_path.start_with?(path) }
+    end
+
+    def self.file_path_starts_with_ruby_lib_path?(trace)
+      trace.file_path.start_with?(ruby_lib_path)
+    end
+
+    def self.file_path_starts_with_bundler_path?(trace)
+      trace.file_path.include?("gems/bundler")
+    end
+
     def self.gem_paths
-      @gem_paths ||= Bundler.load.specs.map(&:full_gem_path)
+      @gem_paths ||= RailsTracepointStack::Filter::GemPath.full_gem_path
     end
 
     def self.ruby_lib_path
-      @ruby_lib_path ||= RbConfig::CONFIG['rubylibdir']
-    end
-    
-    def self.start_with_to_ignore_prefixes?(trace)
-      trace.path.start_with?('<internal:') || trace.path == '(eval)'
+      @ruby_lib_path ||= RailsTracepointStack::Filter::RbConfig.ruby_lib_path
     end
 
-    def self.from_gempath_or_lib_path?(trace)
-      gem_paths.any? { |path| trace.path.start_with?(path) } || 
-        trace.path.start_with?(ruby_lib_path) || 
-          trace.path.include?("gems/bundler")
+    def self.defined_file_path_to_filter_patterns?
+      RailsTracepointStack.configuration&.file_path_to_filter_patterns&.any?
     end
 
-    def self.is_a_to_ignore_pattern?(trace)
-      RailsTracepointStack.configuration&.ignore_patterns&.any? { |pattern| trace.path.match?(pattern) }
+    def self.not_matches_file_path_to_filter_patterns?(trace)
+      !RailsTracepointStack.configuration.file_path_to_filter_patterns.any? do |pattern|
+        trace.file_path.match?(pattern)
+      end
     end
   end
 end

data/lib/rails_tracepoint_stack/tracer.rb

@@ -1,25 +1,22 @@
+#TODO: Move to a loader file
 require 'rails_tracepoint_stack/logger'
 require 'rails_tracepoint_stack/trace_filter'
+require 'rails_tracepoint_stack/trace'
+require 'rails_tracepoint_stack/log_formatter'
 
 module RailsTracepointStack
   class Tracer
+    # TODO: Tracer.new shoud return the tracer. Is weird to call Tracer.new.tracer
     def tracer
-      @trace ||= TracePoint.new(:call) do |tp|
-        next if RailsTracepointStack::TraceFilter.ignore_trace?(trace: tp)
+      @tracer ||= TracePoint.new(:call) do |tracepoint|
+        trace = RailsTracepointStack::Trace.new(trace_point: tracepoint)
 
-        params = fetch_params(tp)
-        
-        RailsTracepointStack::Logger.log "called: #{tp.defined_class}##{tp.method_id} in #{tp.path}:#{tp.lineno} with params: #{params}"
-      end
-    end
+        next if RailsTracepointStack::TraceFilter.ignore_trace?(trace: trace)
 
-    private
-    attr_reader :gem_paths, :ruby_lib_path
-
-    def fetch_params(tp)
-      tp.binding.local_variables.map { |var|
-        [var, tp.binding.local_variable_get(var)]
-      }.to_h
+        # TODO: Use proper OO
+        message = RailsTracepointStack::LogFormatter.message trace
+        RailsTracepointStack::Logger.log message 
+      end
     end
   end
 end

data/lib/rails_tracepoint_stack/version.rb

@@ -0,0 +1,3 @@
+module RailsTracepointStack
+  VERSION = "0.3.1"
+end

data/lib/rails_tracepoint_stack.rb

@@ -1,4 +1,6 @@
+require 'json'
 require 'rails_tracepoint_stack/configuration'
+require 'rails_tracepoint_stack/log_formatter'
 require 'rails_tracepoint_stack/tracer'
 
 $rails_tracer_rtps = nil
@@ -24,7 +26,7 @@ module RailsTracepointStack
   end
 end
 
-if ENV.fetch('RAILS_TRACEPOINT_STACK', 'false') == 'true'
+if ENV.fetch('RAILS_TRACEPOINT_STACK_ENABLED', 'false') == 'true'
   $rails_tracer_rtps = RailsTracepointStack::Tracer.new.tracer
   $rails_tracer_rtps.enable
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_tracepoint_stack
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Carlos Daniel Pohlod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-19 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
 description: A formatted output of all methods called in your rails application of
   code created by the developer, with the complete path to the class/module, including
   passed params.
@@ -60,9 +60,14 @@ extra_rdoc_files: []
 files:
 - lib/rails_tracepoint_stack.rb
 - lib/rails_tracepoint_stack/configuration.rb
+- lib/rails_tracepoint_stack/filter/gem_path.rb
+- lib/rails_tracepoint_stack/filter/rb_config.rb
+- lib/rails_tracepoint_stack/log_formatter.rb
 - lib/rails_tracepoint_stack/logger.rb
+- lib/rails_tracepoint_stack/trace.rb
 - lib/rails_tracepoint_stack/trace_filter.rb
 - lib/rails_tracepoint_stack/tracer.rb
+- lib/rails_tracepoint_stack/version.rb
 homepage: https://github.com/carlosdanielpohlod/rails_tracepoint_stack/
 licenses:
 - MIT