zdzolton-cambric 0.4.0 → 0.5.0

data/README.rdoc

@@ -1,6 +1,11 @@
 = Cambric
 
-Opinionated management and usage of CouchDB from your Ruby apps.
+Mildly opinionated management and usage of CouchDB from your Ruby apps.
+
+Cambric supports applications that wish to use multiple CouchDB
+databases/hosts, in a manner that wont muck up your application code. 
+Moreover, it encourages you to use one design document per database used
+by the application.
 
 (BTW, there's nothing specific to Rails in how this works.)
 
@@ -25,46 +30,36 @@ Opinionated management and usage of CouchDB from your Ruby apps.
       }
     }
   end
-  
-  # Optionally:
-  # Cambric.create_all_databases
 
-2) Interact with CouchRest::Database instances:
+2) Use one of the following methods:
+
+  Cambric.prepare_database  # Creates databases for the configured environment
+                            # and pushes up their design docs.
+
+  Cambric.prepare_database! # Or, the bang method forcibly recreates your
+                            # databases for the configured environment.
+
+3) Interact with CouchRest::Database instances:
+
+  tweet_db = Cambric[:tweets]
 
   # Just like normal...
-  Cambric[:tweets].save_doc :author => 'marbles',
-                            :message => 'Is this pork or beef, @Randy?',
-                            :followers => ['randy','zdzolton','trevorturk'],
-                            :created_at => Time.now
+  tweet_db.save_doc :author => 'marbles',
+                    :message => 'Is this pork or beef, @Randy?',
+                    :followers => ['randy','zdzolton','trevorturk'],
+                    :created_at => Time.now
 
   # Except, you do NOT need to re-specify the design doc name when 
