rails-cache-inspector 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b92f48e54fff086fabd13c4888863667ed2361f71ede21eaa390a6fba0bca98
+  data.tar.gz: cb1afe3f6424666d956f573ac956aa0c91076dbb5b20ff37e5fe0429de3fc0e4
+SHA512:
+  metadata.gz: b7d2d0033021a7701f35cf246a1614ceed2d5cf7e3c824c8161bcab194990aac9b6302fc3d9345357c27303f32601c4219e28793070307cc8e8b1049cec8dbcc
+  data.tar.gz: af694c9d03222d524ebe78a7bed9980d3f051321cbaa5923a89e1d380c3d5b1ad6a8319c70a93c48ce4c5253b6dcbbec48126709778a3e969b50aa8452cef55d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vilius Luneckas
+
+MIT License
+
+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,42 @@
+# Rails cache inspector
+
+Dead simple tool for visual debugging of fragment cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-cache-inspector', group: :development
+```
+
+## Usage
+
+### Configure highlighting
+
+```Ruby
+# config/initializers/rails_cache_inspector.rb
+
+RailsCacheInspector.configuration.highlight_with = { 
+  style:      'filter: sepia(1)',  # default – 'filter: sepia(1)'
+  class_name: 'is-cached'          # default - ''
+}
+
+```
+
+### Configure rails application
+
+Make sure caching is turned on in development environment
+
+```ruby
+# config/environments/development.rb
+
+config.action_controller.perform_caching = true
+```
+
+### In action
+
+Cached fragments have blur filter in the demonstration below. It's easy to identify potentially slow parts of the page 
+and make it fast again.
+
+![visual-debugging](https://github.com/ViliusLuneckas/rails-cache-inspector/blob/master/visual-debugging.gif)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/rails-cache-inspector.rb

@@ -0,0 +1,10 @@
+require_relative 'rails-cache-inspector/configuration'
+require_relative 'rails-cache-inspector/fragment_for_patch'
+require_relative 'rails-cache-inspector/railtie'
+require_relative 'rails-cache-inspector/version'
+
+module RailsCacheInspector
+  def self.configuration
+    @configuration ||= Configuration.new(highlight_with: { style: 'filter: sepia(1)' })
+  end
+end

data/lib/rails-cache-inspector/configuration.rb

@@ -0,0 +1,9 @@
+module RailsCacheInspector
+  class Configuration
+    attr_accessor :highlight_with
+
+    def initialize(init_with = {})
+      init_with.each { |k, v| public_send("#{k}=", v) }
+    end
+  end
+end

data/lib/rails-cache-inspector/fragment_for_patch.rb

@@ -0,0 +1,15 @@
+module RailsCacheInspector
+  module FragmentForPatch
+    def fragment_for(name = {}, options = nil, &block)
+      fragment   = super(name, options, &block)
+      style      = RailsCacheInspector.configuration.highlight_with[:style]
+      class_name = RailsCacheInspector.configuration.highlight_with[:class_name]
+
+      <<-HTML.strip_heredoc
+        <div style="#{style}" class="#{class_name}">
+          #{fragment}
+        </div>
+      HTML
+    end
+  end
+end

data/lib/rails-cache-inspector/railtie.rb

@@ -0,0 +1,9 @@
+module RailsCacheInspector
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      return unless Rails.env.development? && Rails.application.config.action_controller.perform_caching
+
+      ApplicationHelper.prepend FragmentForPatch
+    end
+  end
+end

data/lib/rails-cache-inspector/version.rb

@@ -0,0 +1,3 @@
+module RailsCacheInspector
+  VERSION = '1.0.0'.freeze
+end

data/rails-cache-inspector.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rails-cache-inspector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-cache-inspector'
+  spec.version       = RailsCacheInspector::VERSION
+  spec.authors       = ['Vilius Luneckas']
+  spec.email         = ['vilius.luneckas@gmail.com']
+  spec.summary       = %q{Dead simple tool for visual debugging of fragment cache.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/ViliusLuneckas/rails-cache-inspector'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rails-cache-inspector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vilius Luneckas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dead simple tool for visual debugging of fragment cache.
+email:
+- vilius.luneckas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails-cache-inspector.rb
+- lib/rails-cache-inspector/configuration.rb
+- lib/rails-cache-inspector/fragment_for_patch.rb
+- lib/rails-cache-inspector/railtie.rb
+- lib/rails-cache-inspector/version.rb
+- rails-cache-inspector.gemspec
+- visual-debugging.gif
+homepage: https://github.com/ViliusLuneckas/rails-cache-inspector
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Dead simple tool for visual debugging of fragment cache.
+test_files: []