redis-rack-cache 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 210b9e2f356ff7088e1e6c6711cef5839e6a6e4109243b0b5af50d29aaa32dcb
-  data.tar.gz: 1fe0f9cbda577d2885ea9fa439c8661aa1675d49291678c06fc5a97da940b1d0
+  metadata.gz: a0ea6d51a29498f3273430e69a7bc21faed3005e1b63ad2fd74aa1284c78e2bd
+  data.tar.gz: abc94191628bbca9d30d321be2208479fa147505fa76e2621dca0ce7bd4bbee3
 SHA512:
-  metadata.gz: 10d99ab9139eb38fcbbe32c96d9ad6b0f6f350630d2847b800ded6bae986d9792215907a01b21c552eb180dbd646c2511a2bb14db157e00c04907c6f015e8900
-  data.tar.gz: d19c9586ba787a9da098433e9f44ad3e692c1de7e4408e819cd72571798da272a3833803ba44acb198a421d5ea6e9657c0d6ee499bde1b0a1fc591c4e719f031
+  metadata.gz: 9d8e45b79c1cb106b1eccbdd528372dda9b70bacad1af4c8535e97334048d55a1e7ed854484e3e8cddcecd5d1e673139eef080acd2e1a19659d4a1af12885184
+  data.tar.gz: '05139f20d2a6e70798a223bf00a3ad6f6d66496f60f768f2cd010a268cd1091be5f8ac504f9f160fcfe34b3cd118fd1cda925d57560ece3cd436a641d9062734'

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 script: bundle exec rake
 rvm:
-- 2.2
 - 2.3
 - 2.4
 - 2.5

data/Gemfile

@@ -5,3 +5,5 @@ git_source :github do |name|
   repo = name =~ %r{/} ? name : "#{name}/#{name}"
   "https://github.com/#{repo}.git"
 end
+
+gem 'snappy'

data/README.md

@@ -60,6 +60,52 @@ use Rack::Cache,
   entitystore: 'redis://localhost:6380/0/entitystore'
 ```
 
+### Compression
+
+`Redis::Rack::Cache` supports data compression for entities over 1K when
+transmitting back and forth over the wire to your Redis server.
+Compressing data can improve bandwidth usage as well as RAM/storage
+consumption, and is recommended if you operate a large-scale Rails
+application.
+
+To enable this feature, pass the `:compress` option when configuring
+`Rack::Cache`:
+
+```ruby
+Rails.application.configure do
+  config.action_dispatch.rack_cache = {
+    metastore: "#{Rails.credentials.redis_url}/1",
+    entitystore: "#{Rails.credentials.redis_url}/2",
+    compress: true
+  }
+end
+```
+
+If compression is turned on, but no driver has been selected,
+`Redis::Rack::Cache` will use Ruby's internal **ZLib** integrations and
+compress entities with GZip. You can specify `:deflate` if you want to
+use the deflate algorithm, `:gzip` if you want to be specific about it,
+or a custom object that responds to `.deflate(data)` and
+`.inflate(data)` to compress/decompress data, respectively. For example,
+you can use Google's [Snappy](http://google.github.io/snappy/) for
+[ludicrous-speed](https://www.youtube.com/watch?v=ygE01sOhzz0)
+compression and decompression like this:
+
+```ruby
+Rails.application.configure do
+  config.action_dispatch.rack_cache = {
+    metastore: "#{Rails.credentials.redis_url}/1",
+    entitystore: "#{Rails.credentials.redis_url}/2",
+    compress: Snappy
+  }
+end
+```
+
+**NOTE:** Since metadata would have to be marshalled before compression
+in order to rehydrate it back into an object, only data stored in the
+EntityStore is compressed for now. We'd love your feedback though,
+let us know if there's a good use case for MetaStore compression!
+
 ## Development
 
 First, get the project set up on your local machine:
@@ -70,7 +116,7 @@ cd redis-rack-cache
 bundle install
 ```
 
