blacklight 7.30.0 → 7.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f2833ee33fe1cc1d37ef72206820efdd9bbdd4c39f14783c08bfba4c7b9dd8
-  data.tar.gz: 3f9cbc91061f1a1b68bd25aab95c518f134c7a497566241691a8aee63cc6b752
+  metadata.gz: e7693f7aa372d8e623d9cb996089c4a04bff5ea462b119263efbceec482f0085
+  data.tar.gz: e2c3b9c56f6158c05b97685cfebbc3dc38fbdee1052cd8b5c3e432900cbec35d
 SHA512:
-  metadata.gz: 5b6500ea3048765a8e9d78425eb6f14d7a7edcb6cd17c1ddcc91c88edc7e09353672f0aa7ff29e1e85fbe238508066f9221b652c48cacbfe947e636dbac13a27
-  data.tar.gz: 5da051e3b7d496204d5e8752c09d346e39c0a94d917539155e60d0a2488ee3a32770bdbf205d11d9fff9da0f107c8d01b8786749ad9e9272b4b9933f46b6815e
+  metadata.gz: b0e155b0bf0fa6f5b8c15ef317bb05198b91e871187a8f8fc846894f182e3a2883ae07caa9c3eceaa676a1b45ce94f34bd73e9d9a4b97ce55eb2da15d5c4ab6f
+  data.tar.gz: 69adc6ec4c6402a555bcf2f970adfb692ea5b9a5422375050f787b494d0f62d371859198db14d45373416d10743ee1759162900c25840994481edebd618527c6

data/VERSION

@@ -1 +1 @@
-7.30.0
+7.31.0

data/app/components/blacklight/document/action_component.html.erb

@@ -3,7 +3,7 @@
               url,
               id: @id,
               class: @link_classes,
-              data: {}.merge(({ blacklight_modal: "trigger" } if @action.modal != false) || {}) %>
+              data: {}.merge(({ blacklight_modal: "trigger", turbo: false } if @action.modal != false) || {}) %>
 <% else %>
   <%= helpers.render(partial: @action.partial || @action.name.to_s, locals: { document: @document, document_action_config: @action }.merge(@options)) %>
 <% end %>

data/app/components/blacklight/icons/icon_component.rb

@@ -6,15 +6,27 @@ module Blacklight
     # You can override the default svg by setting:
     #   Blacklight::Icons::ListComponent.svg = '<svg>your SVG here</svg>'
     class IconComponent < ::ViewComponent::Base
-      def initialize(svg: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(svg: nil, tag: :span, name: nil, label: nil, aria_hidden: nil, classes: nil, **options)
         self.svg = svg if svg
+        @classes = Array(classes) + ['blacklight-icons', "blacklight-icons-#{name}"]
+        @name = name
+        @tag = tag
+        @options = options.merge(aria: options.fetch(:aria, {}).reverse_merge(label: label, hidden: aria_hidden))
       end
+      # rubocop:enable Metrics/ParameterLists
 
       def call
-        svg&.html_safe # rubocop:disable Rails/OutputSafety
+        tag.public_send(@tag, svg&.html_safe, # rubocop:disable Rails/OutputSafety
+                        class: @classes,
+                        **@options)
       end
 
       class_attribute :svg
+
+      def name
+        @name ||= self.class.name.demodulize.underscore.sub('_component', '')
+      end
     end
   end
 end

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -9,9 +9,11 @@ module Blacklight::IconHelperBehavior
   # the svg everytime.
   # @param [String, Symbol] icon_name
   # @return [String]
-  def blacklight_icon(icon_name, options = {})
-    Rails.cache.fetch([:blacklight_icons, icon_name, options]) do
-      icon = Blacklight::Icon.new(icon_name, **options)
+  def blacklight_icon(icon_name, **kwargs)
+    render "Blacklight::Icons::#{icon_name.to_s.camelize}Component".constantize.new(**kwargs)
+  rescue NameError
+    Rails.cache.fetch([:blacklight_icons, icon_name, kwargs]) do
+      icon = Blacklight::Icon.new(icon_name, **kwargs)
       tag.span(icon.svg.html_safe, **icon.options)
     end
   end

data/app/models/search_builder.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SearchBuilder < Blacklight::SearchBuilder
+  include Blacklight::Solr::SearchBuilderBehavior
+end

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

@@ -12,8 +12,7 @@
 <% end %>
 
 <% content_for(:container_header) do -%>
-  <h1 class="sr-only visually-hidden top-content-title"><%= t('blacklight.search.header') %></h1>
-
+  <%= render 'search_results_header' %>
   <%= render 'constraints' %>
 <% end %>
 

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

@@ -0,0 +1 @@
+<h1 class="sr-only visually-hidden top-content-title"><%= t('blacklight.search.header') %></h1>

data/lib/blacklight.rb

@@ -60,11 +60,7 @@ module Blacklight
   end
 
   def self.connection_config
-    Blacklight::RuntimeRegistry.connection_config ||= begin
-      raise "The #{::Rails.env} environment settings were not found in the blacklight.yml config" unless blacklight_yml[::Rails.env]
-
-      blacklight_yml[::Rails.env].symbolize_keys
-    end
+    Blacklight::RuntimeRegistry.connection_config ||= blacklight_yml[::Rails.env]&.symbolize_keys if blacklight_yml?
   end
 
   def self.connection_config=(value)
@@ -86,7 +82,7 @@ module Blacklight
     require 'yaml'
 
     return @blacklight_yml if @blacklight_yml
-    unless File.exist?(blacklight_config_file)
+    unless blacklight_yml?
       raise "You are missing a configuration file: #{blacklight_config_file}. Have you run \"rails generate blacklight:install\"?"
     end
 
@@ -113,6 +109,10 @@ module Blacklight
     @blacklight_yml
   end
 
+  def self.blacklight_yml?
+    File.exist?(blacklight_config_file)
+  end
+
   def self.logger
     @logger ||= begin
       ::Rails.logger if defined? Rails && Rails.respond_to?(:logger)

data/lib/generators/blacklight/assets_generator.rb

@@ -15,8 +15,6 @@ module Blacklight
       return unless Rails.version > '7'
 
       gem "sassc-rails", "~> 2.1"
-
-      remove_file 'app/javascript/application.js'
     end
 
     # Add sprockets javascript if needed
@@ -37,7 +35,7 @@ module Blacklight
     # Remove the empty generated app/assets/images directory. Without doing this,
     # the default Sprockets 4 manifest will raise an exception.
     def appease_sprockets4
-      return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4'
+      return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4' || using_importmap?
 
       append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
       empty_directory 'app/assets/images'
@@ -74,6 +72,14 @@ module Blacklight
 
     private
 
+    def root
+      @root ||= Pathname(destination_root)
+    end
+
+    def using_importmap?
+      @using_importmap ||= root.join('config/importmap.rb').exist?
+    end
+
     def turbolinks?
       @turbolinks ||= application_js.include?('turbolinks')
     end

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+
+# Blacklight controller that handles searches and document requests
 class <%= controller_name.classify %>Controller < ApplicationController
 
   include Blacklight::Catalog

data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml

@@ -17,7 +17,7 @@
   </updateHandler>
 
   <!-- solr lib dirs -->
-  <lib dir="${solr.install.dir:../../../..}/contrib/modules/lib" />
+  <lib dir="${solr.install.dir:../../../..}/modules/analysis-extras/lib" />
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lib" />
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lucene-libs" />
 

data/lib/generators/blacklight/templates/solr_document.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+
+# Represent a single document returned from Solr
 class <%= model_name.classify %>
   include Blacklight::Solr::Document
 

data/spec/helpers/blacklight/icon_helper_behavior_spec.rb

@@ -2,9 +2,14 @@
 
 RSpec.describe Blacklight::IconHelperBehavior do
   describe '#blacklight_icon' do
-    it 'wraps the svg in a span with classes' do
-      expect(helper.blacklight_icon(:search))
-        .to have_css 'span.blacklight-icons svg'
+    subject(:icon) { helper.blacklight_icon(:search, classes: 'custom-class') }
+
+    it 'returns the svg' do
+      expect(icon).to have_css '.blacklight-icons svg'
+    end
+
+    it 'adds classes to the wrappering element' do
+      expect(icon).to have_css '.custom-class svg'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.30.0
+  version: 7.31.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -555,6 +555,7 @@ files:
 - app/models/concerns/blacklight/user.rb
 - app/models/record_mailer.rb
 - app/models/search.rb
+- app/models/search_builder.rb
 - app/models/solr_document.rb
 - app/presenters/blacklight/clause_presenter.rb
 - app/presenters/blacklight/document_presenter.rb
@@ -620,6 +621,7 @@ files:
 - app/views/catalog/_search_form.html.erb
 - app/views/catalog/_search_header.html.erb
 - app/views/catalog/_search_results.html.erb
+- app/views/catalog/_search_results_header.html.erb
 - app/views/catalog/_search_sidebar.html.erb
 - app/views/catalog/_show.html.erb
 - app/views/catalog/_show_header.html.erb