readthis 0.8.1 → 1.2.1

data/CHANGELOG.md

@@ -1,114 +0,0 @@
-## 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
-  `url` and `options` separately. This allows the underlying redis client to
-  accept any options, rather than just the driver. For example, it's now
-  possible to use Readthis with sentinel directly through the configuration.
-- Changed: The `hiredis` driver is *no longer the default*. In order to use the
-  vastly faster `hiredis` driver you need to pass it in during construction.
-  See [readthis#9][issue-9] for more discussion.
-
-[issue-9]: https://github.com/sorentwo/readthis/issues/9
-
-## v0.7.0 2015-08-11
-
-- Changed: Entity initialization uses an options hash rather than keyword
-  arguments. This allows flexibility with older Ruby versions (1.9) that aren't
-  officially supported.
-- Changed: There is no longer a hard dependency on `hiredis`, though it is the
-  default. The redis driver can be configured by passing a `driver: :ruby`
-  option through to the constructor.
-
-## v0.6.2 2015-04-28
-
-- Fixed: Set expiration during `write_multi`, primarily effecting `fetch_multi`.
-  This fixes the real issue underlying the change in `v0.6.1`.
-
-## v0.6.1 2015-04-28
-
-- Changed: Expiration values are always cast to an integer before use in write
-  operations. This prevents subtle ActiveSupport bugs where the value would be
-  ignored by `setex`.
-
-## v0.6.0 2015-03-09
-
-- Fixed: Safely handle calling `read_multi` without any keys. [Michael Rykov]
-- Fixed: Pointed `redis-activesupport` at master. Only effected development and
-  testing.
-- Added: A `write_multi` method is no available to bulk set keys and values. It
-  is used by `fetch_multi` internally to ensure that there are at most two Redis
-  calls.
-
-## v0.5.2 2015-01-09
-
-- Fixed: Remove the `pipeline` around `fetch_multi` writing. This will slow down
-  `fetch_multi` in cache miss situations for now. It prevents a difficult to
-  track down exception in multi-threaded situations.
-
-## v0.5.1 2014-12-30
-
-- Fixed: The `clear` method now accepts an argument for compatibility with other
-  caches. The argument is not actually used for anything.
-- Changed: The `delete` method will always return a boolean value rather than an
-  integer.
-- Changed: Avoid multiple instrumentation calls and pool checkouts within
-  `fetch_multi` calls.
-
-## 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,
-  but prevents the project from being used in `jruby`. If we get interest from
-  some `jruby` projects we can soften the requirement.
-- Added: Compression! Adheres to the `ActiveSupport::Store` documentation.
-- Fixed: Gracefully handle `nil` passed as `options` to any cache method.
-
-## v0.3.0 2014-12-01
-
-- Added: Use `to_param` for key expansion, only when available. Makes it
-  possible to extract a key from any object when ActiveSupport is loaded.
-- Added: Expand hashes as cache keys.
-- Changed: Use `mget` for `read_multi`, faster and more synchronous than relying on
-  `pipelined`.
-- Changed: Delimit compound objects with a slash rather than a colon.
-
-## v0.2.0 2014-11-24
-
-- Added: Instrument all caching methods. Will use `ActiveSupport::Notifications`
-  if available, otherwise falls back to a polyfill.
-- Added: Expand objects with a `cache_key` method and arrays of strings or objects into
-  consistent naespaced keys.
-
-## v0.1.0 2014-11-22
-
-- Initial release! Working as a drop in replacement for `redis_store`.

data/CONTRIBUTING.md

@@ -1,14 +0,0 @@
-# Contributing
-
-## Open an Issue
-
-Let us know about bugs. Include your version of Readthis, Ruby, and the
-environment you are using.
-
-## Submit a Pull Request
-
-1. Fork it ( https://github.com/sorentwo/readthis/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/Gemfile

@@ -1,14 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'coveralls', require: false
-
-group :benchmarking do
-  gem 'benchmark-ips'
-  gem 'dalli'
-  gem 'oj'
-  gem 'msgpack'
-  gem 'redis-activesupport'
-  gem 'stackprof'
-end

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Parker Selbert
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/PERFORMANCE.md

@@ -1,73 +0,0 @@
-Results from the various benchmarks in `./bencharks`. Hardware doesn't matter
-much, as we're simply looking for a comparison against other libraries and prior
-verions.
-
-## Footprint
-
-Footprint compared to `redis-activesupport`:
-
-```
-# Total allocated objects after require
-readthis: 20602
-redis-activesupport: 78630
-```
-
-## Performance
-
-Performance compared to `dalli` and `redis-activesupport`:
-
-```
-Raw Read Multi:
-Calculating -------------------------------------
- readthis:read-multi   358.000  i/100ms
-  redisas:read-multi    94.000  i/100ms
-    dalli:read-multi    99.000  i/100ms
--------------------------------------------------
- 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:     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   336.000  i/100ms
- redisas:fetch-multi    86.000  i/100ms
-   dalli:fetch-multi   102.000  i/100ms
--------------------------------------------------
-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:     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   924.000  i/100ms
-         dalli:write   903.000  i/100ms
--------------------------------------------------
-      readthis:write     10.105k (± 4.9%) i/s -     50.820k
-         dalli:write      9.662k (± 1.6%) i/s -     48.762k
-
-Comparison:
-      readthis:write:    10105.3 i/s
-         dalli:write:     9662.4 i/s - 1.05x slower
-
-Compressed Read Multi:
-Calculating -------------------------------------
- readthis:read_multi   325.000  i/100ms
-    dalli:read_multi   100.000  i/100ms
--------------------------------------------------
- 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:     3356.5 i/s
-    dalli:read_multi:     1014.1 i/s - 3.31x slower
-```

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-

data/benchmarks/compressed.rb

@@ -1,74 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'dalli'
-require 'active_support'
-require 'active_support/cache/dalli_store'
-require 'readthis'
-
-dalli = ActiveSupport::Cache::DalliStore.new(
-  'localhost',
-  pool_size: 5,
-  compressed: true,
-  compression_threshold: 8
-)
-
-readthis  = Readthis::Cache.new(
-  pool_size: 5,
-  compressed: true,
-  compression_threshold: 128
-)
-
-KEY  = 'key'
-TEXT = <<-TEXT
-  An abstract cache store class. There are multiple cache store implementations, each having its own additional features. See the classes under the ActiveSupport::Cache module, e.g. ActiveSupport::Cache::MemCacheStore. MemCacheStore is currently the most popular cache store for large production websites.
-  Some implementations may not support all methods beyond the basic cache methods of fetch, write, read, exist?, and delete.
-  ActiveSupport::Cache::Store can store any serializable Ruby object.
-  cache = ActiveSupport::Cache::MemoryStore.new
-  cache.read('city')   # => nil
-  cache.write('city', "Duckburgh")
-  cache.read('city')   # => "Duckburgh"
-  Keys are always translated into Strings and are case sensitive. When an object is specified as a key and has a cache_key method defined, this method will be called to define the key. Otherwise, the to_param method will be called. Hashes and Arrays can also be used as keys. The elements will be delimited by slashes, and the elements within a Hash will be sorted by key so they are consistent.
-  cache.read('city') == cache.read(:city)   # => true
-  Nil values can be cached.
-  If your cache is on a shared infrastructure, you can define a namespace for your cache entries. If a namespace is defined, it will be prefixed on to every key. The namespace can be either a static value or a Proc. If it is a Proc, it will be invoked when each key is evaluated so that you can use application logic to invalidate keys.
-  cache.namespace = -> { @last_mod_time }  # Set the namespace to a variable
-  @last_mod_time = Time.now  # Invalidate the entire cache by changing namespace
-  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 Write/Read:'
-Benchmark.ips do |x|
-  x.report 'readthis:write/read' do
-    readthis.write(KEY, TEXT)
-    readthis.read(KEY)
-  end
-
-  x.report 'dalli:write/read' do
-    dalli.write(KEY, TEXT)
-    dalli.read(KEY)
-  end
-
-  x.compare!
-end
-
-puts 'Compressed Read Multi:'
-MULTI_KEY = (1..30).to_a
-MULTI_KEY.each do |key|
-  readthis.write(key, TEXT)
-  dalli.write(key, TEXT)
-end
-
-Benchmark.ips do |x|
-  x.report 'readthis:read_multi' do
-    readthis.read_multi(*MULTI_KEY)
-  end
-
-  x.report 'dalli:read_multi' do
-    dalli.read_multi(*MULTI_KEY)
-  end
-
-  x.compare!
-end

data/benchmarks/driver.rb

@@ -1,18 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'readthis'
-
-native  = Readthis::Cache.new(redis: { driver: :ruby }, expires_in: 60)
-hiredis = Readthis::Cache.new(redis: { driver: :hiredis }, expires_in: 60)
-
-('a'..'z').each { |key| native.write(key, key * 1024) }
-
-Benchmark.ips do |x|
-  x.report('native:read-multi')  { native.read_multi(*('a'..'z')) }
-  x.report('hiredis:read-multi') { hiredis.read_multi(*('a'..'z')) }
-
-  x.compare!
-end

data/benchmarks/marshalling.rb

@@ -1,40 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'json'
-require 'oj'
-require 'msgpack'
-require 'readthis'
-require 'readthis/passthrough'
-
-OPTIONS = { compressed: false }
-
-readthis_pass    = Readthis::Cache.new(OPTIONS.merge(marshal: Readthis::Passthrough))
-readthis_oj      = Readthis::Cache.new(OPTIONS.merge(marshal: Oj))
-readthis_msgpack = Readthis::Cache.new(OPTIONS.merge(marshal: MessagePack))
-readthis_json    = Readthis::Cache.new(OPTIONS.merge(marshal: JSON))
-readthis_ruby    = Readthis::Cache.new(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_pass.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('msgpack:hash:dump') { readthis_msgpack.write('msgpack', HASH) }
-  x.report('ruby:hash:dump')    { readthis_ruby.write('ruby',       HASH) }
-
-  x.compare!
-end
-
-Benchmark.ips do |x|
-  x.report('pass:hash:load')    { readthis_pass.read('pass') }
-  x.report('oj:hash:load')      { readthis_oj.read('oj') }
-  x.report('json:hash:load')    { readthis_json.read('json') }
-  x.report('msgpack:hash:load') { readthis_msgpack.read('msgpack') }
-  x.report('ruby:hash:load')    { readthis_ruby.read('ruby') }
-
-  x.compare!
-end

data/benchmarks/memory.rb

@@ -1,11 +0,0 @@
-require 'bundler'; Bundler.setup
-a = GC.stat(:total_allocated_objects)
-
-require 'readthis'
-b = GC.stat(:total_allocated_objects)
-
-require 'redis-activesupport'
-c = GC.stat(:total_allocated_objects)
-
-puts "readthis: #{b - a}"
-puts "redis-activesupport: #{c - b}"

data/benchmarks/multi.rb

@@ -1,64 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'benchmark/ips'
-require 'dalli'
-require 'redis-activesupport'
-require 'active_support/cache/memory_store'
-require 'active_support/cache/dalli_store'
-require 'readthis'
-
-memory   = ActiveSupport::Cache::MemoryStore.new(expires_in: 60, namespace: 'mm')
-dalli    = ActiveSupport::Cache::DalliStore.new('localhost', namespace: 'da', pool_size: 5, expires_in: 60)
-redisas  = ActiveSupport::Cache::RedisStore.new('redis://localhost:6379/11/ra', expires_in: 60)
-readthis = Readthis::Cache.new(namespace: 'rd', expires_in: 60)
-
-('a'..'z').each do |key|
-  value = key * 1024
-
-  memory.write(key, value)
-  dalli.write(key, value)
-  readthis.write(key, value)
-  redisas.write(key, value)
-end
-
-Benchmark.ips do |x|
-  x.report 'memory:read-multi' do
-    memory.read_multi(*('a'..'z'))
-  end
-
-  x.report 'readthis:read-multi' do
-    readthis.read_multi(*('a'..'z'))
-  end
-
-  x.report 'redisas:read-multi' do
-    redisas.read_multi(*('a'..'z'))
-  end
-
-  x.report 'dalli:read-multi' do
-    dalli.read_multi(*('a'..'z'))
-  end
-
-  x.compare!
-end
-
-Benchmark.ips do |x|
-  x.report 'memory:fetch-multi' do
-    memory.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.report 'readthis:fetch-multi' do
-    readthis.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.report 'redisas:fetch-multi' do
-    redisas.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.report 'dalli:fetch-multi' do
-    dalli.fetch_multi(*('a'..'z')) { |_| 'missing' }
-  end
-
-  x.compare!
-end

data/benchmarks/profile.rb

@@ -1,20 +0,0 @@
-require 'bundler'
-
-Bundler.setup
-
-require 'fileutils'
-require 'stackprof'
-require 'readthis'
-
-readthis = Readthis::Cache.new('redis://localhost:6379/11')
-
-FileUtils.mkdir_p('tmp')
-readthis.clear
-
-('a'..'z').each { |key| readthis.write(key, key * 1024) }
-
-StackProf.run(mode: :object, interval: 500, out: "tmp/stackprof-object.dump") do
-  1000.times do
-    readthis.read_multi(*('a'..'z'))
-  end
-end

data/bin/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')

data/lib/readthis/notifications.rb

@@ -1,7 +0,0 @@
-module Readthis
-  module Notifications
-    def self.instrument(_name, payload)
-      yield(payload)
-    end
-  end
-end

data/readthis.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'readthis/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'readthis'
-  spec.version       = Readthis::VERSION
-  spec.authors       = ['Parker Selbert']
-  spec.email         = ['parker@sorentwo.com']
-  spec.summary       = 'Pooled active support compliant caching with redis'
-  spec.description   = 'Pooled active support compliant caching with redis'
-  spec.homepage      = 'https://github.com/sorentwo/readthis'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'redis',           '~> 3.0'
-  spec.add_dependency 'connection_pool', '~> 2.1'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'hiredis', '~> 0.5'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec',   '~> 3.1'
-end

data/spec/readthis/notifications_spec.rb

@@ -1,15 +0,0 @@
-require 'readthis/notifications'
-
-RSpec.describe Readthis::Notifications do
-  describe '#instrument' do
-    it 'yields the provided block' do
-      inner = double(:inner)
-
-      expect(inner).to receive(:call)
-
-      Readthis::Notifications.instrument('operation', key: 'key') do
-        inner.call
-      end
-    end
-  end
-end