riak-cache 1.0.0

data/.gitignore

@@ -0,0 +1,35 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+_notes
+doc
+.yardoc
+.bundle
+spec/support/test_server.yml
+Gemfile*.lock
+**/bin
+*.rbc
+.rvmrc
+
+.riaktest
+**/.riaktest
+vendor/erlang
+vendor/riak

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gemspec
+gem 'bundler'
+
+if File.directory?(File.expand_path("../../riak-client", __FILE__))
+  gem 'riak-client', :path => "../riak-client"
+end
+
+group :guard do
+  gem 'guard-rspec'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Gemfile.rails30

@@ -0,0 +1,3 @@
+gem 'activesupport', '~> 3.0.11'
+
+instance_eval File.read(File.expand_path('../Gemfile', __FILE__))

data/Gemfile.rails31

@@ -0,0 +1,3 @@
+gem 'activesupport', '~> 3.1.0'
+
+instance_eval File.read(File.expand_path('../Gemfile', __FILE__))

data/Gemfile.rails32

@@ -0,0 +1,3 @@
+gem 'activesupport', '~> 3.2.0'
+
+instance_eval File.read(File.expand_path('../Gemfile', __FILE__))

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+gemset = ENV['RVM_GEMSET'] || 'ripple'
+gemset = "@#{gemset}" unless gemset.to_s == ''
+
+rvms = %w[ 1.8.7 1.9.2 1.9.3 jruby ].map do |version|
+  "#{version}@#{gemset}"
+end
+
+guard 'rspec', :cli => '--profile', :rvm => rvms do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')
+  watch(%r{^lib/.+\.rb$})
+end
+

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright 2010-2012 Sean Cribbs and Basho Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+All of the files in this project are under the project-wide license
+unless they are otherwise marked.

data/README.markdown

@@ -0,0 +1,59 @@
+# Rails/ActiveSupport Cache Store for Riak (riak-cache) [![Build Status](https://secure.travis-ci.org/seancribbs/riak-cache.png)](http://travis-ci.org/seancribbs/riak-cache)
+
+`riak-cache` is an implementation of `ActiveSupport::Cache::Store`
+that stores cached values in Riak. This is especially useful if you
+have configured Riak to use an in-memory backend.
+
+## Dependencies
+
+`riak-cache` requires ActiveSupport version 3.x for its parent class,
+and `riak-client` to connect to Riak.
+
+Development dependencies are handled with bundler. Install bundler
+(`gem install bundler`) and run this command:
+
+``` bash
+$ bundle install
+```
+
+To pin to a specific version of ActiveSupport (rather than the latest
+3.x version), specify the `BUNDLE_GEMFILE` environment variable:
+
+``` bash
+$ BUNDLE_GEMFILE=Gemfile.rails31 bundle install
+```
+
+## Configuring and Using
+
+To use `riak-cache` with your Rails project, include it in your
+project's `Gemfile` and set it as the cache store inside your
+`config/application.rb` like so:
+
+``` ruby
+config.cache_store = :riak_store
+```
+
+To provide extra configuration (for example, which Riak nodes to
+connect to), use an array:
+
+```ruby
+config.cache_store = [:riak_store, {:http_port => 10000}]
+```
+
+Otherwise, you can simply instantiate and use the class wherever you
+like:
+
+```ruby
+cache = Riak::CacheStore.new
+cache.fetch('pages/1234') { render_page }
+```
+
+## License & Copyright
+
+Copyright ©2010-2012 Sean Cribbs and Basho Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+def gemspec
+  $riakcache_gemspec ||= Gem::Specification.load("riak-cache.gemspec")
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+
+task :gem => :gemspec
+
+desc %{Validate the gemspec file.}
+task :gemspec do
+  gemspec.validate
+end
+
+desc %{Release the gem to RubyGems.org}
+task :release => :gem do
+  system "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end
+
+desc "Cleans up white space in source files"
+task :clean_whitespace do
+  no_file_cleaned = true
+
+  Dir["**/*.rb"].each do |file|
+    contents = File.read(file)
+    cleaned_contents = contents.gsub(/([ \t]+)$/, '')
+    unless cleaned_contents == contents
+      no_file_cleaned = false
+      puts " - Cleaned #{file}"
+      File.open(file, 'w') { |f| f.write(cleaned_contents) }
+    end
+  end
+
+  if no_file_cleaned
+    puts "No files with trailing whitespace found"
+  end
+end
+
+
+desc "Run All Specs"
+RSpec::Core::RakeTask.new do |spec|
+  spec.rspec_opts = %w[--profile]
+end
+
+task :default => :spec

