rspec-solr 1.0.1 → 2.0.0

data/spec/number_of_documents_spec.rb

@@ -2,157 +2,154 @@ require 'spec_helper'
 require 'rspec-solr'
 
 describe RSpecSolr do
-
   context "shouldn't break RSpec #have matcher" do
-    it "for Array" do
-      [1,2,3].should have(3).items
-      [1,2,3].should_not have(4).items
-      [1,2,3].should have_at_least(2).items
-      [1,2,3].should have_at_least(1).item
-      [1,2,3].should have_at_most(5).items
-    end
-    
-    it "for Hash" do
-      {:k1 => 'v1', :k2 => 'v2', :k3 => 'v3'}.should have_exactly(3).items
-      {:k1 => 'v1', :k2 => 'v2', :k3 => 'v3'}.should_not have(4).items
-      {:k1 => 'v1', :k2 => 'v2', :k3 => 'v3'}.should have_at_least(2).items
-      {:k1 => 'v1', :k2 => 'v2', :k3 => 'v3'}.should have_at_most(5).items
-    end
-    
-    it "for String" do
-      "this string".should have(11).characters
-      "this string".should_not have(12).characters
-    end
-    
-    it "passes args to target" do
-      target = mock("target")
-      target.should_receive(:items).with("arg1","arg2").and_return([1,2,3])
-      target.should have(3).items("arg1","arg2")
-    end
-    it "passes block to target" do
-          target = mock("target")
-          block = lambda { 5 }
-          target.should_receive(:items).with("arg1","arg2", block).and_return([1,2,3])
-          target.should have(3).items("arg1","arg2", block)
+    it 'for Array' do
+      expect([1, 2, 3]).to have(3).items
+      expect([1, 2, 3]).not_to have(4).items
+      expect([1, 2, 3]).to have_at_least(2).items
+      expect([1, 2, 3]).to have_at_least(1).item
+      expect([1, 2, 3]).to have_at_most(5).items
+    end
+
+    it 'for Hash' do
+      expect(k1: 'v1', k2: 'v2', k3: 'v3').to have_exactly(3).items
+      expect(k1: 'v1', k2: 'v2', k3: 'v3').not_to have(4).items
+      expect(k1: 'v1', k2: 'v2', k3: 'v3').to have_at_least(2).items
+      expect(k1: 'v1', k2: 'v2', k3: 'v3').to have_at_most(5).items
+    end
+
+    it 'for String' do
+      expect('this string').to have(11).characters
+      expect('this string').not_to have(12).characters
+    end
+
+    it 'passes args to target' do
+      target = double('target')
+      expect(target).to receive(:items).with('arg1', 'arg2').and_return([1, 2, 3])
+      expect(target).to have(3).items('arg1', 'arg2')
+    end
+    it 'passes block to target' do
+      target = double('target')
+      block = -> { 5 }
+      expect(target).to receive(:items).with('arg1', 'arg2', block).and_return([1, 2, 3])
+      expect(target).to have(3).items('arg1', 'arg2', block)
     end
   end
-  
+
   # fixtures at end of this file
 
-  context "should have(n).documents" do
-    
+  context 'should have(n).documents' do
     it "pluralizes 'documents'" do
-      @solr_resp_1_doc.should have(1).document
-    end
-    
-    it "passes if target response has n documents" do
-      @solr_resp_5_docs.should have(5).documents
-      @solr_resp_no_docs.should have(0).documents
-    end
-    
-    it "converts :no to 0" do
-      @solr_resp_no_docs.should have(:no).documents
-    end
-    
-    it "converts a String argument to Integer" do
-      @solr_resp_5_docs.should have('5').documents
-    end
-    
-    it "fails if target response has < n documents" do
-      lambda {
-        @solr_resp_5_docs.should have(6).documents
-      }.should fail_with("expected 6 documents, got 5")
-      lambda {
-        @solr_resp_no_docs.should have(1).document
-      }.should fail_with("expected 1 document, got 0")
-    end
-    
-    it "fails if target response has > n documents" do
-      lambda {
-        @solr_resp_5_docs.should have(4).documents
-      }.should fail_with("expected 4 documents, got 5")
-      lambda {
-        @solr_resp_1_doc.should have(0).documents
-      }.should fail_with("expected 0 documents, got 1")
-    end
-    
+      expect(@solr_resp_1_doc).to have(1).document
+    end
+
+    it 'passes if target response has n documents' do
+      expect(@solr_resp_5_docs).to have(5).documents
+      expect(@solr_resp_no_docs).to have(0).documents
+    end
+
+    it 'converts :no to 0' do
+      expect(@solr_resp_no_docs).to have(:no).documents
+    end
+
+    it 'converts a String argument to Integer' do
+      expect(@solr_resp_5_docs).to have('5').documents
+    end
+
+    it 'fails if target response has < n documents' do
+      expect do
+        expect(@solr_resp_5_docs).to have(6).documents
+      end.to raise_error.with_message 'expected 6 documents, got 5'
+      expect do
+        expect(@solr_resp_no_docs).to have(1).document
+      end.to raise_error.with_message 'expected 1 document, got 0'
+    end
+
+    it 'fails if target response has > n documents' do
+      expect do
+        expect(@solr_resp_5_docs).to have(4).documents
+      end.to raise_error.with_message 'expected 4 documents, got 5'
+      expect do
+        expect(@solr_resp_1_doc).to have(0).documents
+      end.to raise_error.with_message 'expected 0 documents, got 1'
+    end
   end
-  
-  context "should_not have(n).documents" do
-    it "passes if target response has < n documents" do
-      @solr_resp_5_docs.should_not have(6).documents
-      @solr_resp_1_doc.should_not have(2).documents
-      @solr_resp_no_docs.should_not have(1).document
-    end
-    
-    it "passes if target response has > n documents" do
-      @solr_resp_5_docs.should_not have(4).documents
-      @solr_resp_1_doc.should_not have(0).documents
-      @solr_resp_no_docs.should_not have(-1).documents
-    end
-    
-    it "fails if target response has n documents" do
-      lambda {
-        @solr_resp_5_docs.should_not have(5).documents
-      }.should fail_with("expected target not to have 5 documents, got 5")
+
+  context 'should_not have(n).documents' do
+    it 'passes if target response has < n documents' do
+      expect(@solr_resp_5_docs).not_to have(6).documents
+      expect(@solr_resp_1_doc).not_to have(2).documents
+      expect(@solr_resp_no_docs).not_to have(1).document
+    end
+
+    it 'passes if target response has > n documents' do
+      expect(@solr_resp_5_docs).not_to have(4).documents
+      expect(@solr_resp_1_doc).not_to have(0).documents
+      expect(@solr_resp_no_docs).not_to have(-1).documents
+    end
+
+    it 'fails if target response has n documents' do
+      expect do
+        expect(@solr_resp_5_docs).not_to have(5).documents
+      end.to raise_error.with_message 'expected target not to have 5 documents, got 5'
     end
   end
-  
-  context "should have_exactly(n).documents" do
-    it "passes if target response has n documents" do
-      @solr_resp_5_docs.should have_exactly(5).documents
-      @solr_resp_no_docs.should have_exactly(0).documents
-    end
-    it "converts :no to 0" do
-      @solr_resp_no_docs.should have_exactly(:no).documents
-    end
-    it "fails if target response has < n documents" do
-      lambda {
-        @solr_resp_5_docs.should have_exactly(6).documents
-      }.should fail_with("expected 6 documents, got 5")
-      lambda {
-        @solr_resp_no_docs.should have_exactly(1).document
-      }.should fail_with("expected 1 document, got 0")
-    end
-    
-    it "fails if target response has > n documents" do
-      lambda {
-        @solr_resp_5_docs.should have_exactly(4).documents
-      }.should fail_with("expected 4 documents, got 5")
-      lambda {
-        @solr_resp_1_doc.should have_exactly(0).documents
-      }.should fail_with("expected 0 documents, got 1")
+
+  context 'should have_exactly(n).documents' do
+    it 'passes if target response has n documents' do
+      expect(@solr_resp_5_docs).to have_exactly(5).documents
+      expect(@solr_resp_no_docs).to have_exactly(0).documents
+    end
+    it 'converts :no to 0' do
+      expect(@solr_resp_no_docs).to have_exactly(:no).documents
+    end
+    it 'fails if target response has < n documents' do
+      expect do
+        expect(@solr_resp_5_docs).to have_exactly(6).documents
+      end.to raise_error.with_message 'expected 6 documents, got 5'
+      expect do
+        expect(@solr_resp_no_docs).to have_exactly(1).document
+      end.to raise_error.with_message 'expected 1 document, got 0'
+    end
+
+    it 'fails if target response has > n documents' do
+      expect do
+        expect(@solr_resp_5_docs).to have_exactly(4).documents
+      end.to raise_error.with_message 'expected 4 documents, got 5'
+      expect do
+        expect(@solr_resp_1_doc).to have_exactly(0).documents
+      end.to raise_error.with_message 'expected 0 documents, got 1'
     end
   end
-  
-  context "should have_at_least(n).documents" do
-    it "passes if target response has n documents" do
-      @solr_resp_5_docs.should have_at_least(5).documents
-      @solr_resp_1_doc.should have_at_least(1).document
-      @solr_resp_no_docs.should have_at_least(0).documents
-    end
-    
-    it "passes if target response has > n documents" do
-      @solr_resp_5_docs.should have_at_least(4).documents
-      @solr_resp_1_doc.should have_at_least(0).documents
-    end
-    
-    it "fails if target response has < n documents" do
-      lambda {
-        @solr_resp_5_docs.should have_at_least(6).documents
-      }.should fail_matching("expected at least 6 documents, got 5")
-      lambda {
-        @solr_resp_no_docs.should have_at_least(1).document
-      }.should fail_matching("expected at least 1 document, got 0")
-    end
-    
-    it "provides educational negative failure messages" do
+
+  context 'should have_at_least(n).documents' do
+    it 'passes if target response has n documents' do
+      expect(@solr_resp_5_docs).to have_at_least(5).documents
+      expect(@solr_resp_1_doc).to have_at_least(1).document
+      expect(@solr_resp_no_docs).to have_at_least(0).documents
+    end
+
+    it 'passes if target response has > n documents' do
+      expect(@solr_resp_5_docs).to have_at_least(4).documents
+      expect(@solr_resp_1_doc).to have_at_least(0).documents
+    end
+
+    it 'fails if target response has < n documents' do
+      expect do
+        expect(@solr_resp_5_docs).to have_at_least(6).documents
+      end.to raise_error.with_message 'expected at least 6 documents, got 5'
+      expect do
+        expect(@solr_resp_no_docs).to have_at_least(1).document
+      end.to raise_error.with_message 'expected at least 1 document, got 0'
+    end
+
+    it 'provides educational negative failure messages' do
       # given
       my_matcher = have_at_least(6).documents
       # when
       my_matcher.matches?(@solr_resp_5_docs)
-      # then 
-      my_matcher.failure_message_for_should_not.should eq <<-EOF
+      # then
+      expect(my_matcher.failure_message_for_should_not).to eq <<-EOF
 Isn't life confusing enough?
 Instead of having to figure out the meaning of this:
   expect(actual).not_to have_at_least(6).documents
@@ -161,35 +158,35 @@ We recommend that you use this instead:
 EOF
     end
   end
-    
-  context "should have_at_most(n).documents" do
-    it "passes if target response has n documents" do
-      @solr_resp_5_docs.should have_at_most(5).documents
-      @solr_resp_1_doc.should have_at_most(1).document
-      @solr_resp_no_docs.should have_at_most(0).documents
+
+  context 'should have_at_most(n).documents' do
+    it 'passes if target response has n documents' do
+      expect(@solr_resp_5_docs).to have_at_most(5).documents
+      expect(@solr_resp_1_doc).to have_at_most(1).document
+      expect(@solr_resp_no_docs).to have_at_most(0).documents
     end
 
-    it "passes if target response has < n documents" do
-      @solr_resp_5_docs.should have_at_most(6).documents
-      @solr_resp_no_docs.should have_at_most(1).document
+    it 'passes if target response has < n documents' do
+      expect(@solr_resp_5_docs).to have_at_most(6).documents
+      expect(@solr_resp_no_docs).to have_at_most(1).document
     end
 
