blacklight 7.11.1 → 7.12.0

data/spec/components/blacklight/document_component_spec.rb

@@ -87,6 +87,14 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       expect(rendered).to have_selector 'header', text: '5. Title'
     end
 
+    context 'with a document rendered as part of a collection' do
+      let(:attr) { { document_counter: 10, counter_offset: 100 } }
+
+      it 'renders a counter with the title' do
+        expect(rendered).to have_selector 'header', text: '111. Title'
+      end
+    end
+
     it 'renders actions' do
       expect(rendered).to have_selector '.index-document-functions'
     end

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -36,7 +36,6 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
   end
 
   it 'has the facet hierarchy' do
-    puts render
     expect(rendered).to have_selector 'li ul.pivot-facet'
     expect(rendered).to have_link 'x:1', href: /f%5Bz%5D%5B%5D=x%3A1/
   end

data/spec/components/blacklight/system/flash_message_component_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::System::FlashMessageComponent, type: :component do
+  subject(:component) { described_class.new(message: message, type: type) }
+
+  let(:view_context) { controller.view_context }
+  let(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+  let(:message) { 'This is an important message' }
+  let(:type) { 'whatever' }
+
+  it 'renders a message inside an alert' do
+    expect(rendered).to have_selector 'div.alert.alert-whatever', text: message
+  end
+
+  context 'with a success message' do
+    let(:type) { 'success' }
+
+    it 'adds some styling' do
+      expect(rendered).to have_selector 'div.alert-success'
+    end
+  end
+
+  context 'with a notice message' do
+    let(:type) { 'notice' }
+
+    it 'adds some styling' do
+      expect(rendered).to have_selector 'div.alert-info'
+    end
+  end
+
+  context 'with an alert message' do
+    let(:type) { 'alert' }
+
+    it 'adds some styling' do
+      expect(rendered).to have_selector 'div.alert-warning'
+    end
+  end
+
+  context 'with an error message' do
+    let(:type) { 'error' }
+
+    it 'adds some styling' do
+      expect(rendered).to have_selector 'div.alert-danger'
+    end
+  end
+end

data/spec/controllers/blacklight/search_fields_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::SearchFields do
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   class MockConfig
     include Blacklight::SearchFields
   end

data/spec/controllers/catalog_controller_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe CatalogController, api: true do
+  around { |test| Deprecation.silence(Blacklight::Catalog) { test.call } }
+
   let(:doc_id) { '2007020969' }
   let(:mock_response) { instance_double(Blacklight::Solr::Response) }
   let(:mock_document) { instance_double(SolrDocument, export_formats: {}) }

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -3,6 +3,8 @@
 RSpec.describe Blacklight::FacetsHelperBehavior do
   let(:blacklight_config) { Blacklight::Configuration.new }
 
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   before do
     allow(helper).to receive(:blacklight_config).and_return blacklight_config
   end
@@ -103,6 +105,8 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
   end
 
   describe "facet_by_field_name" do
+    around { |test| Deprecation.silence(Blacklight::Facet) { test.call } }
+
     it "retrieves the facet from the response given a string" do
       facet_config = double(query: nil, field: 'b', key: 'a')
       facet_field = double
@@ -133,7 +137,6 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
       expect(helper).to receive(:render_facet_limit).with(a, {})
       expect(helper).to receive(:render_facet_limit).with(b, {})
       helper.render_facet_partials
-      expect(Deprecation).to have_received(:warn).twice
     end
   end
 
@@ -233,6 +236,8 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
         allow(helper).to receive(:render_facet_item).and_return('<a class="facet-select">Book</a>'.html_safe, nil)
       end
 
+      around { |test| Deprecation.silence(Blacklight::FacetItemComponent) { test.call } }
+
       it "draws a list of elements" do
         expect(subject).to have_selector 'li', count: 1
         expect(subject).to have_selector 'li:first-child a.facet-select', text: 'Book'

data/spec/helpers/blacklight/hash_as_hidden_fields_behavior_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::HashAsHiddenFieldsHelperBehavior do
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   let(:params) do
     { q: "query",
       search_field: "search_field",

data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   let(:config) do
     Blacklight::Configuration.new do |config|
       config.add_facet_field 'type'

data/spec/helpers/blacklight/render_partials_helper_behavior_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::RenderPartialsHelperBehavior do
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   describe "#type_field_to_partial_name" do
     subject { helper.send(:type_field_to_partial_name, document, value) }
 
@@ -49,7 +51,7 @@ RSpec.describe Blacklight::RenderPartialsHelperBehavior do
     let(:blacklight_config) { Blacklight::Configuration.new }
 
     before do
-      allow(helper).to receive_messages(blacklight_config: blacklight_config)
+      allow(helper).to receive_messages(blacklight_config: blacklight_config, action_name: 'show')
     end
 
     context "with a solr document with empty fields" do

data/spec/helpers/blacklight/url_helper_behavior_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::UrlHelperBehavior do
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
       config.index.title_field = 'title_tsim'

data/spec/helpers/blacklight_helper_spec.rb

@@ -213,6 +213,8 @@ RSpec.describe BlacklightHelper do
   end
 
   describe '#render_index_field_label' do
+    around { |test| Deprecation.silence(Blacklight::BlacklightHelperBehavior) { test.call } }
+
     let(:doc) { SolrDocument.new({}) }
 
     before do
@@ -246,6 +248,8 @@ RSpec.describe BlacklightHelper do
   end
 
   describe "should_show_spellcheck_suggestions?" do
+    around { |test| Deprecation.silence(Blacklight::BlacklightHelperBehavior) { test.call } }
+
     before do
       allow(helper).to receive_messages spell_check_max: 5
     end
@@ -366,6 +370,8 @@ RSpec.describe BlacklightHelper do
     let(:presenter_class) { double }
     let(:blacklight_config) { Blacklight::Configuration.new }
 
+    around { |test| Deprecation.silence(Blacklight::BlacklightHelperBehavior) { test.call } }
+
     before do
       allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
     end
@@ -394,6 +400,8 @@ RSpec.describe BlacklightHelper do
   end
 
   describe "#render_document_heading" do
+    around { |test| Deprecation.silence(Blacklight::BlacklightHelperBehavior) { test.call } }
+
     let(:document) { double }
 
     before do
@@ -420,6 +428,8 @@ RSpec.describe BlacklightHelper do
   end
 
   describe "#presenter" do
+    around { |test| Deprecation.silence(Blacklight::BlacklightHelperBehavior) { test.call } }
+
     let(:document) { double }
 
     before do

data/spec/helpers/catalog_helper_spec.rb

@@ -166,7 +166,7 @@ RSpec.describe CatalogHelper do
 
   describe "should_autofocus_on_search_box?" do
     before do
-      expect(Deprecation).to receive(:warn)
+      allow(Deprecation).to receive(:warn)
     end
 
     it "is focused if we're on a catalog-like index page without query or facet parameters" do
@@ -192,7 +192,7 @@ RSpec.describe CatalogHelper do
 
   describe "has_thumbnail?" do
     before do
-      expect(Deprecation).to receive(:warn)
+      allow(Deprecation).to receive(:warn)
     end
 
     let(:document) { SolrDocument.new(data) }
@@ -231,7 +231,7 @@ RSpec.describe CatalogHelper do
     let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter) }
 
     before do
