spring_onion 0.1.3 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce732c781280bd7df0bce88ccc8654d20efcf0d526fadeaa5ebcd263de43102d
-  data.tar.gz: 4d7b643b28a2afd962df5882bdef1d38ba4c12d00dc90ab8ce960d3b3f1f3e37
+  metadata.gz: 72b6f835a238acda75a1f45b10f30e79af2ea57f1c65cce762579efb2696aaa3
+  data.tar.gz: 8980630d0a4c270a5aaed49a1b1b47ec44b6ebf94f9bce8b3ee734427329a4ba
 SHA512:
-  metadata.gz: ea8d9b77ed18bd515b75bde75237cc3ab0384c7f9ea64ea3258cb73d66f22589e9320df6e557ac11a8496f8ec2d86a3fef15153c3a9b5eff789a08544be5b6e8
-  data.tar.gz: 75b6de58da35b12b310d30353203f679e930f79faca793c9ee7ec2007dd2d0db057a1cb2f80bbdb66f16a2621048bf15b5167a3a8693cfc2197abea1359c6f6c
+  metadata.gz: 0d8c45b21bd448d30149367efbc6e43cdefd58790f403b216c40ff02eae1642fb4b0bf69838591061f12c8db1618e4f2aeeeb08d8c6359db8a0973930a95e94d
+  data.tar.gz: 2847712ab07bcd40b4115e4efc0190dec21a1a75b500de3b0293f72ba0e121c48c24fe8d6c2f8227be2453d0430af61f8ecd253fa8135b8eec82da2304328616

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spring_onion (0.1.3)
+    spring_onion (0.2.3)
       activerecord
       coderay
       mysql2

data/README.md

@@ -39,8 +39,8 @@ SpringOnion.source_filter_re = //
 
 class Employee < ActiveRecord::Base; end
 
-Employee.all.to_a.count
-#=> SpringOnion	INFO	2020-07-18 01:53:27 +0900	{"sql":"SELECT `employees`.* FROM `employees`","explain":[{"line":1,"select_type":"SIMPLE","table":"employees","partitions":null,"type":"ALL","possible_keys":null,"key":null,"key_len":null,"ref":null,"rows":298936,"filtered":100.0,"Extra":null}],"violations":{"line 1":["slow_type"]},"backtrace":["/foo/bar/zoo/baz.rb:18:in `\u003ctop (required)\u003e'"]}
+p Employee.all.to_a.count
+#=> SpringOnion	INFO	2020-07-18 01:53:27 +0900	{"sql":"SELECT `employees`.* FROM `employees`","explain":[{"line":1,"select_type":"SIMPLE","table":"employees","partitions":null,"type":"ALL","possible_keys":null,"key":null,"key_len":null,"ref":null,"rows":298936,"filtered":100.0,"Extra":null}],"warnings":{"line 1":["slow_type"]},"backtrace":["/foo/bar/zoo/baz.rb:18:in `\u003ctop (required)\u003e'"]}
 #=> 300024
 ```
 
@@ -65,7 +65,7 @@ Employee.all.to_a.count
             "Extra": null
         }
     ],
-    "violations": {
+    "warnings": {
         "line 1": [
             "slow_type"
         ]

data/lib/spring_onion.rb

@@ -7,6 +7,7 @@ require 'active_support'
 require 'spring_onion/config'
 require 'spring_onion/error'
 require 'spring_onion/explainer'
+require 'spring_onion/json_logger'
 require 'spring_onion/version'
 
 ActiveSupport.on_load :active_record do

data/lib/spring_onion/config.rb

@@ -17,7 +17,7 @@ module SpringOnion
     'Using temporary'
   )
 
-  @violations = {
+  @warnings = {
     slow_select_type: ->(exp) { SLOW_SELECT_TYPE_RE =~ exp['select_type'] },
     slow_type: ->(exp) { SLOW_TYPE_RE =~ exp['type'] },
     slow_possible_keys: ->(exp) { SLOW_POSSIBLE_KEYS_RE =~ exp['possible_keys'] },
@@ -42,28 +42,27 @@ module SpringOnion
     @ignore_sql_filter_re !~ sql && @sql_filter_re =~ sql
   end
 
-  @source_filter_re = Regexp.union(
-    [%r{/app/}].tap do |ary|
-      re = ENV['SPRING_ONION_SOURCE_FILTER_RE']
-      ary << Regexp.new(re) if re
-    end
-  )
+  @source_filter_re = ENV['SPRING_ONION_SOURCE_FILTER_RE'].yield_self do |re|
+    re ? Regexp.new(re) : %r{/app/}
+  end
 
   @ignore_source_filter_re = Regexp.union(
-    [RbConfig::TOPDIR, *Gem.path].tap do |ary|
+    [RbConfig::TOPDIR, *Gem.path, '/.rbenv/versions/'].tap do |ary|
       re = ENV['SPRING_ONION_IGNORE_SOURCE_FILTER_RE']
       ary << Regexp.new(re) if re
     end
   )
 
   @source_filter = lambda do |backtrace_lines|
-    backtrace_lines.grep_v(@ignore_source_filter_re).grep(@source_filter_re)
+    backtrace_lines = backtrace_lines.grep_v(@ignore_source_filter_re)
+    idx = backtrace_lines.index { |l| @source_filter_re =~ l }
+    idx ? backtrace_lines.slice(idx..-1) : []
   end
 
   @logger = Logger.new($stdout).tap do |logger|
-    logger.formatter = lambda { |severity, datetime, _progname, msg|
+    logger.formatter = lambda do |severity, datetime, _progname, msg|
       "\n#{self}\t#{severity}\t#{datetime}\t#{msg}\n"
-    }
+    end
   end
 
   @trace_len = 3
@@ -73,7 +72,7 @@ module SpringOnion
   class << self
     attr_accessor :enabled,
                   :connection,
-                  :violations,
+                  :warnings,
                   :sql_filter_re, :ignore_sql_filter_re, :sql_filter,
                   :source_filter_re, :ignore_source_filter_re, :source_filter,
                   :logger,

data/lib/spring_onion/explainer.rb

@@ -8,6 +8,8 @@ module SpringOnion
       end
     end
 
+    private
+
     def _with_explain(sql)
       begin
         if SpringOnion.enabled && sql =~ /^SELECT\b/ && SpringOnion.sql_filter.call(sql)
@@ -19,7 +21,7 @@ module SpringOnion
 
             exp = conn.query("EXPLAIN #{sql}", as: :hash).to_a
             exp.each { |r| r.delete('id') }
-            _validate(exp, sql, trace)
+            _validate_explain(exp, sql, trace)
           end
         end
       rescue StandardError => e
@@ -29,35 +31,26 @@ module SpringOnion
       yield
     end
 
-    def _validate(exp, sql, trace)
-      violations = SpringOnion.violations
-      violation_names_by_line = {}
+    def _validate_explain(exp, sql, trace)
+      warnings = SpringOnion.warnings
+      warning_names_by_index = {}
 
       exp.each_with_index do |row, i|
-        violation_names = violations.select do |_name, validator|
+        warning_names = warnings.select do |_name, validator|
           validator.call(row)
         end.keys
 
-        violation_names_by_line["line #{i + 1}"] = violation_names unless violation_names.empty?
+        warning_names_by_index[i] = warning_names unless warning_names.empty?
       end
 
-      return if violation_names_by_line.empty?
+      return if warning_names_by_index.empty?
 
-      h = {
+      SpringOnion::JsonLogger.log(
         sql: sql,
-        explain: exp.each_with_index.map { |r, i| { line: i + 1 }.merge(r) },
-        violations: violation_names_by_line,
-        backtrace: trace.slice(0, SpringOnion.trace_len),
-      }
-
-      line = if SpringOnion.json_pretty
-               JSON.pretty_generate(h)
-             else
-               JSON.dump(h)
-             end
-
-      line = CodeRay.scan(line, :json).terminal if SpringOnion.color
-      SpringOnion.logger.info(line)
+        explain: exp,
+        warnings: warning_names_by_index,
+        trace: trace
+      )
     end
   end
 end

data/lib/spring_onion/json_logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SpringOnion
+  module JsonLogger
+    module_function
+
+    def log(sql:, explain:, warnings:, trace:)
+      h = {
+        sql: sql,
+        explain: explain.each_with_index.map { |r, i| { line: i + 1 }.merge(r) },
+        warnings: warnings.transform_keys { |i| "line #{i + 1}" },
+        backtrace: trace.slice(0, SpringOnion.trace_len),
+      }
+
+      line = if SpringOnion.json_pretty
+               JSON.pretty_generate(h)
+             else
+               JSON.dump(h)
+             end
+
+      line = CodeRay.scan(line, :json).terminal if SpringOnion.color
+      SpringOnion.logger.info(line)
+    end
+  end
+end

data/lib/spring_onion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpringOnion
-  VERSION = '0.1.3'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring_onion
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.3
 platform: ruby
 authors:
 - winebarrel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -142,6 +142,7 @@ files:
 - lib/spring_onion/config.rb
 - lib/spring_onion/error.rb
 - lib/spring_onion/explainer.rb
+- lib/spring_onion/json_logger.rb
 - lib/spring_onion/version.rb
 - spring_onion.gemspec
 homepage: https://github.com/winebarrel/spring_onion