namespaced-cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df2ceaeb59b553fdfb25f4bdfcece83abacbcaf0
+  data.tar.gz: 784a96a45979f32d4484483000ebc34662b2642f
+SHA512:
+  metadata.gz: 2a4816cda3f35055c6b22d7d7ff2cf6e36220f49901f1632d9df1b2410fe8c10eb80cb963745df963503e49b6a2016007b634826c095f4ca625324e0b7aeb22c
+  data.tar.gz: 6259320fe062835b32f9f326991d6d3f7db4eebc8cb5ecde89b9583ab908441e6eab11a6a1e282cc1ca981d735c29dc0588368670b4df0adbe0d1e2cfe3abe3b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prefixed-cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric J. Holmes
+
+MIT License
+
+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,21 @@
+# ActiveSupport::Cache::NamespacedStore
+
+A simple ActiveSupport::Cache implementation that wraps another implementation to prefix/namespace keys.
+
+## Usage
+
+```ruby
+Rails.cache.write('prefix:1', 'foo')
+
+cache = ActiveSupport::Cache::NamespacedStore.new 'prefix:', Rails.cache
+cache.read '1'
+# => 'foo'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/active_support/cache/namespaced_store.rb

@@ -0,0 +1,46 @@
+require 'active_support/cache'
+
+module ActiveSupport::Cache
+  # Public: A wrapper around an ActiveSupport::Cache to prefix all keys.
+  #
+  # Example
+  #
+  #   cache = ActiveSupport::Cache::NamespacedStore.new 'namespace:', Rails.cache
+  class NamespacedStore
+    attr_reader :namespace, :store
+
+    def initialize(namespace, store)
+      @namespace = namespace
+      @store = store
+    end
+
+    def read(key, *args, &block)
+      store.read(namespaced(key), *args, &block)
+    end
+
+    def read_multi(*keys)
+      k = keys.map { |key| namespaced(key) }
+      store.read_multi(*k).each_with_object(Hash.new) do |t,memo|
+        memo[t[0].sub(namespace, '')] = t[1]
+      end
+    end
+
+    def write(key, *args, &block)
+      store.write(namespaced(key), *args, &block)
+    end
+
+    def fetch(key, *args, &block)
+      store.fetch(namespaced(key), *args, &block)
+    end
+
+    def clear
+      store.delete_matched(namespace)
+    end
+
+    private
+
+    def namespaced(key)
+      "#{namespace}#{key}"
+    end
+  end
+end

data/lib/namespaced-cache.rb

@@ -0,0 +1,2 @@
+require 'namespaced_cache/version'
+require 'active_support/cache/namespaced_store'

data/lib/namespaced_cache/version.rb

@@ -0,0 +1,3 @@
+module NamespacedCache
+  VERSION = '0.0.1'
+end

data/namespaced-cache.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'namespaced_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'namespaced-cache'
+  spec.version       = NamespacedCache::VERSION
+  spec.authors       = ['Eric J. Holmes']
+  spec.email         = ['eric@ejholmes.net']
+  spec.description   = %q{An ActiveSupport::Cache implementation for prefixing.}
+  spec.summary       = %q{An ActiveSupport::Cache implementation for prefixing.}
+  spec.homepage      = 'https://github.com/remind101/namespaced-cache'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.4.2'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+end

data/spec/active_support/cache/prefixed_store_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe ActiveSupport::Cache::NamespacedStore do
+  let(:store) { ActiveSupport::Cache::MemoryStore.new }
+  let(:cache) { described_class.new 'prefix:', store }
+
+  before do
+    store.clear
+  end
+
+  describe '#write' do
+    it 'writes to the cache' do
+      expect {
+        cache.write('key', 'value')
+      }.to change { store.read('prefix:key') }.from(nil).to('value')
+    end
+  end
+
+  describe '#read' do
+    context 'when the item is in cache' do
+      before do
+        store.write('prefix:key', 'value')
+      end
+
+      it 'reads the item' do
+        expect(cache.read('key')).to eq 'value'
+      end
+    end
+  end
+
+  describe '#read_multi' do
+    context 'when no items are in cache' do
+      it 'does not blow up' do
+        expect(cache.read_multi('key1')).to eq Hash.new
+      end
+    end
+
+    context 'when the items are in cache' do
+      before do
+        store.write('prefix:key1', 'value1')
+        store.write('prefix:key2', 'value2')
+      end
+
+      it 'reads the items' do
+        expect(cache.read_multi('key1', 'key2')).to eq 'key1' => 'value1', 'key2' => 'value2'
+      end
+    end
+  end
+
+  describe '#fetch' do
+    context 'when the item is not in cache' do
+      it 'caches the item' do
+        expect {
+          cache.fetch('key') do
+            'value'
+          end
+        }.to change { store.read('prefix:key') }.from(nil).to('value')
+      end
+    end
+  end
+
+  describe '#clear' do
+    before do
+      store.write('prefix:key1', 'value1')
+      store.write('key1', 'value1')
+    end
+
+    it 'clears prefixed keys' do
+      expect {
+        cache.clear
+      }.to change { store.read('prefix:key1') }.from('value1').to(nil)
+    end
+
+    it 'does not clear keys that are not prefixed' do
+      expect {
+        cache.clear
+      }.to_not change { store.read('key1') }.from('value1')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.require :default, :test
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: namespaced-cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: An ActiveSupport::Cache implementation for prefixing.
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_support/cache/namespaced_store.rb
+- lib/namespaced-cache.rb
+- lib/namespaced_cache/version.rb
+- namespaced-cache.gemspec
+- spec/active_support/cache/prefixed_store_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/remind101/namespaced-cache
+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.0.14
+signing_key: 
+specification_version: 4
+summary: An ActiveSupport::Cache implementation for prefixing.
+test_files:
+- spec/active_support/cache/prefixed_store_spec.rb
+- spec/spec_helper.rb