couch_docs 1.2.1 → 1.3.0

data/.bnsignore

@@ -0,0 +1,16 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   PROJ.ignore_file = '.gitignore'
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/.gitignore

@@ -1,2 +1,4 @@
-pkg
-couch_docs-*.gem
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in couch_docs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    couch_docs (1.2.2)
+      directory_watcher (~> 1.3.0)
+      json (~> 1.4.0)
+      rest-client (~> 1.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    directory_watcher (1.3.2)
+    json (1.4.6)
+    mime-types (1.16)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  couch_docs!
+  directory_watcher (~> 1.3.0)
+  json (~> 1.4.0)
+  rest-client (~> 1.6.0)
+  rspec (~> 1.3.0)

data/History.txt

@@ -1,3 +1,15 @@
+== 1.3.0 / 2011-01-01
+
+ * Attachment support
+
+   * Attachments for the foo document would be stored in the foo sub-directory (the foo document itself is stored as foo.json).
+
+   * Rudimentary mime-type support.
+
+   * Works with dumping and pushing.
+
+   * Minor bug fixes.
+
 == 1.2.1 / 2010-04-21
 
  * Update README to reflect changes in 1.2.  No code changes.

data/README.rdoc

@@ -1,49 +1,68 @@
-couch_docs
-    by Chris Strom
-    http://github.com/eee-c/couch_docs
-    (used to be couch_design_docs)
+= NAME
 
-== DESCRIPTION:
+couch_docs - Manage CouchDB views and documents from the filesystem.
 
-Manage CouchDB views and documents.
+Author: Chris Strom
 
-== FEATURES/PROBLEMS:
+http://github.com/eee-c/couch_docs
+
+(formerly couch_design_docs)
+
+= DESCRIPTION
+
+I have two primary use cases: uploading fixture data for integration testing and editing CouchDB documents in my favorite editor.  It could also be useful as a cheap back-up mechanism, though it likely would not work well with large datasets (see PROBLEMS/FUTURE).
+
+== Fixture Strategy
+
+Before an integration test, I create a new CouchDB database with a randomly generated name.  I use couch_docs to upload fixture data to that database:
+
+  CouchDocs.put_dir(DB_URL, DIRECTORY)
+
+Then, I allow the test run to proceed normally.  At the end of the run, I teardown the test database.
+
+Since CouchDB database creation / destruction is so cheap, this allows for quite fast integration tests -- even including necessary design documents.
+
+== Editing with Emacs
+
+I much prefer editing JSON documents in Emacs (lesser editors should work) over using the Futon web interface built into CouchDB.  To initiate this, I watch the directory containing the JSON document(s):
+
+ couch-docs push -w localhost:5984/db
+
+The -w option uses directory watcher to watch for any changes on the file system.  When a change occurs, the updated document is loaded to CouchDB immediately. This is very useful for rapid editing/prototyping of documents that are subsequently used in another medium (e.g. for a blog post).
+
+= FEATURES
 
 * Upload JSON documents stored on the filesystem into a CouchDB
   database.
 
-* Map <tt>.js</tt> files stored on the filesystem
-  (e.g. <tt>_design/recipes/count_by_month/map.js</tt>) into CouchDB
-  design documents.
+  * Map <tt>.js</tt> files stored on the filesystem
+    (e.g. <tt>_design/recipes/count_by_month/map.js</tt>) into CouchDB
+    design documents.
 
-  * Support for the <tt>!code</tt> macro from couchapp (useful for
-    DRYing up map/reduce views as well as list/show documents.
+    * Support for the <tt>!code</tt> macro from couchapp (useful for
+      DRYing up map/reduce views as well as list/show documents.
 
 * Dump documents stored in CouchDB to the filesystem.
 
-* Script (couch-docs) to restore / backup CouchDB database.
-
-  * Multiple options including a directory watcher for uploading
-    directory changes
+  * Attachments are stored as real files (not inline, mime64 encoded attributes on the JSON document)
 
-* A progress bar would be helpful.
+  * De-resolution of <tt>!code</tt> macros.
 
-* Unit testing of view javascript would be very nice.
+* Command line script (<tt>couch-docs</tt>) to push / dump CouchDB database.
 
-* Will almost certainly not work for large datasets (>10k documents).
+  * Multiple options including a directory watcher for uploading
+    directory changes
 
-== SYNOPSIS:
+= SYNOPSIS
 
   From the command line:
 
   # For dumping the contents of a CouchDB database to the filesystem
-  couch-docs dump "http://localhost:5984/db" path/to/dump_dir/
+  couch-docs dump http://localhost:5984/db
 
   # For loading documents from the filesystem into CouchDB
-  couch-docs push "http://localhost:5984/db" path/to/dump_dir/
+  couch-docs push http://localhost:5984/db
 
-  The directory is optional for both dump and push (defaults to the
-  current working directory).
 
   In code:
 
@@ -65,18 +84,28 @@ Manage CouchDB views and documents.
 
   # => JSON dump of every document at DB_URL
 
-== REQUIREMENTS:
+= REQUIREMENTS
 
 * CouchDB
 * JSON
 * RestClient
 * DirectoryWatcher
 
-== INSTALL:
+= INSTALL
 
 * sudo gem install couch_docs
 
-== LICENSE:
+= PROBLEMS/FUTURE
+
+* Does not honor CouchDB document revisions.  Instead it deletes previous revisions and uploads an entirely new one.
+
+* A progress bar would be helpful.
+
+* Unit testing of view javascript would be very nice.
+
+* Will almost certainly not work for large datasets (>10k documents).
+
+= LICENSE
 
 (The MIT License)
 

data/Rakefile

@@ -1,39 +1,20 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  begin
-    load 'tasks/setup.rb'
-  rescue LoadError
-    raise RuntimeError, '### please install the "bones" gem ###'
-  end
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-ensure_in_path 'lib'
-require 'couch_docs'
+task :default => :spec
 
-task :default => 'spec:run'
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
-PROJ.name = 'couch_docs'
-PROJ.authors = 'Chris Strom'
-PROJ.email = 'chris@eeecooks.com'
-PROJ.url = 'http://github.com/eee-c/couch_docs'
-PROJ.version = CouchDocs::VERSION
-PROJ.rubyforge.name = 'couch_docs'
-
-PROJ.spec.opts << '--color'
-
-#PROJ.gem.dependencies = %w{json rest-client}
-PROJ.gem.development_dependencies << 'rspec'
-
-PROJ.readme_file = 'README.rdoc'
-
-depend_on 'rest-client', "~> 1.1.0"
-depend_on 'json'
-depend_on 'directory_watcher'
-
-# EOF
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "couch_docs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.1

data/couch_docs.gemspec

@@ -1,48 +1,27 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "couch_docs/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{couch_docs}
-  s.version = "1.2.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Chris Strom"]
-  s.date = %q{2010-04-21}
-  s.default_executable = %q{couch-docs}
+  s.name        = "couch_docs"
+  s.version     = CouchDocs::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Strom"]
+  s.email       = ["chris@eeecooks.com"]
+  s.homepage    = "http://github.com/eee-c/couch_docs"
+  s.summary     = %q{Manage CouchDB views and documents}
   s.description = %q{Manage CouchDB views and documents.}
-  s.email = %q{chris@eeecooks.com}
-  s.executables = ["couch-docs"]
-  s.extra_rdoc_files = ["History.txt", "README.rdoc", "bin/couch-docs"]
-  s.files = [".gitignore", "History.txt", "README.rdoc", "Rakefile", "bin/couch-docs", "couch_docs-1.1.0.gem", "couch_docs-1.1.1.gem", "couch_docs-1.2.0.gem", "couch_docs.gemspec", "fixtures/_design/__lib/foo.js", "fixtures/_design/a/b/c.js", "fixtures/_design/a/b/d.js", "fixtures/_design/x/z.js", "fixtures/bar.json", "fixtures/foo.json", "lib/couch_docs.rb", "lib/couch_docs/command_line.rb", "lib/couch_docs/design_directory.rb", "lib/couch_docs/document_directory.rb", "lib/couch_docs/store.rb", "spec/couch_docs_spec.rb", "spec/spec_helper.rb", "test/test_couch_docs.rb"]
-  s.homepage = %q{http://github.com/eee-c/couch_docs}
-  s.rdoc_options = ["--main", "README.rdoc"]
+
+  s.rubyforge_project = "couch_docs"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{couch_docs}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Manage CouchDB views and documents}
-  s.test_files = ["test/test_couch_docs.rb"]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_development_dependency "rspec", ["~> 1.3.0"]
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rest-client>, ["~> 1.1.0"])
-      s.add_runtime_dependency(%q<json>, [">= 1.2.0"])
-      s.add_runtime_dependency(%q<directory_watcher>, [">= 1.3.1"])
-      s.add_development_dependency(%q<bones>, [">= 2.5.0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<rest-client>, ["~> 1.1.0"])
-      s.add_dependency(%q<json>, [">= 1.2.0"])
-      s.add_dependency(%q<directory_watcher>, [">= 1.3.1"])
-      s.add_dependency(%q<bones>, [">= 2.5.0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rest-client>, ["~> 1.1.0"])
-    s.add_dependency(%q<json>, [">= 1.2.0"])
-    s.add_dependency(%q<directory_watcher>, [">= 1.3.1"])
-    s.add_dependency(%q<bones>, [">= 2.5.0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
+  s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.0"])
+  s.add_runtime_dependency(%q<json>, ["~> 1.4.0"])
+  s.add_runtime_dependency(%q<directory_watcher>, ["~> 1.3.0"])
 end

data/fixtures/_design/a/e.json

@@ -0,0 +1 @@
+[{"one": "2"}]

data/fixtures/_design/j/q.json

@@ -0,0 +1 @@
+["!code foo.js"]

data/fixtures/baz_with_attachments.json

@@ -0,0 +1 @@
+{"baz":"3"}

data/lib/couch_docs/command_line.rb

@@ -1,5 +1,7 @@
 require 'optparse'
 require 'pp'
+
+require 'rubygems'
 require 'directory_watcher'
 
 module CouchDocs

data/lib/couch_docs/design_directory.rb

@@ -28,7 +28,7 @@ module CouchDocs
     # Load
 
     def to_hash
-      Dir["#{couch_view_dir}/**/*.js"].inject({}) do |memo, filename|
+      Dir["#{couch_view_dir}/**/*.{js,json}"].inject({}) do |memo, filename|
         DesignDirectory.
           a_to_hash(expand_file(filename)).
           deep_merge(memo)
@@ -36,16 +36,30 @@ module CouchDocs
     end
 
     def expand_file(filename)
+      if filename =~ /\.js$/
+        name_value_pair = [
+         File.basename(filename, '.js'),
+         read_js_value(filename)
+        ]
+      elsif filename =~ /\.json$/
+        name_value_pair = [
+         File.basename(filename, '.json'),
+         read_json_value(filename)
+        ]
+      end
+
+      name_value_pair[0].gsub!(/%2F/, '/')
+
       File.dirname(filename).
         gsub(/#{couch_view_dir}\/?/, '').
-        split(/\//) +
-      [
-       File.basename(filename, '.js').gsub(/%2F/, '/'),
-       read_value(filename)
-      ]
+        split(/\//) + name_value_pair
+    end
+
+    def read_json_value(filename)
+      JSON.parse(File.new(filename).read)
     end
 
-    def read_value(filename)
+    def read_js_value(filename)
       File.
         readlines(filename).
         map { |line| process_code_macro(line) }.
@@ -75,18 +89,9 @@ module CouchDocs
 
     def save_js(rel_path, key, value)
       if value.is_a? Hash
-        value.each_pair do |k, v|
-          next if k == '_id'
-          self.save_js([rel_path, key].compact.join('/'), k, v)
-
-        end
+        save_js_hash(rel_path, key, value)
       else
-        path = couch_view_dir + '/' + rel_path
-        FileUtils.mkdir_p(path)
-
-        file = File.new("#{path}/#{key.gsub(/\//, '%2F')}.js", "w+")
-        file.write(remove_code_macros(value))
-        file.close
+        save_js_value(rel_path, key, value)
       end
     end
 
@@ -99,5 +104,26 @@ module CouchDocs
         js
       end
     end
+
+    private
+    def save_js_hash(rel_path, id, hash)
+      hash.each_pair do |k, v|
+        next if k == '_id'
+        self.save_js([rel_path, id].compact.join('/'), k, v)
+      end
+    end
+
+    def save_js_value(rel_path, id, value)
+      ext = value.is_a?(String) ? "js" : "json"
+      value = value.is_a?(String) ? remove_code_macros(value) : value.to_json
+
+
+      path = couch_view_dir + '/' + rel_path
+      FileUtils.mkdir_p(path)
+
+      file = File.new("#{path}/#{id.gsub(/\//, '%2F')}.#{ext}", "w+")
+      file.write(value)
+      file.close
+    end
   end
 end

data/lib/couch_docs/document_directory.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module CouchDocs
   class DocumentDirectory
 
@@ -10,16 +12,69 @@ module CouchDocs
 
     def each_document
       Dir["#{couch_doc_dir}/*.json"].each do |filename|
-        yield [ File.basename(filename, '.json'),
-                JSON.parse(File.new(filename).read) ]
+        id = File.basename(filename, '.json')
+        json = JSON.parse(File.new(filename).read)
+
+        if File.directory? "#{couch_doc_dir}/#{id}"
+          json["_attachments"] ||= { }
+          Dir["#{couch_doc_dir}/#{id}/*"].each do |attachment|
+            next unless File.file? attachment
+            attachment_name = File.basename(attachment)
+            json["_attachments"][attachment_name] = file_as_attachment(attachment)
+          end
+        end
 
+        yield [ id, json ]
       end
     end
 
     def store_document(doc)
       file = File.new("#{couch_doc_dir}/#{doc['_id']}.json", "w+")
+      store_attachments(doc['_id'], doc.delete('_attachments'))
       file.write(doc.to_json)
       file.close
     end
+
+    def file_as_attachment(file)
+      type = mime_type(File.extname(file))
+      data = File.read(file)
+
+      attachment =  {
+        "data" => Base64.encode64(data).gsub(/\n/, '')
+      }
+      if type
+        attachment.merge!({"content_type" => type})
+      end
+
+      attachment
+    end
+
+    def store_attachments(id, attachments)
+      return unless attachments
+
+      make_attachment_dir(id)
+      attachments.each do |filename, opts|
+        save_attachment(id, filename, opts['data'])
+      end
+    end
+
+    def make_attachment_dir(id)
+      FileUtils.mkdir_p "#{couch_doc_dir}/#{id}"
+    end
+
+    def save_attachment(id, filename, data)
+      file = File.new "#{couch_doc_dir}/#{id}/#{filename}", "w"
+      file.write Base64.decode64(data)
+      file.close
+    end
+
+    private
+    def mime_type(extension)
+      ({
+         ".gif" => "image/gif",
+         ".jpg" => "image/jpeg",
+         ".png" => "image/png"
+       })[extension]
+    end
   end
 end

data/lib/couch_docs/version.rb

@@ -0,0 +1,3 @@
+module CouchDocs
+  VERSION = "1.3.0"
+end

data/lib/couch_docs.rb

@@ -3,7 +3,6 @@ require 'ostruct'
 module CouchDocs
 
   # :stopdoc:
-  VERSION = '1.2.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc: