blacklight 7.31.0 → 7.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7693f7aa372d8e623d9cb996089c4a04bff5ea462b119263efbceec482f0085
-  data.tar.gz: e2c3b9c56f6158c05b97685cfebbc3dc38fbdee1052cd8b5c3e432900cbec35d
+  metadata.gz: 17b8b14189b4ced9faa60d183fa887eb6962dba4d55f3718fee11ff4bed59388
+  data.tar.gz: dd1f5ea853080c0732313b3ab64de8d310634786cfbcfe5ddde6691bc2137820
 SHA512:
-  metadata.gz: b0e155b0bf0fa6f5b8c15ef317bb05198b91e871187a8f8fc846894f182e3a2883ae07caa9c3eceaa676a1b45ce94f34bd73e9d9a4b97ce55eb2da15d5c4ab6f
-  data.tar.gz: 69adc6ec4c6402a555bcf2f970adfb692ea5b9a5422375050f787b494d0f62d371859198db14d45373416d10743ee1759162900c25840994481edebd618527c6
+  metadata.gz: d481b3b290ca1030fcc593fad5ef8fdbe3e5a42091c4138af3efaaa58b45322f32d8e4956e6d92d01d305e762d4e2a3886f9caa193ba4197920d18d989184308
+  data.tar.gz: f6010fc1c00b31fddce8d2e73794655dbe3c1c690e65bedace78c693a4c36a884f5ac0589681717e3852bf9e1ff41109a7d5de2c2d4957e835c59afd53cfcfcb

data/VERSION

@@ -1 +1 @@
-7.31.0
+7.32.0

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

@@ -12,19 +12,16 @@
 .navbar-logo {  /* The main logo image for the Blacklight instance */
   @if $logo-image {
     background: transparent $logo-image no-repeat top left;
+    background-size: $logo-width $logo-height;
   }
-
   display: inline-block;
-  flex: 0 0 150px;
-  height: 50px;
-  margin-right:20px;
+  height: $logo-height;
+  margin-right: 20px;
   margin-top: -0.4rem;
   overflow: hidden;
-  padding-left: 0;
-  padding-right: 0;
   text-indent: 100%;
   white-space: nowrap;
-  width: 150px;
+  width: $logo-width;
 }
 
 .navbar-search {

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

@@ -1,6 +1,8 @@
 /* Warning! If you want to change these, just copy them into your own theme css. But you want to remove the !default, which only will set them if not already set. */
 
 $logo-image: image_url('blacklight/logo.png') !default;
+$logo-width: 150px !default;
+$logo-height: 50px !default;
 
 /* label (field names) */
 $field_name_color: $text-muted !default;

data/app/components/blacklight/constraint_component.html.erb

@@ -1,5 +1,5 @@
 <%= render(@layout.new(
       classes: (Array(@classes) + ["filter-#{@facet_item_presenter.key.parameterize}"]).join(' '),
       label: @facet_item_presenter.field_label,
-      value: @facet_item_presenter.label,
+      value: @facet_item_presenter.constraint_label,
       remove_path: @facet_item_presenter.remove_href)) %>

data/app/components/blacklight/search_bar_component.html.erb

@@ -1,8 +1,11 @@
-<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => scoped_t('submit') do %>
+<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', aria: { label: scoped_t('submit') }, **@form_options do %>
   <%= render_hash_as_hidden_fields(@params) %>
   <% if search_fields.length > 1 %>
     <label for="search_field" class="sr-only visually-hidden"><%= scoped_t('search_field.label') %></label>
   <% end %>
+  <% before_input_groups.each do |input_group| %>
+    <%= input_group %>
+  <% end %>
   <div class="input-group">
     <%= prepend %>
 
@@ -17,15 +20,11 @@
     <% end %>
 
     <label for="<%= @prefix %><%= @query_param %>" class="sr-only visually-hidden"><%= scoped_t('search.label') %></label>
-    <%= text_field_tag @query_param, @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
+    <%= text_field_tag @query_param, @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, aria: { label: scoped_t('search.label') }, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
 
     <span class="input-group-append">
       <%= append %>
-
-      <button type="submit" class="btn btn-primary search-btn" id="<%= @prefix %>search">
-        <span class="submit-search-text"><%= scoped_t('submit') %></span>
-        <%= blacklight_icon :search, aria_hidden: true %>
-      </button>
+      <%= search_button || render(Blacklight::SearchButtonComponent.new(id: "#{@prefix}search", text: scoped_t('submit'))) %>
     </span>
   </div>
 <% end %>

data/app/components/blacklight/search_bar_component.rb

@@ -6,6 +6,8 @@ module Blacklight
 
     renders_one :append
     renders_one :prepend
+    renders_one :search_button
+    renders_many :before_input_groups
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
@@ -14,7 +16,8 @@ module Blacklight
       classes: ['search-query-form'], prefix: nil,
       method: 'GET', q: nil, query_param: :q,
       search_field: nil, search_fields: nil, autocomplete_path: nil,
-      autofocus: nil, i18n: { scope: 'blacklight.search.form' }
+      autofocus: nil, i18n: { scope: 'blacklight.search.form' },
+      form_options: {}
     )
       @url = url
       @advanced_search_url = advanced_search_url
@@ -29,6 +32,8 @@ module Blacklight
       @autofocus = autofocus
       @search_fields = search_fields
       @i18n = i18n
+      @form_options = form_options
+
       return if presenter.nil?
 
       Deprecation.warn(self, 'SearchBarComponent no longer uses a SearchBarPresenter, the presenter: param will be removed in 8.0. ' \

data/app/components/blacklight/search_button_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchButtonComponent < ::ViewComponent::Base
+    def initialize(text:, id:)
+      @text = text
+      @id = id
+    end
+
+    def call
+      tag.button(class: 'btn btn-primary search-btn', type: 'submit', id: @id) do
+        tag.span(@text, class: "submit-search-text") +
+          blacklight_icon(:search, aria_hidden: true)
+      end
+    end
+  end
+end

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -38,28 +38,26 @@ module Blacklight
     # (normally renders next to title in the list view)
     #
     # @param [SolrDocument] document
-    # @param [Hash] options
-    # @option options [String] :wrapping_class
+    # @param [String] wrapping_class ("index-document-functions")
+    # @param [Class] component (Blacklight::Document::ActionsComponent)
     # @return [String]
-    def render_index_doc_actions(document, options = {})
-      actions = filter_partials(blacklight_config.view_config(document_index_view_type).document_actions, { document: document }.merge(options)).map { |_k, v| v }
-      wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
+    def render_index_doc_actions(document, wrapping_class: "index-document-functions", component: Blacklight::Document::ActionsComponent)
+      actions = filter_partials(blacklight_config.view_config(document_index_view_type).document_actions, { document: document }).map { |_k, v| v }
 
-      render(Blacklight::Document::ActionsComponent.new(document: document, actions: actions, options: options, classes: wrapping_class))
+      render(component.new(document: document, actions: actions, classes: wrapping_class))
     end
 
     ##
     # Render "collection actions" area for search results view
     # (normally renders next to pagination at the top of the result set)
     #
-    # @param [Hash] options
-    # @option options [String] :wrapping_class
+    # @param [String] wrapping_class ("search-widgets")
+    # @param [Class] component (Blacklight::Document::ActionsComponent)
     # @return [String]
-    def render_results_collection_tools(options = {})
-      actions = filter_partials(blacklight_config.view_config(document_index_view_type).collection_actions, options).map { |_k, v| v }
-      wrapping_class = options.delete(:wrapping_class) || "search-widgets"
+    def render_results_collection_tools(wrapping_class: "search-widgets", component: Blacklight::Document::ActionsComponent)
+      actions = filter_partials(blacklight_config.view_config(document_index_view_type).collection_actions, {}).map { |_k, v| v }
 
-      render(Blacklight::Document::ActionsComponent.new(actions: actions, options: options, classes: wrapping_class))
+      render(component.new(actions: actions, classes: wrapping_class))
     end
 
     ##

data/app/models/concerns/blacklight/document.rb

@@ -26,6 +26,8 @@ module Blacklight::Document
     extend ActiveModel::Naming
     include Blacklight::Document::Extensions
     include GlobalID::Identification
+
+    class_attribute :inspector_fields, default: [:_source]
   end
 
   attr_reader :response, :_source
@@ -82,6 +84,11 @@ module Blacklight::Document
     Array(self[key]).first
   end
 
+  def inspect
+    fields = inspector_fields.map { |field| "#{field}: #{public_send(field)}" }.join(", ")
+    "#<#{self.class.name}:#{object_id} #{fields}>"
+  end
+
   def to_partial_path
     'catalog/document'
   end

data/app/presenters/blacklight/clause_presenter.rb

@@ -24,6 +24,10 @@ module Blacklight
       user_parameters[:query]
     end
 
+    def constraint_label
+      label
+    end
+
     def remove_href(path = search_state)
       view_context.search_action_path(path.reset_search(clause: path.clause_params.except(key)).to_h)
     end

data/app/presenters/blacklight/document_presenter.rb

@@ -125,6 +125,11 @@ module Blacklight
       configuration.view_config(:show)
     end
 
+    def inspect
+      fields = "document:#{document.inspect}"
+      "#<#{self.class.name}:#{object_id} #{fields}>"
+    end
+
     private
 
     def render_field?(field_config)

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -66,6 +66,14 @@ module Blacklight
       end
     end
 
+    # Get the displayable version of the facet's value for use
+    # in e.g. the constraints widget
+    #
+    # @return [String]
+    def constraint_label
+      label
+    end
+
     def value
       if facet_item.respond_to? :value
         facet_item.value

data/blacklight.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency "deprecation"
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '~> 2.43'
+  s.add_dependency "view_component", '~> 2.66'
   s.add_dependency 'hashdiff'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.

data/lib/blacklight/component.rb

@@ -3,6 +3,11 @@
 module Blacklight
   class Component < ViewComponent::Base
     class << self
+      # Workaround for https://github.com/ViewComponent/view_component/issues/1565
+      def config
+        @config ||= ViewComponent::Config.defaults.merge(ViewComponent::Base.config)
+      end
+
       # rubocop:disable Naming/MemoizedInstanceVariableName
       def compiler
         @__vc_compiler ||= EngineCompiler.new(self)
@@ -12,6 +17,21 @@ module Blacklight
       alias sidecar_files _sidecar_files unless ViewComponent::Base.respond_to? :sidecar_files
     end
 
+    EXCLUDE_VARIABLES = [
+      :@lookup_context, :@view_renderer, :@view_flow, :@view_context,
+      :@tag_builder, :@current_template,
+      :@__vc_set_slots, :@__vc_original_view_context,
+      :@__vc_variant, :@__vc_content_evaluated,
+      :@__vc_render_in_block, :@__vc_content, :@__vc_helpers
+    ].freeze
+
+    def inspect
+      # Exclude variables added by render_in
+      render_variables = instance_variables - EXCLUDE_VARIABLES
+      fields = render_variables.map { |ivar| "#{ivar}:#{instance_variable_get(ivar).inspect}" }.join(', ')
+      "#<#{self.class.name}:#{object_id} #{fields}>"
+    end
+
     class EngineCompiler < ::ViewComponent::Compiler
       # ViewComponent::Compiler locates and caches templates from sidecar files to the component source file.
       # While this is sensible in a Rails application, it prevents component templates defined in an Engine

data/package.json

@@ -28,7 +28,6 @@
   },
   "browserslist": "> 0.25%, not dead",
   "dependencies": {
-    "bloodhound-js": "^1.2.3",
     "bootstrap": ">=4.3.1 <6.0.0",
     "jquery": "^3.5.1",
     "typeahead.js": "^0.11.1"

data/spec/components/blacklight/search_bar_component_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::SearchBarComponent, type: :component do
+  let(:instance) { described_class.new(url: search_action_url, params: params_for_search) }
+
+  let(:search_action_url) { '/catalog' }
+  let(:params_for_search) { { q: 'testParamValue' } }
+  let(:blacklight_config) do
+    Blacklight::Configuration.new.configure do |config|
+      config.view = { list: nil, abc: nil }
+    end
+  end
+
+  before do
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+  end
+
+  context 'with the default button' do
+    subject(:render) { render_inline(instance) }
+
+    it 'renders the search field and a button' do
+      expect(render.css("input[aria-label='#{I18n.t('blacklight.search.form.search.label')}']")).to be_present
+      expect(render.css("button#search")).to be_present
+    end
+  end
+
+  context 'when a button is passed in' do
+    subject(:render) do
+      render_inline(instance) do |c|
+        c.search_button do
+          controller.view_context.tag.button "hello", id: 'custom_search'
+        end
+      end
+    end
+
+    it 'renders the search field and a button' do
+      expect(render.css("input[aria-label='#{I18n.t('blacklight.search.form.search.label')}']")).to be_present
+      expect(render.css("button#search")).not_to be_present
+      expect(render.css("button#custom_search")).to be_present
+    end
+  end
+
+  context 'with prepend' do
+    subject(:render) do
+      render_inline(instance) do |c|
+        c.with_prepend { 'stuff before' }
+      end
+    end
+
+    it 'renders the prepended value' do
+      expect(render.to_html).to include 'stuff before'
+    end
+  end
+
+  context 'with append' do
+    subject(:render) do
+      render_inline(instance) do |c|
+        c.with_append { 'stuff after' }
+      end
+    end
+
+    it 'renders the appended value' do
+      expect(render.to_html).to include 'stuff after'
+    end
+  end
+
+  context 'with extra inputs' do
+    subject(:render) do
+      render_inline(instance) do |c|
+        c.with_before_input_group { controller.view_context.tag.input name: 'foo' }
+        c.with_before_input_group { controller.view_context.tag.input name: 'bar' }
+      end
+    end
+
+    it 'renders the extra inputs' do
+      expect(render.css("input[name='foo']")).to be_present
+      expect(render.css("input[name='bar']")).to be_present
+    end
+  end
+end

data/spec/helpers/catalog_helper_spec.rb

@@ -243,7 +243,7 @@ RSpec.describe CatalogHelper do
     end
 
     it "calls thumbnail presenter with provided values" do
-      expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, suppress_link: true)
+      expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, { suppress_link: true })
       helper.render_thumbnail_tag document, {}, suppress_link: true
     end
   end

