couch_potato 0.2.29 → 0.2.30

data/CHANGES.md

@@ -1,6 +1,9 @@
 ## Changes
 
-### master
+### 0.2.30
+* pass in multiple keys when querying a view (langalex)
+
+### 0.2.29
 * nicer inspect() for models (mattmatt)
 * fixed (re)reduce for property views wasn't working (langalex)
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 29
+:patch: 30
 :build: 

data/lib/couch_potato/database.rb

@@ -32,7 +32,7 @@ module CouchPotato
     #
     #   db.view(User.all(limit: 5, startkey: 2, reduce: false))
     #
-    # For your convenience when passing a has with only a key parameter you can just pass in the value
+    # For your convenience when passing a hash with only a key parameter you can just pass in the value
     #
     #   db.view(User.all(key: 1)) == db.view(User.all(1))
     # 
@@ -40,6 +40,9 @@ module CouchPotato
     #
     #   db.view(User.all(key: 1..20)) == db.view(startkey: 1, endkey: 20) == db.view(User.all(1..20))
     #   
+    # You can also pass in multiple keys:
+    #
+    #   db.view(User.all(keys: [1, 2, 3]))
     def view(spec)
       results = CouchPotato::View::ViewQuery.new(database,
         spec.design_document, spec.view_name, spec.map_function,

data/lib/couch_potato/view/base_view_spec.rb

@@ -54,7 +54,7 @@ module CouchPotato
       end
       
       def valid_view_parameters
-        %w(key startkey startkey_docid endkey endkey_docid limit stale descending skip group group_level reduce include_docs inclusive_end)
+        %w(key keys startkey startkey_docid endkey endkey_docid limit stale descending skip group group_level reduce include_docs inclusive_end)
       end
     end
   end

data/spec/custom_view_spec.rb

@@ -12,8 +12,8 @@ class Build
   view :key_array_timeline, :key => [:time, :state]
   view :custom_timeline, :map => "function(doc) { emit(doc._id, {state: 'custom_' + doc.state}); }", :type => :custom
   view :custom_timeline_returns_docs, :map => "function(doc) { emit(doc._id, null); }", :include_docs => true, :type => :custom
-  view :custom_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc.id, 1)}}", :reduce => "function(key, values) {return({\"count\": sum(values)});}", :group => true, :type => :custom
-  view :custom_count_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc.id, 1)}}", :reduce => "function(key, values) {return(sum(values));}", :group => true, :type => :custom
+  view :custom_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc._id, 1)}}", :reduce => "function(key, values) {return({\"count\": sum(values)});}", :group => true, :type => :custom
+  view :custom_count_with_reduce, :map => "function(doc) {if(doc.foreign_key) {emit(doc.foreign_key, 1);} else {emit(doc._id, 1)}}", :reduce => "function(key, values) {return(sum(values));}", :group => true, :type => :custom
   view :raw, :type => :raw, :map => "function(doc) {emit(doc._id, doc.state)}"
   view :filtered_raw, :type => :raw, :map => "function(doc) {emit(doc._id, doc.state)}", :results_filter => lambda{|res| res['rows'].map{|row| row['value']}}
   view :with_view_options, :group => true, :key => :time
@@ -25,11 +25,12 @@ end
 describe 'view' do
   before(:each) do
     recreate_db
+    @db = CouchPotato.database
   end
 
   it "should return instances of the class" do
-    CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
-    results = CouchPotato.database.view(Build.timeline)
+    @db.save_document Build.new(:state => 'success', :time => '2008-01-01')
+    results = @db.view(Build.timeline)
     results.map(&:class).should == [Build]
   end
 
@@ -37,49 +38,63 @@ describe 'view' do
     query = mock 'query'
     CouchPotato::View::ViewQuery.stub!(:new).and_return(query)
     query.should_receive(:query_view!).with(hash_including(:key => 1)).and_return('rows' => [])
-    CouchPotato.database.view Build.timeline(:key => 1)
+    @db.view Build.timeline(:key => 1)
   end
 
   it "should not return documents that don't have a matching JSON.create_id" do
     CouchPotato.couchrest_database.save_doc({:time => 'x'})
-    CouchPotato.database.view(Build.timeline).should == []
+    @db.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
+    @db.save_document! Build.new(:state => 'success', :time => '2008-01-01')
+    @db.view(Build.count(:reduce => true)).should == 1
   end
 
   it "should count zero documents" do
-    CouchPotato.database.view(Build.count(:reduce => true)).should == 0
+    @db.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
+    @db.save_document! Build.new(:state => 'success', :time => '2008-01-01')
+    @db.view(Build.count(:reduce => false)).total_rows.should == 1
+  end
+  
+  describe "with multiple keys" do
+    it "should return the documents with matching keys" do
+      build = Build.new(:state => 'success', :time => '2008-01-01')
+      @db.save! build
+      @db.view(Build.timeline(:keys => ['2008-01-01'])).should == [build]
+    end
+    
+    it "should not return documents with non-matching keys" do
+      build = Build.new(:state => 'success', :time => '2008-01-01')
+      @db.save! build
+      @db.view(Build.timeline(:keys => ['2008-01-02'])).should be_empty
+    end
   end
 
   describe "properties defined" do
     it "should assign the configured properties" do
       CouchPotato.couchrest_database.save_doc(:state => 'success', :time => '2008-01-01', JSON.create_id.to_sym => 'Build')
-      CouchPotato.database.view(Build.minimal_timeline).first.state.should == 'success'
+      @db.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', JSON.create_id.to_sym => 'Build')
-      CouchPotato.database.view(Build.minimal_timeline).first.time.should be_nil
+      @db.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', JSON.create_id.to_sym => 'Build')['id']
-      CouchPotato.database.view(Build.minimal_timeline).first._id.should == id
+      @db.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', JSON.create_id.to_sym => 'Build'})['id']
-      result = CouchPotato.database.view(Build.timeline).first
+      result = @db.view(Build.timeline).first
       result.state.should == 'success'
       result.time.should == '2008-01-01'
       result._id.should == id
@@ -89,38 +104,38 @@ describe 'view' do
   describe "map function given" do
     it "should still return instances of the class" do
       CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
-      CouchPotato.database.view(Build.custom_timeline).map(&:class).should == [Build]
+      @db.view(Build.custom_timeline).map(&:class).should == [Build]
     end
 
     it "should assign the properties from the value" do
       CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
-      CouchPotato.database.view(Build.custom_timeline).map(&:state).should == ['custom_success']
+      @db.view(Build.custom_timeline).map(&:state).should == ['custom_success']
     end
 
     it "should assign the id" do
       doc = CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
-      CouchPotato.database.view(Build.custom_timeline).map(&:_id).should == [doc['id']]
+      @db.view(Build.custom_timeline).map(&:_id).should == [doc['id']]
     end
 
     it "should leave the other properties blank" do
       CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
-      CouchPotato.database.view(Build.custom_timeline).map(&:time).should == [nil]
+      @db.view(Build.custom_timeline).map(&:time).should == [nil]
     end
     
     describe "that returns null documents" do
       it "should return instances of the class" do
         CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
-        CouchPotato.database.view(Build.custom_timeline_returns_docs).map(&:class).should == [Build]
+        @db.view(Build.custom_timeline_returns_docs).map(&:class).should == [Build]
       end
 
       it "should assign the properties from the value" do
         CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01'})
-        CouchPotato.database.view(Build.custom_timeline_returns_docs).map(&:state).should == ['success']
+        @db.view(Build.custom_timeline_returns_docs).map(&:state).should == ['success']
       end
       
       it "should still return instance of class if document included JSON.create_id" do
         CouchPotato.couchrest_database.save_doc({:state => 'success', :time => '2008-01-01', JSON.create_id.to_sym => "Build"})
-        view_data = CouchPotato.database.view(Build.custom_timeline_returns_docs)
+        view_data = @db.view(Build.custom_timeline_returns_docs)
         view_data.map(&:class).should == [Build]
         view_data.map(&:state).should == ['success']
       end
@@ -130,14 +145,14 @@ describe 'view' do
       it "should still assign the id" do
         doc = CouchPotato.couchrest_database.save_doc({})
         CouchPotato.couchrest_database.save_doc({:foreign_key => doc['id']})
-        CouchPotato.database.view(Build.custom_with_reduce).map(&:_id).should == [doc['id']]
+        @db.view(Build.custom_with_reduce).map(&:_id).should == [doc['id']]
       end
       
       describe "when the additional reduce function is a typical count" do
         it "should parse the reduce count" do
           doc = CouchPotato.couchrest_database.save_doc({})
           CouchPotato.couchrest_database.save_doc({:foreign_key => doc['id']})
-          CouchPotato.database.view(Build.custom_count_with_reduce(:reduce => true)).should == 1
+          @db.view(Build.custom_count_with_reduce(:reduce => true)).should == 2
         end
       end
     end
@@ -146,34 +161,34 @@ 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', :query_view! => {'rows' => []}))
-      CouchPotato.database.view Build.key_array_timeline
+      @db.view Build.key_array_timeline
     end
   end
 
   describe "raw view" do
     it "should return the raw data" do
-      CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
-      CouchPotato.database.view(Build.raw)['rows'][0]['value'].should == 'success'
+      @db.save_document Build.new(:state => 'success', :time => '2008-01-01')
+      @db.view(Build.raw)['rows'][0]['value'].should == 'success'
     end
 
     it "should return filtred raw data" do
-      CouchPotato.database.save_document Build.new(:state => 'success', :time => '2008-01-01')
-      CouchPotato.database.view(Build.filtered_raw).should == ['success']
+      @db.save_document Build.new(:state => 'success', :time => '2008-01-01')
+      @db.view(Build.filtered_raw).should == ['success']
     end
 
     it "should pass view options declared in the view declaration to the query" do
      view_query = mock 'view_query'
      CouchPotato::View::ViewQuery.stub!(:new).and_return(view_query)
      view_query.should_receive(:query_view!).with(hash_including(:group => true)).and_return({'rows' => []})
-     CouchPotato.database.view(Build.with_view_options)
+     @db.view(Build.with_view_options)
     end
   end
 
   describe "inherited views" do
     it "should support parent views for objects of the subclass" do
-      CouchPotato.database.save_document CustomBuild.new(:state => 'success', :time => '2008-01-01')
-      CouchPotato.database.view(CustomBuild.timeline).size.should == 1
-      CouchPotato.database.view(CustomBuild.timeline).first.should be_kind_of(CustomBuild)
+      @db.save_document CustomBuild.new(:state => 'success', :time => '2008-01-01')
+      @db.view(CustomBuild.timeline).size.should == 1
+      @db.view(CustomBuild.timeline).first.should be_kind_of(CustomBuild)
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 29
-  version: 0.2.29
+  - 30
+  version: 0.2.30
 platform: ruby
 authors: 
 - Alexander Lang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 +02:00
+date: 2010-04-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -123,7 +123,7 @@ files:
 - spec/unit/callbacks_spec.rb
 - spec/unit/couch_potato_spec.rb
 - spec/unit/create_spec.rb
-- spec/unit/customs_views_spec.rb
+- spec/unit/custom_views_spec.rb
 - spec/unit/database_spec.rb
 - spec/unit/date_spec.rb
 - spec/unit/dirty_attributes_spec.rb
@@ -186,7 +186,7 @@ test_files:
 - spec/unit/callbacks_spec.rb
 - spec/unit/couch_potato_spec.rb
 - spec/unit/create_spec.rb
-- spec/unit/customs_views_spec.rb
+- spec/unit/custom_views_spec.rb
 - spec/unit/database_spec.rb
 - spec/unit/date_spec.rb
 - spec/unit/dirty_attributes_spec.rb