blacklight 8.12.2 → 8.13.0

data/app/presenters/blacklight/rendering/join.rb

@@ -16,8 +16,8 @@ module Blacklight
 
       private
 
-      def html_escape(*args)
-        ERB::Util.html_escape(*args)
+      def html_escape(*)
+        ERB::Util.html_escape(*)
       end
     end
   end

data/app/presenters/blacklight/rendering/microdata.rb

@@ -4,6 +4,7 @@ module Blacklight
   module Rendering
     class Microdata < AbstractStep
       include ActionView::Helpers::TagHelper
+
       def render
         return next_step(values) unless config.itemprop && html?
 

data/app/values/blacklight/types.rb

@@ -95,8 +95,8 @@ module Blacklight
     end
 
     class Selector < Array
-      def initialize(by: nil, block: nil, **kwargs)
-        super(**kwargs)
+      def initialize(by: nil, block: nil, **)
+        super(**)
         @by = by
         @block = block
       end

data/app/views/catalog/_email_form.html.erb

@@ -6,7 +6,7 @@
 
   <div class="modal-body">
     <%= render '/shared/flash_msg' %>
-    <div class="form-group row">
+    <div class="form-group row mb-3">
       <label class="control-label col-sm-2" for="to">
         <%= t('blacklight.email.form.to') %>
       </label>
@@ -15,7 +15,7 @@
       </div>
     </div>
 
-    <div class="form-group row">
+    <div class="form-group row mb-3">
       <label class="control-label col-sm-2" for="message">
         <%= t('blacklight.email.form.message') %>
       </label>

data/app/views/catalog/_sms_form.html.erb

@@ -5,7 +5,7 @@
              method: :post do %>
 <div class="modal-body">
   <%= render '/shared/flash_msg' %>
-    <div class="form-group row">
+    <div class="form-group row mb-3">
       <label class="control-label col-sm-2" for="to">
         <%= t('blacklight.sms.form.to') %>
       </label>
@@ -13,7 +13,7 @@
         <%= telephone_field_tag :to, params[:to], class: 'form-control', required: true %>
       </div>
     </div>
-    <div class="form-group row">
+    <div class="form-group row mb-3">
       <label class="control-label col-sm-2" for="carrier">
         <%= t('blacklight.sms.form.carrier') %>
       </label>

data/blacklight.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", ">= 6.1", "< 8"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
-  s.add_development_dependency 'axe-core-rspec'
+  s.add_development_dependency 'axe-core-rspec', '~> 4.12.0'
   s.add_development_dependency "capybara", '~> 3'
   s.add_development_dependency 'selenium-webdriver'
   s.add_development_dependency 'engine_cart', '~> 2.1'

data/lib/blacklight/abstract_repository.rb

@@ -37,8 +37,8 @@ module Blacklight
 
     # Find multiple documents by their ids
     # @param [Hash] _params query parameters
-    def find_many(params, **kwargs)
-      search(params, **kwargs)
+    def find_many(params, **)
+      search(params, **)
     end
 
     ##

data/lib/blacklight/component.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'view_component/version'
+
 module Blacklight
   class Component < ViewComponent::Base
     class << self

data/lib/blacklight/configuration/context.rb

@@ -24,16 +24,16 @@ module Blacklight
       #
       # @param [#if,#unless] config an object that responds to if/unless
       # @return [Boolean]
-      def evaluate_if_unless_configuration(config, *args)
+      def evaluate_if_unless_configuration(config, *)
         return config if config == true || config == false
 
         if_value = !config.respond_to?(:if) ||
                    config.if.nil? ||
-                   evaluate_configuration_conditional(config.if, config, *args)
+                   evaluate_configuration_conditional(config.if, config, *)
 
         unless_value = !config.respond_to?(:unless) ||
                        config.unless.nil? ||
-                       !evaluate_configuration_conditional(config.unless, config, *args)
+                       !evaluate_configuration_conditional(config.unless, config, *)
 
         if_value && unless_value
       end

data/lib/blacklight/configuration/display_field.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   class Configuration::DisplayField < Blacklight::Configuration::Field
-    def initialize(*args, **kwargs, &block)
+    def initialize(*args, **kwargs, &)
       super
 
       self.presenter ||= Blacklight::FieldPresenter

data/lib/blacklight/configuration/field.rb

@@ -17,37 +17,37 @@ module Blacklight
 
     def normalize! _blacklight_config = nil
       self.field ||= key
-      self.key ||= self.field
+      self.key ||= field
 
       self.label ||= default_label
 
       self.if = true if self.if.nil?
       self.unless = false if self.unless.nil?
 
-      self.field &&= self.field.to_s
+      self.field &&= field.to_s
 
       self
     end
 
     def validate!
-      raise ArgumentError, "Must supply a field name" if self.field.nil?
+      raise ArgumentError, "Must supply a field name" if field.nil?
     end
 
-    def display_label(context = nil, **options)
+    def display_label(context = nil, **)
       field_label(
         (:"blacklight.search.fields.#{context}.#{key}" if context),
         :"blacklight.search.fields.#{key}",
         label,
         default_label,
-        **options
+        **
       )
     end
 
     def default_label
-      if self.key.respond_to?(:titleize)
-        self.key.titleize
+      if key.respond_to?(:titleize)
+        key.titleize
       else
-        self.key.to_s.titleize
+        key.to_s.titleize
       end
     end
 
@@ -65,10 +65,10 @@ module Blacklight
     #     before falling  back to the label
     #   @param [Symbol] any number of additional keys
     #   @param [Symbol] ...
-    def field_label *i18n_keys, **options
+    def field_label(*i18n_keys, **)
       first, *rest = i18n_keys.compact
 
-      I18n.t(first, default: rest, **options)
+      I18n.t(first, default: rest, **)
     end
   end
 end

data/lib/blacklight/configuration/fields.rb

@@ -81,7 +81,7 @@ module Blacklight
       #
       #     add_blacklight_field :index_field, [{ :field => 'format', :label => 'Format' }, IndexField.new(:field => 'date', :label => 'Date')]
       #
-      def add_blacklight_field config_key, *args, &block
+      def add_blacklight_field(config_key, *args, &)
         field_config = case args.first
                        when String
                          field_config_from_key_and_hash(config_key, *args)
@@ -89,7 +89,7 @@ module Blacklight
                          args[0] = args[0].to_s
                          field_config_from_key_and_hash(config_key, *args)
                        when Array
-                         field_config_from_array(config_key, *args, &block)
+                         field_config_from_array(config_key, *args, &)
                          return # we've iterated over the array above.
                        else
                          field_config_from_field_or_hash(config_key, *args)
@@ -101,7 +101,7 @@ module Blacklight
 
         # look up any dynamic fields
         if field_config.match
-          handle_matching_fields(config_key, field_config, &block)
+          handle_matching_fields(config_key, field_config, &)
           return
         end
 

data/lib/blacklight/configuration/sort_field.rb

@@ -10,13 +10,13 @@ module Blacklight
       self.field ||= label&.parameterize
       self.field ||= sort
 
-      self.sort ||= self.field
+      self.sort ||= field
 
       self
     end
 
     def validate!
-      raise ArgumentError.new, "Must supply a sort string" if self.sort.nil?
+      raise ArgumentError.new, "Must supply a sort string" if sort.nil?
     end
   end
 end

data/lib/blacklight/configuration/view_config.rb

@@ -26,7 +26,7 @@ class Blacklight::Configuration
     #   @return [Class] component class used to render the search bar
     # @!attribute search_header_component
     #   @return [Class] component class used to render the header above the documents
-    def display_label(**options)
+    def display_label(**)
       I18n.t(
         :"blacklight.search.view_title.#{key}",
         default: [
@@ -35,7 +35,7 @@ class Blacklight::Configuration
           title,
           key.to_s.humanize
         ],
-        **options
+        **
       )
     end
 

data/lib/blacklight/configuration.rb

@@ -585,7 +585,7 @@ module Blacklight
 
     ##
     # Add a section of config that only applies to documents with a matching display type
-    def for_display_type display_type, &_block
+    def for_display_type(display_type, &)
       fields_for_type[display_type] ||= self.class.new
 
       fields_for_type[display_type].tap do |conf|

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -114,7 +114,7 @@ module Blacklight
 
     def set_default_proc!
       self.default_proc = lambda do |hash, key|
-        hash[key] = nested_class.new(key: key)
+        hash[key] = nested_class.new({ key: key })
       end
     end
   end

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -53,19 +53,19 @@ module Blacklight
       self.class.new @table.deep_dup
     end
 
-    def deep_transform_values(&method)
-      self.class.new @table.deep_transform_values(&method)
+    def deep_transform_values(&)
+      self.class.new @table.deep_transform_values(&)
     end
 
-    def try(method_name = nil, *args, &block)
+    def try(method_name = nil, *, &)
       if method_name.nil? && block_given?
         if b.arity.zero?
-          instance_eval(&block)
+          instance_eval(&)
         else
           yield self
         end
       elsif respond_to?(method_name)
-        public_send(method_name, *args, &b)
+        public_send(method_name, *, &)
       end
     end
   end

data/lib/blacklight/parameters.rb

@@ -79,7 +79,7 @@ module Blacklight
     # Facebook's crawler turns array query parameters into a hash with numeric keys. Once we know
     # the expected parameter structure, we can unmangle those parameters to match our expected values.
     def deep_unmangle_params!(params, permitted_params)
-      permitted_params.select { |p| p.is_a?(Hash) }.each do |permission|
+      permitted_params.grep(Hash).each do |permission|
         permission.each do |key, permitted_value|
           next unless params[key].is_a?(ActionController::Parameters)
 

data/lib/blacklight/search_builder.rb

@@ -95,20 +95,20 @@ module Blacklight
 
     ##
     # Merge additional, repository-specific parameters
-    def merge(extra_params, &block)
+    def merge(extra_params, &)
       if extra_params
         params_will_change!
-        @merged_params.merge!(extra_params.to_hash, &block)
+        @merged_params.merge!(extra_params.to_hash, &)
       end
       self
     end
 
     ##
     # "Reverse merge" additional, repository-specific parameters
-    def reverse_merge(extra_params, &block)
+    def reverse_merge(extra_params, &)
       if extra_params
         params_will_change!
-        @reverse_merged_params.reverse_merge!(extra_params.to_hash, &block)
+        @reverse_merged_params.reverse_merge!(extra_params.to_hash, &)
       end
       self
     end

data/lib/blacklight/search_state/filter_field.rb

@@ -120,8 +120,8 @@ module Blacklight
       delegate :any?, to: :values
 
       # Appease rubocop rules by implementing #each_value
-      def each_value(except: [], &block)
-        values(except: except).each(&block)
+      def each_value(except: [], &)
+        values(except: except).each(&)
       end
 
       # @param [String,#value] item a filter to remove from the url

data/lib/blacklight/search_state/pivot_filter_field.rb

@@ -102,7 +102,7 @@ module Blacklight
             end
             queries.uniq!
           end
-          [(queries - existing)]
+          [queries - existing]
         end
       end
 

data/lib/blacklight/solr/request.rb

@@ -2,7 +2,7 @@
 
 class Blacklight::Solr::InvalidParameter < ArgumentError; end
 
-class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
+class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess # rubocop:disable Style/OneClassPerFile
   # @deprecated
   SINGULAR_KEYS = %w(facet fl q qt rows start spellcheck spellcheck.q sort per_page wt hl group defType)
 

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

@@ -229,7 +229,7 @@ module Blacklight::Solr::Response::Facets
 
     blacklight_config.facet_fields.select { |_k, v| v.query }.each_with_object({}) do |(field_name, facet_field), hash|
       salient_facet_queries = facet_field.query.map { |_k, x| x[:fq] }
-      items = facet_queries.select { |k, _v| salient_facet_queries.include?(k) }.reject { |_value, hits| hits.zero? }.map do |value, hits|
+      items = facet_queries.slice(*salient_facet_queries).reject { |_value, hits| hits.zero? }.map do |value, hits|
         salient_fields = facet_field.query.select { |_key, val| val[:fq] == value }
         key = ((salient_fields.keys if salient_fields.respond_to? :keys) || salient_fields.first).first
         Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
@@ -250,7 +250,7 @@ module Blacklight::Solr::Response::Facets
 
     salient_facet_queries = facet_field.query.map { |_k, x| x[:fq] }
 
-    relevant_facet_data = self['facets'].select { |k, _v| salient_facet_queries.include?(k) }.reject { |_key, data| data['count'].zero? }
+    relevant_facet_data = self['facets'].slice(*salient_facet_queries).reject { |_key, data| data['count'].zero? }
 
     relevant_facet_data.map do |key, data|
       salient_fields = facet_field.query.select { |_key, val| val[:fq] == key }

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

