blacklight 6.2.0 → 6.3.0

data/spec/helpers/catalog_helper_spec.rb

@@ -49,7 +49,7 @@ describe CatalogHelper do
     end
 
     describe "with a single result" do
-      it "should use the provided entry name" do
+      it "uses the provided entry name" do
         response = mock_response :total => 1
 
         html = page_entries_info(response, { :entry_name => 'entry_name' })
@@ -57,7 +57,7 @@ describe CatalogHelper do
         expect(html).to be_html_safe
       end
 
-      it "should infer a name" do
+      it "infers a name" do
         response = mock_response :total => 1
 
         html = page_entries_info(response)
@@ -65,7 +65,7 @@ describe CatalogHelper do
         expect(html).to be_html_safe
       end
 
-      it "should use the model_name from the response" do
+      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'))
 
@@ -106,7 +106,7 @@ describe CatalogHelper do
       expect(html).to eq "<strong>41</strong> - <strong>47</strong> of <strong>47</strong>"
       expect(html).to be_html_safe
     end
-    it "should work with rows the same as per_page" do
+    it "works with rows the same as per_page" do
       @response = mock_response :total => 47, :rows => 20, :current_page => 2
 
       html = page_entries_info(@response, { :entry_name => 'entry_name' })
@@ -131,47 +131,47 @@ describe CatalogHelper do
   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
+    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
     end
 
-    it "should not be focused if we're not on a catalog controller" do
+    it "does not be focused if we're not on a catalog controller" do
       allow(helper).to receive_messages(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
+    it "does not be focused if we're not on a catalog controller index" do
       allow(helper).to receive_messages(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 parameters are provided" do
+    it "does not be focused if a search parameters are provided" do
       allow(helper).to receive_messages(controller: CatalogController.new, action_name: "index", has_search_parameters?: true)
       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
+    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 = 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
+    it "has a thumbnail if a thumbnail_field is configured and it exists in the document" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
       document = double(:has? => 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
+    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 = double(:has? => false)
       expect(helper.has_thumbnail? document).to be false
     end
 
-    it "should not have a thumbnail if none of the fields are configured" do
+    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() ))
       expect(helper.has_thumbnail? double()).to be_falsey
     end
@@ -179,25 +179,25 @@ describe CatalogHelper do
 
   describe "render_thumbnail_tag" do
     let(:document) { double }
-    it "should call the provided thumbnail method" do
+    it "calls the provided thumbnail method" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      allow(helper).to receive_messages(:xyz => "some-thumbnail")
+      expect(helper).to receive_messages(:xyz => "some-thumbnail")
 
       allow(helper).to receive(:link_to_document).with(document, "some-thumbnail", {})
       helper.render_thumbnail_tag document
     end
 
-    it "should create an image tag from the given field" do
+    it "creates an image tag from the given field" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
 
       allow(document).to receive(:has?).with(:xyz).and_return(true)
       allow(document).to receive(:first).with(:xyz).and_return("http://example.com/some.jpg")
 
-      allow(helper).to receive(:link_to_document).with(document, image_tag("http://example.com/some.jpg"), {})
+      expect(helper).to receive(:link_to_document).with(document, image_tag("http://example.com/some.jpg"), {})
       helper.render_thumbnail_tag document
     end
 
-    it "should not link to the document if the url options are false" do
+    it "does not link to the document if the url options are false" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
       allow(helper).to receive_messages(:xyz => "some-thumbnail")
 
@@ -205,7 +205,7 @@ describe CatalogHelper do
       expect(result).to eq "some-thumbnail"
     end
 
-    it "should not link to the document if the url options have :suppress_link" do
+    it "does not link to the document if the url options have :suppress_link" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
       allow(helper).to receive_messages(:xyz => "some-thumbnail")
 
@@ -214,19 +214,19 @@ describe CatalogHelper do
     end
 
 
-    it "should return nil if no thumbnail is available" do
+    it "returns nil if no thumbnail is available" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
       expect(helper.render_thumbnail_tag document).to be_nil
     end
 
-    it "should return nil if no thumbnail is returned from the thumbnail method" do
+    it "returns nil if no thumbnail is returned from the thumbnail method" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
       allow(helper).to receive_messages(:xyz => nil)
 
       expect(helper.render_thumbnail_tag document).to be_nil
     end
 
-    it "should return nil if no thumbnail is in the document" do
+    it "returns nil if no thumbnail is in the document" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
 
       allow(document).to receive(:has?).with(:xyz).and_return(false)
@@ -236,7 +236,7 @@ describe CatalogHelper do
   end
 
   describe "thumbnail_url" do
-    it "should pull the configured thumbnail field out of the document" do
+    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) ))
       document = double()
       allow(document).to receive(:has?).with(:xyz).and_return(true)
@@ -244,7 +244,7 @@ describe CatalogHelper do
       expect(helper.thumbnail_url document).to eq("asdf")
     end
 
-    it "should return nil if the thumbnail field doesn't exist" do
+    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) ))
       document = double()
       allow(document).to receive(:has?).with(:xyz).and_return(false)
@@ -253,19 +253,19 @@ describe CatalogHelper do
   end
 
   describe "document_counter_with_offset" do
-    it "should render the document index with the appropriate offset" do
+    it "renders the document index with the appropriate offset" do
       assign(:response, double(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
+    it "renders the document index with the appropriate offset" do
       assign(:response, double(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
+    it "does not provide a counter for grouped responses" do
       assign(:response, double(start: 10, grouped?: true))
       expect(helper.document_counter_with_offset(0)).to be_nil
     end
@@ -280,31 +280,31 @@ describe CatalogHelper do
       Blacklight::Configuration.new
     end
 
-    it "should pull data out of a document's field" do
+    it "pulls data out of a document's field" do
       blacklight_config.index.display_type_field = :type
       doc = { :type => 'book' }
       expect(helper.render_document_class(doc)).to eq "blacklight-book"
     end
 
-    it "should support multivalued fields" do
+    it "supports multivalued fields" do
       blacklight_config.index.display_type_field = :type
       doc = { :type => ['book', 'mss'] }
       expect(helper.render_document_class(doc)).to eq "blacklight-book blacklight-mss"
     end
 
-    it "should support empty fields" do
+    it "supports empty fields" do
       blacklight_config.index.display_type_field = :type
       doc = { :type => [] }
       expect(helper.render_document_class(doc)).to be_blank
     end
 
-    it "should support missing fields" do
+    it "supports missing fields" do
       blacklight_config.index.display_type_field = :type
       doc = { }
       expect(helper.render_document_class(doc)).to be_blank
     end
 
-    it "should support view-specific field configuration" do
+    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"}
@@ -321,11 +321,11 @@ describe CatalogHelper do
       allow(helper).to receive(:current_bookmarks).and_return([bookmark])
     end
 
-    it "should be bookmarked if the document is in the bookmarks" do
+    it "is bookmarked if the document is in the bookmarks" do
       expect(helper.bookmarked?(bookmarked_document)).to eq true
     end
 
-    it "should not be bookmarked if the document is not listed in the bookmarks" do
+    it "does not be bookmarked if the document is not listed in the bookmarks" do
       expect(helper.bookmarked?(SolrDocument.new(id: 'b'))).to eq false
     end
   end
@@ -339,15 +339,15 @@ describe CatalogHelper do
       Blacklight::Configuration.new
     end
 
-    it "should render a facet with a single value" do
+    it "renders a facet with a single value" do
       expect(helper.render_search_to_page_title_filter('foo', ['bar'])).to eq "Foo: bar"
     end
 
-    it "should render a facet with two values" do
+    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"
     end
 
-    it "should render a facet with more than two values" do
+    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"
     end
   end

data/spec/helpers/configuration_helper_spec.rb

@@ -10,42 +10,42 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#index_fields" do
-    it "should pass through the configuration" do
+    it "passes through the configuration" do
       allow(blacklight_config).to receive_messages(index_fields: config_value)
       expect(helper.index_fields).to eq config_value
     end
   end
 
   describe "#sort_fields" do
-    it "should convert the sort fields to select-ready values" do
+    it "converts the sort fields to select-ready values" do
       allow(blacklight_config).to receive_messages(sort_fields: { 'a' => double(key: 'a', label: 'a'), 'b' => double(key: 'b', label: 'b'), c: double(key: 'c', if: false)  })
       expect(helper.sort_fields).to eq [['a', 'a'], ['b', 'b']]
     end
   end
 
   describe "#active_sort_fields" do
-    it "should restrict the configured sort fields to only those that should be displayed" do
+    it "restricts the configured sort fields to only those that should be displayed" do
       allow(blacklight_config).to receive_messages(sort_fields: { a: double(if: false, unless: false), b: double(if:true, unless: true) })
       expect(helper.active_sort_fields).to be_empty
     end
   end
 
   describe "#document_show_fields" do
-    it "should pass through the configuration" do
+    it "passes through the configuration" do
       allow(blacklight_config).to receive_messages(show_fields: config_value)
       expect(helper.document_show_fields).to eq config_value
     end
   end
 
   describe "#default_document_index_view_type" do
-    it "should use the first view with default set to true" do
+    it "uses the first view with default set to true" do
       blacklight_config.view.a
       blacklight_config.view.b
       blacklight_config.view.b.default = true
       expect(helper.default_document_index_view_type).to eq :b
     end
     
-    it "should default to the first configured index view" do
+    it "defaults to the first configured index view" do
       allow(blacklight_config).to receive_messages(view: { a: true, b: true})
       expect(helper.default_document_index_view_type).to eq :a
     end
@@ -58,7 +58,7 @@ describe BlacklightConfigurationHelper do
       blacklight_config.view.xyz.unless = true
     end
 
-    it "should filter views using :if/:unless configuration" do
+    it "filters views using :if/:unless configuration" do
       expect(helper.document_index_views).to have_key :list
       expect(helper.document_index_views).to_not have_key :abc
       expect(helper.document_index_views).to_not have_key :def
@@ -83,7 +83,7 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#spell_check_max" do
-    it "should pass through the configuration" do
+    it "passes through the configuration" do
       allow(blacklight_config).to receive_messages(spell_max: config_value)
       expect(helper.spell_check_max).to eq config_value
     end
@@ -92,19 +92,19 @@ describe BlacklightConfigurationHelper do
   describe "#document_show_link_field" do
     let(:document) { SolrDocument.new id: 123, a: 1, b: 2, c: 3 }
 
-    it "should allow single values" do
+    it "allows single values" do
       blacklight_config.index.title_field = :a
       f = helper.document_show_link_field document
       expect(f).to eq :a
     end
     
-    it "should retrieve the first field with data" do
+    it "retrieves the first field with data" do
       blacklight_config.index.title_field = [:zzz, :b]
       f = helper.document_show_link_field document
       expect(f).to eq :b
     end
 
-    it "should fallback on the id" do
+    it "fallbacks on the id" do
       blacklight_config.index.title_field = [:zzz, :yyy]
       f = helper.document_show_link_field document
       expect(f).to eq 123
@@ -113,7 +113,7 @@ describe BlacklightConfigurationHelper do
 
   describe "#index_field_label" do
     let(:document) { double }
-    it "should look up the label to display for the given document and field" do
+    it "looks up the label to display for the given document and field" do
       allow(helper).to receive(:index_fields).and_return({ "my_field" => double(label: "some label") })
       allow(helper).to receive(:field_label).with(:"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
       helper.index_field_label document, "my_field"
@@ -122,7 +122,7 @@ describe BlacklightConfigurationHelper do
 
   describe "#document_show_field_label" do
     let(:document) { double }
-    it "should look up the label to display for the given document and field" do
+    it "looks up the label to display for the given document and field" do
       allow(helper).to receive(:document_show_fields).and_return({ "my_field" => double(label: "some label") })
       allow(helper).to receive(:field_label).with(:"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
       helper.document_show_field_label document, "my_field"
@@ -131,7 +131,7 @@ describe BlacklightConfigurationHelper do
 
   describe "#facet_field_label" do
     let(:document) { double }
-    it "should look up the label to display for the given document and field" do
+    it "looks up the label to display for the given document and field" do
       allow(blacklight_config).to receive(:facet_fields).and_return({ "my_field" => double(label: "some label") })
       allow(helper).to receive(:field_label).with(:"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field", "some label", "My field")
       helper.facet_field_label "my_field"
@@ -139,7 +139,7 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#view_label" do
-    it "should look up the label to display for the view" do
+    it "looks up the label to display for the view" do
       allow(blacklight_config).to receive(:view).and_return({ "my_view" => double(label: "some label", title: nil) })
       allow(helper).to receive(:field_label).with(:"blacklight.search.view_title.my_view", :"blacklight.search.view.my_view", "some label", nil, "My view")
 
@@ -148,20 +148,20 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#field_label" do
-    it "should look up the label as an i18n string" do
+    it "looks up the label as an i18n string" do
       allow(helper).to receive(:t).with(:some_key, default: []).and_return "my label"
       label = helper.field_label :some_key
 
       expect(label).to eq "my label"
     end
 
-    it "should pass the provided i18n keys to I18n.t" do
+    it "passes the provided i18n keys to I18n.t" do
       allow(helper).to receive(:t).with(:key_a, default: [:key_b, "default text"])
 
       label = helper.field_label :key_a, :key_b, "default text"
     end
 
-    it "should compact nil keys (fixes rails/rails#19419)" do
+    it "compacts nil keys (fixes rails/rails#19419)" do
       allow(helper).to receive(:t).with(:key_a, default: [:key_b])
 
       label = helper.field_label :key_a, nil, :key_b
@@ -170,31 +170,31 @@ describe BlacklightConfigurationHelper do
   end
   
   describe "#default_per_page" do
-    it "should be the configured default per page" do
+    it "is the configured default per page" do
       allow(helper).to receive_messages(blacklight_config: double(default_per_page: 42))
       expect(helper.default_per_page).to eq 42
     end
     
-    it "should be the first per-page value if a default isn't set" do
+    it "is the first per-page value if a default isn't set" do
       allow(helper).to receive_messages(blacklight_config: double(default_per_page: nil, per_page: [11, 22]))
       expect(helper.default_per_page).to eq 11
     end
   end
   
   describe "#default_sort_field" do
-    it "should be the configured default field" do
+    it "is the configured default field" do
       allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(default: nil), b: double(key: 'b', default: true) }))
       expect(helper.default_sort_field.key).to eq 'b'
     end
     
-    it "should be the first per-page value if a default isn't set" do
+    it "is the first per-page value if a default isn't set" do
       allow(helper).to receive_messages(blacklight_config: double(sort_fields: { a: double(key: 'a', default: nil), b: double(key: 'b', default: nil) }))
       expect(helper.default_sort_field.key).to eq 'a'
     end
   end
   
   describe "#per_page_options_for_select" do
-    it "should be the per-page values formatted as options_for_select" do
+    it "is the per-page values formatted as options_for_select" do
       allow(helper).to receive_messages(blacklight_config: double(per_page: [11, 22, 33]))
       expect(helper.per_page_options_for_select).to include ["11<span class=\"sr-only\"> per page</span>", 11]
       expect(helper.per_page_options_for_select).to include ["22<span class=\"sr-only\"> per page</span>", 22]
@@ -209,16 +209,16 @@ describe BlacklightConfigurationHelper do
       allow(helper).to receive_messages(document_has_value?: true)
     end
 
-    it "should be true" do
+    it "is true" do
       expect(helper.should_render_field?(field_config)).to be true
     end
     
-    it "should be false if the :if condition is false" do
+    it "is false if the :if condition is false" do
       allow(field_config).to receive_messages(if: false)
       expect(helper.should_render_field?(field_config)).to be false
     end
     
-    it "should be false if the :unless condition is true" do
+    it "is false if the :unless condition is true" do
       allow(field_config).to receive_messages(unless: true)
       expect(helper.should_render_field?(field_config)).to be false
     end
@@ -241,7 +241,7 @@ describe BlacklightConfigurationHelper do
       allow(helper).to receive_messages(blacklight_config: @config)
     end
     
-    it "should return proper options_for_select arguments" do
+    it "returns proper options_for_select arguments" do
 
       select_arguments = helper.search_field_options_for_select
 
@@ -253,7 +253,7 @@ describe BlacklightConfigurationHelper do
       end    
     end
 
-    it "should not include fields in select if :display_in_simple_search=>false" do
+    it "does not include fields in select if :display_in_simple_search=>false" do
       select_arguments = helper.search_field_options_for_select
 
       expect(select_arguments).not_to include(["No Display", "no_display"])