jrun-couchrest 0.12.6 → 0.17.1

data/README.md

@@ -59,10 +59,35 @@ Creating and Querying Views:
 
 ## CouchRest::Model
 
-CouchRest::Model is a module designed along the lines of DataMapper::Resource.
-By subclassing, suddenly you get all sorts of powerful sugar, so that working
-with CouchDB in your Rails or Merb app is no harder than working with the
-standard SQL alternatives. See the CouchRest::Model documentation for an
-example article class that illustrates usage.
+CouchRest::Model has been deprecated and replaced by CouchRest::ExtendedDocument
+
+
+## CouchRest::ExtendedDocument
+
+### Callbacks
+
+`CouchRest::ExtendedDocuments` instances have 2 callbacks already defined for you:
+    `create_callback`, `save_callback`, `update_callback` and `destroy_callback`
+    
+In your document inherits from `CouchRest::ExtendedDocument`, define your callback as follows:
+
+    save_callback :before, :generate_slug_from_name
+    
+CouchRest uses a mixin you can find in lib/mixins/callbacks which is extracted from Rails 3, here are some simple usage examples:
+
+    save_callback :before, :before_method
+    save_callback :after,  :after_method, :if => :condition
+    save_callback :around {|r| stuff; yield; stuff }
+    
+Check the mixin or the ExtendedDocument class to see how to implement your own callbacks.
+
+### Casting
+
+Often, you will want to store multiple objects within a document, to be able to retrieve your objects when you load the document, 
+you can define some casting rules. 
+
+    property :casted_attribute, :cast_as => 'WithCastedModelMixin'
+    property :keywords,         :cast_as => ["String"]
+
+If you want to cast an array of instances from a specific Class, use the trick shown above ["ClassName"]
 
-CouchRest::Model will be removed from this package.

data/Rakefile

@@ -23,7 +23,7 @@ spec = Gem::Specification.new do |s|
   s.homepage = "http://github.com/jchris/couchrest"
   s.description = "CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments."
   s.has_rdoc = true
-  s.authors = ["J. Chris Anderson"]
+  s.authors = ["J. Chris Anderson", "Matt Aimonetti"]
   s.files = %w( LICENSE README.md Rakefile THANKS.md ) + 
     Dir["{examples,lib,spec,utils}/**/*"] - 
     Dir["spec/tmp"]
@@ -64,3 +64,6 @@ end
 
 desc "Run the rspec"
 task :default => :spec
+
+
+::Rake::GemPackageTask.new(spec) { |p| p.gem_spec = spec }

data/examples/model/example.rb

@@ -1,31 +1,38 @@
-require 'rubygems'
-require 'couchrest'
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'couchrest')
 
 def show obj
   puts obj.inspect
   puts
 end
 
-CouchRest::Model.default_database = CouchRest.database!('couchrest-model-example')
+SERVER = CouchRest.new
+SERVER.default_database = 'couchrest-extendeddoc-example'
 
-class Author < CouchRest::Model
-  key_accessor :name
+class Author < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  property :name
+  
   def drink_scotch
     puts "... glug type glug ... I'm #{name} ... type glug glug ..."
   end
 end
 
-class Post < CouchRest::Model
-  key_accessor :title, :body, :author
-
-  cast :author, :as => 'Author'
+class Post < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  
+  property :title
+  property :body
+  property :author, :cast_as => 'Author'
 
   timestamps!
 end
 
-class Comment < CouchRest::Model
-  cast :commenter, :as => 'Author'
-
+class Comment < CouchRest::ExtendedDocument
+  use_database SERVER.default_database
+  
+  property :commenter, :cast_as => 'Author'
+  timestamps!
+  
   def post= post
     self["post_id"] = post.id
   end
@@ -33,7 +40,6 @@ class Comment < CouchRest::Model
     Post.get(self['post_id']) if self['post_id']
   end
   
-  timestamps!
 end
 
 puts "Act I: CRUD"

