eee-c-couch_design_docs 1.0.2 → 1.1.0

data/History.txt

@@ -1,3 +1,17 @@
+== 1.1.0 / 2009-07-31
+
+* Add the ability to upload "normal" documents in addition to design
+  documents.
+  * <tt>CouchDesignDocs::upload_dir</tt> is aliased as
+    <tt>CouchDesignDocs::put_dir</tt> and is DEPRECATED.
+  * <tt>CouchDesignDocs::put_dir</tt> now puts both design documents
+    and "normal" documents onto the CouchDB database.
+  * <tt>CouchDesignDocs::put_design_dir</tt> has been added to put
+    design documents
+  * <tt>CouchDesignDocs::put_document_dir</tt> has been added to put
+    "normal" documents
+
+
 == 1.0.2 / 2009-07-13
 
 * Round out the API so that it is possible to load an entire directory

data/README.txt

@@ -4,24 +4,30 @@ couch_design_docs
 
 == DESCRIPTION:
 
-Manage CouchDB views.
+Manage CouchDB views and documents.
 
 == FEATURES/PROBLEMS:
 
-* Allows you to store your CouchDB design documents on the file system
-  with <tt>.js</tt> extensions.
+* Store your CouchDB documents on the filesystem for on-demand
+  upload.  Design documents are kept in a <tt>_design</tt>
+  sub-directory, with <tt>.js</tt> extensions.  Normal documents are
+  stored with a <tt>.json</tt> extension.
 
 == SYNOPSIS:
 
   DB_URL = "http://localhost:5984/db"
-  DIRECTORY = "/repos/db/coudb/_design"
+  DIRECTORY = "/repos/db/couchdb/"
 
-  # /repos/db/coudb/_design/lucene/transform.js
+  # /repos/db/couchdb/_design/lucene/transform.js
+  # /repos/db/couchdb/foo.json
 
-  CouchDesignDocs.upload_dir(DB_URL, DIRECTORY)
+  CouchDesignDocs.put_dir(DB_URL, DIRECTORY)
 
   # => lucene design document with a "transform" function containing
   #    the contents of transform.js
+  #     - AND -
+  #    a document named "foo" with the JSON contents from the foo.json
+  #    file
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -27,6 +27,9 @@ PROJ.rubyforge.name = 'couch_design_docs'
 
 PROJ.spec.opts << '--color'
 
-PROJ.gem.dependencies = %w{json jchris-couchrest}
+PROJ.gem.dependencies = %w{json rest-client}
+
+depend_on 'rest-client'
+depend_on 'json'
 
 # EOF

data/couch_design_docs.gemspec

@@ -2,24 +2,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couch_design_docs}
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Strom"]
-  s.date = %q{2009-07-13}
+  s.date = %q{2009-07-31}
   s.default_executable = %q{couch_design_docs}
-  s.description = %q{Manage CouchDB views.}
+  s.description = %q{Manage CouchDB views and documents.}
   s.email = %q{chris@eeecooks.com}
   s.executables = ["couch_design_docs"]
   s.extra_rdoc_files = ["History.txt", "README.txt", "bin/couch_design_docs"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/couch_design_docs", "couch_design_docs.gemspec", "fixtures/a/b/c.js", "fixtures/a/b/d.js", "lib/couch_design_docs.rb", "lib/couch_design_docs/directory.rb", "lib/couch_design_docs/store.rb", "spec/couch_design_docs_spec.rb", "spec/spec_helper.rb", "test/test_couch_design_docs.rb"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/couch_design_docs", "couch_design_docs.gemspec", "fixtures/_design/a/b/c.js", "fixtures/_design/a/b/d.js", "fixtures/bar.json", "fixtures/foo.json", "lib/couch_design_docs.rb", "lib/couch_design_docs/design_directory.rb", "lib/couch_design_docs/document_directory.rb", "lib/couch_design_docs/store.rb", "spec/couch_design_docs_spec.rb", "spec/spec_helper.rb", "test/test_couch_design_docs.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/eee-c/couch_design_docs}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{couch_design_docs}
   s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Manage CouchDB views}
+  s.summary = %q{Manage CouchDB views and documents}
   s.test_files = ["test/test_couch_design_docs.rb"]
 
   if s.respond_to? :specification_version then
@@ -28,16 +28,22 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<jchris-couchrest>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0.9.2"])
+      s.add_runtime_dependency(%q<json>, [">= 1.1.3"])
       s.add_development_dependency(%q<bones>, [">= 2.5.1"])
     else
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<jchris-couchrest>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0.9.2"])
+      s.add_dependency(%q<json>, [">= 1.1.3"])
       s.add_dependency(%q<bones>, [">= 2.5.1"])
     end
   else
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<jchris-couchrest>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0.9.2"])
+    s.add_dependency(%q<json>, [">= 1.1.3"])
     s.add_dependency(%q<bones>, [">= 2.5.1"])
   end
 end

data/fixtures/bar.json

@@ -0,0 +1 @@
+{"bar":"2"}

data/fixtures/foo.json

@@ -0,0 +1 @@
+{"foo":"1"}

data/lib/couch_design_docs.rb

@@ -1,9 +1,7 @@
-require 'pp'
-
 module CouchDesignDocs
 
   # :stopdoc:
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
@@ -18,12 +16,37 @@ module CouchDesignDocs
   # directory, <tt>dir</tt> containing design documents, creates
   # design documents in the CouchDB database
   #
+  def self.put_dir(db_uri, dir)
+    self.put_design_dir(db_uri, "#{dir}/_design")
+    self.put_document_dir(db_uri, dir)
+  end
+
+  # Alias for <tt>put_dir</tt>
   def self.upload_dir(db_uri, dir)
+    self.put_dir(db_uri, dir)
+  end
+
+  # Upload design documents from <tt>dir</tt> to the CouchDB database
+  # located at <tt>db_uri</tt>
+  #
+  def self.put_design_dir(db_uri, dir)
     store = Store.new(db_uri)
-    dir = Directory.new(dir)
-    store.load(dir.to_hash)
+    dir = DesignDirectory.new(dir)
+    store.put_design_documents(dir.to_hash)
   end
 
+  # Upload documents from <tt>dir</tt> to the CouchDB database
+  # located at <tt>db_uri</tt>
+  #
+  def self.put_document_dir(db_uri, dir)
+    store = Store.new(db_uri)
+    dir = DocumentDirectory.new(dir)
+    dir.each_document do |name, contents|
+      Store.put!("#{db_uri}/#{name}", contents)
+    end
+  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/{directory.rb → design_directory.rb}

@@ -1,5 +1,3 @@
-require 'pp'
-
 class Hash
   def deep_merge(other)
     self.merge(other) do |key, oldval, newval|
@@ -9,7 +7,7 @@ class Hash
 end
 
 module CouchDesignDocs
-  class Directory
+  class DesignDirectory
 
     attr_accessor :couch_view_dir
 
@@ -29,7 +27,7 @@ module CouchDesignDocs
 
     def to_hash
       Dir["#{couch_view_dir}/**/*.js"].inject({}) do |memo, filename|
-        Directory.
+        DesignDirectory.
           a_to_hash(expand_file(filename)).
           deep_merge(memo)
       end

data/lib/couch_design_docs/document_directory.rb

@@ -0,0 +1,19 @@
+module CouchDesignDocs
+  class DocumentDirectory
+
+    attr_accessor :couch_doc_dir
+
+    def initialize(path)
+      Dir.new(path)
+      @couch_doc_dir = path
+    end
+
+    def each_document
+      Dir["#{couch_doc_dir}/*.json"].each do |filename|
+        yield [ File.basename(filename, '.json'),
+                JSON.parse(File.new(filename).read) ]
+
+      end
+    end
+  end
+end

data/lib/couch_design_docs/store.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'restclient'
 require 'json'
 
@@ -12,11 +13,11 @@ module CouchDesignDocs
       @url = url
     end
 
-    # Loads all supplied designed documents in the current store.
+    # Loads all supplied design 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)
+    def put_design_documents(h)
       h.each_pair do |document_name, doc|
         Store.put!("#{url}/_design/#{document_name}", doc)
       end

data/spec/couch_design_docs_spec.rb

@@ -1,19 +1,49 @@
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
 describe CouchDesignDocs do
+  it "should be able to load design and normal documents" do
+    CouchDesignDocs.
+      should_receive(:put_design_dir).
+      with("uri", "fixtures/_design")
+
+    CouchDesignDocs.
+      should_receive(:put_document_dir).
+      with("uri", "fixtures")
+
+    CouchDesignDocs.put_dir("uri", "fixtures")
+  end
+
   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 = mock("Design Directory")
     dir.stub!(:to_hash).and_return({ "foo" => "bar" })
-    Directory.stub!(:new).and_return(dir)
+    DesignDirectory.stub!(:new).and_return(dir)
 
     store.
-      should_receive(:load).
+      should_receive(:put_design_documents).
       with({ "foo" => "bar" })
 
-    CouchDesignDocs.upload_dir("uri", "fixtures")
+    CouchDesignDocs.put_design_dir("uri", "fixtures")
+  end
+
+  it "should be able to load documents into CouchDB" do
+    store = mock("Store")
+    Store.stub!(:new).and_return(store)
+
+    dir = mock("Document Directory")
+    dir.
+      stub!(:each_document).
+      and_yield('foo', {"foo" => "1"})
+
+    DocumentDirectory.stub!(:new).and_return(dir)
+
+    Store.
+      should_receive(:put!).
+      with('uri/foo', {"foo" => "1"})
+
+    CouchDesignDocs.put_document_dir("uri", "fixtures")
   end
 end
 
@@ -78,7 +108,7 @@ describe Store do
         with("uri/_design/a",
              '{"b":{"c":"function(doc) { return true; }"}}',
              :content_type => 'application/json')
-      @it.load(@hash)
+      @it.put_design_documents(@hash)
     end
 
     it "should be able to retrieve an existing document" do
@@ -101,20 +131,49 @@ describe Store do
   end
 end
 
-describe Directory do
+describe DocumentDirectory do
+  it "should require a root directory for instantiation" do
+    lambda { DocumentDirectory.new }.
+      should raise_error
+
+    lambda { DocumentDirectory.new("foo") }.
+      should raise_error
+
+    lambda { DocumentDirectory.new("fixtures")}.
+      should_not raise_error
+  end
+
+  context "a valid directory" do
+    before(:each) do
+      @it = DocumentDirectory.new("fixtures")
+    end
+
+    it "should be able to iterate over the documents" do
+      everything = []
+      @it.each_document do |name, contents|
+        everything << [name, contents]
+      end
+      everything.
+        should == [['bar', {"bar" => "2"}],
+                   ['foo', {"foo" => "1"}]]
+    end
+  end
+end
+
+describe DesignDirectory do
   it "should require a root directory for instantiation" do
-    lambda { Directory.new }.
+    lambda { DesignDirectory.new }.
       should raise_error
 
-    lambda { Directory.new("foo") }.
+    lambda { DesignDirectory.new("foo") }.
       should raise_error
 
-    lambda { Directory.new("fixtures")}.
+    lambda { DesignDirectory.new("fixtures/_design")}.
       should_not raise_error
   end
 
   it "should convert arrays into deep hashes" do
-    Directory.
+    DesignDirectory.
       a_to_hash(%w{a b c d}).
       should == {
       'a' => {
@@ -127,11 +186,11 @@ describe Directory do
 
   context "a valid directory" do
     before(:each) do
-      @it = Directory.new("fixtures")
+      @it = DesignDirectory.new("fixtures/_design")
     end
 
     it "should list dirs, basename and contents of a file" do
-      @it.expand_file("fixtures/a/b/c.js").
+      @it.expand_file("fixtures/_design/a/b/c.js").
         should == ['a', 'b', 'c', 'function(doc) { return true; }']
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eee-c-couch_design_docs
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Chris Strom
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 -07:00
+date: 2009-07-31 00:00:00 -07:00
 default_executable: couch_design_docs
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: jchris-couchrest
+  name: rest-client
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -32,6 +32,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
 - !ruby/object:Gem::Dependency 
   name: bones
   type: :development
@@ -42,7 +62,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.5.1
     version: 
-description: Manage CouchDB views.
+description: Manage CouchDB views and documents.
 email: chris@eeecooks.com
 executables: 
 - couch_design_docs
@@ -58,16 +78,20 @@ files:
 - Rakefile
 - bin/couch_design_docs
 - couch_design_docs.gemspec
-- fixtures/a/b/c.js
-- fixtures/a/b/d.js
+- fixtures/_design/a/b/c.js
+- fixtures/_design/a/b/d.js
+- fixtures/bar.json
+- fixtures/foo.json
 - lib/couch_design_docs.rb
-- lib/couch_design_docs/directory.rb
+- lib/couch_design_docs/design_directory.rb
+- lib/couch_design_docs/document_directory.rb
 - lib/couch_design_docs/store.rb
 - spec/couch_design_docs_spec.rb
 - spec/spec_helper.rb
 - test/test_couch_design_docs.rb
 has_rdoc: true
 homepage: http://github.com/eee-c/couch_design_docs
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -89,9 +113,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: couch_design_docs
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
-summary: Manage CouchDB views
+summary: Manage CouchDB views and documents
 test_files: 
 - test/test_couch_design_docs.rb