readthis 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beeb6a1ebaa7b28ece28bbc82b71a85bd78db186
-  data.tar.gz: 5c1af1a823131e8320c862b4774e285c08ad8525
+  metadata.gz: a07bacb5dfde0174d8c1bbb84f67f4a4fa110a78
+  data.tar.gz: e33d843547462b265a33333106f68b634e1d22fd
 SHA512:
-  metadata.gz: f418008520264991ec238afda668dadea6b42724df8b638b858dada82e0bc5263aea0fa3fd6ffc48839da51fd3153fdd436d348de60fa996cfdc7c57750b2c76
-  data.tar.gz: db0e5445ea22524934d4257347ad28584b8fb03c7b2acfa6c543ce655d76d7f96b5af19d2efada2ed6be22a5afad34dcdf10c5132a466bad2b3b5ee00d68be01
+  metadata.gz: 4e50977ab026bfd2df4824b9da0d2ed043005ecd7dd6f747ba431516f6f09d888f51fa5f56619871f462b602e4d4c882e44ab39c80a98d9d0fed48943a97eae6
+  data.tar.gz: 800a1d90af2fb5a9edd694ae6cea7b319f6e47026394d8dd72fa407c0228766124786f7e22260637baac6a7f36ac4fb8249403c955f6b583334d4f47d823e682

data/.travis.yml

@@ -1,12 +1,14 @@
 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:

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 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

data/README.md

@@ -25,6 +25,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'readthis'
+gem 'hiredis' # Highly recommended
 ```
 
 ## Usage
@@ -33,10 +34,10 @@ Use it the same way as any other [ActiveSupport::Cache::Store][store]. Within a
 Rails environment config:
 
 ```ruby
-config.cache_store = :readthis_store, ENV.fetch('REDIS_URL'), {
+config.cache_store = :readthis_store,
   expires_in: 2.weeks.to_i,
-  namespace: 'cache'
-}
+  namespace: 'cache',
+  redis: { url: ENV.fetch('REDIS_URL'), driver: :hiredis }
 ```
 
 Otherwise you can use it anywhere, without any reliance on `ActiveSupport`:
@@ -44,7 +45,10 @@ Otherwise you can use it anywhere, without any reliance on `ActiveSupport`:
 ```ruby
 require 'readthis'
 
-cache = Readthis::Cache.new(ENV.fetch('REDIS_URL'), expires_in: 2.weeks.to_i)
+cache = Readthis::Cache.new(
+  expires_in: 2.weeks.to_i,
+  redis: { url: ENV.fetch('REDIS_URL') }
+)
 ```
 
 [store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html
@@ -85,10 +89,9 @@ 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, ENV.fetch('REDIS_URL'), {
+config.cache_store = :readthis_store,
   compress: true,
   compression_threshold: 2.kilobytes
-}
 ```
 
 ### Marshalling
@@ -100,22 +103,22 @@ may be desirable to use a faster but less flexible marshaller.
 Use Oj for JSON marshalling, extremely fast, but supports limited types:
 
 ```ruby
-Readthis::Cache.new(url, marshal: Oj)
+Readthis::Cache.new(marshal: Oj)
 ```
 
 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)
