active_record_query_trace 1.6.2 → 1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b58e5acd23e046a98d5f4ab7bd558ecab9bb02b23aa0edf948942d9af0547c21
-  data.tar.gz: 94684eb961ff681969356cba534b78bee8ee4bca1eb925566e6daa56d8b98d7b
+  metadata.gz: 3b9863216a6d3587bfe68f4aeee1213e6f1e16475045e20231fac8870f996ccb
+  data.tar.gz: 43a7bd0611953022e35f1909deefb395d35c2c1b2349a49eb5270b0c74566d83
 SHA512:
-  metadata.gz: 47362f8e90ea73124e054bb313155101fb9c972bf1eec07e97678b4e43edf6307744ce4a9cb3d8c7fa959ee8b1963a7fda2725b589d8b438c0e8c292b155724d
-  data.tar.gz: 2d95048c71b93ef3ef7ddf3003e4463a61feec2c1f82dd28113f32bc65d5d4275ddc6ebe9053b5232e0a543d74d75647de4505d8834b1f58b2621d7702ab7c4d
+  metadata.gz: 9936bc3e438c24fc1d652c8710b8f9e82b485ab26f1189ec45667015bc96fa88d7256bd6259247df65b8f81b70eb6b8a0f719027edff01a6626b6fe7c9972d92
+  data.tar.gz: 90568c7a20aa1c64a2465efea7a9769119d5999c2a7bdf01ea785375e3ddc5445132607d0dfe0d0e693b6811e1c8782060270571cc5ef882094073d16ef30a8b

data/lib/active_record_query_trace.rb

@@ -33,6 +33,16 @@ 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 # rubocop:disable Metrics/ClassLength
@@ -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,36 @@ module ActiveRecordQueryTrace
 
     private
 
+    def cached_query?(payload)
+      return false unless ActiveRecordQueryTrace.ignore_cached_queries
+      payload[:cached] || payload[:name] == 'CACHE'
+    end
+
     # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
     # 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 +116,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
@@ -135,9 +159,9 @@ module ActiveRecordQueryTrace
 
       case ActiveRecordQueryTrace.level
       when :app
-        Rails.backtrace_cleaner.add_silencer { |line| !line.match(rails_root_regexp) }
+        Rails.backtrace_cleaner.add_silencer { |line| line !~ rails_root_regexp }
       when :rails
-        Rails.backtrace_cleaner.add_silencer { |line| line.match(rails_root_regexp) }
+        Rails.backtrace_cleaner.add_silencer { |line| line =~ rails_root_regexp }
       end
     end
 
@@ -167,28 +191,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
-      %r{#{Regexp.escape(Rails.root.to_s)}(?!\/vendor)}
+      @rails_root_regexp ||= %r{#{Regexp.escape(Rails.root.to_s)}(?!\/vendor)}
     end
   end
 end
@@ -213,7 +246,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

data/lib/active_record_query_trace/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_trace
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: '1.7'
 platform: ruby
 authors:
 - Cody Caughlan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -113,14 +113,14 @@ dependencies:
   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