blacklight 7.12.1 → 7.13.0

data/package.json

@@ -10,6 +10,10 @@
     "type": "git",
     "url": "git+https://github.com/projectblacklight/blacklight.git"
   },
+  "files": [
+    "app/assets",
+    "app/javascript"
+  ],
   "author": "",
   "license": "Apache-2.0",
   "bugs": {

data/spec/components/blacklight/document_component_spec.rb

@@ -42,11 +42,13 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   it 'has some defined content areas' do
     component.with(:title, 'Title')
+    component.with(:embed, 'Embed')
     component.with(:metadata, 'Metadata')
     component.with(:thumbnail, 'Thumbnail')
     component.with(:actions, 'Actions')
 
     expect(rendered).to have_content 'Title'
+    expect(rendered).to have_content 'Embed'
     expect(rendered).to have_content 'Metadata'
     expect(rendered).to have_content 'Thumbnail'
     expect(rendered).to have_content 'Actions'
@@ -126,6 +128,19 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       expect(rendered).to have_selector 'dt', text: 'ISBN:'
       expect(rendered).to have_selector 'dd', text: 'Value'
     end
+
+    it 'renders an embed' do
+      stub_const('StubComponent', Class.new(ViewComponent::Base) do
+        def initialize(**); end
+
+        def call
+          'embed'
+        end
+      end)
+
+      blacklight_config.show.embed_component = StubComponent
+      expect(rendered).to have_content 'embed'
+    end
   end
 
   it 'renders metadata' do

data/spec/features/search_spec.rb

@@ -115,9 +115,4 @@ RSpec.describe "Search Page" do
     expect(page).to have_content "Welcome!"
     expect(page).not_to have_selector "#q[value='history']"
   end
-
-  it "handles searches with invalid facet parameters" do
-    visit root_path f: { missing_s: [1] }
-    expect(page).to have_content "No results found for your search"
-  end
 end

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -122,8 +122,7 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe "#view_label" 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")
+      allow(blacklight_config).to receive(:view).and_return("my_view" => double(display_label: "some label"))
 
       helper.view_label "my_view"
     end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::Configuration::ViewConfig do
+  subject { described_class.new(key: key, label: label) }
+
+  let(:key) { 'my_view' }
+  let(:label) { 'some label' }
+
+  describe '#display_label' do
+    it "looks up the label to display for the given document and field" do
+      allow(I18n).to receive(:t).with(:"blacklight.search.view_title.my_view", default: [:"blacklight.search.view.my_view", label, nil, "My view"]).and_return('x')
+      expect(subject.display_label(key)).to eq 'x'
+    end
+  end
+end

data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb

@@ -14,4 +14,13 @@ RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
       expect(copy.a[:b]).to eq 1
     end
   end
+
+  describe '#<<' do
+    subject { described_class.new(Blacklight::Configuration::Field) }
+
+    it 'includes the key in the hash' do
+      subject << :blah
+      expect(subject.blah).to have_attributes(key: :blah)
+    end
+  end
 end

data/spec/lib/blacklight/search_state/filter_field_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::SearchState::FilterField do
+  let(:search_state) { Blacklight::SearchState.new(params.with_indifferent_access, blacklight_config, controller) }
+
+  let(:params) { { f: { some_field: %w[1 2], another_field: ['3'] } } }
+  let(:blacklight_config) do
+    Blacklight::Configuration.new.configure do |config|
+      config.add_facet_field 'some_field'
+      config.add_facet_field 'another_field', single: true
+    end
+  end
+  let(:controller) { double }
+
+  describe '#add' do
+    it 'adds the parameter to the filter list' do
+      filter = search_state.filter('some_field')
+      new_state = filter.add('4')
+
+      expect(new_state.filter('some_field').values).to eq %w[1 2 4]
+    end
+
+    it 'creates new parameter as needed' do
+      filter = search_state.filter('unknown_field')
+      new_state = filter.add('4')
+
+      expect(new_state.filter('unknown_field').values).to eq %w[4]
+      expect(new_state.params[:f]).to include(:unknown_field)
+    end
+
+    context 'without any parameters in the url' do
+      let(:params) { {} }
+
+      it 'adds the necessary structure' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add('1')
+
+        expect(new_state.filter('some_field').values).to eq %w[1]
+        expect(new_state.params).to include(:f)
+      end
+    end
+
+    context 'with a single-valued field' do
+      it 'replaces any existing parameter from the filter list' do
+        filter = search_state.filter('another_field')
+        new_state = filter.add('5')
+
+        expect(new_state.filter('another_field').values).to eq %w[5]
+      end
+    end
+
+    context 'with a pivot facet-type item' do
+      it 'includes the pivot facet fqs' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(OpenStruct.new(fq: { some_other_field: '5' }, value: '4'))
+
+        expect(new_state.filter('some_field').values).to eq %w[1 2 4]
+        expect(new_state.filter('some_other_field').values).to eq %w[5]
+      end
+
+      it 'handles field indirection' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(OpenStruct.new(field: 'some_other_field', value: '4'))
+
+        expect(new_state.filter('some_other_field').values).to eq %w[4]
+      end
+
+      it 'handles value indirection' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(OpenStruct.new(value: '4'))
+
+        expect(new_state.filter('some_field').values).to eq %w[1 2 4]
+      end
+    end
+  end
+
+  describe '#remove' do
+    it 'returns a search state without the given filter applied' do
+      filter = search_state.filter('some_field')
+      new_state = filter.remove('1')
+
+      expect(new_state.filter('some_field').values).to eq ['2']
+    end
+
+    it 'removes the whole field if there are no filter left for the field' do
+      filter = search_state.filter('another_field')
+      new_state = filter.remove('3')
+
+      expect(new_state.filter('another_field').values).to eq []
+      expect(new_state.params[:f]).not_to include :another_field
+    end
+
+    it 'removes the filter parameter entirely if there are no filters left' do
+      new_state = search_state.filter('some_field').remove('1')
+      new_state = new_state.filter('some_field').remove('2')
+      new_state = new_state.filter('another_field').remove('3')
+
+      expect(new_state.params).not_to include :f
+    end
+
+    it 'handles value indirection' do
+      filter = search_state.filter('some_field')
+      new_state = filter.remove(OpenStruct.new(value: '1'))
+
+      expect(new_state.filter('some_field').values).to eq ['2']
+    end
+  end
+
+  describe '#values' do
+    it 'returns the currently selected values of the filter' do
+      expect(search_state.filter('some_field').values).to eq %w[1 2]
+    end
+  end
+
+  describe '#include?' do
+    it 'checks whether the value is currently selected' do
+      expect(search_state.filter('some_field').include?('1')).to eq true
+      expect(search_state.filter('some_field').include?('3')).to eq false
+    end
+
+    it 'handles value indirection' do
+      expect(search_state.filter('some_field').include?(OpenStruct.new(value: '1'))).to eq true
+    end
+  end
+end

data/spec/lib/blacklight/search_state_spec.rb

@@ -3,6 +3,8 @@
 RSpec.describe Blacklight::SearchState do
   subject(:search_state) { described_class.new(params, blacklight_config, controller) }
 
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
       config.index.title_field = 'title_tsim'
@@ -242,9 +244,9 @@ RSpec.describe Blacklight::SearchState do
       end
 
       it "uses the facet's key in the url" do
-        allow(search_state).to receive(:facet_configuration_for_field).with('some_field').and_return(double(single: true, field: "a_solr_field", key: "some_key"))
+        blacklight_config.add_facet_field 'some_key', single: true, field: "a_solr_field"
 
-        result_params = search_state.add_facet_params('some_field', 'my_value')
+        result_params = search_state.add_facet_params('some_key', 'my_value')
 
         expect(result_params[:f]['some_key']).to have(1).item
         expect(result_params[:f]['some_key'].first).to eq 'my_value'
@@ -284,7 +286,7 @@ RSpec.describe Blacklight::SearchState do
       let(:params) { parameter_class.new f: { 'single_value_facet_field' => 'other_value' } }
 
       it "replaces facets configured as single" do
-        allow(search_state).to receive(:facet_configuration_for_field).with('single_value_facet_field').and_return(double(single: true, key: "single_value_facet_field"))
+        blacklight_config.add_facet_field 'single_value_facet_field', single: true
         result_params = search_state.add_facet_params('single_value_facet_field', 'my_value')
 
         expect(result_params[:f]['single_value_facet_field']).to have(1).item
@@ -415,4 +417,131 @@ RSpec.describe Blacklight::SearchState do
       expect(new_state.to_hash).to eq('a' => 1)
     end
   end
+
+  describe '#page' do
+    context 'with a page' do
+      let(:params) { { 'page' => '3' } }
+
+      it 'is mapped from page' do
+        expect(search_state.page).to eq 3
+      end
+    end
+
+    context 'without a page' do
+      let(:params) { {} }
+
+      it 'is defaults to page 1' do
+        expect(search_state.page).to eq 1
+      end
+
+      context 'with negative numbers or other bad data' do
+        let(:params) { { 'page' => '-3' } }
+
+        it 'is defaults to page 1' do
+          expect(search_state.page).to eq 1
+        end
+      end
+    end
+  end
+
+  describe '#per_page' do
+    context 'with rows' do
+      let(:params) { { rows: '30' } }
+
+      it 'maps from rows' do
+        expect(search_state.per_page).to eq 30
+      end
+    end
+
+    context 'with per_page' do
+      let(:params) { { per_page: '14' } }
+
+      it 'maps from rows' do
+        expect(search_state.per_page).to eq 14
+      end
+    end
+
+    context 'it defaults to the configured value' do
+      let(:params) { {} }
+
+      it 'maps from rows' do
+        expect(search_state.per_page).to eq 10
+      end
+    end
+  end
+
+  describe '#sort_field' do
+    let(:params) { { 'sort' => 'author' } }
+
+    before do
+      blacklight_config.add_sort_field 'relevancy', label: 'relevance'
+      blacklight_config.add_sort_field 'author', label: 'asd'
+    end
+
+    it 'returns the current search field' do
+      expect(search_state.sort_field).to have_attributes(key: 'author')
+    end
+
+    context 'without a search field' do
+      let(:params) { {} }
+
+      it 'returns the current search field' do
+        expect(search_state.sort_field).to have_attributes(key: 'relevancy')
+      end
+    end
+  end
+
+  describe '#search_field' do
+    let(:params) { { 'search_field' => 'author' } }
+
+    before do
+      blacklight_config.add_search_field 'author', label: 'asd'
+    end
+
+    it 'returns the current search field' do
+      expect(search_state.search_field).to have_attributes(key: 'author')
+    end
+  end
+
+  describe '#facet_page' do
+    context 'with a page' do
+      let(:params) { { 'facet.page' => '3' } }
+
+      it 'is mapped from facet.page' do
+        expect(search_state.facet_page).to eq 3
+      end
+    end
+
+    context 'without a page' do
+      let(:params) { {} }
+
+      it 'is defaults to page 1' do
+        expect(search_state.facet_page).to eq 1
+      end
+    end
+
+    context 'with negative numbers or other bad data' do
+      let(:params) { { 'facet.page' => '-3' } }
+
+      it 'is defaults to page 1' do
+        expect(search_state.facet_page).to eq 1
+      end
+    end
+  end
+
+  describe '#facet_sort' do
+    let(:params) { { 'facet.sort' => 'index' } }
+
+    it 'is mapped from facet.sort' do
+      expect(search_state.facet_sort).to eq 'index'
+    end
+  end
+
+  describe '#facet_prefix' do
+    let(:params) { { 'facet.prefix' => 'A' } }
+
+    it 'is mapped from facet.prefix' do
+      expect(search_state.facet_prefix).to eq 'A'
+    end
+  end
 end

data/spec/models/blacklight/configuration_spec.rb

@@ -62,6 +62,14 @@ RSpec.describe "Blacklight::Configuration", api: true do
     end
   end
 
+  describe 'config.index.document_actions' do
+    it 'allows you to use the << operator' do
+      config.index.document_actions << :blah
+      expect(config.index.document_actions.blah).to have_attributes key: :blah
+      expect(config.index.document_actions.blah.name).to eq :blah
+    end
+  end
+
   describe "config.index.respond_to" do
     it "has a list of additional formats for index requests to respond to" do
       config.index.respond_to.xml = true

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

@@ -186,9 +186,9 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
     end
 
     describe "for request params also passed in as argument" do
-      let(:user_params) { { q: "some query", 'q' => 'another value' } }
+      let(:user_params) { { 'q' => 'another value', q: "some query" } }
 
-      it "onlies have one value for the key 'q' regardless if a symbol or string" do
+      it "only has one value for the key 'q' regardless if a symbol or string" do
         expect(subject[:q]).to eq 'some query'
         expect(subject['q']).to eq 'some query'
       end
@@ -244,6 +244,21 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe 'with a facet with a custom filter query builder' do
+      let(:user_params) { { f: { some: ['value'] } }.with_indifferent_access }
+
+      before do
+        blacklight_config.add_facet_field 'some', filter_query_builder: (lambda do |*_args|
+          ['some:filter', { qq1: 'abc' }]
+        end)
+      end
+
+      it "has proper solr parameters" do
+        expect(subject[:fq]).to include('some:filter')
+        expect(subject[:qq1]).to include('abc')
+      end
+    end
+
     describe "solr parameters for a field search from config (subject)" do
       let(:user_params) { subject_search_params }
 
@@ -384,6 +399,21 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe 'the search field query_builder config' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new do |config|
+          config.add_search_field('built_query', query_builder: ->(builder, *_args) { [builder.blacklight_params[:q].reverse, qq1: 'xyz'] })
+        end
+      end
+
+      let(:user_params) { { search_field: 'built_query', q: 'value' } }
+
+      it 'uses the provided query builder' do
+        expect(subject[:q]).to eq 'eulav'
+        expect(subject[:qq1]).to eq 'xyz'
+      end
+    end
+
     describe "mapping facet.field" do
       let(:blacklight_config) do
         Blacklight::Configuration.new do |config|