rspec-solr 1.0.1 → 2.0.0

data/lib/rspec-solr/have_documents_matcher.rb

@@ -1,28 +1,19 @@
 # Custom RSpec Matchers for Solr responses
 module RSpecSolr::Matchers
-  
-  # Determine if the receiver has Solr documents
-  # NOTE:  this is about the TOTAL number of Solr documents matching the query, not solely the number of docs in THIS response
-  def have_documents
-    # Placeholder method for documentation purposes; 
-    # the actual method is defined using RSpec's matcher DSL
-  end
-
-  # Define .have_documents
+  # @!method have_documents
   # Determine if the receiver (a Solr response object) has at least one document
   # NOTE:  this is about the TOTAL number of Solr documents matching the query, not solely the number of docs in THIS response
-  RSpec::Matchers.define :have_documents do 
+  RSpec::Matchers.define :have_documents do
     match do |solr_resp|
-      solr_resp["response"]["numFound"] > 0
+      solr_resp['response']['numFound'] > 0
+    end
+
+    failure_message do |solr_resp|
+      "expected documents in Solr response #{solr_resp['response']}"
     end
 
-    failure_message_for_should do |solr_resp|
-      "expected documents in Solr response #{solr_resp["response"]}"
+    failure_message_when_negated do |solr_resp|
+      "did not expect documents, but Solr response had #{solr_resp['response']['numFound']}"
     end
-    
-    failure_message_for_should_not do |solr_resp|
-      "did not expect documents, but Solr response had #{solr_resp["response"]["numFound"]}"
-    end 
   end
-  
-end
+end

data/lib/rspec-solr/have_facet_field_matcher.rb

@@ -1,26 +1,18 @@
 # Custom RSpec Matchers for Solr responses
 module RSpecSolr::Matchers
-  
-  # Determine if the receiver has the facet_field
-  def have_facet_field
-    # Placeholder method for documentation purposes; 
-    # the actual method is defined using RSpec's matcher DSL
-  end
-
   # this is the lambda used to determine if the receiver (a Solr response object) has non-empty values for the facet field
   #  as the expected RSpecSolr::SolrResponseHash
-  def self.have_facet_field_body 
-    lambda { |expected_facet_field_name|
-      
-      match_for_should do |solr_resp|
+  def self.facet_field_body?
+    lambda do |expected_facet_field_name|
+      match do |solr_resp|
         if @facet_val
           solr_resp.has_facet_field_with_value?(expected_facet_field_name, @facet_val)
         else
           solr_resp.has_facet_field?(expected_facet_field_name)
         end
       end
-      
-      match_for_should_not do |solr_resp|
+
+      match_when_negated do |solr_resp|
         # we should fail if we are looking for a specific facet value but the facet field isn't present in the response
         @has_field = solr_resp.has_facet_field?(expected_facet_field_name)
         if @facet_val
@@ -34,15 +26,15 @@ module RSpecSolr::Matchers
         end
       end
 
-      failure_message_for_should do |solr_resp|
+      failure_message do |solr_resp|
         if @facet_val
           "expected facet field #{expected_facet_field_name} with value #{@facet_val} in Solr response: #{solr_resp}"
         else
           "expected facet field #{expected_facet_field_name} with values in Solr response: #{solr_resp}"
         end
       end
-    
-      failure_message_for_should_not do |solr_resp|
+
+      failure_message_when_negated do |solr_resp|
         if @facet_val
           if @has_field
             "expected facet field #{expected_facet_field_name} not to have value #{@facet_val} in Solr response: #{solr_resp}"
@@ -52,18 +44,18 @@ module RSpecSolr::Matchers
         else
           "expected no #{expected_facet_field_name} facet field in Solr response: #{solr_resp}"
         end
-      end 
-      
+      end
+
       chain :with_value do |val|
         @facet_val = val
       end
-      
+
       diffable
-    }
+    end
   end
-  
+
+  # @!method have_facet_field
   # Determine if the receiver (a Solr response object) has the same number of total documents as the expected RSpecSolr::SolrResponseHash
   # NOTE:  this is about the TOTAL number of Solr documents matching the queries, not solely the number of docs in THESE responses
-  RSpec::Matchers.define :have_facet_field, &have_facet_field_body  
-  
-end
+  RSpec::Matchers.define :have_facet_field, &facet_field_body?
+end

data/lib/rspec-solr/include_documents_matcher.rb

@@ -3,26 +3,25 @@
 module RSpec
   module Matchers
     module BuiltIn
-      class Include 
-        
+      class Include
         # chain method for .should include().in_first(n)
         #  sets @max_doc_position for use in perform_match method
         # @return self - "each method must return self in order to chain methods together"
-        def in_first(num=1)
+        def in_first(num = 1)
           @max_doc_position = num
           self
         end
-        
+
         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)
+        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,46 +29,51 @@ module RSpec
           # get first doc position by calling has_document ???
           @before_expected = expected
           self
-        end    
+        end
 
         # override failure message for improved readability
-        def failure_message_for_should
+        def failure_message
           assert_ivars :@actual, :@expected
-# FIXME: DRY up these messages across cases and across should and should_not
+          name_to_sentence = 'include'
+          # FIXME: DRY up these messages across cases and across should and should_not
           if @before_expected
-            "expected response to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} before #{doc_label_str(@before_expected)} matching #{@before_expected.inspect}: #{@actual.inspect} "
+            "expected response to #{name_to_sentence} #{doc_label_str(@expected)}#{to_sentence(@expected)} before #{doc_label_str(@before_expected)} matching #{@before_expected.inspect}: #{@actual.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} in response: #{@actual.inspect}"
+            "expected each of the first #{@min_for_last_matching_doc_pos} documents to #{name_to_sentence}#{to_sentence(@expected)} in response: #{@actual.inspect}"
           elsif @max_doc_position
-            "expected response to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} in first #{@max_doc_position.to_s} results: #{@actual.inspect}"
+            "expected response to #{name_to_sentence} #{doc_label_str(@expected)}#{to_sentence(@expected)} in first #{@max_doc_position} results: #{@actual.inspect}"
           else
             super
           end
         end
-        
+
         # override failure message for improved readability
-        def failure_message_for_should_not
+        def failure_message_when_negated
           assert_ivars :@actual, :@expected
+          name_to_sentence = 'include'
           if @before_expected
-            "expected response not to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} before #{doc_label_str(@before_expected)} matching #{@before_expected.inspect}: #{@actual.inspect} "
+            "expected response not to #{name_to_sentence} #{doc_label_str(@expected)}#{to_sentence(@expected)} before #{doc_label_str(@before_expected)} matching #{@before_expected.inspect}: #{@actual.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} in response: #{@actual.inspect}"
+            "expected some of the first #{@min_for_last_matching_doc_pos} documents not to #{name_to_sentence}#{to_sentence(@expected)} in response: #{@actual.inspect}"
           elsif @max_doc_position
-            "expected response not to #{name_to_sentence} #{doc_label_str(@expected)}#{expected_to_sentence} in first #{@max_doc_position.to_s} results: #{@actual.inspect}"
+            "expected response not to #{name_to_sentence} #{doc_label_str(@expected)}#{to_sentence(@expected)} in first #{@max_doc_position} results: #{@actual.inspect}"
           else
             super
           end
         end
-        
 
-private        
+        private
+
         # overriding method so we can use RSpec include matcher for document in Solr response
         #   my_solr_resp_hash.should include({"id" => "666"})
-        def perform_match(predicate, hash_predicate, actuals, expecteds)
-          expecteds.send(predicate) do |expected|
-            if comparing_doc_to_solr_resp_hash?(actuals, expected)
+
+        def excluded_from_actual
+          return [] unless @actual.respond_to?(:include?)
+
+          expected.each_with_object([]) do |expected_item, memo|
+            if comparing_doc_to_solr_resp_hash?(expected_item)
               if @before_expected
-                before_ix = actuals.get_first_doc_index(@before_expected)
+                before_ix = actual.get_first_doc_index(@before_expected)
                 if before_ix
                   @max_doc_position = before_ix + 1
                 else
@@ -77,28 +81,30 @@ private
                   @max_doc_position = -1
                 end
               end
-              if @min_for_last_matching_doc_pos 
-                actuals.has_document?(expected, @min_for_last_matching_doc_pos, true)
+              if @min_for_last_matching_doc_pos
+                memo << expected_item unless yield actual.has_document?(expected_item, @min_for_last_matching_doc_pos, true)
               else
-                actuals.has_document?(expected, @max_doc_position)
+                memo << expected_item unless yield actual.has_document?(expected_item, @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)
-              actuals.has_key?(expected)
+            elsif comparing_hash_to_a_subset?(expected_item)
+              expected_item.each do |(key, value)|
+                memo << { key => value } unless yield actual_hash_includes?(key, value)
+              end
+            elsif comparing_hash_keys?(expected_item)
+              memo << expected_item unless yield actual_hash_has_key?(expected_item)
             else
-              actuals.include?(expected)
+              memo << expected_item unless yield actual_collection_includes?(expected_item)
             end
           end
         end
-        
-        # is actual param a SolrResponseHash? 
-        def comparing_doc_to_solr_resp_hash?(actual, expected)
-          actual.is_a?(RSpecSolr::SolrResponseHash)
+
+        # is actual param a SolrResponseHash?
+        def comparing_doc_to_solr_resp_hash?(expected_item)
+          actual.is_a?(RSpecSolr::SolrResponseHash) && !expected_item.is_a?(RSpecSolr::SolrResponseHash)
         end
-        
+
         def method_missing(method, *args, &block)
-          if (method =~ /documents?/ || method =~ /results?/)
+          if method =~ /documents?/ || method =~ /results?/
             @collection_name = method
             @args = args
             @block = block
@@ -107,19 +113,32 @@ private
             super.method_missing
           end
         end
-        
+
         # @return [String] 'documents' or 'document' as indicated by expectation
         def doc_label_str(expectations)
-# FIXME: must be a better way to do pluralize and inflection fun            
-          if expectations.is_a?(Array) && 
-              (expectations.size > 1 || (expectations.first.is_a?(Array) && expectations.first.size > 1))
-            docs = "documents"
+          # FIXME: must be a better way to do pluralize and inflection fun
+          if expectations.is_a?(Array) &&
+             (expectations.size > 1 || (expectations.first.is_a?(Array) && expectations.first.size > 1))
+            'documents'
+          else
+            'document'
+          end
+        end
+
+        def to_sentence(words = [])
+          words = words.map(&:inspect)
+          case words.length
+          when 0
+            ''
+          when 1
+            " #{words[0]}"
+          when 2
+            " #{words[0]} and #{words[1]}"
           else
-            docs = "document"
+            " #{words[0...-1].join(', ')}, and #{words[-1]}"
           end
         end
-        
       end # class Include
     end # module BuiltIn
   end
-end
+end

data/lib/rspec-solr/solr_response_hash.rb

@@ -1,37 +1,35 @@
 require 'delegate'
 
 class RSpecSolr
-  
   # Subclass Hash so we can use RSpec matchers for number of documents:
   #   my_solr_resp_hash.should have(3).documents
   #   my_solr_resp_hash.should have_at_least(3).documents
   # NOTE:  to use has_document?(String) to match documents, set the id_field attribute (defaults to 'id')
   class SolrResponseHash < DelegateClass(Hash)
-    
     # unique id field for Solr documents; defaults to 'id', can be changed with .id_field='foo'
     attr_accessor :id_field
-    
-    # id_field attribute defaults to 'id' 
+
+    # id_field attribute defaults to 'id'
     def id_field
       @id_field ||= 'id'
     end
-    
+
     # NOTE:  this is about the TOTAL number of Solr documents matching query, not the number of docs in THIS response
     # override Hash size method so we can use RSpec matchers for number of documents:
     #   my_solr_resp_hash.should have(3).documents
     #   my_solr_resp_hash.should have_at_least(3).documents
     def size
-      self["response"] ? self["response"]["numFound"] : 0  # total number of Solr docs matching query
+      self['response'] ? self['response']['numFound'] : 0  # total number of Solr docs matching query
       # NOT:  self["response"]["docs"].size  # number of Solr docs returned in THIS response
     end
-    
+
     # @return true if THIS Solr Response contains document(s) as indicated by expected_doc
     # @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
     #   {"id" => "666"}
     #   {"subject" => ["warm fuzzies", "fluffy"]}
     #   {"title" => "warm fuzzies", "subject" => ["puppies"]}
-    # @example expected_doc String 
+    # @example expected_doc String
     #   "666"  implies  {'id' => '666'}  when id_field is 'id'
     # @example expected_doc Array
     #   ["1", "2", "3"]  implies we expect Solr docs with ids 1, 2, 3 included in this response
@@ -45,41 +43,41 @@ class RSpecSolr
           (first_non_match ? first_non_match >= max_doc_position : true)
         else
           # we are happy if any doc meets all of our expectations
-          docs.any? { |doc| 
+          docs.any? do |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
         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"
+          fail ArgumentError, 'in_each_of_first(n) requires a Hash argument to include() method'
         end
-        has_document?({self.id_field => expected_doc}, max_doc_position)
+        has_document?({ 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"
+          fail 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
     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) && 
+      expectations_hash.all? do |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 |
+          Array(exp_vals).all? do |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)
+            when Regexp
+              Array(doc[exp_fname]).any? { |val| val =~ exp_val }
+            else
+              Array(doc[exp_fname]).include?(exp_val)
             end
-          }
-      }
+          end
+      end
     end
 
     # @return the index of the first document that meets the expectations in THIS response
