recliner 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.yardoc

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Sam Pohlenz
+
+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,37 @@
+Recliner is a Ruby ORM for interfacing with CouchDB (http://couchdb.apache.org/) databases.
+
+It is designed to be familiar to users of ActiveRecord, but diverges where necessary to fit with the CouchDB document/view paradigm.
+
+
+Example
+=======
+
+class Article < Recliner::Document
+  property :title, String, :default => 'Untitled'
+  property :body, String
+  property :published_at, DateTime
+  property :approved, Boolean, :default => false
+  timestamps!
+  
+  attr_protected :published_at, :approved
+  
+  belongs_to :author, :class_name => 'User'
+  
+  default_order :published_at
+  
+  view :by_title, :order => :title
+  view :approved, :conditions => { :approved => true }
+  
+  validates_presence_of :title, :body
+  
+  before_save :set_published_at
+end
+
+
+article1 = Article.create(:title => "Recliner wins multiple awards!",
+                          :body => "Actually, it hasn't happened yet",
+                          :approved => true)
+article2 = Article.create(:title => "Recliner 1.0 released",
+                          :body => "Yes, it's true!",
+                          :approved => false)
+

data/Rakefile

@@ -0,0 +1,63 @@
+require 'spec/rake/spectask'
+require 'cucumber/rake/task'
+require 'rake/rdoctask'
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.spec_opts = ['--options', "#{File.expand_path(File.dirname(__FILE__))}/spec/spec.opts"]
+end
+
+namespace :spec do
+  desc "Run specs in nested documenting format"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.libs << 'lib'
+    t.spec_opts = ["--format", "nested", '--colour']
+  end
+end
+
+Cucumber::Rake::Task.new(:features, "Run Cucumber features (except @completed and @pending)") do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty'), '-r features', '--tags ~@completed,~@pending']
+end
+
+namespace :features do
+  Cucumber::Rake::Task.new(:all, "Run all Cucumber features (except @pending)") do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty'), '-r features', '--tags ~@pending']
+  end
+end
+
+desc "Generate documentation"
+Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('lib')
+end
+
+desc "Report code statistics (KLOCs, etc)"
+task :stats do
+  require 'vendor/code_statistics'
+  CodeStatistics::TEST_TYPES.replace ['Specs']
+  CodeStatistics.new(['Recliner Library', 'lib'], ['Specs', 'spec']).to_s
+end
+
+begin
+  require 'jeweler'
+  
+  Jeweler::Tasks.new do |gem|
+    gem.name = "recliner"
+    gem.summary = "CouchDB ORM for Ruby/Rails"
+    gem.description = "Recliner is a CouchDB ORM for Ruby/Rails similar to ActiveRecord and DataMapper."
+    gem.email = "sam@sampohlenz.com"
+    gem.homepage = "http://github.com/spohlenz/recliner"
+    gem.authors = ["Sam Pohlenz"]
+    
+    gem.add_dependency('rest-client', '>= 1.0.3')
+    gem.add_dependency('json', '>= 1.1.9')
+    gem.add_dependency('uuid', '>= 2.0.2')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

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

data/features/associations/has.feature

@@ -0,0 +1,36 @@
+Feature: has association
+  
+  
+  Background:
+    Given the default Recliner::Document database is set to "http://localhost:5984/recliner-features"
+    And the database "http://localhost:5984/recliner-features" exists
+    And the following document definitions:
+      """
+      class User < Recliner::Document
+      end
+      
+      class Article < Recliner::Document
+        has :author
+      end
+      """
+  
+  Scenario: assigning instance to association
+    Given I have a saved instance of "User" with id "user-1"
+    And I have a saved instance of "Article" with id "article-1"
+    When I set its author to the "User" with id "user-1"
+    Then its "author" should be the "User" with id "user-1"
+  
+  Scenario: assigning id to association
+    Given I have a saved instance of "User" with id "user-1"
+    And I have a saved instance of "Article" with id "article-1"
+    When I set its author_id to "user-1"
+    Then its "author" should be the "User" with id "user-1"
+  
+  Scenario: loading association
+    Given I have a saved instance of "User" with id "user-1"
+    And I have a saved instance of "Article" with attributes:
+      | id        | article-1 |
+      | author_id | user-1    |
+    When I load the "Article" instance with id "article-1"
+    Then its "author" should be the "User" with id "user-1"
+    

data/features/document/deleting.feature

@@ -0,0 +1,39 @@
+@completed
+Feature: Deleting documents
+  Deleting a Recliner::Document removes it from the database
+  It does not run any callbacks
+  
+  Background:
+    Given the default Recliner::Document database is set to "http://localhost:5984/recliner-features"
+    And the database "http://localhost:5984/recliner-features" exists
+    And the following document definition:
+      """
+      class Article < Recliner::Document
+      end
+      """
+      
+  Scenario: Delete a new document
+    When I create an instance of "Article"
+    And I delete the instance
+    Then the instance should be read only
+  
+  Scenario: Deleting an existing document
+    Given I have a saved instance of "Article" with id "article-1"
+    When I delete the instance
+    Then the instance should be read only
+    And there should be no document at "http://localhost:5984/recliner-features/article-1"
+    
+  Scenario: Deleting a document with an out-of-date revision
+    Given I have a saved instance of "Article" with id "article-1"
+    And the "Article" with id "article-1" is updated elsewhere
+    When I delete the instance
+    Then a "Recliner::StaleRevisionError" exception should be raised
+    
+  Scenario: Deleting an already deleted document
+    Given I have a saved instance of "Article" with id "article-1"
+    And no document exists at "http://localhost:5984/recliner-features/article-1"
+    When I delete the instance
+    Then no exception should be raised
+    And the instance should be read only
+    And there should be no document at "http://localhost:5984/recliner-features/article-1"
+    

data/features/document/destroying.feature

@@ -0,0 +1,39 @@
+@completed
+Feature: Destroying documents
+  Destroying a Recliner::Document removes it from the database
+  It also runs any before/after_destroy callbacks that are defined
+  
+  Background:
+    Given the default Recliner::Document database is set to "http://localhost:5984/recliner-features"
+    And the database "http://localhost:5984/recliner-features" exists
+    And the following document definition:
+      """
+      class Article < Recliner::Document
+      end
+      """
+      
+  Scenario: Destroy a new document
+    When I create an instance of "Article"
+    And I destroy the instance
+    Then the instance should be read only
+  
+  Scenario: Destroying an existing document
+    Given I have a saved instance of "Article" with id "article-1"
+    When I destroy the instance
+    Then the instance should be read only
+    And there should be no document at "http://localhost:5984/recliner-features/article-1"
+    
+  Scenario: Destroying a document with an out-of-date revision
+    Given I have a saved instance of "Article" with id "article-1"
+    And the "Article" with id "article-1" is updated elsewhere
+    When I destroy the instance
+    Then a "Recliner::StaleRevisionError" exception should be raised
+    
+  Scenario: Destroying an already deleted document
+    Given I have a saved instance of "Article" with id "article-1"
+    But no document exists at "http://localhost:5984/recliner-features/article-1"
+    When I destroy the instance
+    Then no exception should be raised
+    And the instance should be read only
+    And there should be no document at "http://localhost:5984/recliner-features/article-1"
+  

data/features/document/instantiation.feature

@@ -0,0 +1,32 @@
+@completed
+Feature: New document instantiation
+  Recliner::Document models can be instantiated with or without attributes
+  
+  Background:
+    Given the default Recliner::Document database is set to "http://localhost:5984/recliner-features"
+    And the database "http://localhost:5984/recliner-features" exists
+    And the following document definition:
+      """
+      class Article < Recliner::Document
+        property :title, String
+        property :content, String
+      end
+      """
+  
+  Scenario: New document instance
+    When I create an instance of "Article"
+    Then the instance should be a new record
+    And the instance should autogenerate an id
+    And the instance should not have a revision
+  
+  Scenario: New document instance with attributes
+    When I create an instance of "Article" with:
+      | id      | article-id             |
+      | title   | Article Title          |
+      | content | Content for article... |
+    Then the instance should be a new record
+    And the instance should have id "article-id"
+    And the instance should have title "Article Title"
+    And the instance should have content "Content for article..."
+    And the instance should not have a revision
+    

data/features/document/loading.feature

@@ -0,0 +1,86 @@
+@completed
+Feature: Document loading
+  Recliner offers two ways of loading documents:
+    load  => does not raise exceptions for missing documents
+    load! => does raise exceptions for missing documents
+  
+  Either individual or multiple documents can be loaded at once
+  
+  Background:
+    Given the default Recliner::Document database is set to "http://localhost:5984/recliner-features"
+    And the database "http://localhost:5984/recliner-features" exists
+    And the following document definition:
+      """
+      class User < Recliner::Document
+        property :name, String
+      end
+      """
+
+  Scenario: Loading a document
+    Given a document exists at "http://localhost:5984/recliner-features/existing-user" with:
+      """
+      {
+        :class => 'User',
+        :name => 'Test User'
+      }
+      """
+    When I load the "User" instance with id "existing-user"
+    Then the instance should not be a new record
+    And the instance should have id "existing-user"
+    And the instance should have name "Test User"
+
+  Scenario: Loading a missing document
+    Given no document exists at "http://localhost:5984/recliner-features/missing-user"
+    When I load the "User" instance with id "missing-user"
+    Then the instance should be nil
+
+  Scenario: Loading a document with load!
+    Given a document exists at "http://localhost:5984/recliner-features/existing-user" with:
+      """
+      {
+        :class => 'User',
+        :name => 'Test User'
+      }
+      """
+    When I load! the "User" instance with id "existing-user"
+    Then the instance should not be a new record
+    And the instance should have id "existing-user"
+    And the instance should have name "Test User"
+
+  Scenario: Loading a missing document with load!
+    Given no document exists at "http://localhost:5984/recliner-features/missing-user"
+    When I load! the "User" instance with id "missing-user"
+    Then a "Recliner::DocumentNotFound" exception should be raised
+
+  Scenario: Loading multiple documents
+    Given a "User" document exists at "http://localhost:5984/recliner-features/user-1"
+    And a "User" document exists at "http://localhost:5984/recliner-features/user-2"
+    When I load the "User" instances with ids "user-1, user-2"
+    Then instance 1 should not be a new record
+    And instance 1 should have id "user-1"
+    And instance 2 should not be a new record
+    And instance 2 should have id "user-2"
+  
+  Scenario: Loading multiple documents (some missing)
+    Given a "User" document exists at "http://localhost:5984/recliner-features/user-1"
+    And no document exists at "http://localhost:5984/recliner-features/missing-user"
+    When I load the "User" instances with ids "user-1, missing-user"
+    Then instance 1 should not be a new record
+    And instance 1 should have id "user-1"
+    And instance 2 should be nil
+  
+  Scenario: Loading multiple documents with load!
+    Given a "User" document exists at "http://localhost:5984/recliner-features/user-1"
+    And a "User" document exists at "http://localhost:5984/recliner-features/user-2"
+    When I load! the "User" instances with ids "user-1, user-2"
+    Then instance 1 should not be a new record
+    And instance 1 should have id "user-1"
+    And instance 2 should not be a new record
+    And instance 2 should have id "user-2"
+  
+  Scenario: Loading multiple documents with load! (some missing)
+    Given a "User" document exists at "http://localhost:5984/recliner-features/user-1"
+    And no document exists at "http://localhost:5984/recliner-features/missing-document"
+    When I load! the "User" instances with ids "user-1, missing-document"
+    Then a "Recliner::DocumentNotFound" exception should be raised
+  

data/features/document/saving.feature

@@ -0,0 +1,88 @@
+@completed
+Feature: Saving documents
+  Recliner offers two ways of saving documents:
+    save  => does not raise exception if document cannot be saved
+    save! => raises exception if document cannot be saved
+  
+  Background:
+    Given the default Recliner::Document database is set to "http://localhost:5984/recliner-features"
+    And the database "http://localhost:5984/recliner-features" exists
+    And the following document definition:
+      """
+      class Article < Recliner::Document
+        property :title, String
+        property :content, String
+      end
+      """
+  
+  Scenario: Saving a new document
+    Given I have an unsaved instance of "Article"
+    When I set its id to "article-1"
+    And I set its title to "Article title"
+    And I save the instance
+    Then the instance should not be a new record
+    And the instance should have a revision matching "^1-"
+    And there should be a document at "http://localhost:5984/recliner-features/article-1" with:
+      """
+      {
+        '_id'   => 'article-1',
+        'class' => 'Article',
+        'title' => 'Article title'
+      }
+      """
+
+  Scenario: Saving a new document with save!
+    Given I have an unsaved instance of "Article"
+    And I set its id to "article-1"
+    And I set its title to "Article title"
+    And I save! the instance
+    Then the instance should not be a new record
+    And the instance should have a revision matching "^1-"
+    And there should be a document at "http://localhost:5984/recliner-features/article-1" with:
+      """
+      {
+        '_id'   => 'article-1',
+        'class' => 'Article',
+        'title' => 'Article title'
+      }
+      """
+
+  Scenario: Saving an existing document
+    Given I have a saved instance of "Article" with id "article-1"
+    When I save the instance
+    Then the instance should have a revision matching "^2-"
+  
+  Scenario: Saving an existing document with save!
+    Given I have a saved instance of "Article" with id "article-1"
+    When I save! the instance
+    Then the instance should have a revision matching "^2-"
+  
+  Scenario: Saving an existing document with an outdated revision
+    Given I have a saved instance of "Article" with:
+      | id    | article-1     |
+      | title | Article title |
+    And I set its revision to "4-123456"
+    And I set its title to "New title"
+    When I save the instance
+    Then there should be a document at "http://localhost:5984/recliner-features/article-1" with:
+      """
+      {
+        'title' => 'Article title'
+      }
+      """
+  
+  Scenario: Saving an existing document with save! with an outdated revision
+    Given I have a saved instance of "Article" with:
+      | id    | article-1     |
+      | title | Article title |
+    And I set its revision to "4-123456"
+    And I set its title to "New title"
+    When I save! the instance
+    Then a "Recliner::StaleRevisionError" exception should be raised
+    And there should be a document at "http://localhost:5984/recliner-features/article-1" with:
+      """
+      {
+        'title' => 'Article title'
+      }
+      """
+