active_record_query_trace 1.3 → 1.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTBiMjU5ZWY5Y2YwMmY3ZjBlNmMyY2YyMjI4MmQ5MzU5MTEwNWY0ZA==
-  data.tar.gz: !binary |-
-    OTM5OWM3YWM5Y2E1OTViMTY0MDM4NWM3ODkwOWFmZmRmYzdjOGJkZg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YmExM2U2OTk5M2U1YTA0MDM4YmI1MWFlM2E5NjhlZDkxN2EzZjEwY2M0NGFl
-    MmY4M2Q5MDcyNzQwMDNjYjcyYjhhYTViODhmYTMwMTE4MjdlMDkxYTQyNGI2
-    MGY0OWRmZGQ4YWM1MzhkMTg4OWUwMTUyMzVmODhhNjVjNmM3MTU=
-  data.tar.gz: !binary |-
-    MDk2NjUxZWViMmI0NjY4ODc4NjY3NTg5YTU4N2ViOWMyNmUzZDhkZTFkZDNm
-    NTMyMGJlZDg5N2YwM2Q4MWUyZmFkYjM2ZDA2OGMwYWY3MTdiNmM3MzFmODU3
-    Y2VjZjY0YzZhZDBjOGRkYzQxMzIwZDllNDZkOTFiZmQyMzA0OWM=
+SHA1:
+  metadata.gz: f3bf7027ae082e7dbcdebe76076e574cc666ebbe
+  data.tar.gz: c83658ea02bf13e42384917c5642dd60153bdbcc
+SHA512:
+  metadata.gz: 026991c7074bf4bbaa9fa08db51d650d42ef8d2973e00e305dcd7e1332fef93336eaaf94c3626607e7f5c4caf98128b433df0c2c6ee1e664604d60879242e74c
+  data.tar.gz: 1447eff21be5a1a3230e7b56b5c9b9e03f663b2d3f4135d99bf3ee8124719026106415cc287830159e597a8cdcbfdb4f1c78207c6f5bae45e65d8cb2bf537270

data/HISTORY.md

@@ -0,0 +1,17 @@
+## 1.4 (2015-03-05)
+
+Support for ignoring `ActiveRecord` cached queries that show up in the log with a `CACHE` prefix.
+
+```ruby
+ActiveRecordQueryTrace.ignore_cached_queries = true
+```
+
+See this Pull-Request for additional notes on how these cached queries can also be skipped from the log file:
+
+https://github.com/ruckus/active-record-query-trace/pull/10
+
+Thank you to @tinynumbers for this contribution.
+
+## < 1.3
+
+Unavailable. Sorry, I was not keep tracking of history prior to `1.4`

data/MIT-LICENSE

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2011
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,12 +1,18 @@
 Logs the source of execution of all queries to the Rails log. Helpful to track down where queries are being executed in your application, for performance optimizations most likely.
 
-Install
--------
+## Install
+
+Install the latest stable release:
 
 `gem install active_record_query_trace`
 
-Usage
------
+In Rails, add it to your Gemfile, then restart the server:
+
+```ruby
+gem 'active_record_query_trace'
+```
+
+##Usage
 
 Enable it in an initializer:
 
@@ -14,34 +20,39 @@ Enable it in an initializer:
 ActiveRecordQueryTrace.enabled = true
 ```
 
-Options
-_______
+## Options
 
-There are three levels of debug. 
+There are three levels of debug.
 
 1. app - includes only files in your app/ directory.
 2. full - includes files in your app as well as rails.
-3. rails - alternate ouput of full backtrace, useful for debugging gems.
+3. rails - alternate output of full backtrace, useful for debugging gems.
 
 ```ruby
 ActiveRecordQueryTrace.level = :app # default
 ```
 
+By default, a backtrace will be logged for every query, even cached queries that do not actually hit the database. You might find it useful not to print the backtrace for cached queries:
+
+```ruby
+ActiveRecordQueryTrace.ignore_cached_queries
+```
+
 Additionally, if you are working with a large app, you may wish to limit the number of lines displayed for each query.
 
 ```ruby
 ActiveRecordQueryTrace.lines = 10 # Default is 5. Setting to 0 includes entire trace.
 ```
 
-Output
-------
+## Output
 
 When enabled every query source will be logged like:
 
 ```
   IntuitAccount Load (1.2ms)  SELECT "intuit_accounts".* FROM "intuit_accounts" WHERE "intuit_accounts"."user_id" = 20 LIMIT 1
