active_record_query_trace 1.6.1 → 1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 065d0d118eb1db21b6095e817d3d2644a833aa191014650f0aa761cdcdde1f67
-  data.tar.gz: c68672567f6b98fc6d58a6aa4cdfce6b8f53c9171a14c6ed72b12793ebb0241c
+  metadata.gz: 7b5e993ea82ca839b520e3e11a3ca7fb9c2109abbae2f0a91d52e04e2f8cf656
+  data.tar.gz: 4be20dad7c8d8002fff46a801e4df6244e4130854a873bb7d70d8490a14861e4
 SHA512:
-  metadata.gz: 2dae585f11b61adf9333ae499bcd8739d3675fc7ab1e3e9a669f8a5d3ab133b80ce8e0afdf534eabca4241576146ddb43ded36c4e4f3b8b3e4d1f65949d82dfa
-  data.tar.gz: 57822d872644b5ddea72c2b1e1bbd9a01084af37bc0e71a97e87c209403de7cd9c88eb7364574bb58cf24819e0f4f30319dc3e5d156fa2b493d121eb54e2ed31
+  metadata.gz: 48c2560aaf4754231a27a9a62f32a4424eadc9cc0a4a64d78eafc1ac4d5dcb1fe2cde57d97c0fa2d9daeda71943558c7d6db45fd6cf17cfb68a65a5da44aade7
+  data.tar.gz: 71b2c37831a9d8313372048946b370ded9221de476d3fedf4b0bf75a4d1c775417ed7aee373a45554103041529e88372c58999df9d00fdcbd4f7a1d03e838adb

data/lib/active_record_query_trace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordQueryTrace
-  VERSION = '1.6.1'
+  VERSION = '1.9'
 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,16 +27,57 @@ 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_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 =
+        if cleaner.is_a?(Proc)
+          cleaner
+        else
+          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
+  class CustomLogSubscriber < ActiveRecord::LogSubscriber # rubocop:disable Metrics/ClassLength
     def initialize
       super
       ActiveRecordQueryTrace.enabled = false
@@ -50,51 +92,50 @@ module ActiveRecordQueryTrace
     def sql(event)
       payload = event.payload
       return unless display_backtrace?(payload)
-
-      setup_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
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
+    def cached_query?(payload)
+      return false unless ActiveRecordQueryTrace.ignore_cached_queries
+      payload[:cached] || payload[:name] == 'CACHE'
+    end
+
     # TODO: refactor and remove rubocop:disable comments.
     def display_backtrace?(payload)
       ActiveRecordQueryTrace.enabled \
         && !transaction_begin_or_commit_query?(payload) \
         && !schema_query?(payload) \
-        && !(ActiveRecordQueryTrace.ignore_cached_queries && payload[:cached]) \
+        && !cached_query?(payload) \
         && !(ActiveRecordQueryTrace.suppress_logging_of_db_reads && db_read_query?(payload)) \
         && display_backtrace_for_query_type?(payload)
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
 
     def display_backtrace_for_query_type?(payload)
-      invalid_type_msg = 'Invalid ActiveRecordQueryTrace.query_type value ' \
-        "#{ActiveRecordQueryTrace.level}. Should be :all, :read, or :write."
-
       case ActiveRecordQueryTrace.query_type
       when :all then true
       when :read then db_read_query?(payload)
       when :write then !db_read_query?(payload)
-      else raise(invalid_type_msg)
+      else
+        raise 'Invalid ActiveRecordQueryTrace.query_type value ' \
+              "#{ActiveRecordQueryTrace.level}. Should be :all, :read, or :write."
       end
     end
 
     def db_read_query?(payload)
-      !payload[:sql].match(/(INSERT|UPDATE|DELETE)/)
+      payload[:sql] !~ /INSERT|UPDATE|DELETE/
     end
 
     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
 
@@ -104,47 +145,36 @@ module ActiveRecordQueryTrace
     end
 
     def transaction_begin_or_commit_query?(payload)
