blacklight 8.2.2 → 8.4.0

data/lib/blacklight/configuration.rb

@@ -5,24 +5,6 @@ module Blacklight
   # Blacklight::Configuration holds the configuration for a Blacklight::Controller, including
   # fields to display, facets to show, sort options, and search fields.
   class Configuration < OpenStructWithHashAccess
-    extend ActiveSupport::Autoload
-    eager_autoload do
-      autoload :Context
-      autoload :ViewConfig
-      autoload :ToolConfig
-      autoload :Fields
-      autoload :Field
-      autoload :NullField
-      autoload :NullDisplayField
-      autoload :SearchField
-      autoload :FacetField
-      autoload :SortField
-      autoload :DisplayField
-      autoload :IndexField
-      autoload :ShowField
-      autoload :SessionTrackingConfig
-    end
-
     class_attribute :default_values, default: {}
 
     # Set up Blacklight::Configuration.default_values to contain the basic, required Blacklight fields
@@ -59,7 +41,9 @@ module Blacklight
     # rubocop:disable Metrics/BlockLength
     default_configuration do
       property :logo_link, default: nil
+      property :skip_link_component, default: Blacklight::SkipLinkComponent
       property :header_component, default: Blacklight::HeaderComponent
+      property :full_width_layout, default: false
 
       # bootstrap_version may be set to 4 or 5
       bootstrap_version = ENV['BOOTSTRAP_VERSION'].presence || "5"
@@ -98,6 +82,10 @@ module Blacklight
       # @!attribute default_document_solr_params
       # @return [Hash] Default values of parameters to send with every single-document request
       property :default_document_solr_params, default: {}
+      # @!attribute fetch_many_documents_path
+      # @since v8.4.0
+      # @return [String] The url path (relative to the solr base url) to use when requesting multiple documents by id
+      property :fetch_many_documents_path, default: nil
       # @!attribute fetch_many_document_params
       # @since v7.0.0
       # @return [Hash] Default values of parameters to send with every multi-document request
@@ -145,6 +133,12 @@ module Blacklight
       # @return [#partials]
       property :navbar, default: OpenStructWithHashAccess.new(partials: {})
 
+      # @!attribute bookmark_icon_component
+      # @since v8.3.1
+      # component class used to render a document
+      # set to Blacklight::Icons::BookmarkIconComponent to replace checkbox with icon
+      property :bookmark_icon_component, default: nil
+
       # @!attribute index
       # General configuration for all views
       # @return [Blacklight::Configuration::ViewConfig::Index]
@@ -154,6 +148,7 @@ module Blacklight
         # component class used to render a document
         document_component: Blacklight::DocumentComponent,
         sidebar_component: Blacklight::Search::SidebarComponent,
+        dropdown_component: Blacklight::System::DropdownComponent,
         # solr field to use to render a document title
         title_field: nil,
         # solr field to use to render format-specific partials
@@ -190,6 +185,8 @@ module Blacklight
         # in Blacklight 9, the default show_tools_component configuration will
         # be Blacklight::Document::ShowToolsComponent
         show_tools_component: nil,
+        show_header_tools_component: nil,
+        document_header_component: Blacklight::Document::PageHeaderComponent,
         sidebar_component: Blacklight::Document::SidebarComponent,
         display_type_field: nil,
         # the "field access" key to use to look up the document display fields
@@ -200,7 +197,8 @@ module Blacklight
         route: nil,
         # partials to render for each document(see #render_document_partials)
         partials: [],
-        document_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
+        document_actions: NestedOpenStructWithHashAccess.new(ToolConfig),
+        header_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
       )
 
       # @!attribute action_mapping
@@ -547,6 +545,22 @@ module Blacklight
       add_action(show.document_actions, name, opts)
       klass && ActionBuilder.new(klass, name, opts).build
     end
+
+    # Add a partial to the show page header when rendering a document.
+    # @!macro partial_if_unless
+    #   @param name [String] the name of the document partial
+    #   @param opts [Hash]
+    #   @option opts [Class] :component draw a component
+    #   @option opts [String] :partial partial to draw if component is false
+    #   @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true. The proc will receive the action configuration and the document or documents for the action.
+    #   @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true. The proc will receive the action configuration and the document or documents for the action.
+    def add_show_header_tools_partial(name, opts = {})
+      opts[:partial] ||= 'document_action'
+
+      add_action(show.header_actions, name, opts)
+      klass && ActionBuilder.new(klass, name, opts).build
+    end
+
     # rubocop:enable Layout/LineLength
 
     # Add a tool for the search result list itself

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -20,7 +20,7 @@ module Blacklight
                end
       end
 
