spring_onion 0.2.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54ea2a17b7ab30f6e646ed61b125dcc22e82cf304c946d26c70222a6e5a78341
-  data.tar.gz: af308c44d05e7b58048e5c29bd8f708a14d7067111210338ec52296ae9e00f16
+  metadata.gz: adf8950ce1f2d7c9c7d7c0d41d3472a833d37a046b9aa31848257a879c261c38
+  data.tar.gz: 23f8d10722ac30ce2a7c0c01236001ecde43c31ec47c81ad2fe0225495282252
 SHA512:
-  metadata.gz: 1d5fcd164189c1a47126b009f0d058baffc306958cb2dcbd3bbf8e0f0bd4d54f49b9f862204b0d46bb4f68e44cd24257a2f62dced99f93b900d620f7871f2cc4
-  data.tar.gz: 0cae3be0dc5e774d092b3e2624bc943604dc8a0aac30dadf645a86f736f13f80978d0ec5a4a5bf595c7eff150f047f79a95769ab9d344bc15917d2ca4dd9b0c1
+  metadata.gz: 4508747cc4ba4b0f4b2bea885b14877e6f7128afad83d0731cbe87b4160159acf13f39e8872d41c9c49328df80e92026900cde9280f8979de03d979a1d7d168e
+  data.tar.gz: 1a6634398984d1c7d317ed9685f9df6beca9c1377d564f90c70904aa646c90ef7d9b80586b79ff65d73253b327d1b711fdd7b7639eee10087ba4c2aa35a9d969

data/.gitignore

@@ -12,3 +12,5 @@
 
 # Appraisal Gemfile.lock
 /gemfiles/*.lock
+
+/test.rb

data/.rspec

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

data/.rubocop.yml

@@ -1,9 +1,12 @@
 AllCops:
   Exclude:
     - "gemfiles/**/*"
+    - "test.rb"
   TargetRubyVersion: 2.5
 Style/Documentation:
   Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 Metrics/AbcSize:
@@ -12,6 +15,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.2)
+    spring_onion (1.0.1)
       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:
@@ -25,12 +28,11 @@ Or install it yourself as:
 #!/usr/bin/env ruby
 require 'active_record'
 require 'spring_onion'
-require 'logger'
 
 ActiveRecord::Base.establish_connection(
   adapter:  'mysql2',
   username: 'root',
-  database: 'employees',
+  database: 'employees'
 )
 
 SpringOnion.enabled = true # or `SPRING_ONION_ENABLED=1`
@@ -75,3 +77,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/config.rb

@@ -28,13 +28,13 @@ module SpringOnion
   @enabled = (/\A(1|true)\z/i =~ ENV['SPRING_ONION_ENABLED'])
 
   @sql_filter_re = ENV['SPRING_ONION_SQL_FILTER_RE'].yield_self do |re|
-    re ? Regexp.new(re) : //
+    re ? Regexp.new(re, Regexp::IGNORECASE) : //
   end
 
   @ignore_sql_filter_re = Regexp.union(
     [/\binformation_schema\b/].tap do |ary|
       re = ENV['SPRING_ONION_IGNORE_SQL_FILTER_RE']
-      ary << Regexp.new(re) if re
+      ary << Regexp.new(re, Regexp::IGNORECASE) if re
     end
   )
 

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_explain(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,7 +33,7 @@ module SpringOnion
       yield
     end
 
-    def _validate_explain(exp, sql, trace)
+    def _validate_explain(sql:, exp:, trace:)
       warnings = SpringOnion.warnings
       warning_names_by_index = {}
 

data/lib/spring_onion/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring_onion
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.1
 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,11 +133,16 @@ 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