paulcarey-relaxdb 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Paul Carey
+
+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.textile

@@ -0,0 +1,98 @@
+*Note:* For a correctly formatted version of this page, take a look at the "wiki":http://github.com/paulcarey/relaxdb/wikis
+
+h2. Overview
+
+RelaxDB provides a Ruby interface to CouchDB. It offers a simple idiom for specifying object relationships. The underlying objects are persisted to the mighty CouchDB. Combined with the schema free nature of CouchDB, RelaxDB's current strength lies in quick prototyping of object models.
+
+A few facilities are provided including pretty printing of GET requests and uploading of JavaScript views.
+
+A basic merb plugin, "merb_relaxdb":http://github.com/paulcarey/merb_relaxdb/tree/master is also available.
+
+For more complete documentation take a look at docs/spec_results.html and the corresponding specs.
+
+h2. Details 
+
+h3. Getting started
+
+<pre>
+<code>
+  RelaxDB.configure :host => "localhost", :port => 5984
+  RelaxDB.use_db "scratch"
+</code>
+</pre>
+
+h3. Defining models
+
+<pre>
+<code>
+  class Writer < RelaxDB::Document
+    property :name, :default => "anon"
+    
+    has_many :posts, :class => "Post"
+    has_many :ratings, :class => "Post", :known_as => :critic
+  end
+
+  class Post < RelaxDB::Document
+    property :created_at
+    property :contents
+  
+    belongs_to :writer  
+    has_many :ratings, :class => "Rating"
+  end
+
+  class Rating < RelaxDB::Document
+    property :thumbs_up, :validator => lambda { |tu| tu >= 0 && tu < 3 }, :validation_msg => "No no"
+
+    belongs_to :post
+    belongs_to :critic
+  end
+</code>
+</pre>
+
+h3. Exploring models
+
+<pre>
+<code>
+  paul = Writer.new(:name => "paul").save
+
+  post = Post.new(:contents => "foo")
+  paul.posts << post                                          # post writer is set and post is saved
+  post.created_at                                             # right now
+  paul.ratings << Rating.new(:thumbs_up => 3, :post => post)  # returns false as rating fails validation
+  paul.ratings.size                                           # 0
+
+  # Simple views are auto created
+  Rating.all.sorted_by(:thumbs_up) { |q| q.key(2).count(1) }  # query params map directly to CouchDB
+</code>
+</pre>
+
+h3. Creating views by hand
+
+<pre>
+<code>
+  $ cat view.js 
+  function Writer-allnames-map(doc) {
+    if(doc.class == "Writer")
+      emit(null, doc.name);
+  }
+
+  function Writer-allnames-reduce(keys, values) {
+    var allnames = "";
+    for(var i = 0; i < values.length; i++)
+      allnames += values[i];
+    return allnames;
+  }
+  $
+
+  RelaxDB::ViewUploader.upload("view.js")
+  RelaxDB.view("Writer", "allnames")                          # paul
+</code>
+</pre>
+
+h2. Incomplete list of limitations
+
+* Error handling is not robust
+* Destroying an object results in non transactional nullification of child/peer references
+* Objects can talk to only one database at a time
+* No caching is used. Although adding an LRU cache would be fairly straightforward, this hasn't been done as it's not yet clear what caching strategies will be most effective. 
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+PLUGIN = "relaxdb"
+NAME = "relaxdb"
+GEM_VERSION = "0.1.0"
+AUTHOR = "Paul Carey"
+EMAIL = "paul.p.carey@gmail.com"
+HOMEPAGE = "http://github.com/paulcarey/relaxdb/"
+SUMMARY = "RelaxDB provides a simple interface to CouchDB"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  s.add_dependency "extlib", ">=0.9.4"
+  s.add_dependency "json"
+  s.add_dependency "uuid"
+  
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{docs,lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install"
+task :install => [:package] do
+  sh %{sudo gem install --local pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+desc "Run specs and produce spec_results.html"
+Spec::Rake::SpecTask.new('spec:html') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = ["--format", "html:docs/spec_results.html"]
+end