cache-query-trace 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f072d1436d53f066103e1d61caf3cd10e1d2b9d
+  data.tar.gz: 6c5b4d41d5034e25869a6f81eb6da7301097dfe7
+SHA512:
+  metadata.gz: fb6061b4d66b94d81a6cf346a8439c693db5531da97f87f8de5021508f395196b11f3914c10f66602561b9d8e2be540b11dcc0eda0803577e0083f0797f83c12
+  data.tar.gz: cc61635c99c762b01f606f61f3a367b4d925e85d8551f84b56aa86231b0c266f5414ecef7704a9a332f42e37da4a8beeb63f175cbf7d9ef724076dee7464aaf2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Oleg Dashevskii
+
+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

@@ -0,0 +1,74 @@
+Logs the source of execution of cache queries to the Rails log. Helpful to
+track down where queries are being executed in your application, for
+performance optimizations most likely.
+
+This gem is basically a modified version of
+[active_record_query_trace](https://github.com/ruckus/active-record-query-trace).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cache-query-trace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache-query-trace
+
+## Usage
+
+Enable it in an initializer:
+
+```ruby
+CacheQueryTrace.enabled = true
+```
+
+## Options
+
+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 output of full backtrace, useful for debugging gems.
+
+```ruby
+CacheQueryTrace.level = :app # default
+```
+
+Additionally, if you are working with a large app, you may wish to limit the number of lines displayed for each query.
+
+```ruby
+CacheQueryTrace.lines = 10 # Default is 5. Setting to 0 includes entire trace.
+```
+
+## Output
+
+When enabled cache queries will be logged like:
+
+```
+Cache read: posts_count
+  ↳ app/controllers/posts_controller.rb:3:in `index'
+Read fragment views/posts/4-20151210094737092778000/8837ab4e4a7592addd66bce7a312e0e6 (3.1ms)
+Cache write: views/posts/4-20151210094737092778000/8837ab4e4a7592addd66bce7a312e0e6
+  ↳ app/views/posts/index.html.erb:5:in `block in _app_views_posts_index_html_erb__3444413509721278033_69855962868040'
+     from app/views/posts/index.html.erb:4:in `_app_views_posts_index_html_erb__3444413509721278033_69855962868040'
+  ↳ app/views/posts/index.html.erb:5:in `block in _app_views_posts_index_html_erb__3444413509721278033_69855962868040'
+     from app/views/posts/index.html.erb:4:in `_app_views_posts_index_html_erb__3444413509721278033_69855962868040'
+Write fragment views/posts/4-20151210094737092778000/8837ab4e4a7592addd66bce7a312e0e6 (16.4ms)
+  Rendered posts/index.html.erb within layouts/application (184.0ms)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cache-query-trace. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cache-query-trace.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache-query-trace"
+  spec.version       = CacheQueryTrace::VERSION
+  spec.authors       = ["Oleg Dashevskii"]
+  spec.email         = ["olegdashevskii@gmail.com"]
+
+  spec.summary       = %q{Print stack trace of all cache queries to the Rails log. Helpful to find where cache queries are being executed in your application"}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/be9/cache-query-trace"
+  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_dependency "activesupport", ">= 3.0"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cache-query-trace.rb

@@ -0,0 +1,78 @@
+# encoding: UTF-8
+require 'active_support/log_subscriber'
+
+module CacheQueryTrace
+  class <<self
+    attr_accessor :enabled
+    attr_accessor :level
+    attr_reader :lines
+    attr_reader :trace_slice
+
+    def lines=(lines)
+      @lines = lines
+
+      @trace_slice = if CacheQueryTrace.lines == 0
+                       0..-1
+                     else
+                       0..(CacheQueryTrace.lines - 1)
+                     end
+    end
+  end
+
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def initialize
+      super
+
+      CacheQueryTrace.enabled = false
+      CacheQueryTrace.level = :app
+      CacheQueryTrace.lines = 5
+
+      if CacheQueryTrace.level != :app
+        # Rails by default silences all backtraces that match Rails::BacktraceCleaner::APP_DIRS_PATTERN
+        Rails.backtrace_cleaner.remove_silencers!
+      end
+    end
+
+    def cache_read(event)
+      if CacheQueryTrace.enabled
+        cleaned_trace = clean_trace(caller)[CacheQueryTrace.trace_slice].join("\n     from ")
+        debug("  ↳ " + cleaned_trace) unless cleaned_trace.blank?
+      end
+    end
+
+    alias cache_write cache_read
+    alias cache_delete cache_read
+    alias cache_exist? cache_read
+
+    alias read_fragment cache_read
+    alias write_fragment cache_read
+    alias exist_fragment? cache_read
+    alias expire_fragment cache_read
+
+    def clean_trace(trace)
+      # Rails relies on backtrace cleaner to set the application root directory
+      # filter. The problem is that the backtrace cleaner is initialized
+      # before the application. This ensures that the value of `root` used by
+      # the filter is set to the application root
+      if Rails.backtrace_cleaner.instance_variable_get(:@root) == '/'
+        Rails.backtrace_cleaner.instance_variable_set :@root, Rails.root.to_s
+      end
+
+      case CacheQueryTrace.level
+      when :full
+        trace
+      when :rails
+        Rails.respond_to?(:backtrace_cleaner) ? Rails.backtrace_cleaner.clean(trace) : trace
+      when :app
+        Rails.backtrace_cleaner.remove_silencers!
+        Rails.backtrace_cleaner.add_silencer { |line| line !~ /^(app|lib|engines)\// }
+        Rails.backtrace_cleaner.clean(trace)
+      else
+        raise ArgumentError, "Invalid CacheQueryTrace.level value '#{CacheQueryTrace.level}' - should be :full, :rails, or :app"
+      end
+    end
+
+    attach_to :active_support
+    attach_to :action_controller
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CacheQueryTrace
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: cache-query-trace
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Oleg Dashevskii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: Print stack trace of all cache queries to the Rails log. Helpful to find
+  where cache queries are being executed in your application"
+email:
+- olegdashevskii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache-query-trace.gemspec
+- lib/cache-query-trace.rb
+- lib/version.rb
+homepage: https://github.com/be9/cache-query-trace
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Print stack trace of all cache queries to the Rails log. Helpful to find
+  where cache queries are being executed in your application"
+test_files: []