blacklight 7.38.0 → 7.39.0

data/lib/blacklight/configuration.rb

@@ -4,22 +4,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 :SearchField
-      autoload :FacetField
-      autoload :SortField
-      autoload :DisplayField
-      autoload :IndexField
-      autoload :ShowField
-    end
-
     class_attribute :default_values, default: {}
 
     # Set up Blacklight::Configuration.default_values to contain the basic, required Blacklight fields
@@ -51,6 +35,7 @@ module Blacklight
     end
 
     property :logo_link
+    property :full_width_layout, default: false
     property :header_component, default: nil
     def header_component
       super || Blacklight::HeaderComponent
@@ -205,7 +190,9 @@ module Blacklight
       # component class used to render search constraints
       constraints_component: nil,
       # component class used to render the search bar
-      search_bar_component: nil
+      search_bar_component: nil,
+      # pagination parameters to pass to kaminari
+      pagination_options: Blacklight::Engine.config.blacklight.default_pagination_options.dup
     )
 
     # @!attribute show

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -51,20 +51,5 @@ module Blacklight
     def deep_dup
       self.class.new @table.deep_dup
     end
-
-    if Rails.version < '6'
-      # Ported from Rails 6 to fix an incompatibility with ostruct
-      def try(method_name = nil, *args, &block)
-        if method_name.nil? && block_given?
-          if b.arity.zero?
-            instance_eval(&block)
-          else
-            yield self
-          end
-        elsif respond_to?(method_name)
-          public_send(method_name, *args, &b)
-        end
-      end
-    end
   end
 end

data/lib/blacklight/solr/response.rb

@@ -1,17 +1,5 @@
 # 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

@@ -105,6 +105,8 @@ module Blacklight::Solr
       return unless search_state.query_param
 
       bool_query = search_field.clause_params.transform_values { |v| v.merge(query: search_state.query_param) }
+      solr_parameters["spellcheck.q"] ||= search_state.query_param
+
       solr_parameters.append_boolean_query(:must, bool_query)
     end
 

data/lib/blacklight/solr.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 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,25 +1,14 @@
 # frozen_string_literal: true
 require 'kaminari'
 require 'deprecation'
-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'
-
   extend Deprecation
-
-  require 'blacklight/version'
   require 'blacklight/engine' if defined?(Rails)
 
   def self.blacklight_config_file
@@ -93,11 +82,7 @@ module Blacklight
     end
 
     begin
-      @blacklight_yml = if RUBY_VERSION > '2.6'
-                          YAML.safe_load(blacklight_erb, aliases: true)
-                        else
-                          YAML.safe_load(blacklight_erb, [], [], true)
-                        end
+      @blacklight_yml = YAML.safe_load(blacklight_erb, aliases: true)
     rescue => e
       raise("#{blacklight_config_file} was found, but could not be parsed.\n#{e.inspect}")
     end

data/lib/generators/blacklight/assets_generator.rb

@@ -19,9 +19,6 @@ module Blacklight
 
     # Add sprockets javascript if needed
     def create_sprockets_javascript
-      # Rails 5 already has an application.js file
-      return if Rails.version < '6'
-
       create_file 'app/assets/javascripts/application.js' do
         <<~CONTENT
           //= require jquery3

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.37.0",
+  "version": "7.39.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {

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

@@ -23,12 +23,7 @@ RSpec.describe Blacklight::Document::ActionComponent, type: :component do
   end
 
   it 'renders an action link' do
-    if Rails.version >= '6'
-      allow(view_context).to receive(:some_tool_solr_document_path).with(document, { only_path: true }).and_return('/asdf')
-    else
-      allow(view_context).to receive(:some_tool_solr_document_path).with(document).and_return('/asdf')
-    end
-
+    allow(view_context).to receive(:some_tool_solr_document_path).with(document, { only_path: true }).and_return('/asdf')
     expect(rendered).to have_link 'Some tool', href: '/asdf'
   end
 

data/spec/components/blacklight/document_component_spec.rb

@@ -160,6 +160,26 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       expect(rendered).to have_content 'embed'
     end
 
