readthis 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b853d729b7827306a040034b1facb812634793a
-  data.tar.gz: cb2c861912d06b3c051c28996b35bced8f252564
+  metadata.gz: beeb6a1ebaa7b28ece28bbc82b71a85bd78db186
+  data.tar.gz: 5c1af1a823131e8320c862b4774e285c08ad8525
 SHA512:
-  metadata.gz: 7286a6a1e1655ba21a7f45de395423b9ac86a9cd757751d6f037a0117481cc1a65e147ed30c68f73b2aa2c4d7da1003b8e729175be5a71da2f2ac472448dd9c0
-  data.tar.gz: 63970909217d7038a717e92729f3791c4dd9191e66863af18ec4ff26d503bdb1810ddd59824e6e6f49253f895a329916b2b508e36a365a11e9c7941b33ae1363
+  metadata.gz: f418008520264991ec238afda668dadea6b42724df8b638b858dada82e0bc5263aea0fa3fd6ffc48839da51fd3153fdd436d348de60fa996cfdc7c57750b2c76
+  data.tar.gz: db0e5445ea22524934d4257347ad28584b8fb03c7b2acfa6c543ce655d76d7f96b5af19d2efada2ed6be22a5afad34dcdf10c5132a466bad2b3b5ee00d68be01

data/.travis.yml

@@ -1,6 +1,14 @@
+sudo: false
 language: ruby
 rvm:
   - 2.1.0
+  - 2.2.2
+  - ruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-2
 services:
   - redis-server
 script: bin/rspec

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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`.

data/Gemfile

@@ -8,5 +8,7 @@ group :benchmarking do
   gem 'benchmark-ips'
   gem 'dalli'
   gem 'oj'
+  gem 'msgpack'
   gem 'redis-activesupport'
+  gem 'stackprof'
 end

data/README.md

@@ -1,20 +1,19 @@
 [![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)
+[![Coverage Status](https://coveralls.io/repos/sorentwo/readthis/badge.svg?branch=master&service=github)](https://coveralls.io/github/sorentwo/readthis?branch=master)
 
 # Readthis
 
-Readthis is a drop in replacement for any ActiveSupport compliant cache, but
-emphasizes performance and simplicity. It takes some cues from Dalli (connection
-pooling), the popular Memcache client.
+Readthis is a drop in replacement for any ActiveSupport compliant cache. It
+emphasizes performance and simplicity and takes some cues from Dalli the popular
+Memcache client.
 
-For any new projects there isn't any reason to stick with Memcached. Redis is
-as fast, if not faster in many scenarios, and is far more likely to be used
-elsewhere in the stack. See [this Stack Overflow post][stackoverflow] for more
-details.
+For new projects there isn't any reason to stick with Memcached. Redis is as
+fast, if not faster in many scenarios, and is far more likely to be used
+elsewhere in the stack. See [this blog post][hp-caching] for more details.
 
-[stackoverflow]: http://stackoverflow.com/questions/10558465/memcache-vs-redis
+[hp-caching]: http://sorentwo.com/2015/07/20/high-performance-caching-with-readthis.html
 
 ## Footprint & Performance
 
@@ -31,7 +30,7 @@ gem 'readthis'
 ## Usage
 
 Use it the same way as any other [ActiveSupport::Cache::Store][store]. Within a
-rails environment config:
+Rails environment config:
 
 ```ruby
 config.cache_store = :readthis_store, ENV.fetch('REDIS_URL'), {
@@ -40,7 +39,7 @@ config.cache_store = :readthis_store, ENV.fetch('REDIS_URL'), {
 }
 ```
 
-Otherwise you can use it anywhere, without any reliance on ActiveSupport:
+Otherwise you can use it anywhere, without any reliance on `ActiveSupport`:
 
 ```ruby
 require 'readthis'
@@ -48,21 +47,34 @@ require 'readthis'
 cache = Readthis::Cache.new(ENV.fetch('REDIS_URL'), expires_in: 2.weeks.to_i)
 ```
 
-You'll want to use a specific database for caching, just in case you need to
-clear the cache entirely. Appending a number between 0 and 15 will specify the
-redis database, which defaults to 0. For example, using database 2:
+[store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html
+
+### Instances & Databases
+
+An isolated Redis instance that is only used for caching is ideal. Dedicated
+instances have numerous benefits like: more predictable performance, avoiding
+expires in favor of LRU, and tuning the persistence mechanism. See [Optimizing
+Redis Usage for Caching][optimizing-usage] for more details.
+
+[optimizing-usage]: http://sorentwo.com/2015/07/27/optimizing-redis-usage-for-caching.html
+
+At the very least you'll want to use a specific database for caching. In the
+event the database needs to be purged you can do so with a single `clear`
+command, rather than finding all keys in a namespace and deleting them.
+Appending a number between 0 and 15 will specify the redis database, which
+defaults to 0. For example, using database 2:
 
 ```bash
 REDIS_URL=redis://localhost:6379/2
 ```
 
+### Expiration
+
 Be sure to use an integer value when setting expiration time. The default
 representation of `ActiveSupport::Duration` values won't work when setting
 expiration time, which will cause all keys to have `-1` as the TTL. Expiration
 values are always cast as an integer on write.
 
-[store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html
-
 ### Compression
 
 Compression can be enabled for all actions by passing the `compress` flag. By
@@ -82,8 +94,8 @@ 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 less flexible marshaller.
+default. This isn't always the fastest option, and depending on your use case it
+may be desirable to use a faster but less flexible marshaller.
 
 Use Oj for JSON marshalling, extremely fast, but supports limited types:
 
@@ -91,8 +103,8 @@ Use Oj for JSON marshalling, extremely fast, but supports limited types:
 Readthis::Cache.new(url, marshal: Oj)
 ```
 
-If you don't mind everything handles as a string then use the pass-through
-marshaller:
+If all cached data can safely be represented as a string then use the
+pass-through marshaller:
 
 ```ruby
 Readthis::Cache.new(url, marshal: Readthis::Passthrough)
@@ -102,6 +114,14 @@ Readthis::Cache.new(url, marshal: Readthis::Passthrough)
 
 Readthis supports all of standard cache methods except for the following:
 
-* `cleanup` - redis does this with ttl for us already
+* `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.
+  in Redis. They are linear time and only support basic globbing.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/benchmarks/driver.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+
+Bundler.setup
+
+require 'benchmark/ips'
+require 'readthis'
+
+REDIS_URL = 'redis://localhost:6379/11'
+native  = Readthis::Cache.new(REDIS_URL, driver: :ruby,  expires_in: 60)
+hiredis = Readthis::Cache.new(REDIS_URL, 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

@@ -5,33 +5,37 @@ Bundler.setup
 require 'benchmark/ips'
 require 'json'
 require 'oj'
+require 'msgpack'
 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))
+readthis_pass    = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: Readthis::Passthrough))
+readthis_oj      = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: Oj))
+readthis_msgpack = Readthis::Cache.new(REDIS_URL, OPTIONS.merge(marshal: MessagePack))
+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.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_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.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 +1,11 @@
 require 'bundler'; Bundler.setup
-a = GC.stat(:total_allocated_object)
+a = GC.stat(:total_allocated_objects)
 
 require 'readthis'
-b = GC.stat(:total_allocated_object)
+b = GC.stat(:total_allocated_objects)
 
 require 'redis-activesupport'
-c = GC.stat(:total_allocated_object)
+c = GC.stat(:total_allocated_objects)
 
 puts "readthis: #{b - a}"
 puts "redis-activesupport: #{c - b}"

data/benchmarks/profile.rb

@@ -0,0 +1,20 @@
+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/lib/readthis/cache.rb

@@ -3,7 +3,6 @@ require 'readthis/expanders'
 require 'readthis/notifications'
 require 'readthis/passthrough'
 require 'redis'
-require 'hiredis'
 require 'connection_pool'
 
 module Readthis
@@ -31,6 +30,7 @@ module Readthis
     # @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 [Symbol] :driver (:hiredis) Specify a driver to be used for Redis connections
     # @option [Number] :pool_size (5) The number of threads in the pool
     # @option [Number] :pool_timeout (5) How long before a thread times out
     #
@@ -51,7 +51,7 @@ module Readthis
       )
 
       @pool = ConnectionPool.new(pool_options(options)) do
-        Redis.new(url: url, driver: :hiredis)
+        Redis.new(url: url, driver: options.fetch(:driver, :hiredis))
       end
     end
 

data/lib/readthis/entity.rb

@@ -6,10 +6,10 @@ module Readthis
 
     attr_reader :marshal, :compression, :threshold
 
-    def initialize(marshal: Marshal, compress: false, threshold: DEFAULT_THRESHOLD)
-      @marshal     = marshal
-      @compression = compress
-      @threshold   = threshold
+    def initialize(options = {})
+      @marshal     = options.fetch(:marshal, Marshal)
+      @compression = options.fetch(:compress, false)
+      @threshold   = options.fetch(:threshold, DEFAULT_THRESHOLD)
     end
 
     def dump(value)

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/readthis.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'redis',           '~> 3.0'
-  spec.add_dependency 'hiredis',         '~> 0.5'
   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'
+  spec.add_development_dependency 'rspec',   '~> 3.1'
 end

data/spec/readthis/cache_spec.rb

@@ -22,6 +22,24 @@ RSpec.describe Readthis::Cache do
     end
   end
 
+  describe '#pool' do
+    it 'creates a new redis connection with hiredis' do
+      cache = Readthis::Cache.new(url)
+
+      cache.pool.with do |client|
+        expect(client.client.driver).to be(Redis::Connection::Hiredis)
+      end
+    end
+
+    it 'creates a new redis connection with a custom driver' do
+      cache = Readthis::Cache.new(url, driver: :ruby)
+
+      cache.pool.with do |client|
+        expect(client.client.driver).to be(Redis::Connection::Ruby)
+      end
+    end
+  end
+
   describe '#write' do
     it 'stores strings in the cache' do
       cache.write('some-key', 'some-value')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: hiredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,9 +112,11 @@ files:
 - README.md
 - Rakefile
 - benchmarks/compressed.rb
+- benchmarks/driver.rb
 - benchmarks/marshalling.rb
 - benchmarks/memory.rb
 - benchmarks/multi.rb
+- benchmarks/profile.rb
 - bin/rspec
 - lib/active_support/cache/readthis_store.rb
 - lib/readthis.rb