gotime-moneta 0.6.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Yehuda Katz
+
+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

@@ -0,0 +1,56 @@
+Moneta: A unified interface for key/value stores
+================================================
+
+Moneta provides a standard interface for interacting with various kinds of key/value stores.
+
+Out of the box, it supports:
+
+* File store for xattr
+* Basic File Store
+* Memcache store
+* In-memory store
+* The xattrs in a file system
+* DataMapper
+* S3
+* Berkeley DB
+* Redis
+* SDBM
+* Tokyo
+* CouchDB
+
+All stores support key expiration, but only memcache and Redis support it natively. All other stores
+emulate expiration.
+
+The Moneta API is purposely extremely similar to the Hash API. In order so support an
+identical API across stores, it does not support iteration or partial matches, but that
+might come in a future release.
+
+The API:
+
+#initialize(options)::          options differs per-store, and is used to set up the store
+
+#[](key)::                      retrieve a key. if the key is not available, return nil
+
+#fetch(key, &block)::           retrieve a key. if the key is not available, execute the
+                                block and return its return value.
+
+#fetch(key, value)              retrieve a key. if the key is not available, return the value
+
+#[]=(key, value)::              set a value for a key. if the key is already used, clobber it.
+                                keys set using []= will never expire
+
+#delete(key)::                  delete the key from the store and return the current value
+
+#key?(key)::                    true if the key exists, false if it does not
+
+#has_key?(key)::                alias for key?
+
+#store(key, value, options)::   same as []=, but you can supply an :expires_in option,
+                                which will specify a number of seconds before the key
+                                should expire. In order to support the same features
+                                across all stores, only full seconds are supported
+
+#update_key(key, options)::     updates an existing key with a new :expires_in option.
+                                if the key has already expired, it will not be updated.
+
+#clear::                        clear all keys in this store

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'spec/rake/spectask'
+require 'date'
+
+GEM = "gotime-moneta"
+GEM_VERSION = "0.6.2"
+AUTHOR = "Yehuda Katz"
+EMAIL = "wycats@gmail.com"
+HOMEPAGE = "http://www.yehudakatz.com"
+SUMMARY = "A unified interface to key/value stores (with redis updates)"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "Run all examples (or a specific spec with TASK=xxxx)"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts  = ["-cfs"]
+  t.spec_files = begin
+    if ENV["TASK"] 
+      ENV["TASK"].split(',').map { |task| "spec/**/#{task}_spec.rb" }
+    else
+      FileList['spec/**/*_spec.rb']
+    end
+  end
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/<%= name %>.rb

data/lib/moneta.rb

@@ -0,0 +1,76 @@
+module Moneta
+  module Expires
+    def check_expired(key)
+      if @expiration[key] && Time.now > @expiration[key]
+        @expiration.delete(key)
+        self.delete(key)
+      end
+    end
+
+    def key?(key)
+      check_expired(key)
+      super
+    end
+
+    def [](key)
+      check_expired(key)
+      super
+    end
+
+    def fetch(key, default = nil, &blk)
+      check_expired(key)
+      super
+    end
+
+    def delete(key)
+      check_expired(key)
+      super
+    end
+
+    def update_key(key, options)
+      update_options(key, options)
+    end
+
+    def store(key, value, options = {})
+      ret = super(key, value)
+      update_options(key, options)
+      ret
+    end
+
+    private
+    def update_options(key, options)
+      if options[:expires_in]
+        @expiration[key] = (Time.now + options[:expires_in])
+      end
+    end
+  end
+
+  module StringExpires
+    include Expires
+
+    def check_expired(key)
+      if @expiration[key] && Time.now > Time.at(@expiration[key].to_i)
+        @expiration.delete(key)
+        delete(key)
+      end
+    end
+
+    private
+    def update_options(key, options)
+      if options[:expires_in]
+        @expiration[key] = (Time.now + options[:expires_in]).to_i.to_s
+      end
+    end
+  end
+  
+  module Defaults
+    def fetch(key, value = nil)
+      value ||= block_given? ? yield(key) : default
+      self[key] || value
+    end
+    
+    def store(key, value, options = {})
+      self[key] = value
+    end        
+  end
+end

data/lib/moneta/basic_file.rb

@@ -0,0 +1,113 @@
+#
+#  Basic File Store
+#  by Hampton Catlin
+#
+#  This cache simply uses a directory that it creates
+#  and manages to keep your file stores.
+#
+#  Specify :skip_expires => true if you aren't using 
+#  expiration as this will slightly decrease your file size
+#  and memory footprint of the library
+#
+#  You can optionally also specify a :namespace
+#  option that will create a subfolder.
+#
+
+
+require 'fileutils'
+require File.join(File.dirname(__FILE__), "..", "moneta.rb")
+
+module Moneta
+  class BasicFile
+    include Defaults
+    
+    def initialize(options = {})
+      @namespace = options[:namespace]
+      @directory = ::File.join(options[:path], @namespace.to_s)
+      
+      @expires = !options[:skip_expires]
+
+      ensure_directory_created(@directory)
+    end
+    
+    def key?(key)
+      !self[key].nil?
+    end
+    
+    alias has_key? key?
+    
+    def [](key)
+      if ::File.exist?(path(key))
+        data = raw_get(key)
+        if @expires
+          if data[:expires_at].nil? || data[:expires_at] > Time.now
+            data[:value]
+          else
+            delete!(key)
+          end
+        else
+          data
+        end
+      end
+    end
+    
+    def raw_get(key)
+      Marshal.load(::File.read(path(key)))
+    end
+    
+    def []=(key, value)
+      store(key, value)
+    end
+    
+    def store(key, value, options = {})
+      ensure_directory_created(::File.dirname(path(key)))
+      ::File.open(path(key), "w") do |file|
+        if @expires
+          data = {:value => value}
+          if options[:expires_in]
+            data[:expires_at] = Time.now + options[:expires_in]
+          end
+          contents = Marshal.dump(data)
+        else
+          contents = Marshal.dump(value)
+        end
+        file.puts(contents)
+      end
+    end
+    
+    def update_key(key, options)
+      store(key, self[key], options)
+    end
+    
+    def delete!(key)
+      FileUtils.rm(path(key))
+      nil
+    rescue Errno::ENOENT
+    end
+          
+    def delete(key)
+      value = self[key]
+      delete!(key)
+      value
+    end
+          
+    def clear
+      FileUtils.rm_rf(@directory)
+      FileUtils.mkdir(@directory)
+    end
+    
+    private
+    def path(key)
+      ::File.join(@directory, key.to_s)
+    end
+    
+    def ensure_directory_created(directory_path)
+      if ::File.file?(directory_path)
+        raise StandardError, "The path you supplied #{directory_path} is a file"
+      elsif !::File.exists?(directory_path)
+        FileUtils.mkdir_p(directory_path)
+      end
+    end
+      
+  end
+end

data/lib/moneta/berkeley.rb

@@ -0,0 +1,53 @@
+begin
+  require 'bdb'
+rescue LoadError
+  puts "You need bdb gem to use Bdb moneta store"
+  exit
+end
+
+module Moneta
+
+  class Berkeley
+    include Defaults
+
+    def initialize(options={})
+      file = @file = options[:file]
+      @db = Bdb::Db.new()
+      @db.open(nil, file, nil, Bdb::Db::BTREE, Bdb::DB_CREATE, 0)
+      unless options[:skip_expires]
+        @expiration = Moneta::Berkeley.new(:file => "#{file}_expiration", :skip_expires => true )
+        self.extend(StringExpires)
+      end
+    end
+    
+    module Implementation
+      def key?(key)
+        nil | self[key]
+      end
+
+      alias has_key? key?
+
+      def []=(key,value)
+        @db[key] = value
+      end
+
+      def [](key)
+        @db[key]
+      end
+
+      def delete(key)
+        value = self[key]
+        @db.del(nil,key,0) if value
+        value
+      end
+
+      def clear
+        @db.truncate(nil)
+      end
+    end
+
+    include Implementation
+
+  end
+
+end

data/lib/moneta/couch.rb

@@ -0,0 +1,63 @@
+begin
+  require "couchrest"
+rescue LoadError
+  puts "You need the couchrest gem to use the CouchDB store"
+  exit
+end
+
+module Moneta
+  class Couch
+    include Defaults
+    
+    def initialize(options = {})
+      @db = ::CouchRest.database!(options[:db])
+      unless options[:skip_expires]
+        @expiration = Moneta::Couch.new(:db => "#{options[:db]}_expiration", :skip_expires => true)
+        self.extend(StringExpires)
+      end
+    end
+
+    def key?(key)
+      !self[key].nil?
+    rescue RestClient::ResourceNotFound
+      false
+    end
+
+    alias has_key? key?
+
+    def [](key)
+      @db.get(key)["data"]
+    rescue RestClient::ResourceNotFound
+      nil
+    end
+
+    def []=(key, value)
+      @db.save_doc("_id" => key, :data => value)
+    rescue RestClient::RequestFailed
+      self[key]
+    end
+
+    def delete(key)
+      value = @db.get(key)
+      @db.delete_doc({"_id" => value["_id"], "_rev" => value["_rev"]}) if value
+      value["data"]
+    rescue RestClient::ResourceNotFound
+      nil
+    end
+
+    def update_key(key, options = {})
+      val = self[key]
+      self.store(key, val, options)
+    rescue RestClient::ResourceNotFound
+      nil
+    end
+
+    def clear
+      @db.recreate!
+    end
+
+    def delete_store
+      @db.delete!
+    end
+  end
+end