blacklight 7.29.0 → 7.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 752a397403b186b177e51a6f260f7f385d9e1db6c26abdb9b37c9c25ecf2ad04
-  data.tar.gz: f81dc90a28f7c9d9cecc35f60e119bd09ec96bd12584b8f1ffb39e51845a0588
+  metadata.gz: e7693f7aa372d8e623d9cb996089c4a04bff5ea462b119263efbceec482f0085
+  data.tar.gz: e2c3b9c56f6158c05b97685cfebbc3dc38fbdee1052cd8b5c3e432900cbec35d
 SHA512:
-  metadata.gz: 54c453918cd5521dd2ee24df0d7d874c48705d14422f8746a10bd262681e411ed54efef1202f9785beec20169ca5ca9acd4d648e730df8a930d2aa659190d905
-  data.tar.gz: 8014988552c75ebb9bbbd82dcad688dfcd3ea2b6126b63c4c178ab32fe034787bdd61b75a826ecdb1c9022e148a7f9911eb99e7c35090de9361d434756fb85a1
+  metadata.gz: b0e155b0bf0fa6f5b8c15ef317bb05198b91e871187a8f8fc846894f182e3a2883ae07caa9c3eceaa676a1b45ce94f34bd73e9d9a4b97ce55eb2da15d5c4ab6f
+  data.tar.gz: 69adc6ec4c6402a555bcf2f970adfb692ea5b9a5422375050f787b494d0f62d371859198db14d45373416d10743ee1759162900c25840994481edebd618527c6

data/.github/workflows/ruby.yml

@@ -23,6 +23,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.7
+        bundler: 'latest'
     - name: Install dependencies
       run: bundle install
     - name: Run linter
@@ -38,12 +39,13 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler: 'latest'
     - name: Install dependencies
       run: bundle install
     - name: Run tests
       run: bundle exec rake ci
       env:
-        ENGINE_CART_RAILS_OPTIONS: '-a propshaft --skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
   test_bootstrap5:
     runs-on: ubuntu-latest
     strategy:
@@ -55,6 +57,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler: 'latest'
     - name: Install dependencies
       run: bundle install
     - name: Run tests
@@ -73,6 +76,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler: 'latest'
     - name: Install dependencies
       run: bundle install
       env:
@@ -93,6 +97,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler: 'latest'
     - name: Install dependencies
       run: bundle install
       env:
@@ -114,6 +119,7 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler: 'latest'
     - name: Install dependencies
       run: bundle install
       env:
@@ -133,6 +139,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
+        bundler: 'latest'
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies
       run: bundle install
@@ -140,7 +147,7 @@ jobs:
       run: bundle exec rake ci
       env:
         BLACKLIGHT_API_TEST: true
-        ENGINE_CART_RAILS_OPTIONS: '--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+        ENGINE_CART_RAILS_OPTIONS: '-a propshaft --api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test'
   docker_build:
     runs-on: ubuntu-latest
     steps:

data/README.md

