active_record_query_trace 1.6 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dafae1b675da678759ad1ba18101f418fb97193f178a57dcb98442e0760f2e1a
-  data.tar.gz: 9748c99d235fef46ef85f432c0419191e05baccd9c28be61f7e090c9cac356ad
+  metadata.gz: 06d7497a2165d922974efd1ffc10bf6b6725d1c4705f9b5d5464affca6db069e
+  data.tar.gz: 1d5bf04f35d74b69cddc657d9f91795c315ce4b50422cc79aa06843a0299d3e9
 SHA512:
-  metadata.gz: 6b40a57407d833bdd54c45a0db89592dbcd5ead14e4b17cc78d3e9f6c33614163f67a57c75969c2c59396fb544eb96e390943265fe7bd0fd9fc57494cce0d985
-  data.tar.gz: e6a1d216f71480d97d0d254c03de448838ece938af770cf80602ee1cae92f1c5988379d0826551f5dda1eed9a80f3a8b33455e97f63022179665cd61c21e9c6b
+  metadata.gz: '09cd3daa1e090acc6e8bafd776c28c3df40f190baccd3799e5b93629a416f890ce4b4514993842830159840fe8d688ef71ba45f54893c62cf053b045c8dd978f'
+  data.tar.gz: d53226b99e6eae63ea2b79abf5db75f4f04c546773dc61fda88962d9de2b4c465f84c3af6481b3778d0410e3c4ed07433b29ba29eba5d4481c04efe9d836118c

data/lib/active_record_query_trace/version.rb

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

data/lib/active_record_query_trace.rb

@@ -33,9 +33,19 @@ module ActiveRecordQueryTrace
     attr_accessor :colorize
     attr_accessor :query_type
     attr_accessor :suppress_logging_of_db_reads
+    attr_reader :backtrace_cleaner
+
+    def backtrace_cleaner=(cleaner)
+      @backtrace_cleaner =
+        if cleaner.is_a?(Proc)
+          cleaner
+        else
+          proc { |trace| cleaner.clean(trace) }
+        end
+    end
   end
 
-  class CustomLogSubscriber < ActiveRecord::LogSubscriber
+  class CustomLogSubscriber < ActiveRecord::LogSubscriber # rubocop:disable Metrics/ClassLength
     def initialize
       super
       ActiveRecordQueryTrace.enabled = false
@@ -51,7 +61,7 @@ module ActiveRecordQueryTrace
       payload = event.payload
       return unless display_backtrace?(payload)
 
-      setup_backtrace_cleaner
+      setup_backtrace_cleaner unless ActiveRecordQueryTrace.backtrace_cleaner
 
       trace = fully_formatted_trace # Memoize
       debug(trace) unless trace.blank?
@@ -61,34 +71,34 @@ module ActiveRecordQueryTrace
 
     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
@@ -104,24 +114,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 ' \
-              "#{ActiveRecordQueryTrace.level}. Should be :full, :rails, or :app."
-      raise(invalid_level_msg) unless %i[full app rails].include?(ActiveRecordQueryTrace.level)
+      case ActiveRecordQueryTrace.level
+      when :full
+        trace = full_trace
+      when :app, :rails
+        trace = Rails.backtrace_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."
+      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}/", '') }
+      trace.map { |line| line.sub(rails_root_prefix, '') }
     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
@@ -129,11 +151,15 @@ module ActiveRecordQueryTrace
     # 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)})
+      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
 
@@ -146,6 +172,11 @@ module ActiveRecordQueryTrace
       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
@@ -158,22 +189,37 @@ 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
+
+    # 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
@@ -198,7 +244,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}/
     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.6'
+  version: '1.8'
 platform: ruby
 authors:
 - Cody Caughlan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,110 +17,110 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.32.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
 description: Print stack trace of all DB queries to the Rails log. Helpful to find
@@ -144,15 +144,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      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.0.6
 signing_key: 
 specification_version: 4
 summary: Print stack trace of all DB queries to the Rails log. Helpful to find where