spring_onion 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a365d84922c1478abeb1ece890c64670ccbc148262362247d76f6b0d14e4fbe
-  data.tar.gz: 9a121f4fd4e29c0f197abf019de3b83c32823f7dbfed4501a29d8a4d80da5463
+  metadata.gz: 54ea2a17b7ab30f6e646ed61b125dcc22e82cf304c946d26c70222a6e5a78341
+  data.tar.gz: af308c44d05e7b58048e5c29bd8f708a14d7067111210338ec52296ae9e00f16
 SHA512:
-  metadata.gz: 6ad8867bd4a3743844350ca26c6cf766283e5fb22ebe882b5fb807d016c18687339a26947408935bc582ea411307673da3c5fa3cb2ba9d28d7988e875fdabd2a
-  data.tar.gz: 5a67f25e5e346f2b5f396ad366bade23dd03d695f487893daa21d167b52b66a89eabde482038aac80c4b612de0b32ac2a601f785da5ba75925038afa091cb5b9
+  metadata.gz: 1d5fcd164189c1a47126b009f0d058baffc306958cb2dcbd3bbf8e0f0bd4d54f49b9f862204b0d46bb4f68e44cd24257a2f62dced99f93b900d620f7871f2cc4
+  data.tar.gz: 0cae3be0dc5e774d092b3e2624bc943604dc8a0aac30dadf645a86f736f13f80978d0ec5a4a5bf595c7eff150f047f79a95769ab9d344bc15917d2ca4dd9b0c1

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    spring_onion (0.1.2)
+    spring_onion (0.2.2)
       activerecord
+      coderay
       mysql2
 
 GEM
@@ -24,6 +25,7 @@ GEM
       rake
       thor (>= 0.14.0)
     ast (2.4.1)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
     diff-lcs (1.4.4)
     i18n (1.8.3)

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'coderay'
 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,39 +42,42 @@ 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
+  @json_pretty = (/\A(1|true)\z/i =~ ENV['SPRING_ONION_JSON_PRETTY'])
+  @color = /\A(1|true)\z/i =~ ENV.fetch('SPRING_ONION_COLOR', $stdout.tty?.to_s)
 
   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,
-                  :trace_len
+                  :trace_len,
+                  :json_pretty,
+                  :color
   end
 end

data/lib/spring_onion/explainer.rb

@@ -19,7 +19,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,26 +29,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?
 
-      SpringOnion.logger.info({
+      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),
-      }.to_json)
+        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.2'
+  VERSION = '0.2.2'
 end

data/spring_onion.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activerecord'
+  spec.add_dependency 'coderay'
   spec.add_dependency 'mysql2'
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring_onion
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 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
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -128,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