lograge-sql 0.4.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb09eb5b84cec3d09b2c25e4a33c6e8dd22d7d836f6532e5b4554e1ae31dfab
-  data.tar.gz: 646b5d6635260962c7685532e2d574c74df016914a800491688e1be063fa0bba
+  metadata.gz: c5983447366cf1c996e3f4a6571646b4d54298df7e8c54417c02537c23b5132f
+  data.tar.gz: 48b16b073f9681e809eb3d1bcf3bb0f661ca2ae80a2a2958ef1d9ce495a1147e
 SHA512:
-  metadata.gz: 0e99f15caca6f929045901ab7abf57431953e6d157d2423fa52ff781aa5abeb2f21224bce0304b6b127d8d5a50f2d368ad82780673a7b0db5223cbb56f3de1f6
-  data.tar.gz: 8425ab339321fbcf3fad76c607ef2097d05a05527837e21daf6e307e67157bdef5eb573e42892d2cbbf53b83cf66729552b473540e29342a6fe6c1d4d95e857b
+  metadata.gz: 1d53aade24130437f98e9bd7d06c448be1364cff17c6dc18c44da939723145a938246c15407fdb8644447d2be31824d34f52cafc0260dc3528b4674cf1a888b9
+  data.tar.gz: 9a8b3bbaa5abd569373b97ffbda2f1c8b2493be8c35695935587ae7726ac7af35adeb99caa01e2a03e753e26777d077c8f561fed1fa7d357568771094dcd4928

data/README.md

@@ -1,6 +1,7 @@
 # Lograge::Sql
 
-[![Gem Version](https://badge.fury.io/rb/lograge-sql.svg)](https://badge.fury.io/rb/lograge-sql) [<img src="https://travis-ci.org/iMacTia/lograge-sql.svg?branch=master" alt="version" />](https://travis-ci.org/iMacTia/lograge-sql)
+[![Gem Version](https://badge.fury.io/rb/lograge-sql.svg)](https://badge.fury.io/rb/lograge-sql)
+[![Build Status](https://travis-ci.org/iMacTia/lograge-sql.svg)](https://travis-ci.org/iMacTia/lograge-sql)
 
 Lograge::Sql is an extension to the famous [Lograge](https://github.com/roidrage/lograge) gem, which adds SQL queries to the Lograge Event and disable default ActiveRecord logging.
 This is extremely useful if you're using Lograge together with the ELK stack.
@@ -22,6 +23,12 @@ In order to enable SQL logging in your application, you'll simply need to add th
 require 'lograge/sql/extension'
 ```
 
+By default, Lograge::Sql disables default logging on ActiveRecord. To preserve default logging, add this to your lograge initializer:
+
+```ruby
+config.lograge_sql.keep_default_active_record_log = true
+```
+
 ## Customization
 
 By default, the format is a string concatenation of the query name, the query duration and the query itself joined by `\n` newline:
@@ -32,7 +39,7 @@ Object Load (0.42) SELECT "objects.*" FROM "objects"
 Associations Load (0.42) SELECT "associations.*" FROM "associations" WHERE "associations"."object_id" = "$1"
 ```
 
-However, having `Lograge::Formatters::Json.new`, the relevant output is 
+However, having `Lograge::Formatters::Json.new`, the relevant output is
 
 ```json
 {
@@ -59,6 +66,9 @@ Rails.application.configure do
 end
 ```
 
+#### Thread-safety
+
+[Depending on the web server in your project](https://github.com/steveklabnik/request_store#the-problem) you might benefit from improved thread-safety by adding [`request_store`](https://github.com/steveklabnik/request_store) to your Gemfile. It will be automatically picked up by `lograge-sql`.
 
 ## Contributing
 

data/lib/lograge/active_record_log_subscriber.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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'
+
+      Lograge::Sql.store[:lograge_sql_queries] ||= []
+      Lograge::Sql.store[:lograge_sql_queries] << Lograge::Sql.extract_event.call(event)
+    end
+  end
+end

data/lib/lograge/sql.rb

@@ -2,6 +2,7 @@
 
 require 'lograge/sql/version'
 
+# Main Lograge module
 module Lograge
   # Main gem module
   module Sql
@@ -15,6 +16,23 @@ module Lograge
       def setup(config)
         Lograge::Sql.formatter     = config.formatter     || default_formatter
         Lograge::Sql.extract_event = config.extract_event || default_extract_event
+
+        # Disable existing ActiveRecord logging
+        unless config.keep_default_active_record_log
+          ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+            Lograge.unsubscribe(:active_record, subscriber) if subscriber.is_a?(ActiveRecord::LogSubscriber)
+          end
+        end
+
+        return unless defined?(Lograge::ActiveRecordLogSubscriber)
+
+        Lograge::ActiveRecordLogSubscriber.attach_to(:active_record)
+      end
+
+      # Gets the store, preferring RequestStore if the gem is found.
+      # @return [Hash, Thread] the RequestStore or the current Thread.
+      def store
+        defined?(RequestStore) ? RequestStore.store : Thread.current
       end
 
       private

data/lib/lograge/sql/extension.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'lograge/active_record_log_subscriber'
+
 module Lograge
   module Sql
     # Module used to extend Lograge
@@ -11,10 +13,10 @@ module Lograge
 
       # Collects all SQL queries stored in the Thread during request processing
       def extract_sql_queries
-        sql_queries = Thread.current[:lograge_sql_queries]
+        sql_queries = Lograge::Sql.store[:lograge_sql_queries]
         return {} unless sql_queries
 
-        Thread.current[:lograge_sql_queries] = nil
+        Lograge::Sql.store[:lograge_sql_queries] = nil
         {
           sql_queries: Lograge::Sql.formatter.call(sql_queries),
           sql_queries_count: sql_queries.length
@@ -24,29 +26,8 @@ module Lograge
   end
 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
-
 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)
-end
-
-Lograge::ActiveRecordLogSubscriber.attach_to :active_record

data/lib/lograge/sql/railtie.rb

@@ -10,8 +10,8 @@ module Lograge
       # To ensure that configuration is not nil when initialise Lograge::Sql.setup
       config.lograge_sql = ActiveSupport::OrderedOptions.new
 
-      config.after_initialize do |app|
-        Lograge::Sql.setup(app.config.lograge_sql)
+      config.to_prepare do
+        Lograge::Sql.setup(Rails.application.config.lograge_sql)
       end
     end
   end

data/lib/lograge/sql/version.rb

@@ -3,6 +3,6 @@
 module Lograge
   module Sql
     # Gem version
-    VERSION = '0.4.0'
+    VERSION = '1.3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lograge-sql
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement
@@ -44,76 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 description: An extension for Lograge to log SQL queries
 email:
 - giuffrida.mattia@gmail.com
@@ -121,22 +65,13 @@ executables: []
 extensions: []
 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/active_record_log_subscriber.rb
 - lib/lograge/sql.rb
 - lib/lograge/sql/extension.rb
 - lib/lograge/sql/railtie.rb
 - lib/lograge/sql/version.rb
-- lograge-sql.gemspec
 homepage: https://github.com/iMacTia/lograge-sql
 licenses:
 - MIT
@@ -149,14 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: An extension for Lograge to log SQL queries

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.idea
-*.gem

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,20 +0,0 @@
-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,23 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 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:
-    secure: xlc4BM+5ljo4cO2FC71KbhbVGVYd3NMxhZPat/Y37vo6b5/I01D+Z+K84azMvhIZa+O17cA56FGqT6P0XYfcjZVnYzixpyRlbffKBGNPcIFj2UklWk2BDOojezHPEQnbR2f0jE2+8jHtAb9qyoBTbTlvsW3+svd76+53TxMW1PgGF9+1xdtlEumF1q+IYRL+5TzDLk9GyQ+3RmVd9KBVvQIxxUpn4COJohmQWnv98ZzluX4I/QUt3k4o+etUINPewyg3S+VNP0u+K9HGkY3TL8OpUbCS3Syr3OydwzgpXIBlW+kWVez5/qZn3pd6oSpNEUF9Mh3NhaVsDacFSh6XgGNgww+isazyAROsledK2GsEOH0Hi6gpia/Ny5cD5TFAiGshMcUIb2K4roI3AW9kJ2e59hoC+QvPy64IybO/dhaKcxwX8F4qq3Fk/8EzQV5eOTq0Iai5aYNJaGZUqHV/X4DiMwDk/JoyQVYE+2CMF/PlZIFV4LuegDArVXYh5w3Qo9vYDfNp7Hfv0w5XgpEqAhk+Dabl+BlVhzSM/Cf28i6OVAhLURnGMNKhQEi3/4EusaM/cOQlM5QKWweAPfOwDKMFUoj9+Rtr0FfSyNzerG9dlGuzEKOlqq+XuOQ7RfDUV4+bn2PwbYo5XwMKz1Y8FWUZTz6l14miaw8Yq7U0GU8=
-  gem: lograge-sql
-  on:
-    tags: true
-    repo: iMacTia/lograge-sql
-    rvm: 2.6
-

data/Gemfile

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

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'lograge/sql'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/gemfiles/lograge10.gemfile

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

data/gemfiles/lograge11.gemfile

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

data/lograge-sql.gemspec

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lograge/sql/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'lograge-sql'
-  spec.version       = Lograge::Sql::VERSION
-  spec.authors       = ['Mattia Giuffrida']
-  spec.email         = ['giuffrida.mattia@gmail.com']
-
-  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'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  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