-  # calling CouchRest::Database#view —hooray!
-  Cambric[:tweets].view 'by_follower_and_created_at', :limit => 1
-
-3) Push view/design doc changes to CouchDB:
-
-  $ ./script/console
-  irb> require 'rubygems'
-  irb> gem 'zdzolton-cambric'
-  irb> require 'cambric'
-  irb> Cambric.configure do |config|
-         config.design_doc_name = 'twitter-clone'
-         config.environment = ENV['RAILS_ENV']
-     
-         config.databases = {
-           :users => {
-             :development => 'http://127.0.0.1:5984/users-development',
-             :test => 'http://127.0.0.1:5984/users-test',
-             :production => 'http://prod.server:5984/users'
-           },
-           :tweets => {
-             :development => 'http://127.0.0.1:5984/tweets-development',
-             :test => 'http://127.0.0.1:5984/tweets-test',
-             :production => 'http://prod.server:5984/tweets'
-           }
-         }
-       end
-  irb> Cambric.push_all_design_docs
+  # calling CouchRest::Database#view —since you're only using one!
+  tweet_db.view 'by_follower_and_created_at', :limit => 1
+
+4) Push view/design doc changes to CouchDB:
+
+  Cambric.push_design_docs
+  
+  # Alternatively, you can just call this, since it wont create
+  # your database, if they already exist:
+  Cambric.prepare_database
 
 == Installation
 

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/cambric.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cambric}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zachary Zolton", "Geoff Buesing"]
-  s.date = %q{2009-05-20}
+  s.date = %q{2009-05-29}
   s.email = %q{zachary.zolton@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,13 +23,13 @@ Gem::Specification.new do |s|
      "lib/cambric.rb",
      "spec/cambric_spec.rb",
      "spec/fixtures/twitter-clone/tweets/views/by_follower_and_created_at/map.js",
+     "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/zdzolton/cambric}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{Opinionated management and usage of CouchDB from your Ruby apps.}
   s.test_files = [
     "spec/cambric_spec.rb",
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<jchris-couchrest>, [">= 0"])

data/lib/cambric.rb

@@ -24,32 +24,45 @@ module Cambric
     @environment = config.environment
   end
   
-  def self.create_all_databases
+  def self.create_databases!
     @databases.each_pair do |name,db|
-      name_with_env = "#{name}-#{@environment}"
       begin
-        db.server.create_db name_with_env
+        db.server.create_db db.name
       rescue
-        db.server.database(name_with_env).recreate!
+        db.server.database(db.name).recreate!
       end
     end
-    push_all_design_docs
+  end
+  
+  def self.create_databases
+    @databases.each_pair{ |name,db| db.server.create_db db.name rescue nil }
   end
   
   def self.[](database)
     @databases[database.to_sym]
   end
   
-  def self.push_all_design_docs
+  def self.push_design_docs
     @databases.keys.each{ |db| push_design_doc_for db.to_s }
   end
+  
+  def self.prepare_databases
+    create_databases
+    push_design_docs
+  end
+  
+  def self.prepare_databases!
+    create_databases!
+    push_design_docs
+  end
    
 private
 
   def self.push_design_doc_for database
     design_doc_path = File.join @db_dir, database
-    raise "Database directory #{design_doc_path} does not exist!" unless File.exist?(design_doc_path)
-    `couchapp push #{design_doc_path} #{@design_doc_name} #{self[database].uri}`
+    if File.exist?(design_doc_path)
+      `couchapp push #{design_doc_path} #{@design_doc_name} #{self[database].uri}`
+    end
   end
     
 end
@@ -60,7 +73,7 @@ class Cambric::Configurator
   
   def initialize
     @design_doc_name = 'cambric'
-    @db_dir = './couchdb'
+    @db_dir = 'cambric'
     @environment = 'development'
     @databases = {}
   end

data/spec/cambric_spec.rb

@@ -4,14 +4,27 @@ require 'uri'
 TWITTER_CLONE_DATABASES = {
   :users => {
     :development => 'http://127.0.0.1:5984/users-development',
-    :test => 'http://127.0.0.1:5984/users-test'
+    :test => 'http://127.0.0.1:5984/users-testing'
   },
   :tweets => {
     :development => 'http://127.0.0.1:5984/tweets-development',
-    :test => 'http://127.0.0.1:5984/tweets-test'
+    :test => 'http://127.0.0.1:5984/tweets-testing'
   }
 }
 
+def configure_twitter_clone
+  Cambric.configure do |config|
+    config.design_doc_name = 'twitter-clone'
+    config.db_dir = 'spec/fixtures/twitter-clone'
+    config.environment = 'test'
+    config.databases = TWITTER_CLONE_DATABASES
+  end
+end
+
+def delete_twitter_clone_databases
+  %w(users tweets).each{ |db| Cambric[db].delete! rescue nil }
+end
+
 describe Cambric do
   
   describe "after configuring without a block" do
@@ -23,8 +36,8 @@ describe Cambric do
       Cambric.design_doc_name.should == 'cambric'
     end
 
-    it "should default to './couchdb' for the database directory" do
-      Cambric.db_dir.should == './couchdb'
+    it "should default to 'cambric' for the database directory" do
+      Cambric.db_dir.should == 'cambric'
     end
     
     it "should default to 'development' for the environment" do
@@ -32,7 +45,7 @@ describe Cambric do
     end
     
     it "should not throw a fit when creating databases" do
-      Cambric.create_all_databases
+      Cambric.create_databases
     end
   end
   
@@ -40,7 +53,7 @@ describe Cambric do
     before :all do
       Cambric.configure do |config|
         config.design_doc_name = 'twitter-clone'
-        config.db_dir = '../to/some/path'
+        config.db_dir = 'does/not/exist'
         config.environment = 'test'
         config.databases = TWITTER_CLONE_DATABASES
       end
@@ -51,28 +64,25 @@ describe Cambric do
     end
     
     it "should have the config object's value for the database directory" do
-      Cambric.db_dir.should == '../to/some/path'
+      Cambric.db_dir.should == 'does/not/exist'
     end    
     
     it "should have the config object's value for the environment" do
       Cambric.environment.should == 'test'
-    end    
+    end
+    
+    it "should not blow up when calling push_design_docs for non-existent directories" do
+      Cambric.push_design_docs
+    end
   end
     
   describe "after creating databases" do
     before :all do
-      Cambric.configure do |config|
-        config.design_doc_name = 'twitter-clone'
-        config.db_dir = './spec/fixtures/twitter-clone'
-        config.environment = 'test'
-        config.databases = TWITTER_CLONE_DATABASES
-      end
-      Cambric.create_all_databases
+      configure_twitter_clone
+      Cambric.create_databases
     end
     
-    after :all do
-      %w(users tweets).each{ |db| Cambric[db].delete! }
-    end
+    after(:all){ delete_twitter_clone_databases }
     
     it "should be able to query database info" do
       %w(users tweets).each do |db|
@@ -82,25 +92,123 @@ describe Cambric do
     
     it "should have the expected URLs" do
       %w(users tweets).each do |db|
-        Cambric[db].uri.should == "http://127.0.0.1:5984/#{db}-test"
+        Cambric[db].uri.should == "http://127.0.0.1:5984/#{db}-testing"
       end
     end
     
-    it "should have the expected design doc" do
+    it "should have not yet pushed the design docs" do
       %w(users tweets).each do |db|
-        Cambric[db].get("_design/twitter-clone").should_not be_nil
+        lambda do
+          Cambric[db].get("_design/twitter-clone")
+        end.should raise_error(RestClient::ResourceNotFound)
       end
     end
+  end
+  
+  describe "after pushing a test doc" do
+    before :all do
+      configure_twitter_clone
+      Cambric.create_databases
+      @test_doc = { 'foo' => 'bar' }
+      Cambric[:tweets].save_doc @test_doc
+    end
+    
+    after(:all){ delete_twitter_clone_databases }
+    
+    it "should not overwrite the database after calling create_databases" do
+      Cambric.create_databases
+      Cambric[:tweets].get(@test_doc['_id'])['foo'].should == 'bar'
+    end
+    
+    it "should overwrite the database after calling create_databases!" do
+      Cambric.create_databases!
+      lambda do
+        Cambric[:tweets].get(@test_doc['_id'])
+      end.should raise_error(RestClient::ResourceNotFound)
+    end
+  end
+  
+  describe "after pushing design docs" do
+    before :all do
+      configure_twitter_clone
+      Cambric.create_databases
+      Cambric.push_design_docs
+    end
+    
+    after(:all){ delete_twitter_clone_databases }
     
     it "should have defined views for design doc" do
       design_doc = Cambric[:tweets].get("_design/twitter-clone")
       design_doc['views']['by_follower_and_created_at'].should_not be_nil
     end
-    
+  
     it "should be able to query view without re-specifying design doc name" do
       Cambric[:tweets].view 'by_follower_and_created_at'
     end
   end
+  
+  describe "when the design doc already exists" do
+    before :all do
+      configure_twitter_clone
+      Cambric.create_databases
+      @design_doc = { '_id' => '_design/twitter-clone', 'foo' => 'bar' }
+      Cambric[:tweets].save_doc @design_doc
+    end
+    
+    after(:all){ delete_twitter_clone_databases }
+    
+    it "should overwrite when pushing design docs" do
+      Cambric.push_design_docs
+      Cambric[:tweets].get("_design/twitter-clone")['_rev'].should_not == @design_doc['_rev']
+    end
+  end
+  
+  describe "after calling prepare_databases" do
+    before :all do
+      configure_twitter_clone
+      Cambric.prepare_databases
+    end
+    
+    after(:all){ delete_twitter_clone_databases }
+    
+    it "should have created both databases" do
+      %w(users tweets).each do |db|
+        Cambric[db].info.should_not be_nil
+      end
+    end
+    
+    it "should have pushed the design doc to both databases" do
+      %w(users tweets).each do |db|
+        Cambric[db].get('_design/twitter-clone').should_not be_nil
+      end
+    end
+    
+    describe "calling prepare_databases again" do
+      before :all do
+        @test_doc = { 'eye' => 'ball' }
+        Cambric[:tweets].save_doc @test_doc
+        @design_doc_rev = Cambric[:tweets].get('_design/twitter-clone')['_rev']
+        Cambric.prepare_databases
+      end
+      
+      it "should not have re-created the database" do
+        Cambric[:tweets].get(@test_doc['_id'])['eye'].should == 'ball'
+      end
+      
+      it "should have updated the design doc" do
+        Cambric[:tweets].get('_design/twitter-clone')['_rev'].should_not == @design_doc_rev
+      end
+    end
+    
+    it "should re-create the database after calling prepare_databases!" do
+      test_doc = { 'bar' => 'bell' }
+      Cambric[:tweets].save_doc test_doc
+      Cambric.prepare_databases!
+      lambda do
+        Cambric[:tweets].get(test_doc['_id'])
+      end.should raise_error(RestClient::ResourceNotFound)
+    end
+  end
 
 end
 
@@ -113,8 +221,8 @@ describe Cambric::Configurator do
     @config.design_doc_name.should == 'cambric'
   end
 
-  it "should default to './couchdb' for the database directory" do
-    @config.db_dir.should == './couchdb'
+  it "should default to 'cambric' for the database directory" do
+    @config.db_dir.should == 'cambric'
   end
 
   it "should default to 'development' for the environment" do

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zdzolton-cambric
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Zachary Zolton
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-20 00:00:00 -07:00
+date: 2009-05-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,8 +43,9 @@ files:
 - lib/cambric.rb
 - spec/cambric_spec.rb
 - spec/fixtures/twitter-clone/tweets/views/by_follower_and_created_at/map.js
+- spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/zdzolton/cambric
 post_install_message: 
 rdoc_options: 
@@ -68,7 +69,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Opinionated management and usage of CouchDB from your Ruby apps.
 test_files: 
 - spec/cambric_spec.rb