mongo_rails_cache 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+# RubyMine
+.idea/*
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ashley Streb
+
+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.rdoc

@@ -0,0 +1,17 @@
+= mongo_store
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ashley Streb. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rspec'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_rails_cache"
+    gem.summary = %Q{Rails3 ActiveSupport Cache built on MongoDB}
+    gem.description = %Q{Rails3 ActiveSupport Cache built on MongoDB}
+    gem.email = "astreb@gmail.com"
+    gem.homepage = "http://github.com/roark31337/mongo_rails_cache"
+    gem.authors = ["Ashley Streb"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+#task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongo_store/cache.rb

@@ -0,0 +1,48 @@
+begin
+  require 'mongo'
+rescue LoadError => e
+  $stderr.puts "You don't have mongo installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+require 'active_support/all'
+
+module MongoStore
+  class Cache < ActiveSupport::Cache::Store
+    attr_reader :collection, :options
+
+    def initialize(collection, options={})
+      @collection, @options = collection, options || {}
+    end
+
+    def expires_in
+      @expires_in ||= options[:expires_in] || 1.month
+    end
+
+    def write_entry(key, entry, options)
+      doc = {:_id => key.to_s, :value => BSON::Binary.new(Marshal.dump(entry))}
+      @collection.save(doc)
+      true
+    end
+
+    def read_entry(key, options)
+      entry = @collection.find_one(:_id => key.to_s)
+      if entry
+        Marshal.load(entry['value'].to_s)
+      else
+        nil
+      end
+    end
+
+    # we don't get any info from mongo driver if delete actually deleted anything.  this will always return true.
+    def delete_entry(key, options)
+      @collection.remove({:_id => key.to_s})
+      true
+    end
+
+    def clear(options=nil)
+      @collection.remove
+    end
+    
+  end
+end

data/lib/mongo_store.rb

@@ -0,0 +1 @@
+require 'mongo_store/cache'

data/mongo_rails_cache.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongo_rails_cache}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ashley Streb"]
+  s.date = %q{2010-09-28}
+  s.description = %q{Rails3 ActiveSupport Cache built on MongoDB}
+  s.email = %q{astreb@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mongo_store.rb",
+     "lib/mongo_store/cache.rb",
+     "mongo_rails_cache.gemspec",
+     "spec/cache/cache_spec.rb",
+     "spec/mongo_store_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/roark31337/mongo_rails_cache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails3 ActiveSupport Cache built on MongoDB}
+  s.test_files = [
+    "spec/cache/cache_spec.rb",
+     "spec/mongo_store_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/cache/cache_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe MongoStore::Cache do
+  before(:each) do
+    DB.collections.each do |collection|
+      collection.remove
+      collection.drop_indexes
+    end
+
+    @collection = DB['mongo_store_cache']
+    @store = MongoStore::Cache.new(@collection)
+  end
+
+  let(:collection)  { DB['mongo_store_cache'] }
+  let(:store)       { MongoStore::Cache.new(collection, nil) }
+
+  it "has a collection" do
+    store.collection.should == collection
+  end
+
+  it "defaults expires_in to 1.month" do
+    store.expires_in.should == 1.month
+  end
+
+  it "can set default expires_in" do
+    MongoStore::Cache.new(collection, :expires_in => 5.minutes).expires_in.should == 5.minutes
+  end
+
+  describe "#write" do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+
+    let(:document) { collection.find_one(:_id => 'foo') }
+
+    it "sets _id to key" do
+      document['_id'].should == 'foo'
+    end
+
+    it "sets value key to value" do
+      store.read('foo').should == 'bar'
+    end
+
+    it "always sets keys as strings" do
+      store.write(:foo, 'bar')
+      doc = collection.find_one(:_id => 'foo')
+      doc.should_not be_nil
+      doc['_id'].should be_instance_of(String)
+
+      store.write('foo', 'bar')
+      doc = collection.find_one(:_id => 'foo')
+      doc.should_not be_nil
+      doc['_id'].should be_instance_of(String)
+    end
+
+    it "should append a namespace to the keyname if one is provided" do
+      store.write('first', 'bar', {:expires_in => 1.year, :namespace => ns = 'myns'})
+      collection.find_one(:_id => "first").should be_nil      
+      collection.find_one(:_id => "#{ns}:first").should_not be_nil
+    end
+
+    it "should not append a namespace to the keyname if one is not provided" do
+      store.write('second', 'bar', {:expires_in => 1.year})
+      collection.find_one(:_id => "second").should_not be_nil      
+    end
+  end
+
+  describe '#read' do
+    before(:each) do
+       store.write('foo', 'bar')
+    end
+
+    let(:document) { collection.find_one(:_id => 'foo') }
+
+    it "returns nil for key not found" do
+     store.read('non:existent:key').should be_nil
+    end
+    it "returns unmarshalled value key value for key found" do
+     store.read('foo').should == 'bar'
+    end
+    it "returns nil for existing but expired key" do
+     store.write('baz', 'bar', {:expires_in => 0.hours})
+     store.read('baz').should be_nil
+    end
+    it "should return an entry with an expiry date in the future" do
+      store.write('foo', 'bar', {:expires_in => 1.year})
+      store.read('foo').should == 'bar'
+    end
+    it "should work with symbols" do
+      store.read(:foo).should == 'bar'
+    end
+  end
+
+  describe '#delete' do
+    before(:each) do
+      store.write('foo', 'bar')
+    end
+
+    it "should delete key from cache" do
+      store.read('foo').should_not be_nil
+      store.delete('foo')
+      store.read('foo').should be_nil
+    end
+
+    it "works with symbol" do
+      store.read(:foo).should_not be_nil
+      store.delete(:foo)
+      store.read(:foo).should be_nil
+    end
+
+    # mongo doesn't tell us if it deleted an item, true will always be returned
+    it "should always return true if an entry was deleted regardless of whether it is in the cache" do
+      store.read(:foo).should_not be_nil
+      store.delete(:foo).should be_true
+
+      store.read(bad_key = "nonexistend:key:name").should be_nil
+      store.delete(bad_key).should be_true
+    end
+  end
+
+end

data/spec/mongo_store_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe MongoStore do
+
+  it "should load MongoStore::Cache" do
+    lambda {MongoStore::Cache}.should_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+gem 'activesupport'
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'mongo_store'
+require 'mongo'
+
+require 'rspec'
+
+Rspec.configure do |config|
+  config.mock_with :rspec
+end
+
+connection = Mongo::Connection.new
+DB = connection.db('mongo-store-test')

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_rails_cache
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ashley Streb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Rails3 ActiveSupport Cache built on MongoDB
+email: astreb@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo_store.rb
+- lib/mongo_store/cache.rb
+- mongo_rails_cache.gemspec
+- spec/cache/cache_spec.rb
+- spec/mongo_store_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/roark31337/mongo_rails_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails3 ActiveSupport Cache built on MongoDB
+test_files: 
+- spec/cache/cache_spec.rb
+- spec/mongo_store_spec.rb
+- spec/spec_helper.rb