blacklight 6.0.0.pre5 → 6.0.0

data/spec/controllers/saved_searches_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe SavedSearchesController do

data/spec/controllers/search_history_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe SearchHistoryController do

data/spec/controllers/suggest_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe SuggestController do

data/spec/features/alternate_controller_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Alternate Controller Behaviors" do

data/spec/features/bookmarks_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Bookmarks" do

data/spec/features/did_you_mean_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Did You Mean" do

data/spec/features/facets_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Facets" do

data/spec/features/record_view_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Record View" do

data/spec/features/saved_searches_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Saved Searches" do

data/spec/features/search_context_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search Results context", js: true do

data/spec/features/search_filters_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Facets" do
@@ -12,7 +13,7 @@ describe "Facets" do
 
     expect(page).to have_selector(".blacklight-language_facet")
     expect(page).to have_selector(".blacklight-language_facet.facet_limit-active")
-    
+
     within "#facet-language_facet" do
       expect(page).to have_selector("span.selected", :text => "Tibetan")
       expect(page).to have_selector("span.facet-count.selected", :text => "6")

data/spec/features/search_formats_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search Formats" do

data/spec/features/search_history_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search History Page" do

data/spec/features/search_pagination_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search Pagination" do

data/spec/features/search_results_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search Results" do

data/spec/features/search_sort_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search Sort" do

data/spec/features/search_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Search Page" do

data/spec/features/sitelinks_search_box.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 feature 'Sitelinks search box' do

data/spec/helpers/blacklight_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe BlacklightHelper do
@@ -84,8 +85,8 @@ describe BlacklightHelper do
     end
 
     describe "render_nav_actions" do
-      it "should render partials" do
-        buff = ''
+      it "renders partials" do
+        buff = String.new
         helper.render_nav_actions { |config, item| buff << "<foo>#{item}</foo>" }
         expect(buff).to have_selector "foo a#bookmarks_nav[href=\"/bookmarks\"]"
         expect(buff).to have_selector "foo a span[data-role='bookmark-counter']", text: '0'

data/spec/helpers/catalog_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe CatalogHelper do
@@ -24,9 +25,6 @@ describe CatalogHelper do
 
 
   describe "page_entries_info" do
-    before(:all) do
-    end
-
     it "with no results" do
       @response = mock_response :total => 0
 
@@ -123,12 +121,13 @@ describe CatalogHelper do
       expect(html).to eq "<strong>1,001</strong> - <strong>1,010</strong> of <strong>5,000</strong>"
     end
 
-    it "should work with an activerecord collection" do
-      50.times { b = Bookmark.new;  b.user_id = 1; b.save! }
-      html = helper.page_entries_info(Bookmark.page(1).per(25))
-      expect(html).to eq "<strong>1</strong> - <strong>25</strong> of <strong>50</strong>"
-    end
+    context "with an ActiveRecord collection" do
+      let(:user) { User.create! email: 'xyz@example.com', password: 'xyz12345' }
+      before { 50.times { Bookmark.create!(user: user) } }
+      subject { helper.page_entries_info(Bookmark.page(1).per(25)) }
 
+      it { is_expected.to eq "<strong>1</strong> - <strong>25</strong> of <strong>50</strong>" }
+    end
   end
 
   describe "should_autofocus_on_search_box?" do
@@ -360,14 +359,10 @@ describe CatalogHelper do
       allow(helper).to receive(:label_for_search_field).with(nil).and_return('')
     end
 
-    let :blacklight_config do
-      Blacklight::Configuration.new
-    end
+    let(:blacklight_config) { Blacklight::Configuration.new }
+    let(:params) { ActionController::Parameters.new(q: 'foobar', f: { format: ["Book"] }) }
+    subject { helper.render_search_to_page_title(params) }
 
-    let(:params) { {'q' => 'foobar', "f" => {"format" => ["Book"]}} }
-
-    it "should render a page title" do
-      expect(helper.render_search_to_page_title(params)).to eq "foobar / Format: Book"
-    end
+    it { is_expected.to eq "foobar / Format: Book" }
   end
 end

data/spec/helpers/configuration_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe BlacklightConfigurationHelper do

data/spec/helpers/deprecated_url_helper_behavior_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::DeprecatedUrlHelperBehavior do
@@ -6,9 +7,10 @@ describe Blacklight::DeprecatedUrlHelperBehavior do
       test.call
     end
   end
-  
+
+  let(:parameter_class) { ActionController::Parameters }
   let(:search_state) { Blacklight::SearchState.new(params, blacklight_config) }
-  let(:params) { {} }
+  let(:params) { parameter_class.new }
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
@@ -27,7 +29,7 @@ describe Blacklight::DeprecatedUrlHelperBehavior do
     end
 
     it 'generates a search state for the source parameters' do
-      expect(helper.params_for_search({ source: 1 }, { merge: 1 })).to include merge: 1, source: 1
+      expect(helper.params_for_search(parameter_class.new(source: 1), { merge: 1 })).to include merge: 1, source: 1
     end
   end
 
@@ -38,8 +40,9 @@ describe Blacklight::DeprecatedUrlHelperBehavior do
   end
 
   describe '#reset_search_params' do
+    let(:source_parameters) { parameter_class.new page: 1, counter: 10 }
     it 'resets the current page and counter' do
-      expect(helper.reset_search_params(page: 1, counter: 10)).to be_blank
+      expect(helper.reset_search_params(source_parameters)).to be_blank
     end
   end
 
@@ -55,8 +58,11 @@ describe Blacklight::DeprecatedUrlHelperBehavior do
       expect(helper.add_facet_params(field, item)).to eq search_state.add_facet_params(field, item)
     end
 
-    it 'generates a search state for the source parameters' do
-      expect(helper.add_facet_params(field, item, source: 1)).to include source: 1
+    context "with source_parameters" do
+      let(:source_parameters) { parameter_class.new source: 1 }
+      it 'generates a search state for the source parameters' do
+        expect(helper.add_facet_params(field, item, source_parameters)).to include source: 1
+      end
     end
   end
 
@@ -85,8 +91,11 @@ describe Blacklight::DeprecatedUrlHelperBehavior do
       expect(helper.remove_facet_params(field, item)).to eq search_state.remove_facet_params(field, item)
     end
 
-    it 'generates a search state for the source parameters' do
-      expect(helper.remove_facet_params(field, item, source: 1)).to include source: 1
+    context "with source_parameters" do
+      let(:source_parameters) { parameter_class.new source: 1 }
+      it 'generates a search state for the source parameters' do
+        expect(helper.remove_facet_params(field, item, source_parameters)).to include source: 1
+      end
     end
   end
-end
+end

data/spec/helpers/facets_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 require 'equivalent-xml'

data/spec/helpers/hash_as_hidden_fields_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe HashAsHiddenFieldsHelper do

data/spec/helpers/layout_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe LayoutHelper do

data/spec/helpers/render_constraints_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe RenderConstraintsHelper do
@@ -18,12 +19,19 @@ describe RenderConstraintsHelper do
 
   describe '#render_constraints_query' do
     let(:my_engine) { double("Engine") }
-    it "should have a link relative to the current url" do
-      expect(helper.render_constraints_query(:q=>'foobar', :f=>{:type=>'journal'})).to have_selector "a[href='/?f%5Btype%5D=journal']"
+    let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }) }
+    subject { helper.render_constraints_query(params) }
+
+    it "has a link relative to the current url" do
+      expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
     end
-    it "should accept an optional route set" do
-      expect(my_engine).to receive(:url_for).and_return('/?f%5Btype%5D=journal')
-      expect(helper.render_constraints_query(:q=>'foobar', :f=>{:type=>'journal'}, :route_set => my_engine)).to have_selector "a[href='/?f%5Btype%5D=journal']"
+
+    context "with a route_set" do
+      let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }, route_set: my_engine) }
+      it "accepts an optional route set" do
+        expect(my_engine).to receive(:url_for).and_return('/?f%5Btype%5D=journal')
+        expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
+      end
     end
   end
 
@@ -34,19 +42,21 @@ describe RenderConstraintsHelper do
     end
     subject { helper.render_filter_element('type', ['journal'], path) }
 
-    let(:path) { Blacklight::SearchState.new({:q=>'biz'}, config) }
+    let(:params) { ActionController::Parameters.new q: 'biz' }
+    let(:path) { Blacklight::SearchState.new(params, config) }
 
-    it "should have a link relative to the current url" do
+    it "has a link relative to the current url" do
       expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
       expect(subject).to have_selector ".filterName", text: 'Item Type'
     end
   end
 
   describe "#render_constraints_filters" do
+    let(:params) { ActionController::Parameters.new f: { 'type' => [''] } }
     before do
       allow(helper).to receive(:blacklight_config).and_return(config)
     end
-    subject { helper.render_constraints_filters(:f=>{'type'=>['']}) }
+    subject { helper.render_constraints_filters(params) }
 
     it "should render nothing for empty facet limit param" do
       expect(subject).to be_blank

data/spec/helpers/search_history_constraints_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe SearchHistoryConstraintsHelper do

data/spec/helpers/suggest_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe SuggestHelper do

data/spec/helpers/url_helper_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe BlacklightUrlHelper do
@@ -9,6 +10,8 @@ describe BlacklightUrlHelper do
     end
   end
 
+  let(:parameter_class) { ActionController::Parameters }
+
   before do
     allow(helper).to receive(:search_action_path) do |*args|
       search_catalog_url *args
@@ -26,7 +29,7 @@ describe BlacklightUrlHelper do
     before do
       allow(helper).to receive_messages(controller: controller_class)
       allow(helper).to receive_messages(controller_name: controller_class.controller_name)
-      allow(helper).to receive_messages(params: {})
+      allow(helper).to receive_messages(params: parameter_class.new)
     end
 
     it "should be a polymorphic routing-ready object" do
@@ -48,12 +51,14 @@ describe BlacklightUrlHelper do
 
     context "within an alternative catalog controller" do
       let(:controller_class) { ::AlternateController.new }
+
       before do
         helper.blacklight_config.show.route = { controller: :current }
-        allow(helper).to receive(:params).and_return(controller: 'alternate')
+        allow(helper).to receive(:params).and_return(parameter_class.new controller: 'alternate')
       end
+
       it "should support the :current controller configuration" do
-        expect(helper.url_for_document(doc)).to eq({controller: 'alternate', action: :show, id: doc})
+        expect(helper.url_for_document(doc)).to eq(controller: 'alternate', action: :show, id: doc)
       end
     end
 
@@ -94,7 +99,7 @@ describe BlacklightUrlHelper do
         expect(tag).to match /page=3/
         expect(tag).to match /per_page=15/
       end
-      
+
       it "should omit per_page if the value is the same as the default" do
         allow(helper).to receive_messages(current_search_session: double(query_params: query_params))
         allow(helper).to receive_messages(search_session: { 'per_page' => 10, 'counter' => 31 })
@@ -106,7 +111,11 @@ describe BlacklightUrlHelper do
 
     context "without current search context" do
       before do
-        controller.request.assign_parameters(Rails.application.routes, 'catalog', 'show', id: '123')
+        if Rails.version >= '5.0.0'
+          controller.request.assign_parameters(Rails.application.routes, 'catalog', 'show', { id: '123' }, '/catalog/123', [:controller, :action, :id])
+        else
+          controller.request.assign_parameters(Rails.application.routes, 'catalog', 'show', id: '123')
+        end
         allow(helper).to receive_messages(current_search_session: nil)
       end
 
@@ -131,31 +140,41 @@ describe BlacklightUrlHelper do
     end
   end
 
+  describe "link_to_previous_document" do
+    context "when the argument is nil" do
+      subject { helper.link_to_previous_document(nil) }
+      it { is_expected.to eq '<span class="previous">&laquo; Previous</span>' }
+    end
+  end
+
   describe "link_to_query" do
-    it "should build a link tag to catalog using query string (no other params)" do
+    it "builds a link tag to catalog using query string (no other params)" do
       query = "brilliant"
-      allow(helper).to receive_messages(params: {})
+      allow(helper).to receive_messages(params: parameter_class.new)
       tag = helper.link_to_query(query)
       expect(tag).to match /q=#{query}/
       expect(tag).to match />#{query}<\/a>/
     end
-    it "should build a link tag to catalog using query string and other existing params" do
+
+    it "builds a link tag to catalog using query string and other existing params" do
       query = "wonderful"
-      allow(helper).to receive_messages(params: {:qt => "title_search", :per_page => "50"})
+      allow(helper).to receive_messages(params: parameter_class.new(qt: "title_search", per_page: "50"))
       tag = helper.link_to_query(query)
       expect(tag).to match /qt=title_search/
       expect(tag).to match /per_page=50/
     end
-    it "should ignore existing :page param" do
+
+    it "ignores existing :page param" do
       query = "yes"
-      allow(helper).to receive_messages(params: {:page => "2", :qt => "author_search"})
+      allow(helper).to receive_messages(params: parameter_class.new(page: "2", qt: "author_search"))
       tag = helper.link_to_query(query)
       expect(tag).to match /qt=author_search/
       expect(tag).to_not match /page/
     end
-    it "should be html_safe" do
+
+    it "is html_safe" do
       query = "brilliant"
-      allow(helper).to receive_messages(params: {:page => "2", :qt => "author_search"})
+      allow(helper).to receive_messages(params: parameter_class.new(page: "2", qt: "author_search"))
       tag = helper.link_to_query(query)
       expect(tag).to be_html_safe
     end
@@ -176,91 +195,76 @@ describe BlacklightUrlHelper do
   end
 
   describe "link_to_document" do
-    it "should consist of the document title wrapped in a <a>" do
-      data = {'id'=>'123456','title_display'=>['654321'] }
-      @document = SolrDocument.new(data)
-      expect(helper.link_to_document(@document, :title_display)).to have_selector("a", :text => '654321', :count => 1)
-    end
+    let(:title_display) { '654321' }
+    let(:id) { '123456' }
+    let(:data) { { 'id' => id, 'title_display' => [title_display] } }
+    let(:document) { SolrDocument.new(data) }
 
-    it "should accept and return a string label" do
-      data = {'id'=>'123456','title_display'=>['654321'] }
-      @document = SolrDocument.new(data)
-      expect(helper.link_to_document(@document, "title_display")).to have_selector("a", :text => 'title_display', :count => 1)
+    it "consists of the document title wrapped in a <a>" do
+      expect(helper.link_to_document(document, :title_display)).to have_selector("a", :text => '654321', :count => 1)
     end
 
-    it "should accept and return a Proc" do
-      data = {'id'=>'123456','title_display'=>['654321'] }
-      @document = SolrDocument.new(data)
-      expect(helper.link_to_document(@document, Proc.new { |doc, opts| doc[:id] + ": " + doc.first(:title_display) })).to have_selector("a", :text => '123456: 654321', :count => 1)
+    it "accepts and returns a string label" do
+      expect(helper.link_to_document(document, String.new('title_display'))).to have_selector("a", :text => 'title_display', :count => 1)
     end
 
-    it "should return id when label is missing" do
-      data = {'id'=>'123456'}
-      @document = SolrDocument.new(data)
-      expect(helper.link_to_document(@document, :title_display)).to have_selector("a", :text => '123456', :count => 1)
+    it "accepts and returns a Proc" do
+      expect(helper.link_to_document(document, Proc.new { |doc, opts| doc[:id] + ": " + doc.first(:title_display) })).to have_selector("a", :text => '123456: 654321', :count => 1)
     end
 
-    it "should be html safe" do
-      data = {'id'=>'123456'}
-      @document = SolrDocument.new(data)
-      expect(helper.link_to_document(@document, :title_display)).to be_html_safe
-    end
+    context 'when label is missing' do
+      let(:data) { { 'id' => id } }
+      it "returns id" do
+        expect(helper.link_to_document(document, :title_display)).to have_selector("a", :text => '123456', :count => 1)
+      end
+
+      it "is html safe" do
+        expect(helper.link_to_document(document, :title_display)).to be_html_safe
+      end
 
-    it "should convert the counter parameter into a data- attribute" do
-      data = {'id'=>'123456','title_display'=>['654321']}
-      @document = SolrDocument.new(data)
+      it "passes on the title attribute to the link_to_with_data method" do
+        expect(helper.link_to_document(document, "Some crazy long label...", title: "Some crazy longer label")).to match(/title=\"Some crazy longer label\"/)
+      end
+
+      it "doesn't add an erroneous title attribute if one isn't provided" do
+        expect(helper.link_to_document(document, "Some crazy long label...")).to_not match(/title=/)
+      end
+
+      context "with an integer id" do
+        let(:id) { 123456 }
+        it "works" do
+          expect(helper.link_to_document(document)).to have_selector("a")
+        end
+      end
+    end
 
+    it "converts the counter parameter into a data- attribute" do
       allow(helper).to receive(:track_test_path).with(hash_including(id: '123456', counter: 5)).and_return('tracking url')
 
-      expect(helper.link_to_document(@document, :title_display, counter: 5)).to include 'data-context-href="tracking url"'
+      expect(helper.link_to_document(document, :title_display, counter: 5)).to include 'data-context-href="tracking url"'
     end
 
     it "includes the data- attributes from the options" do
-      data = {'id'=>'123456','title_display'=>['654321']}
-      @document = SolrDocument.new(data)
-      link = helper.link_to_document @document, { data: { x: 1 }  }
+      link = helper.link_to_document document, { data: { x: 1 }  }
       expect(link).to have_selector '[data-x]'
     end
 
     it 'adds a controller-specific tracking attribute' do
-      data = { 'id'=>'123456', 'title_display'=>['654321'] }
-      @document = SolrDocument.new(data)
-
       expect(helper).to receive(:track_test_path).and_return('/asdf')
-      link = helper.link_to_document @document, { data: { x: 1 }  }
+      link = helper.link_to_document document, { data: { x: 1 }  }
 
       expect(link).to have_selector '[data-context-href="/asdf"]'
     end
 
     it 'adds a global tracking attribute' do
-      data = { 'id'=>'123456', 'title_display'=>['654321'] }
-      @document = SolrDocument.new(data)
-
-      link = helper.link_to_document @document, { data: { x: 1 }  }
+      link = helper.link_to_document document, { data: { x: 1 }  }
       expect(link).to have_selector '[data-context-href="/catalog/123456/track"]'
     end
-
-    it "passes on the title attribute to the link_to_with_data method" do
-      @document = SolrDocument.new('id'=>'123456')
-      expect(helper.link_to_document(@document, "Some crazy long label...", title: "Some crazy longer label")).to match(/title=\"Some crazy longer label\"/)
-    end
-
-    it "doesn't add an erroneous title attribute if one isn't provided" do
-      @document = SolrDocument.new('id'=>'123456')
-      expect(helper.link_to_document(@document, "Some crazy long label...")).to_not match(/title=/)
-    end
-
-    it "should  work with integer ids" do
-      data = {'id'=> 123456 }
-      @document = SolrDocument.new(data)
-      expect(helper.link_to_document(@document)).to have_selector("a")
-    end
-
   end
 
   describe "link_to_previous_search" do
+    let(:params) { {} }
     it "should link to the given search parameters" do
-      params = {}
       allow(helper).to receive(:render_search_to_s).with(params).and_return "link text"
       expect(helper.link_to_previous_search({})).to eq helper.link_to("link text", helper.search_action_path)
     end