spring_onion 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 797e6837cbc8fb508afac284d54509ce175ac77346320bcc0697c0cd54b49a06
-  data.tar.gz: 487f8a88353cce686f0b259cd83f2401cb3d599a4d05e403250018b2e3ae4fdc
+  metadata.gz: b40885dd3b876b902fa6670cde6f312362239a5d65da300297f9240cee05afbc
+  data.tar.gz: 3193d9ab4417169c380bb9fe1bf788752b4f347d9c0bdb34b5237a9f5e2c674f
 SHA512:
-  metadata.gz: bc53955a16cd100e68ef306b798966f62937963ce8a3a67b819779379892fa50125b61c30e127cd1d1c3c0bd23cf58b9961a13a196430b15f55705b553ec9f0e
-  data.tar.gz: d0c482e0864d25b05d3dc002de0b36d6b6b2d5414d8af7402bf86390f7a1182dc2d0cd745afb6cd8dcfe5d4c889141c351f4d3f6414acd957c4d2bd43322af41
+  metadata.gz: e1f37308e5b4dbc00112b4cc7e12a1060fe4c39a8dbb379bb5d10bf3c689151d590095a39e4f732c236993f19efccd8b624bd5baf7f162c3422646f49a377728
+  data.tar.gz: 73aafec72dad64c8e54daa129dd65bbd419f7dc013b94da830228825211a2e3693627185c5e9f50f02b4217f24a244feec7a324a14267c32f0e063c7149febb2

data/Gemfile.lock

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

data/README.md

@@ -39,7 +39,7 @@ SpringOnion.source_filter_re = //
 
 class Employee < ActiveRecord::Base; end
 
-Employee.all.to_a.count
+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
 ```

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

@@ -42,12 +42,9 @@ 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, '/.rbenv/versions/'].tap do |ary|
@@ -63,9 +60,9 @@ module SpringOnion
   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

data/lib/spring_onion/explainer.rb

@@ -3,14 +3,16 @@
 module SpringOnion
   module Explainer
     def execute(*args)
-      _with_explain(args.first) do
+      _with_explain(sql: args.first) do
         super
       end
     end
 
-    def _with_explain(sql)
+    private
+
+    def _with_explain(sql:)
       begin
-        if SpringOnion.enabled && sql =~ /^SELECT\b/ && SpringOnion.sql_filter.call(sql)
+        if SpringOnion.enabled && sql =~ /\A\s*SELECT\b/i && SpringOnion.sql_filter.call(sql)
           trace = SpringOnion.source_filter.call(caller)
 
           unless trace.length.zero?
@@ -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(sql: sql, exp: exp, trace: trace)
           end
         end
       rescue StandardError => e
@@ -29,35 +31,26 @@ module SpringOnion
       yield
     end
 
-    def _validate(exp, sql, trace)
+    def _validate_explain(sql:, exp:, trace:)
       warnings = SpringOnion.warnings
-      warning_names_by_line = {}
+      warning_names_by_index = {}
 
       exp.each_with_index do |row, i|
         warning_names = warnings.select do |_name, validator|
           validator.call(row)
         end.keys
 
-        warning_names_by_line["line #{i + 1}"] = warning_names unless warning_names.empty?
+        warning_names_by_index[i] = warning_names unless warning_names.empty?
       end
 
-      return if warning_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) },
-        warnings: warning_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.2.0'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spring_onion
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - winebarrel
@@ -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