lograge-sql 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c781f369bfdc3b5ee7fa14fe03146c929e67a90b3558933e88d520d1908324e
-  data.tar.gz: c498398d6d5089d9f8362e1f0ab0fec680cfdd80e397195ce75ce6a6860ab951
+  metadata.gz: edb09eb5b84cec3d09b2c25e4a33c6e8dd22d7d836f6532e5b4554e1ae31dfab
+  data.tar.gz: 646b5d6635260962c7685532e2d574c74df016914a800491688e1be063fa0bba
 SHA512:
-  metadata.gz: 265b36d72f2b0a9f6fcdd0f4af6cd07e04088df14be819e3499351230ff314cec3efa07443a2d24d7b0136df9389fb16c0041fae73b1930b01eaa4466c6c8254
-  data.tar.gz: 623aeb11fcb1b9633b72b54e5d001d84ac558f2fea2fee1fdb7eb43e662e0b756ab2dfdfc99abb55749a657844b51caec94ea8609e2a4122d7cd503289a50d9a
+  metadata.gz: 0e99f15caca6f929045901ab7abf57431953e6d157d2423fa52ff781aa5abeb2f21224bce0304b6b127d8d5a50f2d368ad82780673a7b0db5223cbb56f3de1f6
+  data.tar.gz: 8425ab339321fbcf3fad76c607ef2097d05a05527837e21daf6e307e67157bdef5eb573e42892d2cbbf53b83cf66729552b473540e29342a6fe6c1d4d95e857b

data/.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/**/*'

data/.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
 

data/Gemfile

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

data/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

data/bin/console

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

data/gemfiles/lograge10.gemfile

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

data/gemfiles/lograge11.gemfile

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

data/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 @@ module Lograge
 
       # 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
 

data/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,17 +25,25 @@ module Lograge
 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
   end
 end
 
-Lograge::RequestLogSubscriber.prepend Lograge::Sql::Extension
+if defined?(Lograge::RequestLogSubscriber)
+  Lograge::RequestLogSubscriber.prepend Lograge::Sql::Extension
+else
+  Lograge::LogSubscribers::ActionController.prepend Lograge::Sql::Extension
+end
 
 ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
   Lograge.unsubscribe(:active_record, subscriber) if subscriber.is_a?(ActiveRecord::LogSubscriber)

data/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 @@ module Lograge
       end
     end
   end
-end
+end

data/lib/lograge/sql/version.rb

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

data/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         = ['giuffrida.mattia@gmail.com']
 
-  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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lograge-sql
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: lograge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An extension for Lograge to log SQL queries
 email:
 - giuffrida.mattia@gmail.com
@@ -95,12 +123,15 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/lograge10.gemfile
+- gemfiles/lograge11.gemfile
 - lib/lograge/sql.rb
 - lib/lograge/sql/extension.rb
 - lib/lograge/sql/railtie.rb
@@ -125,8 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An extension for Lograge to log SQL queries