blacklight 4.3.0 → 4.4.0

data/spec/helpers/facets_helper_spec.rb

@@ -360,6 +360,14 @@ describe FacetsHelper do
 
   end
 
+  describe "facet_field_in_params?" do
+    it "should check if the facet field is selected in the user params" do
+      helper.stub(:params => { :f => { "some-field" => ["x"]}})
+      expect(helper.facet_field_in_params?("some-field")).to be_true
+      expect(helper.facet_field_in_params?("other-field")).to_not be_true
+    end
+  end
+
   describe "facet_in_params?" do
 
   end

data/spec/lib/blacklight/solr_response/group_response_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe Blacklight::SolrResponse::GroupResponse do
+  
+  let(:response) do
+    create_response(sample_response)
+  end
+
+  let(:group) do
+    response.grouped.select { |x| x.key == "result_group_ssi" }.first
+  end
+
+  describe "groups" do
+    it "should return an array of Groups" do
+      response.grouped.should be_a Array
+
+      expect(group.groups).to have(2).items
+      group.groups.each do |group|
+        expect(group).to be_a Blacklight::SolrResponse::Group
+      end
+    end
+    it "should include a list of SolrDocuments" do
+
+      group.groups.each do |group|
+        group.docs.each do |doc|
+          expect(doc).to be_a SolrDocument
+        end
+      end
+    end
+  end
+  
+  describe "total" do
+    it "should return the ngroups value" do
+      expect(group.total).to eq 3
+    end
+  end
+  
+  describe "facets" do
+    it "should exist in the response object (not testing, we just extend the module)" do
+      expect(group).to respond_to :facets
+    end
+  end
+  
+  describe "rows" do
+    it "should get the rows from the response" do
+      expect(group.rows).to eq 3
+    end
+  end
+
+  describe "group_field" do
+    it "should be the field name for the current group" do
+      expect(group.group_field).to eq "result_group_ssi"
+    end
+  end
+
+  describe "group_limit" do
+    it "should be the number of documents to return for a group" do
+      expect(group.group_limit).to eq 5
+    end
+  end
+end
+
+def create_response(response, params = {})
+  Blacklight::SolrResponse.new(response, params)
+end
+
+def sample_response
+  {"responseHeader" => {"params" =>{"rows" => 3, "group.limit" => 5}},
+   "grouped" => 
+     {'result_group_ssi' => 
+       {'groups' => [{'groupValue'=>"Group 1", 'doclist'=>{'numFound'=>2, 'docs'=>[{:id=>1}]}},
+                     {'groupValue'=>"Group 2", 'doclist'=>{'numFound'=>3, 'docs'=>[{:id=>2}, :id=>3]}}
+                    ],
+        'ngroups' => "3"
+       }
+     }
+  }
+end

data/spec/lib/blacklight/solr_response/group_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe Blacklight::SolrResponse::Group do
+  
+  let(:response) do
+    create_response(sample_response)
+  end
+
+  let(:group) do
+    response.grouped.select { |x| x.key == "result_group_ssi" }.first
+  end
+
+  subject do
+    group.groups.first
+  end
+
+  describe "#doclist" do
+    it "should be the raw list of documents from solr" do
+      expect(subject.doclist).to be_a Hash
+      expect(subject.doclist['docs'].first[:id]).to eq 1
+    end
+  end
+
+  describe "#total" do
+    it "should be the number of results found in a group" do
+      expect(subject.total).to eq 2
+    end
+  end
+
+  describe "#start" do
+    it "should be the offset for the results in the group" do
+      expect(subject.start).to eq 0
+    end
+  end
+
+  describe "#docs" do
+    it "should be a list of SolrDocuments" do
+      subject.docs.each do |doc|
+        expect(doc).to be_a_kind_of SolrDocument
+      end
+    
+      expect(subject.docs.first.id).to eq 1
+    end
+  end
+
+  describe "#field" do
+    it "should be the field the group belongs to" do
+      expect(subject.field).to eq "result_group_ssi"
+    end
+  end
+
+
+end
+
+def create_response(response, params = {})
+  Blacklight::SolrResponse.new(response, params)
+end
+
+def sample_response
+  {"responseHeader" => {"params" =>{"rows" => 3, "group.limit" => 5}},
+   "grouped" => 
+     {'result_group_ssi' => 
+       {'groups' => [{'groupValue'=>"Group 1", 'doclist'=>{'numFound'=>2, 'start' => 0, 'docs'=>[{:id=>1}, {:id => 'x'}]}},
+                     {'groupValue'=>"Group 2", 'doclist'=>{'numFound'=>3, 'docs'=>[{:id=>2}, :id=>3]}}
+                    ],
+        'ngroups' => "3"
+       }
+     }
+  }
+end

data/spec/lib/blacklight_solr_response_spec.rb

@@ -8,21 +8,19 @@ describe Blacklight::SolrResponse do
     Blacklight::SolrResponse.new(raw_response, raw_response['params'])
   end
 
+  let(:r) { create_response }
+
   it 'should create a valid response' do
-    r = create_response
     r.should respond_to(:header)
   end
 
   it 'should have accurate pagination numbers' do
-    r = create_response
     r.rows.should == 11
     r.total.should == 26
     r.start.should == 0
   end
 
   it 'should create a valid response class' do
-    r = create_response
-
     r.should respond_to(:response)
     r.docs.size.should == 11
     r.params[:echoParams].should == 'EXPLICIT'
@@ -31,7 +29,6 @@ describe Blacklight::SolrResponse do
   end
 
   it 'should provide facet helpers' do
-    r = create_response
     r.facets.size.should == 2
 
     field_names = r.facets.collect{|facet|facet.name}
@@ -60,6 +57,15 @@ describe Blacklight::SolrResponse do
 
   end
 
+  it "should provide kaminari pagination helpers" do
+    expect(r.limit_value).to eq(r.rows)
+    expect(r.offset_value).to eq(r.start)
+    expect(r.total_count).to eq(r.total)
+    expect(r.next_page).to eq(r.current_page + 1)
+    expect(r.prev_page).to eq(nil)
+    expect(r).to be_a_kind_of Kaminari::PageScopeMethods
+  end
+
   describe "FacetItem" do
     it "should work with a field,value tuple" do
       item = Blacklight::SolrResponse::Facets::FacetItem.new('value', 15)

data/spec/lib/blacklight_user_spec.rb

@@ -2,76 +2,57 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "Blacklight::User" do
-  class MockUser
-    include Blacklight::User::InstanceMethods
-    attr_accessor :searches
-    attr_accessor :bookmarks
-  end
-
-  class MockBookmark
-    attr_accessor :document_id
 
-    def initialize document_id
-      self.document_id = document_id
-    end
-  end
-
-  before(:each) do
-    @user = MockUser.new
-    @user.searches = []
-    @user.bookmarks = []
-  end
+  subject { User.create! :email => 'xyz@example.com', :password => 'xyz12345' }
 
-  def mock_bookmark doc_id
-    MockBookmark.new doc_id
+  def mock_bookmark document_id
+    Bookmark.new :document_id => document_id
   end
 
   it "should know if it doesn't have bookmarks" do
-    @user.has_bookmarks?.should == false
+    expect(subject).to_not have_bookmarks
   end
 
   it "should know if it has bookmarkss" do
-    @user.bookmarks.push(mock_bookmark(1))
-    @user.bookmarks.push(mock_bookmark(2))
-    @user.has_bookmarks?.should == true
-  end
+    subject.bookmarks << mock_bookmark(1)
+    subject.bookmarks << mock_bookmark(2)
 
-  it "should know if it has a bookmarked document" do
-    @user.bookmarks.push(mock_bookmark(1))
-    @user.should be_document_is_bookmarked(1)
+    expect(subject).to have_bookmarks
   end
 
-  it "should return a bookmark it a document is bookmarked" do
-    @user.bookmarks.push(mock_bookmark(1))
-    @user.existing_bookmark_for(1).should be_a_kind_of(MockBookmark)
+  it "should know if it has a bookmarked document" do
+    subject.bookmarks << mock_bookmark(1)
+    expect(subject.document_is_bookmarked?(1)).to be_true
   end
 
   it "should be able to create bookmarks in batches" do
     @md1 = { :document_id => 1 }
     @md2 = { :document_id => 2 }
     @md3 = { :document_id => 3 }
-    @user.bookmarks.should_receive(:create).with(@md1)
-    @user.bookmarks.should_receive(:create).with(@md2)
-    @user.bookmarks.should_receive(:create).with(@md3)
 
-    @user.documents_to_bookmark= [@md1,@md2,@md3]
+    subject.documents_to_bookmark= [@md1,@md2,@md3]
+    expect(subject.bookmarks).to have(3).bookmarks
+    expect(subject.bookmarked_document_ids).to include("1","2","3")
+
   end
 
   it "should not recreate bookmarks for documents already bookmarked" do
+    subject.bookmarks << mock_bookmark(1)
+
     @md1 = { :document_id => 1 }
-    @user.bookmarks.should_not_receive(:create).with(@md1)
+    subject.bookmarks.should_not_receive(:create).with(@md1)
 
-    @user.bookmarks.push(mock_bookmark(1))
-    @user.documents_to_bookmark=[@md1]
+    subject.bookmarks.push(mock_bookmark(1))
+    subject.documents_to_bookmark=[@md1]
   end
 
   it "should know if it doesn't have a search" do
-    @user.has_searches?.should == false
+    subject.has_searches?.should == false
   end
 
   it "should know if it has a search" do
-    @user.searches.push(1)
-    @user.has_searches?.should == true
+    subject.searches << Search.new
+    subject.has_searches?.should == true
   end
 
 end    

data/spec/lib/solr_helper_spec.rb

@@ -277,6 +277,8 @@ describe 'Blacklight::SolrHelper' do
          config = Blacklight::Configuration.new
 
          config.add_facet_field 'test_field', :sort => 'count'
