couch_potato 0.2.19 → 0.2.20

data/CHANGES.md

@@ -1,5 +1,9 @@
 ## Changes
 
+### 0.2.20
+* support for :boolean properties (jweiss)
+* return the total_rows when querying a view (langalex)
+
 ### 0.2.19
 * added conditions to views (langalex)
 

data/README.md

@@ -88,12 +88,13 @@ Properties can be typed:
     end
     
 In this case Address also implements CouchPotato::Persistence which means its JSON representation will be added to the user document.  
-Couch Potato also has support for the basic types (right now only Fixnum is supported):
+Couch Potato also has support for the basic types (right now Fixnum and :boolean are supported):
 
     class User
       include CouchPotato::Persistence
 
       property :age, :type => Fixnum
+      property :receive_newsletter, :type => :boolean
     end
 
 With this in place when you set the user's age as a String (e.g. using an hTML form) it will be converted into a Fixnum automatically.
@@ -202,7 +203,7 @@ You can also pass conditions as a JavaScript string:
     class User
       property :name
 
-      view :completed, :key => :name, :conditions => 'doc.completed = true'
+      view :completed, :key => :name, :conditions => 'doc.completed === true'
     end
 
 The creation of views is based on view specification classes (see [CouchPotato::View::BaseViewSpec](http://rdoc.info/rdoc/langalex/couch_potato/blob/e8f0069e5529ad08a1bd1f02637ea8f1d6d0ab5b/CouchPotato/View/BaseViewSpec.html) and its descendants for more detailed documentation). The above code uses the ModelViewSpec class which is used to find models by their properties. For more sophisticated searches you can use other view specifications (either use the built-in or provide your own) by passing a type parameter:
@@ -337,6 +338,10 @@ In order for this to work you must have the `js` executable in your PATH. This i
 
 Please fix bugs, add more specs, implement new features by forking the github repo at http://github.com/langalex/couch_potato.
 
+Issues are tracked at github: http://github.com/langalex/couch_potato/issues
+
+There is a mailing list, just write to: couchpotato@librelis.com
+
 You can run all the specs by calling 'rake spec_unit' and 'rake spec_functional' in the root folder of Couch Potato. The specs require a running CouchDB instance at http://localhost:5984
 
 I will only accept patches that are covered by specs - sorry.

data/VERSION.yml

@@ -1,5 +1,4 @@
 --- 
-:build: 
-:minor: 2
-:patch: 19
 :major: 0
+:minor: 2
+:patch: 20

data/lib/couch_potato/database.rb

@@ -12,14 +12,30 @@ module CouchPotato
       end
     end
 
+    # executes a view and return the results. you pass in a view spec
+    # which is usually a result of a SomePersistentClass.view call.
+    # also return the total_rows returned by CouchDB as an accessor on the results.
+    #
+    # Example:
+    #
+    #   class User
+    #     include CouchPotato::Persistence
+    #     view :all, key: :created_at
+    #   end
+    #
+    #   CouchPotato.database.view(User.all) # => [user1, user2]
+    #   CouchPotato.database.view(User.all).total_rows # => 2
+    #
     def view(spec)
       results = CouchPotato::View::ViewQuery.new(database,
         spec.design_document, spec.view_name, spec.map_function,
         spec.reduce_function).query_view!(spec.view_parameters)
-      spec.process_results results
+      processed_results = spec.process_results results
+      processed_results.instance_eval "def total_rows; #{results['total_rows']}; end" if results['total_rows']
+      processed_results
     end
 
-
+    # saves a document. returns true on success, false on failure
     def save_document(document, validate = true)
       return true unless document.dirty?
       if document.new?
@@ -29,7 +45,8 @@ module CouchPotato
       end
     end
     alias_method :save, :save_document
-
+    
+    # saves a document, raises a CouchPotato::Database::ValidationsFailedError on failure
     def save_document!(document)
       save_document(document) || raise(ValidationsFailedError.new(document.errors.full_messages))
     end
@@ -45,6 +62,7 @@ module CouchPotato
     end
     alias_method :destroy, :destroy_document
 
+    # loads a document by its id
     def load_document(id)
       raise "Can't load a document without an id (got nil)" if id.nil?
       begin
@@ -57,7 +75,7 @@ module CouchPotato
     end
     alias_method :load, :load_document
 
-    def inspect
+    def inspect #:nodoc:
       "#<CouchPotato::Database>"
     end
 

data/lib/couch_potato/persistence/type_caster.rb

@@ -2,6 +2,26 @@ module CouchPotato
   module Persistence
     class TypeCaster
       def cast(value, type)
+        if type == :boolean
+          cast_boolen(value)
+        else
+          cast_native(value, type)
+        end
+      end
+      
+      private
+      
+      def cast_boolen(value)
+        if [FalseClass, TrueClass].include?(value.class) || value.nil?
+          value
+        elsif [0, '0'].include?(value)
+          false
+        else
+          true
+        end
+      end
+      
+      def cast_native(value, type)
         if type && !value.instance_of?(type)
           if type == Fixnum
             value.to_s.scan(/\d/).join.to_i unless value.blank?
@@ -12,6 +32,7 @@ module CouchPotato
           value
         end
       end
+      
     end
   end
 end

data/spec/custom_view_spec.rb

@@ -52,6 +52,11 @@ describe 'view' do
   it "should count zero documents" do
     CouchPotato.database.view(Build.count(:reduce => true)).should == 0
   end
+  
+  it "should return the total_rows" do
+    CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
+    CouchPotato.database.view(Build.count(:reduce => false)).total_rows.should == 1
+  end
 
   describe "properties defined" do
     it "should assign the configured properties" do
@@ -132,7 +137,7 @@ describe 'view' do
 
   describe "with array as key" do
     it "should create a map function with the composite key" do
-      CouchPotato::View::ViewQuery.should_receive(:new).with(anything, anything, anything, string_matching(/emit\(\[doc\['time'\], doc\['state'\]\]/), anything).and_return(stub('view query').as_null_object)
+      CouchPotato::View::ViewQuery.should_receive(:new).with(anything, anything, anything, string_matching(/emit\(\[doc\['time'\], doc\['state'\]\]/), anything).and_return(stub('view query', :query_view! => {'rows' => []}))
       CouchPotato.database.view Build.key_array_timeline
     end
   end

data/spec/fixtures/address.rb

@@ -6,4 +6,5 @@ class Address
   property :state
   property :zip
   property :country
+  property :verified, :type => :boolean
 end

data/spec/property_spec.rb

@@ -141,6 +141,48 @@ describe 'properties' do
     p = CouchPotato.database.load_document p.id
     p.ship_address.should be_false
   end
+  
+  describe "boolean properties" do
+    it "should persist '0' for false" do
+      a = Address.new
+      a.verified = '0'
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_false
+    end
+    
+    it "should persist 0 for false" do
+      a = Address.new
+      a.verified = 0
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_false
+    end
+    
+    it "should persist '1' for true" do
+      a = Address.new
+      a.verified = '1'
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_true
+    end
+    
+    it "should persist 1 for true" do
+      a = Address.new
+      a.verified = 1
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_true
+    end
+    
+    it "should leave nil as nil" do
+      a = Address.new
+      a.verified = nil
+      CouchPotato.database.save_document! a
+      a = CouchPotato.database.load_document a.id
+      a.verified.should be_nil
+    end
+  end
 
   describe "predicate" do
     it "should return true if property set" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.19
+  version: 0.2.20
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 +01:00
+date: 2010-01-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency