mongocached 1.0.0

data/Benchmark.md

@@ -0,0 +1,54 @@
+### Ruby 1.9.3p194
+ 
+ mo = mongocached / me = memcached 
+
+#### small string * 100000
+<pre>
+       user     system      total        real
+mo set  5.060000   0.470000   5.530000 (  5.538689)
+me set  1.400000   1.310000   2.710000 (  4.065908)
+mo get 10.130000   1.110000  11.240000 ( 12.415902)
+me get  1.360000   1.340000   2.700000 (  3.768052)
+</pre>
+ 
+ 
+#### large hash * 100000
+<pre>
+       user     system      total        real
+mo set 39.010000   1.170000  40.180000 ( 40.314892)
+me set 15.510000   2.340000  17.850000 ( 20.471940)
+mo get 39.740000   3.350000  43.090000 ( 47.473688)
+me get 14.950000   1.420000  16.370000 ( 17.187145)
+</pre> 
+ 
+#### large hash * 100000
+<pre>
+      user     system      total        real
+mo set 40.650000   1.180000  41.830000 ( 42.026839)
+me set 16.590000   2.060000  18.650000 ( 20.909275)
+mo get 49.400000   5.650000  55.050000 ( 63.141785)
+me get 11.760000   1.810000  13.570000 ( 14.814693)
+</pre>
+
+### Ruby 1.9.2p318
+
+  mo = mongocached / me = memcached
+ 
+#### small string * 100000
+<pre>
+      user     system      total        real
+mo set  4.360000   0.470000   4.830000 (  4.849431)
+me set  1.950000   1.840000   3.790000 (  5.901345)
+mo get  9.580000   1.130000  10.710000 ( 12.000498)
+me get  1.300000   1.390000   2.690000 (  3.707633)
+</pre>
+ 
+ 
+#### large hash * 100000
+<pre>
+      user     system      total        real
+mo set 39.770000   1.130000  40.900000 ( 41.075236)
+me set 15.880000   2.440000  18.320000 ( 20.905582)
+mo get 38.660000   3.590000  42.250000 ( 46.763608)
+me get 11.900000   1.450000  13.350000 ( 14.215215)
+</pre>

data/Gemfile

@@ -0,0 +1,25 @@
+source :rubygems
+
+gem 'mongo'
+gem 'bson_ext'
+
+group :development, :test do
+  gem 'rake'
+end
+
+group :development do
+  gem 'rdoc'
+end
+
+group :benchmark do
+  # for benchmark only
+  # requires sudo apt-get install libsasl2-dev
+  gem 'memcached'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov', :require => false
+end
+
+

data/HISTORY.md

@@ -0,0 +1 @@
+

data/README.md

@@ -0,0 +1,14 @@
+# Mongocached
+
+Cache using mongo, like memcached.
+
+## Why? 
+
+Because disk space is cheaper.
+
+## Links
+
+#### [API Docs](http://rubyops.github.com/mongocached/doc/)
+#### [Coverage](http://rubyops.github.com/mongocached/coverage/)
+#### [Benchmarks](https://github.com/rubyops/mongocached/blob/master/Benchmark.md)
+

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+
+task :benchmark do
+  load './spec/benchmarks.rb'
+end
+
+task :package do
+  puts %x{ gem build diskcached.gemspec && (mkdir ./pkg; mv *.gem ./pkg/ ) }
+end
+
+# vim: syntax=ruby

data/lib/mongocached.rb

@@ -0,0 +1,203 @@
+require 'mongo'
+# @author Joshua P. Mervine <joshua@mervine.net>
+class Mongocached 
+  # version for gem
+  VERSION = '1.0.0'
+
+  @cleanup_last = nil
+  @ensure_indexes = false
+
+  # initialize object
+  def initialize options={}
+    @options = defaults.merge! options
+
+    unless @options[:lifetime].nil?
+      @cleanup_last = Time.now
+      @options[:cleanup_life] = ( @options[:lifetime] < 1800 ? @options[:lifetime] : 1800 )
+    else
+      @options[:cleanup_auto] = false
+    end
+
+    @last = nil
+
+    flush_expired!
+  end
+
+  def defaults
+    {
+      #cache_id_prefix:              nil,
+      lifetime:                     3600,
+      automatic_serialization:      true,
+      host:                         'localhost',
+      port:                         '27017',
+      dbname:                       'mongocached',
+      collection:                   'cache',
+      cleanup_auto:                 true,
+      cleanup_life:                 1800,
+      config:                       {}
+    }
+  end
+
+  # expire cache
+  def delete id
+    @last = nil
+    collection.remove(_id: id)
+  end
+  alias :remove :delete
+
+  # delete all caches
+  def flush
+    collection.drop
+  end
+  alias :clean :flush
+
+  # flush expired caches if cleanup hasn't been run recently
+  def flush_expired 
+    if !@cleanup_last.nil? && !@options[:cleanup_life].nil? && (@cleanup_last+@options[:cleanup_life]) < Time.now
+      flush_expired!
+    end
+  end
+
+  # flush expired caches, ingoring when garbage collection was last run
+  # update indexes
+  def flush_expired!
+    # commenting out forking until I'm sure it's necessary
+    # and won't cause zombie processes
+    #gcpid = Process.fork do
+      collection.remove(expires: {'$lt' => Time.now})
+      unless @ensure_indexes
+        collection.ensure_index([[:tags, 1]])
+        collection.ensure_index([[:expires, -1]])
+      end
+      @cleanup_last = Time.now
+    #end
+    #Process.detach(gcpid)
+  end
+  alias :clean_expired :flush_expired!
+
+  # create or read cache
+  # - creates cache if it doesn't exist
+  # - reads cache if it exists
+  def save id, tags = [], ttl = @options[:lifetime]
+    begin
+      doc = collection.find_one(_id: id, expires: { '$gt' => Time.now })
+      return deserialize(doc['data']) unless doc.nil?
+
+      data = Proc.new { yield }.call
+      collection.save({
+        _id:      id,
+        data:     serialize(data),
+        tags:     tags,
+        expires:  calc_expires(ttl)
+      })
+      return data
+
+    rescue LocalJumpError
+      # when nothing is passed to yield and it's called
+      return nil
+    end
+  end
+  alias :cache :save 
+
+  # set cache
+  # - creates cache if it doesn't exist
+  # - updates cache if it does exist
+  def set id, data, tags = [], ttl = @options[:lifetime]
+    collection.save({
+      _id:      id,
+      data:     serialize(data),
+      tags:     tags,
+      expires:  calc_expires(ttl)
+    })
+    flush_expired if @options[:cleanup_auto]
+    true
+  end
+  alias :replace :set    # for memcached compatability
+
+  # add cache
+  # - creates cache if it doesn't exist
+  # - return false if it does
+  def add id, data, tags = [], ttl = @options[:lifetime]
+    begin
+      collection.insert({
+        _id:      id,
+        data:     serialize(data),
+        tags:     tags,
+        expires:  calc_expires(ttl)
+      }, safe: true)
+    rescue Mongo::OperationFailure
+      flush_expired if @options[:cleanup_auto]
+      return false
+    end
+    flush_expired if @options[:cleanup_auto]
+    return true
+  end
+
+  # get cache
+  # - reads cache if it exists and isn't expired or raises Diskcache::NotFound
+  # - if passed an Array returns only items which exist and aren't expired, it raises Diskcache::NotFound if none are available
+  def get id
+    flush_expired if @options[:cleanup_auto]
+    if id.is_a? Array
+      # TODO: more mongo'y way to do this, perhaps a map/reduce?
+      # STORE.find({ _id: {'$in' => ['no1', 'no2', 'no3']}})
+      hash = {}
+      id.each do |i|
+        doc = collection.find_one(_id: i)
+        if !doc.nil? && doc['expires'] > Time.now
+          hash[i] = deserialize(doc['data']) 
+        end
+      end
+      return hash unless hash.empty?
+    else
+      doc = collection.find_one(_id: id)
+      if !doc.nil? && doc['expires'] > Time.now
+        return deserialize(doc['data']) 
+      end
+    end
+    raise Mongocached::NotFound 
+  end
+  alias :load :get
+
+  private
+  def serialize data
+    if @options[:automatic_serialization]  
+      Marshal::dump(data) 
+    else
+      data
+    end
+  end
+
+  def deserialize data
+    if @options[:automatic_serialization]  
+      Marshal::load(data) 
+    else
+      data
+    end
+  end
+
+  def calc_expires ttl = @options[:lifetime]
+    return nil if ttl.nil?
+    Time.now+ttl
+  end
+
+  def collection
+    @collection ||= db[@options[:collection]]
+  end
+
+  def db
+    @db ||= connection[@options[:dbname]]
+  end
+
+  def connection
+    @connection ||= connect
+  end
+
+  def connect
+    ::Mongo::Connection.new(@options[:host], @options[:port], @options[:config])
+  end
+
+  class NotFound < Exception
+  end
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: mongocached
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple mongodb based cache for things like Sinatra and Rails which is
+  implemented much like Memcached in hopes that in some cases they're interchangeable.
+  It's based off 'diskcached'. This gem should be considered 'alpha'!
+email:
+- joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongocached.rb
+- README.md
+- HISTORY.md
+- Benchmark.md
+- Gemfile
+- Rakefile
+homepage: http://mongocached.rubyops.net/
+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'
+      segments:
+      - 0
+      hash: -4487074619354158587
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple disk cache
+test_files: []