lograge-sql 0.2.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f057e0f18be0a66527bf7bed2c8c217ca95e731304bbaae193efd24e0a764db3
-  data.tar.gz: e84b14ff93214088f99de92228be072a727e834727b362aa4c772afd93ab5fb8
+  metadata.gz: 3726273a2b54f66be4bbdab30b8b2166d9d45f00d2e27b7e0f217aab51befe14
+  data.tar.gz: b35279e56a149def5f8ac6db9d564bc27e264971b15bfe064d63e87a8398ce26
 SHA512:
-  metadata.gz: 7388da0b428389ab33f38476fd717452b5a144ece741531397c43a6c43a97a0eb00235020c89441d34a6977dc6507d6c29678e45d5ecbb30f345f6d80c0cd7a7
-  data.tar.gz: 92c0643b0a37b3f0928be58115ada58d3691b0d2505806f9a97e1226fb3fb7f07e59de7ddcc1a09cad0648f08c11b033d7202d19bb652f205954580b2cb63366
+  metadata.gz: 7d171a9e1a9f2152cc4e3d22434334849f3df4aca8131fb625967ecd79d390a3cb555ce14f6839023221dee85415be8c5068c46492b602d22cd28f69a4fe1309
+  data.tar.gz: dd425accb219b4342a58a1a7275ba032c11e3d8caa04b6342ca7db8a8ddf8ec3552097cca95d4e4d3a6b0c8c9240b519dfb3ab6285a3b2ebfeaf14147c816fed

data/.rubocop.yml

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

data/.travis.yml

@@ -1,4 +1,33 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.11.2
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+gemfile:
+  - gemfiles/lograge10.gemfile
+  - gemfiles/lograge11.gemfile
+before_install:
+  - gem update --system
+  - gem install bundler
+jobs:
+  include:
+    - stage: linting
+      rvm: 2.6
+      gemfile: gemfiles/lograge11.gemfile # Only run on 1 gemfile
+      install: true # Do not bundle install
+      script: gem install rubocop rubocop-performance --no-document && rubocop
+stages:
+  - linting
+  - test
+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,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lograge-sql.gemspec

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,53 @@ 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:
+
+```
+method=GET path=/mypath format=html ...
+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
+
+```json
+{
+    "sql_queries": "name1 ({duration1}) {query1}\nname2 ({duration2}) query2 ...",
+    "sql_queries_count": 3
+}
+```
+
+To customize the output:
+
+```ruby
+# config/initializers/lograge.rb
+Rails.application.configure do
+
+  # Instead of extracting event as Strings, extract as Hash. You can also extract
+  # additional fields to add to the formatter
+  config.lograge_sql.extract_event = Proc.new do |event|
+    { name: event.payload[:name], duration: event.duration.to_f.round(2), sql: event.payload[:sql] }
+  end
+  # Format the array of extracted events
+  config.lograge_sql.formatter = Proc.new do |sql_queries|
+    sql_queries
+  end
+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
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iMacTia/lograge-sql.

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,7 +1,52 @@
+# 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
+      attr_accessor :extract_event
+
+      # Initialise configuration with fallback to default values
+      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
+      end
 
+      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 do |sql_queries|
+          %('#{sql_queries.join("\n")}')
+        end
+      end
+
+      # By default, only extract values required for the default_formatter and
+      # already convert to a string
+      def default_extract_event
+        proc do |event|
+          "#{event.payload[:name]} (#{event.duration.to_f.round(2)}) #{event.payload[:sql]}"
+        end
+      end
+    end
   end
 end
+
+# Rails specific configuration
+require 'lograge/sql/railtie' if defined?(Rails)

data/lib/lograge/sql/extension.rb

@@ -1,17 +1,22 @@
+# 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: %('#{sql_queries.join("\n")}'),
+          sql_queries: Lograge::Sql.formatter.call(sql_queries),
           sql_queries_count: sql_queries.length
         }
       end
@@ -20,20 +25,24 @@ 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] << ("#{event.payload[:name]} (#{event.duration.to_f.round(2)}) #{event.payload[:sql]}")
+
+      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

@@ -0,0 +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)
+      end
+    end
+  end
+end

data/lib/lograge/sql/version.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Lograge
   module Sql
-    VERSION = '0.2.0'
+    # Gem version
+    VERSION = '1.2.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 'activerecord', '>= 4', '< 7.0'
   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 'bundler', '~> 2.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.2.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2020-07-10 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,21 +29,35 @@ dependencies:
         version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   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,14 +123,18 @@ 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
 - lib/lograge/sql/version.rb
 - lograge-sql.gemspec
 homepage: https://github.com/iMacTia/lograge-sql