couchrest 0.28 → 0.30

data/README.md

@@ -93,3 +93,13 @@ you can define some casting rules.
 
 If you want to cast an array of instances from a specific Class, use the trick shown above ["ClassName"]
 
+### Pagination
+
+Pagination is available in any ExtendedDocument classes. Here are some usage examples:
+
+    articles = Article.by_date :key => Date.today
+    articles.paginate(:page => 1, :per_page => 3)
+        
+
+    Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+      :per_page => 3, :page => 2, :descending => true, :key => Date.today, :include_docs => true)

data/Rakefile

@@ -24,7 +24,7 @@ spec = Gem::Specification.new do |s|
   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.files = %w( LICENSE README.md Rakefile THANKS.md ) + 
+  s.files = %w( LICENSE README.md Rakefile THANKS.md history.txt) + 
     Dir["{examples,lib,spec,utils}/**/*"] - 
     Dir["spec/tmp"]
   s.extra_rdoc_files = %w( README.md LICENSE THANKS.md )

data/history.txt

@@ -0,0 +1,19 @@
+== 0.30
+ 
+* Major enhancements
+ 
+  * Added support for pagination (John Wood)
+  * Improved performance when initializing documents with timestamps (Matt Aimonetti)
+ 
+* Minor enhancements
+ 
+  * Extended the API to retrieve an attachment URI (Matt Aimonetti)
+  * Bug fix: default value should be able to be set as false (Alexander Uvarov)
+  * Bug fix: validates_is_numeric should be able to properly validate a Float instance (Rob Kaufman)
+  * Bug fix: fixed the Timeout implementation (Seth Falcon)
+  
+  
+---
+
+Unfortunately, before 0.30 we did not keep a track of the modifications made to CouchRest.
+You can see the full commit history on GitHub: http://github.com/mattetti/couchrest/commits/master/

data/lib/couchrest.rb

@@ -28,7 +28,7 @@ require 'couchrest/monkeypatches'
 
 # = CouchDB, close to the metal
 module CouchRest
-  VERSION    = '0.28' unless self.const_defined?("VERSION")
+  VERSION    = '0.30' unless self.const_defined?("VERSION")
   
   autoload :Server,       'couchrest/core/server'
   autoload :Database,     'couchrest/core/database'

data/lib/couchrest/core/database.rb

@@ -17,7 +17,8 @@ module CouchRest
       @name = name
       @server = server
       @host = server.uri
-      @uri = @root = "#{host}/#{name.gsub('/','%2F')}"
+      @uri  = "/#{name.gsub('/','%2F')}"
+      @root = host + uri
       @streamer = Streamer.new(self)
       @bulk_save_cache = []
       @bulk_save_cache_limit = 500  # must be smaller than the uuid count
@@ -25,18 +26,18 @@ module CouchRest
     
     # returns the database's uri
     def to_s
-      @uri
+      @root
     end
     
     # GET the database info from CouchDB
     def info
-      CouchRest.get @uri
+      CouchRest.get @root
     end
     
     # Query the <tt>_all_docs</tt> view. Accepts all the same arguments as view.
     def documents(params = {})
       keys = params.delete(:keys)
-      url = CouchRest.paramify_url "#{@uri}/_all_docs", params
+      url = CouchRest.paramify_url "#{@root}/_all_docs", params
       if keys
         CouchRest.post(url, {:keys => keys})
       else
@@ -56,7 +57,7 @@ module CouchRest
     def slow_view(funcs, params = {})
       keys = params.delete(:keys)
       funcs = funcs.merge({:keys => keys}) if keys
-      url = CouchRest.paramify_url "#{@uri}/_temp_view", params
+      url = CouchRest.paramify_url "#{@root}/_temp_view", params
       JSON.parse(RestClient.post(url, funcs.to_json, {"Content-Type" => 'application/json'}))
     end
     
@@ -70,7 +71,7 @@ module CouchRest
       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 "#{@root}/_design/#{dname}/_view/#{vname}", params
       if keys
         CouchRest.post(url, {:keys => keys})
       else
@@ -85,7 +86,7 @@ module CouchRest
     # GET a document from CouchDB, by id. Returns a Ruby Hash.
     def get(id, params = {})
       slug = escape_docid(id)
-      url = CouchRest.paramify_url("#{@uri}/#{slug}", params)
+      url = CouchRest.paramify_url("#{@root}/#{slug}", params)
       result = CouchRest.get(url)
       return result unless result.is_a?(Hash)
       doc = if /^_design/ =~ result["_id"]
@@ -101,7 +102,7 @@ module CouchRest
     def fetch_attachment(doc, name)
       # slug = escape_docid(docid)        
       # name = CGI.escape(name)
-      uri = uri_for_attachment(doc, name)
+      uri = url_for_attachment(doc, name)
       RestClient.get uri
       # "#{@uri}/#{slug}/#{name}"
     end
@@ -110,13 +111,13 @@ module CouchRest
     def put_attachment(doc, name, file, options = {})
       docid = escape_docid(doc['_id'])
       name = CGI.escape(name)
-      uri = uri_for_attachment(doc, name)       
+      uri = url_for_attachment(doc, name)
       JSON.parse(RestClient.put(uri, file, options))
     end
     
     # DELETE an attachment directly from CouchDB
     def delete_attachment doc, name
-      uri = uri_for_attachment(doc, name)
+      uri = url_for_attachment(doc, name)
       # this needs a rev
       JSON.parse(RestClient.delete(uri))
     end
@@ -144,18 +145,18 @@ module CouchRest
       result = if doc['_id']
         slug = escape_docid(doc['_id'])
         begin     
-          CouchRest.put "#{@uri}/#{slug}", doc
+          CouchRest.put "#{@root}/#{slug}", doc
         rescue RestClient::ResourceNotFound
           p "resource not found when saving even tho an id was passed"
           slug = doc['_id'] = @server.next_uuid
-          CouchRest.put "#{@uri}/#{slug}", doc
+          CouchRest.put "#{@root}/#{slug}", doc
         end
       else
         begin
           slug = doc['_id'] = @server.next_uuid
-          CouchRest.put "#{@uri}/#{slug}", doc
+          CouchRest.put "#{@root}/#{slug}", doc
         rescue #old version of couchdb
-          CouchRest.post @uri, doc
+          CouchRest.post @root, doc
         end
       end
       if result['ok']
@@ -190,7 +191,7 @@ module CouchRest
           doc['_id'] = nextid if nextid
         end
       end
-      CouchRest.post "#{@uri}/_bulk_docs", {:docs => docs}
+      CouchRest.post "#{@root}/_bulk_docs", {:docs => docs}
     end
     alias :bulk_delete :bulk_save
     
@@ -207,7 +208,7 @@ module CouchRest
         return { "ok" => true } # Mimic the non-deferred version
       end
       slug = escape_docid(doc['_id'])        
-      CouchRest.delete "#{@uri}/#{slug}?rev=#{doc['_rev']}"
+      CouchRest.delete "#{@root}/#{slug}?rev=#{doc['_rev']}"
     end
     
     ### DEPRECATION NOTICE
@@ -227,7 +228,7 @@ module CouchRest
       else
         dest
       end
-      CouchRest.copy "#{@uri}/#{slug}", destination
+      CouchRest.copy "#{@root}/#{slug}", destination
     end
     
     ### DEPRECATION NOTICE
@@ -238,7 +239,7 @@ module CouchRest
     
     # Compact the database, removing old document revisions and optimizing space use.
     def compact!
-      CouchRest.post "#{@uri}/_compact"
+      CouchRest.post "#{@root}/_compact"
     end
     
     # Create the database
@@ -272,7 +273,7 @@ module CouchRest
     # catastrophic. Use with care!
     def delete!
       clear_extended_doc_fresh_cache
-      CouchRest.delete @uri
+      CouchRest.delete @root
     end
 
     private
@@ -280,7 +281,7 @@ module CouchRest
     def clear_extended_doc_fresh_cache
       ::CouchRest::ExtendedDocument.subclasses.each{|klass| klass.design_doc_fresh = false if klass.respond_to?(:design_doc_fresh=) }
     end
-    
+
     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"
@@ -293,7 +294,11 @@ module CouchRest
       docid = escape_docid(docid)
       name = CGI.escape(name)
       rev = "?rev=#{doc['_rev']}" if rev
-      "#{@root}/#{docid}/#{name}#{rev}"
+      "/#{docid}/#{name}#{rev}"
+    end
+
+    def url_for_attachment(doc, name)
+      @root + uri_for_attachment(doc, name)
     end
     
     def escape_docid id      

data/lib/couchrest/core/document.rb

@@ -68,7 +68,7 @@ module CouchRest
     # Returns the CouchDB uri for the document
     def uri(append_rev = false)
       return nil if new_document?
-      couch_uri = "http://#{database.uri}/#{CGI.escape(id)}"
+      couch_uri = "http://#{database.root}/#{CGI.escape(id)}"
       if append_rev == true
         couch_uri << "?rev=#{rev}"
       elsif append_rev.kind_of?(Integer)

data/lib/couchrest/mixins/collection.rb

@@ -0,0 +1,220 @@
+module CouchRest
+  module Mixins
+    module Collection
+  
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        # Creates a new class method, find_all_<collection_name>, that will
+        # execute the view specified with the design_doc and view_name 
+        # parameters, along with the specified view_options.  This method will
+        # return the results of the view as an Array of objects which are
+        # instances of the class.
+        #
+        # This method is handy for objects that do not use the view_by method
+        # to declare their views.
+        def provides_collection(collection_name, design_doc, view_name, view_options)
+          class_eval <<-END, __FILE__, __LINE__ + 1
+            def self.find_all_#{collection_name}(options = {})
+              view_options = #{view_options.inspect} || {}
+              CollectionProxy.new(@database, "#{design_doc}", "#{view_name}", view_options.merge(options), Kernel.const_get('#{self}'))
+            end
+          END
+        end
+
+        # Fetch a group of objects from CouchDB.  Options can include:
+        #   :page - Specifies the page to load (starting at 1)
+        #   :per_page - Specifies the number of objects to load per page
+        #
+        # Defaults are used if these options are not specified.
+        def paginate(options)
+          proxy = create_collection_proxy(options)
+          proxy.paginate(options)
+        end
+
+        # Iterate over the objects in a collection, fetching them from CouchDB
+        # in groups.  Options can include:
+        #   :page - Specifies the page to load
+        #   :per_page - Specifies the number of objects to load per page
+        #
+        # Defaults are used if these options are not specified.
+        def paginated_each(options, &block)
+          proxy = create_collection_proxy(options)
+          proxy.paginated_each(options, &block)
+        end
+
+        # Create a CollectionProxy for the specified view and options.
+        # CollectionProxy behaves just like an Array, but offers support for
+        # pagination.
+        def collection_proxy_for(design_doc, view_name, view_options = {})
+          options = view_options.merge(:design_doc => design_doc, :view_name => view_name)
+          create_collection_proxy(options)
+        end
+
+        private
+
+        def create_collection_proxy(options)
+          design_doc, view_name, view_options = parse_view_options(options)
+          CollectionProxy.new(@database, design_doc, view_name, view_options, self)
+        end
+
+        def parse_view_options(options)
+          design_doc = options.delete(:design_doc)
+          raise ArgumentError, 'design_doc is required' if design_doc.nil?
+
+          view_name = options.delete(:view_name)
+          raise ArgumentError, 'view_name is required' if view_name.nil?
+
+          default_view_options = (design_doc.class == Design && 
+              design_doc['views'][view_name.to_s] &&
+              design_doc['views'][view_name.to_s]["couchrest-defaults"]) || {}
+          view_options = default_view_options.merge(options)
+
+          [design_doc, view_name, view_options]
+        end
+      end
+
+      class CollectionProxy
+        alias_method :proxy_respond_to?, :respond_to?
+        instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|proxy_|^object_id$)/ }
+
+        DEFAULT_PAGE = 1
+        DEFAULT_PER_PAGE = 30
+
+        # Create a new CollectionProxy to represent the specified view.  If a
+        # container class is specified, the proxy will create an object of the
+        # given type for each row that comes back from the view.  If no
+        # container class is specified, the raw results are returned.
+        #
+        # The CollectionProxy provides support for paginating over a collection
+        # via the paginate, and paginated_each methods.
+        def initialize(database, design_doc, view_name, view_options = {}, container_class = nil)
+          raise ArgumentError, "database is a required parameter" if database.nil?
+
+          @database = database
+          @container_class = container_class
+
+          strip_pagination_options(view_options)
+          @view_options = view_options
+
+          if design_doc.class == Design
+            @view_name = "#{design_doc.name}/#{view_name}"
+          else
+            @view_name = "#{design_doc}/#{view_name}"
+          end
+        end
+
+        # See Collection.paginate
+        def paginate(options = {})
+          page, per_page = parse_options(options)
+          results = @database.view(@view_name, pagination_options(page, per_page))
+          remember_where_we_left_off(results, page)
+          convert_to_container_array(results)
+        end
+
+        # See Collection.paginated_each
+        def paginated_each(options = {}, &block)
+          page, per_page = parse_options(options)
+
+          begin
+            collection = paginate({:page => page, :per_page => per_page})
+            collection.each(&block)
+            page += 1
+          end until collection.size < per_page
+        end
+
+        def respond_to?(*args)
+          proxy_respond_to?(*args) || (load_target && @target.respond_to?(*args))
+        end
+
+        # Explicitly proxy === because the instance method removal above
+        # doesn't catch it.
+        def ===(other)
+          load_target
+          other === @target
+        end
+
+        private
+
+        def method_missing(method, *args)
+          if load_target
+            if block_given?
+              @target.send(method, *args)  { |*block_args| yield(*block_args) }
+            else
+              @target.send(method, *args)
+            end
+          end
+        end
+
+        def load_target
+          unless loaded?
+            results = @database.view(@view_name, @view_options)
+            @target = convert_to_container_array(results)
+          end
+          @loaded = true
+          @target
+        end
+
+        def loaded?
+          @loaded
+        end
+
+        def reload
+          reset
+          load_target
+          self unless @target.nil?
+        end
+
+        def reset
+          @loaded = false
+          @target = nil
+        end
+
+        def inspect
+          load_target
+          @target.inspect
+        end
+
+        def convert_to_container_array(results)
+          if @container_class.nil?
+            results
+          else
+            results['rows'].collect { |row| @container_class.new(row['doc']) } unless results['rows'].nil?
+          end
+        end
+
+        def pagination_options(page, per_page)
+          view_options = @view_options.clone
+          if @last_key && @last_docid && @last_page == page - 1
+            view_options.delete(:key)
+            options = { :startkey => @last_key, :startkey_docid => @last_docid, :limit => per_page, :skip => 1 }
+          else
+            options = { :limit => per_page, :skip => per_page * (page - 1) }
+          end
+          view_options.merge(options)
+        end
+
+        def parse_options(options)
+          page = options.delete(:page) || DEFAULT_PAGE
+          per_page = options.delete(:per_page) || DEFAULT_PER_PAGE
+          [page.to_i, per_page.to_i]
+        end
+
+        def strip_pagination_options(options)
+          parse_options(options)
+        end
+
+        def remember_where_we_left_off(results, page)
+          last_row = results['rows'].last
+          @last_key = last_row['key']
+          @last_docid = last_row['id']
+          @last_page = page
+        end
+      end
+
+    end
+  end
+end

data/lib/couchrest/mixins/extended_attachments.rb

@@ -44,6 +44,12 @@ module CouchRest
         "#{database.root}/#{self.id}/#{attachment_name}"
       end
       
+      # returns URI to fetch the attachment from
+      def attachment_uri(attachment_name)
+        return unless has_attachment?(attachment_name)
+        "#{database.uri}/#{self.id}/#{attachment_name}"
+      end
+      
       private
       
         def encode_attachment(data)

data/lib/couchrest/mixins/extended_document_mixins.rb

@@ -5,3 +5,4 @@ require File.join(File.dirname(__FILE__), 'design_doc')
 require File.join(File.dirname(__FILE__), 'validation')
 require File.join(File.dirname(__FILE__), 'extended_attachments')
 require File.join(File.dirname(__FILE__), 'class_proxy')
+require File.join(File.dirname(__FILE__), 'collection')

data/lib/couchrest/mixins/properties.rb

@@ -1,6 +1,25 @@
 require 'time'
 require File.join(File.dirname(__FILE__), '..', 'more', 'property')
 
+class Time                       
+  # returns a local time value much faster than Time.parse
+  def self.mktime_with_offset(string)
+    string =~ /(\d{4})\/(\d{2})\/(\d{2}) (\d{2}):(\d{2}):(\d{2}) ([\+\-])(\d{2})/
+    # $1 = year
+    # $2 = month
+    # $3 = day
+    # $4 = hours
+    # $5 = minutes
+    # $6 = seconds
+    # $7 = time zone direction
+    # $8 = tz difference
+    # utc time with wrong TZ info: 
+    time = mktime($1, RFC2822_MONTH_NAME[$2.to_i - 1], $3, $4, $5, $6, $7)
+    tz_difference = ("#{$7 == '-' ? '+' : '-'}#{$8}".to_i * 3600)
+    time + tz_difference + zone_offset(time.zone) 
+  end 
+end
+
 module CouchRest
   module Mixins
     module Properties
@@ -24,7 +43,7 @@ module CouchRest
         self.class.properties.each do |property|
           key = property.name.to_s
           # let's make sure we have a default
-          if property.default
+          unless property.default.nil?
               if property.default.class == Proc
                 self[key] = property.default.call
               else
@@ -37,10 +56,11 @@ module CouchRest
       def cast_keys
         return unless self.class.properties
         self.class.properties.each do |property|
+          
           next unless property.casted
           key = self.has_key?(property.name) ? property.name : property.name.to_sym
           # Don't cast the property unless it has a value
-          next unless self[key]
+          next unless self[key]   
           target = property.type
           if target.is_a?(Array)
             klass = ::CouchRest.constantize(target[0])
@@ -48,19 +68,21 @@ module CouchRest
               # Auto parse Time objects
               obj = ( (property.init_method == 'new') && klass == Time) ? Time.parse(value) : klass.send(property.init_method, value)
               obj.casted_by = self if obj.respond_to?(:casted_by)
-              obj
+              obj 
             end
           else
             # Auto parse Time objects
-            self[property.name] = if ((property.init_method == 'new') && target == 'Time') 
-              self[key].is_a?(String) ? Time.parse(self[key].dup) : self[key]
+            self[property.name] = if ((property.init_method == 'new') && target == 'Time')
+              # Using custom time parsing method because Ruby's default method is toooo slow 
+              self[key].is_a?(String) ? Time.mktime_with_offset(self[key].dup) : self[key]
             else
               # Let people use :send as a Time parse arg
               klass = ::CouchRest.constantize(target)
-              klass.send(property.init_method, self[key].dup)
-            end
+              klass.send(property.init_method, self[key].dup)   
+            end  
             self[property.name].casted_by = self if self[property.name].respond_to?(:casted_by)
-          end
+          end 
+          
         end
       end
       
@@ -122,4 +144,4 @@ module CouchRest
       
     end
   end
-end
+end

data/lib/couchrest/mixins/views.rb

@@ -141,8 +141,12 @@ module CouchRest
             fetch_view(db, name, opts, &block)
           else
             begin
-              view = fetch_view db, name, opts.merge({:include_docs => true}), &block
-              view['rows'].collect{|r|new(r['doc'])} if view['rows']
+              if block.nil?
+                collection_proxy_for(design_doc, name, opts.merge({:include_docs => true}))
+              else
+                view = fetch_view db, name, opts.merge({:include_docs => true}), &block
+                view['rows'].collect{|r|new(r['doc'])} if view['rows']
+              end
             rescue
               # fallback for old versions of couchdb that don't 
               # have include_docs support

data/lib/couchrest/monkeypatches.rb

@@ -1,5 +1,6 @@
 require File.join(File.dirname(__FILE__), 'support', 'class')
 require File.join(File.dirname(__FILE__), 'support', 'blank')
+require 'timeout'
 
 # This file must be loaded after the JSON gem and any other library that beats up the Time class.
 class Time
@@ -38,7 +39,7 @@ if RUBY_VERSION.to_f < 1.9
           if IO.select([@io], nil, nil, @read_timeout)
             retry
           else
-            raise Timeout::TimeoutError
+            raise Timeout::Error
           end
         end
       else
@@ -109,4 +110,4 @@ module RestClient
 #     end
 #   end
   
-end
+end

data/lib/couchrest/more/extended_document.rb

