chill 5 → 6

data/library/chill.rb

@@ -57,10 +57,35 @@ module ChillDB
     return ChillDB::Document.new(@@database, hash).commit!
   end
   
+  # commit takes an array of documents, and does a bulk commit to the server (one single request)
+  # using a bulk commit is faster than calling commit! on each individual document object
+  def commit! *args
+    list(args.flatten).commit!
+  end
+  
+  def delete! *args
+    list(args.flatten).delete!
+  end
+  
+  # turn an array of documents in to a ChillDB::List
+  def list array = []
+    list = ChillDB::List.from_array array
+    list.database = @@database
+    return list
+  end
+  
+  # all docs!
+  def everything
+    list = ChillDB::List.load(JSON.parse(@@database.http('_all_docs?include_docs=true').get.body))
+    list.database = @@database
+    return list
+  end
+  
+  # open a resource to the server for a particular document, which you can get, post, etc to. For internal use.
   def open *args
     headers = { accept: '*/*' }
     headers.merge! args.pop if args.last.respond_to? :to_hash
-    @@database.http(args.map { |i| URI.escape(i, /[^a-z0-9_.-]/i) }.join('/'), headers)
+    @@database.http(args.map { |item| URI.escape(item, /[^a-z0-9_.-]/i) }.join('/'), headers)
   end
 end
 
@@ -86,6 +111,17 @@ class ChillDB::Database
     return self
   end
   
+  # get info about database
+  def info
+    response = http('').get()
+    IndifferentHash.new.replace(JSON.parse response.body)
+  end
+  
+  # pretty output for debugging things :)
+  def inspect
+    "#<ChillDB::Database: #{info.inspect} >"
+  end
+  
   #def revs_limit; http('_revs_limit').get.body.to_i; end
   #def revs_limit=(v); http('_revs_limit').put(v.to_s); end
   
@@ -204,6 +240,7 @@ class ChillDB::Document < ChillDB::IndifferentHash
   # returns self, or if there's a more specific subclass, a subclassed version of Document
   def load lookup_revision = nil
     url = URI(URI.escape self['_id'])
+    lookup_revision ||= self['_rev']
     url.query = "rev=#{lookup_revision}" if lookup_revision
     response = @database.http(url).get
     return self if response.code == 404 # we can create it later
@@ -215,6 +252,7 @@ class ChillDB::Document < ChillDB::IndifferentHash
   
   # stores updates (or newly existingness) of document to origin database
   def commit!
+    return delete! if self['_deleted'] # just delete if we're marked for deletion
     json = JSON.generate(self)
     response = @database.http(URI.escape self['_id']).put(json);
     raise response.body unless (200..299).include? response.code
@@ -225,11 +263,17 @@ class ChillDB::Document < ChillDB::IndifferentHash
     return self
   end
   
-  # delete this jerk
+  # mark this jerk for deletion! (useful for bulk commit)
+  def delete
+    self.replace('_id'=> self['_id'], '_rev'=> self['_rev'], '_deleted'=> true)
+  end
+  
+  # delete this jerk immediately
   def delete!
     response = @database.http(URI.escape self['_id']).delete()
     response = ChillDB::IndifferentHash.new.replace JSON.parse(response.body)
     raise "Couldn't delete #{self._id}: #{response.error} - #{response.reason}" if response['error']
+    delete # make our contents be deleted
     return response
   end
   
@@ -249,6 +293,11 @@ class ChillDB::Document < ChillDB::IndifferentHash
   def to_param
     self['_id']
   end
+  
+  # loose equality check
+  def == other_doc
+    other.is_a?(self.class) and (self['_id'] == other['_id']) and (self['_rev'] == other['_rev'])
+  end
 end
 
 
@@ -273,6 +322,14 @@ class ChillDB::List < Array
     return new_list
   end
   
+  # to make a list from a simple array (not a couchdb response...)
+  def self.from_array array
+    new_list = self.new
+    new_list.replace array.map do |item|
+      { 'id'=> item['_id'], 'key'=> item['_id'], 'value'=> item, 'doc'=> item }
+    end
+  end
+  
   # store rows nicely in mah belleh
   def rows=(arr)
     self.replace(arr.map { |item|
@@ -342,21 +399,60 @@ class ChillDB::List < Array
     return hash
   end
   
+  # commit takes an array of documents, and does a bulk commit to the server (one single request)
+  # using a bulk commit is faster than calling commit! on each individual document object
+  def commit!
+    commit_documents! convert
+  end
+  alias_method :commit_all!, :commit!
+  
   # remove all the documents in this list from the database
-  def delete_all!
+  def delete!
+    # check all the entries have a _rev - if they don't they cannot be deleted!
     each do |item|
-      raise "Some (all?) items in list do not contain _rev properties in their values" unless item['value']['_rev']
+      rev = item['value']['_rev'] || item['value']['rev'] || item['doc']['_rev']
+      raise "Some (all?) items in list do not contain _rev properties in their values" unless rev
     end
     
-    request = { docs: map { |item|
-      { _id: item['value']['_id'] || item['id'], _rev: item['value']['_rev'], _deleted: true }
-    } }
+    # mark all documents for deletion and commit the order!
+    commit_documents! convert.map { |item| item.delete }
+  end
+  
+  alias_method :delete_all!, :delete!
+  
+  private
+  # get the list, with any non-ChillDB::Document's converted in to those
+  def convert
+    map do |item|
+      document = item['doc'] || item['value']
+      if document.is_a? ChillDB::Document
+        document
+      elsif document.respond_to? :to_hash
+        document['_rev'] ||= item['value']['_rev'] || item['value']['rev'] || item['doc']['_rev']
+        document = ChillDB::Document.new(@database, document.to_hash)
+      else
+        raise "Cannot convert #{document.inspect}"
+      end
+    end
+  end
+  
+  # commit an array of documents to the server
+  def commit_documents! documents
+    response = @database.http('_bulk_docs').post(JSON.generate(docs: documents.to_a))
+    raise response.body unless (200..299).include? response.code
+    json = JSON.parse(response.body)
+    errors = []
     
-    response = JSON.parse @database.http("_bulk_docs").post(request.to_json)
-    raise "Error: #{response['error']} - #{response['reason']}" if response.is_a? Hash and response['error']
+    documents.each_index do |index|
+      self[index]['id'] = json[index]['id']
+      self[index]['value']['rev'] = json[index]['rev'] if json[index]['rev']
+      errors.push [self[index], json[index]] if json[index]['error']
+    end
     
-    return ChillDB::IndifferentHash.new.replace response
+    raise errors unless errors.empty?
+    return self
   end
+  
 end
 
 
@@ -437,3 +533,22 @@ end
 
 
 
+
+class ChillDB::BulkUpdateErrors < StandardError
+  attr_accessor :failures
+  
+  def initialize *args
+    @failures = args.pop
+    super(*args)
+  end
+  
+  def inspect
+    "ChillDB::BulkUpdateError:\n" + @failures.map { |failure|
+      document, error = failure
+      "  '#{document['_id']}': #{error['reason']}"
+    }.join('\n')
+  end
+end
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chill
 version: !ruby/object:Gem::Version
-  version: '5'
+  version: '6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-31 00:00:00.000000000Z
+date: 2012-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70177568025240 !ruby/object:Gem::Requirement
+  requirement: &70131867175840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70177568025240
+  version_requirements: *70131867175840
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70177568024660 !ruby/object:Gem::Requirement
+  requirement: &70131867175340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70177568024660
+  version_requirements: *70131867175340
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70177568024180 !ruby/object:Gem::Requirement
+  requirement: &70131867174860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 2.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *70177568024180
+  version_requirements: *70131867174860
 description: A little library to talk to a couchdb. I made it skinny, because couchdb
   is very simple. I think that's a good thing.
 email: a@creativepony.com
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A tiny plug to hook ruby in to couchdb