zdzolton-cambric 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Zachary Zolton
+
+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.rdoc

@@ -0,0 +1,17 @@
+= Cambric
+
+Opinionated management and usage of CouchDB from your Ruby apps.
+
+== Usage
+
+Coming soon...
+
+== Installation
+
+sudo gem install jchris-couchapp jchris-couchrest zdzolton-cambric
+
+Configure Rails: Coming soon...
+
+== Copyright
+
+Copyright (c) 2009 Zachary Zolton. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cambric"
+    gem.summary = %Q{Opinionated management and usage of CouchDB from your Ruby apps.}
+    gem.email = "zachary.zolton@gmail.com"
+    gem.homepage = "http://github.com/zdzolton/cambric"
+    gem.authors = ["Zachary Zolton", "Geoff Buesing"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('jchris-couchrest', '>= 1.0.5')
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cambric #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/cambric.rb

@@ -0,0 +1,85 @@
+require 'erb'
+require 'yaml'
+require 'couchrest'
+
+class Cambric
+  
+  attr_reader :config, :environment, :design_doc_name, :db_dir
+  
+  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
+  end
+  
+  def [](db)
+    @databases[db.to_sym]
+  end
+  
+  def create_all_databases
+    @databases.each_pair do |db_name,db|
+      name_with_env = "#{db_name}-#{@environment}"
+      begin
+        db.server.create_db name_with_env
+      rescue
+        db.server.database(name_with_env).recreate!
+      end
+    end
+    push_all_design_docs
+  end
+  
+  def push_all_design_docs
+    @databases.keys.each{ |db| push_design_doc_for db.to_s }
+  end
+  
+private
+
+  def 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
+
+  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
+  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
+    end
+  end
+  
+  module AssumeDesignDocName
+
+    attr_accessor :design_doc_name
+    
+    def view name, options={}, &block
+      super "#{@design_doc_name}/#{name}", options, &block
+    end
+    
+  end
+  
+end

data/spec/cambric_spec.rb

@@ -0,0 +1,130 @@
+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
+
+  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
+  
+  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
+    
+    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')
+    end
+  
+    it "should have a value for the environment" do
+      @cambric.environment.should_not be_nil
+    end
+
+    it "should have something for config" do
+      @cambric.config.should_not be_nil
+    end
+    
+    it "should match the given design document name" do
+      @cambric.design_doc_name.should == 'twitter-clone'
+    end
+    
+    it "should match the given database directory" do
+      @cambric.db_dir.should =~ /\/spec\/fixtures\/twitter-clone/
+    end
+
+    it "should contain a key for each database entry" do
+      %w(users tweets).each do |db|
+        @cambric.config.keys.should include(db)
+      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
+    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
+    
+  end
+    
+  describe "when 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")
+    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
+      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
+      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')
+    end
+    
+    it "should reflect the host value in the database URI" do
+      URI.parse(@cambric[:bar].uri).host.should == 'some.where'
+    end
+    
+    it "should reflect the port value in the database URI" do
+      URI.parse(@cambric[:baz].uri).port.should == 5566
+    end
+  end
+
+end

data/spec/fixtures/degenerate.yml

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

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

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

data/spec/fixtures/twitter-clone/tweets/views/by_follower_and_created_at/map.js

@@ -0,0 +1,7 @@
+function(doc) {
+  var outdoc = { message: doc.message, author: doc.author };
+  doc.followers.push(doc.author);
+  doc.followers.forEach(function(f) {
+      emit([f, doc.created_at], outdoc);
+  });
+};

data/spec/fixtures/twitter-clone.yml

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

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'spec'
+
+# Gem dependencies... Here?
+require 'rubygems'
+gem 'jchris-couchrest'
+
+require 'json'
+require 'couchrest'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'cambric'
+
+FIXTURES_PATH = './spec/fixtures'
+
+def load_fixture *path
+  open(File.expand_path(File.join %w(spec fixtures) + path))
+end
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: zdzolton-cambric
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Zachary Zolton
+- Geoff Buesing
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jchris-couchrest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.5
+    version: 
+description: 
+email: zachary.zolton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- 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
+homepage: http://github.com/zdzolton/cambric
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Opinionated management and usage of CouchDB from your Ruby apps.
+test_files: 
+- spec/cambric_spec.rb
+- spec/spec_helper.rb