spring_onion 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc3f0d5560a94e94ae9e4c0e4801b9a9a02e4fd9b5bb74b6b59d9569a6d8613
-  data.tar.gz: 1d12d7b4b1e984eb1b9c0383b0a82a49f79ee5d47e5ccb12b342a0182dda572d
+  metadata.gz: 797e6837cbc8fb508afac284d54509ce175ac77346320bcc0697c0cd54b49a06
+  data.tar.gz: 487f8a88353cce686f0b259cd83f2401cb3d599a4d05e403250018b2e3ae4fdc
 SHA512:
-  metadata.gz: 0eff35cb7949993b9161dae0d4d89b3714d513e8b6a80272c214e8a19d4b56381382fc52640773c324d896e0f7f2d9ea50ff992306cf6272506334d3f0ab5dbe
-  data.tar.gz: 1fcd2d6d57328bc7272cdff88626fd9396837faad035b6c5f1377687a97d502ea357798889b6011d6dcb68e59ad03b112ee08bb27ea7a3aceb2ce313fd074872
+  metadata.gz: bc53955a16cd100e68ef306b798966f62937963ce8a3a67b819779379892fa50125b61c30e127cd1d1c3c0bd23cf58b9961a13a196430b15f55705b553ec9f0e
+  data.tar.gz: d0c482e0864d25b05d3dc002de0b36d6b6b2d5414d8af7402bf86390f7a1182dc2d0cd745afb6cd8dcfe5d4c889141c351f4d3f6414acd957c4d2bd43322af41

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    spring_onion (0.1.0)
+    spring_onion (0.2.0)
       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

@@ -33,14 +33,14 @@ ActiveRecord::Base.establish_connection(
   database: 'employees',
 )
 
-SpringOnion.enabled = true
+SpringOnion.enabled = true # or `SPRING_ONION_ENABLED=1`
 SpringOnion.connection = ActiveRecord::Base.connection.raw_connection
 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'"]}
+#=> 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,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'coderay'
 require 'active_support'
 
 require 'spring_onion/config'

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'] },
@@ -25,17 +25,17 @@ module SpringOnion
     slow_extra: ->(exp) { SLOW_EXTRA_RE =~ exp['Extra'] },
   }
 
-  @enabled = ENV.fetch('SPRING_ONION_ENABLED', '') =~ /\A(1|true)\z/i
+  @enabled = (/\A(1|true)\z/i =~ ENV['SPRING_ONION_ENABLED'])
 
-  @sql_filter_re = if ENV.fetch('SPRING_ONION_SQL_FILTER_RE', '').empty?
-                     //
-                   else
-                     Regexp.new(ENV['SPRING_ONION_SQL_FILTER_RE'])
-                   end
+  @sql_filter_re = ENV['SPRING_ONION_SQL_FILTER_RE'].yield_self do |re|
+    re ? Regexp.new(re) : //
+  end
 
   @ignore_sql_filter_re = Regexp.union(
-    /\binformation_schema\b/,
-    *(ENV.fetch('SPRING_ONION_IGNORE_SQL_FILTER_RE', '').empty? ? nil : Regexp.new(ENV['SPRING_ONION_IGNORE_SQL_FILTER_RE']))
+    [/\binformation_schema\b/].tap do |ary|
+      re = ENV['SPRING_ONION_IGNORE_SQL_FILTER_RE']
+      ary << Regexp.new(re) if re
+    end
   )
 
   @sql_filter = lambda do |sql|
@@ -43,17 +43,23 @@ module SpringOnion
   end
 
   @source_filter_re = Regexp.union(
-    %r{/app/},
-    *(ENV.fetch('SPRING_ONION_SOURCE_FILTER_RE', '').empty? ? nil : Regexp.new(ENV['SPRING_ONION_SOURCE_FILTER_RE']))
+    [%r{/app/}].tap do |ary|
+      re = ENV['SPRING_ONION_SOURCE_FILTER_RE']
+      ary << Regexp.new(re) if re
+    end
   )
 
   @ignore_source_filter_re = Regexp.union(
-    Regexp.union(RbConfig::TOPDIR, *Gem.path),
-    *(ENV.fetch('SPRING_ONION_IGNORE_SOURCE_FILTER_RE', '').empty? ? nil : Regexp.new(ENV['SPRING_ONION_IGNORE_SOURCE_FILTER_RE']))
+    [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|
@@ -63,14 +69,18 @@ module SpringOnion
   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

@@ -30,25 +30,34 @@ module SpringOnion
     end
 
     def _validate(exp, sql, trace)
-      violations = SpringOnion.violations
-      violation_names_by_line = {}
+      warnings = SpringOnion.warnings
+      warning_names_by_line = {}
 
       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_line["line #{i + 1}"] = warning_names unless warning_names.empty?
       end
 
-      return if violation_names_by_line.empty?
+      return if warning_names_by_line.empty?
 
-      SpringOnion.logger.info({
+      h = {
         sql: sql,
         explain: exp.each_with_index.map { |r, i| { line: i + 1 }.merge(r) },
-        violations: violation_names_by_line,
+        warnings: warning_names_by_line,
         backtrace: trace.slice(0, SpringOnion.trace_len),
-      }.to_json)
+      }
+
+      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.0'
+  VERSION = '0.2.0'
 end

data/spring_onion.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Log MySQL queries with EXPLAIN that may be slow.'
   spec.homepage      = 'https://github.com/winebarrel/spring_onion'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -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.0
+  version: 0.2.0
 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
@@ -142,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="