jrun-couchrest 0.2.1.1 → 0.12.6

data/README.md

@@ -59,35 +59,10 @@ Creating and Querying Views:
 
 ## CouchRest::Model
 
-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 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 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", "Matt Aimonetti"]
+  s.authors = ["J. Chris Anderson"]
   s.files = %w( LICENSE README.md Rakefile THANKS.md ) + 
     Dir["{examples,lib,spec,utils}/**/*"] - 
     Dir["spec/tmp"]
@@ -64,6 +64,3 @@ end
 
 desc "Run the rspec"
 task :default => :spec
-
-
-::Rake::GemPackageTask.new(spec) { |p| p.gem_spec = spec }

data/examples/model/example.rb

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

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 = 500  # must be smaller than the uuid count
+      @bulk_save_cache_limit = 50
     end
     
     # returns the database's uri
@@ -61,15 +61,12 @@ module CouchRest
     # paramaters as described in http://wiki.apache.org/couchdb/HttpViewApi
     def view(name, params = {}, &block)
       keys = params.delete(:keys)
-      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
+      url = CouchRest.paramify_url "#{@uri}/_view/#{name}", params
       if keys
         CouchRest.post(url, {:keys => keys})
       else
         if block_given?
-          @streamer.view("_design/#{dname}/_view/#{vname}", params, &block)
+          @streamer.view(name, params, &block)
         else
           CouchRest.get url
         end
@@ -93,7 +90,9 @@ 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
@@ -178,7 +177,6 @@ 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>.
@@ -282,7 +280,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,21 +1,33 @@
-require 'delegate'
-
-module CouchRest  
+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
+  
   class Document < Response
-    include CouchRest::Mixins::Attachments
+    include CouchRest::Mixins::Views
 
-    # 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)
-      self.database = db
+      @@database = db
+    end
+    
+    def self.database
+      @@database
     end
     
     def id
@@ -26,36 +38,6 @@ 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
@@ -91,6 +73,29 @@ 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