active_record_query_trace 1.8 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06d7497a2165d922974efd1ffc10bf6b6725d1c4705f9b5d5464affca6db069e
-  data.tar.gz: 1d5bf04f35d74b69cddc657d9f91795c315ce4b50422cc79aa06843a0299d3e9
+  metadata.gz: ffcc5119bc05b3f37ad664c99bd5fbfa8e8e4d9d014ef6684381c26df844d9df
+  data.tar.gz: 0fe883ba8442ad46737b90fef82100f82875f76fc023112548c997ae8451d9c4
 SHA512:
-  metadata.gz: '09cd3daa1e090acc6e8bafd776c28c3df40f190baccd3799e5b93629a416f890ce4b4514993842830159840fe8d688ef71ba45f54893c62cf053b045c8dd978f'
-  data.tar.gz: d53226b99e6eae63ea2b79abf5db75f4f04c546773dc61fda88962d9de2b4c465f84c3af6481b3778d0410e3c4ed07433b29ba29eba5d4481c04efe9d836118c
+  metadata.gz: 91681694fdddf26183798f31d9ef6d78a55ed4aeae99824271dc198a3aaf7b4fea7b5f2de883896b3b9840e2d643bfee6052e74ae125c852b22ed035855420f3
+  data.tar.gz: 874d7d710c22f18bcb38d3b13509979b4ad912aadc11e3c0889b223f13752c4c2f3d1e275575e8598d1ae0ea82d2fbf32fbe7f0beb6d37491d05b74801e41930

data/lib/active_record_query_trace/version.rb

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

data/lib/active_record_query_trace.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_record/log_subscriber'
+require_relative 'active_record_query_trace/version'
 
 module ActiveRecordQueryTrace
   INDENTATION = ' ' * 6
@@ -26,14 +27,9 @@ module ActiveRecordQueryTrace
   }.freeze
 
   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_accessor :enabled, :lines, :ignore_cached_queries, :colorize, :query_type, :suppress_logging_of_db_reads
+    attr_writer :default_cleaner
+    attr_reader :backtrace_cleaner, :level
 
     def backtrace_cleaner=(cleaner)
       @backtrace_cleaner =
@@ -43,6 +39,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 +92,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?
+      debug(trace) if trace.present?
     end
 
+    delegate :default_cleaner, to: ActiveRecordQueryTrace
+
     attach_to :active_record
 
     private
@@ -93,7 +124,7 @@ module ActiveRecordQueryTrace
       when :write then !db_read_query?(payload)
       else
         raise 'Invalid ActiveRecordQueryTrace.query_type value ' \
-          "#{ActiveRecordQueryTrace.level}. Should be :all, :read, or :write."
+              "#{ActiveRecordQueryTrace.level}. Should be :all, :read, or :write."
       end
     end
 
@@ -104,7 +135,7 @@ module ActiveRecordQueryTrace
     def fully_formatted_trace
       cleaned_trace = clean_trace(original_trace)
       return if cleaned_trace.blank?
-      stringified_trace = BACKTRACE_PREFIX + lines_to_display(cleaned_trace).join("\n" + INDENTATION)
+      stringified_trace = BACKTRACE_PREFIX + lines_to_display(cleaned_trace).join("\n#{INDENTATION}")
       colorize_text(stringified_trace)
     end
 
@@ -127,7 +158,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'
@@ -135,7 +166,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
@@ -145,38 +176,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
@@ -204,7 +203,7 @@ module ActiveRecordQueryTrace
     def validate_color_code(color_code)
       valid_color_code?(color_code) || raise(
         'ActiveRecordQueryTrace.colorize was set to an invalid ' \
-          "color. Use one of #{COLORS.keys} or a valid color code."
+        "color. Use one of #{COLORS.keys} or a valid color code."
       )
     end
 
@@ -215,12 +214,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
 
@@ -244,7 +237,7 @@ ActiveSupport::LogSubscriber.class_eval do
 
   def debug(*args, &block)
     return if ActiveRecordQueryTrace.suppress_logging_of_db_reads \
-      && args.first !~ /INSERT|UPDATE|DELETE|#{ActiveRecordQueryTrace::BACKTRACE_PREFIX}/
+      && args.first !~ /INSERT|UPDATE|DELETE|#{ActiveRecordQueryTrace::BACKTRACE_PREFIX}/o
     original_debug(*args, &block)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_trace
 version: !ruby/object:Gem::Version
-  version: '1.8'
+  version: 1.8.2
 platform: ruby
 authors:
 - Cody Caughlan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,112 +17,126 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :development
+        version: 6.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: '1.55'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: '1.55'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: '1.18'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '2.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '2.22'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.22.0
 description: Print stack trace of all DB queries to the Rails log. Helpful to find
   where queries are being executed in your application.
 email: bruno@facca.info
@@ -135,7 +149,8 @@ files:
 homepage: https://github.com/brunofacca/active-record-query-trace
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/brunofacca/active-record-query-trace
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -144,17 +159,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4.0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+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