+Readthis::Cache.new(marshal: Readthis::Passthrough)
 ```
 
-## Differences
+## Differences From ActiveSupport::Cache
 
 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
+* `delete_matched` - You really don't want to perform key matching operations
   in Redis. They are linear time and only support basic globbing.
 
 ## Contributing

data/benchmarks/compressed.rb

@@ -16,7 +16,6 @@ dalli = ActiveSupport::Cache::DalliStore.new(
 )
 
 readthis  = Readthis::Cache.new(
-  'redis://localhost:6379/11',
   pool_size: 5,
   compressed: true,
   compression_threshold: 128

data/benchmarks/driver.rb

@@ -5,9 +5,8 @@ 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)
+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) }
 

data/benchmarks/marshalling.rb

@@ -9,14 +9,13 @@ 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_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))
+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 }
 

data/benchmarks/multi.rb

@@ -9,11 +9,10 @@ require 'active_support/cache/memory_store'
 require 'active_support/cache/dalli_store'
 require 'readthis'
 
-REDIS_URL = 'redis://localhost:6379/11'
-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_URL + '/ra', expires_in: 60)
-readthis  = Readthis::Cache.new(REDIS_URL, namespace: 'rd', expires_in: 60)
+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

data/lib/readthis/cache.rb

@@ -14,33 +14,31 @@ module Readthis
     # ActiveSupport::Notifications available, but needs to work even when it
     # isn't.
     def self.notifications
-      if Object.const_defined?('ActiveSupport::Notifications')
+      if defined?(ActiveSupport::Notifications)
         ActiveSupport::Notifications
       else
         Readthis::Notifications
       end
     end
 
-    # Creates a new Readthis::Cache object with the given redis URL. The URL
-    # is parsed by the redis client directly.
+    # Creates a new Readthis::Cache object with the given options.
     #
-    # @param [String] A redis compliant url with necessary connection details
+    # @option [Hash]    :redis Options that will be passed to the underlying redis connection
     # @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 [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
+    # @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')
+    #   Readthis::Cache.new(namespace: 'cache', redis: { url: 'redis://localhost:6379/0' })
     #
     # @example Create a compressed cache instance
-    #   Readthis::Cache.new('redis://localhost:6379/0', compress: true, compression_threshold: 2048)
+    #   Readthis::Cache.new(compress: true, compression_threshold: 2048)
     #
-    def initialize(url, options = {})
+    def initialize(options = {})
       @expires_in = options.fetch(:expires_in, nil)
       @namespace  = options.fetch(:namespace, nil)
 
@@ -51,7 +49,7 @@ module Readthis
       )
 
       @pool = ConnectionPool.new(pool_options(options)) do
-        Redis.new(url: url, driver: options.fetch(:driver, :hiredis))
+        Redis.new(options.fetch(:redis, {}))
       end
     end
 

data/lib/readthis/version.rb

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

data/spec/readthis/cache_spec.rb

@@ -1,8 +1,7 @@
 require 'readthis/cache'
 
 RSpec.describe Readthis::Cache do
-  let(:url)   { 'redis://localhost:6379/11' }
-  let(:cache) { Readthis::Cache.new(url) }
+  let(:cache) { Readthis::Cache.new }
 
   after do
     cache.clear
@@ -10,34 +9,26 @@ RSpec.describe Readthis::Cache do
 
   describe '#initialize' do
     it 'accepts and persists a namespace' do
-      cache = Readthis::Cache.new(url, namespace: 'kash')
+      cache = Readthis::Cache.new(namespace: 'kash')
 
       expect(cache.namespace).to eq('kash')
     end
 
     it 'accepts and persists an expiration' do
-      cache = Readthis::Cache.new(url, expires_in: 10)
+      cache = Readthis::Cache.new(expires_in: 10)
 
       expect(cache.expires_in).to eq(10)
     end
   end
 
   describe '#pool' do
-    it 'creates a new redis connection with hiredis' do
-      cache = Readthis::Cache.new(url)
+    it 'uses the passed redis configuration' do
+      cache = Readthis::Cache.new(redis: { driver: :hiredis })
 
       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
@@ -87,8 +78,8 @@ RSpec.describe Readthis::Cache 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)
+      com_cache = Readthis::Cache.new(compress: true, compression_threshold: 8)
+      raw_cache = Readthis::Cache.new
       value = 'enough text that it should be compressed'
 
       com_cache.write('compressed', value)
@@ -98,7 +89,7 @@ RSpec.describe Readthis::Cache do
     end
 
     it 'round trips bulk entries when compression is enabled' do
-      cache = Readthis::Cache.new(url, compress: true, compression_threshold: 8)
+      cache = Readthis::Cache.new(compress: true, compression_threshold: 8)
       value = 'also enough text to compress'
 
       cache.write('comp-a', value)

metadata

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