@@ -51,9 +51,9 @@ class Blacklight::Solr::Response::GroupResponse
     )
   end
 
-  def method_missing meth, *args, &block
+  def method_missing(meth, *args, &)
     if response.respond_to? meth
-      response.send(meth, *args, &block)
+      response.send(meth, *args, &)
     else
       super
     end

data/lib/blacklight/solr/response.rb

@@ -64,8 +64,10 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
     case value
     when Hash
       value.each { |k, v| value[k] = force_to_utf8(v) }
+      value
     when Array
       value.each { |v| force_to_utf8(v) }
+      value
     when String
       if value.encoding == Encoding::UTF_8
         value
@@ -73,7 +75,8 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
         Blacklight.logger&.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
         value.dup.force_encoding('UTF-8')
       end
+    else
+      value
     end
-    value
   end
 end

data/lib/blacklight.rb

@@ -116,7 +116,7 @@ module Blacklight
 
   # returns the full path the the blacklight plugin installation
   def self.root
-    @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
+    @root ||= File.expand_path(File.dirname(__FILE__, 2))
   end
 
   def self.deprecation

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

@@ -5,22 +5,39 @@ module Blacklight
     class ImportmapGenerator < Rails::Generators::Base
       class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.3'), desc: "Set the generated app's bootstrap version"
 
-      # This could be skipped if you want to use webpacker
       def add_javascript_dependencies
         gem 'bootstrap', options[:'bootstrap-version'].presence # in rails 7, only for stylesheets
         gem 'jquery-rails' if bootstrap_4? # Bootstrap 4 has a dependency on jquery
       end
 
+      def create_sprockets_manifest_if_needed
+        # BL8 still optionally supports Sprockets for CSS, but Rails 8+
+        # no longer creates the manifest.js file that Sprockets requires.
+        # We don't need to if we already have one, or if we're using
+        # cssbundling (which would create an application.bootstrap.scss file)
+        # via a `rails new` invocation with `--css bootstrap`.
+        return if File.exist?('app/assets/config/manifest.js')
+        return if File.exist?('app/assets/stylesheets/application.bootstrap.scss')
+
+        create_file 'app/assets/config/manifest.js' do
+          <<~CONTENT
+            //= link_tree ../images
+            //= link_directory ../stylesheets .css
+            //= link_tree ../../javascript .js
+          CONTENT
+        end
+      end
+
       def import_javascript_assets
         append_to_file 'config/importmap.rb' do
           <<~CONTENT
-            pin "@github/auto-complete-element", to: "https://cdn.skypack.dev/@github/auto-complete-element"
+            pin "@github/auto-complete-element", to: "https://cdn.jsdelivr.net/npm/@github/auto-complete-element@3.8.0/+esm"
             pin "@popperjs/core", to: "https://ga.jspm.io/npm:@popperjs/core@2.11.6/dist/umd/popper.min.js"
             pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.3.2'}/dist/js/bootstrap.js"
           CONTENT
         end
 
-        return unless defined?(Sprockets)
+        return unless File.exist?('app/assets/config/manifest.js')
 
         append_to_file 'app/assets/config/manifest.js' do
           <<~CONTENT
@@ -59,6 +76,8 @@ module Blacklight
             CONTENT
           end
         else
+          # NOTE: sassc-rails pulls in sprockets-rails, which requires that a
+          # manifest.js file exists.
           gem "sassc-rails", "~> 2.1"
 
           create_file 'app/assets/stylesheets/blacklight.scss' do
@@ -67,6 +86,12 @@ module Blacklight
               @import 'blacklight/blacklight';
             CONTENT
           end
+
+          # application.css in a Rails 8 app has no Sprockets require
+          # directives, so blacklight.scss won't be included unless we add one.
+          inject_into_file 'app/assets/stylesheets/application.css',
+                           "\n *= require blacklight",
+                           before: "\n */"
         end
       end
 

data/lib/generators/blacklight/search_builder_generator.rb

@@ -27,7 +27,7 @@ module Blacklight
     private
 
     def rspec_installed?
-      defined?(RSpec) && defined?(RSpec::Rails)
+      defined?(RSpec::Rails)
     end
   end
 end