@@ -13,10 +13,11 @@ module CouchRest
     include CouchRest::Mixins::DesignDoc
     include CouchRest::Mixins::ExtendedAttachments
     include CouchRest::Mixins::ClassProxy
+    include CouchRest::Mixins::Collection
 
-   def self.subclasses
-     ObjectSpace.enum_for(:each_object, class << self; self; end).to_a.delete_if{|k| k == self}
-   end
+    def self.subclasses
+      @subclasses ||= []
+    end
     
     def self.inherited(subklass)
       subklass.send(:include, CouchRest::Mixins::Properties)
@@ -25,6 +26,7 @@ module CouchRest
           subklass.properties = self.properties.dup
         end
       EOS
+      subclasses << subklass
     end
     
     # Accessors

data/lib/couchrest/validation/validators/numeric_validator.rb

@@ -40,7 +40,7 @@ module CouchRest
         value = target.send(field_name)
         return true if @options[:allow_nil] && value.nil?
 
-        value = value.kind_of?(Float) ? value.to_s('F') : value.to_s
+        value = (defined?(BigDecimal) && value.kind_of?(BigDecimal)) ? value.to_s('F') : value.to_s
 
         error_message = @options[:message]
         precision     = @options[:precision]

data/spec/couchrest/core/database_spec.rb

@@ -12,7 +12,8 @@ describe CouchRest::Database do
     it "should escape the name in the URI" do
       db = @cr.database("foo/bar")
       db.name.should == "foo/bar"
-      db.uri.should == "#{COUCHHOST}/foo%2Fbar"
+      db.root.should == "#{COUCHHOST}/foo%2Fbar"
+      db.uri.should  == "/foo%2Fbar"
     end
   end
 

data/spec/couchrest/more/extended_doc_attachment_spec.rb

@@ -126,5 +126,10 @@ describe "ExtendedDocument attachments" do
     it 'should return the attachment URL as specified by CouchDB HttpDocumentApi' do
       @obj.attachment_url(@attachment_name).should == "#{Basic.database}/#{@obj.id}/#{@attachment_name}"
     end
+    
+    it 'should return the attachment URI' do
+      @obj.attachment_uri(@attachment_name).should == "#{Basic.database.uri}/#{@obj.id}/#{@attachment_name}"
+    end
+    
   end
 end

data/spec/couchrest/more/extended_doc_spec.rb

@@ -11,6 +11,7 @@ describe "ExtendedDocument" do
     property :set_by_proc,  :default => Proc.new{Time.now},       :cast_as => 'Time'
     property :tags,         :default => []
     property :read_only_with_default, :default => 'generic', :read_only => true
+    property :default_false, :default => false
     property :name
     timestamps!
   end
@@ -142,6 +143,10 @@ describe "ExtendedDocument" do
     it "should have the default value set at initalization" do
       @obj.preset.should == {:right => 10, :top_align => false}
     end
+
+    it "should have the default false value explicitly assigned" do
+      @obj.default_false.should == false
+    end
     
     it "should automatically call a proc default at initialization" do
       @obj.set_by_proc.should be_an_instance_of(Time)

data/spec/couchrest/more/extended_doc_view_spec.rb

@@ -337,5 +337,78 @@ describe "ExtendedDocument views" do
       Article.design_doc["views"].keys.should include("by_updated_at")
     end
   end
