cachedis 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1 @@
+--color --format Fuubar

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cachedis.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    cachedis (0.0.1)
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fuubar (0.0.3)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+      ruby-progressbar (~> 0.0.9)
+    redis (2.1.1)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.7)
+    rspec-mocks (2.5.0)
+    ruby-progressbar (0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cachedis!
+  fuubar
+  redis
+  rspec

data/README.md

@@ -0,0 +1,24 @@
+# Cachedis
+
+Cachedis caches your expensive queries to a Redis instance so the next time you fire it off, it'll load directly from cache instead of being run again. Optionally you can provide a cache expirement time.
+
+    @cachedis = Cachedis.new
+
+    # performs query the first time, performs cached calls to Redis within the next 60 * 60 seconds
+    @cachedis.cachedis 'name-of-expensive-query', :expire => 60 * 60  do
+      Post.all.expensive_operation
+    end
+
+## Installation and dependencies
+
+Dependencies are: `redis-rb`
+
+Install with: `gem install cachedis`
+
+## Wishlist
+
+* Tight ActiveRecord integration
+* Make expirement optional
+* Serialize using BERT (fall back to YAML)
+* Sexify the API
+    - Make it easier to specialize expirement time (e.g. `:expire => 4.hours`)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/cachedis.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cachedis/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cachedis"
+  s.version     = Cachedis::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Simon Hørup Eskildsen"]
+  s.email       = ["sirup@sirupsen.com"]
+  s.homepage    = ""
+  s.summary     = %q{Caches expensive database queries in Redis}
+  s.description = %q{Instead of running your expensive queries for every page load, let cachedis store them in Redis and fetch them.}
+
+  s.rubyforge_project = "cachedis"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Dependencies
+  s.add_dependency('redis')
+
+  # Development dependencies
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('fuubar')
+end

data/lib/cachedis/version.rb

@@ -0,0 +1,3 @@
+class Cachedis
+  VERSION = "0.0.1"
+end

data/lib/cachedis.rb

@@ -0,0 +1,24 @@
+require 'redis'
+require 'yaml'
+
+class Cachedis
+  attr_reader :redis_instance
+
+  def initialize(options = {})
+    redis(options)
+  end
+
+  def cachedis(name, options = {}, &block)
+    result = yield
+    
+    return redis.get name if redis.exists name
+
+    redis.set name, result.to_yaml
+    redis.expire name, options[:expire] || 60 * 60 # set expire to user specified or one minute
+  end
+
+  private
+  def redis(options = {})
+    @redis_instance ||= Redis.new(options)
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Cachedis do
+  include HelperMethods
+
+  before do
+    @cachedis = Cachedis.new
+  end
+
+  describe 'when setting something' do
+    it 'sets without errors' do
+      with_no_cache
+      @cachedis.redis_instance.should_receive(:set).exactly(1).times.and_return(['element', 'element 2'].to_yaml)
+      
+      lambda { 
+      @cachedis.cachedis 'expensive-query' do
+        ['element', 'element 2']
+      end }.should_not raise_error
+    end
+  end
+
+  describe 'when setting and later retrieving something' do
+    it 'retrieves from redis cache' do
+      with_cache('query')
+      @cachedis.redis_instance.should_not_receive(:set)
+
+      result = @cachedis.cachedis 'expensive-query' do
+                "query"
+              end
+
+      result.should == "query".to_yaml
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cachedis'
+require 'rspec'
+
+module HelperMethods
+  def with_no_cache
+    @cachedis.redis_instance.should_receive(:exists).exactly(1).times.and_return(nil)
+  end
+
+  def with_cache(cache)
+    @cachedis.redis_instance.should_receive(:exists).exactly(1).times.and_return(true)
+    @cachedis.redis_instance.should_receive(:get).exactly(1).times.and_return(cache.to_yaml)
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: cachedis
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Simon H\xC3\xB8rup Eskildsen"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fuubar
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Instead of running your expensive queries for every page load, let cachedis store them in Redis and fetch them.
+email: 
+- sirup@sirupsen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- cachedis.gemspec
+- lib/cachedis.rb
+- lib/cachedis/version.rb
+- spec/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cachedis
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Caches expensive database queries in Redis
+test_files: 
+- spec/base_spec.rb
+- spec/spec_helper.rb