data/spec/models/blacklight/suggest_search_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Blacklight::SuggestSearch, api: true do
 
   describe '#suggestions' do
     it 'delegates to the repository' do
-      expect(repository).to receive(:suggestions).with(q: 'test').and_return(response)
+      expect(repository).to receive(:suggestions).with({ q: 'test' }).and_return(response)
       expect(suggest_search.suggestions).to eq response
     end
   end

data/spec/models/solr_document_spec.rb

@@ -29,6 +29,17 @@ RSpec.describe SolrDocument, api: true do
     end
   end
 
+  describe '.inspect' do
+    subject(:inspect) { document.inspect }
+
+    let(:document) do
+      described_class.new(id: '123',
+                          title_tesim: ['Good Omens'])
+    end
+
+    it { is_expected.to end_with "_source: {\"id\"=>\"123\", \"title_tesim\"=>[\"Good Omens\"]}>" }
+  end
+
   describe '.attribute' do
     subject(:title) { document.title }
 

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -60,4 +60,10 @@ RSpec.describe Blacklight::DocumentPresenter do
       expect(presenter.thumbnail).to be_a_kind_of custom_presenter_class
     end
   end
+
+  describe '#inspect' do
+    subject(:inspect) { presenter.inspect }
+
+    it { is_expected.to start_with '#<Blacklight::DocumentPresenter:' }
+  end
 end