@@ -88,60 +86,60 @@ class RSpecSolr
     #   {"id" => "666"}
     #   {"subject" => ["warm fuzzies", "fluffy"]}
     #   {"title" => "warm fuzzies", "subject" => ["puppies"]}
-    # @example expected_doc String 
+    # @example expected_doc String
     #   "666"  implies  {'id' => '666'}  when id_field is 'id'
     # @example expected_doc Array
     #   ["1", "2", "3"]  implies we expect Solr docs with ids 1, 2, 3 included in this response
     #   [{"title" => "warm fuzzies"}, {"title" => "cool fuzzies"}]  implies we expect at least one Solr doc in this response matching each Hash in the Array
     def get_first_doc_index(expected_doc)
-# FIXME:  DRY it up! -- very similar to has_document
+      # FIXME:  DRY it up! -- very similar to has_document
       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 |
-            if (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
-                  Array(doc[exp_fname]).include?(exp_val)
-                }) 
+        docs.any? do |doc|
+          expected_doc.all? do |exp_fname, exp_vals|
+            if 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? do |exp_val|
+                 # a doc's fld values can be a String or an Array
+                 Array(doc[exp_fname]).include?(exp_val)
+               end
               first_doc_index = get_min_index(first_doc_index, docs.find_index(doc))
               return first_doc_index
             end
-          }
-        }
+          end
+        end
       elsif expected_doc.is_a?(String)
-        first_doc_index = get_min_index(first_doc_index, get_first_doc_index({self.id_field => expected_doc}))
+        first_doc_index = get_min_index(first_doc_index, get_first_doc_index(id_field => expected_doc))
       elsif expected_doc.is_a?(Array)
-        expected_doc.all? { |exp| 
+        expected_doc.all? do |exp|
           ix = get_first_doc_index(exp)
           if ix
             first_doc_index = get_min_index(first_doc_index, ix)
           else
             return nil
           end
-        }
-      end  
+        end
+      end
 
-      return first_doc_index
+      first_doc_index
     end
 
     # @return String containing response header and numFound parts of hash for readable output for number of docs messages
     def num_docs_partial_output_str
-      "{'responseHeader' => #{self['responseHeader'].inspect}, " + 
-        (self['response'] ? "'response' => {'numFound' => #{self['response']['numFound']}, ...}" : "" ) + 
-        " ... }"
+      "{'responseHeader' => #{self['responseHeader'].inspect}, " +
+        (self['response'] ? "'response' => {'numFound' => #{self['response']['numFound']}, ...}" : '') +
+        ' ... }'
     end
-    
+
     # @return true if the Solr response contains the facet field indicated and the facet field has some values; return false otherwise
     def has_facet_field_with_value?(ff_name, facet_val = nil)
-      if self["facet_counts"] && self["facet_counts"]["facet_fields"] && self["facet_counts"]["facet_fields"][ff_name]
+      if self['facet_counts'] && self['facet_counts']['facet_fields'] && self['facet_counts']['facet_fields'][ff_name]
         if facet_val
-          val_count_array = self["facet_counts"]["facet_fields"][ff_name]
-          return val_count_array.each_slice(2).find { |val_count| val_count[0] == facet_val}
+          val_count_array = self['facet_counts']['facet_fields'][ff_name]
+          return val_count_array.each_slice(2).find { |val_count| val_count[0] == facet_val }
         else
-          self["facet_counts"]["facet_fields"][ff_name].size > 0
+          self['facet_counts']['facet_fields'][ff_name].size > 0
         end
       else
         false
@@ -150,15 +148,15 @@ class RSpecSolr
 
     # @return true if the Solr response contains the facet field indicated and the facet field has some values; return false otherwise
     def has_facet_field?(ff_name)
-      if self["facet_counts"] && self["facet_counts"]["facet_fields"] && self["facet_counts"]["facet_fields"][ff_name]
-        self["facet_counts"]["facet_fields"][ff_name]
+      if self['facet_counts'] && self['facet_counts']['facet_fields'] && self['facet_counts']['facet_fields'][ff_name]
+        self['facet_counts']['facet_fields'][ff_name]
       else
         false
       end
     end
 
-private
-    
+    private
+
     # return the minimum of the two arguments.  If one of the arguments is nil, then return the other argument.
     # If both arguments are nil, return nil.
     def get_min_index(a, b)
@@ -175,8 +173,7 @@ private
 
     # access the Array of Hashes representing the Solr documents in the response
     def docs
-      @docs ||= self["response"]["docs"]
+      @docs ||= self['response']['docs']
     end
-
   end
 end