@@ -42,7 +42,7 @@ rails generate blacklight:install
 Code contributions are always welcome, instructions for contributing can be found at [CONTRIBUTING.md](https://github.com/projectblacklight/blacklight/blob/main/CONTRIBUTING.md).
 
 ## Configuring Apache Solr
-You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [README_SOLR](https://github.com/projectblacklight/blacklight/wiki/README_SOLR)
+You'll also want some information about how Blacklight expects [Apache Solr](http://lucene.apache.org/solr ) to run, which you can find in [Solr Configuration](https://github.com/projectblacklight/blacklight/wiki/Solr-Configuration#solr-configuration)
 
 ## Building the javascript
 The javascript is built by npm from sources in `app/javascript` into a bundle

data/VERSION

@@ -1 +1 @@
-7.29.0
+7.31.0

data/app/assets/stylesheets/blacklight/_twitter_typeahead.scss

@@ -9,6 +9,7 @@
 
   input.tt-hint.form-control {
     width: 100%;
+    filter: opacity(0.33);
   }
 
   .tt-menu {
@@ -27,4 +28,10 @@
     font-size: 14px;
     padding: 5px 5px 5px 10px;
   }
+
+  .tt-suggestion:hover {
+    background-color: $dropdown-link-hover-bg;
+    color: $dropdown-link-hover-color;
+    cursor: pointer;
+  }
 }

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/document_title_component.html.erb

@@ -1,12 +1,12 @@
 <header class="documentHeader row">
   <%= content_tag @as, class: @classes do %>
-    <% before_title.each do |t| %>
+    <% before_titles.each do |t| %>
       <%= t %>
     <% end %>
 
     <%= counter -%><%= title -%>
 
-    <% after_title.each do |t| %>
+    <% after_titles.each do |t| %>
       <%= t %>
     <% end %>
   <% end %>

data/app/components/blacklight/document_title_component.rb

@@ -2,8 +2,8 @@
 
 module Blacklight
   class DocumentTitleComponent < Blacklight::Component
-    renders_many :before_title
-    renders_many :after_title
+    renders_many :before_titles
+    renders_many :after_titles
     renders_many :actions
 
     # rubocop:disable Metrics/ParameterLists

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Icons
+    # This is the list icon for the search button.
+    # You can override the default svg by setting:
+    #   Blacklight::Icons::ListComponent.svg = '<svg>your SVG here</svg>'
+    class IconComponent < ::ViewComponent::Base
+      # 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
+        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/components/blacklight/response/view_type_button_component.rb

@@ -15,6 +15,9 @@ module Blacklight
       end
 
       def icon
+        return render(@view.icon.new) if @view.icon.is_a?(Class)
+        return render(@view.icon) if @view.icon.is_a?(ViewComponent::Base)
+
         Deprecation.silence(Blacklight::CatalogHelperBehavior) do
           helpers.render_view_type_group_icon(@view.icon || @key)
         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/component.rb

@@ -8,6 +8,8 @@ module Blacklight
         @__vc_compiler ||= EngineCompiler.new(self)
       end
       # rubocop:enable Naming/MemoizedInstanceVariableName
+
+      alias sidecar_files _sidecar_files unless ViewComponent::Base.respond_to? :sidecar_files
     end
 
     class EngineCompiler < ::ViewComponent::Compiler
@@ -23,7 +25,7 @@ module Blacklight
         @templates ||= begin
           extensions = ActionView::Template.template_handler_extensions
 
-          component_class._sidecar_files(extensions).each_with_object([]) do |path, memo|
+          component_class.sidecar_files(extensions).each_with_object([]) do |path, memo|
             pieces = File.basename(path).split(".")
             app_path = "#{Rails.root}/#{path.slice(path.index(component_class.view_component_path)..-1)}"
 

data/lib/blacklight/configuration/fields.rb

@@ -13,7 +13,7 @@ module Blacklight
         def define_field_access(key, base_class_name = nil, class: nil)
           key = key.to_s if respond_to? :to_s
 
-          default_values[key.pluralize.to_sym] = ActiveSupport::OrderedHash.new
+          default_values[key.pluralize.to_sym] = ActiveSupport::HashWithIndifferentAccess.new
 
           @field_type_for_class ||= {}
           @field_type_for_class[key] = binding.local_variable_get(:class) || base_class_name

data/lib/blacklight/configuration/view_config.rb

@@ -14,7 +14,7 @@ class Blacklight::Configuration
     # @!attribute display_type_field
     #   @return [String, Symbol] solr field to use to render format-specific partials
     # @!attribute icon
-    #   @return [String, Symbol] icon file to use in the view picker
+    #   @return [String, Symbol, Blacklight::Icons::IconComponent] icon file to use in the view picker
     # @!attribute document_actions
     #   @return [NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}] 'tools' to render for each document
     # @!attribute facet_group_component

data/lib/blacklight/search_builder.rb

@@ -45,6 +45,9 @@ module Blacklight
 
     ##
     # Update the :q (query) parameter
+    # @param [Hash<Symbol,Object>] conditions the field and values to query on
+    # @example
+    #    search_builder.where(id: [1,2,3]) # produces: q:"{!lucene}id:(1 OR 2 OR 3)"
     def where(conditions)
       Deprecation.warn(Blacklight::SearchBuilder, "SearchBuilder#where must be called with a hash, received #{conditions.inspect}.") unless conditions.is_a? Hash
       params_will_change!

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/components/blacklight/document_component_spec.rb

@@ -166,4 +166,18 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       expect(rendered).to have_content 'Thumb!'
     end
   end
+
+  context 'with before_title' do
+    let(:render) do
+      component.render_in(view_context) do
+        component.title do |c|
+          c.before_title { 'Prefix!' }
+        end
+      end
+    end
+
+    it 'shows the prefix' do
+      expect(rendered).to have_content "Prefix!"
+    end
+  end
 end

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

data/spec/models/blacklight/configuration_spec.rb

@@ -39,13 +39,13 @@ RSpec.describe "Blacklight::Configuration", api: true do
     end
 
     it "has ordered hashes for field configuration" do
-      expect(config.facet_fields).to be_a_kind_of ActiveSupport::OrderedHash
-      expect(config.index_fields).to be_a_kind_of ActiveSupport::OrderedHash
-      expect(config.show_fields).to be_a_kind_of ActiveSupport::OrderedHash
-      expect(config.search_fields).to be_a_kind_of ActiveSupport::OrderedHash
-      expect(config.show_fields).to be_a_kind_of ActiveSupport::OrderedHash
-      expect(config.search_fields).to be_a_kind_of ActiveSupport::OrderedHash
-      expect(config.sort_fields).to be_a_kind_of ActiveSupport::OrderedHash
+      expect(config.facet_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.index_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.show_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.search_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.show_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.search_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.sort_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.29.0
+  version: 7.31.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -470,6 +470,7 @@ files:
 - app/components/blacklight/facet_item_component.rb
 - app/components/blacklight/facet_item_pivot_component.rb
 - app/components/blacklight/hidden_search_state_component.rb
+- app/components/blacklight/icons/icon_component.rb
 - app/components/blacklight/metadata_field_component.html.erb
 - app/components/blacklight/metadata_field_component.rb
 - app/components/blacklight/metadata_field_layout_component.html.erb
@@ -554,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
@@ -619,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