cache_key_for 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbcb149bca59e95a5a19e83a54c909ed3f4cd710
-  data.tar.gz: 8e4be33d6dfe2d03f96ae48b750e74e2b4a82625
+  metadata.gz: 8c625fdf466a0e82fa1c2bb3df30ffecf5044332
+  data.tar.gz: e3d7c1ccf821298f34890920e4e31d4b8b1115bf
 SHA512:
-  metadata.gz: 1c13742c65e6b4aa0dbbdb1c5f378e26105b3f3f3a01b03c70af2e97985f593bf08d86b8351fc88e510604851a889a395acd53dd47053227703e0519189e2514
-  data.tar.gz: eb8a4cc4e1993454a55966bcd9aa2d7f0d46064a1ae3f0631778ed1f062ef996ed4c21c1fcd4ad5c442087a8a067e448c401b9d4c39c6f66845e723d9a62b517
+  metadata.gz: 37ad16b96072909e6d821841fae60050f7cf26b510857563b0671e50c0882aefb98b2eb39f26c975a42753b12da4c88a2fb521037e8a9acc92d5b886a9a3d017
+  data.tar.gz: 5c991a6bfedacafc4f30526f37d6f0b4a7af555afba85a08e4850619cf104d1f24bcbec7e26ab16c6b770d9d5b74ea16ff8a8dc0c92787826d6cfdeb76784930

data/.gitignore

