Fixes tests (iMacTia#9)

.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*.rb
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'

.travis.yml

@@ -1,7 +1,16 @@
 language: ruby
+cache: bundler
 rvm:
+  - 2.3
+  - 2.4
   - 2.5
-before_install: gem install bundler -v 1.16.2
+  - 2.6
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '~> 1.17'
+gemfile:
+  - gemfiles/lograge10.gemfile
+  - gemfiles/lograge11.gemfile
 deploy:
   provider: rubygems
   api_key:
@@ -10,5 +19,5 @@ deploy:
   on:
     tags: true
     repo: iMacTia/lograge-sql
-    rvm: 2.5
+    rvm: 2.6
 

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lograge-sql.gemspec

Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'lograge/sql'

gemfiles/lograge10.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'lograge', '~> 0.10.0'
+
+gemspec path: '../'

gemfiles/lograge11.gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'lograge', '~> 0.11.0'
+
+gemspec path: '../'

lib/lograge/sql.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'lograge/sql/version'
 
 module Lograge
+  # Main gem module
   module Sql
-
     class << self
-
       # Format SQL log
       attr_accessor :formatter
       # Extract information from SQL event
@@ -20,21 +21,19 @@ def setup(config)
 
       # By default, the output is a concatenated string of all extracted events
       def default_formatter
-        Proc.new do |sql_queries|
+        proc do |sql_queries|
           %('#{sql_queries.join("\n")}')
         end
       end
 
-      # By default, only extract values required for the default_formatter and 
+      # By default, only extract values required for the default_formatter and
       # already convert to a string
       def default_extract_event
-        Proc.new do |event|
+        proc do |event|
           "#{event.payload[:name]} (#{event.duration.to_f.round(2)}) #{event.payload[:sql]}"
         end
       end
-
     end
-
   end
 end
 

lib/lograge/sql/extension.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 module Lograge
   module Sql
+    # Module used to extend Lograge
     module Extension
+      # Overrides `Lograge::RequestLogSubscriber#extract_request` do add SQL queries
       def extract_request(event, payload)
         super.merge!(extract_sql_queries)
       end
 
+      # Collects all SQL queries stored in the Thread during request processing
       def extract_sql_queries
         sql_queries = Thread.current[:lograge_sql_queries]
         return {} unless sql_queries
@@ -20,10 +25,14 @@ def extract_sql_queries
 end
 
 module Lograge
+  # Log subscriber to replace ActiveRecord's default one
   class ActiveRecordLogSubscriber < ActiveSupport::LogSubscriber
+    # Every time there's an SQL query, stores it into the Thread.
+    # They'll later be access from the RequestLogSubscriber.
     def sql(event)
       ActiveRecord::LogSubscriber.runtime += event.duration
       return if event.payload[:name] == 'SCHEMA'
+
       Thread.current[:lograge_sql_queries] ||= []
       Thread.current[:lograge_sql_queries] << Lograge::Sql.extract_event.call(event)
     end

lib/lograge/sql/railtie.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'active_support/ordered_options'
 
 module Lograge
   module Sql
+    # Railtie to automatically setup in Rails
     class Railtie < Rails::Railtie
       # To ensure that configuration is not nil when initialise Lograge::Sql.setup
       config.lograge_sql = ActiveSupport::OrderedOptions.new
@@ -12,4 +15,4 @@ class Railtie < Rails::Railtie
       end
     end
   end
-end
+end

lib/lograge/sql/version.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Lograge
   module Sql
+    # Gem version
     VERSION = '0.3.0'
   end
 end

lograge-sql.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lograge/sql/version'
 
@@ -9,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Mattia Giuffrida']
   spec.email         = ['[email protected]']
 
-  spec.summary       = %q{An extension for Lograge to log SQL queries}
-  spec.description   = %q{An extension for Lograge to log SQL queries}
+  spec.summary       = 'An extension for Lograge to log SQL queries'
+  spec.description   = 'An extension for Lograge to log SQL queries'
   spec.homepage      = 'https://github.com/iMacTia/lograge-sql'
   spec.license       = 'MIT'
 
@@ -19,10 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'lograge', '~> 0.4'
   spec.add_runtime_dependency 'activerecord', '>= 4', '< 6.0'
+  spec.add_runtime_dependency 'lograge', '~> 0.4'
 
   spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
 end

spec/lograge/sql_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Lograge::Sql do

spec/spec_helper.rb

@@ -1,2 +1,4 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'lograge/sql'