readthis 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1763594017ac9b87a099ca476d01c9f3823a0b0
-  data.tar.gz: 23e9363a5cc0c997c70f923f0ea21c50477843ff
+  metadata.gz: 39c546b2720bf3e983c15c8fe9d7a60fea06cf75
+  data.tar.gz: 0a41d522ce9f5a096bf967a344d3e71ab1c01b56
 SHA512:
-  metadata.gz: 0c3868ec4afab92154c4a9bc542de628224086760a6c8c5275d9ba83ede290b4800f209eb3c3b5349d11cd2f2f63e0aa5858e587308ac9d2988ecc6a35989511
-  data.tar.gz: 3ffd2cc9546da805453a27d5ca33a4a35525582eb7905973a45293e4093ed47c70ebe37b4e3fb8f16035074cb558de08e271b2de712b8f52e237a8f386db9ca3
+  metadata.gz: 669ad6115ac86b13bb8ff8108a839d6c9890fbf4ca456ee8bd5f06dfe53578532559a8507a9cdd8a7ed7458341def6acee7e7e051b479fef2828c3312b0f32b8
+  data.tar.gz: 15ebfbe02678355846db403aa48b800212aeb5115c05b3b14107ba603db2e74445403ad24988b2161eaff7c5d8e0662b8c7fa1bab2a0927f290ccbf943fa5648

data/CHANGELOG.md

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

data/PERFORMANCE.md

@@ -1,4 +1,4 @@
-Results from the various benchmarks in `./bencharks`. Hardware doesnt't matter
+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.
 

data/README.md

@@ -7,10 +7,14 @@
 
 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. Below are some performance comparisons
-against the only other notable redis cache implementation, `redis-activesupport`,
-which has been abandoned and doesn't actually comply to Rails 4.2 cache store
-behavior for `fetch_multi`.
+pooling), 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.
+
+[stackoverflow]: http://stackoverflow.com/questions/10558465/memcache-vs-redis
 
 ## Footprint & Performance
 
@@ -52,6 +56,8 @@ redis database, which defaults to 0. For example, using database 2:
 REDIS_URL=redis://localhost:6379/2
 ```
 
+[store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html
+
 ### Compression
 
 Compression can be enabled for all actions by passing the `compress` flag. By
@@ -72,7 +78,7 @@ config.cache_store = :readthis_store, ENV.fetch('REDIS_URL'), {
 
 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.
+be desirable to use a faster but less flexible marshaller.
 
 Use Oj for JSON marshalling, extremely fast, limited types:
 
@@ -93,5 +99,3 @@ Readthis supports all of standard cache methods except for the following:
 * `cleanup` - redis does this with ttl for us already
 * `delete_matched` - you really don't want to perform key matching operations
   in redis. They are linear time and only support basic globbing.
-
-[store]: http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html

data/benchmarks/multi.rb

@@ -5,10 +5,12 @@ Bundler.setup
 require 'benchmark/ips'
 require 'dalli'
 require 'redis-activesupport'
+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)
@@ -16,12 +18,17 @@ readthis  = Readthis::Cache.new(REDIS_URL, 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
@@ -38,6 +45,10 @@ Benchmark.ips do |x|
 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

data/lib/readthis/cache.rb

@@ -75,22 +75,41 @@ module Readthis
       end
     end
 
+    # Writes data to the cache using the given key. Will overwrite whatever
+    # value is already stored at that key.
+    #
+    # @param [String] Key for lookup
+    # @param [Hash] Optional overrides
+    #
+    # @example
+    #
+    #   cache.write('some-key', 'a bunch of text')                     # => 'OK'
+    #   cache.write('some-key', 'short lived', expires_in: 60)         # => 'OK'
+    #   cache.write('some-key', 'lives elsehwere', namespace: 'cache') # => 'OK'
+    #
     def write(key, value, options = {})
-      options    = merged_options(options)
-      namespaced = namespaced_key(key, options)
+      options = merged_options(options)
 
       invoke(:write, key) do |store|
-        if expiration = options[:expires_in]
-          store.setex(namespaced, expiration, entity.dump(value))
-        else
-          store.set(namespaced, entity.dump(value))
-        end
+        write_entity(key, value, store, options)
       end
     end
 
+    # Delete the value stored at the specified key. Returns `true` if
+    # anything was deleted, `false` otherwise.
+    #
+    # @params [String] The key for lookup
+    # @params [Hash] Optional overrides
+    #
+    # @example
+    #
+    #   cache.delete('existing-key') # => true
+    #   cache.delete('random-key')   # => false
     def delete(key, options = {})
+      namespaced = namespaced_key(key, merged_options(options))
+
       invoke(:delete, key) do |store|
-        store.del(namespaced_key(key, merged_options(options)))
+        store.del(namespaced) > 0
       end
     end
 
@@ -162,9 +181,20 @@ module Readthis
     # and filling in any cache misses. All read and write operations are
     # executed atomically.
     #
+    # @overload fetch_multi(keys)
+    #   Return all values fro the given keys, applying the block to the key
+    #   when a value is missing.
+    #   @param [String] One or more keys to fetch
+    #
+    # @example
+    #
     #   cache.fetch_multi('alpha', 'beta') do |key|
     #     "#{key}-was-missing"
     #   end
+    #
+    #   cache.fetch_multi('a', 'b', expires_in: 60) do |key|
+    #     key * 2
+    #   end
     def fetch_multi(*keys)
       results = read_multi(*keys)
       options = merged_options(extract_options!(keys))
@@ -173,8 +203,8 @@ module Readthis
         store.pipelined do
           results.each do |key, value|
             if value.nil?
-              value = yield key
-              write(key, value, options)
+              value = yield(key)
+              write_entity(key, value, store, options)
               results[key] = value
             end
           end
@@ -184,16 +214,46 @@ module Readthis
       end
     end
 
+    # Returns `true` if the cache contains an entry for the given key.
+    #
+    # @param [String] Key for lookup
+    # @param [Hash] Optional overrides
+    #
+    # @example
+    #
+    #   cache.exist?('some-key') # => false
+    #   cache.exist?('some-key', namespace: 'cache') # => true
+    #
     def exist?(key, options = {})
       invoke(:exist?, key) do |store|
         store.exists(namespaced_key(key, merged_options(options)))
       end
     end
 
-    def clear
+    # Clear the entire cache. This flushes the current database, no
+    # globbing is applied.
+    #
+    # @param [Hash] Options, only present for compatibility.
+    #
+    # @example
+    #
+    #   cache.clear #=> 'OK'
+    def clear(options = {})
       invoke(:clear, '*', &:flushdb)
     end
 
+    protected
+
+    def write_entity(key, value, store, options)
+      namespaced = namespaced_key(key, options)
+
+      if expiration = options[:expires_in]
+        store.setex(namespaced, expiration, entity.dump(value))
+      else
+        store.set(namespaced, entity.dump(value))
+      end
+    end
+
     private
 
     def alter(key, amount, options)

data/lib/readthis/version.rb

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

data/spec/readthis/cache_spec.rb

@@ -158,6 +158,22 @@ RSpec.describe Readthis::Cache do
         'b' => 'bb',
         'c' => 3,
       )
+
+      expect(cache.read('b')).to eq('bb')
+    end
+
+    it 'uses passed options' do
+      cache.write('a', 1, namespace: 'alph')
+
+      results = cache.fetch_multi('a', 'b', namespace: 'alph') { |key| key }
+
+      expect(results).to eq(
+        'a' => 1,
+        'b' => 'b'
+      )
+
+      expect(cache.read('b')).to be_nil
+      expect(cache.read('b', namespace: 'alph')).not_to be_nil
     end
   end
 
@@ -175,10 +191,14 @@ RSpec.describe Readthis::Cache do
   describe '#delete' do
     it 'deletes an existing key' do
       cache.write('not-long', 'for this world')
-      cache.delete('not-long')
 
+      expect(cache.delete('not-long')).to be_truthy
       expect(cache.read('not-long')).to be_nil
     end
+
+    it 'safely returns false if nothing is deleted' do
+      expect(cache.delete('no-such-key')).to be_falsy
+    end
   end
 
   describe '#increment' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis