blacklight 7.10.0 → 7.11.1

data/app/components/blacklight/response/facet_group_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    class FacetGroupComponent < ::ViewComponent::Base
+      def initialize(response:, fields: [], title: nil, id: nil)
+        @response = response
+        @fields = fields
+        @title = title
+        @id = id ? "facets-#{id}" : 'facets'
+        @panel_id = id ? "facet-panel-#{id}-collapse" : 'facet-panel-collapse'
+      end
+
+      def render?
+        @view_context.has_facet_values?(@fields, @response)
+      end
+    end
+  end
+end

data/app/components/blacklight/response/pagination_component.html.erb

@@ -0,0 +1,3 @@
+<%= content_tag :nav, class: 'pagination', role: 'region', **@html_attr do %>
+  <%= pagination %>
+<% end %>

data/app/components/blacklight/response/pagination_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    class PaginationComponent < ::ViewComponent::Base
+      def initialize(response:, html: {}, **pagination_args)
+        @response = response
+        @html_attr = { aria: { label: t('views.pagination.aria.container_label') } }.merge(html)
+        @pagination_args = { outer_window: 2, theme: 'blacklight' }.merge(pagination_args)
+      end
+
+      def pagination
+        @view_context.paginate @response, **@pagination_args
+      end
+    end
+  end
+end

data/app/components/blacklight/response/sort_component.html.erb

@@ -0,0 +1,6 @@
+<%= render(Blacklight::System::DropdownComponent.new(
+      param: @param,
+      choices: @choices,
+      id: @id,
+      search_state: @search_state,
+      selected: @selected)) %>

data/app/components/blacklight/response/sort_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    class SortComponent < ViewComponent::Base
+      def initialize(param: 'sort', choices: {}, search_state:, id: 'sort-dropdown', classes: [], selected: nil)
+        @param = param
+        @choices = choices
+        @search_state = search_state
+        @id = id
+        @classes = classes
+        @selected = selected
+      end
+    end
+  end
+end

data/app/components/blacklight/response/spellcheck_component.html.erb

@@ -0,0 +1,7 @@
+<div id="spell">
+  <h3 class="suggest">
+    <em>
+      <%= t('blacklight.did_you_mean', options: safe_join(@options.map { |word| link_to_query(word) }, " #{t('blacklight.or')} ")).html_safe %>
+    </em>
+  </h3>
+</div>

data/app/components/blacklight/response/spellcheck_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    class SpellcheckComponent < ViewComponent::Base
+      def initialize(response:, options: nil)
+        @response = response
+        @options = options || @response&.spelling&.words
+      end
+
+      def link_to_query(query)
+        @view_context.link_to_query(query)
+      end
+
+      def render?
+        @options.any? && @view_context.should_show_spellcheck_suggestions?(@response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => t('blacklight.search.form.submit') do %>
+  <%= render_hash_as_hidden_fields(@params) %>
+  <% if @search_fields.length > 1 %>
+    <label for="search_field" class="sr-only"><%= t('blacklight.search.form.search_field.label') %></label>
+  <% end %>
+  <div class="input-group">
+    <% if @search_fields.length > 1 %>
+        <%= select_tag(:search_field,
+                       options_for_select(@search_fields, h(@search_field)),
+                       title: t('blacklight.search.form.search_field.title'),
+                       id: "#{@prefix}search_field",
+                       class: "custom-select search-field") %>
+    <% elsif @search_fields.length == 1 %>
+      <%= hidden_field_tag :search_field, @search_fields.first.last %>
+    <% end %>
+
+    <label for="<%= @prefix %>q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
+    <%= text_field_tag :q, @q, placeholder: t('blacklight.search.form.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 }  %>
+
+    <%= content %>
+
+    <span class="input-group-append">
+      <button type="submit" class="btn btn-primary search-btn" id="<%= @prefix %>search">
+        <span class="submit-search-text"><%= t('blacklight.search.form.submit') %></span>
+        <%= blacklight_icon :search, aria_hidden: true %>
+      </button>
+    </span>
+  </div>
+<% end %>

data/app/components/blacklight/search_bar_component.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchBarComponent < ::ViewComponent::Base
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(url:, params:, classes: ['search-query-form'], presenter: nil, prefix: '', method: 'GET', q: nil, search_field: nil, search_fields: [], autocomplete_path: nil, autofocus: nil)
+      @url = url
+      @q = q || params[:q]
+      @search_field = search_field || params[:search_field]
+      @params = params.except(:q, :search_field, :utf8, :page)
+      @prefix = prefix
+      @classes = classes
+      @presenter = presenter
+      @method = method
+      @autocomplete_path = autocomplete_path
+      @autofocus = autofocus
+      @search_fields = search_fields
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def autocomplete_path
+      return nil unless presenter.autocomplete_enabled?
+
+      @autocomplete_path
+    end
+
+    def autofocus
+      if @autofocus.nil?
+        presenter.autofocus?
+      else
+        @autofocus
+      end
+    end
+
+    private
+
+    def presenter
+      @presenter ||= blacklight_config.index.search_bar_presenter_class.new(controller, blacklight_config)
+    end
+
+    def blacklight_config
+      @view_context.blacklight_config
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+<div class='pagination-search-widgets'>
+
+  <div class="page-links">
+    <%= link_to_previous_document @search_context[:prev] %> |
+
+    <%= item_page_entry_info %> |
+
+    <%= link_to_next_document @search_context[:next] %>
+  </div>
+</div>

data/app/components/blacklight/search_context_component.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchContextComponent < ::ViewComponent::Base
+    with_collection_parameter :search_context
+
+    def initialize(search_context:, search_session:)
+      @search_context = search_context
+      @search_session = search_session
+    end
+
+    def render?
+      @search_context.present? && (@search_context[:prev] || @search_context[:next])
+    end
+
+    def item_page_entry_info
+      Deprecation.silence(Blacklight::CatalogHelperBehavior) do
+        @view_context.item_page_entry_info
+      end
+    end
+
+    def link_to_previous_document(*args)
+      @view_context.link_to_previous_document(*args)
+    end
+
+    def link_to_next_document(*args)
+      @view_context.link_to_next_document(*args)
+    end
+  end
+end

data/app/components/blacklight/system/dropdown_component.html.erb

@@ -0,0 +1,12 @@
+<%= content_tag :div, id: @id, class: @classes.join(' ') do %>
+  <button type="button" class="btn btn-outline-secondary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">
+    <%= t(:button_label_html, default: :label_html, scope: "blacklight.search.#{@param}", @interpolation => label_for_value(@selected)) %> <span class="caret"></span>
+  </button>
+
+  <div class="dropdown-menu" role="menu">
+    <%- @choices.each do |option| %>
+      <% text, value = option_text_and_value(option) %>
+      <%= link_to(text, url_for(@search_state.params_for_search(@param => value)), class: 'dropdown-item', role: 'menuitem') %>
+    <%- end -%>
+  </div>
+<% end %>

data/app/components/blacklight/system/dropdown_component.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module System
+    class DropdownComponent < ViewComponent::Base
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(param:, choices:, search_state:, id: nil, classes: [], default: nil, selected: nil, interpolation: :field)
+        @param = param
+        @choices = choices
+        @search_state = search_state
+        @id = id
+        @classes = classes.concat(['btn-group', "#{param.to_s.parameterize}-dropdown"])
+        @selected = selected || default || option_text_and_value(@choices.first)&.first
+        @interpolation = interpolation
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def render?
+        @choices.many?
+      end
+
+      # rubocop:disable Style/CaseEquality
+      # This method is from Rails to mirror how it handles native dropdowns
+      def option_text_and_value(option)
+        # Options are [text, value] pairs or strings used for both.
+        if !option.is_a?(String) && option.respond_to?(:first) && option.respond_to?(:last)
+          option = option.reject { |e| Hash === e } if Array === option
+          [option.first, option.last]
+        else
+          [option, option]
+        end
+      end
+      # rubocop:enable Style/CaseEquality
+
+      def label_for_value(value)
+        choice = @choices.find { |option| option_text_and_value(option).last == value }
+
+        choice && option_text_and_value(choice).first
+      end
+    end
+  end
+end

data/app/components/blacklight/system/modal_component.html.erb

@@ -0,0 +1,25 @@
+<div data-blacklight-modal="container">
+  <%= prefix %>
+
+  <div class="modal-header">
+    <%= header || (capture do %>
+      <h1 class="modal-title"><%= title %></h1>
+    <% end) %>
+
+    <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+      <span aria-hidden="true">&times;</span>
+    </button>
+  </div>
+
+  <%= body || (capture do %>
+    <div class="modal-body">
+      <%= content %>
+    </div>
+  <% end) %>
+
+  <% if footer.present? %>
+    <div class="modal-footer">
+      <%= footer %>
+    </div>
+  <% end %>
+</div>

data/app/components/blacklight/system/modal_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module System
+    class ModalComponent < ViewComponent::Base
+      with_content_areas :prefix, :header, :title, :body, :footer
+    end
+  end
+end

data/app/controllers/concerns/blacklight/catalog.rb

@@ -67,13 +67,14 @@ module Blacklight::Catalog
     search_session['counter'] = params[:counter]
     search_session['id'] = params[:search_id]
     search_session['per_page'] = params[:per_page]
+    search_session['document_id'] = params[:document_id]
 
     if params[:redirect] && (params[:redirect].starts_with?('/') || params[:redirect] =~ URI::DEFAULT_PARSER.make_regexp)
       uri = URI.parse(params[:redirect])
       path = uri.query ? "#{uri.path}?#{uri.query}" : uri.path
-      redirect_to path, status: 303
+      redirect_to path, status: :see_other
     else
-      redirect_to({ action: :show, id: params[:id] }, status: 303)
+      redirect_to({ action: :show, id: params[:id] }, status: :see_other)
     end
   end
 
@@ -184,7 +185,7 @@ module Blacklight::Catalog
   # @note Make sure your format has a well known mime-type or is registered in config/initializers/mime_types.rb
   # @example
   #   config.index.respond_to.txt = Proc.new { render plain: "A list of docs." }
-  def additional_response_formats format
+  def additional_response_formats(format)
     blacklight_config.index.respond_to.each do |key, config|
       format.send key do
         case config
@@ -214,7 +215,7 @@ module Blacklight::Catalog
 
   ##
   # Try to render a response from the document export formats available
-  def document_export_formats format
+  def document_export_formats(format)
     format.any do
       format_name = params.fetch(:format, '').to_sym
       if @response.export_formats.include? format_name

data/app/controllers/concerns/blacklight/default_component_configuration.rb

@@ -24,7 +24,7 @@ module Blacklight
 
     module ClassMethods
       # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
 
       # @!macro partial_if_unless
       #   @param name [String] the name of the document partial
@@ -41,7 +41,7 @@ module Blacklight
         blacklight_config.add_show_tools_partial(name, opts)
         ActionBuilder.new(self, name, opts).build
       end
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       deprecation_deprecate add_show_tools_partial: 'use blacklight_config.add_show_tools_partial instead'
 

data/app/controllers/concerns/blacklight/searchable.rb

@@ -1,4 +1,15 @@
 # frozen_string_literal: true
+
+# The Searchable module can be included onto classes that need to initialize a SearchService.
+# There are three dependencies you must provide on the including class. Typically these
+# would be provided by Blacklight::Controller
+#  1. search_state
+#  2. blacklight_config
+#  3. search_service_class
+#
+# Additionally, the including class may override the search_service_context method to provide
+# further context to the SearchService. For example you could override this to provide the
+# currently signed in user.
 module Blacklight::Searchable
   # @return [Blacklight::SearchService]
   def search_service

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 # Methods added to this helper will be available to all templates in the hosting application
 module Blacklight::BlacklightHelperBehavior
+  extend Deprecation
+
   include Blacklight::UrlHelperBehavior
   include Blacklight::HashAsHiddenFieldsHelperBehavior
   include Blacklight::LayoutHelperBehavior
@@ -148,9 +150,12 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
-    label = options[:label] || index_field_label(document, field)
+    label = Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+      options[:label] || index_field_label(document, field)
+    end
     html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: label)
   end
+  deprecation_deprecate render_index_field_label: 'Use Blacklight::MetadataFieldComponent instead'
 
   ##
   # Render the show field label for a document
@@ -170,10 +175,13 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
-    label = options[:label] || document_show_field_label(document, field)
+    label = Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+      options[:label] || document_show_field_label(document, field)
+    end
 
     t(:'blacklight.search.show.label', label: label)
   end
+  deprecation_deprecate render_document_show_field_label: 'Use Blacklight::MetadataFieldComponent instead'
 
   ##
   # Get the value of the document's "title" field, or a placeholder
@@ -252,8 +260,11 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # Should we render a grouped response (because the response
   # contains a grouped response instead of the normal response)
+  #
+  # Default to false if there's no response object available (sometimes the case
+  #   for tests, but might happen in other circumstances too..)
   def render_grouped_response? response = @response
-    response.grouped?
+    response&.grouped?
   end
 
   ##

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -103,6 +103,7 @@ module Blacklight::CatalogHelperBehavior
                                                        total: number_with_delimiter(search_session['total']),
                                                        count: search_session['total'].to_i).html_safe
   end
+  deprecation_deprecate item_page_entry_info: 'Use Blacklight::SearchContextComponent methods instead'
 
   ##
   # Look up search field user-displayable label

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -38,7 +38,7 @@ module Blacklight
     def render_index_doc_actions(document, options = {})
       wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
       rendered = render_filtered_partials(blacklight_config.view_config(document_index_view_type).document_actions, { document: document }.merge(options))
-      content_tag("div", rendered, class: wrapping_class) if rendered.present?
+      tag.div(rendered, class: wrapping_class) if rendered.present?
     end
 
     ##
@@ -51,7 +51,7 @@ module Blacklight
     def render_results_collection_tools(options = {})
       wrapping_class = options.delete(:wrapping_class) || "search-widgets"
       rendered = render_filtered_partials(blacklight_config.view_config(document_index_view_type).collection_actions, options)
-      content_tag("div", rendered, class: wrapping_class) if rendered.present?
+      tag.div(rendered, class: wrapping_class) if rendered.present?
     end
 
     ##