rspec-solr 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29844b0eff6a43c4cdcdd5362f62415149f88c08
-  data.tar.gz: 484e4610bd1998ba05a32df00b501fed762bb1da
+  metadata.gz: 614534dc732f46bfc1fe137e447bec23eb04e480
+  data.tar.gz: 69fed90ebd9a576ebc14e52493a90e8d5c8ea8d2
 SHA512:
-  metadata.gz: 8d6667795c37700d04732dc58adf51c9694d6076bead960f3cff38781084bd978bd56ef33b673ee4d26c93cc4c36fa6ca34a1599c3ffeceb481388ef37df8024
-  data.tar.gz: 5d293800c943c18e7dfe85629fe0d45f4f37e62b0ebb923aa88a6ec3eb8ec4fb769a24260c8b4500933f19a82a3c4770686aa9f45264336275d50b71f98330f2
+  metadata.gz: b75ea440dcd94fdc5ff553af14dec0e56373a141aeb806abd9dec92d76655590f67bf744577e897471d50126bcb372ba07915a8985700d60552a49d66de882a4
+  data.tar.gz: 827e79d09922c16d08518a46c50d5dcf087be3d8826379187a89c6d40190c3db202f963774b52631ded7e4b9753ff617b3817e808593c7003ae67b1e462ec12a

data/.rubocop.yml

@@ -0,0 +1,53 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-26 14:31:43 -0700 using RuboCop version 0.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 110
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 409
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 211
+
+# Offense count: 11
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 43
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 3
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Enabled: false
+

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
-script: rake rspec
 rvm:
-  - 2.1.0
-  - 2.0.0
+  - 2.2.2
   - 1.9.3
   - jruby-19mode
 notifications:

data/.yardopts

@@ -1,3 +1,3 @@
 --title 'RSpecSolr Documentation'
 lib/**/*.rb -
-README.rdoc MATCHERS.rdoc LICENSE.txt 
+README.md MATCHERS.md LICENSE.txt 

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # See rspec-solr.gemspec for this gem's dependencies
 gemspec
+
+gem 'rspec', '~> 3.3'

data/MATCHERS.md

@@ -0,0 +1,168 @@
+# 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
+* `expect(rspec-solr_resp_hash).to have_documents`
+* `expect(rspec-solr_resp_hash).not_to 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"`)
+* (`"fldname" => /regex_to_match_val/`)
+* (`"fld1" => "val1", "fld2" => /val2_regex/`)
+ NOTE: single Solr document must satisfy all key value pairs
+* (`"fldname" => ["val1", /val2_regex/, "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
+
+More Ideas (TODO):
+* `include_title("val")` (i.e. include_anyFieldName("val") )
+
+#### Specifying Multiple Documents
+##### Array
+* by id strings: (`["id1", "id2", "id3"]`)
+* by hashes: (`[{"title" => "green is best"}, {"title" => /blue/}, {"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
+* `expect(rspec-solr_resp_hash).to include("fld1" => "val1")`
+* `expect(rspec-solr_resp_hash).to include("fld1" => /regex_for_val/)`
+* `expect(rspec-solr_resp_hash).to include("f1" => "v1", "f2" => ["val1", "val2", /regex_for_val/])`
+* `expect(rspec-solr_resp_hash).to include("idval")`
+* `expect(rspec-solr_resp_hash).to include(["id1", "id2", "id3"])`
+* `expect(rspec-solr_resp_hash).to include([{"title" => "title1"}, {"title" => "title2"}])`
+* `expect(rspec-solr_resp_hash).to 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().in_first(n)`
+* `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`
+* `start_with()`
+
+### Usage
+See above for information on how to specify specific documents
+* `expect(rspec-solr_resp_hash).to include("111").as_first.document`
+* `expect(rspec-solr_resp_hash).to include(["111", "222"]).as_first.documents`
+* `expect(rspec-solr_resp_hash).to include([{"title" => "title1"}, {"title" => "title2"}]).in_first(3).results`
+* `expect(rspec-solr_resp_hash).to include("fld1" => "val1").in_first(3)`
+* `expect(rspec-solr_resp_hash).to include("title" => /cooking/).in_first(3).results`
+
+## 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()`
+* `expect(subject.document(:title => 'vala')).to come_before(subject.document(:title =>'valb'))`
+* `expect(subject).to have_result_field_ordered("title", "vala", "valb") `
+
+### Usage
+* `expect(rspec-solr_resp_hash).to include("111").before("222")`
+* `expect(rspec-solr_resp_hash).to include("fld"=>"val").before("fld"=>["val1", "val2", "val3"])`
+* `expect(rspec-solr_resp_hash).to include([{"title" => "title1"}, {"title" => "title2"}]).before("title" => "title3")`
+
+
+## COMPARING TOTAL RESULTS OF TWO RESPONSES
+
+ NOTE:  this is about the TOTAL number of Solr documents that match ("numFound"), NOT solely the documents returned in THESE responses
+
+### Matchers
+* `have_more_results_than()`
+* `have_fewer_results_than()`
+* `have_the_same_number_of_results_as()`
+* `have_more_documents_than()`
+* `have_fewer_documents_than()`
+* `have_the_same_number_of_documents_as()`
+
+### Usage
+* `expect(rspec-solr_resp_hash1).to have_more_results_than(rspec-solr_resp_hash2)`
+* `expect(rspec-solr_resp_hash1).to have_fewer_results_than(rspec-solr_resp_hash2)`
+* `expect(rspec-solr_resp_hash1).to have_the_same_number_of_results_as(rspec-solr_resp_hash2)`
+
+#### Alternate (allows more granularity)
+* `expect(rspec-solr_resp_hash1.size).to > rspec-solr_resp_hash2.size`
+* `expect(rspec-solr_resp_hash1.size).to >= rspec-solr_resp_hash2.size`
+* `expect(rspec-solr_resp_hash1.size).to < rspec-solr_resp_hash2.size`
+* `expect(rspec-solr_resp_hash1.size).to <= rspec-solr_resp_hash2.size`
+* `expect(rspec-solr_resp_hash1.size).to == rspec-solr_resp_hash2.size`
+* `expect(rspec-solr_resp_hash1.size).to be_within(delta).of(rspec-solr_resp_hash2.size)`
+
+## MATCHING FACET VALUES IN RESPONSE
+
+ NOTE:  this is about the facet counts returned in THIS response
+
+### Matchers
+* `have_facet_field()`
+* `have_facet_field().with_value()`
+
+### Usage
+* `expect(rspec-solr_resp_hash).to have_facet_field("author")`
+* `expect(rspec-solr_resp_hash).to have_facet_field("author").with_value("Steinbeck, John")`
+
+### TODO:
+* facets with arrarr and without (Solr option to get better facet formatting)
+* `have_facet_field().with_value().with_count()`
+* more ideas
+  * `facet(:format => "Book")`
+  * `facets(:format => ["Image", "Map"])`
+  * `include_facet().before_facet()`
+  * `include_facets().before_facet()`
+  * `include_facet().before_facets()`
+  * `include_facets().before_facets()`

data/{README.rdoc → README.md}

@@ -1,10 +1,12 @@
-= RSpec Solr
+[![Build Status](https://travis-ci.org/sul-dlss/rspec-solr.svg?branch=master)](https://travis-ci.org/sul-dlss/rspec-solr)
+[![Coverage Status](https://coveralls.io/repos/sul-dlss/rspec-solr/badge.svg)](https://coveralls.io/r/sul-dlss/rspec-solr)
+[![Dependency Status](https://gemnasium.com/sul-dlss/rspec-solr.svg)](https://gemnasium.com/sul-dlss/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] {<img src="https://gemnasium.com/sul-dlss/rspec-solr.png" alt="Dependency Status" />}[https://gemnasium.com/sul-dlss/rspec-solr]
+# RSpec Solr
 
 A Gem to provide RSpec custom matchers to be used with Solr response objects.
 
-== Installation
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -18,12 +20,13 @@ Or install it yourself as:
 
     $ gem install rspec-solr
 
-== Usage
+## Usage
 
-See MATCHERS.rdoc for syntax of supported expectations.
+See `MATCHERS.md` for syntax of supported expectations.
 
-=== Examples:
+### Examples:
 
+```ruby
  it "q of 'Buddhism' should get 8,500-10,500 results" do
    resp = solr_resp_doc_ids_only({'q'=>'Buddhism'})
    resp.should have_at_least(8500).documents
@@ -45,50 +48,54 @@ See MATCHERS.rdoc for syntax of supported expectations.
     resp.should have_at_least(240).documents
     resp.should have_the_same_number_of_results_as(solr_resp_doc_ids_only({'q'=>'三国志'})) 
   end
+```
 
-=== How Do I Do That?
+### How Do I Do That?
 
 Essentially, you write a bunch of specs that
 * send a request to your Solr index
-* wrap the Solr Ruby response into the RSpecSolr::SolrResponseHash  (blah = RSpecSolr::SolrResponseHash.new(orig_resp))
-* utilize the matchers (blah.should have_document("222")) -- see MATCHERS.rdoc
+* wrap the Solr Ruby response into the `RSpecSolr::SolrResponseHash`  (`blah = RSpecSolr::SolrResponseHash.new(orig_resp)``)
+* utilize the matchers (`expect(blah).to have_document("222")``) -- see `MATCHERS.md`
 
 There is an exemplar project utilizing rspec-solr at https://github.com/sul-dlss/sw_index_tests.  
 
 Besides the specs themselves, it has essentially 4 files to smooth the way.
 
-==== 1. Gemfile
+#### 1. Gemfile
 Indicate the required gems for bundler
 
- source :rubygems
-
- gem 'RedCloth' 		# for textile formatting used in Readme
- gem 'rake'
+```ruby
  gem 'rsolr'       # for sending requests to and getting responses from solr
  gem 'rspec-solr'  # for rspec assertions against solr response object
+```
 
-==== 2. Rakefile
+#### 2. Rakefile
 Make it easy to run various groups of specs from the command line
 
+```ruby
  require 'rspec/core/rake_task'
 
  desc "run specs expected to pass" 
  RSpec::Core::RakeTask.new(:rspec) do |spec|
    spec.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
  end
+```
 
-==== 3. config/solr.yml
+#### 3. config/solr.yml
 Your Solr base url goes here
 
+```yaml
  test:
   :url: http://your_solr_baseurl
 
  dev:
    :url: http://your_solr_baseurl
+```
 
-==== 4. spec/spec_helper.rb
+#### 4. spec/spec_helper.rb
 Do a one time setup of Solr connection, and methods to make it easier to make desired Solr requests
 
+```ruby
   require "yaml"
   require 'rsolr'
   
@@ -110,10 +117,12 @@ Do a one time setup of Solr connection, and methods to make it easier to make de
   def solr_response(solr_params, req_handler='select')  
     RSpecSolr::SolrResponseHash.new(@@solr.send_and_receive(req_handler, {:method => :get, :params => solr_params}))
   end
+```
 
-===== 4a.  a little more magic
+#### 4a.  a little more magic
 You might want to add code such as that below to your spec_helper - it can help keep your solr responses small, which makes for easier debugging.
   
+```ruby
   # send a GET request to the default Solr request handler with the indicated Solr parameters
   # @param solr_params [Hash] the key/value pairs to be sent to Solr as HTTP parameters, in addition to 
   #  those to get only id fields and no facets in the response
@@ -128,19 +137,15 @@ You might want to add code such as that below to your spec_helper - it can help
   def doc_ids_only
     {'fl'=>'id', 'facet'=>'false'}
   end
-  
-
-== Ruby Version Compatibility
-
-This should work with various rubies 1.8.7, but currently some tests expected ordered hashes (though the code itself doesn't require them - just THIS gem's TEST code).
+```
 
-== Contribute
+## Contribute
 
 I'm currently envisioning helper methods shared somehow - either on the github wikis, or in this gem as exemplars, or in a separate gem, or ...
 
 Please share yours!
 
-== Contributing
+## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -148,7 +153,7 @@ Please share yours!
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-== Releases
+## Releases
 - <b>1.0.1</b> fix spec failing in travis due to diff error message in later rspec version
 - <b>1.0.0</b> declare victory and make 0.2.0 into 1.0.0
 - <b>0.2.0</b> add facet support  have_facet_field(fld_name).with_value(fld_value)

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env rake
 require 'bundler/setup'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rake'
 require 'bundler'
@@ -9,11 +9,11 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $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
+task default: :ci
+task spec: :rspec

data/lib/rspec-solr.rb

@@ -1,9 +1,8 @@
-require "rspec-solr/solr_response_hash"
-require "rspec-solr/compare_num_docs_matcher"
-require "rspec-solr/have_documents_matcher"
-require "rspec-solr/have_facet_field_matcher"
-require "rspec-solr/include_documents_matcher"
+require 'rspec-solr/solr_response_hash'
+require 'rspec-solr/compare_num_docs_matcher'
+require 'rspec-solr/have_documents_matcher'
+require 'rspec-solr/have_facet_field_matcher'
+require 'rspec-solr/include_documents_matcher'
 
 module RSpecSolr::Matchers
-
-end
+end

data/lib/rspec-solr/compare_num_docs_matcher.rb

@@ -1,109 +1,92 @@
 # Custom RSpec Matchers for Solr responses
 module RSpecSolr::Matchers
-  
-  # Determine if the receiver has the same number of Solr docs as the expected
-  # NOTE:  this is about the TOTAL number of Solr documents matching the queries, not solely the number of docs in THESE responses
-  def have_the_same_number_of_results_as
-    # Placeholder method for documentation purposes; 
-    # the actual method is defined using RSpec's matcher DSL
-  end
-
-  # Determine if the receiver has fewer Solr docs than the expected
-  # NOTE:  this is about the TOTAL number of Solr documents matching the queries, not solely the number of docs in THESE responses
-  def have_fewer_results_than
-    # Placeholder method for documentation purposes; 
-    # the actual method is defined using RSpec's matcher DSL
-  end
-
-  # Determine if the receiver has more Solr docs than the expected
-  # NOTE:  this is about the TOTAL number of Solr documents matching the queries, not solely the number of docs in THESE responses
-  def have_more_results_than
-    # 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 the same number of total documents 
+  # this is the lambda used to determine if the receiver (a Solr response object) has the same number of total documents
   #  as the expected RSpecSolr::SolrResponseHash
-  def self.same_number_of_results_body 
-    lambda { |expected_solr_resp_hash|
+  def self.same_number_of_results_body
+    lambda do |expected_solr_resp_hash|
       match do |actual_solr_resp_hash|
         actual_solr_resp_hash.size == expected_solr_resp_hash.size
       end
 
-      failure_message_for_should do |actual_solr_resp_hash|
+      failure_message do |actual_solr_resp_hash|
         "expected #{actual_solr_resp_hash.size} documents in Solr response #{expected_solr_resp_hash.num_docs_partial_output_str}"
       end
-    
-      failure_message_for_should_not do |actual_solr_resp_hash|
+
+      failure_message_when_negated do |actual_solr_resp_hash|
         "expected (not #{actual_solr_resp_hash.size}) documents in Solr response #{expected_solr_resp_hash.num_docs_partial_output_str}"
-      end 
-      
+      end
+
       diffable
-    }
-  end  
-  
+    end
+  end
+
+  # @!method have_the_same_number_of_results_as
   # 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_the_same_number_of_results_as, &same_number_of_results_body
 
+  # @!method have_the_same_number_of_documents_as
   # 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_the_same_number_of_documents_as,  &same_number_of_results_body
-  
-  # this is the lambda used to determine if the receiver (a Solr response object) has fewer total documents 
+
+  # this is the lambda used to determine if the receiver (a Solr response object) has fewer total documents
   #  than the expected RSpecSolr::SolrResponseHash
   def self.fewer_results_than_body
-    lambda { |expected_solr_resp_hash|
+    lambda do |expected_solr_resp_hash|
       match do |actual_solr_resp_hash|
         actual_solr_resp_hash.size < expected_solr_resp_hash.size
       end
 
-      failure_message_for_should do |actual_solr_resp_hash|
+      failure_message do |actual_solr_resp_hash|
         "expected more than #{actual_solr_resp_hash.size} documents in Solr response #{expected_solr_resp_hash.num_docs_partial_output_str}"
       end
 
-      failure_message_for_should_not do |actual_solr_resp_hash|
+      failure_message_when_negated do |actual_solr_resp_hash|
         "expected #{actual_solr_resp_hash.size} or fewer documents in Solr response #{expected_solr_resp_hash.num_docs_partial_output_str}"
-      end 
+      end
 
       diffable
-    }
+    end
   end
-  
+
+  # @!method have_fewer_results_than
   # Determine if the receiver (a Solr response object) has fewer total documents than 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_fewer_results_than, &fewer_results_than_body
 
+  # @!method have_fewer_documents_than
   # Determine if the receiver (a Solr response object) has fewer total documents than 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_fewer_documents_than, &fewer_results_than_body
 
-  # this is the lambda used to determine if the receiver (a Solr response object) has more total documents 
+  # this is the lambda used to determine if the receiver (a Solr response object) has more total documents
   #  than the expected RSpecSolr::SolrResponseHash
   def self.more_results_than_body
-    lambda { |expected_solr_resp_hash|
+    lambda do |expected_solr_resp_hash|
       match do |actual_solr_resp_hash|
         actual_solr_resp_hash.size > expected_solr_resp_hash.size
       end
 
-      failure_message_for_should do |actual_solr_resp_hash|
+      failure_message do |actual_solr_resp_hash|
         "expected fewer than #{actual_solr_resp_hash.size} documents in Solr response #{expected_solr_resp_hash.num_docs_partial_output_str}"
       end
 
-      failure_message_for_should_not do |actual_solr_resp_hash|
+      failure_message_when_negated do |actual_solr_resp_hash|
         "expected #{actual_solr_resp_hash.size} or more documents in Solr response #{expected_solr_resp_hash.num_docs_partial_output_str}"
-      end 
+      end
 
       diffable
-    }
+    end
   end
 
+  # @!method have_more_results_than
   # Determine if the receiver (a Solr response object) has more total documents than 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_more_results_than, &more_results_than_body
 
+  # @!method have_more_documents_than
   # Determine if the receiver (a Solr response object) has more total documents than 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_more_documents_than, &more_results_than_body
-
-end
+end