blacklight 7.28.0 → 7.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7e57b2c0a5ca770fa8fbc0560072609b5db93d10c952d33af0db3d69ae2dfc6
-  data.tar.gz: 231146a7df38ba031b116075b75bf9abe7f91e760485524fb8678a624d9be893
+  metadata.gz: d3f2833ee33fe1cc1d37ef72206820efdd9bbdd4c39f14783c08bfba4c7b9dd8
+  data.tar.gz: 3f9cbc91061f1a1b68bd25aab95c518f134c7a497566241691a8aee63cc6b752
 SHA512:
-  metadata.gz: 95bc567df4947b3a11b37749c0c9a123da3c5a20552e78195a77775638bc5075d1db2c6d11d8158864346a1346a29a296a3ce8a873b497a9946eb011cd53843f
-  data.tar.gz: 28efc83fd658e1e43a3f85c8bea5ec389ee913b540b413ce967925b98b48a5d4d9422a2df1fcbf14d905ba0e31cba3fe9267a3cee38e6371adaf83b963183f41
+  metadata.gz: 5b6500ea3048765a8e9d78425eb6f14d7a7edcb6cd17c1ddcc91c88edc7e09353672f0aa7ff29e1e85fbe238508066f9221b652c48cacbfe947e636dbac13a27
+  data.tar.gz: 5da051e3b7d496204d5e8752c09d346e39c0a94d917539155e60d0a2488ee3a32770bdbf205d11d9fff9da0f107c8d01b8786749ad9e9272b4b9933f46b6815e

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.28.0
+7.30.0

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

@@ -1,5 +1,5 @@
 .group-key {
-  border-bottom: 1px solid darken($table-border-color, 60%);
+  border-bottom: 1px solid darken($border-color, 60%);
   clear: right;
 }
 
@@ -11,4 +11,4 @@
 
 .more-in-group {
   float: right;
-}
+}

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_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/facet_component.rb

@@ -11,8 +11,8 @@ module Blacklight
     # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
     # @param [Blacklight::Configuration] blacklight_config
     # @param [Boolean] layout
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def initialize(display_facet_or_field_config: nil, display_facet: nil, field_config: nil, response: nil, blacklight_config: nil, **component_args)
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists
+    def initialize(display_facet_or_field_config: nil, display_facet: nil, field_config: nil, response: nil, blacklight_config: nil, component: nil, **component_args)
       if display_facet_or_field_config.is_a? Blacklight::FacetFieldPresenter
         @facet_field_presenter = display_facet_or_field_config
         @field_config = @facet_field_presenter.facet_field
@@ -30,9 +30,10 @@ module Blacklight
         raise ArgumentError, 'You must provide one of display_facet or field_config' unless @field_config
       end
 
+      @component = component || (@field_config.component == true ? Blacklight::FacetFieldListComponent : @field_config.component)
       @component_args = component_args
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists
 
     def render?
       helpers.should_render_field?(@field_config, @display_facet)
@@ -41,10 +42,8 @@ module Blacklight
     def call
       return render_partial if @field_config.partial
 
-      component = @field_config.component == true ? Blacklight::FacetFieldListComponent : @field_config.component
-
       render(
-        component.new(
+        @component.new(
           facet_field: @facet_field_presenter || helpers.facet_field_presenter(@field_config, @display_facet),
           **@component_args
         )

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

@@ -0,0 +1,20 @@
+# 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
+      def initialize(svg: nil)
+        self.svg = svg if svg
+      end
+
+      def call
+        svg&.html_safe # rubocop:disable Rails/OutputSafety
+      end
+
+      class_attribute :svg
+    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/views/catalog/index.json.jbuilder

@@ -67,14 +67,16 @@ json.included do
     end
   end
 
-  json.array! search_fields do |(label, key)|
-    json.type 'search_field'
-    json.id key
-    json.attributes do
-      json.label label
-    end
-    json.links do
-      json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
+  Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+    json.array! search_fields do |(label, key)|
+      json.type 'search_field'
+      json.id key
+      json.attributes do
+        json.label label
+      end
+      json.links do
+        json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
+      end
     end
   end
 

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

@@ -27,7 +27,7 @@ module Blacklight
       end
 
       @blacklight_params = {}
-      search_state_class = @scope&.search_state_class || Blacklight::SearchState
+      search_state_class = @scope.try(:search_state_class) || Blacklight::SearchState
       @search_state = search_state_class.new(@blacklight_params, @scope&.blacklight_config, @scope)
       @additional_filters = {}
       @merged_params = {}
@@ -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/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/components/blacklight/facet_component_spec.rb

@@ -26,6 +26,25 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     expect(rendered).to have_selector 'ul.facet-values'
   end
 
+  context 'with a provided component' do
+    let(:component_kwargs) { { field_config: facet_config, display_facet: display_facet, component: component_class } }
+    let(:component_class) do
+      Class.new(Blacklight::FacetFieldListComponent) do
+        def self.name
+          'CustomFacetComponent'
+        end
+
+        def call
+          'Custom facet rendering'
+        end
+      end
+    end
+
+    it 'renders the provided component' do
+      expect(rendered).to have_content 'Custom facet rendering'
+    end
+  end
+
   context 'with a facet configured to use a partial' do
     let(:facet_config) do
       Blacklight::Configuration::FacetField.new(key: 'field', partial: 'catalog/facet_partial').normalize!

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.28.0
+  version: 7.30.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-10-03 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