zdzolton-cambric 0.3.1 → 0.4.0

data/README.rdoc

@@ -2,35 +2,69 @@
 
 Opinionated management and usage of CouchDB from your Ruby apps.
 
+(BTW, there's nothing specific to Rails in how this works.)
+
 == Usage
 
 1) Configure the Cambric instances:
 
-  @cambric = Cambric.new open('./config/cambric.yml'), 
-                         :environment => 'development', 
-                         :design_doc => 'twitter-clone'
-
+  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
+  
   # Optionally:
-  # @cambric.create_all_databases
+  # Cambric.create_all_databases
 
 2) Interact with CouchRest::Database instances:
 
-  @tweets_db = @cambric[:tweets]
-  @tweets_db.save_doc :author => 'marbles',
-                      :message => 'Is this pork or beef, @Randy?',
-                      :followers => ['randy','zdzolton','trevorturk'],
-                      :created_at => Time.now
+  # Just like normal...
+  Cambric[:tweets].save_doc :author => 'marbles',
+                            :message => 'Is this pork or beef, @Randy?',
+                            :followers => ['randy','zdzolton','trevorturk'],
+                            :created_at => Time.now
 
-  @tweets_db.view 'by_follower_and_created_at', :limit => 1
+  # 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 changes to CouchDB:
+3) Push view/design doc changes to CouchDB:
 
   $ ./script/console
-  irb> require 'require cambric.rb' # This needs to change when gem becomes available...! :^/
-  irb> @cambric = Cambric.new open('./config/cambric.yml'), 
-                         :environment => 'production', 
-                         :design_doc => 'twitter-clone'
-  irb> @cambric.push_all_design_docs
+  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
 
 == Installation
 
@@ -39,27 +73,15 @@ Opinionated management and usage of CouchDB from your Ruby apps.
   $ sudo gem install jchris-couchapp jchris-couchrest zdzolton-cambric
 
 * Configure Rails:
-
-Coming soon...
-
-* create a couchdb directory within your project
-  $ cd /your/app/root
-  $ mkdir -p ./couchdb/your_db/views/some_view_name
+  * create a config/initializers/cambric.rb file as follows:
   
-* create a ./config/cambric.yml file
-  bar:
-    staging:
-
-    somewhere:
-      host: some.where
+    # coming soon...
 
-  baz:
-    staging:
+  * create a couchdb directory within your project
 
-    somewhere:
-      port: 5566
+    $ cd /your/app/root
+    $ mkdir -p ./couchdb/your_db/views/some_view_name
   
-
 == Copyright
 
 Copyright (c) 2009 Zachary Zolton. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.1

data/cambric.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cambric}
-  s.version = "0.3.1"
+  s.version = "0.4.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-18}
+  s.date = %q{2009-05-20}
   s.email = %q{zachary.zolton@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,9 +22,6 @@ Gem::Specification.new do |s|
      "cambric.gemspec",
      "lib/cambric.rb",
      "spec/cambric_spec.rb",
-     "spec/fixtures/degenerate.yml",
-     "spec/fixtures/foo-bar-baz.yml",
-     "spec/fixtures/twitter-clone.yml",
      "spec/fixtures/twitter-clone/tweets/views/by_follower_and_created_at/map.js",
      "spec/spec_helper.rb"
   ]

data/lib/cambric.rb

@@ -1,29 +1,32 @@
-require 'erb'
-require 'yaml'
 require 'couchrest'
+require 'uri'
 
-class Cambric
+module Cambric
   
-  attr_reader :config, :environment, :design_doc_name, :db_dir
+  def self.design_doc_name
+    @design_doc_name
+  end
+  
+  def self.db_dir
+    @db_dir
+  end
   
