cache-client 0.0.3

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/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 0.0.3
+
+* Fixes cache key generation for arrays of keys
+* Adds specs
+
+# 0.0.2
+
+* The beginning

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cache-client.gemspec
+gemspec
+
+group :test, :development do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thorben Schröder
+
+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,52 @@
+# Cache::Client
+
+A client to store and retrieve data in a cache backend. The client is backend agnostic and can be used as a *noop-cache* without any backend.
+
+## Usage
+
+### Setup
+
+To instantiate a new cache client you pass in a class of a cache backend and a list of parameters for that array. If either the backend class or all parameters are ``nil`` the cache will fall back to a noon mode. In that mode it will work without any errors but not cache anything at all. This is useful for tests and development mode.
+
+```ruby
+cache_client = Cache::Client.new(Cache::BackendClass, 'http://localhost', '8080')
+```
+
+Instead of an actual class instance you can also pass in a string of the backend's class name
+
+```ruby
+cache_client = Cache::Client.new('Cache::BackendClass', 'http://localhost', '8080')
+```
+
+### Cache keys
+
+Cache keys can be any objects or arrays of objects. The ``Cache::Client`` will turn each object to a cache key using this methods in a top to bottom order:
+
+* ``#to_cache_key``
+* the key itself if it is a string
+* the string version of the key if it is a number
+* A SHA1 hash of the ``Marshal.dump`` of the key object
+
+Objects in an array will each be turned into cache key first and then concatenated.
+
+### Set a value in the cache
+
+```ruby
+cache_client.set(['my', 'key'], 123) # => 123
+```
+
+### Get a value from the cache
+
+```ruby
+cache_client.get(['my', 'key']) # => 123
+```
+
+### Set or get in the cache
+
+This will set a value in the cache if the given key does not exist, otherwise it just returns the value under that key from the cache.
+
+```ruby
+cache_client.get(['my', 'key']) do
+  123
+end # => 123
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :test

data/cache-client.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache-client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cache-client"
+  gem.version       = Cache::Client::VERSION
+  gem.authors       = ["Thorben Schröder"]
+  gem.email         = ["stillepost@gmail.com"]
+  gem.description   = %q{A client to store and retrieve data in a cache backend.}
+  gem.summary       = %q{A client to store and retrieve data in a cache backend.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/cache-backend/noop_backend.rb

@@ -0,0 +1,15 @@
+module Cache
+  module Backend
+    class NoopBackend
+      def initialize(*args)
+      end
+
+      def get(key)
+      end
+
+      def set(key, value)
+        value
+      end
+    end
+  end
+end

data/lib/cache-client.rb

@@ -0,0 +1,50 @@
+module Cache
+  class Client
+  end
+end
+
+require "cache-client/version"
+require "cache-client/error"
+require "cache-client/utils"
+require "cache-client/key_builder"
+require "cache-backend/noop_backend"
+
+module Cache
+  class Client
+    attr_reader :backend
+    def initialize(backend, *args)
+      @backend = backendify(backend).new(*args)
+    end
+
+    def set(key, value)
+      @backend.set(keyify(key), value)
+    end
+
+    def get(key)
+      @backend.get(keyify(key))
+    end
+
+    def fetch(key)
+      existing_value = get(key)
+      return existing_value if existing_value
+      set(key, yield)
+    end
+
+    protected
+    def backendify(backend)
+      return Cache::Backend::NoopBackend unless backend
+
+      return backend if backend.kind_of?(Class)
+
+      clazz = Class
+      Utils.camelize_string(backend).split('::').each do |const|
+        clazz = clazz.const_get(const)
+      end
+      clazz
+    end
+
+    def keyify(keys)
+      Array(keys).map {|key| KeyBuilder.new(key)}.join('-')
+    end
+  end
+end

data/lib/cache-client/error.rb

@@ -0,0 +1,4 @@
+class Cache::Client
+  class Error < StandardError
+  end
+end

data/lib/cache-client/key_builder.rb

@@ -0,0 +1,18 @@
+require 'digest/sha1'
+
+class Cache::Client
+  class KeyBuilder
+    def initialize(key)
+      @key = key
+    end
+
+    def to_s
+      return @key.to_cache_key if @key.respond_to?(:to_cache_key)
+
+      return @key if @key.kind_of?(String)
+      return @key.to_s if @key.kind_of?(Numeric)
+
+      return Digest::SHA1.hexdigest(Marshal.dump(@key))
+    end
+  end
+end

data/lib/cache-client/utils.rb

@@ -0,0 +1,7 @@
+class Cache::Client
+  class Utils
+     def self.camelize_string(str)
+      str.gsub('-', '_').sub(/^[a-z\d]*/) { $&.capitalize }.gsub(/(?:_|(\/))([a-z\d]*)/i) {$2.capitalize}
+    end
+  end
+end

data/lib/cache-client/version.rb

@@ -0,0 +1,5 @@
+module Cache
+  class Client
+    VERSION = "0.0.3"
+  end
+end

data/spec/cache_client_spec.rb

@@ -0,0 +1,64 @@
+require_relative './spec_helper'
+
+describe Cache::Client do
+  describe "without a cache class" do
+    before do
+      @client = Cache::Client.new(nil)
+    end
+
+    it "does not cache anything" do
+      @client.set('bla', 123).must_equal(123)
+      @client.get('bla').must_be_nil
+      @client.fetch('bla') do
+        456
+      end.must_equal 456
+    end
+  end
+
+  describe "backends" do
+    it "can be set using a class as a backend descriptor" do
+      client = Cache::Client.new(Cache::InMemoryBackend)
+      client.backend.kind_of?(Cache::InMemoryBackend).must_equal true
+    end
+
+    it "can be set using a class name string as a backend descriptor" do
+      client = Cache::Client.new('Cache::InMemoryBackend')
+      client.backend.kind_of?(Cache::InMemoryBackend).must_equal true
+    end
+
+    it "passes a list of options through to the backend" do
+      class ArgumentTestBackend
+        attr_reader :args
+        def initialize(*args)
+          @args = args
+        end
+      end
+
+      client = Cache::Client.new(ArgumentTestBackend, 1, 2, 3, {'four' => :five})
+      client.backend.args.must_equal([1, 2, 3, {'four' => :five}])
+    end
+
+    describe "that are initialized" do
+      before do
+        @client = Cache::Client.new(Cache::InMemoryBackend)
+      end
+
+      it "can set/get values" do
+        @client.set('bla', 123).must_equal(123)
+        @client.get('bla').must_equal(123)
+      end
+
+      it "can fetch values" do
+        @client.fetch(['bla', 'fetch']) do
+          123
+        end.must_equal(123)
+
+        @client.fetch(['bla', 'fetch']) do
+          456
+        end.must_equal(123)
+
+        @client.get(['bla', 'fetch']).must_equal(123)
+      end
+    end
+  end
+end

data/spec/in_memory_backend.rb

@@ -0,0 +1,15 @@
+module Cache
+  class InMemoryBackend
+    def initialize(*args)
+      @store = {}
+    end
+
+    def get(key)
+      @store[key]
+    end
+
+    def set(key, value)
+      @store[key] = value
+    end
+  end
+end

data/spec/key_building_spec.rb

@@ -0,0 +1,74 @@
+require_relative './spec_helper'
+
+require 'digest/sha1'
+
+class ObectWithToCacheKey
+  def initialize(arg)
+    @arg = arg
+  end
+
+  def to_cache_key
+    "_#{@arg}_#{@arg}_"
+  end
+end
+
+class ObectWithoutToCacheKey
+  def initialize(arg)
+    @arg = arg
+  end
+end
+
+class TestingBackend
+  attr_reader :last_key
+
+  def get(key)
+    @last_key = key
+    nil
+  end
+end
+
+describe Cache::Client do
+  describe "cache keys" do
+    before do
+      @client = Cache::Client.new(TestingBackend)
+    end
+
+    it "uses #to_cache_key method when available" do
+      key = ObectWithToCacheKey.new('bla')
+      @client.get(key)
+      @client.backend.last_key.must_equal(key.to_cache_key())
+    end
+
+    it "uses the key itself if it is a string" do
+      @client.get('bla')
+      @client.backend.last_key.must_equal('bla')
+    end
+
+    it "uses a string version of the key if it is a number" do
+      @client.get(10)
+      @client.backend.last_key.must_equal('10')
+
+      @client.get(7.3)
+      @client.backend.last_key.must_equal('7.3')
+    end
+
+    it "uses a SHA1 of the marshalled key when #to_cache_key is not available and the key is neither a string nor a number" do
+      key = ObectWithoutToCacheKey.new('bla')
+      @client.get(key)
+      expected_key = Digest::SHA1.hexdigest(Marshal.dump(key))
+
+      @client.backend.last_key.must_equal(expected_key)
+    end
+
+    it "concatenates built keys for arrays of keys" do
+      key1 = ObectWithToCacheKey.new('bla')
+      key2 = ObectWithoutToCacheKey.new('bla')
+      key3 = 'yeah'
+      key4 = 65.7
+
+      @client.get([key1, key2, key3, key4])
+      expected_key = "#{key1.to_cache_key}-#{Digest::SHA1.hexdigest(Marshal.dump(key2))}-#{key3}-#{key4}"
+      @client.backend.last_key.must_equal(expected_key)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+Bundler.require
+
+require 'minitest/autorun'
+
+require_relative './in_memory_backend'
+
+require 'cache-client'

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: cache-client
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Thorben Schröder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies: []
+description: A client to store and retrieve data in a cache backend.
+email:
+- stillepost@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache-client.gemspec
+- lib/cache-backend/noop_backend.rb
+- lib/cache-client.rb
+- lib/cache-client/error.rb
+- lib/cache-client/key_builder.rb
+- lib/cache-client/utils.rb
+- lib/cache-client/version.rb
+- spec/cache_client_spec.rb
+- spec/in_memory_backend.rb
+- spec/key_building_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A client to store and retrieve data in a cache backend.
+test_files:
+- spec/cache_client_spec.rb
+- spec/in_memory_backend.rb
+- spec/key_building_spec.rb
+- spec/spec_helper.rb
+has_rdoc: