couchrest 0.31 → 0.32

data/history.txt

@@ -1,3 +1,18 @@
+== 0.32
+  
+* Major enhancements
+
+  * ExtendedDocument.get doesn't raise an exception anymore. If no documents are found nil is returned.
+  * ExtendedDocument.get! works the say #get used to work and will raise an exception if a document isn't found.
+  
+* Minor enhancements  
+   
+  * Bug fix: Model.all(:keys => [1,2]) was not working (Matt Aimonetti)
+  * Added ValidationErrors#count in order to play nicely with Rails (Peter Wagenet)
+  * Bug fix: class proxy design doc refresh (Daniel Kirsh)
+  * Bug fix: the count method on the proxy collection was missing (Daniel Kirsch)
+  * Added #amount_pages to a paginated collection. (Matt Aimonetti)
+
 == 0.31
 
 * Major enhancements

data/lib/couchrest/mixins/class_proxy.rb

@@ -59,6 +59,10 @@ module CouchRest
           @klass.all({:database => @database}.merge(opts), &block)
         end
         
+        def count(opts = {}, &block)
+          @klass.all({:database => @database, :raw => true, :limit => 0}.merge(opts), &block)['total_rows']
+        end
+        
         def first(opts = {})
           @klass.first({:database => @database}.merge(opts))
         end
@@ -100,7 +104,7 @@ module CouchRest
         end
         
         def refresh_design_doc
-          @klass.refresh_design_doc
+          @klass.refresh_design_doc_on(@database)
         end
         
         def save_design_doc

data/lib/couchrest/mixins/collection.rb

@@ -83,6 +83,8 @@ module CouchRest
 
         DEFAULT_PAGE = 1
         DEFAULT_PER_PAGE = 30
+        
+        attr_accessor :amount_pages
 
         # Create a new CollectionProxy to represent the specified view.  If a
         # container class is specified, the proxy will create an object of the
@@ -110,7 +112,8 @@ module CouchRest
         # See Collection.paginate
         def paginate(options = {})
           page, per_page = parse_options(options)
-          results = @database.view(@view_name, pagination_options(page, per_page))
+          results = @database.view(@view_name, pagination_options(page, per_page)) 
+          @amount_pages ||= (results['total_rows'].to_f / per_page.to_f).ceil
           remember_where_we_left_off(results, page)
           convert_to_container_array(results)
         end

data/lib/couchrest/mixins/design_doc.rb

@@ -35,7 +35,7 @@ module CouchRest
               'all' => {
                 'map' => "function(doc) {
                   if (doc['couchrest-type'] == '#{self.to_s}') {
-                    emit(null,1);
+                    emit(doc['_id'],1);
                   }
                 }"
               }
@@ -48,6 +48,11 @@ module CouchRest
           save_design_doc
         end
 
+        def refresh_design_doc_on(db)
+          reset_design_doc
+          save_design_doc_on(db)
+        end
+
         # Save the design doc onto the default database, and update the
         # design_doc attribute
         def save_design_doc

data/lib/couchrest/mixins/document_queries.rb

@@ -39,7 +39,38 @@ module CouchRest
         end
         
         # Load a document from the database by id
+        # No exceptions will be raised if the document isn't found
+        #
+        # ==== Returns
+        # Object:: if the document was found
+        # or
+        # Nil::
+        # 
+        # === Parameters
+        # id<String, Integer>:: Document ID
+        # db<Database>:: optional option to pass a custom database to use
         def get(id, db = database)
+          begin
+            doc = db.get id
+          rescue
+            nil
+          else
+            new(doc)
+          end
+        end
+        
+        # Load a document from the database by id
+        # An exception will be raised if the document isn't found
+        #
+        # ==== Returns
+        # Object:: if the document was found
+        # or
+        # Exception
+        # 
+        # === Parameters
+        # id<String, Integer>:: Document ID
+        # db<Database>:: optional option to pass a custom database to use
+        def get!(id, db = database)
           doc = db.get id
           new(doc)
         end

data/lib/couchrest/mixins/views.rb

@@ -95,11 +95,11 @@ module CouchRest
 
         # Dispatches to any named view.
         def view(name, query={}, &block)
-          unless design_doc_fresh
-            refresh_design_doc
+          db = query.delete(:database) || database
+          unless design_doc_fresh            
+            refresh_design_doc_on(db)
           end
           query[:raw] = true if query[:reduce]        
-          db = query.delete(:database) || database
           raw = query.delete(:raw)
           fetch_view_with_docs(db, name, query, raw, &block)
         end

data/lib/couchrest/validation/validation_errors.rb

@@ -104,6 +104,13 @@ module CouchRest
         entries.empty?
       end
 
+      # Return size of errors hash
+      #
+      # Allows us to play nicely with Rails' helpers
+      def count
+        errors.size
+      end
+
       def method_missing(meth, *args, &block)
         errors.send(meth, *args, &block)
       end

data/lib/couchrest.rb

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

data/spec/couchrest/more/extended_doc_spec.rb

@@ -216,6 +216,15 @@ describe "ExtendedDocument" do
       foundart = Article.get @art.id
       foundart.title.should == "All About Getting"
     end
+    
+    it "should return nil if `get` is used and the document doesn't exist" do
+      foundart = Article.get 'matt aimonetti'
+      foundart.should be_nil
+    end                     
+    
+    it "should raise an error if `get!` is used and the document doesn't exist" do
+       lambda{foundart = Article.get!('matt aimonetti')}.should raise_error
+    end
   end
 
   describe "getting a model with a subobjects array" do
@@ -507,7 +516,7 @@ describe "ExtendedDocument" do
     end
     it "should make it go away" do
       @dobj.destroy
-      lambda{Basic.get(@dobj.id)}.should raise_error
+      lambda{Basic.get!(@dobj.id)}.should raise_error
     end
   end
   

data/spec/couchrest/more/extended_doc_view_spec.rb

@@ -168,8 +168,11 @@ describe "ExtendedDocument views" do
       end
       things[0]["doc"]["title"].should =='aaa'
     end
-    it "should barf on get if no database given" do
-      lambda{Unattached.get("aaa")}.should raise_error
+    it "should return nil on get if no database given" do
+      Unattached.get("aaa").should be_nil
+    end
+    it "should barf on get! if no database given" do
+      lambda{Unattached.get!("aaa")}.should raise_error
     end
     it "should get from specific database" do
       u = Unattached.get(@first_id, @db)
@@ -200,7 +203,7 @@ describe "ExtendedDocument views" do
     before(:all) do
       reset_test_db!
       # setup the class default doc to save the design doc
-      Unattached.use_database DB
+      Unattached.use_database nil # just to be sure it is really unattached
       @us = Unattached.on(DB)
       %w{aaa bbb ddd eee}.each do |title|
         u = @us.new(:title => title)
@@ -212,6 +215,9 @@ describe "ExtendedDocument views" do
       rs = @us.all
       rs.length.should == 4
     end
+    it "should count" do
+      @us.count.should == 4
+    end
     it "should make the design doc upon first query" do
       @us.by_title
       doc = @us.design_doc
@@ -365,6 +371,11 @@ describe "ExtendedDocument views" do
       articles.paginated_each(:per_page => 3) do |a|
         a.should_not be_nil
       end
+    end 
+    it "should have the amount of paginated pages" do
+      articles = Article.by_date :key => Date.today
+      articles.paginate(:per_page => 3) 
+      articles.amount_pages.should == 3
     end
     it "should provide a class method to access the collection directly" do
       articles = Article.collection_proxy_for('Article', 'by_date', :descending => true,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couchrest
 version: !ruby/object:Gem::Version 
-  version: "0.31"
+  version: "0.32"
 platform: ruby
 authors: 
 - J. Chris Anderson