spring_onion 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f81f2b07f2a586b8e02444106908d6d8eb8631d772db5bff80dd0fa6ee72b550
-  data.tar.gz: 0e23da7945c119c5c5dcf90f2ead4985647536d0c7f3cb091b47e8f2c94ae168
+  metadata.gz: d3d2f2a889573516f94fa1f5fb4a3276a26c31de830a9dabc56785e35c715c57
+  data.tar.gz: de4ca5c79ffdf0455552f54fb95d0316cf5eb075bb281c975e1db3bd0d6a3655
 SHA512:
-  metadata.gz: 115c03712806b8b97d9ff1e65f512db06e8ebc9f4e555b743d97c57b9159c58dc4f43410b7fb73db178a584425e22b403f6005ed3be6cb9a01c57b3295c686e3
-  data.tar.gz: 4aa1951677c97b2fa2b45e2eeb3d49b51543e1632537c316a9d73d775b73b95472ced9074e06adc32d4c523bef5f069b9c4826c1f4bdf0a1e638e61d458dc2e1
+  metadata.gz: 247a3d06f4f82854f0fa3a395a5f5ba224362772c3f3c40273029009db5f10babaf5a70de589d1ce08b2c242ec4d1072ab038d0dfb92196262c2527094f879ea
+  data.tar.gz: 6754099ea2ffb1d6ce713d665954dfb7ebce6f74a51141f85006ff06e4b0bc32083ea155e2c116d22a59552a97d69efa62655935f79337d5736e1883fb448c8d

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -4,6 +4,8 @@ AllCops:
   TargetRubyVersion: 2.5
 Style/Documentation:
   Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 Metrics/AbcSize:
@@ -12,6 +14,8 @@ Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false
 Layout/LineLength:
   Enabled: false
 

data/.travis.yml

@@ -2,5 +2,21 @@
 language: ruby
 cache: bundler
 rvm:
+  - 2.5.8
   - 2.6.6
-before_install: gem install bundler -v 2.1.2
+  - 2.7.1
+gemfile:
+  - gemfiles/ar52.gemfile
+  - gemfiles/ar60.gemfile
+services:
+  - mysql
+env:
+  - DATABASE_URL=mysql2://travis@localhost/sakila
+before_install:
+  - gem install bundler -v 2.1.2
+  - curl -sSfL https://downloads.mysql.com/docs/sakila-db.tar.gz -o - | tar zxf -
+  - cd sakila-db
+  - mysql < sakila-schema.sql
+  - mysql < sakila-data.sql
+script:
+  - bundle exec rake

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise 'ar52' do
+  gem 'activerecord', '~> 5.2.1'
+end
+
+appraise 'ar60' do
+  gem 'activerecord', '~> 5.2.1'
+end

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM rubylang/ruby:2.5-bionic
+
+RUN apt-get update && \
+  apt-get install -y \
+  mysql-client \
+  libmysqlclient-dev \
+  rubygems \
+  curl
+
+COPY ./ /mnt/
+WORKDIR /mnt
+RUN gem update bundler -f && \
+  bundle install && \
+  bundle exec appraisal install

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spring_onion (0.2.1)
+    spring_onion (1.0.0)
       activerecord
       coderay
       mysql2
@@ -83,4 +83,4 @@ DEPENDENCIES
   spring_onion!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -1,8 +1,11 @@
 # SpringOnion
 
 Log MySQL queries with EXPLAIN that may be slow.
+
 Inspired by [MySQLCasualLog.pm](https://gist.github.com/kamipo/839e8a5b6d12bddba539).
 
+[![Build Status](https://travis-ci.org/winebarrel/spring_onion.svg?branch=master)](https://travis-ci.org/winebarrel/spring_onion)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -75,3 +78,10 @@ p Employee.all.to_a.count
     ]
 }
 ```
+
+## Test
+
+```sh
+docker-compose build
+docker-compose run client bundle exec appraisal ar60 rake
+```

data/Rakefile

@@ -2,7 +2,12 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+RuboCop::RakeTask.new do |task|
+  task.options = %w[-c .rubocop.yml]
+end
+
+task default: %i[rubocop spec]

data/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3.8"
+services:
+  client:
+    build: .
+    environment:
+      MYSQL_PING_ATTEMPTS: "10"
+      DATABASE_URL: mysql2://root@db/sakila
+    volumes:
+      - ./:/mnt
+    depends_on:
+      - db
+  db:
+    image: budougumi0617/mysql-sakila:5.7
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: "1"

data/gemfiles/ar52.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "activerecord", "~> 5.2.1"
+
+gemspec path: "../"

data/gemfiles/ar60.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "activerecord", "~> 5.2.1"
+
+gemspec path: "../"

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

@@ -60,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,9 +21,11 @@ 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 SpringOnion::Error
+        raise
       rescue StandardError => e
         SpringOnion.logger.error(e)
       end
@@ -29,35 +33,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.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring_onion
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - winebarrel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -133,15 +133,21 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- docker-compose.yml
+- gemfiles/ar52.gemfile
+- gemfiles/ar60.gemfile
 - lib/spring_onion.rb
 - 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