+    context 'show view with custom translation' do
+      let!(:original_translations) { I18n.backend.send(:translations).deep_dup }
+
+      before do
+        controller.action_name = "show"
+        I18n.backend.store_translations(:en, blacklight: { search: { show: { label: "testing:%{label}" } } })
+      end
+
+      after do
+        I18n.backend.reload!
+        I18n.backend.store_translations(:en, original_translations[:en])
+      end
+
+      it 'renders with show-specific metadata with correct translation' do
+        expect(rendered).to have_css 'dl.document-metadata'
+        expect(rendered).to have_css 'dt', text: 'testing:ISBN'
+        expect(rendered).to have_css 'dd', text: 'Value'
+      end
+    end
+
     context 'with configured metadata component' do
       let(:custom_component_class) do
         Class.new(Blacklight::DocumentMetadataComponent) do
@@ -216,6 +236,36 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     end
   end
 
+  context 'with partials rendered into a component slot' do
+    it 'does not automatically renders partials' do
+      component.with_partial { 'Partials' }
+      expect(rendered).not_to have_content 'Partials'
+    end
+  end
+
+  context 'with render_partials_in_component set to true' do
+    before do
+      blacklight_config.index.render_partials_in_component = true
+    end
+
+    it 'renders partials' do
+      component.with_partial { 'Partials' }
+      expect(rendered).to have_content 'Partials'
+    end
+  end
+
+  context 'with partials passed into the component constructor' do
+    let(:attr) { { partials: ['a'] } }
+
+    before do
+      allow(view_context).to receive(:render_document_partial).and_return('Partials')
+    end
+
+    it 'renders partials' do
+      expect(rendered).to have_content 'Partials'
+    end
+  end
+
   context 'with before_titles' do
     let(:render) do
       component.render_in(view_context) do

data/spec/components/blacklight/icons/icon_component_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Icons::IconComponent, type: :component do
+  subject(:component) { sub_component.new }
+
+  let(:sub_component) do
+    Class.new(described_class) do
+      def self.name
+        'TestIconComponent'
+      end
+    end
+  end
+
+  context 'when no classes are passed in' do
+    subject(:component) { sub_component.new }
+
+    it "renders component" do
+      render_inline(component)
+      expect(page).to have_css "span[class='blacklight-icons blacklight-icons-test_icon']"
+    end
+  end
+
+  context 'when classes are passed in' do
+    subject(:component) { sub_component.new(classes: 'my-icon') }
+
+    it "renders component" do
+      render_inline(component)
+      expect(page).to have_css "span[class='my-icon blacklight-icons blacklight-icons-test_icon']"
+    end
+  end
+
+  context 'when name is passed in' do
+    subject(:component) { sub_component.new(name: 'my-icon') }
+
+    it "renders component" do
+      render_inline(component)
+      expect(page).to have_css "span[class='blacklight-icons blacklight-icons-my-icon']"
+    end
+  end
+end

data/spec/components/blacklight/response/pagination_component_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Response::PaginationComponent, type: :component do
+  let(:render) do
+    with_request_url '/catalog?q=foo' do
+      render_inline(instance)
+    end
+  end
+
+  let(:instance) { described_class.new(response: response) }
+
+  context 'when there are many results' do
+    let(:response) { instance_double(Blacklight::Solr::Response, total: 10, current_page: 5, limit_value: 10_000, total_pages: 100) }
+
+    context 'with default config' do
+      before { render }
+
+      it "has links to deep pages" do
+        expect(page).not_to have_link '98'
+        expect(page).to have_link '99'
+        expect(page).to have_link '100'
+        expect(page).not_to have_link '101'
+      end
+    end
+
+    context 'when a different configuration that removes deep links is passed as a parameter' do
+      let(:instance) { described_class.new(response: response, left: 5, right: 0, outer_window: nil) }
+
+      before { render }
+
+      it "does not link to deep pages" do
+        expect(page).to have_link '1'
+        expect(page).not_to have_link '100'
+      end
+    end
+
+    context 'when a different configuration that removes deep links is configured in the controller' do
+      before do
+        allow(controller.blacklight_config.index)
+          .to receive(:pagination_options)
+          .and_return(theme: 'blacklight', left: 5, right: 0)
+        render
+      end
+
+      it "does not link to deep pages" do
+        expect(page).to have_link '1'
+        expect(page).not_to have_link '100'
+      end
+    end
+  end
+end

data/spec/helpers/blacklight/layout_helper_behavior_spec.rb

@@ -30,9 +30,26 @@ RSpec.describe Blacklight::LayoutHelperBehavior do
   end
 
   describe '#container_classes' do
-    it 'returns a string of classe(s)' do
-      expect(helper.container_classes).to be_an String
-      expect(helper.container_classes).to eq 'container'
+    before do
+      allow(view).to receive(:blacklight_config).and_return(config)
+    end
+
+    context 'when not full-width' do
+      let(:config) { Blacklight::Configuration.new }
+
+      it 'returns a string of classe(s)' do
+        expect(helper.container_classes).to be_an String
+        expect(helper.container_classes).to eq 'container'
+      end
+    end
+
+    context 'when full-width' do
+      let(:config) { Blacklight::Configuration.new(full_width_layout: true) }
+
+      it 'returns a string of classe(s)' do
+        expect(helper.container_classes).to be_an String
+        expect(helper.container_classes).to eq 'container-fluid'
+      end
     end
   end
 

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

@@ -335,6 +335,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
           qf: '$subject_qf',
           pf: '$subject_pf'
         }
+        blacklight_config.search_fields['subject'].clause_params = nil
       end
 
       it "looks up qt from field definition" do
@@ -374,6 +375,18 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
         expect(key_value_pairs).to include("pf=$subject_pf")
         expect(key_value_pairs).to include("qf=$subject_qf")
       end
+
+      context 'when subject field uses JSON query DSL' do
+        before do
+          blacklight_config.search_fields['subject'].clause_params = {
+            edismax: {}
+          }
+        end
+
+        it "includes spellcheck.q, without LocalParams" do
+          expect(subject["spellcheck.q"]).to eq "wome"
+        end
+      end
     end
 
     describe "solr json query parameters from the fielded search" do

data/spec/services/blacklight/search_service_spec.rb

@@ -8,7 +8,7 @@
 #  to talk with solr and get results)? when we do a document request, does
 #  blacklight code get a single document returned?)
 #
-RSpec.describe Blacklight::SearchService, api: true do
+RSpec.describe Blacklight::SearchService, :api do
   subject { service }
 
   let(:context) { { whatever: :value } }
@@ -49,7 +49,7 @@ RSpec.describe Blacklight::SearchService, api: true do
   end
 
   # SPECS FOR SEARCH RESULTS FOR QUERY
-  describe 'Search Results', integration: true do
+  describe 'Search Results', :integration do
     let(:blacklight_config) { copy_of_catalog_config }
 
     describe 'for a sample query returning results' do
@@ -100,11 +100,11 @@ RSpec.describe Blacklight::SearchService, api: true do
 
       it "returns a grouped response" do
         expect(@document_list).to be_empty
-        expect(@solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
+        expect(@solr_response).to be_a Blacklight::Solr::Response::GroupResponse
       end
     end
 
-    describe "for a query returning multiple groups", integration: true do
+    describe "for a query returning multiple groups", :integration do
       let(:blacklight_config) { copy_of_catalog_config }
       let(:user_params) { { q: all_docs_query } }
 
@@ -117,7 +117,7 @@ RSpec.describe Blacklight::SearchService, api: true do
 
       it "returns a grouped response" do
         expect(@document_list).to be_empty
-        expect(@solr_response).to be_a_kind_of Blacklight::Solr::Response::GroupResponse
+        expect(@solr_response).to be_a Blacklight::Solr::Response::GroupResponse
         expect(@solr_response.group_field).to eq "title_si"
       end
     end
@@ -167,7 +167,7 @@ RSpec.describe Blacklight::SearchService, api: true do
   end # Search Results
 
   # SPECS FOR SEARCH RESULTS FOR FACETS
-  describe 'Facets in Search Results for All Docs Query', integration: true do
+  describe 'Facets in Search Results for All Docs Query', :integration do
     let(:blacklight_config) { copy_of_catalog_config }
     let(:user_params) { { q: all_docs_query } }
 
@@ -181,7 +181,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     it 'has all facets specified in initializer' do
-      expect(@facets.keys).to include *blacklight_config.facet_fields.keys
+      expect(@facets.keys).to include(*blacklight_config.facet_fields.keys)
       expect(@facets.none? { |_k, v| v.nil? }).to eq true
     end
 
@@ -205,14 +205,14 @@ RSpec.describe Blacklight::SearchService, api: true do
     it 'has all value counts > 0' do
       @facets.each do |_key, facet|
         facet.items.each do |facet_vals|
-          expect(facet_vals.hits).to be > 0
+          expect(facet_vals.hits).to be_positive
         end
       end
     end
   end # facet specs
 
   # SPECS FOR SEARCH RESULTS FOR PAGING
-  describe 'Paging', integration: true do
+  describe 'Paging', :integration do
     let(:blacklight_config) { copy_of_catalog_config }
     let(:user_params) { { q: all_docs_query } }
 
@@ -309,7 +309,7 @@ RSpec.describe Blacklight::SearchService, api: true do
   end # page specs
 
   # SPECS FOR SINGLE DOCUMENT REQUESTS
-  describe 'Get Document By Id', integration: true do
+  describe 'Get Document By Id', :integration do
     let(:doc_id) { '2007020969' }
     let(:bad_id) { 'redrum' }
 
@@ -336,7 +336,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
   end
 
-  describe 'Get multiple documents By Id', integration: true do
+  describe 'Get multiple documents By Id', :integration do
     let(:doc_id) { '2007020969' }
     let(:bad_id) { 'redrum' }
     let(:response) { service.fetch([doc_id]).first }
@@ -355,7 +355,7 @@ RSpec.describe Blacklight::SearchService, api: true do
   end
 
   # SPECS FOR SPELLING SUGGESTIONS VIA SEARCH
-  describe "Searches should return spelling suggestions", integration: true do
+  describe "Searches should return spelling suggestions", :integration do
     context "for just-poor-enough-query term" do
       let(:user_params) { { q: 'boo' } }
 

data/spec/spec_helper.rb

@@ -117,31 +117,3 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 end
-
-# RSpec's stub_template method needs a differnet implementation for Rails 7.1, that
-# isn't yet in an rspec-rails release.
-#
-# First rspec-rails tried this:
-#   https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
-#
-# But it was subject to this problem:
-#   https://github.com/rspec/rspec-rails/issues/2696
-#
-# Below implementation appears to work for our purposes here, so we will patch it in
-# if we are on Rails 7.1+, and  not yet rspec-rails 6.1 which we expect to have it.
-
-if ::Rails.version.to_f >= 7.1 && Gem.loaded_specs["rspec-rails"].version.release < Gem::Version.new('6.1')
-
-  module RSpec
-    module Rails
-      module ViewExampleGroup
-        module ExampleMethods
-          def stub_template(hash)
-            controller.prepend_view_path(StubResolverCache.resolver_for(hash))
-          end
-        end
-      end
-    end
-  end
-
-end

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1 @@
 gem 'rails-controller-testing'
-gem 'thor', '~> 0.20' if /^5.[12]/.match?(ENV['RAILS_VERSION'])

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

@@ -2,9 +2,11 @@
 
 RSpec.describe "catalog/_paginate_compact.html.erb" do
   let(:user) { User.new { |u| u.save(validate: false) } }
+  let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
     controller.request.path_parameters[:action] = 'index'
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
   end
 
   it "renders paginatable arrays" do

data/spec/views/catalog/index.atom.builder_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rexml/document'
 
 RSpec.describe "catalog/index" do
@@ -6,7 +7,7 @@ RSpec.describe "catalog/index" do
     10.times.map do |i|
       doc = SolrDocument.new(id: i)
       allow(doc).to receive(:export_as_some_format).and_return("")
-      allow(doc).to receive(:to_semantic_values).and_return(author: ['xyz']) if i == 0
+      allow(doc).to receive(:to_semantic_values).and_return(author: ['xyz']) if i.zero?
       doc.will_export_as(:some_format, "application/some-format") if i == 1
       doc
     end

data/template.demo.rb

@@ -2,12 +2,12 @@
 
 gem 'blacklight', '>= 7.0'
 
-run "bundle install"
+after_bundle do
+  # run the blacklight install generator
+  options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc')
 
-# run the blacklight install generator
-options = ENV.fetch("BLACKLIGHT_INSTALL_OPTIONS", '--devise --marc')
+  generate 'blacklight:install', options
 
-generate 'blacklight:install', options
-
-# run the database migrations
-rake "db:migrate"
+  # run the database migrations
+  rake "db:migrate"
+end