eee-c-couch_design_docs 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,8 @@
+== 1.0.2 / 2009-07-13
+
+* Round out the API so that it is possible to load an entire directory
+  into a CouchDB database.
+
 == 1.0.0 / 2009-07-08
 
 * 1 major enhancement

data/README.txt

@@ -8,11 +8,20 @@ Manage CouchDB views.
 
 == FEATURES/PROBLEMS:
 
-* Not acutally working just yet :)
+* Allows you to store your CouchDB design documents on the file system
+  with <tt>.js</tt> extensions.
 
 == SYNOPSIS:
 
-  CouchDesignDocs.load(COUCHDB_VIEW_DIRECTORY)
+  DB_URL = "http://localhost:5984/db"
+  DIRECTORY = "/repos/db/coudb/_design"
+
+  # /repos/db/coudb/_design/lucene/transform.js
+
+  CouchDesignDocs.upload_dir(DB_URL, DIRECTORY)
+
+  # => lucene design document with a "transform" function containing
+  #    the contents of transform.js
 
 == REQUIREMENTS:
 
@@ -22,7 +31,7 @@ Manage CouchDB views.
 
 == INSTALL:
 
-* sudo gem install couch_view
+* sudo gem install couch_design_docs
 
 == LICENSE:
 

data/couch_design_docs.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couch_design_docs}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Strom"]
-  s.date = %q{2009-07-12}
+  s.date = %q{2009-07-13}
   s.default_executable = %q{couch_design_docs}
   s.description = %q{Manage CouchDB views.}
   s.email = %q{chris@eeecooks.com}

data/lib/couch_design_docs.rb

@@ -1,8 +1,9 @@
+require 'pp'
 
 module CouchDesignDocs
 
   # :stopdoc:
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
@@ -13,6 +14,16 @@ module CouchDesignDocs
     VERSION
   end
 
+  # For a CouchDB database described by <tt>db_uri</tt> and a
+  # directory, <tt>dir</tt> containing design documents, creates
+  # design documents in the CouchDB database
+  #
+  def self.upload_dir(db_uri, dir)
+    store = Store.new(db_uri)
+    dir = Directory.new(dir)
+    store.load(dir.to_hash)
+  end
+
   # Returns the library path for the module. If any arguments are given,
   # they will be joined to the end of the libray path using
   # <tt>File.join</tt>.

data/lib/couch_design_docs/store.rb

@@ -5,18 +5,26 @@ module CouchDesignDocs
   class Store
     attr_accessor :url
 
+    # Initialize a CouchDB store object.  Requires a URL for the
+    # target CouchDB database.
+    #
     def initialize(url)
       @url = url
     end
 
+    # Loads all supplied designed documents in the current store.
+    # Given a hash <tt>h</tt>, the keys being the CouchDB document
+    # name and values of design documents
+    #
     def load(h)
       h.each_pair do |document_name, doc|
         Store.put!("#{url}/_design/#{document_name}", doc)
       end
     end
 
-    # Create or replace the document located at "path" with the
-    # Hash document "doc"
+    # Create or replace the document located at <tt>path</tt> with the
+    # Hash document <tt>doc</tt>
+    #
     def self.put!(path, doc)
       self.put(path, doc)
     rescue RestClient::RequestFailed

data/spec/couch_design_docs_spec.rb

@@ -1,5 +1,23 @@
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
+describe CouchDesignDocs do
+  it "should be able to load directory/JS files into CouchDB as design docs" do
+    store = mock("Store")
+    Store.stub!(:new).and_return(store)
+
+    dir = mock("Directory")
+    dir.stub!(:to_hash).and_return({ "foo" => "bar" })
+    Directory.stub!(:new).and_return(dir)
+
+    store.
+      should_receive(:load).
+      with({ "foo" => "bar" })
+
+    CouchDesignDocs.upload_dir("uri", "fixtures")
+  end
+end
+
+
 describe Store do
   it "should require a CouchDB URL Root for instantiation" do
     lambda { Store.new }.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eee-c-couch_design_docs
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Chris Strom
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 -07:00
+date: 2009-07-13 00:00:00 -07:00
 default_executable: couch_design_docs
 dependencies: 
 - !ruby/object:Gem::Dependency