lograge-sql 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f057e0f18be0a66527bf7bed2c8c217ca95e731304bbaae193efd24e0a764db3
-  data.tar.gz: e84b14ff93214088f99de92228be072a727e834727b362aa4c772afd93ab5fb8
+  metadata.gz: 6c781f369bfdc3b5ee7fa14fe03146c929e67a90b3558933e88d520d1908324e
+  data.tar.gz: c498398d6d5089d9f8362e1f0ab0fec680cfdd80e397195ce75ce6a6860ab951
 SHA512:
-  metadata.gz: 7388da0b428389ab33f38476fd717452b5a144ece741531397c43a6c43a97a0eb00235020c89441d34a6977dc6507d6c29678e45d5ecbb30f345f6d80c0cd7a7
-  data.tar.gz: 92c0643b0a37b3f0928be58115ada58d3691b0d2505806f9a97e1226fb3fb7f07e59de7ddcc1a09cad0648f08c11b033d7202d19bb652f205954580b2cb63366
+  metadata.gz: 265b36d72f2b0a9f6fcdd0f4af6cd07e04088df14be819e3499351230ff314cec3efa07443a2d24d7b0136df9389fb16c0041fae73b1930b01eaa4466c6c8254
+  data.tar.gz: 623aeb11fcb1b9633b72b54e5d001d84ac558f2fea2fee1fdb7eb43e662e0b756ab2dfdfc99abb55749a657844b51caec94ea8609e2a4122d7cd503289a50d9a

data/.travis.yml

@@ -1,4 +1,14 @@
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.11.2
+  - 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/README.md

@@ -22,6 +22,44 @@ In order to enable SQL logging in your application, you'll simply need to add th
 require 'lograge/sql/extension'
 ```
 
+## 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
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iMacTia/lograge-sql.

data/lib/lograge/sql.rb

@@ -2,6 +2,41 @@ require 'lograge/sql/version'
 
 module Lograge
   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
+      end
+
+      private
+
+      # By default, the output is a concatenated string of all extracted events
+      def default_formatter
+        Proc.new 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.new 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

@@ -11,7 +11,7 @@ module Lograge
 
         Thread.current[: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
@@ -25,7 +25,7 @@ module Lograge
       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]}")
+      Thread.current[:lograge_sql_queries] << Lograge::Sql.extract_event.call(event)
     end
   end
 end

data/lib/lograge/sql/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+require 'active_support/ordered_options'
+
+module Lograge
+  module Sql
+    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,5 @@
 module Lograge
   module Sql
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lograge-sql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-07 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -103,6 +103,7 @@ files:
 - 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
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: An extension for Lograge to log SQL queries