-  
+
+  describe "with a collection" do
+    before(:all) do
+      reset_test_db!
+      @titles = ["very uniq one", "really interesting", "some fun",
+        "really awesome", "crazy bob", "this rocks", "super rad"]
+      @titles.each_with_index do |title,i|
+        a = Article.new(:title => title, :date => Date.today)
+        a.save
+      end
+    end
+    it "should return a proxy that looks like an array of 7 Article objects" do
+      articles = Article.by_date :key => Date.today
+      articles.class.should == Array
+      articles.size.should == 7
+    end
+    it "should get a subset of articles using paginate" do
+      articles = Article.by_date :key => Date.today
+      articles.paginate(:page => 1, :per_page => 3).size.should == 3
+      articles.paginate(:page => 2, :per_page => 3).size.should == 3
+      articles.paginate(:page => 3, :per_page => 3).size.should == 1
+    end
+    it "should get all articles, a few at a time, using paginated each" do
+      articles = Article.by_date :key => Date.today
+      articles.paginated_each(:per_page => 3) do |a|
+        a.should_not be_nil
+      end
+    end
+    it "should provide a class method to access the collection directly" do
+      articles = Article.collection_proxy_for('Article', 'by_date', :descending => true,
+        :key => Date.today, :include_docs => true)
+      articles.class.should == Array
+      articles.size.should == 7
+    end
+    it "should provide a class method for paginate" do
+      articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+        :per_page => 3, :descending => true, :key => Date.today, :include_docs => true)
+      articles.size.should == 3
+
+      articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+        :per_page => 3, :page => 2, :descending => true, :key => Date.today, :include_docs => true)
+      articles.size.should == 3
+
+      articles = Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
+        :per_page => 3, :page => 3, :descending => true, :key => Date.today, :include_docs => true)
+      articles.size.should == 1
+    end
+    it "should provide a class method for paginated_each" do
+      options = { :design_doc => 'Article', :view_name => 'by_date',
+        :per_page => 3, :page => 1, :descending => true, :key => Date.today,
+        :include_docs => true }
+      Article.paginated_each(options) do |a|
+        a.should_not be_nil
+      end
+    end
+    it "should provide a class method to get a collection for a view" do
+      class Article
+        provides_collection :article_details, 'Article', 'by_date', :descending => true, :include_docs => true
+      end
+
+      articles = Article.find_all_article_details(:key => Date.today)
+      articles.class.should == Array
+      articles.size.should == 7
+    end
+    it "should raise an exception if design_doc is not provided" do
+      lambda{Article.collection_proxy_for(nil, 'by_date')}.should raise_error
+      lambda{Article.paginate(:view_name => 'by_date')}.should raise_error
+    end
+    it "should raise an exception if view_name is not provided" do
+      lambda{Article.collection_proxy_for('Article', nil)}.should raise_error
+      lambda{Article.paginate(:design_doc => 'Article')}.should raise_error
+    end
+  end
+
 end

data/spec/couchrest/more/property_spec.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require File.join(FIXTURE_PATH, 'more', 'person')
 require File.join(FIXTURE_PATH, 'more', 'card')
 require File.join(FIXTURE_PATH, 'more', 'invoice')
 require File.join(FIXTURE_PATH, 'more', 'service')
@@ -36,6 +37,15 @@ describe "ExtendedDocument properties" do
     @card.family_name.should == @card.last_name
   end
   
+  it "should let you use an alias for a casted attribute" do
+    @card.cast_alias = Person.new(:name => "Aimonetti")
+    @card.cast_alias.name.should == "Aimonetti"
+    @card.calias.name.should == "Aimonetti"
+    card = Card.new(:first_name => "matt", :cast_alias => {:name => "Aimonetti"})
+    card.cast_alias.name.should == "Aimonetti"
+    card.calias.name.should == "Aimonetti"
+  end
+  
   it "should be auto timestamped" do
     @card.created_at.should be_nil
     @card.updated_at.should be_nil

data/spec/fixtures/more/card.rb

@@ -11,6 +11,8 @@ class Card < CouchRest::ExtendedDocument
   property :first_name
   property :last_name,        :alias     => :family_name
   property :read_only_value,  :read_only => true
+  property :cast_alias,       :cast_as   =>  'Person',  :alias  => :calias
+
   
   timestamps!
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couchrest
 version: !ruby/object:Gem::Version 
-  version: "0.28"
+  version: "0.30"
 platform: ruby
 authors: 
 - J. Chris Anderson
@@ -48,6 +48,7 @@ files:
 - README.md
 - Rakefile
 - THANKS.md
+- history.txt
 - examples/model/example.rb
 - examples/word_count/markov
 - examples/word_count/views/books/chunked-map.js
@@ -73,6 +74,7 @@ files:
 - lib/couchrest/mixins/attachments.rb
 - lib/couchrest/mixins/callbacks.rb
 - lib/couchrest/mixins/class_proxy.rb
+- lib/couchrest/mixins/collection.rb
 - lib/couchrest/mixins/design_doc.rb
 - lib/couchrest/mixins/document_queries.rb
 - lib/couchrest/mixins/extended_attachments.rb
@@ -161,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.2
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Lean and RESTful interface to CouchDB.