-  def initialize(yaml_config_io, options={})
-    options.keys.map!{ |k| k.to_sym }
-    @config = YAML::load(ERB.new(yaml_config_io.read).result)
-    validate_options_hash options
-    @environment = options[:environment]
-    @design_doc_name = options[:design_doc]
-    @db_dir = options[:db_dir] || './couchdb'
-    validate_environments_exists_for_all_dbs
-    initialize_databases
+  def self.environment
+    @environment
   end
   
-  def [](db)
-    @databases[db.to_sym]
+  def self.configure
+    config = Configurator.new
+    yield config if block_given?
+    @databases = config.initialize_databases
+    @design_doc_name = config.design_doc_name
+    @db_dir = config.db_dir
+    @environment = config.environment
   end
   
-  def create_all_databases
-    @databases.each_pair do |db_name,db|
-      name_with_env = "#{db_name}-#{@environment}"
+  def self.create_all_databases
+    @databases.each_pair do |name,db|
+      name_with_env = "#{name}-#{@environment}"
       begin
         db.server.create_db name_with_env
       rescue
@@ -33,53 +36,63 @@ class Cambric
     push_all_design_docs
   end
   
-  def push_all_design_docs
-    @databases.keys.each{ |db| push_design_doc_for db.to_s }
+  def self.[](database)
+    @databases[database.to_sym]
   end
   
+  def self.push_all_design_docs
+    @databases.keys.each{ |db| push_design_doc_for db.to_s }
+  end
+   
 private
 
