campchair 0.1.0 → 0.1.1

data/README.md

@@ -20,7 +20,7 @@ This is not append-only and replication is not a feature.
 
 This project was born at [Railscamp 11](http://railscamps.com/).
 
-### How does it look?
+### As a basic data structure store
 
 For these examples we'll work with two documents.
 
@@ -67,6 +67,45 @@ fred[:last_seen] = Time.new(2012, 3, 6, 12, 40, 25)
 doc[key] = fred
 ```
 
+### As an persisted object store
+
+Sometimes you want persistence baked-in à la ActiveRecord.
+
+```ruby
+class People
+  include Campchair::Model
+  # note: this includes Campchair::Store automagically
+end
+```
+
+Then you get some extra methods:
+
+```ruby
+# Add a person to the db
+fred = People.new
+fred.save
+key = fred.key # think 'id'
+# this key is generated
+# but you can set one before saving if you like
+
+# Rerieve a person from the db
+fred = People.load(key) # think 'find'
+
+# Delete the person!
+fred.delete
+
+# Reincarnate & persist
+fred = Person.new
+fred.save
+
+# Attribtues get persisted
+fred.attributes[:favourite_colour] = 'LSD'
+fred.save
+
+# as you can see with a Store-style query
+People[fred.key] # => { :favourite_colour => 'LSD' }
+```
+
 ### Basic views _not yet implemented_
 
 For views to be available on classes we need to include `Campchair::Views`.

data/lib/campchair/model.rb

@@ -16,6 +16,8 @@ module Campchair
 
     module ClassMethods
       def load(key)
+        return unless exists?(key)
+
         entity = new
         entity.key = key
         entity.reload
@@ -62,11 +64,13 @@ module Campchair
     alias :destroy :delete
 
     def reload(options = nil)
-      fresh_attributes = self.class[key]
-      attributes.update(fresh_attributes)
-      @new_entity = false
-
-      self
+      if fresh_attributes = self.class[key]
+        attributes.update(fresh_attributes)
+        @new_entity = false
+        self
+      else
+        nil
+      end
     end
 
   end

data/lib/campchair/version.rb

@@ -1,3 +1,3 @@
 module Campchair
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/campchair/model_spec.rb

@@ -26,6 +26,11 @@ describe Campchair::Model do
         test_entity.should_not be_new_entity
         test_entity.should_not be_destroyed
       end
+
+      it "returns nil if the key is not present in the store" do
+        test_class['BADA55'].should be_nil
+        test_class.load('BADA55').should be_nil
+      end
     end
 
     describe "#save" do

data/spec/integration/readme_examples_spec.rb

@@ -1,6 +1,13 @@
 require 'spec_helper'
 
-describe "DB behavior" do
+describe "As a basic data structure store" do
+  let(:test_class) do
+    Class.new do
+      include Campchair::Store
+      self.db_path = 'tmp/ccdb'
+    end
+  end
+
   before do
     @fred = {
       :name       => 'Fred', :height => 1.748,
@@ -14,42 +21,61 @@ describe "DB behavior" do
       :first_seen => Time.local(2012, 3, 6, 12, 20),
       :last_seen  => Time.local(2012, 3, 6, 12, 50)
     }
-
-    class TestPeople
-      include Campchair::Store
-      self.db_path = 'tmp/ccdb'
-    end
-  end
-
-  after do
-    `rm -fr tmp/ccdb`
   end
 
   it "persists documents" do
-    key = TestPeople << @fred
-    TestPeople[key].should == @fred
+    key = test_class << @fred
+    test_class[key].should == @fred
   end
 
   it "deletes documents" do
-    key = TestPeople << @fred
-    TestPeople.delete(key)
-    TestPeople[key].should be_nil
+    key = test_class << @fred
+    test_class.delete(key)
+    test_class[key].should be_nil
   end
 
   it "updates docuemnts with a key" do
-    key = TestPeople << @fred
+    key = test_class << @fred
     new_last_seen = Time.local(2012, 3, 6, 12, 50)
     @fred[:last_seen] = new_last_seen
-    TestPeople[key] = @fred
+    test_class[key] = @fred
 
-    TestPeople[key][:last_seen].should == new_last_seen
+    test_class[key][:last_seen].should == new_last_seen
   end
 
   it "creates documents with a key" do
     key = 'something'
-    TestPeople[key] = @fred
+    test_class[key] = @fred
 
-    TestPeople[key].should == @fred
+    test_class[key].should == @fred
   end
 
 end
+
+describe "As an persisted object store" do
+  let(:test_class) do
+    Class.new do
+      include Campchair::Model
+      self.db_path = 'tmp/ccdb'
+    end
+  end
+
+  it "persists object attributes" do
+    fred = test_class.new
+    fred.save
+
+    key = fred.key
+    loaded_fred = test_class.load(key)
+    fred.attributes.should == loaded_fred.attributes
+
+    fred.delete
+    test_class.should_not be_exists(fred.key)
+
+    fred = test_class.new
+    fred.save
+    fred.attributes[:favourite_colour] = 'LSD'
+    fred.save
+
+    test_class[fred.key].should == { :favourite_colour => 'LSD' }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: campchair
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leveldb-ruby