blacklight 7.0.0.rc1 → 7.0.0.rc2

data/spec/helpers/blacklight_helper_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 RSpec.describe BlacklightHelper do
-  before(:each) do
+  before do
     allow(helper).to receive(:current_or_guest_user).and_return(User.new)
     allow(helper).to receive(:search_action_path) do |*args|
       search_catalog_url *args
@@ -11,6 +11,7 @@ RSpec.describe BlacklightHelper do
     before do
       allow(Rails).to receive(:cache).and_return(ActiveSupport::Cache::NullStore.new)
     end
+
     it "defaults to 'Blacklight'" do
       expect(application_name).to eq "Blacklight"
     end
@@ -30,10 +31,11 @@ RSpec.describe BlacklightHelper do
 
       context "and a translation exists for that language" do
         around do |example|
-          I18n.backend.store_translations(:de, 'blacklight' => { 'application_name' => 'Schwarzlicht' } )
+          I18n.backend.store_translations(:de, 'blacklight' => { 'application_name' => 'Schwarzlicht' })
           example.run
           I18n.backend.reload!
         end
+
         it "uses the provided value" do
           expect(application_name).to eq "Schwarzlicht"
         end
@@ -90,7 +92,7 @@ RSpec.describe BlacklightHelper do
         config.index.display_type_field = 'format'
       end
     end
-    let(:document) { SolrDocument.new('title_tsim' => "A Fake Document", 'id'=>'8') }
+    let(:document) { SolrDocument.new('title_tsim' => "A Fake Document", 'id' => '8') }
 
     before do
       config.add_show_tools_partial(:bookmark, partial: 'catalog/bookmark_control')
@@ -103,7 +105,7 @@ RSpec.describe BlacklightHelper do
     describe "render_nav_actions" do
       it "renders partials" do
         buff = String.new
-        helper.render_nav_actions { |config, item| buff << "<foo>#{item}</foo>" }
+        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'
       end
@@ -142,15 +144,18 @@ RSpec.describe BlacklightHelper do
     end
 
     it "is true" do
+      expect(Deprecation).to receive(:warn)
       expect(helper.should_render_index_field?(double, double)).to be true
     end
 
     it "is false if the document doesn't have a value for the field" do
+      expect(Deprecation).to receive(:warn)
       allow(helper).to receive_messages(document_has_value?: false)
       expect(helper.should_render_index_field?(double, double)).to be false
     end
 
     it "is false if the configuration has the field disabled" do
+      expect(Deprecation).to receive(:warn)
       allow(helper).to receive_messages(should_render_field?: false)
       expect(helper.should_render_index_field?(double, double)).to be false
     end
@@ -162,15 +167,18 @@ RSpec.describe BlacklightHelper do
     end
 
     it "is true" do
+      expect(Deprecation).to receive(:warn)
       expect(helper.should_render_show_field?(double, double)).to be true
     end
 
     it "is false if the document doesn't have a value for the field" do
+      expect(Deprecation).to receive(:warn)
       allow(helper).to receive_messages(document_has_value?: false)
       expect(helper.should_render_show_field?(double, double)).to be false
     end
 
     it "is false if the configuration has the field disabled" do
+      expect(Deprecation).to receive(:warn)
       allow(helper).to receive_messages(should_render_field?: false)
       expect(helper.should_render_show_field?(double, double)).to be false
     end
@@ -178,21 +186,24 @@ RSpec.describe BlacklightHelper do
 
   describe "#document_has_value?" do
     let(:doc) { double(SolrDocument) }
+
+    before { allow(Deprecation).to receive(:warn) }
+
     it "ifs the document has the field value" do
       allow(doc).to receive(:has?).with('asdf').and_return(true)
-      field_config = double(:field => 'asdf')
+      field_config = double(field: 'asdf')
       expect(helper.document_has_value?(doc, field_config)).to eq true
     end
     it "ifs the document has a highlight field value" do
       allow(doc).to receive(:has?).with('asdf').and_return(false)
       allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(true)
-      field_config = double(:field => 'asdf', :highlight => true)
+      field_config = double(field: 'asdf', highlight: true)
       expect(helper.document_has_value?(doc, field_config)).to eq true
     end
     it "ifs the field has a model accessor" do
       allow(doc).to receive(:has?).with('asdf').and_return(false)
       allow(doc).to receive(:has_highlight_field?).with('asdf').and_return(false)
-      field_config = double(:field => 'asdf', :highlight => true, :accessor => true)
+      field_config = double(field: 'asdf', highlight: true, accessor: true)
       expect(helper.document_has_value?(doc, field_config)).to eq true
     end
   end
@@ -217,26 +228,28 @@ RSpec.describe BlacklightHelper do
     before do
       allow(helper).to receive_messages spell_check_max: 5
     end
+
     it "does not show suggestions if there are enough results" do
       response = double(total: 10)
-      expect(helper.should_show_spellcheck_suggestions? response).to be false
+      expect(helper.should_show_spellcheck_suggestions?(response)).to be false
     end
     it "only shows suggestions if there are very few results" do
       response = double(total: 4, spelling: double(words: [1]))
-      expect(helper.should_show_spellcheck_suggestions? response).to be true
+      expect(helper.should_show_spellcheck_suggestions?(response)).to be true
     end
     it "shows suggestions only if there are spelling suggestions available" do
       response = double(total: 4, spelling: double(words: []))
-      expect(helper.should_show_spellcheck_suggestions? response).to be false
+      expect(helper.should_show_spellcheck_suggestions?(response)).to be false
     end
     it "does not show suggestions if spelling is not available" do
       response = double(total: 4, spelling: nil)
-      expect(helper.should_show_spellcheck_suggestions? response).to be false
+      expect(helper.should_show_spellcheck_suggestions?(response)).to be false
     end
   end
 
   describe "#opensearch_description_tag" do
     subject { helper.opensearch_description_tag 'title', 'href' }
+
     it "has a search rel" do
       expect(subject).to have_selector "link[rel='search']", visible: false
     end
@@ -261,6 +274,7 @@ RSpec.describe BlacklightHelper do
 
   describe "#render_document_index_with_view" do
     let(:obj1) { SolrDocument.new }
+
     before do
       allow(helper).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
       assign(:response, instance_double(Blacklight::Solr::Response, grouped?: false, start: 0))
@@ -321,6 +335,7 @@ RSpec.describe BlacklightHelper do
   context "related classes" do
     let(:presenter_class) { double }
     let(:blacklight_config) { Blacklight::Configuration.new }
+
     before do
       allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
     end
@@ -350,6 +365,7 @@ RSpec.describe BlacklightHelper do
 
   describe "#render_document_heading" do
     let(:document) { double }
+
     before do
       allow(helper).to receive(:presenter).and_return(double(heading: "Heading"))
     end
@@ -359,7 +375,7 @@ RSpec.describe BlacklightHelper do
     end
 
     it "accepts the tag name as an option" do
-      expect(helper.render_document_heading tag: "h1").to have_selector "h1", text: "Heading"
+      expect(helper.render_document_heading(tag: "h1")).to have_selector "h1", text: "Heading"
     end
 
     it "accepts an explicit document argument" do

data/spec/helpers/catalog_helper_spec.rb

@@ -2,7 +2,7 @@
 
 RSpec.describe CatalogHelper do
   include ERB::Util
-  include CatalogHelper
+  include described_class
 
   def mock_response args
     current_page = args[:current_page] || 1
@@ -22,18 +22,17 @@ RSpec.describe CatalogHelper do
     false
   end
 
-
   describe "page_entries_info" do
     it "with no results" do
-      @response = mock_response :total => 0
+      @response = mock_response total: 0
 
-      html = page_entries_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, entry_name: 'entry_name')
       expect(html).to eq "No entry_names found"
       expect(html).to be_html_safe
     end
 
     it "with no results (and no entry_name provided)" do
-      @response = mock_response :total => 0
+      @response = mock_response total: 0
 
       html = page_entries_info(@response)
       expect(html).to eq "No entries found"
@@ -49,15 +48,15 @@ RSpec.describe CatalogHelper do
 
     describe "with a single result" do
       it "uses the provided entry name" do
-        response = mock_response :total => 1
+        response = mock_response total: 1
 
-        html = page_entries_info(response, { :entry_name => 'entry_name' })
+        html = page_entries_info(response, entry_name: 'entry_name')
         expect(html).to eq "<strong>1</strong> entry_name found"
         expect(html).to be_html_safe
       end
 
       it "infers a name" do
-        response = mock_response :total => 1
+        response = mock_response total: 1
 
         html = page_entries_info(response)
         expect(html).to eq "<strong>1</strong> entry found"
@@ -65,8 +64,8 @@ RSpec.describe CatalogHelper do
       end
 
       it "uses the model_name from the response" do
-        response = mock_response :total => 1
-        allow(response).to receive(:model_name).and_return(double(:human => 'thingy'))
+        response = mock_response total: 1
+        allow(response).to receive(:model_name).and_return(double(human: 'thingy'))
 
         html = page_entries_info(response)
         expect(html).to eq "<strong>1</strong> thingy found"
@@ -75,55 +74,57 @@ RSpec.describe CatalogHelper do
     end
 
     it "with a single page of results" do
-      response = mock_response :total => 7
+      response = mock_response total: 7
 
-      html = page_entries_info(response, { :entry_name => 'entry_name' })
+      html = page_entries_info(response, entry_name: 'entry_name')
       expect(html).to eq "<strong>1</strong> - <strong>7</strong> of <strong>7</strong>"
       expect(html).to be_html_safe
     end
 
     it "on the first page of multiple pages of results" do
-      @response = mock_response :total => 15, :per_page => 10
+      @response = mock_response total: 15, per_page: 10
 
-      html = page_entries_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, entry_name: 'entry_name')
       expect(html).to eq "<strong>1</strong> - <strong>10</strong> of <strong>15</strong>"
       expect(html).to be_html_safe
     end
 
     it "on the second page of multiple pages of results" do
-      @response = mock_response :total => 47, :per_page => 10, :current_page => 2
+      @response = mock_response total: 47, per_page: 10, current_page: 2
 
-      html = page_entries_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, entry_name: 'entry_name')
       expect(html).to eq "<strong>11</strong> - <strong>20</strong> of <strong>47</strong>"
       expect(html).to be_html_safe
     end
 
     it "on the last page of results" do
-      @response = mock_response :total => 47, :per_page => 10, :current_page => 5
+      @response = mock_response total: 47, per_page: 10, current_page: 5
 
-      html = page_entries_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, entry_name: 'entry_name')
       expect(html).to eq "<strong>41</strong> - <strong>47</strong> of <strong>47</strong>"
       expect(html).to be_html_safe
     end
     it "works with rows the same as per_page" do
-      @response = mock_response :total => 47, :rows => 20, :current_page => 2
+      @response = mock_response total: 47, rows: 20, current_page: 2
 
-      html = page_entries_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, entry_name: 'entry_name')
       expect(html).to eq "<strong>21</strong> - <strong>40</strong> of <strong>47</strong>"
       expect(html).to be_html_safe
     end
 
     it "uses delimiters with large numbers" do
-      @response = mock_response :total => 5000, :rows => 10, :current_page => 101
-      html = page_entries_info(@response, { :entry_name => 'entry_name' })
+      @response = mock_response total: 5000, rows: 10, current_page: 101
+      html = page_entries_info(@response, entry_name: 'entry_name')
 
       expect(html).to eq "<strong>1,001</strong> - <strong>1,010</strong> of <strong>5,000</strong>"
     end
 
     context "with an ActiveRecord collection" do
+      subject { helper.page_entries_info(Bookmark.page(1).per(25)) }
+
       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
@@ -177,6 +178,7 @@ RSpec.describe CatalogHelper do
     before do
       expect(Deprecation).to receive(:warn)
     end
+
     it "is focused if we're on a catalog-like index page without query or facet parameters" do
       allow(helper).to receive_messages(controller: CatalogController.new, action_name: "index", has_search_parameters?: false)
       expect(helper.should_autofocus_on_search_box?).to be true
@@ -207,27 +209,28 @@ RSpec.describe CatalogHelper do
     let(:data) { {} }
 
     it "has a thumbnail if a thumbnail_method is configured" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz, document_presenter_class: Blacklight::IndexPresenter) ))
-      expect(helper.has_thumbnail? document).to be true
+      allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_method: :xyz, document_presenter_class: Blacklight::IndexPresenter)))
+      expect(helper.has_thumbnail?(document)).to be true
     end
 
     context "if a thumbnail_field is configured and it exists in the document" do
       let(:data) { { xyz: 'abc' } }
+
       it "has a thumbnail" do
-        allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz, document_presenter_class: Blacklight::IndexPresenter) ))
-        expect(helper.has_thumbnail? document).to be true
+        allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz, document_presenter_class: Blacklight::IndexPresenter)))
+        expect(helper.has_thumbnail?(document)).to be true
       end
     end
 
     it "does not have a thumbnail if the thumbnail_field is missing from the document" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz, document_presenter_class: Blacklight::IndexPresenter) ))
+      allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz, document_presenter_class: Blacklight::IndexPresenter)))
       allow(document).to receive_messages(has?: false)
-      expect(helper.has_thumbnail? document).to be false
+      expect(helper.has_thumbnail?(document)).to be false
     end
 
     it "does not have a thumbnail if none of the fields are configured" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(document_presenter_class: Blacklight::IndexPresenter) ))
-      expect(helper.has_thumbnail? document).to be_falsey
+      allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(document_presenter_class: Blacklight::IndexPresenter)))
+      expect(helper).not_to have_thumbnail(document)
     end
   end
 
@@ -235,7 +238,7 @@ RSpec.describe CatalogHelper do
     let(:index_presenter) do
       instance_double(Blacklight::IndexPresenter, thumbnail: thumbnail_presenter)
     end
-    let(:thumbnail_presenter){ instance_double(Blacklight::ThumbnailPresenter) }
+    let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter) }
 
     before do
       expect(Deprecation).to receive(:warn)
@@ -251,7 +254,7 @@ RSpec.describe CatalogHelper do
 
     it "calls thumbnail presenter with provided values" do
       expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, suppress_link: true)
-      result = helper.render_thumbnail_tag document, {}, suppress_link: true
+      helper.render_thumbnail_tag document, {}, suppress_link: true
     end
   end
 
@@ -261,18 +264,18 @@ RSpec.describe CatalogHelper do
     end
 
     it "pulls the configured thumbnail field out of the document" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
+      allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz)))
       document = instance_double(SolrDocument)
       allow(document).to receive(:has?).with(:xyz).and_return(true)
       allow(document).to receive(:first).with(:xyz).and_return("asdf")
-      expect(helper.thumbnail_url document).to eq("asdf")
+      expect(helper.thumbnail_url(document)).to eq("asdf")
     end
 
     it "returns nil if the thumbnail field doesn't exist" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
+      allow(helper).to receive_messages(blacklight_config: Blacklight::Configuration.new(index: Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz)))
       document = instance_double(SolrDocument)
       allow(document).to receive(:has?).with(:xyz).and_return(false)
-      expect(helper.thumbnail_url document).to be_nil
+      expect(helper.thumbnail_url(document)).to be_nil
     end
   end
 
@@ -306,38 +309,37 @@ RSpec.describe CatalogHelper do
 
     it "pulls data out of a document's field" do
       blacklight_config.index.display_type_field = :type
-      doc = { :type => 'book' }
+      doc = { type: 'book' }
       expect(helper.render_document_class(doc)).to eq "blacklight-book"
     end
 
     it "supports multivalued fields" do
       blacklight_config.index.display_type_field = :type
-      doc = { :type => ['book', 'mss'] }
+      doc = { type: %w[book mss] }
       expect(helper.render_document_class(doc)).to eq "blacklight-book blacklight-mss"
     end
 
     it "supports empty fields" do
       blacklight_config.index.display_type_field = :type
-      doc = { :type => [] }
+      doc = { type: [] }
       expect(helper.render_document_class(doc)).to be_blank
     end
 
     it "supports missing fields" do
       blacklight_config.index.display_type_field = :type
-      doc = { }
+      doc = {}
       expect(helper.render_document_class(doc)).to be_blank
     end
 
     it "supports view-specific field configuration" do
       allow(helper).to receive(:document_index_view_type).and_return(:some_view_type)
       blacklight_config.view.some_view_type.display_type_field = :other_type
-      doc = { other_type: "document"}
+      doc = { other_type: "document" }
       expect(helper.render_document_class(doc)).to eq "blacklight-document"
     end
   end
 
   describe "#bookmarked?" do
-
     let(:bookmark) { Bookmark.new document: bookmarked_document }
     let(:bookmarked_document) { SolrDocument.new(id: 'a') }
 
@@ -368,24 +370,25 @@ RSpec.describe CatalogHelper do
     end
 
     it "renders a facet with two values" do
-      expect(helper.render_search_to_page_title_filter('foo', ['bar', 'baz'])).to eq "Foo: bar and baz"
+      expect(helper.render_search_to_page_title_filter('foo', %w[bar baz])).to eq "Foo: bar and baz"
     end
 
     it "renders a facet with more than two values" do
-      expect(helper.render_search_to_page_title_filter('foo', ['bar', 'baz', 'foobar'])).to eq "Foo: 3 selected"
+      expect(helper.render_search_to_page_title_filter('foo', %w[bar baz foobar])).to eq "Foo: 3 selected"
     end
   end
 
   describe "#render_search_to_page_title" do
+    subject { helper.render_search_to_page_title(params) }
+
     before do
       allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
-      allow(helper).to receive(:default_search_field).and_return(Blacklight::Configuration::SearchField.new(:key => 'default_search_field', :display_label => 'Default'))
+      allow(helper).to receive(:default_search_field).and_return(Blacklight::Configuration::SearchField.new(key: 'default_search_field', display_label: 'Default'))
       allow(helper).to receive(:label_for_search_field).with(nil).and_return('')
     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) }
 
     it { is_expected.to eq "foobar / Format: Book" }
   end