-      super value
+      super(value)
       set_default_proc!
     end
 
@@ -56,7 +56,7 @@ module Blacklight
     # to the internal hash
     def marshal_load x
       @nested_class = x.first
-      super x.last
+      super(x.last)
       set_default_proc!
     end
 

data/lib/blacklight/parameters.rb

@@ -7,7 +7,7 @@ module Blacklight
     # from the provided parameters.
     # @param [Hash] params parameters
     def self.sanitize params
-      params.reject { |_k, v| v.nil? } # rubocop:disable Style/CollectionCompact not available in Rails 6.0
+      params.reject { |_k, v| v.nil? } # not available in Rails 6.0
             .except(:action, :controller, :id, :commit, :utf8)
     end
 

data/lib/blacklight/solr/repository.rb

@@ -17,13 +17,20 @@ module Blacklight::Solr
       solr_response
     end
 
+    # Find multiple documents by their ids
+    # @param [Hash] _params query parameters
+    def find_many(params)
+      search(params: params, path: blacklight_config.fetch_many_documents_path)
+    end
+
     ##
     # Execute a search query against solr
     # @param [Hash] params solr query parameters
-    def search params = {}
-      request_params = params.reverse_merge({ qt: blacklight_config.qt })
+    # @param [String] path solr request handler path
+    def search pos_params = {}, path: nil, params: nil, **kwargs
+      request_params = (params || pos_params).reverse_merge(kwargs).reverse_merge({ qt: blacklight_config.qt })
 
-      send_and_receive search_path(request_params), request_params
+      send_and_receive(path || default_search_path(request_params), request_params)
     end
 
     # @param [Hash] request_params
@@ -126,7 +133,7 @@ module Blacklight::Solr
     end
 
     # @return [String]
-    def search_path(solr_params)
+    def default_search_path(solr_params)
       return blacklight_config.json_solr_path if blacklight_config.json_solr_path && uses_json_query_dsl?(solr_params)
 
       blacklight_config.solr_path

data/lib/blacklight/solr/request.rb

@@ -14,7 +14,7 @@ class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
       super()
       update(constructor)
     else
-      super(constructor)
+      super
     end
   end
 

data/lib/blacklight/solr/response/facets.rb

@@ -102,7 +102,7 @@ module Blacklight::Solr::Response::Facets
 
   class NullFacetField < FacetField
     def initialize name, items = [], response: nil, **kwargs
-      super(name, items, response: response, **kwargs)
+      super
     end
   end
 

data/lib/blacklight/solr/response/params.rb

@@ -98,7 +98,7 @@ module Blacklight::Solr::Response::Params
       json_params[json_key || key],
       json_params.dig(:params, key),
       json_params.dig(:params, "json.#{key}")
-    ].select(&:present?).inject([]) do |memo, arr|
+    ].compact_blank.inject([]) do |memo, arr|
       memo.concat(Array.wrap(arr))
     end
   end

data/lib/blacklight/solr/response.rb

@@ -1,18 +1,6 @@
 # frozen_string_literal: true
 
 class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
-  extend ActiveSupport::Autoload
-  eager_autoload do
-    autoload :PaginationMethods
-    autoload :Response
-    autoload :Spelling
-    autoload :Facets
-    autoload :MoreLikeThis
-    autoload :GroupResponse
-    autoload :Group
-    autoload :Params
-  end
-
   include PaginationMethods
   include Spelling
   include Facets

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -161,7 +161,7 @@ module Blacklight::Solr
         limit: facet_limit_with_pagination(field_name)
       ).merge(additional_parameters)
 
-      solr_parameters[:json][:facet][field_name] = field_config.select { |_k, v| v.present? }
+      solr_parameters[:json][:facet][field_name] = field_config.compact_blank
     end
 
     ##
@@ -324,7 +324,7 @@ module Blacklight::Solr
       unless val =~ /^[a-zA-Z0-9$_\-\^]+$/
         val = options[:quote] +
               # Yes, we need crazy escaping here, to deal with regexp esc too!
-              val.gsub("'", "\\\\\'").gsub('"', "\\\\\"") +
+              val.gsub("'", "\\\\'").gsub('"', "\\\\\"") +
               options[:quote]
       end
       val

data/lib/blacklight/solr.rb

@@ -2,11 +2,5 @@
 
 module Blacklight
   module Solr
