lograge-sql 0.3.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c781f369bfdc3b5ee7fa14fe03146c929e67a90b3558933e88d520d1908324e
-  data.tar.gz: c498398d6d5089d9f8362e1f0ab0fec680cfdd80e397195ce75ce6a6860ab951
+  metadata.gz: 2a1b24c2960cc4eecd3b3ca23807587a396e8b483c76e916b8f2a50b600babe2
+  data.tar.gz: 5e33f26703504065a0838c5bb97f9bb45705a7ffce6317d2d239f46967b9fe79
 SHA512:
-  metadata.gz: 265b36d72f2b0a9f6fcdd0f4af6cd07e04088df14be819e3499351230ff314cec3efa07443a2d24d7b0136df9389fb16c0041fae73b1930b01eaa4466c6c8254
-  data.tar.gz: 623aeb11fcb1b9633b72b54e5d001d84ac558f2fea2fee1fdb7eb43e662e0b756ab2dfdfc99abb55749a657844b51caec94ea8609e2a4122d7cd503289a50d9a
+  metadata.gz: ee641c7c4988772cf1db3fb37639072e53c4cbe2a6a0b2823637e54f39a5ecba62ab1a52017f0a9418c61091af7419116ff36273f8363813090a45f65bea3a13
+  data.tar.gz: 176fd786ad019f0cf125bbe9a77acbce82722d43f6df0421eeeb0d9b719116e2d0aa68f8a8589e5ddcbc76d32bba183c7bb6d0342ffda993d4719d8d703af7d5

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/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/lib/lograge/sql.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'lograge/sql/version'
 
+# Main Lograge module
 module Lograge
+  # Main gem module
   module Sql
-    
     class << self
-
       # Format SQL log
       attr_accessor :formatter
       # Extract information from SQL event
@@ -14,27 +16,40 @@ module Lograge
       def setup(config)
         Lograge::Sql.formatter     = config.formatter     || default_formatter
         Lograge::Sql.extract_event = config.extract_event || default_extract_event
+
+        return if config.keep_default_active_record_log
+
+        # Disable existing ActiveRecord logging
+        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
+      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
 
       # 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,15 +1,20 @@
+# 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]
+        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
@@ -20,20 +25,22 @@ 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)
+
+      Lograge::Sql.store[:lograge_sql_queries] ||= []
+      Lograge::Sql.store[:lograge_sql_queries] << Lograge::Sql.extract_event.call(event)
     end
   end
 end
 
-Lograge::RequestLogSubscriber.prepend Lograge::Sql::Extension
-
-ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-  Lograge.unsubscribe(:active_record, subscriber) if subscriber.is_a?(ActiveRecord::LogSubscriber)
+if defined?(Lograge::RequestLogSubscriber)
+  Lograge::RequestLogSubscriber.prepend Lograge::Sql::Extension
+else
+  Lograge::LogSubscribers::ActionController.prepend Lograge::Sql::Extension
 end
-
-Lograge::ActiveRecordLogSubscriber.attach_to :active_record

data/lib/lograge/sql/railtie.rb

@@ -1,15 +1,18 @@
+# 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
 
-      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
-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 = '1.3.0'
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lograge-sql
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2020-11-14 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
@@ -33,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
@@ -43,49 +29,35 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: lograge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
+        version: '0.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.4'
 - !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'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
 description: An extension for Lograge to log SQL queries
 email:
 - giuffrida.mattia@gmail.com
@@ -93,19 +65,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - 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
@@ -118,15 +83,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: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+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/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-before_install: gem install bundler -v 1.16.2
-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.5
-

data/Gemfile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-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/lograge-sql.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$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       = %q{An extension for Lograge to log SQL queries}
-  spec.description   = %q{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 'lograge', '~> 0.4'
-  spec.add_runtime_dependency 'activerecord', '>= 4', '< 6.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end