@@ -6,3 +6,4 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 .sass-cache/*
 *.gem
+/coverage

data/.rspec

@@ -1,2 +1,3 @@
+--format Fuubar
 --color
 --require spec_helper

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cache_key_for (0.1.1)
+    cache_key_for (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -30,16 +30,38 @@ GEM
       rake
       thor (>= 0.14.0)
     builder (3.2.2)
+    byebug (8.2.2)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     erubis (2.7.0)
+    fuubar (2.0.0)
+      rspec (~> 3.0)
+      ruby-progressbar (~> 1.4)
     i18n (0.7.0)
     json (1.8.2)
     loofah (2.0.1)
       nokogiri (>= 1.5.9)
+    method_source (0.8.2)
     mini_portile (0.6.2)
     minitest (5.5.1)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
     rack (1.6.0)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -57,6 +79,10 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
     rspec-core (3.2.1)
       rspec-support (~> 3.2.0)
     rspec-expectations (3.2.0)
@@ -74,9 +100,19 @@ GEM
       rspec-mocks (~> 3.2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
     sqlite3 (1.3.10)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.4)
+    tins (1.6.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
@@ -86,7 +122,13 @@ PLATFORMS
 DEPENDENCIES
   appraisal (~> 1.0)
   cache_key_for!
+  codeclimate-test-reporter (~> 0.5.0)
+  coveralls (~> 0.8.13)
+  fuubar (~> 2.0.0)
+  pry (~> 0.10.3)
+  pry-byebug (~> 3.3.0)
   rspec-rails (~> 3.1)
+  simplecov (~> 0.11.2)
   sqlite3 (~> 1.3)
 
 BUNDLED WITH

data/README.md

@@ -1,4 +1,4 @@
-# CacheKeyFor [![Build Status](https://travis-ci.org/efigence/cache_key_for.svg?branch=master)](https://travis-ci.org/efigence/cache_key_for)
+# CacheKeyFor [![Build Status](https://travis-ci.org/efigence/cache_key_for.svg?branch=master)](https://travis-ci.org/efigence/cache_key_for) [![Coverage Status](https://coveralls.io/repos/github/efigence/cache_key_for/badge.svg?branch=master)](https://coveralls.io/github/efigence/cache_key_for?branch=master) [![Code Climate](https://codeclimate.com/github/efigence/cache_key_for/badges/gpa.svg)](https://codeclimate.com/github/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.
@@ -14,12 +14,18 @@ It should be run as a gem and included in your `Gemfile`:
 ### \#cache_key_for
 
 Features:
-* locale
-* pagination
-* scoped collections
+* ORM agnostic
+* works with arrays and Plain Old Ruby Objects (POROs) (just provide: #id, #updated_at)
+* supports locale
+* recognizes subdomains
 * 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
+* filters params with proper non-utf8 data handling for key generation
+* recognizes pagination via params (performs well for less than 100 objects per page)
+* includes all params, not only GET's `query` params, which enables submitting of complex forms via POST,
+  which - otherwise - would have query string longer than 2048 characters (Microsoft Internet Explorer)
+* optional whitelist of first level parameters to prevent accidentally generating duplicated cache
+* strips utm_* params
 * optional suffix for:
     * expiry tags (unlike :expires_in cache option, this offers full :file_store storage compatibility)
     * any edge cases
@@ -79,7 +85,3 @@ app_name:views/en/datacenters/5bd92bd352e7726d02175752913014711f5d412e/companies
 
     rm gemfiles/*.lock
     bundle exec appraisal install
-
-## TODO
-
-- add coveralls

data/Rakefile

@@ -5,7 +5,7 @@ require 'appraisal'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default do |t|
+task :default do
   if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
     exec 'rake spec'
   else
@@ -13,6 +13,6 @@ task :default do |t|
   end
 end
 
-task :appraise => ['appraisal:install'] do |t|
+task appraise: ['appraisal:install'] do
   exec 'rake appraisal'
 end

data/cache_key_for.gemspec

@@ -49,4 +49,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency('appraisal', '~> 1.0')
   s.add_development_dependency('sqlite3', '~> 1.3')
   s.add_development_dependency('rspec-rails', '~> 3.1')
+  s.add_development_dependency('coveralls', '~> 0.8.13')
+  s.add_development_dependency('simplecov', '~> 0.11.2')
+  s.add_development_dependency('pry', '~> 0.10.3')
+  s.add_development_dependency('pry-byebug', '~> 3.3.0')
+  s.add_development_dependency('fuubar', '~> 2.0.0')
+  s.add_development_dependency('codeclimate-test-reporter', '~> 0.5.0')
 end

data/lib/cache_key_for/cache_key_for_helper.rb

@@ -1,10 +1,16 @@
 # Features:
-# * locale
-# * pagination
-# * scoped collections
+# * ORM agnostic
+# * works with arrays and Plain Old Ruby Objects (POROs) (just provide: #id, #updated_at)
+# * supports locale
+# * recognizes subdomains
 # * 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
+# * filters params with proper non-utf8 data handling for key generation
+# * recognizes pagination via params (performs well for less than 100 objects per page)
+# * includes all params, not only GET's `query` params, which enables submitting of complex forms via POST,
+#   which - otherwise - would have query string longer than 2048 characters (Microsoft Internet Explorer)
+# * optional whitelist of first level parameters to prevent accidentally generating duplicated cache
+# * strips utm_* params
 # * optional suffix for:
 #     * expiry tags (unlike :expires_in cache option, this offers full :file_store storage compatibility)
 #     * any edge cases
@@ -35,12 +41,24 @@
 # 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
+  def cache_key_for(scoped_collection, collection_prefix, cache_owner_cache_key = '', suffix = '', whitelist_params = [])
+    max_updated_at = scoped_collection.to_a.map { |i| i.updated_at ? i.updated_at.utc.to_f : 0 }.max
     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}")
+    blacklist_params = ['utm_source', 'utm_medium', 'utm_term', 'utm_content', 'utm_campaign']
+    request_params = if request.params
+      if whitelist_params.empty?
+        request.params.reject { |k, _v| blacklist_params.include?(k.to_s) }
+      else
+        request.params.select { |k, _v| whitelist_params.include?(k.to_s) }
+      end.map { |k, v| [k.to_s.dup.force_encoding('UTF-8'), v.dup.to_s.force_encoding('UTF-8')] }
+    else
+      nil
+    end
+    digest = Digest::SHA1.hexdigest("#{ids_string}-#{max_updated_at}-#{count}-#{request.subdomains.join('.')}-#{request.path}-#{request_params}")
+    # puts "Caller: #{caller.first}"
+    # puts "generated cache key digest base: #{ids_string}-#{max_updated_at}-#{count}-#{request.subdomains.join('.')}-#{request.path}-#{request_params}"
+    # puts "generated cache key: #{I18n.locale}/#{collection_prefix}/#{digest}/#{cache_owner_cache_key}/#{suffix}"
     "#{I18n.locale}/#{collection_prefix}/#{digest}/#{cache_owner_cache_key}/#{suffix}"
   end
 end

data/lib/cache_key_for/cache_key_for_view_helper.rb

@@ -16,7 +16,7 @@
 # ```
 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, '')}"
+  def cache_key_for_view(file, scoped_collection, collection_prefix, cache_owner_cache_key = '', suffix = '', whitelist_params = [])
+    "#{cache_key_for(scoped_collection, collection_prefix, cache_owner_cache_key, suffix, whitelist_params)}#{file.gsub(Rails.root.to_s, '')}"
   end
 end

data/lib/cache_key_for/railtie.rb

@@ -2,11 +2,12 @@ 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|
+    initializer 'cache_key_for.helper' do
       ActionView::Base.send :include, CacheKeyForHelper
     end
-    initializer 'cache_key_for_view.helper' do |app|
+    initializer 'cache_key_for_view.helper' do
       ActionView::Base.send :include, CacheKeyForViewHelper
     end
   end

data/lib/cache_key_for/version.rb

@@ -1,3 +1,3 @@
 module CacheKeyFor
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/cache_key_for.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_key_for
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Marcin Kalita
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -52,6 +52,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.13
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: How to design a perfect cache key? This project's goal is to provide
   a bulletproof solution for most use cases.
 email: