langalex-couch_potato 0.2.4 → 0.2.5

data/README.md

@@ -173,9 +173,9 @@ Composite keys are also possible:
       view :all, :key => [:created_at, :name]
     end
   
-The creation of views is based on view specification classes (see the CouchPotato::View) module. The above code used the ModelViewSpec class which is used to the simple find model by property searches. For more sophisticated searches you can use other view specifications (either use the built-in or provide your own) by passing a type parameter:
+The creation of views is based on view specification classes (see the CouchPotato::View module). 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:
 
-If you have larger structures and you only want to load some attributes you can customize the view you can use the PropertiesViewSpec (the full class name is automatically derived):
+If you have larger structures and you only want to load some attributes you can use the PropertiesViewSpec (the full class name is automatically derived):
 
     class User
       property :name
@@ -209,6 +209,8 @@ To process this raw data you can also pass in a results filter:
 
 In this case querying the view would only return the emitted value for each row.
 
+You can pass in your own view specifications by passing in :type => MyViewSpecClass. Take a look at the CouchPotato::View::*ViewSpec classes to get an idea of how this works.
+
 #### Associations
 
 Not supported. Not sure if they ever will be. You can implement those yourself using views and custom methods on your models.

data/VERSION.yml

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

data/lib/couch_potato/view/custom_views.rb

@@ -18,11 +18,19 @@ module CouchPotato
         def view(view_name, options)
           self.class.instance_eval do
             define_method view_name do |view_parameters = {}|
-              klass = options[:type] ? options[:type].to_s.camelize : 'Model'
-              CouchPotato::View.const_get("#{klass}ViewSpec").new self, view_name, options, view_parameters
+              view_spec_class(options[:type]).new self, view_name, options, view_parameters
             end
           end
         end
+        
+        def view_spec_class(type)
+          if type && type.is_a?(Class)
+            type
+          else
+            name = type.nil? ? 'Model' : type.to_s.camelize
+            CouchPotato::View.const_get("#{name}ViewSpec")
+          end
+        end
       end
     end
   end

data/lib/couch_potato/view/model_view_spec.rb

@@ -1,29 +1,51 @@
 module CouchPotato
   module View
-    # A view to return model instances by searching its properties
+    # A view to return model instances by searching its properties.
+    # If you pass reduce => true will count instead
     #
     # example:
     #   view :my_view, :key => :name
     class ModelViewSpec < BaseViewSpec
       
       def view_parameters
-        {:include_docs => true}.merge(super)
+        _super = super
+        if _super[:reduce]
+          _super
+        else
+          {:include_docs => true, :reduce => false}.merge(_super)
+        end
       end
       
       def map_function
         "function(doc) {
-            emit(#{formatted_key(key)}, null);
+           if(doc.ruby_class && doc.ruby_class == '#{@klass.name}') {
+             emit(#{formatted_key(key)}, null);
+           }
          }"
       end
       
+      def reduce_function
+        "function(key, values) {
+          return values.length;
+        }"
+      end
+      
       def process_results(results)
-        results['rows'].map do |row|
-          klass.json_create row['doc']
+        if count?
+          results['rows'].first['value']
+        else
+          results['rows'].map do |row|
+            klass.json_create row['doc']
+          end
         end
       end
       
       private
       
+      def count?
+        view_parameters[:reduce]
+      end
+      
       def key
         options[:key]
       end

data/lib/couch_potato/view/properties_view_spec.rb

@@ -7,7 +7,9 @@ module CouchPotato
     class PropertiesViewSpec < ModelViewSpec
       def map_function
         "function(doc) {
-            emit(#{formatted_key(key)}, #{properties_for_map(properties)});
+           if(doc.ruby_class && doc.ruby_class == '#{@klass.name}') {
+             emit(#{formatted_key(key)}, #{properties_for_map(properties)});
+           }
          }"
       end
       

data/spec/custom_view_spec.rb

@@ -7,6 +7,7 @@ class Build
   property :time
   
   view :timeline, :key => :time
+  view :count, :key => :time, :reduce => true
   view :minimal_timeline, :key => :time, :properties => [:state], :type => :properties
   view :key_array_timeline, :key => [:time, :state]
   view :custom_timeline, :map => "function(doc) { emit(doc._id, {state: 'custom_' + doc.state}); }", :type => :custom
@@ -33,26 +34,36 @@ describe 'view' do
     CouchPotato.database.view Build.timeline(:key => 1)
   end
   
+  it "should not return documents that don't have a matching ruby_class" do
+    CouchPotato.couchrest_database.save_doc({:time => 'x'})
+    CouchPotato.database.view(Build.timeline).should == []
+  end
+  
+  it "should count documents" do
+    CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
+    CouchPotato.database.view(Build.count(:reduce => true)).should == 1
+  end
+  
   describe "properties defined" do
     it "should assign the configured properties" do
-      CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+      CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', :ruby_class => 'Build')
       CouchPotato.database.view(Build.minimal_timeline).first.state.should == 'success'
     end
     
     it "should not assign the properties not configured" do
-      CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
+      CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', :ruby_class => 'Build')
       CouchPotato.database.view(Build.minimal_timeline).first.time.should be_nil
     end
     
     it "should assign the id even if it is not configured" do
-      id = CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})['id']
+      id = CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', :ruby_class => 'Build')['id']
       CouchPotato.database.view(Build.minimal_timeline).first._id.should == id
     end
   end
   
   describe "no properties defined" do
     it "should assign all properties to the objects by default" do
-      id = CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})['id']
+      id = CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01', :ruby_class => 'Build'})['id']
       result = CouchPotato.database.view(Build.timeline).first
       result.state.should == 'success'
       result.time.should == '2008-01-01'

data/spec/unit/customs_views_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CouchPotato::View::CustomViews do
+  
+  class MyViewSpec; end
+  class ModelWithView
+    include CouchPotato::Persistence
+    view :all, :type => MyViewSpec
+  end
+  
+  it "should use a custom viewspec class" do
+    MyViewSpec.should_receive(:new)
+    ModelWithView.all
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: langalex-couch_potato
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Alexander Lang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-19 00:00:00 -07:00
+date: 2009-05-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,6 +86,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/attributes_spec.rb
 - spec/unit/create_spec.rb
+- spec/unit/customs_views_spec.rb
 - spec/unit/database_spec.rb
 - spec/unit/dirty_attributes_spec.rb
 - spec/unit/string_spec.rb
@@ -126,6 +127,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/attributes_spec.rb
 - spec/unit/create_spec.rb
+- spec/unit/customs_views_spec.rb
 - spec/unit/database_spec.rb
 - spec/unit/dirty_attributes_spec.rb
 - spec/unit/string_spec.rb