readthis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 076d20cf4f8bffa4b9a6b6ced603f65020bea46c
-  data.tar.gz: bcb7899c7aa4f98d206ae7fea3e6fc388c7036b4
+  metadata.gz: 513263f9ac89cdc3d8bfc354404778e49902460b
+  data.tar.gz: 525ab985b197507e19c000bcb6dc21683ba068d9
 SHA512:
-  metadata.gz: be88ade839408848ba227ece979dc2d4bb5b4621cdca98eb1f6a3b61fae3d00468940cb9c32eb02b3ca6438e882c680019035583f65c54ed58bd69e33f2c5e3d
-  data.tar.gz: dcb48683aaa8ef72cf0e6770f0334245db4f6198fa244486115123a497ee9bc897568687727ef582ec40b220f81f6b1c1c1221b9c1527a80df714f090a1c4fa5
+  metadata.gz: f9207fe0c1d9746337d17ac05a23acd4bfde8c9d943d1814daa7426160a39fb8d932ea2fd7c69e898097afdf0427eab59cfad320362053547d4e40b3f2a4d4ee
+  data.tar.gz: 14ae7680da85fe6591cc6b623c9f13e2c11dd7905add114288d6ed4138490b4a63a67d0832d0069706246cac73f5fe9de14774f0316e4a4db933ed418e6c60aa

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+services:
+  - redis-server
+script: bin/rspec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.2.0 2014-11-24
+
+- Instrument all caching methods. Will use `ActiveSupport::Notifications`
+  if available, otherwise falls back to a polyfill.
+- 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/README.md

@@ -1,3 +1,6 @@
+[![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)
+
 # Readthis
 
 An ActiveSupport::Cache compatible redis based cache focused on speed,

data/lib/readthis/cache.rb

@@ -1,3 +1,5 @@
+require 'readthis/expanders'
+require 'readthis/notifications'
 require 'redis'
 require 'connection_pool'
 
@@ -5,8 +7,22 @@ module Readthis
   class Cache
     attr_reader :expires_in, :namespace, :pool
 
+    # Provide a class level lookup of the proper notifications module.
+    # Instrumention is expected to occur within applications that have
+    # ActiveSupport::Notifications available, but needs to work even when it
+    # isn't.
+    def self.notifications
+      if Object.const_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.
+    #
+    #   Readthis::Cache.new('redis://localhost:6379/0', namespace: 'cache')
     def initialize(url, options = {})
       @expires_in = options.fetch(:expires_in, nil)
       @namespace  = options.fetch(:namespace, nil)
@@ -17,8 +33,10 @@ module Readthis
     end
 
     def read(key, options = {})
-      with do |store|
-        store.get(namespaced_key(key, merged_options(options)))
+      instrument(:read, key) do
+        with do |store|
+          store.get(namespaced_key(key, merged_options(options)))
+        end
       end
     end
 
@@ -26,18 +44,22 @@ module Readthis
       options    = merged_options(options)
       namespaced = namespaced_key(key, options)
 
-      with do |store|
-        if expiration = options[:expires_in]
-          store.setex(namespaced, expiration, value)
-        else
-          store.set(namespaced, value)
+      instrument(:write, key) do
+        with do |store|
+          if expiration = options[:expires_in]
+            store.setex(namespaced, expiration, value)
+          else
+            store.set(namespaced, value)
+          end
         end
       end
     end
 
     def delete(key, options = {})
-      with do |store|
-        store.del(namespaced_key(key, merged_options(options)))
+      instrument(:delete, key) do
+        with do |store|
+          store.del(namespaced_key(key, merged_options(options)))
+        end
       end
     end
 
@@ -53,14 +75,18 @@ module Readthis
     end
 
     def increment(key, options = {})
-      with do |store|
-        store.incr(namespaced_key(key, merged_options(options)))
+      instrument(:incremenet, key) do
+        with do |store|
+          store.incr(namespaced_key(key, merged_options(options)))
+        end
       end
     end
 
     def decrement(key, options = {})
-      with do |store|
-        store.decr(namespaced_key(key, merged_options(options)))
+      instrument(:decrement, key) do
+        with do |store|
+          store.decr(namespaced_key(key, merged_options(options)))
+        end
       end
     end
 
@@ -68,50 +94,70 @@ module Readthis
       options = merged_options(extract_options!(keys))
       results = []
 
-      with do |store|
-        results = store.pipelined do
-          keys.each { |key| store.get(namespaced_key(key, options)) }
+      instrument(:read_multi, keys) do
+        with do |store|
+          results = store.pipelined do
+            keys.each { |key| store.get(namespaced_key(key, options)) }
+          end
         end
-      end
 
-      keys.zip(results).to_h
+        keys.zip(results).to_h
+      end
     end
 
-    # This must be done in two separate blocks. Redis pipelines return
-    # futures, which can not be resolved until the pipeline has exited.
+    # Fetches multiple keys from the cache using a single call to the server
+    # and filling in any cache misses. All read and write operations are
+    # executed atomically.
+    #
+    #   cache.fetch_multi('alpha', 'beta') do |key|
+    #     "#{key}-was-missing"
+    #   end
     def fetch_multi(*keys)
       results = read_multi(*keys)
       options = merged_options(extract_options!(keys))
 
-      with do |store|
-        store.pipelined do
-          results.each do |key, value|
-            if value.nil?
-              value = yield key
-              write(key, value, options)
-              results[key] = value
+      instrument(:fetch_multi, keys) do
+        with do |store|
+          store.pipelined do
+            results.each do |key, value|
+              if value.nil?
+                value = yield key
+                write(key, value, options)
+                results[key] = value
+              end
             end
           end
         end
-      end
 
-      results
+        results
+      end
     end
 
     def exist?(key, options = {})
-      with do |store|
-        store.exists(namespaced_key(key, merged_options(options)))
+      instrument(:exist?, key) do
+        with do |store|
+          store.exists(namespaced_key(key, merged_options(options)))
+        end
       end
     end
 
     def clear
-      with do |store|
-        store.flushdb
+      instrument(:clear, '*') do
+        with do |store|
+          store.flushdb
+        end
       end
     end
 
     private
 
+    def instrument(operation, key)
+      name    = "cache_#{operation}.active_support"
+      payload = { key: key }
+
+      self.class.notifications.instrument(name, key) { yield(payload) }
+    end
+
     def with(&block)
       pool.with(&block)
     end
@@ -132,9 +178,7 @@ module Readthis
     end
 
     def namespaced_key(key, options)
-      namespace = options[:namespace]
-
-      [namespace, key].compact.join(':')
+      Readthis::Expanders.expand(key, options[:namespace])
     end
   end
 end

data/lib/readthis/expanders.rb

@@ -0,0 +1,15 @@
+module Readthis
+  module Expanders
+    def self.expand(key, namespace = nil)
+      expanded = if key.respond_to?(:cache_key)
+        key.cache_key
+      elsif key.is_a?(Array)
+        key.flat_map { |elem| expand(elem) }.join(':')
+      else
+        key
+      end
+
+      namespace ? "#{namespace}:#{expanded}" : expanded
+    end
+  end
+end

data/lib/readthis/notifications.rb

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

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/readthis.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'redis',           '~> 3.0'
   spec.add_dependency 'connection_pool', '~> 2.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake',    '~> 10.0'
-  spec.add_development_dependency 'rspec',   '~> 3.1'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.1'
 end

data/spec/readthis/cache_spec.rb

@@ -43,6 +43,14 @@ RSpec.describe Readthis::Cache do
       sleep 1.01
       expect(cache.read('some-key')).to be_nil
     end
+
+    it 'expands non-string keys' do
+      key_obj = double(cache_key: 'custom-key')
+
+      cache.write(key_obj, 'some-value')
+
+      expect(cache.read('custom-key')).to eq('some-value')
+    end
   end
 
   describe '#fetch' do

data/spec/readthis/expanders_spec.rb

@@ -0,0 +1,26 @@
+require 'readthis/expanders'
+
+RSpec.describe Readthis::Expanders do
+  def expand(key, namespace = nil)
+    Readthis::Expanders.expand(key, namespace)
+  end
+
+  describe '#expand' do
+    it 'namespaces a plain string' do
+      expect(expand('thing', 'space')).to eq('space:thing')
+    end
+
+    it 'expands an object that has a cache_key method' do
+      object = double(cache_key: 'custom-key')
+
+      expect(expand(object)).to eq('custom-key')
+    end
+
+    it 'expands an array of objects' do
+      object = double(cache_key: 'gamma')
+
+      expect(expand(['alpha', 'beta'])).to eq('alpha:beta')
+      expect(expand([object, object])).to eq('gamma:gamma')
+    end
+  end
+end

data/spec/readthis/notifications_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -98,9 +99,13 @@ files:
 - lib/active_support/cache/readthis_store.rb
 - lib/readthis.rb
 - lib/readthis/cache.rb
+- lib/readthis/expanders.rb
+- lib/readthis/notifications.rb
 - lib/readthis/version.rb
 - readthis.gemspec
 - spec/readthis/cache_spec.rb
+- spec/readthis/expanders_spec.rb
+- spec/readthis/notifications_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sorentwo/readthis
 licenses:
@@ -128,4 +133,6 @@ specification_version: 4
 summary: Pooled active support compliant caching with redis
 test_files:
 - spec/readthis/cache_spec.rb
+- spec/readthis/expanders_spec.rb
+- spec/readthis/notifications_spec.rb
 - spec/spec_helper.rb