readthis 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5a03b37918d41dfd0e30151cb3049638df50aa8
-  data.tar.gz: 9c80690714866bc6992eafa9c137e785cf72a88d
+  metadata.gz: d1763594017ac9b87a099ca476d01c9f3823a0b0
+  data.tar.gz: 23e9363a5cc0c997c70f923f0ea21c50477843ff
 SHA512:
-  metadata.gz: 9297ce7d8525ecdc2715399b3b657fb3cc12e581e4e9d067d762f7e9a134ffe6a35e48f6867bf7a26902f5dc48b6106e5c6dd012bc5e16372ad1b715fa6faa60
-  data.tar.gz: d431742cd9f908aabdd06dfeaab2ed99b7165158fff51c57c947d9857d336e2a5c82fe42edae15a41c7cdd8043b3fc950c09e6fd60feb4d69c571fb71e2fe6e3
+  metadata.gz: 0c3868ec4afab92154c4a9bc542de628224086760a6c8c5275d9ba83ede290b4800f209eb3c3b5349d11cd2f2f63e0aa5858e587308ac9d2988ecc6a35989511
+  data.tar.gz: 3ffd2cc9546da805453a27d5ca33a4a35525582eb7905973a45293e4093ed47c70ebe37b4e3fb8f16035074cb558de08e271b2de712b8f52e237a8f386db9ca3

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v0.5.0 2014-12-12
+
+- Added: All read and write operations are marshalled to and from storage. This
+  allows hashes, arrays, etc. to be restored instead of always returning a
+  string. Unlike `ActiveSupport::Store::Entity`, no new objects are allocated
+  for each entity, reducing GC and improving performance.
+- Fixed: Increment/Decrement interface was only accepting two params instead of
+  three. Now accepts `amount` as the second parameter.
+- Changed: Increment/Decrement no longer use `incby` and `decby`, as they don't
+  work with marshalled values. This means they are not entirely atomic, so race
+  conditions are possible.
+
 ## v0.4.0 2014-12-11
 
 - Added: Force the use of `hiredis` as the adapter. It is dramatically faster,

data/Gemfile

@@ -2,8 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'coveralls', require: false
+
 group :benchmarking do
   gem 'benchmark-ips'
   gem 'dalli'
+  gem 'oj'
   gem 'redis-activesupport', github: 'sorentwo/redis-activesupport'
 end

data/PERFORMANCE.md

@@ -19,55 +19,55 @@ Performance compared to `dalli` and `redis-activesupport`:
 ```
 Raw Read Multi:
 Calculating -------------------------------------
- readthis:read-multi   500.000  i/100ms
-  redisas:read-multi    95.000  i/100ms
-    dalli:read-multi    97.000  i/100ms
+ readthis:read-multi   358.000  i/100ms
+  redisas:read-multi    94.000  i/100ms
+    dalli:read-multi    99.000  i/100ms
 -------------------------------------------------
- readthis:read-multi      5.286k (± 2.7%) i/s -     26.500k
-  redisas:read-multi    959.405  (± 4.2%) i/s -      4.845k
-    dalli:read-multi    978.803  (± 2.1%) i/s -      4.947k
+ readthis:read-multi      3.800k (± 2.3%) i/s -     19.332k
+  redisas:read-multi    962.199  (± 3.6%) i/s -      4.888k
+    dalli:read-multi    995.353  (± 1.1%) i/s -      5.049k
 
 Comparison:
- readthis:read-multi:     5286.0 i/s
-    dalli:read-multi:      978.8 i/s - 5.40x slower
-  redisas:read-multi:      959.4 i/s - 5.51x slower
+ readthis:read-multi:     3799.8 i/s
+    dalli:read-multi:      995.4 i/s - 3.82x slower
+  redisas:read-multi:      962.2 i/s - 3.95x slower
 
 Raw Fetch Multi:
 Calculating -------------------------------------
-readthis:fetch-multi   448.000  i/100ms
- redisas:fetch-multi    84.000  i/100ms
-   dalli:fetch-multi    99.000  i/100ms
+readthis:fetch-multi   336.000  i/100ms
+ redisas:fetch-multi    86.000  i/100ms
+   dalli:fetch-multi   102.000  i/100ms
 -------------------------------------------------
-readthis:fetch-multi      4.682k (± 2.4%) i/s -     23.744k
- redisas:fetch-multi    848.101  (± 3.2%) i/s -      4.284k
-   dalli:fetch-multi      1.006k (± 2.4%) i/s -      5.049k
+readthis:fetch-multi      3.424k (± 2.6%) i/s -     17.136k
+ redisas:fetch-multi    874.803  (± 2.7%) i/s -      4.386k
+   dalli:fetch-multi      1.028k (± 1.2%) i/s -      5.202k
 
 Comparison:
-readthis:fetch-multi:     4682.4 i/s
-   dalli:fetch-multi:     1005.6 i/s - 4.66x slower
- redisas:fetch-multi:      848.1 i/s - 5.52x slower
+readthis:fetch-multi:     3424.2 i/s
+   dalli:fetch-multi:     1027.7 i/s - 3.33x slower
+ redisas:fetch-multi:      874.8 i/s - 3.91x slower
 
 Compressed Writes:
 Calculating -------------------------------------
-      readthis:write     1.003k i/100ms
-         dalli:write   913.000  i/100ms
+      readthis:write   924.000  i/100ms
+         dalli:write   903.000  i/100ms
 -------------------------------------------------
-      readthis:write     11.095k (± 5.7%) i/s -     56.168k
-         dalli:write      9.829k (± 1.8%) i/s -     49.302k
+      readthis:write     10.105k (± 4.9%) i/s -     50.820k
+         dalli:write      9.662k (± 1.6%) i/s -     48.762k
 
 Comparison:
-      readthis:write:    11095.5 i/s
-         dalli:write:     9828.8 i/s - 1.13x slower
+      readthis:write:    10105.3 i/s
+         dalli:write:     9662.4 i/s - 1.05x slower
 
 Compressed Read Multi:
 Calculating -------------------------------------
- readthis:read_multi   446.000  i/100ms
-    dalli:read_multi    97.000  i/100ms
+ readthis:read_multi   325.000  i/100ms
+    dalli:read_multi   100.000  i/100ms
 -------------------------------------------------
- readthis:read_multi      4.728k (± 4.6%) i/s -     23.638k
-    dalli:read_multi    985.986  (± 3.9%) i/s -      4.947k
+ readthis:read_multi      3.357k (± 2.3%) i/s -     16.900k
+    dalli:read_multi      1.014k (± 3.1%) i/s -      5.100k
 
 Comparison:
- readthis:read_multi:     4728.3 i/s
-    dalli:read_multi:      986.0 i/s - 4.80x slower
+ readthis:read_multi:     3356.5 i/s
+    dalli:read_multi:     1014.1 i/s - 3.31x slower
 ```

data/README.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/readthis.svg)](http://badge.fury.io/rb/readthis)
 [![Build Status](https://travis-ci.org/sorentwo/readthis.svg?branch=master)](https://travis-ci.org/sorentwo/readthis)
 [![Code Climate](https://codeclimate.com/github/sorentwo/readthis/badges/gpa.svg)](https://codeclimate.com/github/sorentwo/readthis)
+[![Coverage Status](https://img.shields.io/coveralls/sorentwo/readthis.svg)](https://coveralls.io/r/sorentwo/readthis?branch=master)
 
 # Readthis
 
@@ -13,7 +14,7 @@ behavior for `fetch_multi`.
 
 ## Footprint & Performance
 
-See [Performance][PERFORMANCE.md]
+See [Performance](PERFORMANCE.md)
 
 ## Installation
 
@@ -51,6 +52,8 @@ redis database, which defaults to 0. For example, using database 2:
 REDIS_URL=redis://localhost:6379/2
 ```
 
+### Compression
+
 Compression can be enabled for all actions by passing the `compress` flag. By
 default all values greater than 1024k will be compressed automatically. If there
 is any content has not been stored with compression, or perhaps was compressed
@@ -65,6 +68,24 @@ config.cache_store = :readthis_store, ENV.fetch('REDIS_URL'), {
 }
 ```
 
+### Marshalling
+
+Readthis uses Ruby's `Marshal` module for dumping and loading all values by
+default. This isn't always the fastest option, depending on your use case it may
+be desirable to use a faster but more flexible marshaller.
+
+Use Oj for JSON marshalling, extremely fast, limited types:
+
+```ruby
+Readthis::Cache.new(marshal: Oj)
+```
+
+If you don't mind everything being a string then use the Passthrough marshal:
+
+```ruby
+Readthis::Cache.new(marshal: Readthis::Passthrough)
+```
+
 ## Differences
 
 Readthis supports all of standard cache methods except for the following:

data/benchmarks/marshalling.rb

@@ -0,0 +1,37 @@
+require 'bundler'
+
+Bundler.setup
+
+require 'benchmark/ips'
+require 'json'
+require 'oj'
+require 'readthis'
+require 'readthis/passthrough'
+
+REDIS_URL = 'redis://localhost:6379/11'
+OPTIONS   = { compressed: false }
+
+readthis_pass = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: Readthis::Passthrough))
+readthis_oj   = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: Oj))
+readthis_json = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: JSON))
+readthis_ruby = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: Marshal))
+
+HASH = ('a'..'z').each_with_object({}) { |key, memo| memo[key] = key }
+
+Benchmark.ips do |x|
+  x.report('pass:hash:dump') { readthis_oj.write('pass',   HASH) }
+  x.report('oj:hash:dump')   { readthis_oj.write('oj',     HASH) }
+  x.report('json:hash:dump') { readthis_json.write('json', HASH) }
+  x.report('ruby:hash:dump') { readthis_ruby.write('ruby', HASH) }
+
+  x.compare!
+end
+
+Benchmark.ips do |x|
+  x.report('pass:hash:load') { readthis_oj.read('pass') }
+  x.report('oj:hash:load')   { readthis_oj.read('oj') }
+  x.report('json:hash:load') { readthis_json.read('json') }
+  x.report('ruby:hash:load') { readthis_ruby.read('ruby') }
+
+  x.compare!
+end

data/lib/readthis/cache.rb

@@ -1,19 +1,14 @@
-require 'readthis/compressor'
+require 'readthis/entity'
 require 'readthis/expanders'
 require 'readthis/notifications'
+require 'readthis/passthrough'
 require 'redis'
 require 'hiredis'
 require 'connection_pool'
 
 module Readthis
   class Cache
-    attr_reader :compress,
-      :compression_threshold,
-      :expires_in,
-      :namespace,
-      :pool
-
-    alias_method :compress?, :compress
+    attr_reader :entity, :expires_in, :namespace, :pool
 
     # Provide a class level lookup of the proper notifications module.
     # Instrumention is expected to occur within applications that have
@@ -30,11 +25,14 @@ module Readthis
     # Creates a new Readthis::Cache object with the given redis URL. The URL
     # is parsed by the redis client directly.
     #
-    # @param url [String] A redis compliant url with necessary connection details
-    # @option options [String] :namespace Prefix used to namespace entries
-    # @option options [Number] :expires_in The number of seconds until an entry expires
-    # @option options [Boolean] :compress Enable or disable automatic compression
-    # @option options [Number] :compression_threshold The size a string must be for compression
+    # @param [String] A redis compliant url with necessary connection details
+    # @option [Boolean] :compress (false) Enable or disable automatic compression
+    # @option [Number] :compression_threshold (8k) The size a string must be for compression
+    # @option [Number] :expires_in The number of seconds until an entry expires
+    # @option [Module] :marshal (Marshal) Any module that responds to `dump` and `load`
+    # @option [String] :namespace Prefix used to namespace entries
+    # @option [Number] :pool_size (5) The number of threads in the pool
+    # @option [Number] :pool_timeout (5) How long before a thread times out
     #
     # @example Create a new cache instance
     #   Readthis::Cache.new('redis://localhost:6379/0', namespace: 'cache')
@@ -45,19 +43,35 @@ module Readthis
     def initialize(url, options = {})
       @expires_in = options.fetch(:expires_in, nil)
       @namespace  = options.fetch(:namespace,  nil)
-      @compress   = options.fetch(:compress,   false)
-      @compression_threshold = options.fetch(:compression_threshold, 1024)
+
+      @entity = Readthis::Entity.new(
+        marshal:   options.fetch(:marshal, Marshal),
+        compress:  options.fetch(:compress, false),
+        threshold: options.fetch(:compression_threshold, 1024)
+      )
 
       @pool = ConnectionPool.new(pool_options(options)) do
         Redis.new(url: url, driver: :hiredis)
       end
     end
 
+    # Fetches data from the cache, using the given key. If there is data in
+    # the cache with the given key, then that data is returned. Otherwise, nil
+    # is returned.
+    #
+    # @param [String] Key for lookup
+    # @param [Hash] Optional overrides
+    #
+    # @example
+    #
+    #   cache.read('missing') # => nil
+    #   cache.read('matched') # => 'some value'
+    #
     def read(key, options = {})
       invoke(:read, key) do |store|
         value = store.get(namespaced_key(key, merged_options(options)))
 
-        decompressed(value)
+        entity.load(value)
       end
     end
 
@@ -67,9 +81,9 @@ module Readthis
 
       invoke(:write, key) do |store|
         if expiration = options[:expires_in]
-          store.setex(namespaced, expiration, compressed(value))
+          store.setex(namespaced, expiration, entity.dump(value))
         else
-          store.set(namespaced, compressed(value))
+          store.set(namespaced, entity.dump(value))
         end
       end
     end
@@ -91,15 +105,45 @@ module Readthis
       value
     end
 
-    def increment(key, options = {})
+    # Increment a key in the store.
+    #
+    # If the key doesn't exist it will be initialized at 0. If the key exists
+    # but it isn't a Fixnum it will be initialized at 0.
+    #
+    # @param [String] Key for lookup
+    # @param [Fixnum] Value to increment by
+    # @param [Hash] Optional overrides
+    #
+    # @example
+    #
+    #   cache.increment('counter') # => 0
+    #   cache.increment('counter') # => 1
+    #   cache.increment('counter', 2) # => 3
+    #
+    def increment(key, amount = 1, options = {})
       invoke(:incremenet, key) do |store|
-        store.incr(namespaced_key(key, merged_options(options)))
+        alter(key, amount, options)
       end
     end
 
-    def decrement(key, options = {})
+    # Decrement a key in the store.
+    #
+    # If the key doesn't exist it will be initialized at 0. If the key exists
+    # but it isn't a Fixnum it will be initialized at 0.
+    #
+    # @param [String] Key for lookup
+    # @param [Fixnum] Value to decrement by
+    # @param [Hash] Optional overrides
+    #
+    # @example
+    #
+    #   cache.write('counter', 20) # => 20
+    #   cache.decrement('counter') # => 19
+    #   cache.decrement('counter', 2) # => 17
+    #
+    def decrement(key, amount = 1, options = {})
       invoke(:decrement, key) do |store|
-        store.decr(namespaced_key(key, merged_options(options)))
+        alter(key, amount * -1, options)
       end
     end
 
@@ -108,7 +152,7 @@ module Readthis
       mapping = keys.map { |key| namespaced_key(key, options) }
 
       invoke(:read_multi, keys) do |store|