-  def push_design_doc_for database
+  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}`
   end
+    
+end
 
-  def validate_options_hash options
-    %w(environment design_doc).each do |opt_key|
-      unless options.has_key?(opt_key.to_sym)
-        raise "Must provide :#{opt_key} option"
-      end
-    end
-  end
-
-  def validate_environments_exists_for_all_dbs
-    @config.each_pair do |db,env_hash|
-      raise "No Cambric config for DB '#{db}' ENV '#{@environment}'" unless env_hash.has_key?(@environment)
-    end
+class Cambric::Configurator
+  
+  attr_accessor :design_doc_name, :db_dir, :environment, :databases
+  
+  def initialize
+    @design_doc_name = 'cambric'
+    @db_dir = './couchdb'
+    @environment = 'development'
+    @databases = {}
   end
   
   def initialize_databases
-    @databases = {}
-    @config.each_pair do |db_name,conn_by_env|
-      conn_settings = conn_by_env[@environment] || {}
-      host = conn_settings['host'] || 'localhost'
-      port = conn_settings['port'] || 5984
-      database = CouchRest.new("http://#{host}:#{port}").database("#{db_name}-#{@environment}")
-      database.extend AssumeDesignDocName
-      database.design_doc_name = @design_doc_name
-      @databases[db_name.to_sym] = database
+    dbs_by_name = {}
+    @databases.each_pair do |db,urls_by_env|
+      urls_by_env.keys.map!{ |env| env.to_sym }
+      uri = URI.parse urls_by_env[@environment.to_sym]
+      dbs_by_name[db.to_sym] = initialize_database uri
     end
+    dbs_by_name
   end
   
-  module AssumeDesignDocName
+private
 
-    attr_accessor :design_doc_name
-    
-    def view name, options={}, &block
-      super "#{@design_doc_name}/#{name}", options, &block
-    end
-    
+  def initialize_database uri
+    server = CouchRest.new("#{uri.scheme}://#{uri.host}:#{uri.port}")
+    database = server.database uri.path.gsub(/^\//, '')
+    database.extend ::Cambric::AssumeDesignDocName
+    database.cambric_design_doc_name = @design_doc_name
+    database
+  end
+  
+end
+
+module Cambric::AssumeDesignDocName
+
+  attr_accessor :cambric_design_doc_name
+  
+  def view name, options={}, &block
+    super "#{@cambric_design_doc_name}/#{name}", options, &block
   end
   
 end

data/spec/cambric_spec.rb

@@ -1,130 +1,136 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'uri'
 
-describe Cambric do
-
-  describe "when initializing without the design document name" do
-    it "should raise an error" do
-      lambda do 
-        Cambric.new load_fixture('tweets.yml'), :environment => 'development' 
-      end.should raise_error
-    end
-  end
+TWITTER_CLONE_DATABASES = {
+  :users => {
+    :development => 'http://127.0.0.1:5984/users-development',
+    :test => 'http://127.0.0.1:5984/users-test'
+  },
+  :tweets => {
+    :development => 'http://127.0.0.1:5984/tweets-development',
+    :test => 'http://127.0.0.1:5984/tweets-test'
+  }
+}
 
-  describe "when initializing for a non-specified environment" do
-    it "should raise an error" do
-      lambda do
-        Cambric.new load_fixture('degenerate.yml'), 
-                    :environment => 'staging', 
-                    :design_doc => 'blarg'
-      end.should raise_error
-    end
-  end
+describe Cambric do
   
-  it "should assume ./couchdb as the database path" do
-    lambda do
-      @cambric = Cambric.new load_fixture('foo-bar-baz.yml'), 
-                             :environment => 'staging', 
-                             :design_doc => 'xop'
-
-      @cambric.push_all_design_docs
-    end.should raise_error
-  end
-
-  describe "after initializing with required information" do
-    
+  describe "after configuring without a block" do
     before :all do
-      @cambric = Cambric.new load_fixture('twitter-clone.yml'), 
-                             :environment => 'development', 
-                             :design_doc => 'twitter-clone',
-                             :db_dir => File.join(FIXTURES_PATH, 'twitter-clone')
+      Cambric.configure
     end
-  
-    it "should have a value for the environment" do
-      @cambric.environment.should_not be_nil
+    
+    it "should default its design doc name to 'cambric'" do
+      Cambric.design_doc_name.should == 'cambric'
     end
 
-    it "should have something for config" do
-      @cambric.config.should_not be_nil
+    it "should default to './couchdb' for the database directory" do
+      Cambric.db_dir.should == './couchdb'
     end
     
-    it "should match the given design document name" do
-      @cambric.design_doc_name.should == 'twitter-clone'
+    it "should default to 'development' for the environment" do
+      Cambric.environment.should == 'development'
     end
     
-    it "should match the given database directory" do
-      @cambric.db_dir.should =~ /\/spec\/fixtures\/twitter-clone/
+    it "should not throw a fit when creating databases" do
+      Cambric.create_all_databases
     end
-
-    it "should contain a key for each database entry" do
-      %w(users tweets).each do |db|
-        @cambric.config.keys.should include(db)
+  end
+  
+  describe "after instantiating with a block" do
+    before :all do
+      Cambric.configure do |config|
+        config.design_doc_name = 'twitter-clone'
+        config.db_dir = '../to/some/path'
+        config.environment = 'test'
+        config.databases = TWITTER_CLONE_DATABASES
       end
     end
     
-    it "should hash-style access databases, by name, as string or symbol" do
-      %w(users tweets).each do |db_name|
-        [db_name, db_name.to_sym].each do |db|
-          @cambric[db].uri.should =~ /localhost:5984\/#{db}-development$/
-        end
-      end
+    it "should have the config object's value for the design doc name" do
+      Cambric.design_doc_name.should == 'twitter-clone'
     end
     
-    describe "after pushing up the databases" do
-      before :all do
-        @cambric.create_all_databases
-        @tweets_db = @cambric[:tweets]
-      end
-      
-      it "should access views with omitted design doc name" do
-        @tweets_db.save_doc :author => 'marbles',
-                            :message => 'Is this pork or beef, @Randy?',
-                            :followers => ['randy','zdzolton','trevorturk'],
-                            :created_at => Time.now
-
-        @tweets_db.view 'by_follower_and_created_at', :limit => 1
-      end
-    end
+    it "should have the config object's value for the database directory" do
+      Cambric.db_dir.should == '../to/some/path'
+    end    
     
+    it "should have the config object's value for the environment" do
+      Cambric.environment.should == 'test'
+    end    
   end
     
-  describe "when creating databases" do
+  describe "after creating databases" do
     before :all do
-      Cambric.new(load_fixture('foo-bar-baz.yml'), 
-                  :environment => 'staging', 
-                  :design_doc => 'xop',
-                  :db_dir =>  File.join(FIXTURES_PATH, 'foo-bar-baz')).create_all_databases
-      @server = CouchRest.new("localhost:5984")
+      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
+    end
+    
+    after :all do
+      %w(users tweets).each{ |db| Cambric[db].delete! }
     end
     
-    it "should be able to access databases, with the environment name" do
-      %w(bar baz).each do |db|
-        @server.database("#{db}-staging").info.should_not be_nil
+    it "should be able to query database info" do
+      %w(users tweets).each do |db|
+        Cambric[db].info.should_not be_nil
       end
     end
     
-    it "should have pushed to each the specified design doc name" do
-      %w(bar baz).each do |db|
-        @server.database("#{db}-staging").get('_design/xop').should_not be_nil
+    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"
       end
     end
-  end
-  
-  describe "when the YAML specifies a host or port value" do
-    before :all do
-      @cambric = Cambric.new load_fixture('foo-bar-baz.yml'), 
-                             :environment => 'somewhere', 
-                             :design_doc => 'xop',
-                             :db_dir =>  File.join(FIXTURES_PATH, 'foo-bar-baz')
+    
+    it "should have the expected design doc" do
+      %w(users tweets).each do |db|
+        Cambric[db].get("_design/twitter-clone").should_not be_nil
+      end
     end
     
-    it "should reflect the host value in the database URI" do
-      URI.parse(@cambric[:bar].uri).host.should == 'some.where'
+    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 reflect the port value in the database URI" do
-      URI.parse(@cambric[:baz].uri).port.should == 5566
+    it "should be able to query view without re-specifying design doc name" do
+      Cambric[:tweets].view 'by_follower_and_created_at'
     end
   end
 
 end
+
+describe Cambric::Configurator do
+  before :all do
+    @config = Cambric::Configurator.new
+  end
+
+  it "should default its design doc name to 'cambric'" do
+    @config.design_doc_name.should == 'cambric'
+  end
+
+  it "should default to './couchdb' for the database directory" do
+    @config.db_dir.should == './couchdb'
+  end
+
+  it "should default to 'development' for the environment" do
+    @config.environment.should == 'development'
+  end
+  
+  describe "when retrieving the configured CouchRest::Database instances" do
+    before :all do
+      @config.databases = TWITTER_CLONE_DATABASES
+      @dbs = @config.initialize_databases
+    end
+    
+    it "should have the expected URLs for development environment" do
+      %w(users tweets).each do |db|
+        @dbs[db.to_sym].uri.should == "http://127.0.0.1:5984/#{db}-development"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zdzolton-cambric
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Zachary Zolton
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -07:00
+date: 2009-05-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,9 +42,6 @@ files:
 - cambric.gemspec
 - lib/cambric.rb
 - spec/cambric_spec.rb
-- spec/fixtures/degenerate.yml
-- spec/fixtures/foo-bar-baz.yml
-- spec/fixtures/twitter-clone.yml
 - spec/fixtures/twitter-clone/tweets/views/by_follower_and_created_at/map.js
 - spec/spec_helper.rb
 has_rdoc: true

data/spec/fixtures/degenerate.yml

@@ -1,2 +0,0 @@
-spaz:
-  

data/spec/fixtures/foo-bar-baz.yml

@@ -1,11 +0,0 @@
-bar:
-  staging:
-    
-  somewhere:
-    host: some.where
-    
-baz:
-  staging:
-    
-  somewhere:
-    port: 5566

data/spec/fixtures/twitter-clone.yml

@@ -1,6 +0,0 @@
-users:
-  development:
-    
-tweets:
-  development:
-