-You can run the following command to execute the test suite:
+You can run the following command to run the test suite:
 
 ```bash
 bundle exec rake test

data/gemfiles/rack_cache_1.6.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "snappy"
 gem "rack-cache", "~> 1.6"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rack_cache_1.7.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "snappy"
 gem "rack-cache", "~> 1.7"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/rack/cache/redis_base.rb

@@ -1,4 +1,5 @@
 require 'rack/utils'
+require 'rack/cache/options'
 
 module Rack
   module Cache
@@ -10,6 +11,8 @@ module Rack
 
           attr_reader :cache, :options, :default_ttl
         end
+
+        Rack::Cache::Options.option_accessor :compress
       end
 
       module ClassMethods

data/lib/rack/cache/redis_entitystore.rb

@@ -1,11 +1,15 @@
 require 'rack/cache/entity_store'
 require 'redis-rack-cache/constants'
 require 'rack/cache/redis_base'
+require 'zlib'
+require 'zlib/gzip_compression'
 
 module Rack
   module Cache
     class EntityStore
       class Redis < self
+        MINIMUM_COMPRESSION_BYTESIZE = 1_000
+
         include RedisBase
 
         def exist?(key)
@@ -13,15 +17,21 @@ module Rack
         end
 
         def read(key)
-          cache.get key
+          raw = cache.get(key)
+
+          return if raw.nil?
+
+          decompress(raw).force_encoding('utf-8')
         end
 
         def write(body, ttl=0)
           buf = StringIO.new
           key, size = slurp(body) {|part| buf.write(part) }
           ttl = ttl.to_i.zero? ? default_ttl : ttl
+          value = compress(buf.string)
+
+          return unless cache.setex(key, ttl, value)
 
-          return unless cache.setex(key, ttl, buf.string)
           [key, size]
         end
 
@@ -29,6 +39,54 @@ module Rack
           cache.del key
           nil
         end
+
+        protected
+
+        def compress(data)
+          return data unless compress? data
+
+          deflater.deflate(data)
+        end
+
+        def decompress(data)
+          return data unless compress?
+
+          inflater.inflate(data) rescue data
+        end
+
+        private
+
+        def deflater
+          case options[:compress]
+          when :deflate
+            Zlib::Deflate
+          when :gzip, true
+            Zlib::GzipCompression
+          when false
+            nil
+          else
+            options[:compress]
+          end
+        end
+
+        def inflater
+          case options[:compress]
+          when :deflate
+            Zlib::Inflate
+          when :gzip, true
+            Zlib::GzipCompression
+          when false
+            nil
+          else
+            options[:compress]
+          end
+        end
+
+        def compress?(data = nil)
+          return options[:compress] if data.nil?
+
+          options[:compress] && data.bytesize >= MINIMUM_COMPRESSION_BYTESIZE
+        end
       end
 
       REDIS = REDISS = Redis

data/lib/redis-rack-cache.rb

@@ -2,4 +2,4 @@ require 'redis-store'
 require 'rack/cache'
 require 'rack/cache/redis_entitystore'
 require 'rack/cache/redis_metastore'
-require 'redis-rack-cache/version'
+require 'redis-rack-cache/version'

data/lib/redis-rack-cache/version.rb

@@ -1,7 +1,7 @@
 class Redis
   module Rack
     module Cache
-      VERSION = '2.1.2'
+      VERSION = '2.2.0'
     end
   end
 end

data/lib/zlib/gzip_compression.rb

@@ -0,0 +1,32 @@
+module Zlib
+  # Compress data over the wire to Redis with GZip. This code was mostly
+  # stolen from `Dalli::GzipCompressor`.
+  #
+  # https://github.com/petergoldstein/dalli/blob/master/lib/dalli/compressor.rb
+  module GzipCompression
+    # Compress the given data with GZip.
+    #
+    # @param [String] data - Uncompressed data.
+    # @return [String]
+    def self.deflate(data)
+      io = StringIO.new(String.new(""), "w")
+      gz = Zlib::GzipWriter.new(io)
+
+      gz.write(data)
+      gz.close
+
+      io.string
+    end
+
+    # Decompress the given data with GZip.
+    #
+    # @param [String] data - Compressed data.
+    # @return [String] Decompressed data.
+    def self.inflate(data)
+      io = StringIO.new(data, "rb")
+      gz = Zlib::GzipReader.new(io)
+
+      gz.read
+    end
+  end
+end

data/redis-rack-cache.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |s|
   s.executables = []
 
   s.add_dependency 'redis-store', '>= 1.6', '< 2'
-  s.add_dependency 'rack-cache',  '>= 1.6', '< 2'
+  s.add_dependency 'rack-cache',  '>= 1.10', '< 2'
 
   s.add_development_dependency 'rake',     '~> 10'
   s.add_development_dependency 'bundler', '> 1', '< 3'
   s.add_development_dependency 'mocha',    '~> 0.14.0'
-  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'minitest', '~> 5.11.0'
   s.add_development_dependency 'redis-store-testing', '~> 0'
   s.add_development_dependency 'appraisal', '~> 2'
 end

data/test/fixtures/lorem.txt

@@ -0,0 +1,99 @@
+Hic voluptatem unde. Eligendi soluta quia. Odit vel sed.
+Iste veritatis debitis. Sunt vel quia. Nisi nemo quaerat.
+Reprehenderit omnis et. Qui nemo suscipit. Officia consequatur dolor.
+Et consequatur optio. Est expedita enim. Assumenda eveniet quam.
+Explicabo expedita aut. Ea dolor ipsa. Omnis odit aut.
+Est veniam molestiae. Porro ut nobis. Nisi eum nihil.
+Neque non consequatur. Facere est libero. Consequuntur harum magni.
+Accusantium iste esse. Reprehenderit doloribus odio. Cupiditate enim quis.
+Provident perferendis adipisci. Sed nam fugit. Voluptate praesentium rerum.
+Aut hic voluptas. Totam dolor ipsum. Neque vel debitis.
+Cumque est animi. Molestiae praesentium dolor. Occaecati voluptates distinctio.
+Omnis est non. Vel repellat enim. Et saepe tempora.
+Dolor delectus veniam. Nostrum et laborum. Quod maiores reprehenderit.
+Architecto optio debitis. Non eos repellat. Aut perspiciatis quos.
+In voluptate voluptas. Est unde expedita. Est eum aut.
+Voluptas deserunt illo. Laudantium nisi quia. Possimus accusamus aspernatur.
+Accusamus maxime id. Rerum iste reprehenderit. Voluptatem tenetur totam.
+Id aperiam ut. Tenetur sed nesciunt. Veritatis rerum neque.
+Nam odio dolorum. Ipsum atque voluptatem. Fuga molestiae culpa.
+Dicta esse harum. Id error autem. Pariatur autem quidem.
+Eum sit qui. Voluptate hic minus. Voluptatem nisi cumque.
+Est aut autem. In a quidem. Corporis illum sit.
+Suscipit tenetur hic. Ipsa adipisci repellendus. Alias nesciunt veritatis.
+Doloribus facilis repellat. Maiores alias voluptas. Officia et aut.
+Qui ut sequi. Odit quas maiores. Qui doloribus tempore.
+Illum aut sequi. Pariatur iusto placeat. Impedit ratione consequatur.
+Odit inventore tenetur. Ea quasi assumenda. Quo sapiente mollitia.
+Explicabo minima aperiam. Maiores voluptas aut. Ut in sed.
+Optio modi temporibus. Quia aliquid accusantium. Animi commodi dolore.
+Cum voluptatem saepe. Commodi dolorum perspiciatis. Porro et molestias.
+Molestiae maxime rerum. Labore magnam porro. Est harum nam.
+Voluptatem ex omnis. Dolorum ut consectetur. Dicta provident velit.
+Commodi corporis ex. Libero recusandae expedita. Ut natus laborum.
+Quae qui saepe. Quas recusandae voluptatem. Eum est est.
+Laborum neque ut. Eos id pariatur. Eum ipsa qui.
+Eveniet quo et. Aut quaerat velit. Maxime est aut.
+A est soluta. Rerum sint recusandae. Voluptas dolorum asperiores.
+Veritatis voluptas expedita. Non aut maiores. Mollitia dicta tempore.
+Deleniti nam animi. Velit quae aut. Atque totam amet.
+Ullam et dolor. Soluta aut voluptas. Eos et commodi.
+Molestias asperiores placeat. Culpa sed magni. Minima aliquam quisquam.
+Vel debitis perferendis. Voluptates incidunt non. Deserunt iusto aut.
+Aut laboriosam voluptatem. Dolor nihil ea. Ratione praesentium beatae.
+Officiis consequuntur qui. Corporis voluptas repellat. Porro minima officiis.
+Dicta alias quos. Quos porro voluptates. Aut rem ut.
+Ullam illo dolore. Magnam tempora corporis. Voluptatem assumenda nemo.
+Quo inventore qui. Cumque eos facilis. Aut ab maiores.
+Ipsa quia voluptatem. Magni nulla earum. Error vel iste.
+Debitis eum quia. Placeat maiores iste. Vero ex iusto.
+Fugit beatae quia. Omnis animi minima. Dolor iste error.
+Provident quod occaecati. Voluptatem dicta possimus. Sunt commodi est.
+Quasi in facere. Molestias omnis qui. Perspiciatis ipsa eum.
+Veniam culpa sit. Molestiae quia cupiditate. Alias molestiae laborum.
+Odit esse exercitationem. Magni accusantium qui. Autem odio corrupti.
+Qui minus consequatur. Necessitatibus fugit voluptatum. Quia a sint.
+Non quibusdam sed. Nihil dolor quo. Est consequatur perspiciatis.
+Rerum rem expedita. Ab consectetur eos. Similique facere et.
+Dolor autem natus. Ipsam illo eius. Sint tenetur corporis.
+A ut aut. Odio sit esse. Unde dolores iste.
+Quidem sed provident. Unde sint sunt. Quos praesentium cum.
+Perferendis atque odio. Et quasi dolor. Et et facere.
+Sunt praesentium aut. Rerum at optio. Totam iste et.
+Natus ad vero. Autem dolores architecto. Ipsam eaque voluptatem.
+In quaerat porro. Autem quos qui. Sit sint voluptas.
+Sapiente omnis eos. Similique fuga minus. Dolore est id.
+Inventore ea doloribus. Minima laboriosam adipisci. Ipsa voluptas aut.
+Non cumque temporibus. Aut deleniti aperiam. Blanditiis delectus dolorem.
+Delectus perferendis consequatur. Vel quos reprehenderit. Delectus non et.
+Voluptates et atque. Excepturi voluptates cumque. Nam quas non.
+Quia incidunt expedita. Itaque officiis necessitatibus. Sit nostrum perferendis.
+Sed quibusdam consectetur. Reprehenderit nam qui. Hic rerum aperiam.
+Praesentium quasi eaque. Reprehenderit temporibus dolor. Officia a quo.
+Non porro cum. Provident repellendus dolore. Saepe commodi aut.
+Placeat aut sunt. Illo et porro. Ea maiores quis.
+Totam expedita assumenda. Dolorum voluptatibus iusto. Doloremque iste dolorem.
+Ut corrupti eaque. Impedit tenetur eius. Voluptate id quia.
+Laborum velit non. Et reprehenderit qui. Animi dicta voluptate.
+Non quia quis. Minima id voluptas. Velit nihil sit.
+Dolor praesentium eum. Tempora ullam repudiandae. At nihil harum.
+Magni voluptatem sit. Harum et iure. Iure et voluptatem.
+Architecto dignissimos quas. Et tenetur sint. Omnis recusandae aspernatur.
+Et earum voluptatem. Temporibus possimus non. Id odio iusto.
+Delectus cupiditate voluptatem. Sed expedita perferendis. Repudiandae qui iusto.
+Doloremque totam ut. Aliquam maiores excepturi. Eius suscipit assumenda.
+Quo aliquid sint. At impedit accusamus. Commodi et enim.
+Pariatur iure optio. Corrupti nihil beatae. Unde consectetur quo.
+Dolores et doloremque. Ut mollitia magnam. Omnis eius nihil.
+Qui similique beatae. Rem quo pariatur. Earum perferendis vitae.
+Qui nulla eum. Consequatur aut enim. Reiciendis earum aliquam.
+Incidunt voluptas est. Nemo magnam recusandae. Eos placeat debitis.
+Aliquam qui aut. Quo est cupiditate. Et nobis est.
+Iusto omnis eos. Illo voluptatem excepturi. Quae velit a.
+Consequatur inventore qui. Sapiente totam dicta. Molestiae accusamus autem.
+Neque provident laudantium. Ut minus est. Veritatis enim et.
+Vel et in. Consequatur deleniti aut. Cupiditate et non.
+Eos fugiat veniam. Consequatur pariatur et. Sed occaecati et.
+Quia quasi quis. Aut repudiandae amet. Ut rerum dignissimos.
+Sed saepe quis. Ipsa a repellat. Consequatur assumenda modi.
+Velit cupiditate corrupti. Et commodi ducimus. Occaecati repudiandae velit.

data/test/rack/cache/entitystore/redis_test.rb

@@ -9,6 +9,56 @@ end
 describe Rack::Cache::EntityStore::Redis do
   before do
     @store = ::Rack::Cache::EntityStore::Redis.new :host => 'localhost'
+    @body = File.read('test/fixtures/lorem.txt')
+  end
+
+  it 'stores raw data by default' do
+    key, _size = @store.write [@body]
+
+    key.wont_be_nil
+    @store.read(key).must_equal(@body)
+  end
+
+  it 'compresses data with deflate' do
+    @store.options[:compress] = :deflate
+    key, _size = @store.write [@body]
+
+    key.wont_be_nil
+    @store.read(key).must_equal(@body)
+  end
+
+  it 'compresses data with gzip' do
+    @store.options[:compress] = :gzip
+    key, _size = @store.write [@body]
+
+    key.wont_be_nil
+
+    @store.options[:compress] = true
+
+    @store.read(key).must_equal(@body)
+  end
+
+  it 'compresses data with custom tool' do
+    @store.options[:compress] = Snappy
+    key, _size = @store.write [@body]
+
+    key.wont_be_nil
+    @store.read(key).must_equal(@body)
+  end
+
+  it 'handles existing non-compressed data' do
+    @store.options[:compress] = true
+    key, _size = @store.send(:slurp, [@body]) {}
+
+    @store.cache.setex(key, 120, @body).must_equal('OK')
+    @store.read(key).must_equal(@body)
+
+    @store.options[:compress] = Snappy
+
+    key, _size = @store.send(:slurp, [@body]) {}
+
+    @store.cache.setex(key, 120, @body).must_equal('OK')
+    @store.read(key).must_equal(@body)
   end
 
   it 'respects the default_tll options' do
@@ -18,7 +68,7 @@ describe Rack::Cache::EntityStore::Redis do
 
   it 'properly delegates the TTL to redis' do
     @store = ::Rack::Cache::EntityStore::Redis.new({ :host => 'localhost' }, { :default_ttl => 120 })
-    key, size = @store.write(['She rode to the devil,'])
+    key, _size = @store.write(['She rode to the devil,'])
     assert @store.cache.ttl(key) <= 120
   end
 
@@ -56,7 +106,7 @@ describe Rack::Cache::EntityStore::Redis do
   end
 
   it 'stores bodies with #write' do
-    key, size = @store.write(['My wild love went riding,'])
+    key, _size = @store.write(['My wild love went riding,'])
     key.wont_be_nil
     key.must_be :sha_like?
 
@@ -65,7 +115,7 @@ describe Rack::Cache::EntityStore::Redis do
   end
 
   it 'takes a ttl parameter for #write' do
-    key, size = @store.write(['My wild love went riding,'], 0)
+    key, _size = @store.write(['My wild love went riding,'], 0)
     key.wont_be_nil
     key.must_be :sha_like?
 
@@ -74,19 +124,19 @@ describe Rack::Cache::EntityStore::Redis do
   end
 
   it 'correctly determines whether cached body exists for key with #exist?' do
-    key, size = @store.write(['She rode to the devil,'])
+    key, _size = @store.write(['She rode to the devil,'])
     assert @store.exist?(key)
     assert ! @store.exist?('938jasddj83jasdh4438021ksdfjsdfjsdsf')
   end
 
   it 'can read data written with #write' do
-    key, size = @store.write(['And asked him to pay.'])
+    key, _size = @store.write(['And asked him to pay.'])
     data = @store.read(key)
     data.must_equal('And asked him to pay.')
   end
 
   it 'gives a 40 character SHA1 hex digest from #write' do
-    key, size = @store.write(['she rode to the sea;'])
+    key, _size = @store.write(['she rode to the sea;'])
     key.wont_be_nil
     key.length.must_equal(40)
     key.must_match(/^[0-9a-z]+$/)
@@ -94,7 +144,7 @@ describe Rack::Cache::EntityStore::Redis do
   end
 
   it 'returns the entire body as a String from #read' do
-    key, size = @store.write(['She gathered together'])
+    key, _size = @store.write(['She gathered together'])
     @store.read(key).must_equal('She gathered together')
   end
 
@@ -103,7 +153,7 @@ describe Rack::Cache::EntityStore::Redis do
   end
 
   it 'returns a Rack compatible body from #open' do
-    key, size = @store.write(['Some shells for her hair.'])
+    key, _size = @store.write(['Some shells for her hair.'])
     body = @store.open(key)
     body.must_respond_to :each
     buf = ''
@@ -118,7 +168,7 @@ describe Rack::Cache::EntityStore::Redis do
   if RUBY_VERSION < '1.9'
     it 'can store largish bodies with binary data' do
       pony = File.open(File.dirname(__FILE__) + '/pony.jpg', 'rb') { |f| f.read }
-      key, size = @store.write([pony])
+      key, _size = @store.write([pony])
       key.must_equal('d0f30d8659b4d268c5c64385d9790024c2d78deb')
       data = @store.read(key)
       data.length.must_equal(pony.length)
@@ -127,7 +177,7 @@ describe Rack::Cache::EntityStore::Redis do
   end
 
   it 'deletes stored entries with #purge' do
-    key, size = @store.write(['My wild love went riding,'])
+    key, _size = @store.write(['My wild love went riding,'])
     @store.purge(key).must_be_nil
     @store.read(key).must_be_nil
   end

data/test/test_helper.rb

@@ -2,3 +2,4 @@ require 'bundler/setup'
 require 'minitest/autorun'
 require 'mocha/setup'
 require 'redis-rack-cache'
+require 'snappy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-rack-cache
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-18 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-store
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -104,14 +104,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 5.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 5.11.0
 - !ruby/object:Gem::Dependency
   name: redis-store-testing
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,9 @@ files:
 - lib/redis-rack-cache.rb
 - lib/redis-rack-cache/constants.rb
 - lib/redis-rack-cache/version.rb
+- lib/zlib/gzip_compression.rb
 - redis-rack-cache.gemspec
+- test/fixtures/lorem.txt
 - test/rack/cache/entitystore/pony.jpg
 - test/rack/cache/entitystore/redis_test.rb
 - test/rack/cache/metastore/redis_test.rb