sql_tracker 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1760dc0e6fbb610de5ed9dc40d2c50087901f5c0
-  data.tar.gz: 282699e984535d03896c19d7aaaf5c10fa66e6bb
+  metadata.gz: 29226162337ee889c358d175c76c9aea25a6e7ec
+  data.tar.gz: 51c36a794abd3c99398247a8884cfc5bd472a982
 SHA512:
-  metadata.gz: 381fbceeb15cfedf0ca60955e962577287ceebcdc5c674689512419552ed463c87d4dfc443e823ecff4a01ece2800914dae59c847c58b71723faabb2f8b731e3
-  data.tar.gz: ab777cb8498dbdf20da9eb702bf843f665d32b7e55e7502e1c11fc7fd9b2960fa7897fc15f2e7d26d8450959be31382c6fadf958b6b2700986eec9e5eb395eba
+  metadata.gz: 8d1d5d91215717b8ab3a928a0a2568683fa26e2fb4d782b166b4ac5218bab710963fa1778717dfe7fa1679e9859ea216214636233db36b132d12cc3af666cca2
+  data.tar.gz: e87a892f671de2faedce163085e4ec89326581ab572550a856ba6628517ccb445c7bc200392701e462106f556e1a3142a40451131333668909403438a1a04ecb

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.3.0
-before_install: gem install bundler -v 1.12.4
+before_install:
+  - gem install bundler
+  - gem update bundler

data/README.md

@@ -1,5 +1,8 @@
 # Rails SQL Query Tracker
 
+[![Code Climate](https://codeclimate.com/github/steventen/sql_tracker/badges/gpa.svg)](https://codeclimate.com/github/steventen/sql_tracker)
+[![Build Status](https://travis-ci.org/steventen/sql_tracker.svg?branch=master)](https://travis-ci.org/steventen/sql_tracker)
+
 `sql_tracker` tracks SQL queries by subscribing to Rails' `sql.active_record` event notifications.
 
 It then aggregates and generates report to give you insights about all the sql queries happened in your Rails application.
@@ -34,6 +37,16 @@ To generate report, run
 sql_tracker tmp/sql_tracker-*.json
 ```
 
+## Configurations
+
+All the configurable variables and their defaults are list below:
+```ruby
+SqlTracker::Config.enabled = true
+SqlTracker::Config.tracked_paths = %w(app lib)
+SqlTracker::Config.tracked_sql_command = %w(SELECT INSERT UPDATE DELETE)
+SqlTracker::Config.output_path = File.join(Rails.root.to_s, 'tmp')
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/sql_tracker/config.rb

@@ -10,7 +10,13 @@ module SqlTracker
         self.enabled = enabled.nil? ? true : enabled
         self.tracked_paths ||= %w(app lib)
         self.tracked_sql_command ||= %w(SELECT INSERT UPDATE DELETE)
-        self.output_path ||= File.join(Rails.root.to_s, 'tmp')
+        self.output_path ||= begin
+          if defined?(::Rails) && ::Rails.root
+            File.join(::Rails.root.to_s, 'tmp')
+          else
+            'tmp'
+          end
+        end
         self
       end
     end

data/lib/sql_tracker/handler.rb

@@ -4,24 +4,26 @@ require 'fileutils'
 
 module SqlTracker
   class Handler
+    attr_reader :data
+
     def initialize(config)
       @config = config
       @started_at = Time.now.to_s
       @data = {} # {key: {sql:, count:, duration, source: []}, ...}
     end
 
-    def call(name, started, finished, id, payload)
+    def call(_name, started, finished, _id, payload)
       return unless @config.enabled
 
       sql = payload[:sql]
-      return unless sql.start_with?(*@config.tracked_sql_command)
+      return unless track?(sql)
 
       cleaned_trace = clean_trace(caller)
       return if cleaned_trace.empty?
 
       sql = clean_sql_query(sql)
       duration = 1000.0 * (finished - started) # in milliseconds
-      sql_key = Digest::MD5.hexdigest(sql)
+      sql_key = Digest::MD5.hexdigest(sql.downcase)
 
       if @data.key?(sql_key)
         update_data(sql_key, cleaned_trace, duration)
@@ -30,23 +32,42 @@ module SqlTracker
       end
     end
 
+    def track?(sql)
+      return true unless @config.tracked_sql_command.respond_to?(:join)
+      tracked_sql_matcher =~ sql
+    end
+
+    def tracked_sql_matcher
+      @tracked_sql_matcher ||= /\A#{@config.tracked_sql_command.join('|')}/i
+    end
+
+    def trace_path_matcher
+      @trace_path_matcher ||= %r{^(#{@config.tracked_paths.join('|')})\/}
+    end
+
     def clean_sql_query(query)
       query.squish!
       query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|\w+)/, '\1xxx')
-      query.gsub!(/(\sIN\s)\([^\(\)]+\)/, '\1(xxx)')
-      query.gsub!(/BETWEEN ('[^']+'|\w+) AND ('[^']+'|\w+)/, 'BETWEEN xxx AND xxx')
+      query.gsub!(/(\sIN\s)\([^\(\)]+\)/i, '\1(xxx)')
+      query.gsub!(/(\sBETWEEN\s)('[^']+'|\w+)(\sAND\s)('[^']+'|\w+)/i, '\1xxx\3xxx')
       query
     end
 
     def clean_trace(trace)
+      return trace unless defined?(::Rails)
+
       if Rails.backtrace_cleaner.instance_variable_get(:@root) == '/'
         Rails.backtrace_cleaner.instance_variable_set :@root, Rails.root.to_s
       end
 
       Rails.backtrace_cleaner.remove_silencers!
-      Rails.backtrace_cleaner.add_silencer do |line|
-        line !~ %r{^(#{@config.tracked_paths.join('|')})\/}
+
+      if config.tracked_paths.respond_to?(:join)
+        Rails.backtrace_cleaner.add_silencer do |line|
+          line !~ trace_path_matcher
+        end
       end
+
       Rails.backtrace_cleaner.clean(trace)
     end
 

data/lib/sql_tracker/version.rb

@@ -1,3 +1,3 @@
 module SqlTracker
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracker
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Steven Yue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler