active_record_query_trace 1.7 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9863216a6d3587bfe68f4aeee1213e6f1e16475045e20231fac8870f996ccb
-  data.tar.gz: 43a7bd0611953022e35f1909deefb395d35c2c1b2349a49eb5270b0c74566d83
+  metadata.gz: 9148d2ea96878f6bd1031637db809f39445b393831a397d8e8ecda57bc6a6f86
+  data.tar.gz: db356dff425204012c693c7d9ab17f867d4b1574965ebd966b60ee95b5a540ab
 SHA512:
-  metadata.gz: 9936bc3e438c24fc1d652c8710b8f9e82b485ab26f1189ec45667015bc96fa88d7256bd6259247df65b8f81b70eb6b8a0f719027edff01a6626b6fe7c9972d92
-  data.tar.gz: 90568c7a20aa1c64a2465efea7a9769119d5999c2a7bdf01ea785375e3ddc5445132607d0dfe0d0e693b6811e1c8782060270571cc5ef882094073d16ef30a8b
+  metadata.gz: 4bc0b49b7ab734944ecf2122ec0f97b177a47fa1d6bd810770369edcf63c4ebcb384bd879823cbb2ef7be8301d36ee1b1a5a1b402844a9201888f2482986fd86
+  data.tar.gz: f48e1191fd895a4e297272ce0a72b13c30971cba23724a27fe9ed2996e198c59b977b1d2fb88818c2212d638728c9f5dc8fc09b57737b0c81cfabffebd0280cb

data/lib/active_record_query_trace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordQueryTrace
-  VERSION = '1.7'
+  VERSION = '1.8.1'
 end

data/lib/active_record_query_trace.rb

@@ -27,13 +27,13 @@ module ActiveRecordQueryTrace
 
   class << self
     attr_accessor :enabled
-    attr_accessor :level
     attr_accessor :lines
     attr_accessor :ignore_cached_queries
     attr_accessor :colorize
     attr_accessor :query_type
     attr_accessor :suppress_logging_of_db_reads
-    attr_reader :backtrace_cleaner
+    attr_writer :default_cleaner
+    attr_reader :backtrace_cleaner, :level
 
     def backtrace_cleaner=(cleaner)
       @backtrace_cleaner =
@@ -43,6 +43,42 @@ module ActiveRecordQueryTrace
           proc { |trace| cleaner.clean(trace) }
         end
     end
