cache_key_for 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0019a0a8e3f7265702688e55c5b340a129fcbde0
-  data.tar.gz: 5e2715145b399c3e161011e434d648b52d7594ff
+  metadata.gz: a75d030a404b2048b534fb95b9a34bff92bec378
+  data.tar.gz: 54d450d3ced6c78baadd1fc9a9c31e4d53bc9ce0
 SHA512:
-  metadata.gz: 97d765ebee9045c4f5df6ec07990d32cd7b4bf5e85b843833058656cf07b2bd6d20fb41b55ad37491deb1c15117eb9c5a2aada1b5bf6eb0ba590eb5d2c0dd218
-  data.tar.gz: 94e3e4fd81d0e0cd516a7a0d054a4d595a5cd0f77698a766b6981c5b08c90acbcf453dd5657742ff70cd70c3b374d6beda5f2ea884dcf409303570797aaf87c2
+  metadata.gz: 5a7e08df937897ff5aac575f39296b52e7496fed1fecf0b90f810487bd9953513e875e25f92ea338d116540bb90a7eb36723210c2f2c98a9e15ac7e8b2bcf01f
+  data.tar.gz: 86c4a91d17463bac1c8dc9e809d16e62204618278eb2b23abf0c7433573817e77aafc0e07d50e95e98d06e74e3b80b3b55f2d89a6e75ee81955af5e51be8351f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cache_key_for (0.1.9)
+    cache_key_for (0.1.10)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -21,6 +21,7 @@ Features:
 * 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.
 * filters params with proper non-utf8 data handling for key generation
+* supports paginated and not paginated collections or arrays of objects
 * recognizes pagination via params (performs well for less than 100 objects per page)
 * allows to set default page and per_page or sort order or any param in `default_params` to avoid multiple different default caches
 * includes all params, not only GET's `query` params, which enables submitting of complex forms via POST,

data/lib/cache_key_for/cache_key_for_helper.rb

@@ -6,6 +6,7 @@
 # * 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.
 # * filters params with proper non-utf8 data handling for key generation
+# * supports paginated and not paginated collections or arrays of objects
 # * recognizes pagination via params (performs well for less than 100 objects per page)
 # * allows to set default page and per_page or sort order or any param in `default_params` to avoid multiple different default caches
 # * includes all params, not only GET's `query` params, which enables submitting of complex forms via POST,
@@ -43,43 +44,51 @@
 # ```
 module CacheKeyForHelper
   def cache_key_for(scoped_collection, collection_prefix, cache_owner_cache_key = '', suffix = '', whitelist_params = [], default_params = {})
-    if scoped_collection.respond_to?(:maximum) # ActiveRecord
+    # 1) paginated scope - `maximum/max` database query on page(2) does not work
+    # 2) Array doesn't respond to `total_pages`
+    max_updated_at = if scoped_collection.respond_to?(:total_pages) || scoped_collection.class == Array
+      scoped_collection.to_a.map { |i| i.updated_at ? i.updated_at.utc.to_f : 0 }.max
+    elsif scoped_collection.respond_to?(:maximum) # not paginated ActiveRecord::Relation
       begin
-        max_updated_at = scoped_collection.maximum(scoped_collection.table_name + '.updated_at').to_f
+        scoped_collection.maximum(scoped_collection.table_name + '.updated_at').to_f
       # can't use join table as query root if query includes polimorphic associations
       rescue ActiveRecord::EagerLoadPolymorphicError
         Rails.logger.debug "[CacheKeyForHelper] Fallback to array (ActiveRecord::EagerLoadPolymorphicError)"
         scoped_collection = scoped_collection.to_a
-        max_updated_at = scoped_collection.to_a.map { |i| i.updated_at ? i.updated_at.utc.to_f : 0 }.max
+        scoped_collection.to_a.map { |i| i.updated_at ? i.updated_at.utc.to_f : 0 }.max
       end
-    elsif scoped_collection.class == Array
-      max_updated_at = scoped_collection.to_a.map { |i| i.updated_at ? i.updated_at.utc.to_f : 0 }.max
-    elsif scoped_collection.respond_to?(:max) # Mongoid
-      max_updated_at = scoped_collection.max(:updated_at).to_f
+    elsif scoped_collection.respond_to?(:max) # not paginated Mongoid::Criteria
+      scoped_collection.max(:updated_at).to_f
+    end
+    count = if scoped_collection.respond_to?(:total_count) # kaminari
+      scoped_collection.total_count
+    elsif scoped_collection.respond_to?(:total_entries) # will_paginate
+      scoped_collection.total_entries
+    else # Array or not paginated scope
+      scoped_collection.count
     end
-    count = scoped_collection.count
     if scoped_collection.respond_to?(:ids)
       ids_string = scoped_collection.ids
     else
       ids_string = scoped_collection.to_a.map(&:id).join('-')
     end
     blacklist_params = ['utm_source', 'utm_medium', 'utm_term', 'utm_content', 'utm_campaign']
-    request_params = if request.params
+    flat_request_params = if request.params
       if whitelist_params.empty?
-        default_params.merge(request.params).reject { |k, _v| blacklist_params.map(&:to_s).include?(k.to_s) }
+        default_params.stringify_keys.merge(request.params).reject { |k, _v| blacklist_params.map(&:to_s).include?(k) }
       else
-        default_params.merge(request.params).select { |k, _v| whitelist_params.map(&:to_s).include?(k.to_s) }
-      end.map do |k, v|
+        default_params.stringify_keys.merge(request.params).select { |k, _v| whitelist_params.map(&:to_s).include?(k) }
+      end.map { |k, v|
         # don't care about data type in the `v`, convert all to string
         [k.to_s.dup.force_encoding('UTF-8'), v.to_s.dup.force_encoding('UTF-8')]
-      end
+      }.to_h
     else
       nil
     end
-    digest = Digest::SHA1.hexdigest("#{ids_string}-#{max_updated_at}-#{count}-#{request.subdomains.join('.')}-#{request.path}-#{request_params}")
+    digest = Digest::SHA1.hexdigest("#{ids_string}-#{max_updated_at}-#{count}-#{request.subdomains.join('.')}-#{request.path}-#{flat_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}"
+    puts "generated cache key digest base: #{ids_string}-#{max_updated_at}-#{count}-#{request.subdomains.join('.')}-#{request.path}-#{flat_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/version.rb

@@ -1,3 +1,3 @@
 module CacheKeyFor
-  VERSION = '0.1.9'.freeze
+  VERSION = '0.1.10'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_key_for
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Marcin Kalita