rspec-solr 0.1.2 → 0.1.3

data/MATCHERS.rdoc

@@ -76,13 +76,15 @@ TODO:
 === Matchers
 * include().as_first
 * include().as_first.document
-* include().as_first.results
-* include().as_first.anything.can.go.here
 * include().in_first(n)
-* include().in_first(n).documents
-* include().in_first(n).results
-* include().in_first(n).anything_can_go_here
 * include(Array).in_first(n).results 
+* include(Hash).in_each_of_first(n).documents
+
+Note that the following are equivalent:
+* include().blah.document
+* include().blah.documents
+* include().blah.result
+* include().blah.results
 
 TODO:
 * include_at_least(3).of_these_documents().in_first(3).results
@@ -94,6 +96,7 @@ See above for information on how to specify specific documents
 * rspec-solr_resp_hash.should include(["111", "222"]).as_first.documents
 * rspec-solr_resp_hash.should include([{"title" => "title1"}, {"title" => "title2"}]).in_first(3).results
 * rspec-solr_resp_hash.should include("fld1" => "val1").in_first(3)
+* rspec-solr_resp_hash.should include("title" => /cooking/).in_first(3).results
 
 
 == MATCHING RELATIVE ORDER OF SPECIFIC DOCUMENTS

data/lib/rspec-solr/include_documents_matcher.rb

@@ -15,6 +15,14 @@ module RSpec
         
         alias_method :as_first, :in_first
         
+        # chain method for .should include().in_each_of_first(n)
+        #  sets @min_for_last_matching_doc_ix for use in perform_match method
+        # @return self - "each method must return self in order to chain methods together"
+        def in_each_of_first(num=1)
+          @min_for_last_matching_doc_pos = num
+          self
+        end
+        
         # chain method for .should include().before()
         #  sets @before_expected for use in perform_match method
         # @return self - "each method must return self in order to chain methods together"
@@ -30,6 +38,8 @@ module RSpec
 # FIXME: DRY up these messages across cases and across should and should_not
           if @before_expected
             "expected #{@actual.inspect} to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} before #{doc_label_str(@before_expected)} matching #{@before_expected.inspect}"
+          elsif @min_for_last_matching_doc_pos
+            "expected each of the first #{@min_for_last_matching_doc_pos.to_s} documents to #{name_to_sentence}#{expected_to_sentence}: #{@actual.inspect}"
           elsif @max_doc_position
             "expected #{@actual.inspect} to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} in first #{@max_doc_position.to_s} results"
           else
@@ -42,6 +52,8 @@ module RSpec
           assert_ivars :@actual, :@expected
           if @before_expected
             "expected #{@actual.inspect} not to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} before #{doc_label_str(@before_expected)} matching #{@before_expected.inspect}"
+          elsif @min_for_last_matching_doc_pos
+            "expected some of the first #{@min_for_last_matching_doc_pos.to_s} documents not to #{name_to_sentence}#{expected_to_sentence}: #{@actual.inspect}"
           elsif @max_doc_position
             "expected #{@actual.inspect} not to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} in first #{@max_doc_position.to_s} results"
           else
@@ -56,7 +68,7 @@ private
         def perform_match(predicate, hash_predicate, actuals, expecteds)
           expecteds.send(predicate) do |expected|
             if comparing_doc_to_solr_resp_hash?(actuals, expected)
-              if (@before_expected)
+              if @before_expected
                 before_ix = actuals.get_first_doc_index(@before_expected)
                 if before_ix
                   @max_doc_position = before_ix + 1
@@ -65,7 +77,11 @@ private
                   @max_doc_position = -1
                 end
               end
-              actuals.has_document?(expected, @max_doc_position)
+              if @min_for_last_matching_doc_pos 
+                actuals.has_document?(expected, @min_for_last_matching_doc_pos, true)
+              else
+                actuals.has_document?(expected, @max_doc_position)
+              end
             elsif comparing_hash_values?(actuals, expected)
               expected.send(hash_predicate) {|k,v| actuals[k] == v}
             elsif comparing_hash_keys?(actuals, expected)
@@ -82,10 +98,14 @@ private
         end
         
         def method_missing(method, *args, &block)