data/lib/couchrest.rb

@@ -13,31 +13,37 @@
 #    limitations under the License.
 
 require "rubygems"
+gem 'json'
 require 'json'
+gem 'rest-client'
 require 'rest_client'
 
 $:.unshift File.dirname(__FILE__) unless
   $:.include?(File.dirname(__FILE__)) ||
   $:.include?(File.expand_path(File.dirname(__FILE__)))
   
+$COUCHREST_DEBUG ||= false
   
 require 'couchrest/monkeypatches'
 
 # = CouchDB, close to the metal
 module CouchRest
-  VERSION = '0.12.6'
+  VERSION    = '0.17.1' unless self.const_defined?("VERSION")
   
   autoload :Server,       'couchrest/core/server'
   autoload :Database,     'couchrest/core/database'
+  autoload :Response,     'couchrest/core/response'
   autoload :Document,     'couchrest/core/document'
-  autoload :Design,     'couchrest/core/design'
+  autoload :Design,       'couchrest/core/design'
   autoload :View,         'couchrest/core/view'
   autoload :Model,        'couchrest/core/model'
   autoload :Pager,        'couchrest/helper/pager'
   autoload :FileManager,  'couchrest/helper/file_manager'
   autoload :Streamer,     'couchrest/helper/streamer'
+  autoload :Upgrade,      'couchrest/helper/upgrade'
   
   autoload :ExtendedDocument,     'couchrest/more/extended_document'
+  autoload :CastedModel,          'couchrest/more/casted_model'
   
   require File.join(File.dirname(__FILE__), 'couchrest', 'mixins')
   
@@ -46,6 +52,23 @@ module CouchRest
   # some helpers for tasks like instantiating a new Database or Server instance.
   class << self
 
+    # extracted from Extlib
+    #
+    # Constantize tries to find a declared constant with the name specified
+    # in the string. It raises a NameError when the name is not in CamelCase
+    # or is not initialized.
+    #
+    # @example
+    # "Module".constantize #=> Module
+    # "Class".constantize #=> Class
+    def constantize(camel_cased_word)
+      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+        raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+      end
+
+      Object.module_eval("::#{$1}", __FILE__, __LINE__)
+    end
+    
     # todo, make this parse the url and instantiate a Server or Database instance
     # depending on the specificity.
     def new(*opts)
@@ -103,18 +126,42 @@ module CouchRest
       cr.database(parsed[:database])
     end
     
-    def put uri, doc = nil
+    def put(uri, doc = nil)
       payload = doc.to_json if doc
-      JSON.parse(RestClient.put(uri, payload))
+      begin
+        JSON.parse(RestClient.put(uri, payload))
+      rescue Exception => e
+        if $COUCHREST_DEBUG == true
+          raise "Error while sending a PUT request #{uri}\npayload: #{payload.inspect}\n#{e}"
+        else
+          raise e
+        end
+      end
     end
 
-    def get uri
-      JSON.parse(RestClient.get(uri), :max_nesting => false)
+    def get(uri)
+      begin
+        JSON.parse(RestClient.get(uri), :max_nesting => false)
+      rescue => e
+        if $COUCHREST_DEBUG == true
+          raise "Error while sending a GET request #{uri}\n: #{e}"
+        else
+          raise e
+        end
+      end
     end
   
     def post uri, doc = nil
       payload = doc.to_json if doc
-      JSON.parse(RestClient.post(uri, payload))
+      begin
+        JSON.parse(RestClient.post(uri, payload))
+      rescue Exception => e
+        if $COUCHREST_DEBUG == true
+          raise "Error while sending a POST request #{uri}\npayload: #{payload.inspect}\n#{e}"
+        else
+          raise e
+        end
+      end
     end
   
     def delete uri
@@ -124,10 +171,6 @@ module CouchRest
     def copy uri, destination
       JSON.parse(RestClient.copy(uri, {'Destination' => destination}))
     end
-    
-    def move uri, destination
-      JSON.parse(RestClient.move(uri, {'Destination' => destination}))
-    end
   
     def paramify_url url, params = {}
       if params && !params.empty?
@@ -140,4 +183,4 @@ module CouchRest
       url
     end
   end # class << self
-end
+end

data/lib/couchrest/core/database.rb

@@ -20,7 +20,7 @@ module CouchRest
       @uri = @root = "#{host}/#{CGI.escape(name)}"
       @streamer = Streamer.new(self)
       @bulk_save_cache = []
-      @bulk_save_cache_limit = 50
+      @bulk_save_cache_limit = 500  # must be smaller than the uuid count
     end
     
     # returns the database's uri
@@ -61,12 +61,15 @@ module CouchRest
     # paramaters as described in http://wiki.apache.org/couchdb/HttpViewApi
     def view(name, params = {}, &block)
       keys = params.delete(:keys)
-      url = CouchRest.paramify_url "#{@uri}/_view/#{name}", params
+      name = name.split('/') # I think this will always be length == 2, but maybe not...
+      dname = name.shift
+      vname = name.join('/')
+      url = CouchRest.paramify_url "#{@uri}/_design/#{dname}/_view/#{vname}", params
       if keys
         CouchRest.post(url, {:keys => keys})
       else
         if block_given?
-          @streamer.view(name, params, &block)
+          @streamer.view("_design/#{dname}/_view/#{vname}", params, &block)
         else
           CouchRest.get url
         end
@@ -74,13 +77,15 @@ module CouchRest
     end
     
     # GET a document from CouchDB, by id. Returns a Ruby Hash.
-    def get(id)
+    def get(id, params = {})
       slug = escape_docid(id)
-      hash = CouchRest.get("#{@uri}/#{slug}")
-      doc = if /^_design/ =~ hash["_id"]
-        Design.new(hash)
+      url = CouchRest.paramify_url("#{@uri}/#{slug}", params)
+      result = CouchRest.get(url)
+      return result unless result.is_a?(Hash)
+      doc = if /^_design/ =~ result["_id"]
+        Design.new(result)
       else
-        Document.new(hash)
+        Document.new(result)
       end
       doc.database = self
       doc
@@ -90,9 +95,7 @@ module CouchRest
     def fetch_attachment(doc, name)
       # slug = escape_docid(docid)        
       # name = CGI.escape(name)
-
       uri = uri_for_attachment(doc, name)
-      
       RestClient.get uri
       # "#{@uri}/#{slug}/#{name}"
     end
@@ -177,6 +180,7 @@ module CouchRest
       end
       CouchRest.post "#{@uri}/_bulk_docs", {:docs => docs}
     end
+    alias :bulk_delete :bulk_save
     
     # DELETE the document from CouchDB that has the given <tt>_id</tt> and
     # <tt>_rev</tt>.
@@ -220,26 +224,6 @@ module CouchRest
       copy_doc(doc, dest)
     end
     
-    # MOVE an existing document to a new id. If the destination id currently exists, a rev must be provided.
-    # <tt>dest</tt> can take one of two forms if overwriting: "id_to_overwrite?rev=revision" or the actual doc
-    # hash with a '_rev' key
-    def move_doc(doc, dest)
-      raise ArgumentError, "_id and _rev are required for moving" unless doc['_id'] && doc['_rev']
-      slug = escape_docid(doc['_id'])        
-      destination = if dest.respond_to?(:has_key?) && dest['_id'] && dest['_rev']
-        "#{dest['_id']}?rev=#{dest['_rev']}"
-      else
-        dest
-      end
-      CouchRest.move "#{@uri}/#{slug}?rev=#{doc['_rev']}", destination
-    end
-    
-    ### DEPRECATION NOTICE
-    def move(doc, dest)
-      puts "CouchRest::Database's move method is being deprecated, please use move_doc instead"
-      move_doc(doc, dest)
-    end
-    
     # Compact the database, removing old document revisions and optimizing space use.
     def compact!
       CouchRest.post "#{@uri}/_compact"
@@ -280,7 +264,7 @@ module CouchRest
 
     private
     
-    def uri_for_attachment doc, name
+    def uri_for_attachment(doc, name)
       if doc.is_a?(String)
         puts "CouchRest::Database#fetch_attachment will eventually require a doc as the first argument, not a doc.id"
         docid = doc

data/lib/couchrest/core/document.rb

@@ -1,33 +1,21 @@
-module CouchRest
-  class Response < Hash
-    def initialize(keys = {})
-      keys.each do |k,v|
-        self[k.to_s] = v
-      end
-    end
-    def []= key, value
-      super(key.to_s, value)
-    end
-    def [] key
-      super(key.to_s)
-    end
-  end
-  
+require 'delegate'
+
+module CouchRest  
   class Document < Response
-    include CouchRest::Mixins::Views
+    include CouchRest::Mixins::Attachments
 
+    # def self.inherited(subklass)
+    #   subklass.send(:class_inheritable_accessor, :database)
+    # end
+    
+    class_inheritable_accessor :database
     attr_accessor :database
-    @@database = nil
     
     # override the CouchRest::Model-wide default_database
     # This is not a thread safe operation, do not change the model
     # database at runtime.
     def self.use_database(db)
-      @@database = db
-    end
-    
-    def self.database
-      @@database
+      self.database = db
     end
     
     def id
@@ -38,6 +26,36 @@ module CouchRest
       self['_rev']
     end
     
+    # returns true if the document has never been saved
+    def new_document?
+      !rev
+    end
+    
+    # Saves the document to the db using create or update. Also runs the :save
+    # callbacks. Sets the <tt>_id</tt> and <tt>_rev</tt> fields based on
+    # CouchDB's response.
+    # If <tt>bulk</tt> is <tt>true</tt> (defaults to false) the document is cached for bulk save.
+    def save(bulk = false)
+      raise ArgumentError, "doc.database required for saving" unless database
+      result = database.save_doc self, bulk
+      result['ok']
+    end
+
+    # Deletes the document from the database. Runs the :delete callbacks.
+    # Removes the <tt>_id</tt> and <tt>_rev</tt> fields, preparing the
+    # document to be saved to a new <tt>_id</tt>.
+    # If <tt>bulk</tt> is <tt>true</tt> (defaults to false) the document won't 
+    # actually be deleted from the db until bulk save.
+    def destroy(bulk = false)
+      raise ArgumentError, "doc.database required to destroy" unless database
+      result = database.delete_doc(self, bulk)
+      if result['ok']
+        self['_rev'] = nil
+        self['_id'] = nil
+      end
+      result['ok']
+    end
+    
     # copies the document to a new id. If the destination id currently exists, a rev must be provided.
     # <tt>dest</tt> can take one of two forms if overwriting: "id_to_overwrite?rev=revision" or the actual doc
     # hash with a '_rev' key
@@ -73,29 +91,6 @@ module CouchRest
       @database || self.class.database
     end
     
-    # saves an attachment directly to couchdb
-    def put_attachment(name, file, options={})
-      raise ArgumentError, "doc must be saved" unless self.rev
-      raise ArgumentError, "doc.database required to put_attachment" unless database
-      result = database.put_attachment(self, name, file, options)
-      self['_rev'] = result['rev']
-      result['ok']
-    end
-    
-    # returns an attachment's data
-    def fetch_attachment(name)
-      raise ArgumentError, "doc must be saved" unless self.rev
-      raise ArgumentError, "doc.database required to put_attachment" unless database
-      database.fetch_attachment(self, name)
-    end
-    
-    # deletes an attachment directly from couchdb
-    def delete_attachment(name)
-      raise ArgumentError, "doc.database required to delete_attachment" unless database
-      result = database.delete_attachment(self, name)
-      self['_rev'] = result['rev']
-      result['ok']
-    end
   end
   
 end