remember 0.0.1

data/README.md

@@ -0,0 +1,53 @@
+# Remember
+
+![Remember](/jpignata/remember/raw/master/etc/remember.jpg)
+
+A simple object persistence wrapper for Moneta. Initialize Remember with any Moneta adapter and serialize any object that implements Ruby's marshal API.
+
+## Adapters
+
+Moneta currently 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
+
+## Usage
+
+    jp@populuxe:~/Projects/remember$ irb -r 'lib/remember' -r 'moneta/redis'
+    >> r = Remember.new(Moneta::Redis)
+    >> r["important_data"] = rand(100000000000000000000000)
+    => 99924367975800373618177
+    >> r["important_data"]
+    => 99924367975800373618177
+    >> r["config"] = { :setting => 'value', :other_setting => 'other value' }
+
+    jp@populuxe:~/Projects/remember$ irb -r 'lib/remember' -r 'moneta/redis'
+    >> r = Remember.new(Moneta::Redis)
+    >> r["important_data"]
+    => 99924367975800373618177
+    >> r["config"]
+    => {:setting=>"value", :other_setting=>"other value"}
+		
+    jp@populuxe:~/Projects/remember$ irb -r 'lib/remember' -r 'moneta/redis'
+    >> r = Remember.new(Moneta::Redis)
+    >> class Duck; def make_noise; "Quack!"; end; end
+    >> d = Duck.new
+    >> d.make_noise
+    => "Quack!"
+    >> r["duck"] = d
+
+    jp@populuxe:~/Projects/remember$ irb -r 'lib/remember' -r 'moneta/redis'
+    >> r = Remember.new(Moneta::Redis)
+    >> class Duck; def make_noise; "Quack!"; end; end
+    >> r["duck"].make_noise
+    => "Quack!"

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/remember.rb

@@ -0,0 +1,56 @@
+require 'moneta'
+
+class Remember
+  def initialize(moneta, options = {})
+    @moneta = moneta.new(options)
+  end
+  
+  def []=(key, object)
+    store(key, object)
+  end
+
+  def store(key, object, options = {})
+    @moneta.store(key, Marshal.dump(object), options)
+    object
+  end
+
+  def update_key(key, options = {})
+    if @moneta.key?(key)
+      @moneta.update_key(key, options)
+    end
+  end
+  
+  def fetch(key, options, &block)
+    if value = self[key]
+      value
+    else
+      store(key, yield, options)
+    end
+  end
+  
+  def [](key)
+    deserialize(@moneta[key])
+  end
+
+  def delete(key)
+    deserialize(@moneta.delete(key))
+  end
+  
+  def key?(key)
+    @moneta.key?(key)
+  end
+  
+  def clear
+    @moneta.clear
+  end
+  
+  alias has_key? key?
+  
+  private
+  
+    def deserialize(value)
+      if value && value.size > 0
+        Marshal.load(value)
+      end
+    end
+end

data/spec/remember_spec.rb

@@ -0,0 +1,131 @@
+require File.join(File.dirname(__FILE__), '../lib/remember')
+require 'moneta/memory'
+
+describe Remember do
+  before do
+    @r = Remember.new(Moneta::Memory)
+  end
+  
+  describe "#[]=" do
+    it "returns the Object originally passed into it" do
+      @r["enum_sizes"] = ['xs', 's', 'm', 'l'].should == ['xs', 's', 'm', 'l']
+    end
+    
+    it "persists object values and behaviors" do
+      class Bridge < Struct.new(:name, :year)
+        def to_s; "#{name} opened in #{year}"; end
+        def opened?; year < Time.now.year; end
+      end
+      
+      @r["brooklyn"] = Bridge.new("Brooklyn Bridge", 1883)
+      @r["verrazano"] = Bridge.new("Verrazano-Narrows Bridge", 1964)
+
+      @r["brooklyn"].to_s.should == "Brooklyn Bridge opened in 1883"
+      @r["verrazano"].year.should == 1964
+      @r["brooklyn"].opened?.should be_true
+    end
+  end
+
+  describe "#[]" do
+    context "a given key exists" do
+      it "returns a deserialized object" do
+        @r["thirteen"] = 13
+        @r["thirteen"].should == 13
+      end
+    end
+
+    context "a given key does not exist" do
+      it "returns nil" do
+        @r["pretend"].should be_nil
+      end
+    end
+  end
+  
+  describe "#delete" do
+    context "a given key exists" do
+      it "returns the object that the key contained after deletion" do
+        @r["thirteen"] = 13
+        @r.delete("thirteen").should == 13
+        @r["thirteen"].should be_nil
+      end      
+    end
+
+    context "a given key does not exist" do    
+      it "returns nil" do
+        @r.delete("pretend").should be_nil
+      end
+    end
+  end
+  
+  describe "#key?" do
+    context "a key that exists" do
+      it "returns true" do
+        @r["real"] = true
+        @r.key?("real").should be_true
+      end
+    end
+
+    context "a key that does not exist" do
+      it "returns false" do
+        @r.key?("pretend").should be_false
+      end
+    end
+  end
+  
+  describe "#has_key?" do
+    it "is an alias for key?" do
+      @r.has_key?("pretend").should == @r.key?("pretend")
+    end
+  end
+
+  describe "#clear" do
+    it "clears all persisted objects" do
+      @r["do"] = 1
+      @r["ray"] = 2
+      @r["egon"] = 3
+      @r.clear
+      @r.key?("ray").should be_false
+    end
+  end    
+  
+  describe "#store" do
+    it "saves an object to key and sets an expiration in seconds" do
+      @r.store("zuul", :zuul, :expires_in => 60).should == :zuul
+    end
+  end
+
+  describe "#update_key" do
+    context "a key that exists" do
+      it "updates object identified by key and sets an expiration in seconds and returns the new expiration time" do
+        @r["gozer"] = :gozer
+        @r.update_key("gozer", :expires_in => 60).to_i.should == Time.now.to_i + 60
+      end
+    end
+
+    context "a key that does not exist" do
+      it "returns nil" do
+        @r.update_key("slimer", :expires_in => 60).should be_nil
+      end
+    end
+  end
+  
+  describe "#fetch" do
+    context "a key that exists" do
+      it "fetches the object" do
+        @r["some_data"] = 123
+        @r.fetch("some_data", :expires_in => 120) { 456 }.should == 123
+      end
+    end
+
+    context "a key that does not exist" do
+      it "executes a block and then stores the resulting object" do
+        @r["resource_intensive_data"].should be_nil
+        data = @r.fetch("resource_intensive_data", :expires_in => 120) do
+          ['calculation']
+        end
+        data.should == ['calculation']
+        @r["resource_intensive_data"].should == ['calculation']
+      end      
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: remember
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Pignata
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A Moneta wrapper for Ruby object persistence
+email: john.pignata@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- VERSION
+- etc/remember.jpg
+- lib/remember.rb
+- spec/remember_spec.rb
+has_rdoc: true
+homepage: http://github.com/jpignata/remember
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Moneta wrapper for Ruby object persistence
+test_files: 
+- spec/remember_spec.rb