-Called from: app/views/users/edit.html.haml:78:in `block in _app_views_users_edit_html_haml___1953197429694975654_70177901460360'
- app/views/users/edit.html.haml:16:in `_app_views_users_edit_html_haml___1953197429694975654_70177901460360'
+Called from:
+  app/views/users/edit.html.haml:78:in `block in _app_views_users_edit_html_haml___1953197429694975654_70177901460360'
+  app/views/users/edit.html.haml:16:in `_app_views_users_edit_html_haml___1953197429694975654_70177901460360'
 ```
 
 Requirements

data/active_record_query_trace.gemspec

@@ -4,12 +4,11 @@ require 'version'
 Gem::Specification.new do |gem|
   gem.name          = 'active_record_query_trace'
   gem.version       = ActiveRecordQueryTrace::VERSION
-
   gem.summary       = "Print stack trace of all queries to the Rails log. Helpful to find where queries are being executed in your application."
   gem.description   = gem.summary
   gem.authors       = ["Cody Caughlan"]
   gem.email         = 'toolbag@gmail.com'
   gem.homepage      = 'https://github.com/ruckus/active-record-query-trace'
-  gem.files = Dir["**/*"]
-
+  gem.files         = Dir["**/*"]
+  gem.license       = 'MIT'
 end

data/lib/active_record_query_trace.rb

@@ -6,6 +6,7 @@ module ActiveRecordQueryTrace
     attr_accessor :enabled
     attr_accessor :level
     attr_accessor :lines
+    attr_accessor :ignore_cached_queries
   end
 
   module ActiveRecord
@@ -16,6 +17,7 @@ module ActiveRecordQueryTrace
         ActiveRecordQueryTrace.enabled = false
         ActiveRecordQueryTrace.level = :app
         ActiveRecordQueryTrace.lines = 5
+        ActiveRecordQueryTrace.ignore_cached_queries = false
       end
 
       def sql(event)
@@ -28,7 +30,11 @@ module ActiveRecordQueryTrace
             end
           end
 
-          debug(color('Called from: ', MAGENTA, true) + clean_trace(caller)[index].join("\n "))
+          payload = event.payload
+          return if payload[:name] == 'SCHEMA'
+          return if ActiveRecordQueryTrace.ignore_cached_queries && payload[:name] == 'CACHE'
+
+          debug(color("Called from: \n  ", MAGENTA, true) + clean_trace(caller)[index].join("\n  "))
         end
       end
 
@@ -41,6 +47,8 @@ module ActiveRecordQueryTrace
         when :app
           Rails.backtrace_cleaner.add_silencer { |line| not line =~ /^app/ }
           Rails.backtrace_cleaner.clean(trace)
+        else
+          raise "Invalid ActiveRecordQueryTrace.level value '#{ActiveRecordQueryTrace.level}' - should be :full, :rails, or :app"
         end
       end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordQueryTrace
-  VERSION = '1.3'
+  VERSION = '1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_trace
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - Cody Caughlan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies: []
 description: Print stack trace of all queries to the Rails log. Helpful to find where
   queries are being executed in your application.
@@ -18,11 +18,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - active_record_query_trace.gemspec
+- HISTORY.md
 - lib/active_record_query_trace.rb
 - lib/version.rb
+- MIT-LICENSE
 - README.md
 homepage: https://github.com/ruckus/active-record-query-trace
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -30,19 +33,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Print stack trace of all queries to the Rails log. Helpful to find where
   queries are being executed in your application.
 test_files: []
+has_rdoc: