cache_key_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65f947c28df0505768d59510c841a2b2cc1cbdad
+  data.tar.gz: 439a17b86ab90a3a348b7fd24888db67e2db7621
+SHA512:
+  metadata.gz: ca839ffbe1cf763cc448a76d13171f409f363f5e218db2f00f949bebd6a507bdda4dfbd3bf22e53d93dba133b040fc81d8764f78c86b1fafd78264f0544e5135
+  data.tar.gz: a40ce417551f596834f39e7b2e7fc86242af434a3c7e4a715137174a8079c6e69aecb97d56a7722c4c960deef83345a7a7afe39b148eaefaf3a565c00457e220

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+.sass-cache/*
+gemfiles/*.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.4
+gemfile:
+  - gemfiles/rails_4.1.0.gemfile
+  - gemfiles/rails_4.2.0.gemfile
+sudo: false

data/Appraisals

@@ -0,0 +1,7 @@
+rails_versions = ['~> 4.1.0', '~> 4.2.0']
+
+rails_versions.each do |rails_version|
+  appraise "rails-#{rails_version.slice(/\d+\.\d+.\d+/)}" do
+    gem 'rails', rails_version
+  end
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mkalita@artegence.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    cache_key_for (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.1)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 1.0)
+  cache_key_for!
+  rspec-rails (~> 3.1)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Efigence
+
+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,75 @@
+# CacheKeyFor [![Build Status](https://travis-ci.org/efigence/cache_key_for.svg?branch=master)](https://travis-ci.org/efigence/cache_key_for)
+Comprehensive cache key generator (complements Rails `cache` helper)
+
+How to design a perfect cache key? This project's goal is to provide the bulletproof solution for most use cases.
+
+## Install
+
+cache_key_for is a Railtie. We support the versions of Ruby and Rails listed in [.travis.yml](.travis.yml).
+
+It should be run as a gem and included in your `Gemfile`:
+
+    gem "cache_key_for"
+
+### \#cache_key_for
+
+Features:
+* locale
+* pagination
+* scoped collections
+* deletion from and addition to collections sorted in ascending order (via embedded `count` in the key)
+* accepts `cache_owner_cache_key` for personalized cache, eg. current_company.cache_key, current_user.cache_key etc.
+* all params (including other than GET's query params) with proper non-utf8 data handling for key generation
+* optional suffix for:
+    * expiry tags (unlike :expires_in cache option, this offers full :file_store storage compatibility)
+    * any edge cases
+* file differentiation and file changes are handled separately by Rails' `cache` helper (md5 is added at the end of cache path)
+* one key instead of many, but also unobtrusive (example in haml):
+
+    ```haml
+        - cache [cache_key_for(@articles, 'articles'), @some_active_model_object, 'box-type-view'] do
+        (...)
+    ```
+* core concept of Russian Doll Caching is touching: `belongs_to :some_model, touch: true`, but if you do not use `touch`, you can still cache safely like this (example in haml):
+
+    ```haml
+        - cache [cache_key_for(@articles, 'articles'), @some_model_instance] do
+        (...)
+    ```
+
+Example (haml):
+
+```haml
+    - cache cache_key_for(@service.datacenters, 'datacenters', current_company.cache_key, Time.now.utc.to_date.to_s) do
+    (...)
+```
+
+Rails will generate cache at:
+
+```
+app_name:views/en/datacenters/5bd92bd352e7726d02175752913014711f5d412e/companies/1-20150619101645935901000/2015-06-26/7a6f89a738006a69c1d1e0214e147bab
+```
+
+### \#cache_key_for_view
+
+Features:
+* all features of `cache_key_for` method
+* better debugging (accepts view/partial file path for visible part of cache key)
+
+Example (haml):
+
+```haml
+    - cache cache_key_for_view(__FILE__, @service.datacenters, 'datacenters', current_company.cache_key, Time.now.utc.to_date.to_s) do
+```
+
+Rails will generate cache at:
+
+```
+app_name:views/en/datacenters/5bd92bd352e7726d02175752913014711f5d412e/companies/1-20150619101645935901000/2015-06-
+26/app/views/services/datacenters.html.haml/4324f99340fd2b2bc7e26b8e9b79d8f5
+```
+
+## Contributing
+
+    ./bin/setup
+    bundle exec rake

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    exec 'rake spec'
+  else
+    Rake::Task['appraise'].execute
+  end
+end
+
+task :appraise => ['appraisal:install'] do |t|
+  exec 'rake appraisal'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flutie"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cache_key_for.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'cache_key_for/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'cache_key_for'
+  s.version     = CacheKeyFor::VERSION.dup
+  s.authors     = ['Marcin Kalita']
+  s.email       = ['mkalita@efigence.com']
+
+  s.summary     = %q{Comprehensive cache key generator (complements Rails `cache` helper)}
+  s.description = %q{How to design a perfect cache key? This project's goal is to provide a bulletproof solution for most use cases.}
+  s.homepage    = 'http://github.com/efigence/cache_key_for'
+  s.license     = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if s.respond_to?(:metadata)
+    s.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  #s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.files         = [ ".gitignore",
+                      ".rspec",
+                      ".travis.yml",
+                      "Appraisals",
+                      "CODE_OF_CONDUCT.md",
+                      "Gemfile",
+                      "Gemfile.lock",
+                      "LICENSE.txt",
+                      "README.md",
+                      "Rakefile",
+                      "bin/console",
+                      "bin/setup",
+                      "cache_key_for.gemspec",
+                      "gemfiles/rails_4.1.0.gemfile",
+                      "gemfiles/rails_4.2.0.gemfile",
+                      "lib/cache_key_for.rb",
+                      "lib/cache_key_for/cache_key_for_helper.rb",
+                      "lib/cache_key_for/cache_key_for_view_helper.rb",
+                      "lib/cache_key_for/railtie.rb",
+                      "lib/cache_key_for/version.rb" ]
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency('appraisal', '~> 1.0')
+  s.add_development_dependency('sqlite3', '~> 1.3')
+  s.add_development_dependency('rspec-rails', '~> 3.1')
+end

data/gemfiles/rails_4.1.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/cache_key_for/cache_key_for_helper.rb

@@ -0,0 +1,46 @@
+# Features:
+# * locale
+# * pagination
+# * scoped collections
+# * deletion from and addition to collections sorted in ascending order (via embedded `count` in the key)
+# * accepts `cache_owner_cache_key` for personalized cache, eg. current_company.cache_key, current_user.cache_key etc.
+# * all params (including other than GET's query params) with proper non-utf8 data handling for key generation
+# * optional suffix for:
+#     * expiry tags (unlike :expires_in cache option, this offers full :file_store storage compatibility)
+#     * any edge cases
+# * file differentiation and file changes are handled separately by Rails' `cache` helper (md5 is added at the end of cache path)
+# * one key instead of many, but also unobtrusive (example in haml):
+
+#     ```haml
+#         - cache [cache_key_for(@articles, 'articles'), @some_active_model_object, 'box-type-view'] do
+#         (...)
+#     ```
+# * core concept of Russian Doll Caching is touching: `belongs_to :some_model, touch: true`, but if you do not use `touch`, you can still cache safely like this (example in haml):
+
+#     ```haml
+#         - cache [cache_key_for(@articles, 'articles'), @some_model_instance] do
+#         (...)
+#     ```
+
+# Example (haml):
+
+# ```haml
+#     - cache cache_key_for(@service.datacenters, 'datacenters', current_company.cache_key, Time.now.utc.to_date.to_s) do
+#     (...)
+# ```
+
+# Rails will generate cache at:
+
+# ```
+# app_name:views/en/datacenters/5bd92bd352e7726d02175752913014711f5d412e/companies/1-20150619101645935901000/2015-06-26/7a6f89a738006a69c1d1e0214e147bab
+# ```
+module CacheKeyForHelper
+  def cache_key_for(scoped_collection, collection_prefix, cache_owner_cache_key = '', suffix = '')
+    max_updated_at = scoped_collection.to_a.map{|i| i.updated_at.to_i }.max.to_i
+    count = scoped_collection.count
+    ids_string = scoped_collection.to_a.map(&:id).join('-')
+    request_params = request.params ? request.params.map{|k, v| [k.dup.force_encoding("UTF-8"), v.dup.force_encoding("UTF-8")] } : nil
+    digest = Digest::SHA1.hexdigest("#{ids_string}-#{max_updated_at}-#{count}-#{request.path}-#{request_params}")
+    "#{I18n.locale}/#{collection_prefix}/#{digest}/#{cache_owner_cache_key}/#{suffix}"
+  end
+end

data/lib/cache_key_for/cache_key_for_view_helper.rb

@@ -0,0 +1,22 @@
+# Features:
+# * all features of `cache_key_for` method
+# * better debugging (accepts view/partial file path for visible part of cache key)
+
+# Example (haml):
+
+# ```haml
+#     - cache cache_key_for_view(__FILE__, @service.datacenters, 'datacenters', current_company.cache_key, Time.now.utc.to_date.to_s) do
+# ```
+
+# Rails will generate cache at:
+
+# ```
+# app_name:views/en/datacenters/5bd92bd352e7726d02175752913014711f5d412e/companies/1-20150619101645935901000/2015-06-
+# 26/app/views/services/datacenters.html.haml/4324f99340fd2b2bc7e26b8e9b79d8f5
+# ```
+module CacheKeyForViewHelper
+  include CacheKeyForHelper
+  def cache_key_for_view(file, scoped_collection, collection_prefix, cache_owner_cache_key = '', suffix = '')
+    "#{cache_key_for(scoped_collection, collection_prefix, cache_owner_cache_key, suffix)}#{file.gsub(Rails.root.to_s, '')}"
+  end
+end

data/lib/cache_key_for/railtie.rb

@@ -0,0 +1,13 @@
+require 'cache_key_for/cache_key_for_helper'
+require 'cache_key_for/cache_key_for_view_helper'
+
+module CacheKeyFor
+  class Railtie < Rails::Railtie
+    initializer 'cache_key_for.helper' do |app|
+      ActionView::Base.send :include, CacheKeyForHelper
+    end
+    initializer 'cache_key_for_view.helper' do |app|
+      ActionView::Base.send :include, CacheKeyForViewHelper
+    end
+  end
+end

data/lib/cache_key_for/version.rb

@@ -0,0 +1,3 @@
+module CacheKeyFor
+  VERSION = '0.1.0'.freeze
+end

data/lib/cache_key_for.rb

@@ -0,0 +1,5 @@
+require 'cache_key_for/version'
+
+module Flutie
+  require 'cache_key_for/railtie' if defined?(Rails)
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: cache_key_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcin Kalita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: How to design a perfect cache key? This project's goal is to provide
+  a bulletproof solution for most use cases.
+email:
+- mkalita@efigence.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache_key_for.gemspec
+- gemfiles/rails_4.1.0.gemfile
+- gemfiles/rails_4.2.0.gemfile
+- lib/cache_key_for.rb
+- lib/cache_key_for/cache_key_for_helper.rb
+- lib/cache_key_for/cache_key_for_view_helper.rb
+- lib/cache_key_for/railtie.rb
+- lib/cache_key_for/version.rb
+homepage: http://github.com/efigence/cache_key_for
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Comprehensive cache key generator (complements Rails `cache` helper)
+test_files: []