-      expect(Deprecation).to receive(:warn)
+      allow(Deprecation).to receive(:warn)
       allow(helper).to receive(:index_presenter).with(document).and_return(index_presenter)
     end
 
@@ -250,7 +250,7 @@ RSpec.describe CatalogHelper do
 
   describe "thumbnail_url" do
     before do
-      expect(Deprecation).to receive(:warn)
+      allow(Deprecation).to receive(:warn)
     end
 
     it "pulls the configured thumbnail field out of the document" do

data/spec/lib/blacklight/configuration/facet_field_spec.rb

@@ -10,4 +10,21 @@ RSpec.describe Blacklight::Configuration::FacetField do
       expect(subject.link_to_facet).to eq true
     end
   end
+
+  describe '#normalize!' do
+    it 'preserves existing properties' do
+      expected = double
+      subject.presenter = expected
+
+      subject.normalize!
+
+      expect(subject.presenter).to eq expected
+    end
+
+    it 'adds a default presenter' do
+      subject.normalize!
+
+      expect(subject.presenter).to eq Blacklight::FacetFieldPresenter
+    end
+  end
 end

data/spec/models/blacklight/search_builder_spec.rb

@@ -183,7 +183,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       end
     end
 
-    context "when the user provides an sort parameter" do
+    context "when the user provides a sort parameter" do
       subject(:sort) { builder_with_param.send(:sort) }
 
       let(:builder_with_param) { builder.with(sort: 'x') }

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -331,6 +331,14 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
         end
       end
 
+      context "when the user provides a valid customized sort parmeter" do
+        let(:user_params) { { sort: 'year-desc' } }
+
+        it "passes solr sort paramters through" do
+          expect(subject[:sort]).to eq 'pub_date_si desc, title_si asc'
+        end
+      end
+
       context "when the user provides an invalid sort parameter" do
         let(:user_params) { { sort: 'bad' } }
 

data/spec/presenters/blacklight/field_presenter_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Blacklight::FieldPresenter, api: true do
   subject(:presenter) { described_class.new(request_context, document, field_config, options) }
 
-  let(:request_context) { double('View context', search_state: search_state, should_render_field?: true, blacklight_config: config) }
+  let(:request_context) { double('View context', params: { x: '1' }, search_state: search_state, should_render_field?: true, blacklight_config: config) }
   let(:document) do
     SolrDocument.new(id: 1,
                      'link_to_facet_true' => 'x',
@@ -18,6 +18,14 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
 
   let(:field_config) { config.index_fields[field_name] }
   let(:field_name) { 'asdf' }
+
+  let(:custom_step) do
+    Class.new(Blacklight::Rendering::AbstractStep) do
+      def render
+        'Static step'
+      end
+    end
+  end
   let(:config) do
     Blacklight::Configuration.new.configure do |config|
       config.add_index_field 'qwer'
@@ -29,8 +37,10 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       config.add_index_field 'explicit_accessor', accessor: :solr_doc_accessor
       config.add_index_field 'explicit_array_accessor', accessor: [:solr_doc_accessor, :some_method]
       config.add_index_field 'explicit_values', values: ->(_config, _doc) { ['some-value'] }
+      config.add_index_field 'explicit_values_with_context', values: ->(_config, _doc, view_context) { [view_context.params[:x]] }
       config.add_index_field 'alias', field: 'qwer'
       config.add_index_field 'with_default', default: 'value'
+      config.add_index_field 'with_steps', steps: [custom_step]
     end
   end
 
@@ -154,10 +164,19 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       let(:field_name) { 'explicit_values' }
 
       it 'calls the accessors on the return of the preceeding' do
+        allow(Deprecation).to receive(:warn)
         expect(subject).to eq 'some-value'
       end
     end
 
+    context 'when the values lambda is provided and accepts the view contexts' do
+      let(:field_name) { 'explicit_values_with_context' }
+
+      it 'calls the accessors on the return of the preceeding' do
+        expect(subject).to eq '1'
+      end
+    end
+
     context 'when the field is an alias' do
       let(:field_name) { 'alias' }
 
@@ -170,6 +189,12 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       it { is_expected.to eq 'value' }
     end
 
+    context 'with steps' do
+      let(:field_name) { 'with_steps' }
+
+      it { is_expected.to eq 'Static step' }
+    end
+
     context 'for a field with the helper_method option' do
       let(:field_name) { 'field_with_helper' }
       let(:field_config) { config.add_facet_field 'field_with_helper', helper_method: 'render_field_with_helper' }
@@ -212,7 +237,7 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
   describe '#render_field?' do
     subject { presenter.render_field? }
 
-    let(:field_config) { double('field config', if: true, unless: false) }
+    let(:field_config) { double('field config', if: true, unless: false, except_operations: nil) }
 
     before do
       allow(presenter).to receive_messages(document_has_value?: true)
@@ -235,7 +260,7 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
     subject { presenter.any? }
 
     context 'when the document has the field value' do
-      let(:field_config) { double(field: 'asdf', highlight: false, accessor: nil, default: nil, values: nil) }
+      let(:field_config) { double(field: 'asdf', highlight: false, accessor: nil, default: nil, values: nil, except_operations: nil) }
 
       before do
         allow(document).to receive(:fetch).with('asdf', nil).and_return(['value'])
@@ -245,7 +270,7 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
     end
 
     context 'when the document has a highlight field value' do
-      let(:field_config) { double(field: 'asdf', highlight: true) }
+      let(:field_config) { double(field: 'asdf', highlight: true, except_operations: nil) }
 
       before do
         allow(document).to receive(:has_highlight_field?).with('asdf').and_return(true)
@@ -256,7 +281,7 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
     end
 
     context 'when the field is a model accessor' do
-      let(:field_config) { double(field: 'asdf', highlight: false, accessor: true) }
+      let(:field_config) { double(field: 'asdf', highlight: false, accessor: true, except_operations: nil) }
 
       before do
         allow(document).to receive(:send).with('asdf').and_return(['value'])

data/spec/services/blacklight/search_service_spec.rb

@@ -131,7 +131,7 @@ RSpec.describe Blacklight::SearchService, api: true do
         expect(solr_response.docs).to have_at_least(1).result
       end
       # TODO: check that number of these results < number of results for all docs query
-      #   BUT can't: num docs isn't total, it's the num docs in the single SOLR response (e.g. 10)
+      #   BUT can't: num docs isn't total, it's the num docs in the single Solr response (e.g. 10)
     end
 
     describe "for Query Without Results and No Facet" do
@@ -334,10 +334,6 @@ RSpec.describe Blacklight::SearchService, api: true do
     it 'has the expected value in the id field' do
       expect(@document.id).to eq doc_id
     end
-
-    it 'has non-nil values for required fields set in initializer' do
-      expect(@document.fetch(blacklight_config.view_config(:show).display_type_field)).not_to be_nil
-    end
   end
 
   describe 'Get multiple documents By Id', integration: true do

data/spec/views/catalog/_constraints.html.erb_spec.rb

@@ -9,8 +9,9 @@ RSpec.describe "catalog/constraints" do
 
   it "renders nothing if no constraints are set" do
     allow(view).to receive_messages(query_has_constraints?: false)
+    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     render partial: "catalog/constraints"
-    expect(rendered).to be_empty
+    expect(rendered.strip).to be_empty
   end
 
   it "renders a start over link" do

data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb

@@ -3,12 +3,14 @@
 RSpec.describe 'catalog/_facet_index_navigation.html.erb', type: :view do
   let(:pagination) { Blacklight::Solr::FacetPaginator.new([]) }
   let(:facet) { Blacklight::Configuration::FacetField.new(index_range: '0'..'9') }
+  let(:display_facet) { double(items: [], offset: 0, prefix: '', sort: 'index') }
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
-    assign(:pagination, pagination)
+    assign(:display_facet, display_facet)
     assign(:facet, facet)
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
+    allow(view).to receive(:facet_limit_for).and_return(10)
     controller.request.path_parameters[:action] = 'index'
   end
 
@@ -27,7 +29,7 @@ RSpec.describe 'catalog/_facet_index_navigation.html.erb', type: :view do
   end
 
   context 'with a selected index' do
-    let(:pagination) { Blacklight::Solr::FacetPaginator.new([], prefix: '5') }
+    let(:display_facet) { double(items: [], offset: 0, prefix: '5', sort: 'index') }
 
     it 'highlights the selected index' do
       render