-      payload[:sql].match(/\A(begin transaction|commit transaction|BEGIN|COMMIT)\Z/)
+      payload[:sql] =~ /\Abegin transaction|commit transaction|BEGIN|COMMIT\Z/
     end
 
     def schema_query?(payload)
       payload[:name] == 'SCHEMA'
     end
 
+    # rubocop:disable Metrics/MethodLength
     def clean_trace(full_trace)
-      invalid_level_msg = 'Invalid ActiveRecordQueryTrace.level value ' \
+      case ActiveRecordQueryTrace.level
+      when :full
+        trace = full_trace
+      when :app, :rails
+        trace = default_cleaner.clean(full_trace)
+      when :custom
+        unless ActiveRecordQueryTrace.backtrace_cleaner
+          raise 'Configure your backtrace cleaner first via ActiveRecordQueryTrace.backtrace_cleaner = MyCleaner'
+        end
+        trace = ActiveRecordQueryTrace.backtrace_cleaner.call(full_trace)
+      else
+        raise 'Invalid ActiveRecordQueryTrace.level value ' \
               "#{ActiveRecordQueryTrace.level}. Should be :full, :rails, or :app."
-      raise(invalid_level_msg) unless %i[full app rails].include?(ActiveRecordQueryTrace.level)
+      end
 
-      trace = ActiveRecordQueryTrace.level == :full ? full_trace : Rails.backtrace_cleaner.clean(full_trace)
       # We cant use a Rails::BacktraceCleaner filter to display only the relative
       # path of application trace lines because it breaks the silencer that selects
       # the lines to display or hide based on whether they include `Rails.root`.
-      trace.map { |line| line.gsub("#{Rails.root}/", '') }
-    end
-
-    # 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 unless ActiveRecordQueryTrace.level == :rails
-      Rails.backtrace_cleaner.remove_filters!
-      Rails.backtrace_cleaner.remove_silencers!
-      Rails.backtrace_cleaner.add_silencer do |line|
-        line.match(%r{#{Regexp.escape(Rails.root.to_s)}(?!/vendor)})
-      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
+      trace.map { |line| line.sub(rails_root_prefix, '') }
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Allow query to be colorized in the terminal
     def colorize_text(text)
@@ -158,22 +188,31 @@ module ActiveRecordQueryTrace
     end
 
     def color_code
+      return @color_code if @color_code && @configured_color == ActiveRecordQueryTrace.colorize
+
+      @configured_color = ActiveRecordQueryTrace.colorize
+
       # Backward compatibility for string color names with space as word separator.
-      color_code =
+      @color_code =
         case ActiveRecordQueryTrace.colorize
-        when Symbol then COLORS[ActiveRecordQueryTrace.colorize]
+        when Symbol, true then COLORS[ActiveRecordQueryTrace.colorize]
         when String then COLORS[ActiveRecordQueryTrace.colorize.tr("\s", '_').to_sym]
         end
+    end
 
-      error_msg = 'ActiveRecordQueryTrace.colorize was set to an invalid ' \
-           "color. Use one of #{COLORS.keys} or a valid color code."
-
-      raise error_msg unless valid_color_code?(color_code)
-      color_code
+    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."
+      )
     end
 
     def valid_color_code?(color_code)
-      /\A\d+(;\d+)?\Z/.match(color_code)
+      /\A\d+(?:;\d+)?\Z/ =~ color_code
+    end
+
+    def rails_root_prefix
+      @rails_root_prefix ||= "#{Rails.root}/"
     end
   end
 end
@@ -198,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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_trace
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: '1.9'
 platform: ruby
 authors:
 - Cody Caughlan
 - Bruno Facca
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2026-01-20 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.12.2
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0'
 - !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,8 +149,9 @@ files:
 homepage: https://github.com/brunofacca/active-record-query-trace
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/brunofacca/active-record-query-trace
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,16 +159,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Print stack trace of all DB queries to the Rails log. Helpful to find where
   queries are being executed in your application.