-    it "fails if target response has > n documents" do
-      lambda {
-        @solr_resp_5_docs.should have_at_most(4).documents
-      }.should fail_matching("expected at most 4 documents, got 5")
-      lambda {
-        @solr_resp_1_doc.should have_at_most(0).documents
-      }.should fail_matching("expected at most 0 documents, got 1")
+    it 'fails if target response has > n documents' do
+      expect do
+        expect(@solr_resp_5_docs).to have_at_most(4).documents
+      end.to raise_error.with_message 'expected at most 4 documents, got 5'
+      expect do
+        expect(@solr_resp_1_doc).to have_at_most(0).documents
+      end.to raise_error.with_message 'expected at most 0 documents, got 1'
     end
 
-    it "provides educational negative failure messages" do
+    it 'provides educational negative failure messages' do
       # given
       my_matcher = have_at_most(4).documents
       # when
       my_matcher.matches?(@solr_resp_5_docs)
-      # then 
-      my_matcher.failure_message_for_should_not.should eq <<-EOF
+      # then
+      expect(my_matcher.failure_message_for_should_not).to eq <<-EOF
 Isn't life confusing enough?
 Instead of having to figure out the meaning of this:
   expect(actual).not_to have_at_most(4).documents
@@ -198,53 +195,47 @@ We recommend that you use this instead:
 EOF
     end
   end
-  
-  it "should pass according to total Solr docs matching the query, not the number of docs in THIS response" do
-    solr_resp = RSpecSolr::SolrResponseHash.new({ "response" =>
-                          { "numFound" => 3, 
-                            "start" => 0, 
-                            "rows" => 1,
-                            "docs" => [ {"id"=>"111"} ]
-                          }
-                        })
-    solr_resp.should have(3).documents
-    solr_resp.should_not have(1).document
-    solr_resp = RSpecSolr::SolrResponseHash.new({ "response" =>
-                          { "numFound" => 3, 
-                            "start" => 0, 
-                            "rows" => 0 
-                          }
-                        })
-    solr_resp.should have(3).documents
+
+  it 'should pass according to total Solr docs matching the query, not the number of docs in THIS response' do
+    solr_resp = RSpecSolr::SolrResponseHash.new('response' =>
+                          { 'numFound' => 3,
+                            'start' => 0,
+                            'rows' => 1,
+                            'docs' => [{ 'id' => '111' }]
+                          })
+    expect(solr_resp).to have(3).documents
+    expect(solr_resp).not_to have(1).document
+    solr_resp = RSpecSolr::SolrResponseHash.new('response' =>
+                          { 'numFound' => 3,
+                            'start' => 0,
+                            'rows' => 0
+                          })
+    expect(solr_resp).to have(3).documents
   end
-  
+
   before(:all) do
-    @solr_resp_1_doc = RSpecSolr::SolrResponseHash.new({ "response" =>
-                          { "numFound" => 1, 
-                            "start" => 0, 
-                            "docs" => [ {"id"=>"111"} ]
-                          }
-                        })
-
-    @solr_resp_5_docs = RSpecSolr::SolrResponseHash.new({ "response" =>
-                          { "numFound" => 5, 
-                            "start" => 0, 
-                            "docs" => 
-                              [ {"id"=>"111"}, 
-                                {"id"=>"222"}, 
-                                {"id"=>"333"}, 
-                                {"id"=>"444"}, 
-                                {"id"=>"555"}
+    @solr_resp_1_doc = RSpecSolr::SolrResponseHash.new('response' =>
+                          { 'numFound' => 1,
+                            'start' => 0,
+                            'docs' => [{ 'id' => '111' }]
+                          })
+
+    @solr_resp_5_docs = RSpecSolr::SolrResponseHash.new('response' =>
+                          { 'numFound' => 5,
+                            'start' => 0,
+                            'docs' =>
+                              [{ 'id' => '111' },
+                               { 'id' => '222' },
+                               { 'id' => '333' },
+                               { 'id' => '444' },
+                               { 'id' => '555' }
                               ]
-                          }
-                        })
-
-    @solr_resp_no_docs = RSpecSolr::SolrResponseHash.new({ "response" =>
-                          { "numFound" => 0, 
-                            "start" => 0, 
-                            "docs" => [] 
-                          }
-                        }) 
+                          })
+
+    @solr_resp_no_docs = RSpecSolr::SolrResponseHash.new('response' =>
+                          { 'numFound' => 0,
+                            'start' => 0,
+                            'docs' => []
+                          })
   end
-  
-end
+end

data/spec/solr_response_hash_spec.rb

@@ -2,114 +2,107 @@ require 'spec_helper'
 require 'rspec-solr'
 
 describe RSpecSolr::SolrResponseHash do
-  
-  context "id field" do
+  context 'id field' do
     before(:all) do
-      @srh = RSpecSolr::SolrResponseHash.new({ "response" =>
-                            { "docs" => 
-                                [ {"id"=>"111"}, 
-                                  {"not_id"=>"222"}, 
-                                  {"id"=>"333"}, 
+      @srh = RSpecSolr::SolrResponseHash.new('response' =>
+                            { 'docs' =>
+                                [{ 'id' => '111' },
+                                 { 'not_id' => '222' },
+                                 { 'id' => '333' }
                                 ]
-                            }
-                          })
+                            })
     end
     it "should default to 'id'" do
-      RSpecSolr::SolrResponseHash.new({}).id_field.should == "id"
-      @srh.id_field.should == "id"
+      expect(RSpecSolr::SolrResponseHash.new({}).id_field).to eq('id')
+      expect(@srh.id_field).to eq('id')
     end
-    it "should be changable to whatever" do
-      @srh.id_field='new'
-      @srh.id_field.should == 'new'
-      @srh.id_field='newer'
-      @srh.id_field.should == 'newer'
+    it 'should be changable to whatever' do
+      @srh.id_field = 'new'
+      expect(@srh.id_field).to eq('new')
+      @srh.id_field = 'newer'
+      expect(@srh.id_field).to eq('newer')
     end
   end
-  
+
   # fixture below
-  
-  context "has_document?" do
-    it "should be true when single document meets expectation" do
-      @solr_resp_5_docs.should have_document({"id" => "222"})
-      @solr_resp_5_docs.should have_document({"id" => "111", "fld" => "val"})
-    end
-    
-    it "should be true when at least one doc meets expectation" do
-      @solr_resp_5_docs.should have_document({"fld" => "val"})
-    end
-    
-    it "should be false when no docs meet expectation" do
-      @solr_resp_5_docs.should_not have_document({"id" => "not_there"})
-    end
-    
-    it "should be false when only part of expectation is met" do
-      @solr_resp_5_docs.should_not have_document({"id" => "222", "fld" => "val"})
-    end  
-    
-    it "should be true when document is < =  expected position in results" do
-      @solr_resp_5_docs.should have_document({"id" => "222"}, 2)
-    end
-    
-    it "should be false when document is > expected position in results" do
-      @solr_resp_5_docs.should_not have_document({"id" => "222"}, 1)
-    end
-     
+
+  context 'has_document?' do
+    it 'should be true when single document meets expectation' do
+      expect(@solr_resp_5_docs).to have_document('id' => '222')
+      expect(@solr_resp_5_docs).to have_document('id' => '111', 'fld' => 'val')
+    end
+
+    it 'should be true when at least one doc meets expectation' do
+      expect(@solr_resp_5_docs).to have_document('fld' => 'val')
+    end
+
+    it 'should be false when no docs meet expectation' do
+      expect(@solr_resp_5_docs).not_to have_document('id' => 'not_there')
+    end
+
+    it 'should be false when only part of expectation is met' do
+      expect(@solr_resp_5_docs).not_to have_document('id' => '222', 'fld' => 'val')
+    end
+
+    it 'should be true when document is < =  expected position in results' do
+      expect(@solr_resp_5_docs).to have_document({ 'id' => '222' }, 2)
+    end
+
+    it 'should be false when document is > expected position in results' do
+      expect(@solr_resp_5_docs).not_to have_document({ 'id' => '222' }, 1)
+    end
   end  # has_document?
-  
-  context "get_first_doc_index" do
-    it "should get the right document index with an id String argument" do
-      @solr_resp_5_docs.get_first_doc_index("333").should == 2
-      @solr_resp_5_docs.get_first_doc_index("111").should == 0
-    end
-    
-    it "should get the first occurrence of a doc meeting a Hash argument" do
-      @solr_resp_5_docs.get_first_doc_index("fld"=>"val").should == 0
-      @solr_resp_5_docs.get_first_doc_index("id"=>"333").should == 2
-    end
-    
-    it "should get the index of the doc occurring first in the results from an Array argument" do
-      @solr_resp_5_docs.get_first_doc_index(["fld"=>"val"]).should == 0
-      @solr_resp_5_docs.get_first_doc_index(["222", "444"]).should == 1
-    end
-    
+
+  context 'get_first_doc_index' do
+    it 'should get the right document index with an id String argument' do
+      expect(@solr_resp_5_docs.get_first_doc_index('333')).to eq(2)
+      expect(@solr_resp_5_docs.get_first_doc_index('111')).to eq(0)
+    end
+
+    it 'should get the first occurrence of a doc meeting a Hash argument' do
+      expect(@solr_resp_5_docs.get_first_doc_index('fld' => 'val')).to eq(0)
+      expect(@solr_resp_5_docs.get_first_doc_index('id' => '333')).to eq(2)
+    end
+
+    it 'should get the index of the doc occurring first in the results from an Array argument' do
+      expect(@solr_resp_5_docs.get_first_doc_index(['fld' => 'val'])).to eq(0)
+      expect(@solr_resp_5_docs.get_first_doc_index(%w(222 444))).to eq(1)
+    end
+
     it "should return nil when the expectation argument isn't met" do
-      @solr_resp_5_docs.get_first_doc_index("666").should be_nil
-      @solr_resp_5_docs.get_first_doc_index("not_there"=>"not_there").should be_nil
-      @solr_resp_5_docs.get_first_doc_index(["222", "666"]).should be_nil
+      expect(@solr_resp_5_docs.get_first_doc_index('666')).to be_nil
+      expect(@solr_resp_5_docs.get_first_doc_index('not_there' => 'not_there')).to be_nil
+      expect(@solr_resp_5_docs.get_first_doc_index(%w(222 666))).to be_nil
     end
-    
   end
-  
-  context "get_min_index" do    
-    it "should return nil when both arguments are nil" do
-      @solr_resp_5_docs.send(:get_min_index, nil, nil).should be_nil
+
+  context 'get_min_index' do
+    it 'should return nil when both arguments are nil' do
+      expect(@solr_resp_5_docs.send(:get_min_index, nil, nil)).to be_nil
     end
-    it "should return the first argument when the second argument is nil" do
-      @solr_resp_5_docs.send(:get_min_index, 3, nil).should == 3
+    it 'should return the first argument when the second argument is nil' do
+      expect(@solr_resp_5_docs.send(:get_min_index, 3, nil)).to eq(3)
     end
-    it "should return the second argument when the first argument is nil" do
-      @solr_resp_5_docs.send(:get_min_index, nil, 5).should == 5
+    it 'should return the second argument when the first argument is nil' do
+      expect(@solr_resp_5_docs.send(:get_min_index, nil, 5)).to eq(5)
+    end
+    it 'should return the minimum of the two arguments when neither of them is nil' do
+      expect(@solr_resp_5_docs.send(:get_min_index, 2, 5)).to eq(2)
+      expect(@solr_resp_5_docs.send(:get_min_index, 5, 2)).to eq(2)
     end
-    it "should return the minimum of the two arguments when neither of them is nil" do
-      @solr_resp_5_docs.send(:get_min_index, 2, 5).should == 2
-      @solr_resp_5_docs.send(:get_min_index, 5, 2).should == 2
-    end    
   end
-  
-  
+
   before(:all) do
-    @solr_resp_5_docs = RSpecSolr::SolrResponseHash.new({ "response" =>
-                          { "numFound" => 5, 
-                            "start" => 0, 
-                            "docs" => 
-                              [ {"id"=>"111", "fld"=>"val"}, 
-                                {"id"=>"222"}, 
-                                {"id"=>"333", "fld"=>"val"}, 
-                                {"id"=>"444"}, 
-                                {"id"=>"555"}
+    @solr_resp_5_docs = RSpecSolr::SolrResponseHash.new('response' =>
+                          { 'numFound' => 5,
+                            'start' => 0,
+                            'docs' =>
+                              [{ 'id' => '111', 'fld' => 'val' },
+                               { 'id' => '222' },
+                               { 'id' => '333', 'fld' => 'val' },
+                               { 'id' => '444' },
+                               { 'id' => '555' }
                               ]
-                          }
-                        })
+                          })
   end
-  
-end
+end