spring_onion 0.2.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b6f835a238acda75a1f45b10f30e79af2ea57f1c65cce762579efb2696aaa3
-  data.tar.gz: 8980630d0a4c270a5aaed49a1b1b47ec44b6ebf94f9bce8b3ee734427329a4ba
+  metadata.gz: d6ebac8b79b898f06004cbaf58cb639d348d37a4936719b8e33854289708aa8a
+  data.tar.gz: 5bae8b0d8500ed2ce454194f21ac82833be665c37d338c962ab6152f01572b7d
 SHA512:
-  metadata.gz: 0d8c45b21bd448d30149367efbc6e43cdefd58790f403b216c40ff02eae1642fb4b0bf69838591061f12c8db1618e4f2aeeeb08d8c6359db8a0973930a95e94d
-  data.tar.gz: 2847712ab07bcd40b4115e4efc0190dec21a1a75b500de3b0293f72ba0e121c48c24fe8d6c2f8227be2453d0430af61f8ecd253fa8135b8eec82da2304328616
+  metadata.gz: 565ddc62b8def422ec437ce23310ffb86068b41eb17b4225a1a4697865cef384fa9ae991f86fb0abd3ee52d9db139ba0f1114dd12f5abce1aec30fb0ea4e20f3
+  data.tar.gz: 6a3258876b6fb9eb7963c4dd937ff909535917f642c956b1f46ac0954a916da202fc406cf4e023506c45bb4bf7821343285a8f5675bf716eb5a9ceb1e1740cee

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.3)
+    spring_onion (1.0.2)
       activerecord
       coderay
       mysql2
@@ -28,7 +28,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.6)
     diff-lcs (1.4.4)
-    i18n (1.8.3)
+    i18n (1.8.4)
       concurrent-ruby (~> 1.0)
     minitest (5.14.1)
     mysql2 (0.5.3)
@@ -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,16 +28,15 @@ 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`
-SpringOnion.connection = ActiveRecord::Base.connection.raw_connection
+SpringOnion.connection = ActiveRecord::Base.connection.raw_connection # or `SPRING_ONION_DATABASE_URL=mysql2://...`
 SpringOnion.source_filter_re = //
 
 class Employee < ActiveRecord::Base; end
@@ -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.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'logger'
-require 'coderay'
+
 require 'active_support'
+require 'coderay'
+require 'mysql2'
 
 require 'spring_onion/config'
 require 'spring_onion/error'
@@ -11,6 +13,12 @@ require 'spring_onion/json_logger'
 require 'spring_onion/version'
 
 ActiveSupport.on_load :active_record do
+  if ENV['SPRING_ONION_DATABASE_URL'] && !SpringOnion.connection
+    SpringOnion.connection = Mysql2::Client.new(
+      ActiveRecord::ConnectionAdapters::ConnectionSpecification::ConnectionUrlResolver.new(url).to_hash
+    )
+  end
+
   require 'active_record/connection_adapters/abstract_mysql_adapter'
   ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.prepend SpringOnion::Explainer
 end

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,16 +3,16 @@
 module SpringOnion
   module Explainer
     def execute(*args)
-      _with_explain(args.first) do
+      _with_explain(sql: args.first) do
         super
       end
     end
 
     private
 
-    def _with_explain(sql)
+    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?
@@ -21,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
@@ -31,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.3'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring_onion
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.2
 platform: ruby
 authors:
 - winebarrel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-07-20 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