+
+    # When changing the level we need to reset the backtrace cleaner used
+    def level=(level)
+      @level = level
+      @default_cleaner = nil
+    end
+
+    def default_cleaner
+      @default_cleaner ||= setup_backtrace_cleaner
+    end
+
+    # The following code creates a brand new BacktraceCleaner just for the use of this Gem
+    # avoiding the dealing with Rails.backtrace_cleaner
+    def setup_backtrace_cleaner
+      cleaner = Rails::BacktraceCleaner.new
+      remove_filters_and_silencers cleaner
+      cleaner.instance_variable_set :@root, Rails.root.to_s if cleaner.instance_variable_get(:@root) == '/'
+      case ActiveRecordQueryTrace.level
+      when :app
+        cleaner.add_silencer { |line| line !~ rails_root_regexp }
+      when :rails
+        cleaner.add_silencer { |line| line =~ rails_root_regexp }
+      end
+      cleaner
+    end
+
+    def remove_filters_and_silencers(cleaner)
+      cleaner.remove_filters!
+      cleaner.remove_silencers!
+    end
+
+    # This cannot be set in a constant as Rails.root is not yet available when
+    # this file is loaded.
+    def rails_root_regexp
+      @rails_root_regexp ||= %r{#{Regexp.escape(Rails.root.to_s)}(?!\/vendor)}
+    end
   end
 
   class CustomLogSubscriber < ActiveRecord::LogSubscriber # rubocop:disable Metrics/ClassLength
@@ -60,13 +96,12 @@ module ActiveRecordQueryTrace
     def sql(event)
       payload = event.payload
       return unless display_backtrace?(payload)
-
-      setup_backtrace_cleaner unless ActiveRecordQueryTrace.backtrace_cleaner
-
       trace = fully_formatted_trace # Memoize
       debug(trace) unless trace.blank?
     end
 
+    delegate :default_cleaner, to: ActiveRecordQueryTrace
+
     attach_to :active_record
 
     private
@@ -76,7 +111,6 @@ module ActiveRecordQueryTrace
       payload[:cached] || payload[:name] == 'CACHE'
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     # TODO: refactor and remove rubocop:disable comments.
     def display_backtrace?(payload)
       ActiveRecordQueryTrace.enabled \
@@ -86,7 +120,6 @@ module ActiveRecordQueryTrace
         && !(ActiveRecordQueryTrace.suppress_logging_of_db_reads && db_read_query?(payload)) \
         && display_backtrace_for_query_type?(payload)
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def display_backtrace_for_query_type?(payload)
       case ActiveRecordQueryTrace.query_type
@@ -129,7 +162,7 @@ module ActiveRecordQueryTrace
       when :full
         trace = full_trace
       when :app, :rails
-        trace = Rails.backtrace_cleaner.clean(full_trace)
+        trace = default_cleaner.clean(full_trace)
       when :custom
         unless ActiveRecordQueryTrace.backtrace_cleaner
           raise 'Configure your backtrace cleaner first via ActiveRecordQueryTrace.backtrace_cleaner = MyCleaner'
@@ -137,7 +170,7 @@ module ActiveRecordQueryTrace
         trace = ActiveRecordQueryTrace.backtrace_cleaner.call(full_trace)
       else
         raise 'Invalid ActiveRecordQueryTrace.level value ' \
-          "#{ActiveRecordQueryTrace.level}. Should be :full, :rails, or :app."
+              "#{ActiveRecordQueryTrace.level}. Should be :full, :rails, or :app."
       end
 
       # We cant use a Rails::BacktraceCleaner filter to display only the relative
@@ -147,38 +180,6 @@ module ActiveRecordQueryTrace
     end
     # rubocop:enable Metrics/MethodLength
 
-    # Rails by default silences all backtraces that *do not* match
-    # Rails::BacktraceCleaner::APP_DIRS_PATTERN. In other words, the default
-    # silencer filters out all framework backtrace lines, leaving only the
-    # application lines.
-    def setup_backtrace_cleaner
-      setup_backtrace_cleaner_path
-      return if ActiveRecordQueryTrace.level == :full
-
-      remove_filters_and_silencers
-
-      case ActiveRecordQueryTrace.level
-      when :app
-        Rails.backtrace_cleaner.add_silencer { |line| line !~ rails_root_regexp }
-      when :rails
-        Rails.backtrace_cleaner.add_silencer { |line| line =~ rails_root_regexp }
-      end
-    end
-
-    # Rails relies on backtrace cleaner to set the application root directory
-    # filter. The problem is that the backtrace cleaner is initialized before
-    # this gem. This ensures that the value of `root` used by the filter
-    # is correct.
-    def setup_backtrace_cleaner_path
-      return unless Rails.backtrace_cleaner.instance_variable_get(:@root) == '/'
-      Rails.backtrace_cleaner.instance_variable_set :@root, Rails.root.to_s
-    end
-
-    def remove_filters_and_silencers
-      Rails.backtrace_cleaner.remove_filters!
-      Rails.backtrace_cleaner.remove_silencers!
-    end
-
     # Allow query to be colorized in the terminal
     def colorize_text(text)
       return text unless ActiveRecordQueryTrace.colorize
@@ -217,12 +218,6 @@ module ActiveRecordQueryTrace
     def rails_root_prefix
       @rails_root_prefix ||= "#{Rails.root}/"
     end
-
-    # This cannot be set in a constant as Rails.root is not yet available when
-    # this file is loaded.
-    def rails_root_regexp
-      @rails_root_regexp ||= %r{#{Regexp.escape(Rails.root.to_s)}(?!\/vendor)}
-    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_trace
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: 1.8.1
 platform: ruby
 authors:
 - Cody Caughlan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2023-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -29,30 +29,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,17 +142,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Print stack trace of all DB queries to the Rails log. Helpful to find where