Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A new way to deal with memcached
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
benchmarks
examples
lib
spec
.gitignore
AUTHORS
LICENSE
README.markdown
Rakefile
VERSION
harness.rb
init.rb
remix-stash.gemspec

README.markdown

Quick & Dirty Specs

New API that doesn't actually suck! I've rethought a lot of the API and this comes with a lot of new capabilities. More work is being done on making it as expressive as possible without terrible overhead. This includes vectorized keys which allow emulation of partial cache clearing as well as nice shortcuts like eval and gate for expressions. Options, clusters, and implicit scope are easy to manage on a stash-by-stash basis. Keys are also easy to pass in as it will create composite keys from whatever you pass in (as long as it has to_s) so no more ugly string interpolation all over the place.

It's fast (faster than memcache-client). It's simple (pure ruby and only a few hundred lines). It's tested (shoulda). Of course, because it's pure ruby it will run almost anywhere as well unlike many other clients.

It does require memcached 1.4+ but you should be running that anyway (if you aren't, upgrade already).

Take a look at the examples and let me know what you think!

Installation

Right now remix-stash is designed to be run as a gem. I've published it to both github and gemcutter (preferred). You can also safely use this as a rails plugin, just check out the source in your plugin directory and it will be automatically loaded.

Install via GemCutter

gem install remix-stash --source=http://gemcutter.org/

Using Remix::Stash

The examples directory has some simple code snippets that introduce general features of the library. In general, everything should just work after require 'remix/stash'. This includes integration with Rails and automatic pick-up of Heroku style memcached environment variables. Of course, this library is completely independent of Rails and does not need environment variables to function or be used.

The API is exported onto the Remix module as the stash method. Direct calls as well as inclusion/extension of the module on specific objects should work fine. When in doubt try starting with Remix.stash as a style. NOTE: Prior to version 1.1 this was mixed in to Object as well. If your code depended on this, please just include Remix to retain compatibility.

Specifications

This project is tested with shoulda (install via the thoughtbot-shoulda gem on github) and takes the philosophy that fewer moving parts is better. So to avoid complex runners just run spec/spec.rb or the spec you are interested in directly. In order for the specs to function, you should have memcached 1.4+ running locally on port 11211.

Future Work

  • add block form to access response headers directly
  • get/set add/replace read/write should allow a CAS flag to be passed
  • allow swappable cluster types for consistent hashing, ketama, etc...
  • support non-marshal value dumps configured per stash
  • support multi vector sets
  • thread safe cluster
  • quiet/multi command forms (will require a protocol refactoring most likely)
  • accelerated binary API implementation with Ruby fallback
  • redis support for vectors and/or value
  • UDP support (more experimentation on the tradeoffs)
  • EventMachine integration (non-blocking?)
Something went wrong with that request. Please try again.