data/lib/active_support/cache/riak_store.rb

@@ -0,0 +1,2 @@
+require 'riak-cache'
+ActiveSupport::Cache::RiakStore = Riak::CacheStore unless defined?(ActiveSupport::Cache::RiakStore)

data/lib/riak-cache.rb

@@ -0,0 +1,2 @@
+require 'riak-cache/version'
+require 'riak/cache_store'

data/lib/riak-cache/version.rb

@@ -0,0 +1,5 @@
+module Riak
+  module Cache
+    VERSION = "1.0.0"
+  end
+end

data/lib/riak/cache_store.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+require 'riak'
+require 'active_support/version'
+require 'active_support/cache'
+
+module Riak
+  # An ActiveSupport::Cache::Store implementation that uses Riak.
+  # Compatible only with ActiveSupport version 3 or greater.
+  class CacheStore < ActiveSupport::Cache::Store
+    attr_accessor :client
+
+    # Creates a Riak-backed cache store.
+    def initialize(options = {})
+      super
+      @bucket_name = options.delete(:bucket) || '_cache'
+      @n_value = options.delete(:n_value) || 2
+      @r = options.delete(:r) || 1
+      @w = options.delete(:w) || 1
+      @dw = options.delete(:dw) || 0
+      @rw = options.delete(:rw) || "quorum"
+      @client = Riak::Client.new(options)
+      set_bucket_defaults
+    end
+
+    def bucket
+      @bucket ||= @client.bucket(@bucket_name)
+    end
+
+    def delete_matched(matcher, options={})
+      instrument(:delete_matched, matcher) do
+        bucket.keys do |keys|
+          keys.grep(matcher).each do |k|
+            bucket.delete(k)
+          end
+        end
+      end
+    end
+
+    protected
+    def set_bucket_defaults
+      begin
+        new_values = {}
+        new_values['n_val'] = @n_value unless bucket.n_value == @n_value
+        new_values['r']     = @r       unless bucket.r == @r
+        new_values['w']     = @w       unless bucket.w == @w
+        new_values['dw']    = @dw      unless bucket.dw == @dw
+        new_values['rw']    = @rw      unless bucket.rw == @rw
+        bucket.props = new_values      unless new_values.empty?
+      rescue
+      end
+    end
+
+    def write_entry(key, value, options={})
+      object = bucket.get_or_new(key)
+      object.content_type = 'application/yaml'
+      object.data = value
+      object.store
+    end
+
+    def read_entry(key, options={})
+      begin
+        bucket.get(key).data
+      rescue Riak::FailedRequest => fr
+        raise fr unless fr.not_found?
+        nil
+      end
+    end
+
+    def delete_entry(key, options={})
+      bucket.delete(key)
+    end
+  end
+end