-    autoload :Document, 'blacklight/solr/document'
-    autoload :FacetPaginator, 'blacklight/solr/facet_paginator'
-    autoload :Repository, 'blacklight/solr/repository'
-    autoload :Request, 'blacklight/solr/request'
-    autoload :Response, 'blacklight/solr/response'
-    autoload :SearchBuilderBehavior, 'blacklight/solr/search_builder_behavior'
   end
 end

data/lib/blacklight.rb

@@ -1,23 +1,13 @@
 # frozen_string_literal: true
 
 require 'kaminari'
-require 'blacklight/open_struct_with_hash_access'
-require 'blacklight/nested_open_struct_with_hash_access'
 require 'jbuilder'
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.setup
 
 module Blacklight
-  autoload :AbstractRepository, 'blacklight/abstract_repository'
-  autoload :Component, 'blacklight/component'
-  autoload :Configuration, 'blacklight/configuration'
-  autoload :Exceptions,  'blacklight/exceptions'
-  autoload :Parameters,  'blacklight/parameters'
-  autoload :Routes,      'blacklight/routes'
-  autoload :RuntimeRegistry, 'blacklight/runtime_registry'
-  autoload :SearchBuilder, 'blacklight/search_builder'
-  autoload :SearchState, 'blacklight/search_state'
-  autoload :Solr, 'blacklight/solr'
-
-  require 'blacklight/version'
   require 'blacklight/engine' if defined?(Rails)
 
   def self.blacklight_config_file

data/lib/generators/blacklight/assets/propshaft_generator.rb

@@ -5,9 +5,9 @@ module Blacklight
     class PropshaftGenerator < Rails::Generators::Base
       def add_package
         if ENV['CI']
-          run "yarn add blacklight-frontend:#{Blacklight::Engine.root}"
+          run "yarn add file:#{Blacklight::Engine.root}"
         else
-          run 'yarn add blacklight-frontend'
+          run "yarn add blacklight-frontend@#{Blacklight::VERSION}"
         end
       end
 

data/lib/generators/blacklight/models_generator.rb

@@ -36,7 +36,7 @@ module Blacklight
     concerns :exportable
   end
 
-  resources :bookmarks do
+  resources :bookmarks, only: [:index, :update, :create, :destroy] do
     concerns :exportable
 
     collection do

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.2.2",
+  "version": "8.4.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "module": "app/assets/javascripts/blacklight/blacklight.esm.js",

data/spec/components/blacklight/advanced_search_form_component_spec.rb

@@ -32,7 +32,7 @@ RSpec.describe Blacklight::AdvancedSearchFormComponent, type: :component do
   end
 
   it 'has text fields for each search field' do
-    expect(rendered).to have_selector '.advanced-search-field', count: 4
+    expect(rendered).to have_css '.advanced-search-field', count: 4
     expect(rendered).to have_field 'clause_0_field', with: 'all_fields', type: :hidden
     expect(rendered).to have_field 'clause_1_field', with: 'title', type: :hidden
     expect(rendered).to have_field 'clause_2_field', with: 'author', type: :hidden
@@ -40,7 +40,7 @@ RSpec.describe Blacklight::AdvancedSearchFormComponent, type: :component do
   end
 
   it 'has filters' do
-    expect(rendered).to have_selector '.blacklight-format'
+    expect(rendered).to have_css '.blacklight-format'
     expect(rendered).to have_field 'f_inclusive[format][]', with: 'Book'
     expect(rendered).to have_field 'f_inclusive[format][]', with: 'CD'
   end

data/spec/components/blacklight/constraint_layout_component_spec.rb

@@ -13,11 +13,11 @@ RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
     end
 
     it "renders label and value" do
-      expect(rendered).to have_selector("span.applied-filter.constraint") do |s|
+      expect(rendered).to have_css("span.applied-filter.constraint") do |s|
         expect(s).to have_css("span.constraint-value")
-        expect(s).not_to have_css("a.constraint-value")
-        expect(s).to have_selector "span.filter-name", text: "my label"
-        expect(s).to have_selector "span.filter-value", text: "my value"
+        expect(s).to have_no_css("a.constraint-value")
+        expect(s).to have_css "span.filter-name", text: "my label"
+        expect(s).to have_css "span.filter-value", text: "my value"
       end
     end
   end
@@ -28,14 +28,14 @@ RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
     end
 
     it "includes remove link" do
-      expect(rendered).to have_selector("span.applied-filter") do |s|
-        expect(s).to have_selector(".remove[href='http://remove']")
+      expect(rendered).to have_css("span.applied-filter") do |s|
+        expect(s).to have_css(".remove[href='http://remove']")
       end
     end
 
     it "has an accessible remove label" do
-      expect(rendered).to have_selector(".remove") do |s|
-        expect(s).to have_selector('.visually-hidden', text: 'Remove constraint my label: my value')
+      expect(rendered).to have_css(".remove") do |s|
+        expect(s).to have_css('.visually-hidden', text: 'Remove constraint my label: my value')
       end
     end
   end
@@ -46,7 +46,7 @@ RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
     end
 
     it "includes them" do
-      expect(rendered).to have_selector("span.applied-filter.constraint.class1.class2")
+      expect(rendered).to have_css("span.applied-filter.constraint.class1.class2")
     end
   end
 
@@ -56,8 +56,8 @@ RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
     end
 
     it "does not escape key and value" do
-      expect(rendered).to have_selector("span.applied-filter.constraint span.filter-name span.custom_label")
-      expect(rendered).to have_selector("span.applied-filter.constraint span.filter-value span.custom_value")
+      expect(rendered).to have_css("span.applied-filter.constraint span.filter-name span.custom_label")
+      expect(rendered).to have_css("span.applied-filter.constraint span.filter-value span.custom_value")
     end
   end
 end

data/spec/components/blacklight/constraints_component_spec.rb

@@ -36,15 +36,15 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     end
 
     it 'has a header' do
-      expect(rendered).to have_selector('h2', text: 'Search Constraints')
+      expect(rendered).to have_css('h2', text: 'Search Constraints')
     end
 
     it 'wraps the output in a div' do
-      expect(rendered).to have_selector('div#appliedParams')
+      expect(rendered).to have_css('div#appliedParams')
     end
 
     it 'renders the query' do
-      expect(rendered).to have_selector('.applied-filter.constraint', text: 'some query')
+      expect(rendered).to have_css('.applied-filter.constraint', text: 'some query')
     end
   end
 
@@ -52,15 +52,15 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     let(:query_params) { { f: { some_facet: ['some value'] } } }
 
     it 'renders the query' do
-      expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
+      expect(rendered).to have_css('.constraint-value > .filter-name', text: 'Some Facet').and(have_css('.constraint-value > .filter-value', text: 'some value'))
     end
 
     context 'that is not configured' do
       let(:query_params) { { f: { some_facet: ['some value'], missing: ['another value'] } } }
 
       it 'renders only the configured constraints' do
-        expect(rendered).to have_selector('.constraint-value > .filter-name', text: 'Some Facet').and(have_selector('.constraint-value > .filter-value', text: 'some value'))
-        expect(rendered).not_to have_selector('.constraint-value > .filter-name', text: 'Missing')
+        expect(rendered).to have_css('.constraint-value > .filter-name', text: 'Some Facet').and(have_css('.constraint-value > .filter-value', text: 'some value'))
+        expect(rendered).to have_no_css('.constraint-value > .filter-name', text: 'Missing')
       end
     end
   end
@@ -71,15 +71,15 @@ RSpec.describe Blacklight::ConstraintsComponent, type: :component do
     let(:query_params) { { q: 'some query', f: { some_facet: ['some value'] } } }
 
     it 'wraps the output in a span' do
-      expect(rendered).to have_selector('span .constraint')
+      expect(rendered).to have_css('span .constraint')
     end
 
     it 'renders the search state as lightly-decorated text' do
-      expect(rendered).to have_selector('.constraint > .filter-values', text: 'some query').and(have_selector('.constraint', text: 'Some Facet:some value'))
+      expect(rendered).to have_css('.constraint > .filter-values', text: 'some query').and(have_css('.constraint', text: 'Some Facet:some value'))
     end
 
     it 'omits the headers' do
-      expect(rendered).not_to have_selector('h2', text: 'Search Constraints')
+      expect(rendered).to have_no_css('h2', text: 'Search Constraints')
     end
   end
 end

data/spec/components/blacklight/document/action_component_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Blacklight::Document::ActionComponent, type: :component do
     let(:action) { Blacklight::Configuration::ToolConfig.new(name: '', partial: '/some/tool') }
 
     it 'render the partial' do
-      allow(view_context).to receive(:render).with(hash_including(partial: '/some/tool')).and_return('tool')
+      allow(view_context).to receive(:render).with(hash_including(partial: '/some/tool'), {}).and_return('tool')
 
       expect(rendered).to have_content 'tool'
     end

data/spec/components/blacklight/document/group_component_spec.rb

@@ -26,9 +26,9 @@ RSpec.describe Blacklight::Document::GroupComponent, type: :component do
   end
 
   it 'renders the group with a header' do
-    expect(rendered).to have_selector 'div.group'
-    expect(rendered).to have_selector 'h2', text: 'group1'
-    expect(rendered).not_to have_link 'more'
+    expect(rendered).to have_css 'div.group'
+    expect(rendered).to have_css 'h2', text: 'group1'
+    expect(rendered).to have_no_link 'more'
   end
 
   it 'renders the group documents' do

data/spec/components/blacklight/document/page_header_component_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Document::PageHeaderComponent, type: :component do
+  subject(:component) { described_class.new(document: document, search_context: search_context, search_session: current_search_session) }
+
+  let(:show_header_tools_component) { Class.new(Blacklight::Document::ShowToolsComponent) }
+
+  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(:document) { SolrDocument.new(id: 'x', title_tsim: 'Title') }
+
+  let(:blacklight_config) do
+    CatalogController.blacklight_config.deep_copy
+  end
+
+  # rubocop:disable RSpec/SubjectStub
+  before do
+    # Every call to view_context returns a different object. This ensures it stays stable.
+    allow(controller).to receive_messages(blacklight_config: blacklight_config)
+    allow(controller).to receive(:current_search_session).and_return(double(id: document.id))
+    controller.class.helper_method :current_search_session
+    allow(controller).to receive_messages(controller_name: 'catalog', link_to_previous_document: '', link_to_next_document: '')
+    allow(view_context).to receive_messages(search_context: search_context, search_session: current_search_session, current_search_session: current_search_session)
+    allow(component).to receive(:render).and_call_original
+    allow(component).to receive(:render).with(an_instance_of(show_header_tools_component)).and_return('tool component content')
+    replace_hash = { 'application/_start_over.html.erb' => 'Start Over' }
+    if Rails.version.to_f >= 7.1
+      controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+    else
+      view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+    end
+  end
+  # rubocop:enable RSpec/SubjectStub
+
+  context "all variables are empty" do
+    let(:search_context) { nil }
+    let(:current_search_session) { {} }
+
+    it 'does not render' do
+      expect(rendered.native.inner_html).to be_blank
+    end
+
+    context 'has header tools' do
+      before do
+        blacklight_config.show.show_header_tools_component = show_header_tools_component
+      end
+
+      it 'renders the tools' do
+        expect(rendered).to have_text 'tool component content'
+        expect(rendered).to have_css '.row'
+      end
+    end
+  end
+
+  context "has pagination" do
+    let(:search_context) { { next: next_doc, prev: prev_doc } }
+    let(:prev_doc) { SolrDocument.new(id: '777') }
+    let(:next_doc) { SolrDocument.new(id: '888') }
+    let(:current_search_session) { { query_params: { q: 'abc' }, 'id' => '123', 'document_id' => document.id } }
+
+    it 'renders pagination' do
+      expect(rendered).to have_text 'Previous'
+      expect(rendered).to have_text 'Next'
+      expect(rendered).to have_text 'Start Over'
+      expect(rendered).to have_text 'Back to Search'
+    end
+
+    context 'has header tools' do
+      before do
+        blacklight_config.show.show_header_tools_component = show_header_tools_component
+      end
+
+      it 'renders the tools and pagination' do
+        expect(rendered).to have_text 'Previous'
+        expect(rendered).to have_text 'Next'
+        expect(rendered).to have_text 'Start Over'
+        expect(rendered).to have_text 'Back to Search'
+        expect(rendered).to have_text 'tool component content'
+        expect(rendered).to have_css '.row'
+      end
+    end
+  end
+end

data/spec/components/blacklight/document/sidebar_component_spec.rb

@@ -26,8 +26,7 @@ RSpec.describe Blacklight::Document::SidebarComponent, type: :component do
 
   before do
     # Every call to view_context returns a different object. This ensures it stays stable.
-    allow(controller).to receive(:view_context).and_return(view_context)
-    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+    allow(controller).to receive_messages(view_context: view_context, blacklight_config: blacklight_config)
   end
 
   describe '#render_show_tools' do
@@ -42,7 +41,7 @@ RSpec.describe Blacklight::Document::SidebarComponent, type: :component do
       end
 
       it 'renders show_tools partial' do
-        expect(rendered).to have_selector 'div[@class="expected-show_tools"]'
+        expect(rendered).to have_css 'div[@class="expected-show_tools"]'
       end
     end
 
@@ -55,7 +54,7 @@ RSpec.describe Blacklight::Document::SidebarComponent, type: :component do
       end
 
       it 'renders configured show_tools component' do
-        expect(rendered).to have_selector 'div[@class="expected-show_tools"]'
+        expect(rendered).to have_css 'div[@class="expected-show_tools"]'
       end
     end
     # rubocop:enable RSpec/SubjectStub