readthis 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a07bacb5dfde0174d8c1bbb84f67f4a4fa110a78
-  data.tar.gz: e33d843547462b265a33333106f68b634e1d22fd
+  metadata.gz: ea629e7d22f58baa04359d6fabaee9116caf4e5d
+  data.tar.gz: ff5720742c337be8b178ca840064b3469766dcda
 SHA512:
-  metadata.gz: 4e50977ab026bfd2df4824b9da0d2ed043005ecd7dd6f747ba431516f6f09d888f51fa5f56619871f462b602e4d4c882e44ab39c80a98d9d0fed48943a97eae6
-  data.tar.gz: 800a1d90af2fb5a9edd694ae6cea7b319f6e47026394d8dd72fa407c0228766124786f7e22260637baac6a7f36ac4fb8249403c955f6b583334d4f47d823e682
+  metadata.gz: b75d0eb316bb68975693ab64044cc3c30159b9511dde446b504e1075b5c6aa915bc3782290334001de3b921173714343c86110778bc41ec90f67dc84b9ef0704
+  data.tar.gz: 765fae41b2f8d511cd99269e17ed31eacbb968239e97be78422a4b20793ae3325feefc2f19d411b6d0a17722a7b06bbba78230fe49e12c76e01edabb9fc93b43

data/.travis.yml

@@ -1,16 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.0.0
   - 2.1.0
   - 2.2.2
   - ruby-head
   - rbx-2
 matrix:
   allow_failures:
-    - rvm: 2.0.0
     - rvm: ruby-head
     - rvm: rbx-2
 services:
   - redis-server
 script: bin/rspec
