readthis 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e47cddbb974aaa2df5258b6279db5ac65ac1b7c
-  data.tar.gz: d729c1a37bbd6b2ab51d20ff20944e4b51aab561
+  metadata.gz: 2c3b9c325211a544d3cdffbbb4356c7c392a5c04
+  data.tar.gz: ecd6d0982a96bcff0f9bfafff60b6d758ab5ee55
 SHA512:
-  metadata.gz: 5b9e58cf2f1dda31681d653e770153d190b1fb5958e52881222b8a350cf94b71eac28c9043e56d1d2ab6673952db14b63872d52452006926cf2818d74837961d
-  data.tar.gz: f4950c2133cd938ee7e5b9da6a4ed5605506ef4da347b0b34379ad07b97fcc66d2c63dab6c56ddba72e41a4490313338517360860924bd7a5171fb9d21561b05
+  metadata.gz: 92323a5bfb41f8a29ea0b3082ff500078af9944d85fd756a1147b2cc1a7899e7fa4900c086463bfaa775608cf3d7c86137b4e54084f72ce1a2110b3f14d55c2b
+  data.tar.gz: f2d19489b82236baee8be73033b07f3a375585195fc251b17c5ce9f15972911e696e038b282a949a513c8afda4465706f2a581b90c99529da7255e364fe9517b

data/README.md

@@ -5,9 +5,10 @@
 
 # Readthis
 
-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.
+Readthis is a Redis backed cache client for Ruby. It is a drop in replacement
+for any `ActiveSupport` compliant cache and can also be used for [session
+storage](#session-storage).  Above all Readthis emphasizes performance,
+simplicity, and explicitness.
 
 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
@@ -65,24 +66,29 @@ 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
+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:
+defaults to `0`. For example, using database `2`:
 
 ```bash
 REDIS_URL=redis://localhost:6379/2
 ```
 
+[optimizing-usage]: http://sorentwo.com/2015/07/27/optimizing-redis-usage-for-caching.html
+
 ### 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.
+values are always cast as an integer on write. For example:
+
+```ruby
+Readthis::Cache.new(expires_in: 1.week) # don't do this
+Readthis::Cache.new(expires_in: 1.week.to_i) # do this
+```
 
 ### Compression
 
@@ -132,7 +138,7 @@ Readthis.serializers.freeze!
 Readthis::Cache.new(marshal: Oj)
 ```
 
-Be aware that the order in which you add serializers matters. Serializers are
+Be aware that the *order in which you add serializers matters*. Serializers are
 sticky and a flag is stored with each cached value. If you subsequently go to
 deserialize values and haven't configured the same serializers in the same order
 your application will raise errors.
@@ -140,7 +146,7 @@ your application will raise errors.
 ## Fault Tolerance
 
 In some situations it is desirable to keep serving requests from disk or the
-database if Redis crashes. This can be achieved wiht connection fault tolerance
+database if Redis crashes. This can be achieved with connection fault tolerance
 by enabling it at the top level:
 
 ```ruby
@@ -150,6 +156,16 @@ Readthis.fault_tolerant = true
 The default value is `false`, because while it may work for `fetch` operations,
 it isn't compatible with other state-based commands like `increment`.
 
+## Running Arbitrary Redis Commands
+
+Readthis provides access to the underlying Redis connection pool, allowing you
+to run arbitrary commands directly through the cache instance. For example, if
+you wanted to expire a key manually using an instance of `Rails.cache`:
+
+```ruby
+Rails.cache.pool.with { |client| client.expire('foo-key', 60) }
+```
+
 ## Differences From ActiveSupport::Cache
 
 Readthis supports all of standard cache methods except for the following:
@@ -157,11 +173,34 @@ 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.
+* `mute` and `silence!` - You can subscribe to the events `/cache*+active_support/` with `ActiveSupport::Notifications` to [log cache calls manually][notifications].
+
+[notifications]: https://github.com/sorentwo/readthis/issues/22#issuecomment-142595938
 
 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.
 
+## Session Storage
+
+By using [ActionDispatch::Session::CacheStore][cache-store] it's possible to
+reuse `:readthis_store` or specify a new Readthis cache store for storing
+sessions.
+
+```ruby
+Rails.application.config.session_store :cache_store
+```
+
+To specify a separate Readthis instance you can use the `:cache` option:
+
+```ruby
+Rails.application.config.session_store :cache_store,
+  cache: Readthis::Cache.new,
+  expire_after: 2.weeks.to_i
+```
+
+[cache-store]: http://api.rubyonrails.org/classes/ActionDispatch/Session/CacheStore.html
+
 ## Contributing
 
 1. Fork it

data/lib/readthis/cache.rb

@@ -212,7 +212,7 @@ module Readthis
       return {} if keys.empty?
 
       invoke(:read_multi, keys) do |store|
-        values = store.mget(mapping).map { |value| entity.load(value) }
+        values = store.mget(*mapping).map { |value| entity.load(value) }
 
         keys.zip(values).to_h
       end

data/lib/readthis/entity.rb

@@ -40,7 +40,7 @@ module Readthis
     #
     # @example Dumping a value with overrides
     #
-    #   entity.dump(string, compress: false)
+    #   entity.dump(string, compress: false, marshal: JSON)
     #
     def dump(value, options = {})
       compress  = with_fallback(options, :compress)

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pooled active support compliant caching with redis