blacklight 4.3.0 → 4.4.0

data/spec/features/search_pagination_spec.rb

@@ -0,0 +1,91 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe "Search Pagination" do
+  it "should have results with pagination" do
+    visit root_path
+    fill_in "q", with: ''
+    click_button 'search'
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "1 - 10 of "
+      within '#per_page-dropdown' do
+        expect(page).to have_link('10')
+        expect(page).to have_link('20')
+        expect(page).to have_link('50')
+        expect(page).to have_link('100')
+      end
+
+    end
+    click_link "Next »"
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "11 - 20 of "
+    end
+    click_link "« Previous"
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "1 - 10 of "
+    end
+  end
+
+  it "should be able to change the number of items per page" do
+    visit root_path
+    fill_in "q", with: ''
+    click_button 'search'
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "1 - 10 of "
+    end
+
+    within ("#per_page-dropdown") do
+      click_link '20'
+    end
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "1 - 20 of "
+    end
+  end
+
+  describe "when the application is configured for other per page values" do
+    let!(:original_per_page) { CatalogController.blacklight_config[:per_page] }
+    let!(:original_rows) { CatalogController.blacklight_config[:default_solr_params][:rows] }
+    before do
+      CatalogController.blacklight_config[:per_page] = [15, 30]
+      CatalogController.blacklight_config[:default_solr_params][:rows] = 15
+    end
+    after do
+      CatalogController.blacklight_config[:per_page] = original_per_page
+      CatalogController.blacklight_config[:default_solr_params][:rows] = original_rows
+    end
+    it "should use the configured values" do
+      visit root_path
+      fill_in "q", with: ''
+      click_button 'search'
+      within ("#sortAndPerPage") do
+        expect(page).to have_content "1 - 15 of "
+        within '#per_page-dropdown' do
+          expect(page).to have_link('15')
+          expect(page).to have_link('30')
+        end
+      end
+      within ("#per_page-dropdown") do
+        click_link '30'
+      end
+      within ("#sortAndPerPage") do
+        expect(page).to have_content "1 - 30 of "
+      end
+    end
+  end
+
+  it "should reset the page offset to 1 when changing per page" do
+    visit root_path
+    fill_in "q", with: ''
+    click_button 'search'
+    click_link "Next »"
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "11 - 20 of "
+    end
+    within ("#per_page-dropdown") do
+      click_link '20'
+    end
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "1 - 20 of "
+    end
+  end
+end

data/spec/features/search_results_spec.rb

@@ -0,0 +1,68 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe "Search Results" do
+  it "should have for an empty query" do
+    visit root_path
+    click_button 'search'
+    number_of_results_from_page(page).should == 30
+    page.should have_xpath("//a[contains(@href, #{2007020969})]")
+    fill_in "q", with: 'korea'
+    click_button 'search'
+    number_of_results_from_page(page).should == 4
+  end
+
+  it "should find same result set with or without diacritcs" do
+    visit root_path
+    fill_in "q", with: 'inmul'
+    click_button 'search'
+    number_of_results_from_page(page).should == 1
+    page.should have_xpath("//a[contains(@href, #{77826928})]")
+
+    fill_in "q", with: 'inmül'
+    click_button 'search'
+    number_of_results_from_page(page).should == 1
+  end
+  it "should find same result set for a case-insensitive query " do
+    visit root_path
+    fill_in "q", with: 'inmul'
+    click_button 'search'
+    number_of_results_from_page(page).should == 1
+    page.should have_xpath("//a[contains(@href, #{77826928})]")
+
+    fill_in "q", with: 'INMUL'
+    click_button 'search'
+    number_of_results_from_page(page).should == 1
+  end
+
+  it "should order by relevancy" do
+    visit root_path
+    fill_in "q", with: 'Korea'
+    click_button 'search'
+    position_in_result_page(page, '77826928').should == 1
+    position_in_result_page(page, '94120425').should == 2
+    
+  end
+
+end
+
+
+
+def position_in_result_page(page, id)
+  i = -1
+  page.all(".index_title a").each_with_index do |link, idx|
+    i = (idx+1) if link['href'] =~ Regexp.new(Regexp.escape(id) + "$")
+  end
+  i.to_i
+end
+        
+def number_of_results_for_query(query)
+  visit root_path
+  fill_in "q", :with => query
+  click_button "search"
+  get_number_of_results_from_page(page)
+end
+
+def number_of_results_from_page(page)
+  page.find("meta[name=totalResults]")['content'].to_i rescue 0
+end

data/spec/features/search_sort_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "Search Sort" do
+  it "should sort on facet results with no search terms" do
+    visit root_path
+    click_link 'English'
+    expect(page).to have_content 'Sort by relevance'
+    click_link 'title'
+    expect(page).to have_content 'Sort by title'
+  end
+
+  it "should sort on search" do
+    visit root_path
+    fill_in "q", with: 'bod'
+    click_button 'search'
+    expect(page).to have_content 'Sort by relevance'
+    click_link 'title'
+    expect(page).to have_content 'Sort by title'
+  end
+end

data/spec/features/search_spec.rb

@@ -0,0 +1,108 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe "Search Page" do
+  it "should show welcome" do
+    visit root_path
+    expect(page).to have_selector("input#q")
+    within ("select#search_field") do
+      expect(page).to have_selector('option', text: 'All Fields')
+      expect(page).to have_selector('option', text: 'Title')
+      expect(page).to have_selector('option', text: 'Author')
+      expect(page).to have_selector('option', text: 'Subject')
+    end
+    expect(page).to have_selector("button[type='submit'] .submit-search-text")
+    expect(page).to_not have_selector("#startOverLink")
+   
+    expect(page).to have_content "Welcome!"
+    expect(page).to have_selector("link[rel=stylesheet]")
+  end
+
+  it "should do searches across all fields" do
+    visit root_path
+    fill_in "q", with: 'history'
+    select 'All Fields', from: 'search_field'
+    click_button 'search'
+   
+    expect(page).to have_selector("link[rel=alternate][type='application/rss+xml']")
+    expect(page).to have_selector("link[rel=alternate][type='application/atom+xml']")
+
+    # opensearch
+    expect(page).to have_selector("meta[name=totalResults]")
+    expect(page).to have_selector("meta[name=startIndex]")
+    expect(page).to have_selector("meta[name=itemsPerPage]")
+
+    within "#appliedParams" do
+      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "history"
+    end
+
+    within ("select#search_field") do
+      expect(page).to have_selector("option[selected]", text: "All Fields")
+    end
+
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "Sort by"
+      expect(page).to have_content "1 - 9 of 9"
+      within '#sort-dropdown' do
+        expect(page).to have_link('relevance')
+        expect(page).to have_link('year')
+        expect(page).to have_link('author')
+        expect(page).to have_link('title')
+      end
+    end
+    within "#documents" do
+      expect(page).to have_selector(".document", count: 9)
+    end
+  end
+
+  it "should do searches constrained to a single field" do
+    visit root_path
+    fill_in "q", with: 'inmul'
+    select 'Title', from: 'search_field'
+    click_button 'search'
+
+    within "#appliedParams" do
+      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "Title"
+      expect(page).to have_content "inmul"
+    end
+    within ("select#search_field") do
+      expect(page).to have_selector("option[selected]", text: "Title")
+    end
+    within(".index_title") do
+      expect(page).to have_content "1."
+    end
+    within ("#sortAndPerPage") do
+      expect(page).to have_content "1 to 1 of 1"
+    end
+  end
+
+  it "should show vernacular (Linked 880) and call number" do
+    visit root_path
+    fill_in "q", with: 'history'
+    click_button 'search'
+    within "#documents" do
+      expect(page).to have_content "次按驟變"
+      expect(page).to have_content "DK861.K3 V5"
+    end
+  end
+
+  it "should allow you to clear the search" do
+    visit root_path
+    fill_in "q", with: 'history'
+    click_button 'search'
+    within "#appliedParams" do
+      expect(page).to have_content "You searched for:"
+      expect(page).to have_content "history"
+    end
+
+    expect(page).to have_selector "#q[value='history']"
+
+    click_link "Start Over"
+
+    expect(page).to have_content "Welcome!"
+    expect(page).to_not have_selector "#q[value='history']"
+  end
+end
+

data/spec/helpers/blacklight_helper_spec.rb

@@ -165,9 +165,9 @@ describe BlacklightHelper do
     end
 
     it "should not return blacklisted elements" do
-      source_params = { :action => 'action', :controller => 'controller', :commit => 'commit'}
+      source_params = { :action => 'action', :controller => 'controller', :id => "id", :commit => 'commit'}
       result = params_for_search(:params => source_params )
-      result.keys.should_not include(:action, :controller, :commit)
+      result.keys.should_not include(:action, :controller, :commit, :id)
 
     end
 
@@ -479,6 +479,8 @@ describe BlacklightHelper do
       @config = Blacklight::Configuration.new.configure do |config|
         config.add_index_field 'qwer'
         config.add_index_field 'asdf', :helper_method => :render_asdf_index_field
+        config.add_index_field 'link_to_search_true', :link_to_search => true
+        config.add_index_field 'link_to_search_named', :link_to_search => :some_field
         config.add_index_field 'highlight', :highlight => true
       end
       helper.stub(:blacklight_config).and_return(@config)
@@ -499,6 +501,20 @@ describe BlacklightHelper do
       value.should == 'custom asdf value'
     end
 
+    it "should check for a link_to_search" do
+      doc = double()
+      doc.should_receive(:get).with('link_to_search_true', :sep => nil).and_return('x')
+      value = helper.render_index_field_value :document => doc, :field => 'link_to_search_true'
+      value.should == helper.link_to("x", helper.search_action_url(:f => { :link_to_search_true => ['x'] }))
+    end
+
+    it "should check for a link_to_search with a field name" do
+      doc = double()
+      doc.should_receive(:get).with('link_to_search_named', :sep => nil).and_return('x')
+      value = helper.render_index_field_value :document => doc, :field => 'link_to_search_named'
+      value.should == helper.link_to("x", helper.search_action_url(:f => { :some_field => ['x'] }))
+    end
+
     it "should gracefully handle when no highlight field is available" do
       doc = double()
       doc.should_not_receive(:get)
@@ -537,6 +553,8 @@ describe BlacklightHelper do
       @config = Blacklight::Configuration.new.configure do |config|
         config.add_show_field 'qwer'
         config.add_show_field 'asdf', :helper_method => :render_asdf_document_show_field
+        config.add_show_field 'link_to_search_true', :link_to_search => true
+        config.add_show_field 'link_to_search_named', :link_to_search => :some_field
         config.add_show_field 'highlight', :highlight => true
       end
       helper.stub(:blacklight_config).and_return(@config)
@@ -558,6 +576,20 @@ describe BlacklightHelper do
       value.should == 'custom asdf value'
     end
 
+    it "should check for a link_to_search" do
+      doc = double()
+      doc.should_receive(:get).with('link_to_search_true', :sep => nil).and_return('x')
+      value = helper.render_document_show_field_value :document => doc, :field => 'link_to_search_true'
+      value.should == helper.link_to("x", helper.search_action_url(:f => { :link_to_search_true => ['x'] }))
+    end
+
+    it "should check for a link_to_search with a field name" do
+      doc = double()
+      doc.should_receive(:get).with('link_to_search_named', :sep => nil).and_return('x')
+      value = helper.render_document_show_field_value :document => doc, :field => 'link_to_search_named'
+      value.should == helper.link_to("x", helper.search_action_url(:f => { :some_field => ['x'] }))
+    end
+
     it "should gracefully handle when no highlight field is available" do
       doc = double()
       doc.should_not_receive(:get)
@@ -626,4 +658,15 @@ describe BlacklightHelper do
     end
   end
 
+
+  describe "render_grouped_response?" do
+    it "should check if the response contains grouped data" do
+      assign(:response, double("SolrResponse", :grouped? => true))
+      expect(helper.render_grouped_response?).to be_true
+    end
+  end
+
+  describe "render_grouped_document_index" do
+
+  end
 end

data/spec/helpers/catalog_helper_spec.rb

@@ -11,13 +11,20 @@ describe CatalogHelper do
     start = (current_page - 1) * per_page
 
     mock_response = double("Blacklight::SolrResponse")
-    mock_response.stub(:total).and_return(total)
+    mock_response.stub(:total_count).and_return(total)
+    mock_response.stub(:current_page).and_return(current_page)
+    mock_response.stub(:total_pages).and_return((total / per_page).to_i + 1)
     mock_response.stub(:rows).and_return(per_page)
     mock_response.stub(:start).and_return(start)
     mock_response.stub(:docs).and_return((1..total).to_a.slice(start, per_page))
 
     mock_response
   end
+
+  def render_grouped_response?
+    false
+  end
+  
   
   describe "render_pagination_info" do
     before(:all) do
@@ -87,4 +94,130 @@ describe CatalogHelper do
     end
 
   end
+
+  describe "should_autofocus_on_search_box?" do
+    it "should be focused if we're on a catalog-like index page without query or facet parameters" do
+      helper.stub(:controller => CatalogController.new, :action_name => "index", :params => { })
+      expect(helper.should_autofocus_on_search_box?).to be_true
+    end
+
+    it "should not be focused if we're not on a catalog controller" do
+      helper.stub(:controller => ApplicationController.new)
+      expect(helper.should_autofocus_on_search_box?).to be_false
+    end
+
+    it "should not be focused if we're not on a catalog controller index" do
+      helper.stub(:controller => CatalogController.new, :action_name => "show")
+      expect(helper.should_autofocus_on_search_box?).to be_false
+    end
+
+    it "should not be focused if a search string is provided" do
+      helper.stub(:controller => CatalogController.new, :action_name => "index", :params => { :q => "hello"})
+      expect(helper.should_autofocus_on_search_box?).to be_false
+    end
+
+    it "should not be focused if a facet is selected" do
+      helper.stub(:controller => CatalogController.new, :action_name => "index", :params => { :f => { "field" => ["value"]}})
+      expect(helper.should_autofocus_on_search_box?).to be_false
+    end
+  end
+
+  describe "has_thumbnail?" do
+    it "should have a thumbnail if a thumbnail_method is configured" do
+      helper.stub(:blacklight_config => OpenStruct.new(:index => OpenStruct.new(:thumbnail_method => :xyz) ))
+      document = double()
+      expect(helper.has_thumbnail? document).to be_true
+    end
+
+    it "should have a thumbnail if a thumbnail_field is configured and it exists in the document" do
+      helper.stub(:blacklight_config => OpenStruct.new(:index => OpenStruct.new(:thumbnail_field => :xyz) ))
+      document = double(:has_field? => true)
+      expect(helper.has_thumbnail? document).to be_true
+    end
+    
+    it "should not have a thumbnail if the thumbnail_field is missing from the document" do
+      helper.stub(:blacklight_config => OpenStruct.new(:index => OpenStruct.new(:thumbnail_field => :xyz) ))
+      document = double(:has_field? => false)
+      expect(helper.has_thumbnail? document).to be_false
+    end
+
+    it "should not have a thumbnail if none of the fields are configured" do
+      helper.stub(:blacklight_config => OpenStruct.new(:index => OpenStruct.new()))
+      expect(helper.has_thumbnail? double()).to be_false
+    end
+  end
+
+  describe "render_thumbnail_tag" do
+    it "should call the provided thumbnail method" do
+      helper.stub(:blacklight_config => double(:index => double(:thumbnail_method => :xyz)))
+      document = double()
+      helper.stub(:xyz => "some-thumbnail")
+
+      helper.should_receive(:link_to_document).with(document, :label => "some-thumbnail")
+      helper.render_thumbnail_tag document
+    end
+
+    it "should create an image tag from the given field" do
+      helper.stub(:blacklight_config => double(:index => OpenStruct.new(:thumbnail_field => :xyz)))
+      document = double()
+
+      document.stub(:has_field?).with(:xyz).and_return(true)
+      document.stub(:get).with(:xyz, :sep => nil).and_return(["http://example.com/some.jpg"])
+
+      helper.should_receive(:link_to_document).with(document, :label => image_tag("http://example.com/some.jpg"))
+      helper.render_thumbnail_tag document
+    end
+
+    it "should return nil if no thumbnail is available" do
+      helper.stub(:blacklight_config => double(:index => OpenStruct.new()))
+
+      document = double()
+      expect(helper.render_thumbnail_tag document).to be_nil
+    end
+
+    it "should return nil if no thumbnail is returned from the thumbnail method" do
+      helper.stub(:blacklight_config => double(:index => OpenStruct.new(:thumbnail_method => :xyz)))
+      helper.stub(:xyz => nil)
+      document = double()
+
+      expect(helper.render_thumbnail_tag document).to be_nil
+    end
+  end
+
+  describe "thumbnail_url" do
+    it "should pull the configured thumbnail field out of the document" do
+      helper.stub(:blacklight_config => double(:index => double(:thumbnail_field => "xyz")))
+      document = double()
+      document.stub(:has_field?).with("xyz").and_return(true)
+      document.stub(:get).with("xyz", :sep => nil).and_return(["asdf"])
+      expect(helper.thumbnail_url document).to eq("asdf")
+    end
+
+    it "should return nil if the thumbnail field doesn't exist" do
+      helper.stub(:blacklight_config => double(:index => double(:thumbnail_field => "xyz")))
+      document = double()
+      document.stub(:has_field?).with("xyz").and_return(false)
+      expect(helper.thumbnail_url document).to be_nil
+    end
+  end
+
+  describe "document_counter_with_offset" do
+    it "should render the document index with the appropriate offset" do
+      assign(:response, double(:params => { :start => 0 }, :grouped? => false))
+      expect(helper.document_counter_with_offset(0)).to be(1)
+      expect(helper.document_counter_with_offset(1)).to be(2)
+    end
+
+    it "should render the document index with the appropriate offset" do
+      assign(:response, double(:params => { :start => 10 }, :grouped? => false))
+      expect(helper.document_counter_with_offset(0)).to be(11)
+      expect(helper.document_counter_with_offset(1)).to be(12)
+    end
+
+    it "should not provide a counter for grouped responses" do
+      assign(:response, double(:params => { :start => 10 }, :grouped? => true))
+      expect(helper.document_counter_with_offset(0)).to be_nil
+    end
+  end
+
 end