data/spec/presenters/blacklight/facet_item_presenter_spec.rb

@@ -55,6 +55,13 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
     end
   end
 
+  describe '#constraint_label' do
+    it 'provides the label for the constraint' do
+      allow(facet_config).to receive_messages(query: nil, date: nil, helper_method: nil, url_method: nil)
+      expect(presenter.constraint_label).to eq presenter.label
+    end
+  end
+
   describe '#href' do
     before do
       allow(search_state).to receive(:has_facet?).and_return(false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.31.0
+  version: 7.32.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.43'
+        version: '2.66'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.43'
+        version: '2.66'
 - !ruby/object:Gem::Dependency
   name: hashdiff
   requirement: !ruby/object:Gem::Requirement
@@ -489,6 +489,7 @@ files:
 - app/components/blacklight/response/view_type_component.rb
 - app/components/blacklight/search_bar_component.html.erb
 - app/components/blacklight/search_bar_component.rb
+- app/components/blacklight/search_button_component.rb
 - app/components/blacklight/search_context_component.html.erb
 - app/components/blacklight/search_context_component.rb
 - app/components/blacklight/search_history_constraint_layout_component.rb
@@ -792,6 +793,7 @@ files:
 - spec/components/blacklight/hidden_search_state_component_spec.rb
 - spec/components/blacklight/metadata_field_component_spec.rb
 - spec/components/blacklight/response/spellcheck_component_spec.rb
+- spec/components/blacklight/search_bar_component_spec.rb
 - spec/components/blacklight/start_over_button_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
@@ -952,7 +954,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
@@ -973,6 +975,7 @@ test_files:
 - spec/components/blacklight/hidden_search_state_component_spec.rb
 - spec/components/blacklight/metadata_field_component_spec.rb
 - spec/components/blacklight/response/spellcheck_component_spec.rb
+- spec/components/blacklight/search_bar_component_spec.rb
 - spec/components/blacklight/start_over_button_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb