couch-quilt 0.4.1 → 0.5.0

data/couch-quilt.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couch-quilt}
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Johannes J\303\266rg Schmidt"]
-  s.date = %q{2010-03-23}
+  s.date = %q{2010-04-02}
   s.default_executable = %q{couchquilt}
   s.description = %q{Access CouchDB JSON documents from filesystem.}
   s.email = %q{schmidt@netzmerk.com}
@@ -26,11 +26,15 @@ Gem::Specification.new do |s|
      "bin/couchquilt",
      "couch-quilt.gemspec",
      "lib/couchquilt.rb",
+     "lib/couchquilt/core_ext/array.rb",
+     "lib/couchquilt/core_ext/hash.rb",
      "lib/couchquilt/couch_client.rb",
+     "lib/couchquilt/database.rb",
      "lib/couchquilt/debugged_fs.rb",
      "lib/couchquilt/fs.rb",
      "lib/couchquilt/mapper.rb",
      "lib/couchquilt/version.rb",
+     "spec/couchquilt/core_ext_spec.rb",
      "spec/couchquilt/fs_spec.rb",
      "spec/couchquilt/mapper_spec.rb",
      "spec/spec_helper.rb"
@@ -44,6 +48,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/spec_helper.rb",
      "spec/couchquilt/fs_spec.rb",
+     "spec/couchquilt/core_ext_spec.rb",
      "spec/couchquilt/mapper_spec.rb"
   ]
 

data/lib/couchquilt.rb

@@ -29,7 +29,10 @@ $:.unshift File.dirname(__FILE__) unless
     $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'couchquilt/mapper'
+require 'couchquilt/core_ext/array'
+require 'couchquilt/core_ext/hash'
 require 'couchquilt/couch_client'
+require 'couchquilt/database'
 require 'couchquilt/fs'
 
 

data/lib/couchquilt/core_ext/array.rb

@@ -0,0 +1,37 @@
+class Array
+  include Couchquilt::Mapper
+
+  def at_path(path)
+    head, *parts = to_parts(path)
+    return self if head.nil?
+    head = head.to_i
+    part = self[head]
+    return part if parts.empty? || !part.respond_to?(:at_path)
+    part.at_path(parts)
+  end
+
+  def update_at_path(path, value)
+    head, *parts = to_parts(path)
+    return if head.nil?
+    head = head.to_i
+    return self[head] = value if parts.empty?
+    self[head] ||= []
+    self[head].update_at_path(parts, value)
+  end
+
+  def delete_at_path(path)
+    head, *parts = to_parts(path)
+    return if head.nil?
+    head = head.to_i
+    return self.delete_at(head) if parts.empty?
+    return unless self[head]
+    self[head].delete_at_path(parts)
+  end
+
+  def to_fs(named_path = true)
+    # using zip for backwards compatibily:
+    # in Ruby 1.9 (and 1.8.7) we could simply use
+    # each_with_index.map { |k,i| ... }
+    named_path ? zip((0..size).to_a).map { |v,i| name_for(i, v) } : self
+  end
+end

data/lib/couchquilt/core_ext/hash.rb

@@ -0,0 +1,43 @@
+class Hash
+  include Couchquilt::Mapper
+
+  def at_path(path)
+    head, *parts = to_parts(path)
+    return self if head.nil?
+    part = self[head]
+    return part if parts.empty? || !part.respond_to?(:at_path)
+    part.at_path(parts)
+  end
+
+  def update_at_path(path, value)
+    head, *parts = to_parts(path)
+    return if head.nil?
+    return self[head] = value if parts.empty?
+    self[head] ||= {}
+    self[head].update_at_path(parts, value)
+  end
+
+  def delete_at_path(path)
+    head, *parts = to_parts(path)
+    return if head.nil?
+    return self.delete(head) if parts.empty?
+    return unless self[head]
+    self[head].delete_at_path(parts)
+  end
+
+  def to_fs(named_path = true)
+    named_path ? keys.map { |k| name_for(k, self[k]) }.sort : keys.sort
+  end
+
+  def map_arrays!
+    each do |key, value|
+      next unless value.is_a?(Hash)
+      if value.keys.all? { |k| k =~ /^\d+$/ }
+        self[key] = value.keys.sort.map { |k| value[k] }
+      else
+        value.map_arrays!
+      end
+    end
+    self
+  end
+end

data/lib/couchquilt/database.rb

@@ -0,0 +1,68 @@
+module Couchquilt
+  module Database
+    ## database queries
+    
+    # does a database, document or design_document exists?
+    def exists?(path)
+      @couch.head key_for(path)
+    end
+
+    # query for all dbs
+    def all_dbs
+      @couch.get("_all_dbs")
+    end
+
+    # query for database info
+    def database_info(database, parts = [])
+      @couch.get(database).at_path(parts)
+    end
+
+    # query for all docs ids
+    def all_doc_ids(database, query_string = nil)
+      path = "#{database}/_all_docs"
+      path << "?#{URI.encode query_string}" if query_string
+      @couch.get(path)["rows"].map { |r| r["id"] }
+    end
+
+    # query for document
+    def document(database, id, parts = [])
+      @couch.get("#{database}/#{id}").at_path(parts)
+    end
+
+    # query for view
+    def view(database, id, parts)
+      a, view_function_name, *rest = parts
+      query = [id.sub("_design/", ""), "_view", view_function_name].join("/")
+      doc = @couch.get("#{database}/_design/#{query}").at_path(rest)
+    end
+
+    # query a function
+    def function_result(database, id, parts)
+      @couch.get key_for(File.join(database, id, *parts))
+    end
+
+    ## document manipulation
+
+    # updating documents
+    def update(database, id, doc)
+      doc.map_arrays!
+      @couch.put("#{database}/#{id}", doc)
+    end
+
+    # create database or document
+    def create(database, id = nil)
+      @couch.put("#{database}/#{id}")
+    end
+
+    # delete a database
+    def delete_database(database)
+      @couch.delete(database)
+    end
+
+    # delete a document
+    def delete_document(database, id)
+      doc = document(database, id)
+      @couch.delete("#{database}/#{id}?rev=#{doc["_rev"]}")
+    end
+  end
+end

data/lib/couchquilt/fs.rb

@@ -4,6 +4,7 @@ require 'uri'
 module Couchquilt
   class FS
     include Mapper
+    include Database
 
     # initializes Quilt FS with the database server name
     def initialize(server_name)
@@ -16,39 +17,35 @@ module Couchquilt
   
       list case named_path(path)
            when :root
-             ["_uuids"] + @couch.get("_all_dbs")
+             ["_uuids"] + all_dbs
            when :uuids
              ["0i.js"]
            when :database
              ["_design"] +
                # database meta data
-               map_json(@couch.get(database)) +
+                database_info(database, id).to_fs +
                # all documents but design documents
-               # Note: we can not use ?startkey="_design/"&endkey="_design0" here,
-               # because that would return no results for databases without design documents
-               @couch.get("#{database}/_all_docs")["rows"].map { |r| r["id"] }.select { |id| id !~ /^_design\// }
+               all_doc_ids(database).select { |id| id !~ /^_design\// }
            when :_design
-             query = URI.encode('startkey="_design"&endkey="_design0"')
              # all design documents
-             @couch.get("#{database}/_all_docs?#{query}")["rows"].map { |r| r["id"].sub("_design/", "") }
+             all_doc_ids(database, 'startkey="_design"&endkey="_design0"').map { |id| id.sub("_design/", "") }
            when :_show
-             (@couch.get("#{database}/#{id}")["shows"] || {}).keys
+             document(database, id, "shows").to_fs(false)
            when :_list
-             (@couch.get("#{database}/#{id}")["lists"] || {}).keys
+             document(database, id, "lists").to_fs(false)
            when :_view
-             (@couch.get("#{database}/#{id}")["views"] || {}).keys
+             document(database, id, "views").to_fs(false)
            when :list_function
-             (@couch.get("#{database}/#{id}")["views"] || {}).keys.map { |name| "#{name}.html" }
+             document(database, id, "views").to_fs(false).map { |name| "#{name}.html" }
            when :show_function
-             query = URI.encode('startkey="_design0"')
-             @couch.get("#{database}/_all_docs?#{query}")["rows"].map { |r| "#{r["id"]}.html" }
+             all_doc_ids(database, 'startkey="_design0"').map { |id| "#{id}.html" }
            when :view_function, :view_function_result
-             map_json(get_view_result_part(database, id, parts))
+             view(database, id, parts).to_fs
            when :design_document
              ["_list", "_show", "_view"] +
-               map_json(get_document_part(database, id))
+               document(database, id).to_fs
            else
-             map_json(get_document_part(database, id, parts))
+             document(database, id, parts).to_fs
            end
     end
   
@@ -58,21 +55,21 @@ module Couchquilt
   
       case named_path(path)
       when :database, :document, :design_document
-        @couch.head(path)
+        exists?(path)
       when :view_function_result
-        doc = get_view_result_part(database, id, parts)
+        doc = view(database, id, parts)
         # arrays and hashes are mapped into directories
         doc.is_a?(Hash) || doc.is_a?(Array)
       when :database_info, :show_function_result, :list_function_result, :uuid
         false
-      when nil
+      when :document_part
         # look into document
-        doc = get_document_part(database, id, parts)
+        doc = document(database, id, parts)
         # arrays and hashes are mapped into directories
         doc.is_a?(Hash) || doc.is_a?(Array)
       else
         # all other special paths are directories by now
-        # TODO: thats not so good.
+        # TODO: thats not very good.
         true
       end
     end
@@ -85,11 +82,11 @@ module Couchquilt
       when :database_info, :show_function_result, :list_function_result, :uuid
         true
       when :view_function_result
-        # Every javascript or HTML is file, based on extension
+        # Every javascript or HTML is a file, based on extension
         [".js", ".html"].include?(File.extname(path))
-      when nil
+      when :document_part
         # look into document
-        doc = get_document_part(database, id, parts)
+        doc = document(database, id, parts)
         # only arrays and hashes are mapped into directories
         !doc.nil? && !(doc.is_a?(Hash) || doc.is_a?(Array))
       else
@@ -103,19 +100,15 @@ module Couchquilt
   
       content case named_path(path)
               when :database_info
-                @couch.get(database)[key_for(id)]
-              when :show_function_result
-                parts.shift
-                @couch.get(key_for(File.join(database, id, "_show", *parts)))
-              when :list_function_result
-                parts.shift
-                @couch.get(key_for(File.join(database, id, "_list", *parts)))
+                database_info(database, id)
+              when :show_function_result, :list_function_result
+                function_result(database, id, parts)
               when :view_function_result
-                get_view_result_part(database, id, parts)
+                view(database, id, parts)
               when :uuid
-                get_document_part(database, id, ["uuids"])
+                document(database, id, "uuids")
               else
-                get_document_part(database, id, parts)
+                document(database, id, parts)
               end
     end
   
@@ -139,11 +132,11 @@ module Couchquilt
       str.strip!
       database, id, *parts = extract_parts(path)
       # fetch document
-      doc = @couch.get("#{database}/#{id}")
+      doc = document(database, id)
       # update the value that the file at path holds
-      map_fs(doc, parts, str)
+      doc.update_at_path(parts, str)
       # save document
-      @couch.put("#{database}/#{id}", doc)
+      update(database, id, doc)
     end
   
     # can I delete path?
@@ -164,11 +157,11 @@ module Couchquilt
       database, id, *parts = extract_parts(path)
   
       # fetch document
-      doc = @couch.get("#{database}/#{id}")
+      doc = document(database, id)
       # remove object
-      map_fs(doc, parts, nil)
+      doc.delete_at_path(parts)
       # save document
-      @couch.put("#{database}/#{id}", doc)
+      update(database, id, doc)
     end
   
     # can I make a directory at path?
@@ -180,9 +173,9 @@ module Couchquilt
         false
       when :database, :document, :design_document
         # can create database or document unless exists
-        !@couch.head(path)
+        !exists?(path)
       else
-        !get_document_part(database, id, parts)
+        !document(database, id, parts)
       end
     end
   
@@ -193,16 +186,16 @@ module Couchquilt
   
       case named_path(path)
       when :database
-        @couch.put(database)
+        create(database)
       when :document, :design_document
-        @couch.put("#{database}/#{id}")
+        create(database, id)
       else
         # fetch document
-        doc = @couch.get("#{database}/#{id}")
+        doc = document(database, id)
         # insert empty object
-        map_fs(doc, parts)
+        doc.update_at_path(parts, {})
         # save document
-        @couch.put("#{database}/#{id}", doc)
+        update(database, id, doc)
       end
     end
   
@@ -214,7 +207,7 @@ module Couchquilt
       when :root, :_design, :_list, :list_function, :_show, :show_function, :_view, :view_function, :view_function_result, :database, :document, :design_document
         false
       else
-        get_document_part(database, id, parts).empty? rescue nil
+        document(database, id, parts).empty? rescue false
       end
     end
   
@@ -224,11 +217,11 @@ module Couchquilt
       database, id, *parts = extract_parts(path)
   
       # fetch document
-      doc = @couch.get("#{database}/#{id}")
+      doc = document(database, id)
       # remove object
-      map_fs(doc, parts, nil)
+      doc.delete_at_path(parts)
       # save document
-      @couch.put("#{database}/#{id}", doc)
+      update(database, id, doc)
     end
   
     # switch to delete a database or document
@@ -237,10 +230,9 @@ module Couchquilt
   
       case named_path(path)
       when :switch_delete_database
-        @couch.delete(database)
+        delete_database(database)
       when :switch_delete_document
-        doc = @couch.get("#{database}/#{id}")
-        @couch.delete("#{database}/#{id}?rev=#{doc["_rev"]}")
+        delete_document(database, id)
       end
     end
   
@@ -315,37 +307,13 @@ module Couchquilt
         # /database_id/document_id/object
         # /database_id/_design/design_document_id
         # /database_id/_design/design_document_id/object
-        nil
+        :document_part
       end
     end
-  
-    # fetch part of document
-    def get_document_part(database, id, parts = [])
-      doc = @couch.get("#{database}/#{id}")
-      parts.map! { |p| key_for p }
-      get_part(doc, parts)
-    end
-  
-    # get view result, or a part of that document.
-    def get_view_result_part(database, id, parts = [])
-      a, view_function_name, *rest = parts
-      view = [id.sub("_design/", ""), "_view", view_function_name].join("/")
-      doc = @couch.get("#{database}/_design/#{view}")
-      rest.map! { |p| key_for p }
-      get_part(doc, rest)
-    end
-  
-    # get a part of the document
-    # eg: get_part({ :a => { :b => :c}}, [:a, :b]) #=> :c
-    def get_part(doc, keys = [])
-      return if doc.nil?
-      doc = doc.dup
-      keys.each do |key|
-        doc = doc[key]
-      end
-      doc
-    end
-  
+
+
+    ## list and content helper
+
     # escapes the value for using as filename
     def list(array)
       return [] if array.nil?