rspec-solr 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@rspec-solr --create

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: rake rspec
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+notifications:
+  email:
+    - ndushay@stanford.edu

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# See rspec-solr.gemspec for this gem's dependencies
+gemspec

data/LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright (c) 2012.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+
+Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
+
+THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= RSpec Solr
+
+{<img src="https://secure.travis-ci.org/sul-dlss/rspec-solr.png?branch=master" alt="Build Status" />}[http://travis-ci.org/sul-dlss/rspec-solr]
+
+Provides RSpec custom matchers to be used with Solr response objects.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-solr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-solr
+
+== Usage
+
+See expecation_matchers.rdoc 
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task :default => :ci  
+task :spec => :rspec

data/expectation_matchers.rdoc

@@ -0,0 +1,148 @@
+= RSpec-Solr Matchers for RSpec-Solr::SolrResponseHash
+
+(rspec-solr_resp_hash..should ...  or rspec-solr_resp_hash..should_not ...)
+
+== MATCHING WHETHER RESPONSE HAS DOCUMENTS OR NOT
+
+ NOTE:  this is about the TOTAL number of Solr documents that match ("numFound"), NOT solely the documents returned in this response
+
+=== Matcher
+* have_documents
+
+=== Usage
+* rspec-solr_resp_hash.should have_documents
+* rspec-solr_resp_hash.should_not have_documents
+
+== MATCHING NUMBER OF DOCUMENTS 
+
+ NOTE:  this is about the TOTAL number of Solr documents that match ("numFound"), NOT solely the documents returned in this response
+
+=== Matchers
+* have(2).documents
+* have_exactly(4).documents
+* have_at_least(3).documents  
+* have_at_most(3).documents
+
+=== Usage
+* rspec-solr_resp_hash.should have(3).documents
+* rspec-solr_resp_hash.should_not have(2).documents
+* rspec-solr_resp_hash.should have_at_least(3).documents
+* rspec-solr_resp_hash.should have_at_most(4).documents
+
+== MATCHING SPECIFIC DOCUMENTS IN RESPONSE
+
+ NOTE:  this is about the Solr documents returned in THIS response
+
+=== Matcher
+* include()
+
+=== Usage
+==== Specifying Single Document
+===== String
+* ("idval") 
+ NOTE: value of the unique id field (defaults to 'id') in the Solr document
+       To change the id field name, use my_solr_response_hash.id_field='my_id_fldname'
+===== Hash
+* ("fldname" => "value")
+* ("fld1" => "val1", "fld2" => "val2")
+ NOTE: single Solr document must have all key value pairs
+* ("fldname" => ["val1", "val2", "val3"])
+ NOTE: all of the Array values must be present for the fld in a single Solr document
+       should_not for Array implies NONE of the values should be present in a single document
+TODO:
+* document("fldname" => "/regex/")
+* include_title("val")  include_[any_field_name]("val")
+
+==== Specifying Multiple Documents
+===== Array
+* by id strings: (["id1", "id2", "id3"])
+* by hashes: ([{"title" => "green is best"}, {"title" => "blue is best"}, {"fld" => "val"}])
+ NOTE: you cannot do this:  ([{"title" => ["Solr doc 1 title", "Solr doc 2 title"]} ]) to specify multiple documents
+* by mix of id strings and hashes: ([{"title" => "green is best"}, "id3", {"author" => "steinbeck"}])
+
+==== Full Examples
+* rspec-solr_resp_hash.should include("fld1" => "val1")
+* rspec-solr_resp_hash.should include("f1" => "v1", "f2" => ["val1", "val2", "val3"])
+* rspec-solr_resp_hash.should include("idval")
+* rspec-solr_resp_hash.should include(["id1", "id2", "id3"])
+* rspec-solr_resp_hash.should include([{"title" => "title1"}, {"title" => "title2"}])
+* rspec-solr_resp_hash.should include([{"title" => "title1"}, {"title" => "title2"}, "id8"])
+
+== MATCHING SPECIFIC DOCUMENTS OCCURRING IN FIRST N RESULTS 
+
+ NOTE:  this is about the Solr documents returned in THIS response
+
+=== 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 
+
+TODO:
+* include_at_least(3).of_these_documents().in_first(3).results
+
+=== Usage
+See above for information on how to specify specific documents
+* rspec-solr_resp_hash.should include("111").as_first.document
+* 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)
+
+
+== MATCHING RELATIVE ORDER OF SPECIFIC DOCUMENTS
+
+ NOTE:  this is about the Solr documents returned in THIS response
+
+=== Matcher
+* include().before()
+ NOTE: documents are specified the same way inside both sets of parens (see Usage for examples and see above re: specifying documents)
+
+TODO: Potential Syntax:
+* include().before_first_occurrence_of()
+* include().within(3).of_document()
+* subject.document(:title => 'vala').should come_before(subject.document(:title =>'valb'))
+* subject.should have_result_field_ordered("title", "vala", "valb") 
+
+=== Usage
+* rspec-solr_resp_hash.should include("111").before("222")
+* rspec-solr_resp_hash.should include("fld"=>"val").before("fld"=>["val1", "val2", "val3"])
+* rspec-solr_resp_hash.should include([{"title" => "title1"}, {"title" => "title2"}]).before("title" => "title3")
+
+== TODO: MATCHING FACET VALUES IN RESPONSE
+
+ NOTE:  this is about the facet values returned in THIS response
+
+=== Specifying Facet Values
+* facet(:format => "Book")
+* facets(:format => ["Image", "Map"])
+*  facets with arrarr and without
+
+=== Potential Syntax
+rspec-solr_resp_hash.should include_facet
+
+=== Matchers
+* include_facet().before_facet()
+* include_facets().before_facet()
+* include_facet().before_facets()
+* include_facets().before_facets()
+
+
+== TODO: COMPARING TOTAL RESULTS OF TWO RESPONSES
+
+=== Specifying Second Response
+* than_solr_response({:q => "foo", :sort => "title"})  # solr params
+* than_search_for("foo")  # only q is specified, defaults for everything else
+
+=== Potential Syntax
+rspec-solr_resp_hash.should
+
+=== Matchers
+* have_more_results_than_solr_response(:params)
+* have_fewer_results_than_solr_response(:params)
+* have_the_same_number_of_results_as_solr_response(:params)
+

data/lib/rspec-solr/have_documents_matcher.rb

@@ -0,0 +1,34 @@
+
+begin
+  require 'rspec-expectations'
+rescue LoadError
+end
+
+# 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
+  # 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 
+    match do |solr_resp|
+      solr_resp["response"]["numFound"] > 0
+    end
+
+    failure_message_for_should do |solr_resp|
+      "expected documents in Solr response #{solr_resp["response"]}"
+    end
+    
+    failure_message_for_should_not do |solr_resp|
+      "did not expect documents, but Solr response had #{solr_resp["response"]["numFound"]}"
+    end 
+  end
+  
+end

data/lib/rspec-solr/include_documents_matcher.rb

@@ -0,0 +1,105 @@
+# overriding RSpec::Matchers::Builtin::Include.perform_match method 
+# so we can use RSpec include matcher for document in Solr response
+module RSpec
+  module Matchers
+    module BuiltIn
+      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)
+          @max_doc_position = num
+          self
+        end
+        
+        alias_method :as_first, :in_first
+        
+        # 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"
+        def before(expected)
+          # get first doc position by calling has_document ???
+          @before_expected = expected
+          self
+        end    
+
+        # override failure message for improved readability
+        def failure_message_for_should
+          assert_ivars :@actual, :@expected
+# 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 @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
+            super
+          end
+        end
+        
+        # override failure message for improved readability
+        def failure_message_for_should_not
+          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 @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
+            super
+          end
+        end
+        
+
+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)
+              if (@before_expected)
+                before_ix = actuals.get_first_doc_index(@before_expected)
+                if before_ix
+                  @max_doc_position = before_ix + 1
+                else
+                  # make the desired result impossible
+                  @max_doc_position = -1
+                end
+              end
+              actuals.has_document?(expected, @max_doc_position)
+            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)
+            else
+              actuals.include?(expected)
+            end
+          end
+        end
+        
+        # is actual param a SolrResponseHash? 
+        def comparing_doc_to_solr_resp_hash?(actual, expected)
+          actual.is_a?(RSpecSolr::SolrResponseHash)
+        end
+        
+        def method_missing(method, *args, &block)
+          @collection_name = method
+          @args = args
+          @block = block
+          self
+        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"
+          else
+            docs = "document"
+          end
+        end
+        
+      end # class Include
+    end # module BuiltIn
+  end
+end

data/lib/rspec-solr/solr_response_hash.rb

@@ -0,0 +1,130 @@
+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' 
+    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"]["numFound"]  # 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 
+    #   "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
+    # @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)
+      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
+                Array(doc[exp_fname]).include?(exp_val)
+              } &&
+              # satisfy doc's position in the results
+              (max_doc_position ? docs.find_index(doc) < max_doc_position : true)
+          }
+        }
+      elsif expected_doc.is_a?(String)
+        has_document?({self.id_field => expected_doc}, max_doc_position)
+      elsif expected_doc.is_a?(Array)
+        expected_doc.all? { |exp| has_document?(exp, max_doc_position) }
+      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
+    #   {"id" => "666"}
+    #   {"subject" => ["warm fuzzies", "fluffy"]}
+    #   {"title" => "warm fuzzies", "subject" => ["puppies"]}
+    # @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
+      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)
+                }) 
+              first_doc_index = get_min_index(first_doc_index, docs.find_index(doc))
+              return first_doc_index
+            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}))
+      elsif expected_doc.is_a?(Array)
+        expected_doc.all? { |exp| 
+          ix = get_first_doc_index(exp)
+          if ix
+            first_doc_index = get_min_index(first_doc_index, ix)
+          else
+            return nil
+          end
+        }
+      end  
+
+      return first_doc_index
+    end
+
+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)
+      if a
+        if b
+          [a, b].min
+        else # b is nil
+          a
+        end
+      else # a is nil
+        b
+      end
+    end
+
+    # access the Array of Hashes representing the Solr documents in the response
+    def docs
+      @docs ||= self["response"]["docs"]
+    end
+
+  end
+end

data/lib/rspec-solr/version.rb

@@ -0,0 +1,3 @@
+class RSpecSolr
+  VERSION = "0.0.1"
+end

data/lib/rspec-solr.rb

@@ -0,0 +1,7 @@
+require "rspec-solr/solr_response_hash"
+require "rspec-solr/have_documents_matcher"
+require "rspec-solr/include_documents_matcher"
+
+module RSpecSolr::Matchers
+
+end

data/lib/tasks/ci.rake

@@ -0,0 +1,5 @@
+desc "run continuous integration suite (tests, coverage, docs)" 
+task :ci do 
+  Rake::Task["rspec"].invoke
+  Rake::Task["doc"].invoke
+end

data/lib/tasks/doc.rake

@@ -0,0 +1,21 @@
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+# Use yard to build docs
+begin
+  project_root = File.expand_path(File.dirname(__FILE__) + "/../..")
+  doc_dest_dir = File.join(project_root, 'doc')
+
+  YARD::Rake::YardocTask.new(:doc) do |yt|
+    yt.files = Dir.glob(File.join(project_root, 'lib', '**', '*.rb'))
+    yt.options = ['--output-dir', doc_dest_dir, 
+                  '--readme', 'README.rdoc', 
+                  '--title', 'RSpec-Solr Documentation', 
+                  '--files', 'expectation_matchers.rdoc']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
+end  

data/lib/tasks/spec.rake

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+end

data/rspec-solr.gemspec

@@ -0,0 +1,35 @@
+
+# # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rspec-solr/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "rspec-solr"
+  gem.version       = RSpecSolr::VERSION
+  gem.authors       = ["Naomi Dushay", "Chris Beer"]
+  gem.email         = ["ndushay@stanford.edu", "cabeer@stanford.edu"]
+  gem.description   = "Provides RSpec custom matchers to be used with Solr response objects."
+  gem.summary       = "RSpec custom matchers for Solr response objects"
+  gem.homepage      = "http://github.com/sul-dlss/rspec-solr"
+
+  gem.extra_rdoc_files = ["LICENSE.txt", "README.rdoc", "expectation_matchers.rdoc"]
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_path = ["lib"]
+  
+  gem.add_runtime_dependency "rspec"
+
+  # Development dependencies
+  # Bundler will install these gems too if you've checked out rspec-solr source from git and run 'bundle install'
+  # It will not add these as dependencies if you require rspec-solr for other projects
+  gem.add_development_dependency "rake"
+  # docs
+  gem.add_development_dependency "rdoc"
+  gem.add_development_dependency "yard"
+  # tests for this gem
+	gem.add_development_dependency 'simplecov'
+	gem.add_development_dependency 'simplecov-rcov'
+	# continuous integration 
+	gem.add_development_dependency 'travis-lint'
+  
+end

data/spec/have_documents_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'rspec-solr'
+
+describe RSpecSolr do
+
+  # fixtures below
+
+  context "have_documents with no doc matcher" do
+    it "passes if response.should has documents" do
+      @solr_resp_w_docs.should have_documents
+      @solr_resp_total_but_no_docs.should have_documents
+    end
+
+    it "passes if response.should_not has no documents" do
+      @solr_resp_no_docs.should_not have_documents
+    end
+
+    it "failure message for should" do
+      lambda {
+        @solr_resp_no_docs.should have_documents
+      }.should fail_matching("expected documents in Solr response ")
+    end
+
+    it "failure message for should_not" do
+      lambda {
+        @solr_resp_w_docs.should_not have_documents
+        @solr_resp_total_but_no_docs.should_not have_documents
+      }.should fail_matching("did not expect documents, but Solr response had ")
+    end    
+  end
+  
+  before(:all) do
+    @solr_resp_w_docs = { "response" =>
+                          { "numFound" => 5, 
+                            "start" => 0, 
+                            "docs" => 
+                              [ {"id"=>"111"}, 
+                                {"id"=>"222"}, 
+                                {"id"=>"333"}, 
+                                {"id"=>"444"}, 
+                                {"id"=>"555"}
+                              ]
+                          }
+                        }
+
+    @solr_resp_no_docs = { "response" =>
+                          { "numFound" => 0, 
+                            "start" => 0, 
+                            "docs" => [] 
+                          }
+                        } 
+    @solr_resp_total_but_no_docs = { "response" =>
+                          { "numFound" => 1324, 
+                            "start" => 0, 
+                            "docs" => [] 
+                          }
+                        } 
+  end
+  
+end