+bundler_args: --without benchmarking

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## v0.8.1 2015-09-04
+
+- Changed: `Readthis::Cache` now has an accessor for the options that were
+  passed during initialization. This is primarily to support the session store
+  middleware provided by `ActionDispatch`. See [readthis#16][issue-16].
+- Fixed: Caching `nil` values is now possible. Previously the value would be
+  converted into a blank string, causing a Marshal error when loading the data.
+  There is still some non-standard handling of `nil` within `fetch` or
+  `fetch_multi`, where a cached `nil` value will always result in a cache miss.
+  See [readthis#15][issue-15].
+- Fixed: Entity compression was broken, it wouldn't unload data when the
+  compressed size was below the compression limit. Data is now decompressed
+  when it can the value looks to be compressed, falling back to the initial
+  value when decompression fails. See [readthis#13][issue-13] for details.
+
+[issue-13]: https://github.com/sorentwo/readthis/pull/13
+[issue-15]: https://github.com/sorentwo/readthis/pull/15
+[issue-16]: https://github.com/sorentwo/readthis/pull/16
+
 ## v0.8.0 2015-08-26
 
 - Breaking: The initializer now takes a single options argument instead of a

data/README.md

@@ -34,10 +34,11 @@ Use it the same way as any other [ActiveSupport::Cache::Store][store]. Within a
 Rails environment config:
 
 ```ruby
-config.cache_store = :readthis_store,
+config.cache_store = :readthis_store, {
   expires_in: 2.weeks.to_i,
   namespace: 'cache',
   redis: { url: ENV.fetch('REDIS_URL'), driver: :hiredis }
+}
 ```
 
 Otherwise you can use it anywhere, without any reliance on `ActiveSupport`:
@@ -89,9 +90,10 @@ means it is safe to enable or change compression with an existing cache. There
 will be a decoding performance penalty in this case, but it should be minor.
 
 ```ruby
-config.cache_store = :readthis_store,
+config.cache_store = :readthis_store, {
   compress: true,
   compression_threshold: 2.kilobytes
+}
 ```
 
 ### Marshalling
@@ -118,8 +120,12 @@ Readthis::Cache.new(marshal: Readthis::Passthrough)
 Readthis supports all of standard cache methods except for the following:
 
 * `cleanup` - Redis does this with TTL or LRU already.
-* `delete_matched` - You really don't want to perform key matching operations
-  in Redis. They are linear time and only support basic globbing.
+* `delete_matched` - You really don't want to perform key matching operations in
+  Redis. They are linear time and only support basic globbing.
+
+Like other `ActiveSupport::Cache` implementations it is possible to cache `nil`
+as a value. However, the fetch methods treat `nil` values as a cache miss and
+re-generate/re-cache the value. Caching `nil` isn't recommended.
 
 ## Contributing
 

data/benchmarks/compressed.rb

@@ -39,14 +39,16 @@ TEXT = <<-TEXT
   Caches can also store values in a compressed format to save space and reduce time spent sending data. Since there is overhead, values must be large enough to warrant compression. To turn on compression either pass compress: true in the initializer or as an option to fetch or write. To specify the threshold at which to compress values, set the :compress_threshold option. The default threshold is 16K.
 TEXT
 
-puts 'Compressed Writes:'
+puts 'Compressed Write/Read:'
 Benchmark.ips do |x|
-  x.report 'readthis:write' do
+  x.report 'readthis:write/read' do
     readthis.write(KEY, TEXT)
+    readthis.read(KEY)
   end
 
-  x.report 'dalli:write' do
+  x.report 'dalli:write/read' do
     dalli.write(KEY, TEXT)
+    dalli.read(KEY)
   end
 
   x.compare!

data/lib/readthis/cache.rb

@@ -7,7 +7,7 @@ require 'connection_pool'
 
 module Readthis
   class Cache
-    attr_reader :entity, :expires_in, :namespace, :pool
+    attr_reader :entity, :expires_in, :namespace, :options, :pool
 
     # Provide a class level lookup of the proper notifications module.
     # Instrumention is expected to occur within applications that have
@@ -39,6 +39,7 @@ module Readthis
     #   Readthis::Cache.new(compress: true, compression_threshold: 2048)
     #
     def initialize(options = {})
+      @options    = options
       @expires_in = options.fetch(:expires_in, nil)
       @namespace  = options.fetch(:namespace, nil)
 

data/lib/readthis/entity.rb

@@ -3,6 +3,7 @@ require 'zlib'
 module Readthis
   class Entity
     DEFAULT_THRESHOLD = 8 * 1024
+    MAGIC_BYTES = [120, 156].freeze
 
     attr_reader :marshal, :compression, :threshold
 
@@ -13,8 +14,6 @@ module Readthis
     end
 
     def dump(value)
-      return value if value.nil?
-
       if compress?(value)
         compress(value)
       else
@@ -23,9 +22,7 @@ module Readthis
     end
 
     def load(value)
-      return value if value.nil?
-
-      if compress?(value)
+      if compressed?(value)
         decompress(value)
       else
         marshal.load(value)
@@ -47,5 +44,9 @@ module Readthis
     def compress?(value)
       compression && value.bytesize >= threshold
     end
+
+    def compressed?(value)
+      compression && value[0, 2].unpack('CC') == MAGIC_BYTES
+    end
   end
 end

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/spec/readthis/cache_spec.rb

@@ -19,6 +19,12 @@ RSpec.describe Readthis::Cache do
 
       expect(cache.expires_in).to eq(10)
     end
+
+    it 'makes options available' do
+      cache = Readthis::Cache.new(namespace: 'cache', expires_in: 1)
+
+      expect(cache.options).to eq(namespace: 'cache', expires_in: 1)
+    end
   end
 
   describe '#pool' do

data/spec/readthis/entity_spec.rb

@@ -25,10 +25,24 @@ RSpec.describe Readthis::Entity do
       expect(entity.dump(string)).not_to eq(dumped)
     end
 
-    it 'does not dump nil values' do
+    it 'does not return compressed data when the size is below threshold' do
+      string = 'a' * 200
+      entity = Readthis::Entity.new(compress: true, threshold: 50)
+
+      expect(entity.load(entity.dump(string))).to eq(string)
+    end
+
+    it 'safely returns incorrectly deduced compressed data' do
+      string = [120, 156, 97, 98, 99].pack('CCCCC')
+      entity = Readthis::Entity.new(compress: true, threshold: 1)
+
+      expect(entity.load(string)).to eq(string)
+    end
+
+    it 'safely roundtrips nil values' do
       entity = Readthis::Entity.new
 
-      expect(entity.dump(nil)).to be_nil
+      expect(entity.load(entity.dump(nil))).to be_nil
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis