campchair 0.0.4 → 0.1.0

data/README.md

@@ -1,22 +1,24 @@
 # ⑁ Campchair
-### Lightweight, ghetto-tech CouchDB-like views in Ruby
+### A fast, ghetto-tech CouchDB-like persistence layer for Ruby
 
 [![Build Status](https://secure.travis-ci.org/captainpete/campchair.png?branch=master)](http://travis-ci.org/captainpete/campchair)
 
 ___This README is a wishlist. The thing doesn't entirely work yet!___
 
-Campchair provides some helpers for lazily materialized views and a
-persistence mapping for different Ruby types.
+Campchair provides some helpers for lazily materialized views,
+and gives you a choice of using ActiveRecord-like models
+or class-based, barebones data-structure access.
 
 Views are described a bit like those found in [CouchDB](http://couchdb.apache.org/).
 Campchair is not a service and has no client-server stuff.
-Parallel writes are not supported, but that's okay – you can use something
+Parallel access is not supported yet, but that's okay – you can use something
 else for concurrency and use this in your persistence fiber/thread/process.
+
 Persistence happens through [LevelDB](http://code.google.com/p/leveldb/).
+Objects are serialized into documents using Ruby's Marshal class.
 This is not append-only and replication is not a feature.
-For these reasons it's called campchair, not couch :)
 
-This project was born at [Railscamp 11](http://railscamps.com/) for the heavy-metrics project.
+This project was born at [Railscamp 11](http://railscamps.com/).
 
 ### How does it look?
 
@@ -41,7 +43,7 @@ Mixing in Campchair DB behavior to a class is as simple as...
 
 ```ruby
 class People
-  include Campchair::LevelDB
+  include Campchair::Store
 end
 ```
 
@@ -49,20 +51,20 @@ Now, use it like a `Hash`.
 
 ```ruby
 # Add a document to the db
-id = People << fred
+key = People << fred
 
 # Add another person
 People << jane
 
 # Rerieve a document from the db
-fred = People[id]
+fred = People[key]
 
 # Delete the document from the db
-People.delete(id)
+People.delete(key)
 
-# Update/create the document in the db using an id
+# Update/create the document in the db using a key
 fred[:last_seen] = Time.new(2012, 3, 6, 12, 40, 25)
-doc[id] = fred
+doc[key] = fred
 ```
 
 ### Basic views _not yet implemented_
@@ -249,7 +251,7 @@ People.average_height_by_location['Docklands, Melbourne, Australia']
 
 ### Custom database path
 
-By default, the folder for db files is 'cddb'.  
+By default, the folder for db files is 'cddb'.
 You can change this with:
 ```ruby
 Campchair.db_path = 'db/heavy_metrics'

data/campchair.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Peter Hollows"]
   s.email       = ["pete@dojo7.com"]
   s.homepage    = "https://github.com/captainpete/campchair"
-  s.summary     = %q{Lightweight, ghetto-tech CouchDB-like views in Ruby}
+  s.summary     = %q{A fast, ghetto-tech CouchDB-like persistence layer for Ruby}
   s.description = %q{Campchair is a map-reduce framework using levelDB for persistence, and Ruby for everything else.}
 
   s.rubyforge_project = "campchair"
@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency(%q<leveldb-ruby>, ["~> 0.14"])
-  s.add_development_dependency(%q<rspec>)
-  s.add_development_dependency(%q<rake>)
+  s.add_dependency  %q<leveldb-ruby>, ["~> 0.14"]
+
+  s.add_development_dependency  %q<rspec>,  ["~> 2.12.0"]
+  s.add_development_dependency  %q<rake>,   ["~> 10.0.0"]
 end

data/lib/campchair/model.rb

@@ -0,0 +1,73 @@
+module Campchair
+  module Model
+    def self.included(base)
+      base.class_eval do
+        include Store
+        extend ClassMethods
+
+        class << self
+          _new = instance_method(:new)
+          define_method(:new) do |*args|
+            _new.bind(self).call(*args).tap(&:initialize_model)
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def load(key)
+        entity = new
+        entity.key = key
+        entity.reload
+        entity
+      end
+    end
+
+    def initialize_model
+      @attributes = {}
+      @new_entity = true
+      @destroyed  = false
+    end
+
+    attr_accessor :key
+    attr_reader :attributes
+
+    def new_entity?
+      @new_entity != false
+    end
+
+    def destroyed?
+      @destroyed != false
+    end
+
+    def persisted?
+      !(new_entity? || destroyed?)
+    end
+
+    def save
+      if key
+        self.class[key] = attributes
+      else
+        self.key = self.class << attributes
+      end
+      @new_entity = false
+      true
+    end
+
+    def delete
+      self.class.delete(key) if persisted?
+      @destroyed = true
+      freeze
+    end
+    alias :destroy :delete
+
+    def reload(options = nil)
+      fresh_attributes = self.class[key]
+      attributes.update(fresh_attributes)
+      @new_entity = false
+
+      self
+    end
+
+  end
+end

data/lib/campchair/{leveldb.rb → store.rb}

@@ -1,8 +1,9 @@
 require 'leveldb'
+require 'fileutils'
 require 'digest/sha1'
 
 module Campchair
-  module LevelDB
+  module Store
     class << self
       def generate_key
         @alpha ||= [('a'..'f'), ('0'..'9')].map(&:to_a).flatten
@@ -19,13 +20,20 @@ module Campchair
 
       def included(base)
         base.class_eval do
+          include Enumerable
+
           class << self
-            attr_writer :db_path, :db_name, :db
+            attr_writer :db_name, :db
 
             def db_path
               @db_path || File.join(Campchair.db_path, db_name)
             end
 
+            def db_path=(value)
+              @db = nil unless @db_path == value
+              @db_path = value
+            end
+
             def db_name
               @db_name || name
             end
@@ -34,30 +42,42 @@ module Campchair
               @db ||= create_db
             end
 
+            def exists?(key)
+              db.exists?(key)
+            end
+
             def [](key)
               val = db[key]
-              val && Campchair::LevelDB.decode(db[key])
+              val && Campchair::Store.decode(db[key])
             end
 
             def []=(key, value)
-              db[key] = Campchair::LevelDB.encode(value)
+              db[key] = Campchair::Store.encode(value)
             end
 
             def <<(value)
-              id = Campchair::LevelDB.generate_key
-              self[id] = value
-              return id
+              key = Campchair::Store.generate_key
+              self[key] = value
+              return key
             end
 
             def delete(key)
               db.delete(key)
             end
 
+            def all
+              db.keys.map { |key| self[key] }
+            end
+
+            def each(&block)
+              db.values.each(&block)
+            end
+
           protected
 
             def create_db
               FileUtils.mkdir_p(db_path)
-              ::LevelDB::DB.new(db_path)
+              LevelDB::DB.new(db_path)
             end
 
           end # class << self
@@ -66,5 +86,5 @@ module Campchair
       end # included
     end # class << self
 
-  end # module LevelDB
+  end # module Store
 end # module Campchair

data/lib/campchair/version.rb

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

data/lib/campchair.rb

@@ -1,8 +1,9 @@
 require "campchair/version"
 
 module Campchair
-  autoload :Views,    'campchair/views'
-  autoload :LevelDB,  'campchair/leveldb'
+  autoload :Views,  'campchair/views'
+  autoload :Store,  'campchair/store'
+  autoload :Model,  'campchair/model'
 
   class << self
     attr_writer :db_path

data/spec/campchair/model_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Campchair::Model do
+
+  context "included" do
+    let(:test_class) do
+      Class.new { include Campchair::Model }
+    end
+    before do
+      test_class.stub! :name => 'TestEntity'
+      test_class.db_path = 'tmp/ccdb/test'
+    end
+
+    it "includes Campchair::Store" do
+      test_class.ancestors.should include(Campchair::Store)
+    end
+
+    describe "#load" do
+      it "retrieves an object by key, populating attributes, from the store" do
+        test_class['BADA55'] = { :colour => 'turple', :awesomeness => '9000' }
+        test_entity = test_class.load('BADA55')
+
+        test_entity.should be_a(test_class)
+        test_entity.attributes.should == { :colour => 'turple', :awesomeness => '9000' }
+        test_entity.should be_persisted
+        test_entity.should_not be_new_entity
+        test_entity.should_not be_destroyed
+      end
+    end
+
+    describe "#save" do
+      context "when not previously persisted (create)" do
+        let(:test_entity) do
+          test_class.new
+        end
+        before do
+          test_entity.should_not be_persisted
+        end
+
+        context "the model has no key" do
+          before do
+            test_entity.key.should be_nil
+          end
+
+          it "adds an attribute hash to the store and sets the model key to the generated store key" do
+            test_entity.stub! :attributes => { :paper => 'is for planes' }
+            test_entity.save
+
+            key = test_entity.key
+            key.should_not be_nil
+            test_class[key].should == { :paper => 'is for planes' }
+          end
+        end
+
+        context "the model has a key" do
+          it "writes an attribute hash to the store keyed by the model's key" do
+          end
+        end
+      end
+
+      context "when already persisted (update)" do
+        let(:test_entity) do
+          test_class['BADA55'] = { :colour => 'turple', :awesomeness => '9000' }
+          test_class.load('BADA55')
+        end
+        before do
+          test_entity.should be_persisted
+        end
+
+        it "updates the attribute hash stored at the model's key, using the model's attributes" do
+          test_entity.stub! :key => 'BADA55', :attributes => { :taste => 'like tripping', :awesomeness => '9001' }
+          test_entity.save
+
+          test_class['BADA55'].should == { :taste => 'like tripping', :awesomeness => '9001' }
+        end
+      end
+
+    end # describe "#save"
+
+    describe "#delete" do
+      it "removes the object from the store" do
+        test_entity = test_class.new
+        test_entity.key = 'BADA55'
+        test_entity.save
+        test_entity.should be_persisted
+        test_class.should be_exists('BADA55')
+
+        test_entity.delete
+        test_entity.should be_destroyed
+        test_class.should_not be_exists('BADA55')
+      end
+    end
+
+  end # context "included"
+end # describe Campchair::Model

data/spec/campchair/{leveldb_spec.rb → store_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe Campchair::LevelDB do
+describe Campchair::Store do
   let(:test_module) do
-    Campchair::LevelDB.dup
+    Campchair::Store.dup
   end
 
   describe ".generate_key" do
@@ -13,26 +13,21 @@ describe Campchair::LevelDB do
 
   context "included" do
     let(:test_class) do
-      Object.send(:remove_const, :TestEntity) if defined? TestEntity
-      TestEntity = Class.new do
-        include Campchair::LevelDB
-      end
+      Class.new { include Campchair::Store }
     end
-
-    after do
-      `rm -fr tmp/ccdb`
+    before do
+      test_class.stub! :name => 'TestEntity'
     end
 
     describe "setting the db_name" do
       describe ".db_name" do
         it "is the class name by default" do
-          test_class.stub! :name => 'TestEntity'
           test_class.db_name.should == 'TestEntity'
         end
       end
 
       describe ".db_name=" do
-        it "is the custom db_name specified" do
+        it "sets the db_name" do
           test_class.db_name = 'TestEntityCustomName'
           test_class.db_name.should == 'TestEntityCustomName'
         end
@@ -43,12 +38,14 @@ describe Campchair::LevelDB do
       describe ".db_path" do
         it "is the Campchair.db_path, and the db_name by default" do
           Campchair.should_receive(:db_path).and_return('some/path')
+          test_class.should_receive(:db_name).and_return('TestEntity')
+
           test_class.db_path.should == 'some/path/TestEntity'
         end
       end
 
       describe ".db_path=" do
-        it "is the custom db_path specified" do
+        it "sets the db_path" do
           test_class.db_path = 'some/other/path'
           test_class.db_path.should == 'some/other/path'
         end
@@ -65,20 +62,44 @@ describe Campchair::LevelDB do
           test_class.db.should be_a(LevelDB::DB)
           test_class.db.pathname.should == 'tmp/ccdb/test'
         end
+
+        it "is cached" do
+          test_class.db.should == test_class.db
+        end
+
+        it "changes to reflect changes to db_path" do
+          first_db = test_class.db
+          test_class.db_path = 'tmp/ccdb/test2'
+          second_db = test_class.db
+
+          first_db.should_not == second_db
+          second_db.pathname.should == 'tmp/ccdb/test2'
+        end
       end
 
       context "no data serialization" do
         before do
           # Passthrough {en,de}coding for these tests
-          Campchair::LevelDB.stub(:encode).and_return {|v| v}
-          Campchair::LevelDB.stub(:decode).and_return {|v| v}
+          Campchair::Store.stub(:encode).and_return {|v| v}
+          Campchair::Store.stub(:decode).and_return {|v| v}
 
           FileUtils.mkdir_p('tmp/ccdb/TestEntity')
-          @db = ::LevelDB::DB.new('tmp/ccdb/TestEntity')
+          @db = LevelDB::DB.new('tmp/ccdb/TestEntity')
 
           test_class.stub! :db => @db
         end
 
+        describe ".exists?" do
+          it "is false when there's no matching key in the database" do
+            test_class.exists?('nonexistent').should be_false
+          end
+
+          it "is true when there's a matching key" do
+            @db['something'] = '22'
+            test_class.exists?('something').should be_true
+          end
+        end
+
         describe ".[]" do
           it "is nil when there's no matching key in the database" do
             test_class['nonexistent'].should be_nil
@@ -98,13 +119,13 @@ describe Campchair::LevelDB do
         end
 
         describe ".<<" do
-          it "adds the value to the database, generating a key" do
+          it "adds the value to the database, returning a key" do
             key = 'b78aa2f6b718651743fac2682003f2c63340ae34b'
-            Campchair::LevelDB.stub! :generate_key => key
+            Campchair::Store.stub! :generate_key => key
 
-            id = TestEntity << '22'
-            id.should == key
-            test_class[id].should == '22'
+            generated_key = test_class << '22'
+            generated_key.should == key
+            test_class[generated_key].should == '22'
           end
         end
 
@@ -112,13 +133,35 @@ describe Campchair::LevelDB do
           it "deletes the key its values from the db" do
             test_class['something'] = '22'
             test_class.delete('something')
-            
+
             test_class['something'].should be_nil
           end
         end
+
+        describe ".all" do
+          it "contains all the values" do
+            test_class << '22'
+            test_class << '22'
+            test_class << '44'
+
+            test_class.all.sort == ['22', '22', '44']
+          end
+        end
+
+        describe ".each" do
+          it "enumerates over all the values" do
+            test_class << '22'
+            test_class << '22'
+            test_class << '44'
+
+            values = []
+            test_class.each { |v| values << v }
+            values.sort.should == ['22', '22', '44']
+          end
+        end
       end
 
-      context "Campchair::LevelDB serialization" do
+      context "Campchair::Store serialization" do
         describe ".[]{,=}" do
           it "persists non-string data structures" do
             doc = { :sym => :sym, 'string' => 'string', 'types' => [1234.12341234, (55..44), /regexen/, Time.now, { 'a' => 22 }] }

data/spec/integration/readme_examples_spec.rb

@@ -16,7 +16,7 @@ describe "DB behavior" do
     }
 
     class TestPeople
-      include Campchair::LevelDB
+      include Campchair::Store
       self.db_path = 'tmp/ccdb'
     end
   end
@@ -25,36 +25,31 @@ describe "DB behavior" do
     `rm -fr tmp/ccdb`
   end
 
-  it "persists documents without an id" do
-    id = TestPeople << @fred
-    TestPeople  << @jane
-  end
-
-  it "retrieves documents" do
-    id = TestPeople << @fred
-    TestPeople[id].should == @fred
+  it "persists documents" do
+    key = TestPeople << @fred
+    TestPeople[key].should == @fred
   end
 
   it "deletes documents" do
-    id = TestPeople << @fred
-    TestPeople.delete(id)
-    TestPeople[id].should be_nil
+    key = TestPeople << @fred
+    TestPeople.delete(key)
+    TestPeople[key].should be_nil
   end
 
-  it "updates docuemnts with an id" do
-    id = TestPeople << @fred
+  it "updates docuemnts with a key" do
+    key = TestPeople << @fred
     new_last_seen = Time.local(2012, 3, 6, 12, 50)
     @fred[:last_seen] = new_last_seen
-    TestPeople[id] = @fred
+    TestPeople[key] = @fred
 
-    TestPeople[id][:last_seen].should == new_last_seen
+    TestPeople[key][:last_seen].should == new_last_seen
   end
 
-  it "creates documents with an id" do
-    id = 'something'
-    TestPeople[id] = @fred
+  it "creates documents with a key" do
+    key = 'something'
+    TestPeople[key] = @fred
 
-    TestPeople[id].should == @fred
+    TestPeople[key].should == @fred
   end
 
 end

data/spec/spec_helper.rb

@@ -1,2 +1,8 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'campchair'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    `rm -fr tmp/ccdb`
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: campchair
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leveldb-ruby
-  requirement: &70242209955760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,29 +21,44 @@ dependencies:
         version: '0.14'
   type: :runtime
   prerelease: false
-  version_requirements: *70242209955760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70242209955340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70242209955340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70242209954880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
   type: :development
   prerelease: false
-  version_requirements: *70242209954880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
 description: Campchair is a map-reduce framework using levelDB for persistence, and
   Ruby for everything else.
 email:
@@ -60,11 +75,13 @@ files:
 - Rakefile
 - campchair.gemspec
 - lib/campchair.rb
-- lib/campchair/leveldb.rb
+- lib/campchair/model.rb
+- lib/campchair/store.rb
 - lib/campchair/version.rb
 - lib/campchair/views.rb
 - spec/.gitkeep
-- spec/campchair/leveldb_spec.rb
+- spec/campchair/model_spec.rb
+- spec/campchair/store_spec.rb
 - spec/campchair/views_spec.rb
 - spec/campchair_spec.rb
 - spec/integration/readme_examples_spec.rb
@@ -90,12 +107,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: campchair
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Lightweight, ghetto-tech CouchDB-like views in Ruby
+summary: A fast, ghetto-tech CouchDB-like persistence layer for Ruby
 test_files:
-- spec/campchair/leveldb_spec.rb
+- spec/campchair/model_spec.rb
+- spec/campchair/store_spec.rb
 - spec/campchair/views_spec.rb
 - spec/campchair_spec.rb
 - spec/integration/readme_examples_spec.rb