-        values = decompressed_multi(store.mget(mapping))
+        values = store.mget(mapping).map { |value| entity.load(value) }
 
         keys.zip(values).to_h
       end
@@ -152,32 +196,11 @@ module Readthis
 
     private
 
-    def compressed(value)
-      if compress?
-        compressor.compress(value)
-      else
-        value
-      end
-    end
-
-    def decompressed(value)
-      if compress?
-        compressor.decompress(value)
-      else
-        value
-      end
-    end
-
-    def decompressed_multi(values)
-      if compress?
-        values.map { |value| compressor.decompress(value) }
-      else
-        values
-      end
-    end
-
-    def compressor
-      @compressor ||= Readthis::Compressor.new(threshold: compression_threshold)
+    def alter(key, amount, options)
+      number = read(key, options)
+      delta  = number.to_i + amount
+      write(key, delta, options)
+      delta
     end
 
     def instrument(operation, key)

data/lib/readthis/entity.rb

@@ -0,0 +1,51 @@
+require 'zlib'
+
+module Readthis
+  class Entity
+    DEFAULT_THRESHOLD = 8 * 1024
+
+    attr_reader :marshal, :compression, :threshold
+
+    def initialize(marshal: Marshal, compress: false, threshold: DEFAULT_THRESHOLD)
+      @marshal     = marshal
+      @compression = compress
+      @threshold   = threshold
+    end
+
+    def dump(value)
+      return value if value.nil?
+
+      if compress?(value)
+        compress(value)
+      else
+        marshal.dump(value)
+      end
+    end
+
+    def load(value)
+      return value if value.nil?
+
+      if compress?(value)
+        decompress(value)
+      else
+        marshal.load(value)
+      end
+    rescue TypeError, Zlib::Error
+      value
+    end
+
+    def compress(value)
+      Zlib::Deflate.deflate(marshal.dump(value))
+    end
+
+    def decompress(value)
+      marshal.load(Zlib::Inflate.inflate(value))
+    end
+
+    private
+
+    def compress?(value)
+      compression && value.bytesize >= threshold
+    end
+  end
+end

data/lib/readthis/passthrough.rb

@@ -0,0 +1,11 @@
+module Readthis
+  module Passthrough
+    def self.dump(value)
+      value
+    end
+
+    def self.load(value)
+      value
+    end
+  end
+end

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/readthis/cache_spec.rb

@@ -20,17 +20,6 @@ RSpec.describe Readthis::Cache do
 
       expect(cache.expires_in).to eq(10)
     end
-
-    it 'stores compression parameters' do
-      cache = Readthis::Cache.new(
-        url,
-        compress: true,
-        compression_threshold: 8
-      )
-
-      expect(cache.compress).to be_truthy
-      expect(cache.compression_threshold).to eq(8)
-    end
   end
 
   describe '#write' do
@@ -47,6 +36,14 @@ RSpec.describe Readthis::Cache do
       expect(cache.read('some-key', namespace: 'cache')).to eq('some-value')
     end
 
+    it 'roundtrips values as their original type' do
+      object = { a: 1, b: 2 }
+
+      cache.write('obj-key', object)
+
+      expect(cache.read('obj-key')).to eq(object)
+    end
+
     it 'uses a custom expiration' do
       cache.write('some-key', 'some-value', expires_in: 1)
 
@@ -70,7 +67,7 @@ RSpec.describe Readthis::Cache do
     end
   end
 
-  describe '#compress' do
+  describe 'compression' do
     it 'round trips entries when compression is enabled' do
       com_cache = Readthis::Cache.new(url, compress: true, compression_threshold: 8)
       raw_cache = Readthis::Cache.new(url)
@@ -129,11 +126,11 @@ RSpec.describe Readthis::Cache do
     it 'maps multiple values to keys' do
       cache.write('a', 1)
       cache.write('b', 2)
