rack-cache 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3812540d0f5bbe2e962a141bfec32689f6fd91eba903f450bacca8b7ba3ac8e
-  data.tar.gz: e688349a29392080fdf0e906f262675bff93af5831336370ef5a2b88aa5838ac
+  metadata.gz: 7e2ca34b16edeb06ab8ce7df32ad78b273b600cd950ce3b56d03b898bf00e53f
+  data.tar.gz: 5d35c87987859feb36e5f24b3b065ac790c6dc4f3df0969e41aaa6f15819ab94
 SHA512:
-  metadata.gz: f411e9b9678e5e3d4c80623a0d2bede18b2f024ed9e8d7e9d78e114f3fb69278f46ca2cf2281e9ca7260a4a4f3c6225f8ebbc8116aabb5ffa4b2ba8e6ceb6d20
-  data.tar.gz: 51105145c2d3fb9c9106bb77e71254f002e416a0978f1a0d788e674ba73ba87645c387c86b875b4c7973ba32f6a1cb89f35e8c1102904e1258d3f91060a929e0
+  metadata.gz: 1d156a65178883329c11d00024f60af8d013cd4fe2a3def6d930c43d822c76dd1bd9b6d26d965209fbfdc038e79cff96a5efd973deadace39e0b83097c332ec5
+  data.tar.gz: 9a3b6fdc70f24de95a8cc02d3d9180c5c59f277156605ddca2b295e56542f81b0433fb8da279d0f337d49d4352e0e2500be4a468fc75a61c5b13eadccf1b3cc7

data/CHANGES

@@ -1,3 +1,12 @@
+## 1.11.0
+
+ * Add a proc to allow ignoring parts of the query string in the key
+
+## 1.10.0
+
+  * Pass Options To Underlying Storage Driver
+  * bump required ruby version to 2.3
+
 ## 1.9.0
 
   * make purge not raise when not implemented

data/README.md

@@ -97,7 +97,7 @@ Does not persist response bodies (no disk/memory used).<br/>
 Responses from the cache will have an empty body.<br/>
 Clients must ignore these empty cached response (check for X-Rack-Cache response header).<br/>
 Atm cannot handle streamed responses, patch needed.
- 
+
 ```Ruby
 require 'rack/cache'
 
@@ -109,6 +109,18 @@ use Rack::Cache,
 run app
 ```
 
+Ignoring tracking parameters in cache keys
+-----------------
+
+It's fairly common to include tracking parameters which don't affect the content
+of the page. Since Rack::Cache uses the full URL as part of the cache key, this
+can cause unneeded churn in your cache. If you're using the default key class
+`Rack::Cache::Key`, you can configure a proc to ignore certain keys/values like
+so:
+
+```Ruby
+Rack::Cache::Key.query_string_ignore = proc { |k, v| k =~ /^(trk|utm)_/ }
+```
+
 License: MIT<br/>
 [![Build Status](https://travis-ci.org/rtomayko/rack-cache.svg)](https://travis-ci.org/rtomayko/rack-cache)
-

data/lib/rack/cache/key.rb

@@ -4,6 +4,21 @@ module Rack::Cache
   class Key
     include Rack::Utils
 
+    # A proc for ignoring parts of query strings when generating a key. This is
+    # useful when you have parameters like `utm` or `trk` that don't affect the
+    # content on the page and are unique per-visitor or campaign. Parameters
+    # like these will be part of the key and cause a lot of churn.
+    #
+    # The block will be passed a key and value which are the name and value of
+    # that parameter.
+    #
+    # Example:
+    #   `Rack::Cache::Key.query_string_ignore = proc { |k, v| k =~ /^(trk|utm)_/ }`
+    #
+    class << self
+      attr_accessor :query_string_ignore
+    end
+
     # Implement .call, since it seems like the "Rack-y" thing to do. Plus, it
     # opens the door for cache key generators to just be blocks.
     def self.call(request)
@@ -42,11 +57,12 @@ module Rack::Cache
     def query_string
       return nil if @request.query_string.to_s.empty?
 
-      @request.query_string.split(/[&;] */n).
-        map { |p| p.split('=', 2).map{ |s| unescape(s) } }.
-        sort.
-        map { |k,v| "#{escape(k)}=#{escape(v)}" }.
-        join('&')
+      parts = @request.query_string.split(/[&;] */n)
+      parts.map! { |p| p.split('=', 2).map!{ |s| unescape(s) } }
+      parts.sort!
+      parts.reject!(&self.class.query_string_ignore)
+      parts.map! { |k,v| "#{escape(k)}=#{escape(v)}" }
+      parts.join('&')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-cache
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack