prefixed_cache_store 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ae20416193b23bdb080fdbb7ccebbb9eb5912f4
+  data.tar.gz: 9c88a5ff0f2a52f573f2ed7b1166651547f6b6c3
+SHA512:
+  metadata.gz: c60c6c9af8e90303dfab957406a6d54a29fe3d5b653f81f5cf841d9897624627dcae7150a2526f965916df82d9c612053a2e0137a02ab75044565a1fdae07e9c
+  data.tar.gz: 58e34568ae7ee5720af4347280dd73ab95417352cb453eea74469d86db535f68daebafd8f089ee5801886674eefc484e2670ee45c31a74483ab15625ed829d59

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2
+cache: bundler

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "activesupport", "~> 3"
+  gem 'rspec', '~> 3.1'
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Julik Tarkhanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+## prefixed_cache_store
+ 
+A cache wrapper for ActiveSupport that allows you to expire parts of your cache imperatively.
+
+Sometimes you need to selectively nuke parts of your cache. All cache stores for Rails support the `Store#clear()`
+method, but it usually nukes the entire backing store - be it memcached or Redis. This is mostly not what you expect.
+
+Originally, this wrapper has been developed to selectively expire cached items for translations when the translations
+have been updated on the backend.
+
+The way it works is that the wrapper accepts any `ActiveSupport::Cache::Store` and will prefix all keys going into or out of
+that `Store`. The prefix will be memorized under a separate cache key. This cache key is going to be set periodically to prevent it from expiring too early.
+
+When you increase this prefix value, all of the keys going through the store will change - so new
+versions of the values are going to be generated and saved to the store. Consider a simple example:
+
+    store = PrefixedCacheStore.new(Rails.cache, "pfx") # Sets "pfx-version" to 0
+    store.write("foo", "Hello!") # Writes "pfx-0/foo"
+    store.read("foo") # Reads "pfx-0/foo"
+    store.clear # Replaces "pfx-version" with 1, does not flush your cache cluster
+    store.read("foo") # Reads "pfx-1/foo", which is not found now
+    store.write("foo", "Different hello!") # Writes "pfx-1/foo"
+
+The value of the prefixed `version` key will be cached in memory of the Ruby process for 10 seconds between refetches - so most
+of page renders will incur no more than one `read()` call for that specific key. Any `Store` can be wrapped in this object,
+to your liking.
+
+The gem has been extensively tested in production with Rails 3.x but should work fine with Rails 4 as well.
+
+## Contributing to prefixed_cache_store
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require_relative 'lib/prefixed_cache_store'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = PrefixedCacheStore::VERSION
+  gem.name = "prefixed_cache_store"
+  gem.homepage = "http://github.com/julik/prefixed_cache_store"
+  gem.license = "MIT"
+  gem.summary = %Q{Namespaced versioned cache wrapper for ActiveSupport}
+  gem.description = %Q{Allows you to expire parts of your cache separately}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+task :default => :spec
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "prefixed_cache_store #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/prefixed_cache_store.rb

@@ -0,0 +1,140 @@
+# encoding: ascii
+require 'forwardable'
+
+# A caching store that will expire only the keys saved through it, by using a common prefix
+# for the namespace and the version number that can be ratched up to "unlink" all the related keys.
+# It assumes that the keys are being evicted automatically if they do not get used often.
+class PrefixedCacheStore
+  VERSION = '0.0.1'
+  
+  RETAIN_PREFIX_FOR_SECONDS = 10
+  
+  extend Forwardable
+  
+  attr_reader :prefix, :store
+  
+  def_delegators :@store, :silence?, 
+    :silence, :silence!,
+    :mute, :cleanup, 
+    :logger, :logger=,
+    :instrument=, :instrument, :namespace, :namespace=
+  
+  def initialize(store, prefix = 'pfx')
+    @store = store
+    @prefix = prefix
+  end
+  
+  def fetch(name, options=nil)
+    if block_given?
+      @store.fetch(prefix_key(name), options) { yield }
+    else
+      @store.fetch(prefix_key(name), options)
+    end
+  end
+
+  def read(name, options=nil)
+    @store.read(prefix_key(name), options)
+  end
+
+  def write(name, value, options=nil)
+    @store.write(prefix_key(name), value, options)
+  end
+
+  def exist?(name, options=nil)
+    @store.exist?(prefix_key(name), options)
+  end
+
+  def delete(name, options=nil)
+    @store.delete(prefix_key(name), options)
+  end
+
+  # Reads multiple keys from the cache using a single call to the
+  # servers for all keys. Keys must be Strings.
+  def read_multi(*names)
+    names.extract_options!
+    prefixed_names = names.map{|e| prefix_key(e) }
+    result = @store.read_multi(*prefixed_names)
+    # Unprefix the keys received
+    result.inject({}) do |memo, (prefixed_key, value)|
+      memo.merge(unprefix_key(prefixed_key) => value)
+    end
+  end
+  
+  # Increment a cached value.
+  def increment(name, amount = 1, options=nil)
+    @store.increment(prefix_key(name), amount, options)
+  end
+
+  # Decrement a cached value.
+  def decrement(name, amount = 1, options=nil)
+    @store.decrement(prefix_key(name), amount, options)
+  end
+
+  # Bump the version prefix making all keys obsolete.
+  def clear(options=nil)
+    bump_version! # First bump the version
+    @last_prefix = nil # Then make sure the cached version number will not be used
+    get_and_set_current_version
+  end
+
+  private
+  
+  def bump_version!
+    key = [@prefix, "version"].join('-')
+    @store.write(key, @store.read(key).to_i + 1) # Redis does not support increment() with ActiveSupport values
+  end
+  
+  # If the version prefix was last seen not too long ago, reuse it without asking the backend
+  # for it over and over. If it wasn't just fetch it as normally
+  def get_and_set_current_version
+    if @last_prefix && @last_seen && (Time.now.utc - @last_seen) < RETAIN_PREFIX_FOR_SECONDS
+      @last_prefix
+    else
+      @last_seen = Time.now.utc
+      @last_prefix = read_and_set_current_version_from_backend
+      @last_prefix
+    end
+  end
+  
+  def read_and_set_current_version_from_backend
+    key = [@prefix, "version"].join('-')
+    @store.fetch(key) { 0 }
+  end
+  
+  def prefix_key(key)
+    current_version = get_and_set_current_version
+    [@prefix, current_version, expanded_key(key)].join('-')
+  end
+  
+  def unprefix_key(key)
+    @prefix_removal_re ||= /^#{prefix}\-\d+\-/ # Memoize to not parse the regex all the time
+    key.gsub(@prefix_removal_re, '')
+  end
+  
+  # Expand key to be a consistent string value. Invoke +cache_key+ if
+  # object responds to +cache_key+. Otherwise, to_param method will be
+  # called. If the key is a Hash, then keys will be sorted alphabetically.
+  # Picked from the Dalli store adapter (cant use that one because it is a private method)
+  def expanded_key(key) # :nodoc:
+    return key.cache_key.to_s if key.respond_to?(:cache_key)
+
+    case key
+    when Array
+      if key.size > 1
+        key = key.collect{|element| expanded_key(element)}
+      else
+        key = key.first
+      end
+    when Hash
+      key = key.sort_by { |k,_| k.to_s }.collect{|k,v| "#{k}=#{v}"}
+    end
+
+    key = key.to_param
+    if key.respond_to? :force_encoding
+      key = key.dup
+      key.force_encoding('binary')
+    end
+    key
+  end
+
+end

data/spec/prefixed_cache_store_spec.rb

@@ -0,0 +1,133 @@
+require_relative 'spec_helper'
+require 'active_support'
+
+describe PrefixedCacheStore do
+  describe 'instantiation' do
+    it 'creates a store wrapping another without passing the prefix' do
+      some_store = double('SomeStore')
+      store = described_class.new(some_store)
+      
+      expect(store.store).to eq(some_store)
+      expect(store.prefix).to eq('pfx')
+    end
+    it 'creates a store wrapping another with given the prefix' do
+      some_store = double('SomeStore')
+      store = described_class.new(some_store, 'translations')
+      expect(store.store).to eq(some_store)
+      expect(store.prefix).to eq('translations')
+    end
+  end
+  
+  describe 'delegated methods' do
+    it 'get forwarded to the backing store' do
+      method_names = [:silence?, :silence, :silence!,
+        :mute, :cleanup, :logger, :logger=, :instrument=, :instrument,
+        :namespace, :namespace=
+      ]
+      
+      store_double = double('SomeStore') 
+      subject = described_class.new(store_double)
+      method_names.each do | method_name |
+        expect(subject).to respond_to(method_name)
+        expect(store_double).to receive(method_name).once
+        subject.public_send(method_name)
+      end
+    end
+  end
+  
+  describe 'fetch' do
+    it 'fetches the key and saves it to the cache and it then exists?' do
+      some_store = ActiveSupport::Cache::MemoryStore.new
+      subject = described_class.new(some_store, 'pre')
+      
+      data = subject.fetch("record1") { 123 }
+      expect(data).to eq(123)
+      expect(subject.exist?('record1')).to eq(true)
+      
+      expect(some_store.read("pre-version")).to eq(0), "Should have initialized the version to 0"
+      expect(some_store.read("pre-0-record1")).to eq(123), "Should have saved the prefixed value"
+      expect(some_store.read("record1")).to be_nil, "Should not have saved the unprefixed key"
+    end
+  end
+  
+  describe 'write' do
+    it 'writes the key with the prefix and it then exists?' do
+      some_store = ActiveSupport::Cache::MemoryStore.new
+      subject = described_class.new(some_store, 'pre')
+      
+      subject.write("record2", 456)
+      expect(subject.exist?('record2')).to eq(true)
+      
+      expect(some_store.read("pre-version")).to eq(0)
+      expect(some_store.read("pre-0-record2")).to eq(456)
+    end
+  end
+  
+  describe 'read' do
+    it 'reads the prefixed key instead' do
+      some_store = ActiveSupport::Cache::MemoryStore.new
+      subject = described_class.new(some_store, 'pre')
+      
+      some_store.write('pre-version', 0)
+      some_store.write('pre-0-record3', "Ola peoples!")
+      
+      expect(subject.read("record3")).to eq('Ola peoples!')
+    end
+  end
+  
+  describe 'read_multi' do
+    it 'performs multi-reads' do
+      some_store = ActiveSupport::Cache::MemoryStore.new
+      subject = described_class.new(some_store, 'pre')
+      
+      subject.write('record1', 'John')
+      subject.write('record2', 'Jake')
+      subject.write('record3', 'Mary')
+      
+      expect(subject.read_multi('record1', 'record2', 'record3')).to eq({"record1"=>"John", "record2"=>"Jake", "record3"=>"Mary"})
+      
+      expect(some_store.read("pre-version")).to eq(0)
+      expect(some_store.read("pre-0-record1")).to eq('John')
+      expect(some_store.read("pre-0-record2")).to eq('Jake')
+      expect(some_store.read("pre-0-record3")).to eq('Mary')
+    end
+  end
+  
+  describe 'clear' do
+    it 'bumps the version' do
+      some_store = ActiveSupport::Cache::MemoryStore.new
+      subject = described_class.new(some_store, 'pre')
+      
+      subject.write('record1', 'John')
+      expect(subject.read('record1')).to eq('John')
+      
+      expect(some_store.read("pre-version")).to eq(0)
+      
+      subject.clear
+      
+      expect(subject.read('record1')).to be_nil
+      subject.write('record1', 'Jake')
+      expect(subject.read('record1')).to eq('Jake')
+      
+      expect(some_store.read("pre-version")).to eq(1)
+      expect(some_store.read("pre-0-record1")).to eq('John')
+      expect(some_store.read("pre-1-record1")).to eq('Jake')
+    end
+  end
+  
+  describe 'current_version'do
+    it 'caches the current value for 10 seconds' do
+      some_store = ActiveSupport::Cache::MemoryStore.new
+      expect(some_store).to receive(:fetch).with("pre-version").once { 4 }
+      
+      subject = described_class.new(some_store, 'pre')
+      5.times { subject.read('record1') }
+      
+      some_seconds_after = Time.now + 11.seconds
+      allow(Time).to receive(:now) { some_seconds_after }
+      expect(some_store).to receive(:fetch).with("pre-version").once { 4 }
+      subject.read('record1')
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'prefixed_cache_store'
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: prefixed_cache_store
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows you to expire parts of your cache separately
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prefixed_cache_store.rb
+- spec/prefixed_cache_store_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/julik/prefixed_cache_store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Namespaced versioned cache wrapper for ActiveSupport
+test_files: []