data/riak-cache.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'riak-cache/version'
+
+Gem::Specification.new do |gem|
+  # Meta
+  gem.name = "riak-cache"
+  gem.version = Riak::Cache::VERSION
+  gem.summary = %Q{riak-cache is an ActiveSupport::Cache::Store that is backed by Riak.}
+  gem.description = %Q{riak-cache is an ActiveSupport::Cache::Store that is backed by Riak. It supports ActiveSupport version 3.x.}
+  gem.email = ["sean@basho.com"]
+  gem.homepage = "http://github.com/seancribbs/riak-cache"
+  gem.authors = ["Sean Cribbs"]
+
+  # Deps
+  gem.add_development_dependency "rspec", "~>2.8.0"
+  gem.add_development_dependency 'rake'
+  gem.add_runtime_dependency "riak-client", "~> 1.0.0"
+  gem.add_runtime_dependency "activesupport", "~> 3.0"
+
+  # Files
+  ignores = File.read(".gitignore").split(/\r?\n/).reject{ |f| f =~ /^(#.+|\s*)$/ }.map {|f| Dir[f] }.flatten
+  gem.files = (Dir['**/*','.gitignore'] - ignores).reject {|f| !File.file?(f) }
+  gem.test_files = (Dir['spec/**/*','.gitignore'] - ignores).reject {|f| !File.file?(f) }
+  # gem.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+end

data/spec/riak/cache_store_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+require 'riak/cache_store'
+
+describe Riak::CacheStore do
+  let(:web_port){ test_server.http_port }
+  subject { ActiveSupport::Cache.lookup_store(:riak_store, :http_port => web_port) }
+
+  describe "Riak integration" do
+    it "should have a client" do
+      subject.should respond_to(:client)
+      subject.client.should be_kind_of(Riak::Client)
+    end
+
+    it "should have a bucket to store entries in" do
+      subject.bucket.should be_kind_of(Riak::Bucket)
+    end
+
+    it "should configure the client according to the initialized options" do
+      subject = ActiveSupport::Cache.lookup_store(:riak_store, :http_port => 10000)
+      subject.client.nodes.all? { |n| n.http_port == 10000 }.should == true
+    end
+
+    it "should choose the bucket according to the initializer option" do
+      cache = ActiveSupport::Cache.lookup_store(:riak_store, :bucket => "foobar", :http_port => web_port)
+      cache.bucket.name.should == "foobar"
+    end
+
+    it "should set the N value to 2 by default" do
+      subject.bucket.n_value.should == 2
+    end
+
+    it "should set the N value to the specified value" do
+      cache = ActiveSupport::Cache.lookup_store(:riak_store, :n_value => 1, :http_port => web_port)
+      cache.bucket.n_value.should == 1
+    end
+
+    it "should set the bucket R value to 1 by default" do
+      subject.bucket.r.should == 1
+    end
+
+    it "should set the bucket R default to the specified value" do
+      cache = ActiveSupport::Cache.lookup_store(:riak_store, :r => "quorum", :http_port => web_port)
+      cache.bucket.r.should == "quorum"
+    end
+
+    it "should set the bucket W value to 1 by default" do
+      subject.bucket.w.should == 1
+    end
+
+    it "should set the bucket W default to the specified value" do
+      cache = ActiveSupport::Cache.lookup_store(:riak_store, :w => "all", :http_port => web_port)
+      cache.bucket.w.should == "all"
+    end
+
+    it "should set the bucket DW value to 0 by default" do
+      subject.bucket.dw.should == 0
+    end
+
+    it "should set the bucket DW default to the specified value" do
+      cache = ActiveSupport::Cache.lookup_store(:riak_store, :dw => "quorum", :http_port => web_port)
+      cache.bucket.dw.should == "quorum"
+    end
+
+    it "should set the bucket RW value to quorum by default" do
+      subject.bucket.rw.should == "quorum"
+    end
+
+    it "should set the bucket RW default to the specified value" do
+      cache = ActiveSupport::Cache.lookup_store(:riak_store, :rw => "all", :http_port => web_port)
+      cache.bucket.rw.should == "all"
+    end
+  end
+
+
+  it "should read and write strings" do
+    subject.write('foo', 'bar')
+    subject.read('foo').should == 'bar'
+  end
+
+  it "should read and write hashes" do
+    subject.write('foo', {:a => "b"})
+    subject.read('foo').should == {:a => "b"}
+  end
+
+  it "should read and write integers" do
+    subject.write('foo', 1)
+    subject.read('foo').should == 1
+  end
+
+  it "should read and write nil" do
+    subject.write('foo', nil)
+    subject.read('foo').should be_nil
+  end
+
+  it "should return the stored value when fetching on hit" do
+    subject.write('foo', 'bar')
+    subject.fetch('foo'){'baz'}.should == 'bar'
+  end
+
+  it "should return the default value when fetching on miss" do
+    subject.fetch('does-not-exist'){ 'baz' }.should == 'baz'
+  end
+
+  it "should return the default value when forcing a miss" do
+    subject.fetch('foo', :force => true){'bar'}.should == 'bar'
+  end
+
+  it "should detect if a value exists in the cache" do
+    subject.write('foo', 'bar')
+    subject.exist?('foo').should be_true
+  end
+
+  it "should delete matching keys from the cache" do
+    subject.write('foo', 'bar')
+    subject.write('green', 'thumb')
+    subject.delete_matched(/foo/)
+    subject.read('foo').should be_nil
+    subject.read('green').should == 'thumb'
+  end
+
+  it "should delete a single key from the cache" do
+    subject.write('foo', 'bar')
+    subject.read('foo').should == 'bar'
+    subject.delete('foo')
+    subject.read('foo').should be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems' # Use the gems path only for the spec suite
+require 'riak'
+require 'riak-cache'
+require 'rspec'
+
+# Only the tests should really get away with this.
+Riak.disable_list_keys_warnings = true
+
+%w[test_server].each do |file|
+  require File.join("support", file)
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  if defined?(::Java)
+    config.seed = Time.now.utc
+  else
+    config.order = :random
+  end
+end

data/spec/support/test_server.rb

@@ -0,0 +1,57 @@
+require 'riak/test_server'
+
+module TestServerSupport
+  def test_server
+    unless $test_server
+      begin
+        require 'yaml'
+        config = YAML.load_file(File.expand_path("../test_server.yml", __FILE__))
+        $test_server = Riak::TestServer.create(:root => config['root'],
+                                               :source => config['source'],
+                                               :min_port => config['min_port'] || 15000)
+      rescue SocketError => e
+        warn "Couldn't connect to Riak TestServer! #{$test_server.inspect}"
+        warn "Skipping remaining integration tests."
+        warn_crash_log
+        $test_server_fatal = e
+      rescue => e
+        warn "Can't run integration specs without the test server. Please create/verify spec/support/test_server.yml."
+        warn "Skipping remaining integration tests."
+        warn e.inspect
+        warn_crash_log
+        $test_server_fatal = e
+      end
+    end
+    $test_server
+  end
+
+  def test_server_fatal
+    $test_server_fatal
+  end
+
+  def warn_crash_log
+    if $test_server && crash_log = $test_server.log + 'crash.log'
+      warn crash_log.read if crash_log.exist?
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include TestServerSupport
+
+  config.before(:each) do
+    fail "Test server not working: #{test_server_fatal}" if test_server_fatal
+    test_server.create unless test_server.exist?
+    test_server.start
+  end
+
+  config.after(:each, :integration => true) do
+    if test_server && !test_server_fatal
+      test_server.drop
+    end
+  end
+
+  config.after(:suite) do
+    $test_server.stop if $test_server
+  end
+end

data/spec/support/test_server.yml.example

@@ -0,0 +1,14 @@
+# This is where the test server node will be generated. Something on
+# /tmp is usually ok.
+root: /tmp/riak-client-test-server
+
+# This is where Riak is installed on your system, that is, the path to
+# the 'riak' and 'riak-admin' scripts. I use a self-built node, but
+# here's where it will generally be on various platforms:
+#
+#                Linux:  /usr/sbin
+#  Solaris/OpenSolaris:  /opt/riak/bin
+#  Mac OS/X (Homebrew):  /usr/local/bin
+#    Source/Self built:  /path/to/your/install/rel/riak/bin
+#
+source: /Users/sean/Development/riak/rel/riak/bin

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: riak-cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Cribbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153009100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153009100
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153008680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153008680
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: &2153008140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153008140
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153007640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153007640
+description: riak-cache is an ActiveSupport::Cache::Store that is backed by Riak.
+  It supports ActiveSupport version 3.x.
+email:
+- sean@basho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.rails30
+- Gemfile.rails31
+- Gemfile.rails32
+- Guardfile
+- lib/active_support/cache/riak_store.rb
+- lib/riak/cache_store.rb
+- lib/riak-cache/version.rb
+- lib/riak-cache.rb
+- LICENSE
+- Rakefile
+- README.markdown
+- riak-cache.gemspec
+- spec/riak/cache_store_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_server.rb
+- spec/support/test_server.yml.example
+- .gitignore
+homepage: http://github.com/seancribbs/riak-cache
+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.15
+signing_key: 
+specification_version: 3
+summary: riak-cache is an ActiveSupport::Cache::Store that is backed by Riak.
+test_files:
+- spec/riak/cache_store_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_server.rb
+- spec/support/test_server.yml.example
+- .gitignore