+         config.add_facet_field 'some-query', :query => {'x' => {:fq => 'some:query' }}, :ex => 'xyz'
+         config.add_facet_field 'some-pivot', :pivot => ['a','b'], :ex => 'xyz'
          config.add_facet_fields_to_solr_request!
 
          config
@@ -291,6 +293,15 @@ describe 'Blacklight::SolrHelper' do
         solr_parameters[:'facet.field'].should include('test_field')
         solr_parameters[:'f.test_field.facet.sort'].should == 'count'
       end
+
+      it "should add facet exclusions" do
+        solr_parameters = { }
+
+        add_facetting_to_solr(solr_parameters, {})
+
+        solr_parameters[:'facet.query'].should include('{!ex=xyz}some:query')
+        solr_parameters[:'facet.pivot'].should include('{!ex=xyz}a,b')
+      end
     end
 
     describe "with a complex parameter environment" do
@@ -379,7 +390,8 @@ describe 'Blacklight::SolrHelper' do
           :key => "custom_author_key",
           :solr_local_parameters => {
             :qf => "$author_qf",
-            :pf => "you'll have \" to escape this"
+            :pf => "you'll have \" to escape this",
+            :pf2 => "$pf2_do_not_escape_or_quote"
           },
           :solr_parameters => {
             :qf => "someField^1000",
@@ -406,6 +418,7 @@ describe 'Blacklight::SolrHelper' do
       it "should include include local params with escaping" do
         @result[:q].should include('qf=$author_qf')
         @result[:q].should include('pf=\'you\\\'ll have \\" to escape this\'')
+        @result[:q].should include('pf2=$pf2_do_not_escape_or_quote')
       end
     end
     
@@ -578,6 +591,40 @@ describe 'Blacklight::SolrHelper' do
       end
     end
 
+    describe "for a query returning a grouped response" do
+      before(:all) do
+        (@solr_response, @document_list) = get_search_results({:q => @all_docs_query}, :group => true, :'group.field' => 'pub_date_sort')
+      end
+
+      it "should have an empty document list" do
+        expect(@document_list).to be_empty
+      end
+
+      it "should return a grouped response" do
+        expect(@solr_response).to be_a_kind_of Blacklight::SolrResponse::GroupResponse
+
+      end
+    end
+
+    describe "for a query returning multiple groups" do
+      before(:all) do
+        (@solr_response, @document_list) = get_search_results({:q => @all_docs_query}, :group => true, :'group.field' => ['pub_date_sort', 'title_sort'])
+      end
+
+      def grouped_key_for_results
+        'title_sort'
+      end
+
+      it "should have an empty document list" do
+        expect(@document_list).to be_empty
+      end
+
+      it "should return a grouped response" do
+        expect(@solr_response).to be_a_kind_of Blacklight::SolrResponse::GroupResponse
+        expect(@solr_response.group_field).to eq "title_sort"
+      end
+    end
+
     describe '#query_solr' do
       it 'should have results' do
         solr_response = query_solr(:q => @single_word_query)
@@ -1044,5 +1091,30 @@ describe 'Blacklight::SolrHelper' do
     Blacklight.solr.stub(:get).and_raise(Errno::ECONNREFUSED)
     expect { find(:a => 123) }.to raise_exception(/Unable to connect to Solr instance/)
   end
+
+  describe "grouped_key_for_results" do
+    let :blacklight_config do
+      Blacklight::Configuration.new
+    end
+
+    it "should pull the grouped key out of the config" do
+      blacklight_config.index.group = 'xyz'
+      expect(self.grouped_key_for_results).to eq('xyz')
+    end 
+  end
+
+  describe "#with_tag_ex" do
+    it "should add an !ex local parameter if the facet configuration requests it" do
+      expect(self.with_ex_local_param("xyz", "some-value")).to eq "{!ex=xyz}some-value"
+    end
+
+    it "should not add an !ex local parameter if it isn't configured" do
+      mock_field = double()
+      expect(self.with_ex_local_param(nil, "some-value")).to eq "some-value"
+    end
+
+
+  end
+
 end
 

data/spec/models/record_mailer_spec.rb

@@ -41,7 +41,7 @@ describe RecordMailer do
   
   describe "SMS" do
     before(:each) do
-      details = {:to => '5555555555', :carrier => 'att'}
+      details = {:to => '5555555555@txt.att.net'}
       @sms = RecordMailer.sms_record(@documents,details,{:host =>'projectblacklight.org:3000'})
     end
     it "should create the correct TO address for the SMS email" do
@@ -56,10 +56,10 @@ describe RecordMailer do
     it "should print out the correct body" do
       @sms.body.should =~ /The horn/
       @sms.body.should =~ /by Janetzky, Kurt/
-      @sms.body.should =~ /projectblacklight.org:300/      
+      @sms.body.should =~ /projectblacklight.org:3000/      
     end
     it "should use https URL when protocol is set" do
-      details = {:to => '5555555555', :carrier => 'att'}
+      details = {:to => '5555555555@txt.att.net'}
       @https_sms = RecordMailer.sms_record(@documents,details,{:host =>'projectblacklight.org', :protocol => 'https'})
       @https_sms.body.should =~ %r|https://projectblacklight.org/|
     end