blacklight 7.17.2 → 7.19.2

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -5,7 +5,8 @@ module Blacklight::Solr
 
     included do
       self.default_processor_chain = [
-        :default_solr_parameters, :add_query_to_solr, :add_facet_fq_to_solr,
+        :default_solr_parameters, :add_search_field_default_parameters,
+        :add_query_to_solr, :add_facet_fq_to_solr,
         :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr,
         :add_sorting_to_solr, :add_group_config_to_solr,
         :add_facet_paging_to_solr, :add_adv_search_clauses,
@@ -18,21 +19,17 @@ module Blacklight::Solr
     # merge to dup values, to avoid later mutating the original by mistake.
     def default_solr_parameters(solr_parameters)
       blacklight_config.default_solr_params.each do |key, value|
-        solr_parameters[key] = if value.respond_to? :deep_dup
-                                 value.deep_dup
-                               elsif value.respond_to?(:dup) && value.duplicable?
-                                 value.dup
-                               else
-                                 value
-                               end
+        solr_parameters[key] ||= if value.respond_to? :deep_dup
+                                   value.deep_dup
+                                 elsif value.respond_to?(:dup) && value.duplicable?
+                                   value.dup
+                                 else
+                                   value
+                                 end
       end
     end
 
-    ##
-    # Take the user-entered query, and put it in the solr params,
-    # including config's "search field" params for current search field.
-    # also include setting spellcheck.q.
-    def add_query_to_solr(solr_parameters)
+    def add_search_field_default_parameters(solr_parameters)
       ###
       # legacy behavior of user param :qt is passed through, but over-ridden
       # by actual search field config if present. We might want to remove
@@ -46,10 +43,21 @@ module Blacklight::Solr
       ###
       # Merge in search field configured values, if present, over-writing general
       # defaults
-
       if search_field
         solr_parameters[:qt] = search_field.qt if search_field.qt
-        solr_parameters.merge!(search_field.solr_parameters) if search_field.solr_parameters
+
+        solr_parameters.deep_merge!(search_field.solr_parameters) if search_field.solr_parameters
+      end
+    end
+
+    ##
+    # Take the user-entered query, and put it in the solr params,
+    # including config's "search field" params for current search field.
+    # also include setting spellcheck.q.
+    def add_query_to_solr(solr_parameters)
+      unless processor_chain.include?(:add_search_field_default_parameters)
+        Deprecation.warn(Blacklight::Solr::SearchBuilderBehavior, 'Please include :add_search_field_default_parameters in your process chain')
+        add_search_field_default_parameters(solr_parameters)
       end
 
       ##
@@ -64,7 +72,10 @@ module Blacklight::Solr
       elsif search_field&.solr_local_parameters.present?
         add_search_field_with_local_parameters(solr_parameters)
       elsif search_state.query_param.is_a? Hash
-        add_additional_filters(solr_parameters, search_state.query_param)
+        if search_state.query_param == @additional_filters && !processor_chain.include?(:add_additional_filters)
+          Deprecation.warn(Blacklight::Solr::SearchBuilderBehavior, 'Expecting to see the processor step add_additional_filters; falling back to legacy query handling')
+          add_additional_filters(solr_parameters, search_state.query_param)
+        end
       elsif search_state.query_param
         solr_parameters.append_query search_state.query_param
       end
@@ -322,6 +333,7 @@ module Blacklight::Solr
     # around the term unless it's a bare-word. Escape internal quotes
     # if needed.
     def solr_param_quote(val, options = {})
+      val = val.to_s
       options[:quote] ||= '"'
       unless val =~ /^[a-zA-Z0-9$_\-\^]+$/
         val = options[:quote] +

data/lib/generators/blacklight/install_generator.rb

@@ -37,8 +37,10 @@ module Blacklight
     end
 
     def bundle_install
-      Bundler.with_clean_env do
-        run "bundle install"
+      inside destination_root do
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
     end
 
@@ -81,9 +83,7 @@ module Blacklight
       blacklight_marc = String.new('blacklight-marc')
       gem blacklight_marc, '>= 7.0.0.rc1', '< 8'
 
-      Bundler.with_clean_env do
-        run "bundle install"
-      end
+      bundle_install
 
       generate 'blacklight:marc:install'
     end

data/lib/generators/blacklight/solr_generator.rb

@@ -35,8 +35,10 @@ module Blacklight
     end
 
     def bundle_install
-      Bundler.with_clean_env do
-        run "bundle install"
+      inside destination_root do
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
     end
   end

data/lib/generators/blacklight/user_generator.rb

@@ -24,8 +24,10 @@ module Blacklight
       gem "devise"
       gem "devise-guests", "~> 0.6"
 
-      Bundler.with_clean_env do
-        run "bundle install"
+      inside destination_root do
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
 
       generate "devise:install"

data/spec/components/blacklight/constraint_layout_component_spec.rb

@@ -3,12 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
-  subject(:render) do
-    render_inline(described_class.new(**params))
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(**params))
   end
 
   describe "for simple display" do
@@ -39,7 +35,7 @@ RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
 
     it "has an accessible remove label" do
       expect(rendered).to have_selector(".remove") do |s|
-        expect(s).to have_selector('.sr-only', text: 'Remove constraint my label: my value')
+        expect(s).to have_selector('.visually-hidden', text: 'Remove constraint my label: my value')
       end
     end
   end

data/spec/components/blacklight/facet_field_checkboxes_component_spec.rb

@@ -3,12 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetFieldCheckboxesComponent, type: :component do
-  subject(:render) do
-    render_inline(described_class.new(facet_field: facet_field))
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(facet_field: facet_field))
   end
 
   let(:facet_field) do
@@ -40,7 +36,7 @@ RSpec.describe Blacklight::FacetFieldCheckboxesComponent, type: :component do
   it 'renders a collapsible card' do
     expect(rendered).to have_selector '.card'
     expect(rendered).to have_button 'Field'
-    expect(rendered).to have_selector 'button[data-target="#facet-field"]'
+    expect(rendered).to have_selector 'button[data-bs-target="#facet-field"]'
     expect(rendered).to have_selector '#facet-field.collapse.show'
   end
 

data/spec/components/blacklight/facet_field_list_component_spec.rb

@@ -3,12 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
-  subject(:render) do
-    render_inline(described_class.new(facet_field: facet_field))
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(facet_field: facet_field))
   end
 
   let(:facet_field) do
@@ -35,7 +31,7 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
   it 'renders a collapsible card' do
     expect(rendered).to have_selector '.card'
     expect(rendered).to have_button 'Field'
-    expect(rendered).to have_selector 'button[data-target="#facet-field"]'
+    expect(rendered).to have_selector 'button[data-bs-target="#facet-field"]'
     expect(rendered).to have_selector '#facet-field.collapse.show'
   end
 

data/spec/components/blacklight/facet_item_component_spec.rb

@@ -3,12 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetItemComponent, type: :component do
-  subject(:render) do
-    render_inline(described_class.new(facet_item: facet_item))
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(facet_item: facet_item))
   end
 
   let(:facet_item) do

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -3,12 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
-  subject(:render) do
-    render_inline(described_class.new(facet_item: facet_item))
-  end
-
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(facet_item: facet_item))
   end
 
   let(:search_state) do
@@ -31,7 +27,7 @@ RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
 
   it 'links to the facet and shows the number of hits' do
     expect(rendered).to have_selector 'li'
-    expect(rendered).to have_link 'x', href: '/catalog?f[z]=x'
+    expect(rendered).to have_link 'x', href: '/catalog?f%5Bz%5D=x'
     expect(rendered).to have_selector '.facet-count', text: '10'
   end
 

data/spec/components/blacklight/hidden_search_state_component_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::HiddenSearchStateComponent, type: :component do
-  subject(:render) { render_inline(instance) }
+  subject(:rendered) { render_inline_to_capybara_node(instance) }
 
   let(:params) do
     { q: "query",
@@ -11,14 +11,13 @@ RSpec.describe Blacklight::HiddenSearchStateComponent, type: :component do
       f: { field1: %w[a b], field2: ["z"] } }
   end
   let(:instance) { described_class.new(params: params) }
-  let(:generated) { Capybara::Node::Simple.new("<div>#{render.to_html}</div>") }
 
   it "converts a hash with nested complex data to Rails-style hidden form fields" do
-    expect(generated).to have_selector("input[type='hidden'][name='q'][value='query']", visible: :hidden)
-    expect(generated).to have_selector("input[type='hidden'][name='per_page'][value='10']", visible: :hidden)
-    expect(generated).to have_selector("input[type='hidden'][name='extra_arbitrary_key'][value='arbitrary_value']", visible: :hidden)
-    expect(generated).to have_selector("input[type='hidden'][name='f[field2][]'][value='z']", visible: :hidden)
-    expect(generated).to have_selector("input[type='hidden'][name='f[field1][]'][value='a']", visible: :hidden)
-    expect(generated).to have_selector("input[type='hidden'][name='f[field1][]'][value='b']", visible: :hidden)
+    expect(rendered).to have_selector("input[type='hidden'][name='q'][value='query']", visible: :hidden)
+    expect(rendered).to have_selector("input[type='hidden'][name='per_page'][value='10']", visible: :hidden)
+    expect(rendered).to have_selector("input[type='hidden'][name='extra_arbitrary_key'][value='arbitrary_value']", visible: :hidden)
+    expect(rendered).to have_selector("input[type='hidden'][name='f[field2][]'][value='z']", visible: :hidden)
+    expect(rendered).to have_selector("input[type='hidden'][name='f[field1][]'][value='a']", visible: :hidden)
+    expect(rendered).to have_selector("input[type='hidden'][name='f[field1][]'][value='b']", visible: :hidden)
   end
 end

data/spec/components/blacklight/metadata_field_component_spec.rb

@@ -3,8 +3,8 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::MetadataFieldComponent, type: :component do
-  subject(:render) do
-    render_inline(described_class.new(field: field))
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new(field: field))
   end
 
   let(:view_context) { controller.view_context }
@@ -15,10 +15,6 @@ RSpec.describe Blacklight::MetadataFieldComponent, type: :component do
     Blacklight::FieldPresenter.new(view_context, document, field_config)
   end
 
-  let(:rendered) do
-    Capybara::Node::Simple.new(render)
-  end
-
   it 'renders the field label' do
     expect(rendered).to have_selector 'dt.blacklight-field', text: 'Field label'
   end
@@ -28,8 +24,8 @@ RSpec.describe Blacklight::MetadataFieldComponent, type: :component do
   end
 
   context 'from a show view' do
-    subject(:render) do
-      render_inline(described_class.new(field: field, show: true))
+    subject(:rendered) do
+      render_inline_to_capybara_node(described_class.new(field: field, show: true))
     end
 
     it 'renders the right field label' do

data/spec/features/facets_spec.rb

@@ -84,13 +84,13 @@ RSpec.describe "Facets" do
       pending 'Capybara::NotSupportedByDriverError: Capybara::Driver::Base#evaluate_script'
       visit root_path
       page.find('h3.facet-field-heading button', text: 'Format').click
-      focused_element_data_target = page.evaluate_script("document.activeElement")['data-target']
+      focused_element_data_target = page.evaluate_script("document.activeElement")['data-bs-target']
       expect(focused_element_data_target).to eq '#facet-format'
     end
   end
 
   describe '"More" links' do
-    it 'has default more link with sr-only text' do
+    it 'has default more link with visually-hidden text' do
       visit root_path
       within '#facet-language_ssim' do
         expect(page).to have_css 'div.more_facets', text: 'more Language'

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -33,9 +33,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe "#default_document_index_view_type" 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
+      blacklight_config.view.a({})
+      blacklight_config.view.b(default: true)
       expect(helper.default_document_index_view_type).to eq :b
     end
 
@@ -48,8 +47,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
   describe "#document_index_views" do
     before do
       blacklight_config.view.abc = false
-      blacklight_config.view.def.if = false
-      blacklight_config.view.xyz.unless = true
+      blacklight_config.view.def(if: false)
+      blacklight_config.view.xyz(unless: true)
     end
 
     it "filters views using :if/:unless configuration" do
@@ -62,8 +61,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe '#document_index_view_controls' do
     before do
-      blacklight_config.view.a
-      blacklight_config.view.b.display_control = false
+      blacklight_config.view.a({})
+      blacklight_config.view.b(display_control: false)
     end
 
     it "filters index views to those set to display controls" do
@@ -195,9 +194,9 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
   describe "#per_page_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]
-      expect(helper.per_page_options_for_select).to include ["33<span class=\"sr-only\"> per page</span>", 33]
+      expect(helper.per_page_options_for_select).to include ["11<span class=\"sr-only visually-hidden\"> per page</span>", 11]
+      expect(helper.per_page_options_for_select).to include ["22<span class=\"sr-only visually-hidden\"> per page</span>", 22]
+      expect(helper.per_page_options_for_select).to include ["33<span class=\"sr-only visually-hidden\"> per page</span>", 33]
     end
   end
 

data/spec/helpers/blacklight_helper_spec.rb

@@ -127,7 +127,7 @@ RSpec.describe BlacklightHelper do
 
       it "renders view type specific actions" do
         allow(helper).to receive(:document_index_view_type).and_return(:custom)
-        config.view.custom.document_actions = []
+        config.view.custom(document_actions: [])
         expect(helper.render_index_doc_actions(document)).to be_blank
       end
     end
@@ -315,11 +315,29 @@ RSpec.describe BlacklightHelper do
     end
 
     it "ignores missing templates" do
-      blacklight_config.view.view_type.partials = %w[index_header a b]
+      blacklight_config.view.view_type(partials: %w[index_header a b])
 
       response = helper.render_document_index_with_view :view_type, [obj1, obj1]
       expect(response).to have_selector "div#documents"
     end
+
+    context 'with a template partial provided by the view config' do
+      before do
+        blacklight_config.view.gallery(template: '/my/partial')
+      end
+
+      def stub_template(hash)
+        view.view_paths.unshift(ActionView::FixtureResolver.new(hash))
+      end
+
+      it 'renders that template' do
+        stub_template 'my/_partial.html.erb' => 'some content'
+
+        response = helper.render_document_index_with_view :gallery, [obj1, obj1]
+
+        expect(response).to eq 'some content'
+      end
+    end
   end
 
   describe "#document_index_view_type" do

data/spec/helpers/catalog_helper_spec.rb

@@ -323,7 +323,7 @@ RSpec.describe CatalogHelper 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
+      blacklight_config.view.some_view_type(display_type_field: :other_type)
       doc = { other_type: "document" }
       expect(helper.render_document_class(doc)).to eq "blacklight-document"
     end

data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb

@@ -1,6 +1,26 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
+  subject { described_class.new(Blacklight::OpenStructWithHashAccess) }
+
+  describe '#key' do
+    context 'for an object provided by the initializer' do
+      subject { described_class.new(Blacklight::OpenStructWithHashAccess, a: { b: 1 }) }
+
+      it 'copies the key to the initialized value' do
+        expect(subject.a).to have_attributes key: :a, b: 1
+      end
+    end
+
+    context 'for an object provided through assignment' do
+      it 'copies the key to the initialized value' do
+        subject.a!
+
+        expect(subject.a).to have_attributes key: :a
+      end
+    end
+  end
+
   describe "#deep_dup" do
     it "preserves the current class" do
       expect(described_class.new(described_class).deep_dup).to be_a_kind_of described_class
@@ -23,4 +43,20 @@ RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
       expect(subject.blah).to have_attributes(key: :blah)
     end
   end
+
+  describe 'adding new parameters' do
+    subject { described_class.new(Blacklight::Configuration::Field) }
+
+    it 'strips the trailing !' do
+      subject.blah!
+      expect(subject.blah).to have_attributes(key: :blah)
+      expect(subject.keys).to eq [:blah]
+    end
+
+    it 'supports direct assignment' do
+      subject.blah = '123'
+      expect(subject.blah).to eq '123'
+      expect(subject.keys).to eq [:blah]
+    end
+  end
 end