-      cache.write('c', 3)
+      cache.write('c', '3')
 
       expect(cache.read_multi('a', 'b', 'c')).to eq(
-        'a' => '1',
-        'b' => '2',
+        'a' => 1,
+        'b' => 2,
         'c' => '3',
       )
     end
@@ -143,8 +140,8 @@ RSpec.describe Readthis::Cache do
       cache.write('e', 2, namespace: 'cache')
 
       expect(cache.read_multi('d', 'e', namespace: 'cache')).to eq(
-        'd' => '1',
-        'e' => '2',
+        'd' => 1,
+        'e' => 2,
       )
     end
   end
@@ -157,9 +154,9 @@ RSpec.describe Readthis::Cache do
       results = cache.fetch_multi('a', 'b', 'c') { |key| key + key }
 
       expect(results).to eq(
-        'a' => '1',
+        'a' => 1,
         'b' => 'bb',
-        'c' => '3',
+        'c' => 3,
       )
     end
   end
@@ -188,7 +185,7 @@ RSpec.describe Readthis::Cache do
     it 'atomically increases the stored integer' do
       cache.write('counter', 10)
       expect(cache.increment('counter')).to eq(11)
-      expect(cache.read('counter')).to eq('11')
+      expect(cache.read('counter')).to eq(11)
     end
 
     it 'defaults a missing key to 1' do

data/spec/readthis/entity_spec.rb

@@ -0,0 +1,73 @@
+require 'readthis/entity'
+require 'json'
+
+RSpec.describe Readthis::Entity do
+  describe '#dump' do
+    it 'marshals the object as a ruby string' do
+      string = 'some string'
+      entity = Readthis::Entity.new
+
+      expect(entity.dump(string)).to eq(Marshal.dump(string))
+    end
+
+    it 'marshals using a custom marshaller' do
+      string = 'some string'
+      entity = Readthis::Entity.new(marshal: JSON)
+
+      expect(entity.dump(string)).to eq(JSON.dump(string))
+    end
+
+    it 'applies compression when enabled' do
+      string = 'a very large string, huge I tell you'
+      entity = Readthis::Entity.new(compress: true, threshold: 8)
+      dumped = Marshal.dump(string)
+
+      expect(entity.dump(string)).not_to eq(dumped)
+    end
+
+    it 'does not dump nil values' do
+      entity = Readthis::Entity.new
+
+      expect(entity.dump(nil)).to be_nil
+    end
+  end
+
+  describe '#load' do
+    it 'unmarshals a value' do
+      object = { a: 1, b: '2' }
+      dumped = Marshal.dump(object)
+      entity = Readthis::Entity.new
+
+      expect(entity.load(dumped)).to eq(object)
+    end
+
+    it 'uncompresses when compression is enabled' do
+      string = 'another one of those huge strings'
+      entity = Readthis::Entity.new(compress: true, threshold: 0)
+      dumped = Marshal.dump(string)
+
+      compressed = entity.compress(dumped)
+
+      expect(entity.load(compressed)).not_to eq(string)
+    end
+
+    it 'does not try to load a nil value' do
+      entity = Readthis::Entity.new
+
+      expect(entity.load(nil)).to be_nil
+    end
+
+    it 'passes through the value when it fails to marshal' do
+      entity = Readthis::Entity.new
+
+      expect { entity.load('not marshalled') }.not_to raise_error
+    end
+
+    it 'passes through the value when it fails to decompress' do
+      entity = Readthis::Entity.new(compress: true, threshold: 0)
+      dumped = Marshal.dump('some sizable string')
+
+      expect { entity.load(dumped) }.not_to raise_error
+    end
+  end
+end

data/spec/readthis/passthrough_spec.rb

@@ -0,0 +1,17 @@
+require 'readthis/passthrough'
+
+RSpec.describe Readthis::Passthrough do
+  describe '.load' do
+    it 'passes through the provided value' do
+      value = Object.new
+      expect(Readthis::Passthrough.load(value)).to eq(value)
+    end
+  end
+
+  describe '.dump' do
+    it 'passes through the provided value' do
+      value = Object.new
+      expect(Readthis::Passthrough.dump(value)).to eq(value)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
+require 'coveralls'
+
+Coveralls.wear!
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2014-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -112,21 +112,24 @@ files:
 - README.md
 - Rakefile
 - benchmarks/compressed.rb
+- benchmarks/marshalling.rb
 - benchmarks/memory.rb
 - benchmarks/multi.rb
 - bin/rspec
 - lib/active_support/cache/readthis_store.rb
 - lib/readthis.rb
 - lib/readthis/cache.rb
-- lib/readthis/compressor.rb
+- lib/readthis/entity.rb
 - lib/readthis/expanders.rb
 - lib/readthis/notifications.rb
+- lib/readthis/passthrough.rb
 - lib/readthis/version.rb
 - readthis.gemspec
 - spec/readthis/cache_spec.rb
-- spec/readthis/compressor_spec.rb
+- spec/readthis/entity_spec.rb
 - spec/readthis/expanders_spec.rb
 - spec/readthis/notifications_spec.rb
+- spec/readthis/passthrough_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sorentwo/readthis
 licenses:
@@ -154,7 +157,8 @@ specification_version: 4
 summary: Pooled active support compliant caching with redis
 test_files:
 - spec/readthis/cache_spec.rb
-- spec/readthis/compressor_spec.rb
+- spec/readthis/entity_spec.rb
 - spec/readthis/expanders_spec.rb
 - spec/readthis/notifications_spec.rb
+- spec/readthis/passthrough_spec.rb
 - spec/spec_helper.rb

data/lib/readthis/compressor.rb

@@ -1,41 +0,0 @@
-require 'zlib'
-
-module Readthis
-  class Compressor
-    attr_reader :threshold
-
-    # Create a new Readthis::Compressor object that pivots on the provided
-    # threshold value.
-    #
-    # @param threshold [Number] the threshold size required for compression
-    def initialize(threshold: 1024)
-      @threshold = threshold
-    end
-
-    # Compress a value if its size is greater or equal to the current threshold.
-    #
-    # @param value [String] a string to compress
-    def compress(value)
-      if value.size >= threshold
-        Zlib::Deflate.deflate(value)
-      else
-        value
-      end
-    end
-
-    # Decompress a previously compressed object. It will attempt to decode a
-    # value regardless of whether it has been compressed, but will rescue
-    # decoding errors.
-    #
-    # @param value [String] a possibly compressed string to decompress
-    def decompress(value)
-      if value.size >= threshold
-        Zlib::Inflate.inflate(value)
-      else
-        value
-      end
-    rescue Zlib::Error
-      value
-    end
-  end
-end

data/spec/readthis/compressor_spec.rb

@@ -1,38 +0,0 @@
-require 'readthis/compressor'
-
-RSpec.describe Readthis::Compressor do
-  describe '#compress' do
-    it 'compresses the input' do
-      compressor   = Readthis::Compressor.new(threshold: 0)
-      input      = 'aaa bbb ccc'
-      output     = compressor.compress(input)
-
-      expect(input).not_to eq(output)
-    end
-
-    it 'passes input below the threshold size through uncompressed' do
-      compressor = Readthis::Compressor.new(threshold: 1024)
-      input      = 'abcdefg'
-
-      expect(compressor.compress(input)).to eq(input)
-    end
-  end
-
-  describe '#decompress' do
-    it 'decompresses compressed data' do
-      compressor   = Readthis::Compressor.new(threshold: 0)
-      input        = 'aaa bbb ccc'
-      compressed   = compressor.compress(input)
-      decompressed = compressor.decompress(compressed)
-
-      expect(decompressed).to eq(input)
-    end
-
-    it 'passes through decompression failures' do
-      compressor = Readthis::Compressor.new(threshold: 0)
-      input      = 'abcdefg'
-
-      expect(compressor.decompress(input)).to eq(input)
-    end
-  end
-end