jchris-couchrest 0.9.9 → 0.9.10

data/README.rdoc

@@ -1,8 +1,13 @@
 == CouchRest - CouchDB, close to the metal
 
-CouchRest is based on [CouchDB's couch.js test library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js), which I find to be concise, clear, and well designed. CouchRest lightly wraps CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths to CouchDB's API endpoints so you don't have to.
+CouchRest is based on [CouchDB's couch.js test
+library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js),
+which I find to be concise, clear, and well designed. CouchRest lightly wraps
+CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths
+to CouchDB's API endpoints so you don't have to.
 
-CouchRest's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.
+CouchRest's lighweight is designed to make a simple base for application and
+framework-specific object oriented APIs.
 
 === Easy Install
 
@@ -10,11 +15,16 @@ CouchRest's lighweight is designed to make a simple base for application and fra
 
 === Relax, it's RESTful
 
-The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined web service. 
+The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper.
+REST Client takes all the nastyness of Net::HTTP and gives is a pretty face,
+while still giving you more control than Open-URI. I recommend it anytime
+you’re interfacing with a well-defined web service.
 
 === Running the Specs
 
-The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run `rake`, or `autotest` (requires RSpec and optionally ZenTest for autotest support). 
+The most complete documentation is the spec/ directory. To validate your
+CouchRest install, from the project root directory run `rake`, or `autotest`
+(requires RSpec and optionally ZenTest for autotest support).
 
 === Examples
 
@@ -50,7 +60,8 @@ Creating and Querying Views:
 
 == CouchRest::Model
 
-CouchRest::Model is a module designed along the lines of DataMapper::Resource. By 
-including it in your class, suddenly you get all sorts of magic 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 and example article class that illustrates usage.
+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.

data/Rakefile

@@ -5,7 +5,7 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = "couchrest"
-  s.version = "0.9.9"
+  s.version = "0.9.10"
   s.date = "2008-09-11"
   s.summary = "Lean and RESTful interface to CouchDB."
   s.email = "jchris@grabb.it"

data/lib/couchrest/core/database.rb

@@ -59,6 +59,19 @@ module CouchRest
       RestClient.get "#{@root}/#{doc}/#{name}"
     end
     
+    # PUT an attachment directly to CouchDB
+    def put_attachment doc, name, file, options = {}
+      docid = CGI.escape(doc['_id'])
+      name = CGI.escape(name)
+      uri = if doc['_rev']
+        "#{@root}/#{docid}/#{name}?rev=#{doc['_rev']}"
+      else
+        "#{@root}/#{docid}/#{name}"
+      end
+        
+      JSON.parse(RestClient.put(uri, file, options))
+    end
+    
     # Save a document to CouchDB. This will use the <tt>_id</tt> field from the document as the id for PUT, or request a new UUID from CouchDB, if no <tt>_id</tt> is present on the document. IDs are attached to documents on the client side because POST has the curious property of being automatically retried by proxies in the event of network segmentation and lost responses.
     def save doc
       if doc['_attachments']

data/lib/couchrest/core/model.rb

@@ -1,15 +1,23 @@
+require 'rubygems'
+require 'extlib'
+require 'digest/md5'
+
 # = CouchRest::Model - ORM, the CouchDB way
 module CouchRest
   # = CouchRest::Model - ORM, the CouchDB way
-  # 
-  # CouchRest::Model provides an ORM-like interface for CouchDB documents. It avoids all usage of <tt>method_missing</tt>, and tries to strike a balance between usability and magic. See CouchRest::Model::MagicViews#view_by for documentation about the view-generation system. For the other class methods, inspiried by DataMapper and ActiveRecord, see CouchRest::Model::ClassMethods. The InstanceMethods are pretty basic.
-  # 
+  #  
+  # CouchRest::Model provides an ORM-like interface for CouchDB documents. It
+  # avoids all usage of <tt>method_missing</tt>, and tries to strike a balance
+  # between usability and magic. See CouchRest::Model#view_by for
+  # documentation about the view-generation system.
+  #  
   # ==== Example
-  # 
-  # This is an example class using CouchRest::Model. It is taken from the spec/couchrest/core/model_spec.rb file, which may be even more up to date than this example.
-  # 
-  #   class Article
-  #     include CouchRest::Model
+  #  
+  # This is an example class using CouchRest::Model. It is taken from the
+  # spec/couchrest/core/model_spec.rb file, which may be even more up to date
+  # than this example.
+  #  
+  #   class Article < CouchRest::Model
   #     use_database CouchRest.database!('http://localhost:5984/couchrest-model-test')
   #     unique_id :slug
   #
@@ -19,7 +27,7 @@ module CouchRest
   #     view_by :tags,
   #       :map => 
   #         "function(doc) {
-  #           if (doc.type == 'Article' && doc.tags) {
+  #           if (doc['couchrest-type'] == 'Article' && doc.tags) {
   #             doc.tags.forEach(function(tag){
   #               emit(tag, 1);
   #             });
@@ -38,169 +46,163 @@ module CouchRest
   #
   #     before(:create, :generate_slug_from_title)  
   #     def generate_slug_from_title
-  #       doc['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'')
+  #       self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'')
   #     end
   #   end
-  module Model
-    class << self
-      # this is the CouchRest::Database that model classes will use unless they override it with <tt>use_database</tt>
-      attr_accessor :default_database
-    end
-    
-    # instance methods on the model classes
-    module InstanceMethods
-      attr_accessor :doc
-      
-      def initialize keys = {}
-        self.doc = {}
-        keys.each do |k,v|
-          doc[k.to_s] = v
-        end
-        unless doc['_id'] && doc['_rev']
-          init_doc
-        end
-      end
-      
-      # returns the database used by this model's class
-      def database
-        self.class.database
-      end
-      
-      # alias for doc['_id']
-      def id
-        doc['_id']
-      end
+  class Model < Hash
 
-      # alias for doc['_rev']      
-      def rev
-        doc['_rev']
-      end
-      
-      # returns true if the doc has never been saved
-      def new_record?
-        !doc['_rev']
+    # instantiates the hash by converting all the keys to strings.
+    def initialize keys = {}
+      super()
+      apply_defaults
+      keys.each do |k,v|
+        self[k.to_s] = v
       end
-      
-      # save the doc to the db using create or update
-      def save
-        if new_record?
-          create
-        else
-          update
-        end
+      cast_keys
+      unless self['_id'] && self['_rev']
+        self['couchrest-type'] = self.class.to_s
       end
+    end
 
-      protected
-      
-      def create
-        set_unique_id if respond_to?(:set_unique_id) # hack
-        save_doc
-      end
-      
-      def update
-        save_doc
-      end
-      
-      private
-      
-      def save_doc
-        result = database.save doc
-        if result['ok']
-          doc['_id'] = result['id']
-          doc['_rev'] = result['rev']
-        end
-        result['ok']
-      end
-      
-      def init_doc
-        doc['type'] = self.class.to_s
-      end
-    end # module InstanceMethods
-    
-    # Class methods for models that include CouchRest::Model
-    module ClassMethods
+    # this is the CouchRest::Database that model classes will use unless
+    # they override it with <tt>use_database</tt>
+    cattr_accessor :default_database
+
+    class_inheritable_accessor :casts
+    class_inheritable_accessor :default_obj
+    class_inheritable_accessor :class_database
+    class_inheritable_accessor :generated_design_doc
+    class_inheritable_accessor :design_doc_slug_cache
+    class_inheritable_accessor :design_doc_fresh
+
+    class << self
       # override the CouchRest::Model-wide default_database
       def use_database db
-        @database = db
+        self.class_database = db
       end
-      
+
       # returns the CouchRest::Database instance that this class uses
       def database
-        @database || CouchRest::Model.default_database
+        self.class_database || CouchRest::Model.default_database
       end
-      
+
       # load a document from the database
       def get id
         doc = database.get id
         new(doc)
       end
+
+      def all opts = {}
+        self.generated_design_doc ||= default_design_doc
+        unless design_doc_fresh
+          refresh_design_doc
+        end
+        view_name = "#{design_doc_slug}/all"
+        raw = opts.delete(:raw)
+        view = fetch_view(view_name, opts)
+        process_view_results view, raw
+      end
       
-      # Defines methods for reading and writing from fields in the document. Uses key_writer and key_reader internally.
+      # Cast a field as another class. The class must be happy to have the
+      # field's primitive type as the argument to it's constucture. Classes
+      # which inherit from CouchRest::Model are happy to act as sub-objects
+      # for any fields that are stored in JSON as object (and therefore are
+      # parsed from the JSON as Ruby Hashes).
+      def cast field, opts = {}
+        self.casts ||= {}
+        self.casts[field.to_s] = opts
+      end
+
+      # Defines methods for reading and writing from fields in the document.
+      # Uses key_writer and key_reader internally.
       def key_accessor *keys
         key_writer *keys
         key_reader *keys
       end
-      
-      # For each argument key, define a method <tt>key=</tt> that sets the corresponding field on the CouchDB document.
+
+      # For each argument key, define a method <tt>key=</tt> that sets the
+      # corresponding field on the CouchDB document.
       def key_writer *keys
         keys.each do |method|
           key = method.to_s
           define_method "#{method}=" do |value|
-            doc[key] = value
+            self[key] = value
           end
         end
       end
 
-      # For each argument key, define a method <tt>key</tt> that reads the corresponding field on the CouchDB document.      
+      # For each argument key, define a method <tt>key</tt> that reads the
+      # corresponding field on the CouchDB document.      
       def key_reader *keys
         keys.each do |method|
           key = method.to_s
           define_method method do
-            doc[key]
+            self[key]
           end
         end
       end
+
+      def default
+        self.default_obj
+      end
       
-      # Automatically set <tt>updated_at</tt> and <tt>created_at</tt> fields on the document whenever saving occurs. CouchRest uses a pretty decent time format by default. See Time#to_json
+      def set_default hash
+        self.default_obj = hash
+      end
+
+      # Automatically set <tt>updated_at</tt> and <tt>created_at</tt> fields
+      # on the document whenever saving occurs. CouchRest uses a pretty
+      # decent time format by default. See Time#to_json
       def timestamps!
         before(:create) do
-          doc['updated_at'] = doc['created_at'] = Time.now
+          self['updated_at'] = self['created_at'] = Time.now
         end                  
         before(:update) do   
-          doc['updated_at'] = Time.now
+          self['updated_at'] = Time.now
         end
       end
-      
-      # Name a method that will be called before the document is first saved, which returns a string to be used for the document's <tt>_id</tt>. Because CouchDB enforces a constraint that each id must be unique, this can be used to enforce eg: uniq usernames. Note that this id must be globally unique across all document types which share a database, so if you'd like to scope uniqueness to this class, you should use the class name as part of the unique id.
-      def unique_id method
-        define_method :set_unique_id do
-          doc['_id'] ||= self.send(method)
+
+      # Name a method that will be called before the document is first saved,
+      # which returns a string to be used for the document's <tt>_id</tt>.
+      # Because CouchDB enforces a constraint that each id must be unique,
+      # this can be used to enforce eg: uniq usernames. Note that this id
+      # must be globally unique across all document types which share a
+      # database, so if you'd like to scope uniqueness to this class, you
+      # should use the class name as part of the unique id.
+      def unique_id method = nil, &block
+        if method
+          define_method :set_unique_id do
+            self['_id'] ||= self.send(method)
+          end
+        elsif block
+          define_method :set_unique_id do
+            uniqid = block.call(self)
+            raise ArgumentError, "unique_id block must not return nil" if uniqid.nil?
+            self['_id'] ||= uniqid
+          end
         end
       end
-      
-    end # module ClassMethods
 
-    module MagicViews
-      
-      # Define a CouchDB view. The name of the view will be the concatenation of <tt>by</tt> and the keys joined by <tt>_and_</tt>
-      # 
+      # Define a CouchDB view. The name of the view will be the concatenation
+      # of <tt>by</tt> and the keys joined by <tt>_and_</tt>
+      #  
       # ==== Example views:
-      # 
+      #  
       #   class Post
       #     # view with default options
       #     # query with Post.by_date
       #     view_by :date, :descending => true
-      # 
+      #  
       #     # view with compound sort-keys
       #     # query with Post.by_user_id_and_date
       #     view_by :user_id, :date
-      # 
+      #  
       #     # view with custom map/reduce functions
       #     # query with Post.by_tags :reduce => true
       #     view_by :tags,                                                
       #       :map =>                                                     
       #         "function(doc) {                                          
-      #           if (doc.type == 'Post' && doc.tags) {                   
+      #           if (doc['couchrest-type'] == 'Post' && doc.tags) {                   
       #             doc.tags.forEach(function(tag){                       
       #               emit(doc.tag, 1);                                   
       #             });                                                   
@@ -211,32 +213,46 @@ module CouchRest
       #           return sum(values);                                     
       #         }"                                                        
       #   end
-      # 
-      # <tt>view_by :date</tt> will create a view defined by this Javascript function:
-      # 
+      #  
+      # <tt>view_by :date</tt> will create a view defined by this Javascript
+      # function:
+      #  
       #   function(doc) {
-      #     if (doc.type == 'Post' && doc.date) {
+      #     if (doc['couchrest-type'] == 'Post' && doc.date) {
       #       emit(doc.date, null);
       #     }
       #   }
-      # 
-      # It can be queried by calling <tt>Post.by_date</tt> which accepts all valid options for CouchRest::Database#view. In addition, calling with the <tt>:raw => true</tt> option will return the view rows themselves. By default <tt>Post.by_date</tt> will return the documents included in the generated view.
-      # 
-      # CouchRest::Database#view options can be applied at view definition time as defaults, and they will be curried and used at view query time. Or they can be overridden at query time.
-      # 
-      # Custom views can be queried with <tt>:reduce => true</tt> to return reduce results. The default for custom views is to query with <tt>:reduce => false</tt>.
-      # 
-      # Views are generated (on a per-model basis) lazily on first-access. This means that if you are deploying changes to a view, the views for that model won't be available until generation is complete. This can take some time with large databases. Strategies are in the works.
-      # 
-      # To understand the capabilities of this view system more compeletly, it is recommended that you read the RSpec file at <tt>spec/core/model.rb</tt>.
+      #  
+      # It can be queried by calling <tt>Post.by_date</tt> which accepts all
+      # valid options for CouchRest::Database#view. In addition, calling with
+      # the <tt>:raw => true</tt> option will return the view rows
+      # themselves. By default <tt>Post.by_date</tt> will return the
+      # documents included in the generated view.
+      #  
+      # CouchRest::Database#view options can be applied at view definition
+      # time as defaults, and they will be curried and used at view query
+      # time. Or they can be overridden at query time.
+      #  
+      # Custom views can be queried with <tt>:reduce => true</tt> to return
+      # reduce results. The default for custom views is to query with
+      # <tt>:reduce => false</tt>.
+      #  
+      # Views are generated (on a per-model basis) lazily on first-access.
+      # This means that if you are deploying changes to a view, the views for
+      # that model won't be available until generation is complete. This can
+      # take some time with large databases. Strategies are in the works.
+      #  
+      # To understand the capabilities of this view system more compeletly,
+      # it is recommended that you read the RSpec file at
+      # <tt>spec/core/model.rb</tt>.
       def view_by *keys
         opts = keys.pop if keys.last.is_a?(Hash)
         opts ||= {}
         type = self.to_s
 
         method_name = "by_#{keys.join('_and_')}"
-        @@design_doc ||= default_design_doc
-        
+        self.generated_design_doc ||= default_design_doc
+
         if opts[:map]
           view = {}
           view['map'] = opts.delete(:map)
@@ -244,53 +260,61 @@ module CouchRest
             view['reduce'] = opts.delete(:reduce)
             opts[:reduce] = false
           end
-          @@design_doc['views'][method_name] = view
+          generated_design_doc['views'][method_name] = view
         else
           doc_keys = keys.collect{|k|"doc['#{k}']"}
           key_protection = doc_keys.join(' && ')
           key_emit = doc_keys.length == 1 ? "#{doc_keys.first}" : "[#{doc_keys.join(', ')}]"
           map_function = <<-JAVASCRIPT
           function(doc) {
-            if (doc.type == '#{type}' && #{key_protection}) {
+            if (doc['couchrest-type'] == '#{type}' && #{key_protection}) {
               emit(#{key_emit}, null);
             }
           }
           JAVASCRIPT
-          @@design_doc['views'][method_name] = {
+          generated_design_doc['views'][method_name] = {
             'map' => map_function
           }
         end
-        
-        @@design_doc_fresh = false
-        
+
+        self.design_doc_fresh = false
+
         self.meta_class.instance_eval do
           define_method method_name do |*args|
             query = opts.merge(args[0] || {})
             query[:raw] = true if query[:reduce]
-            unless @@design_doc_fresh
+            unless design_doc_fresh
               refresh_design_doc
             end
             raw = query.delete(:raw)
-            view_name = "#{type}/#{method_name}"
-
+            view_name = "#{design_doc_slug}/#{method_name}"
             view = fetch_view(view_name, query)
-            if raw
-              view
-            else
-              # TODO this can be optimized once the include-docs patch is applied
-              view['rows'].collect{|r|new(database.get(r['id']))}
-            end
+            process_view_results view, raw
           end
         end
       end
-      
+
+      # Fetch the generated design doc. Could raise an error if the generated views have not been queried yet.
+      def design_doc
+        database.get("_design/#{design_doc_slug}")
+      end
+
       private
-      
+
+      def process_view_results view, raw=false
+        if raw
+          view
+        else
+          # TODO this can be optimized once the include-docs patch is applied
+          view['rows'].collect{|r|new(database.get(r['id']))}
+        end
+      end
+
       def fetch_view view_name, opts
         retryable = true
         begin
           database.view(view_name, opts)
-        # the design doc could have been deleted by a rouge process
+          # the design doc could have been deleted by a rouge process
         rescue RestClient::ResourceNotFound => e
           if retryable
             refresh_design_doc
@@ -301,52 +325,145 @@ module CouchRest
           end
         end
       end
-      
-      def design_doc_id
-        "_design/#{self.to_s}"
+
+      def design_doc_slug
+        return design_doc_slug_cache if design_doc_slug_cache && design_doc_fresh
+        funcs = []
+        generated_design_doc['views'].each do |name, view|
+          funcs << "#{name}/#{view['map']}#{view['reduce']}"
+        end
+        md5 = Digest::MD5.hexdigest(funcs.sort.join(''))
+        self.design_doc_slug_cache = "#{self.to_s}-#{md5}"
       end
-      
+
       def default_design_doc
         {
-          "_id" => design_doc_id,
           "language" => "javascript",
-          "views" => {}
+          "views" => {
+            'all' => {
+              'map' => "function(doc) {
+                if (doc['couchrest-type'] == '#{self.to_s}') {
+                  emit(null,null);
+                }
+              }"
+            }
+          }
         }
       end
-      
+
       def refresh_design_doc
-        saved = database.get(design_doc_id) rescue nil
+        did = "_design/#{design_doc_slug}"
+        saved = database.get(did) rescue nil
         if saved
-          @@design_doc['views'].each do |name, view|
+          generated_design_doc['views'].each do |name, view|
             saved['views'][name] = view
           end
           database.save(saved)
         else
-          database.save(@@design_doc)
+          generated_design_doc['_id'] = did
+          database.save(generated_design_doc)
         end
-        @@design_doc_fresh = true
+        self.design_doc_fresh = true
       end
-      
-    end # module MagicViews
-    
-    module Callbacks
-      def self.included(model)
-        model.class_eval <<-EOS, __FILE__, __LINE__
-          include Extlib::Hook
-          register_instance_hooks :save, :create, :update #, :destroy
-        EOS
+
+    end # class << self
+
+    # returns the database used by this model's class
+    def database
+      self.class.database
+    end
+
+    # alias for self['_id']
+    def id
+      self['_id']
+    end
+
+    # alias for self['_rev']      
+    def rev
+      self['_rev']
+    end
+
+    # returns true if the document has never been saved
+    def new_record?
+      !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.
+    def save
+      if new_record?
+        create
+      else
+        update
+      end
+    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>.
+    def destroy
+      result = database.delete self
+      if result['ok']
+        self['_rev'] = nil
+        self['_id'] = nil
+      end
+      result['ok']
+    end
+
+    protected
+
+    # Saves a document for the first time, after running the before(:create)
+    # callbacks, and applying the unique_id.
+    def create
+      set_unique_id if respond_to?(:set_unique_id) # hack
+      save_doc
+    end
+
+    # Saves the document and runs the :update callbacks.
+    def update
+      save_doc
+    end
+
+    private
+
+    def save_doc
+      result = database.save self
+      if result['ok']
+        self['_id'] = result['id']
+        self['_rev'] = result['rev']
+      end
+      result['ok']
+    end
+
+    def apply_defaults
+      if self.class.default
+        self.class.default.each do |k,v|
+          self[k.to_s] = v
+        end
+      end
+    end
+
+    def cast_keys
+      return unless self.class.casts
+      # TODO move the argument checking to the cast method for early crashes
+      self.class.casts.each do |k,v|
+        next unless self[k]
+        target = v[:as]
+        if target.is_a?(Array) && target[0].is_a?(Class)
+          self[k] = self[k].collect do |value|
+            target[0].new(value)
+          end
+        elsif target.is_a?(Class)
+          self[k] = target.new(self[k])
+        else
+          raise ArgumentError, "Call like - cast :field, :as => MyClass - or - :as => [MyClass] if the field is an array."
+        end
       end
-    end # module Callbacks
-    
-    # bookkeeping section
-    
-    # load the code into the model class
-    def self.included(model)
-      model.send(:include, InstanceMethods)
-      model.extend ClassMethods
-      model.extend MagicViews
-      model.send(:include, Callbacks)
     end
-    
-  end # module Model
+
+    include ::Extlib::Hook
+    register_instance_hooks :save, :create, :update, :destroy
+
+  end # class Model
 end # module CouchRest

data/spec/{couchrest_spec.rb → couchrest/core/couchrest_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe CouchRest do
 

data/spec/{database_spec.rb → couchrest/core/database_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe CouchRest::Database do
   before(:each) do
@@ -205,6 +205,22 @@ describe CouchRest::Database do
     
   end
 
+  describe "PUT attachment from file" do
+    before(:each) do
+      filename = File.dirname(__FILE__) + '/../../fixtures/attachments/couchdb.png'
+      @file = File.open(filename)
+    end
+    after(:each) do
+      @file.close
+    end
+    it "should save the attachment to a new doc" do
+      r = @db.put_attachment({'_id' => 'attach-this'}, 'couchdb.png', image = @file.read, {:content_type => 'image/png'})
+      r['ok'].should == true
+      attachment = @db.fetch_attachment("attach-this","couchdb.png")
+      attachment.should == image
+    end
+  end
+
   describe "PUT document with attachment" do
     before(:each) do
       @attach = "<html><head><title>My Doc</title></head><body><p>Has words.</p></body></html>"

data/spec/couchrest/core/model_spec.rb

@@ -1,11 +1,38 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-class Basic
-  include CouchRest::Model
+class Basic < CouchRest::Model
 end
 
-class Article
-  include CouchRest::Model
+class WithTemplate < CouchRest::Model
+  unique_id do |model|
+    model['important-field']
+  end
+  set_default({
+    :preset => 'value',
+    'more-template' => [1,2,3]
+  })
+  key_accessor :preset
+end
+
+class Question < CouchRest::Model
+  key_accessor :q, :a
+end
+
+class Person < CouchRest::Model
+  key_accessor :name
+  def last_name
+    name.last
+  end
+end
+
+class Course < CouchRest::Model
+  key_accessor :title
+  cast :questions, :as => [Question]
+  cast :professor, :as => Person
+  view_by :title
+end
+
+class Article < CouchRest::Model
   use_database CouchRest.database!('http://localhost:5984/couchrest-model-test')
   unique_id :slug
   
@@ -15,7 +42,7 @@ class Article
   view_by :tags,
     :map => 
       "function(doc) {
-        if (doc.type == 'Article' && doc.tags) {
+        if (doc['couchrest-type'] == 'Article' && doc.tags) {
           doc.tags.forEach(function(tag){
             emit(tag, 1);
           });
@@ -34,7 +61,7 @@ class Article
   
   before(:create, :generate_slug_from_title)  
   def generate_slug_from_title
-    doc['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'')
+    self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'')
   end
 end
 
@@ -61,6 +88,7 @@ describe CouchRest::Model do
   describe "a new model" do
     it "should be a new_record" do
       @obj = Basic.new
+      @obj.rev.should be_nil
       @obj.should be_a_new_record
     end
   end
@@ -68,13 +96,13 @@ describe CouchRest::Model do
   describe "a model with key_accessors" do
     it "should allow reading keys" do
       @art = Article.new
-      @art.doc['title'] = 'My Article Title'
+      @art['title'] = 'My Article Title'
       @art.title.should == 'My Article Title'
     end
     it "should allow setting keys" do
       @art = Article.new
       @art.title = 'My Article Title'
-      @art.doc['title'].should == 'My Article Title'
+      @art['title'].should == 'My Article Title'
     end
   end
   
@@ -83,7 +111,7 @@ describe CouchRest::Model do
       @art = Article.new
       t = Time.now
       @art.date = t
-      @art.doc['date'].should == t
+      @art['date'].should == t
     end
     it "should not allow reading keys" do
       @art = Article.new
@@ -96,7 +124,7 @@ describe CouchRest::Model do
   describe "a model with key_readers" do
     it "should allow reading keys" do
       @art = Article.new
-      @art.doc['slug'] = 'my-slug'
+      @art['slug'] = 'my-slug'
       @art.slug.should == 'my-slug'
     end
     it "should not allow setting keys" do
@@ -105,6 +133,15 @@ describe CouchRest::Model do
     end
   end
   
+  describe "a model with template values" do
+    before(:all) do
+      @tmpl = WithTemplate.new
+    end
+    it "should have fields set when new" do
+      @tmpl.preset.should == 'value'
+    end
+  end
+  
   describe "getting a model" do
     before(:all) do
       @art = Article.new(:title => 'All About Getting')
@@ -116,6 +153,68 @@ describe CouchRest::Model do
     end
   end
 
+  describe "getting a model with a subobjects array" do
+    before(:all) do
+      course_doc = {
+        "title" => "Metaphysics 200",
+        "questions" => [
+          {
+            "q" => "Carve the ___ of reality at the ___.",
+            "a" => ["beast","joints"]
+          },{
+            "q" => "Who layed the smack down on Leibniz's Law?",
+            "a" => "Willard Van Orman Quine"
+          }
+        ]
+      }
+      r = Course.database.save course_doc
+      @course = Course.get r['id']
+    end
+    it "should load the course" do
+      @course.title.should == "Metaphysics 200"
+    end
+    it "should instantiate them as such" do
+      @course["questions"][0].a[0].should == "beast"
+    end
+  end
+
+  describe "finding all instances of a model" do
+    before(:all) do
+      WithTemplate.new('important-field' => '1').save
+      WithTemplate.new('important-field' => '2').save
+      WithTemplate.new('important-field' => '3').save
+      WithTemplate.new('important-field' => '4').save
+    end
+    it "should make the design doc" do
+      WithTemplate.all
+      d = WithTemplate.design_doc
+      d['views']['all']['map'].should include('WithTemplate')
+    end
+    it "should find all" do
+      rs = WithTemplate.all 
+      rs.length.should == 4
+    end
+  end
+
+  describe "getting a model with a subobject field" do
+    before(:all) do
+      course_doc = {
+        "title" => "Metaphysics 410",
+        "professor" => {
+          "name" => ["Mark", "Hinchliff"]
+        }
+      }
+      r = Course.database.save course_doc
+      @course = Course.get r['id']
+    end
+    it "should load the course" do
+      @course["professor"]["name"][1].should == "Hinchliff"
+    end
+    it "should instantiate the professor as a person" do
+      @course['professor'].last_name.should == "Hinchliff"
+    end
+  end
+
   describe "saving a model" do
     before(:all) do
       @obj = Basic.new
@@ -129,17 +228,17 @@ describe CouchRest::Model do
     
     it "should be set for resaving" do
       rev = @obj.rev
-      @obj.doc['another-key'] = "some value"
+      @obj['another-key'] = "some value"
       @obj.save
       @obj.rev.should_not == rev
     end
     
     it "should set the id" do
-      @obj.id.should be_an_instance_of String
+      @obj.id.should be_an_instance_of(String)
     end
     
     it "should set the type" do
-      @obj.doc['type'].should == 'Basic'
+      @obj['couchrest-type'].should == 'Basic'
     end
   end
 
@@ -184,6 +283,48 @@ describe CouchRest::Model do
     end
   end
 
+  describe "saving a model with a unique_id lambda" do
+    before(:each) do
+      @templated = WithTemplate.new
+      @old = WithTemplate.get('very-important') rescue nil
+      @old.destroy if @old
+    end
+    
+    it "should require the field" do
+      lambda{@templated.save}.should raise_error
+      @templated['important-field'] = 'very-important'
+      @templated.save.should == true
+    end
+    
+    it "should save with the id" do
+      @templated['important-field'] = 'very-important'
+      @templated.save.should == true
+      t = WithTemplate.get('very-important')
+      t.should == @templated
+    end
+    
+    it "should not change the id on update" do
+      @templated['important-field'] = 'very-important'
+      @templated.save.should == true
+      @templated['important-field'] = 'not-important'
+      @templated.save.should == true
+      t = WithTemplate.get('very-important')
+      t.should == @templated
+    end
+    
+    it "should raise an error when the id is taken" do
+      @templated['important-field'] = 'very-important'
+      @templated.save.should == true
+      lambda{WithTemplate.new('important-field' => 'very-important').save}.should raise_error
+    end
+    
+    it "should set the id" do
+      @templated['important-field'] = 'very-important'
+      @templated.save.should == true
+      @templated.id.should == 'very-important'
+    end
+  end
+
   describe "a model with timestamps" do
     before(:all) do
       @art = Article.new(:title => "Saving this")
@@ -214,7 +355,7 @@ describe CouchRest::Model do
     
     it "should create the design doc" do
       Article.by_date rescue nil
-      doc = Article.database.get("_design/Article")
+      doc = Article.design_doc
       doc['views']['by_date'].should_not be_nil
     end
     
@@ -234,6 +375,23 @@ describe CouchRest::Model do
     end
   end
   
+  describe "another model with a simple view" do
+    before(:all) do
+      Course.database.delete! rescue nil
+      @db = @cr.create_db(TESTDB) rescue nil
+      Course.new(:title => 'aaa').save
+      Course.new(:title => 'bbb').save
+    end
+    it "should make the design doc" do
+      doc = Course.design_doc
+      doc['views']['all']['map'].should include('Course')
+    end
+    it "should get them" do
+      rs = Course.by_title 
+      rs.length.should == 2
+    end
+  end
+  
   describe "a model with a compound key view" do
     before(:all) do
       written_at = Time.now - 24 * 3600 * 7
@@ -249,12 +407,12 @@ describe CouchRest::Model do
     end
     it "should create the design doc" do
       Article.by_user_id_and_date rescue nil
-      doc = Article.database.get("_design/Article")
+      doc = Article.design_doc
       doc['views']['by_date'].should_not be_nil
     end
     it "should sort correctly" do
       articles = Article.by_user_id_and_date
-      articles.collect{|a|a.doc['user_id']}.should == ['aaron', 'aaron', 'quentin', 'quentin']
+      articles.collect{|a|a['user_id']}.should == ['aaron', 'aaron', 'quentin', 'quentin']
       articles[1].title.should == 'not junk'
     end
     it "should be queryable with couchrest options" do
@@ -289,4 +447,43 @@ describe CouchRest::Model do
       view['rows'].find{|r|r['key'] == 'cool'}['value'].should == 3
     end
   end
+
+  describe "adding a view" do
+    before(:each) do
+      Article.by_date
+      @design_docs = Article.database.documents :startkey => "_design/", :endkey => "_design/\u9999"
+    end
+    it "should not create a design doc on view definition" do
+      Article.view_by :created_at
+      newdocs = Article.database.documents :startkey => "_design/", :endkey => "_design/\u9999"
+      newdocs["rows"].length.should == @design_docs["rows"].length
+    end
+    it "should create a new design document on view access" do
+      Article.view_by :created_at
+      Article.by_created_at
+      newdocs = Article.database.documents :startkey => "_design/", :endkey => "_design/\u9999"
+      newdocs["rows"].length.should == @design_docs["rows"].length + 1
+    end
+  end
+
+  describe "destroying an instance" do
+    before(:each) do
+      @obj = Basic.new
+      @obj.save.should == true
+    end
+    it "should return true" do
+      result = @obj.destroy
+      result.should == true
+    end
+    it "should be resavable" do
+      @obj.destroy
+      @obj.rev.should be_nil
+      @obj.id.should be_nil
+      @obj.save.should == true
+    end
+    it "should make it go away" do
+      @obj.destroy
+      lambda{Basic.get(@obj.id)}.should raise_error
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jchris-couchrest
 version: !ruby/object:Gem::Version 
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors: 
 - J. Chris Anderson
@@ -59,6 +59,8 @@ files:
 - bin/couchapp
 - bin/couchdir
 - bin/couchview
+- examples/model
+- examples/model/example.rb
 - examples/word_count
 - examples/word_count/markov
 - examples/word_count/views
@@ -94,12 +96,13 @@ files:
 - spec/couchapp_spec.rb
 - spec/couchrest
 - spec/couchrest/core
+- spec/couchrest/core/couchrest_spec.rb
+- spec/couchrest/core/database_spec.rb
 - spec/couchrest/core/model_spec.rb
-- spec/couchrest_spec.rb
-- spec/database_spec.rb
 - spec/file_manager_spec.rb
 - spec/fixtures
 - spec/fixtures/attachments
+- spec/fixtures/attachments/couchdb.png
 - spec/fixtures/attachments/test.html
 - spec/fixtures/couchapp
 - spec/fixtures/couchapp/attachments
@@ -108,12 +111,6 @@ files:
 - spec/fixtures/couchapp/views/example-map.js
 - spec/fixtures/couchapp/views/example-reduce.js
 - spec/fixtures/couchapp-test
-- spec/fixtures/couchapp-test/my-app
-- spec/fixtures/couchapp-test/my-app/attachments
-- spec/fixtures/couchapp-test/my-app/attachments/index.html
-- spec/fixtures/couchapp-test/my-app/views
-- spec/fixtures/couchapp-test/my-app/views/example-map.js
-- spec/fixtures/couchapp-test/my-app/views/example-reduce.js
 - spec/fixtures/views
 - spec/fixtures/views/lib.js
 - spec/fixtures/views/test_view