-          @collection_name = method
-          @args = args
-          @block = block
-          self
+          if (method =~ /documents?/ || method =~ /results?/)
+            @collection_name = method
+            @args = args
+            @block = block
+            self
+          else
+            super.method_missing
+          end
         end
         
         # @return [String] 'documents' or 'document' as indicated by expectation

data/lib/rspec-solr/solr_response_hash.rb

@@ -38,34 +38,51 @@ class RSpecSolr
     #   [{"title" => "warm fuzzies"}, {"title" => "cool fuzzies"}]  implies we expect at least one Solr doc in this response matching each Hash in the Array
     #   [{"title" => /rm fuzz/}, {"title" => /^cool/}]  implies we expect at least one Solr doc in this response matching each Hash in the Array
     # @param [FixNum] max_doc_position maximum acceptable position (1-based) of document in results.  (e.g. if 2, it must be the 1st or 2nd doc in the results)
-    def has_document?(expected_doc, max_doc_position = nil)
+    def has_document?(expected_doc, max_doc_position = nil, all_must_match = nil)
       if expected_doc.is_a?(Hash)
-        # we are happy if any doc meets all of our expectations
-        docs.any? { |doc| 
-          expected_doc.all? { | exp_fname, exp_vals |
-            doc.include?(exp_fname) && 
-              # exp_vals can be a String or an Array
-              # if it's an Array, then all expected values must be present
-              Array(exp_vals).all? { | exp_val |
-                # a doc's fld values can be a String or an Array
-                case exp_val
-                  when Regexp
-                    Array(doc[exp_fname]).any? { |val| val =~ exp_val }
-                  else
-                    Array(doc[exp_fname]).include?(exp_val)
-                end
-              } &&
+        if all_must_match
+          first_non_match = docs.find_index { |doc| 
+            !doc_matches_all_criteria(doc, expected_doc)
+          } >= max_doc_position
+        else
+          # we are happy if any doc meets all of our expectations
+          docs.any? { |doc| 
+            doc_matches_all_criteria(doc, expected_doc) &&
               # satisfy doc's position in the results
               (max_doc_position ? docs.find_index(doc) < max_doc_position : true)
           }
-        }
+        end
       elsif expected_doc.is_a?(String)
+        if all_must_match
+          raise ArgumentError, "in_each_of_first(n) requires a Hash argument to include() method"
+        end
         has_document?({self.id_field => expected_doc}, max_doc_position)
       elsif expected_doc.is_a?(Array)
+        if all_must_match
+          raise ArgumentError, "in_each_of_first(n) requires a Hash argument to include() method"
+        end
         expected_doc.all? { |exp| has_document?(exp, max_doc_position) }
       end   
     end
 
+    # return true if the document contains all the key value pairs in the expectations_hash
+    def doc_matches_all_criteria(doc, expectations_hash)
+      expectations_hash.all? { | exp_fname, exp_vals |
+        doc.include?(exp_fname) && 
+          # exp_vals can be a String or an Array
+          # if it's an Array, then all expected values must be present
+          Array(exp_vals).all? { | exp_val |
+            # a doc's fld values can be a String or an Array
+            case exp_val
+              when Regexp
+                Array(doc[exp_fname]).any? { |val| val =~ exp_val }
+              else
+                Array(doc[exp_fname]).include?(exp_val)
+            end
+          }
+      }
+    end
+
     # @return the index of the first document that meets the expectations in THIS response
     # @param expected_doc what should be matched in a document in THIS response
     # @example expected_doc Hash implies ALL key/value pairs will be matched in a SINGLE Solr document

data/lib/rspec-solr/version.rb

@@ -1,3 +1,3 @@
 class RSpecSolr
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/include_in_each_of_first_n_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'rspec-solr'
+
+describe RSpecSolr do
+  
+  # fixtures below
+  
+  context "#include().in_each_of_first(n)" do
+    context "should" do
+      it "passes when all docs in range meet criteria" do
+        @solr_resp.should include("fld" => "val").in_each_of_first(2)
+        @solr_resp.should include("fld" => "val").in_each_of_first(2).documents
+        @solr_resp.should include("fld" => "val").in_each_of_first(2).results
+      end
+      it "fails when doc in range doesn't meet criteria" do
+        lambda {
+          @solr_resp.should include("fld2" => "val2").in_each_of_first(2)
+        }.should fail_matching('expected each of the first 2 documents to include {"fld2"=>"val2"}')
+        lambda {
+          @solr_resp.should include("fld" => "val").in_each_of_first(3)
+        }.should fail_matching('expected each of the first 3 documents to include {"fld"=>"val"}')
+      end
+    end
+    context "should_NOT" do
+      it "fails when all docs in range meet criteria" do
+        lambda {
+          @solr_resp.should_not include("fld" => "val").in_each_of_first(2)
+        }.should fail_matching('expected some of the first 2 documents not to include {"fld"=>"val"}')
+        lambda {
+          @solr_resp.should_not include("fld" => "val").in_each_of_first(2).documents
+        }.should fail_matching('expected some of the first 2 documents not to include {"fld"=>"val"}')
+        lambda {
+          @solr_resp.should_not include("fld" => "val").in_each_of_first(2).results
+        }.should fail_matching('expected some of the first 2 documents not to include {"fld"=>"val"}')
+      end
+      it "passes when doc in range doesn't meet criteria" do
+        @solr_resp.should_not include("fld" => "val").in_each_of_first(3)
+        @solr_resp.should_not include("fld2" => "val2").in_each_of_first(2)
+      end
+    end
+    it "should expect a Hash for the include" do
+      expect {
+        @solr_resp.should include("111").in_each_of_first(1)
+      }.to raise_error(ArgumentError, "in_each_of_first(n) requires a Hash argument to include() method")
+      expect {
+        @solr_resp.should include(["111", "222"]).in_each_of_first(1)
+      }.to raise_error(ArgumentError, "in_each_of_first(n) requires a Hash argument to include() method")
+      expect {
+        @solr_resp.should_not include("111").in_each_of_first(1)
+      }.to raise_error(ArgumentError, "in_each_of_first(n) requires a Hash argument to include() method")
+      expect {
+        @solr_resp.should include("fld" => "val").in_each_of_first(1)
+      }.to_not raise_error(ArgumentError)
+      expect {
+        @solr_resp.should include({"fld" => "val", "fld2" => "val2"}).in_each_of_first(1)
+      }.to_not raise_error(ArgumentError)
+    end
+  end
+    
+  before(:all) do
+    @solr_resp = RSpecSolr::SolrResponseHash.new({ "response" =>
+                    { "numFound" => 5, 
+                      "start" => 0, 
+                      "docs" => 
+                        [ {"id"=>"111", "fld"=>"val", "fld2"=>"val2"}, 
+                          {"id"=>"222", "fld"=>"val"}, 
+                          {"id"=>"333"}, 
+                          {"id"=>"444", "fld"=>["val1", "val2", "val3"]}, 
+                          {"id"=>"555"}
+                        ]
+                    }
+                  })
+  end
+  
+end

data/spec/include_in_first_n_spec.rb

@@ -110,13 +110,12 @@ describe RSpecSolr do
     end
   end # include().in_first (no n set)
   
-  context "#include().in_first(n).any_chained.names" do
-    context "should #include().in_first(n).any_chained.names" do
+  context "#include().in_first(n).allowed_chained.names" do
+    context "should #include().in_first(n).allowed_chained.names" do
       it "passes when document(s) meet criteria" do
         @solr_resp_5_docs.should include("222").in_first(2).results
         @solr_resp_5_docs.should include("222").in_first(2).documents
-        @solr_resp_5_docs.should include("222").in_first(2).solr.documents
-        @solr_resp_5_docs.should include("fld2"=>"val2").in_first.solr.document
+        @solr_resp_5_docs.should include("fld2"=>"val2").in_first.document
       end
       it "fails when document(s) don't meet criteria" do
         lambda {
@@ -124,20 +123,25 @@ describe RSpecSolr do
         }.should fail_matching('} to include document {"fld"=>["val1", "val2", "val3"]} in first 1')
       end
     end
-    context "should_NOT #include().in_first(n).any_chained.names" do
+    context "should_NOT #include().in_first(n).allowed_chained.names" do
       it "fails when document(s) meet criteria" do
         lambda {
-          @solr_resp_5_docs.should_not include("222").in_first(2).solr.documents
+          @solr_resp_5_docs.should_not include("222").in_first(2).documents
         }.should fail_matching('not to include document "222" in first 2 ')
         lambda {
-          @solr_resp_5_docs.should_not include("fld2"=>"val2").in_first.solr.document
+          @solr_resp_5_docs.should_not include("fld2"=>"val2").in_first.document
         }.should fail_matching('not to include document {"fld2"=>"val2"} in first 1')
       end
       it "passes when document(s) don't meet criteria" do
         @solr_resp_5_docs.should_not include("fld"=>["val1", "val2", "val3"]).in_first.result
       end
     end
-  end # include().in_first().any_chained_names
+    it "should raise a NoMethodError exception when it gets nonsense after include" do
+      expect {
+        @solr_resp.should include("111").bad_method(2)
+      }.to raise_error(NoMethodError, /bad_method/)
+    end    
+  end # include().in_first().allowed_chained.names
   
   context "#include().as_first" do
     context "should include().as_first" do
@@ -183,12 +187,12 @@ describe RSpecSolr do
   end
   
   
-  context "#include().as_first().any_chained.names" do
-    context "should #include().as_first(n).any_chained.names" do
+  context "#include().as_first().allowed_chained.names" do
+    context "should #include().as_first(n).allowed_chained.names" do
       it "passes when document(s) meet criteria" do
         @solr_resp_5_docs.should include(["111", "222"]).as_first(2).results
-        @solr_resp_5_docs.should include(["111", "222"]).as_first(2).solr.documents
-        @solr_resp_5_docs.should include("fld2"=>"val2").as_first.solr.document
+        @solr_resp_5_docs.should include(["111", "222"]).as_first(2).documents
+        @solr_resp_5_docs.should include("fld2"=>"val2").as_first.document
       end
       it "fails when document(s) don't meet criteria" do
         lambda {
@@ -199,17 +203,17 @@ describe RSpecSolr do
     context "should_NOT #include().as_first(n).any_chained.names" do
       it "fails when document(s) meet criteria" do
         lambda {
-          @solr_resp_5_docs.should_not include(["111", "222"]).as_first(2).solr.documents
+          @solr_resp_5_docs.should_not include(["111", "222"]).as_first(2).documents
         }.should fail_matching('not to include documents ["111", "222"] in first 2')
         lambda {
-          @solr_resp_5_docs.should_not include("fld2"=>"val2").as_first.solr.document
+          @solr_resp_5_docs.should_not include("fld2"=>"val2").as_first.document
         }.should fail_matching('not to include document {"fld2"=>"val2"} in first 1')
       end
       it "passes when document(s) don't meet criteria" do
         @solr_resp_5_docs.should_not include("fld"=>["val1", "val2", "val3"]).as_first.result
       end
     end
-  end # include().as_first().any_chained_names
+  end # include().as_first().allowed_chained.names
 
   before(:all) do
     @solr_resp_5_docs = RSpecSolr::SolrResponseHash.new({ "response" =>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-solr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2012-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -158,6 +158,7 @@ files:
 - spec/have_documents_spec.rb
 - spec/include_before_spec.rb
 - spec/include_document_spec.rb
+- spec/include_in_each_of_first_n_spec.rb
 - spec/include_in_first_n_spec.rb
 - spec/number_of_documents_spec.rb
 - spec/solr_response_hash_spec.rb
@@ -177,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4597988063406856522
+      hash: -2465877972703506306
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -186,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4597988063406856522
+      hash: -2465877972703506306
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -198,6 +199,7 @@ test_files:
 - spec/have_documents_spec.rb
 - spec/include_before_spec.rb
 - spec/include_document_spec.rb
+- spec/include_in_each_of_first_n_spec.rb
 - spec/include_in_first_n_spec.rb
 - spec/number_of_documents_spec.rb
 - spec/solr_response_hash_spec.rb