blacklight 7.13.2 → 7.15.2

data/app/components/blacklight/facet_field_checkboxes_component.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldCheckboxesComponent < ::ViewComponent::Base
+    def initialize(facet_field:, layout: nil)
+      @facet_field = facet_field
+      @layout = layout == false ? FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
+    end
+
+    def render?
+      presenters.any?
+    end
+
+    def presenters
+      return [] unless @facet_field.paginator
+
+      return to_enum(:presenters) unless block_given?
+
+      @facet_field.paginator.items.each do |item|
+        yield Blacklight::FacetItemPresenter.new(item, @facet_field.facet_field, @view_context, @facet_field.key, @facet_field.search_state)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+<div class="inclusive_or card card-body bg-light mb-3">
+  <h5><%= t('blacklight.advanced_search.any_of') %></h5>
+  <ul class="list-unstyled facet-values">
+    <%= @view_context.render(Blacklight::FacetItemComponent.with_collection(presenters.to_a)) %>
+  </ul>
+</div>

data/app/components/blacklight/facet_field_inclusive_constraint_component.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldInclusiveConstraintComponent < ::ViewComponent::Base
+    with_collection_parameter :facet_field
+
+    def initialize(facet_field:, values: nil)
+      @facet_field = facet_field
+      @values = values
+    end
+
+    def values
+      @values ||= @facet_field.values.find { |v| v.is_a? Array }
+      @values || []
+    end
+
+    def render?
+      values.present?
+    end
+
+    def presenters
+      return to_enum(:presenters) unless block_given?
+
+      values.each do |item|
+        yield Blacklight::FacetGroupedItemPresenter.new(values, item, @facet_field.facet_field, @view_context, @facet_field.key, @facet_field.search_state)
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
     <%= @facet_field.label %>
   <% end %>
   <% component.with(:body) do %>
+    <%= @view_context.render(Blacklight::FacetFieldInclusiveConstraintComponent.new(facet_field: @facet_field)) %>
     <ul class="facet-values list-unstyled">
       <%= render_facet_limit_list @facet_field.paginator, @facet_field.key %>
     </ul>

data/app/components/blacklight/facet_field_pagination_component.rb

@@ -7,7 +7,7 @@ module Blacklight
     end
 
     def sort_facet_url(sort)
-      @facet_field.paginator.params_for_resort_url(sort, @facet_fieldsearch_state.to_h)
+      @facet_field.paginator.params_for_resort_url(sort, @facet_field.search_state.to_h)
     end
 
     def param_name

data/app/components/blacklight/facet_item_component.rb

@@ -86,8 +86,8 @@ module Blacklight
         tag.span(@label, class: "selected") +
           # remove link
           link_to(@href, class: "remove") do
-            tag.span('✖', class: "remove-icon") +
-              tag.span('[remove]', class: 'sr-only')
+            tag.span('✖', class: "remove-icon", aria: { hidden: true }) +
+              tag.span(@view_context.t(:'blacklight.search.facets.selected.remove'), class: 'sr-only')
           end
       end + render_facet_count(classes: ["selected"])
     end
@@ -103,6 +103,8 @@ module Blacklight
     def render_facet_count(options = {})
       return @view_context.render_facet_count(@hits, options) unless @view_context.method(:render_facet_count).owner == Blacklight::FacetsHelperBehavior || explicit_component_configuration?
 
+      return '' if @hits.blank?
+
       classes = (options[:classes] || []) << "facet-count"
       tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(@hits)), class: classes)
     end

data/app/components/blacklight/hidden_search_state_component.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Writes out zero or more <input type="hidden"> elements, completely
+  # representing a hash passed in using Rails-style request parameters
+  # for hashes nested with arrays and other hashes.
+  class HiddenSearchStateComponent < ::ViewComponent::Base
+    # @param [Hash] hash
+    def initialize(params:)
+      Deprecation.warn(self, "Passing page as a parameter to HiddenSearchStateComponent is deprecated and will not be supported in Blacklight 8") if params.key?(:page)
+      @params = params.except(:utf8)
+    end
+
+    def call
+      hidden_fields = []
+      flatten_hash(@params).each do |name, value|
+        value = Array.wrap(value)
+        value.each do |v|
+          hidden_fields << hidden_field_tag(name, v.to_s, id: nil)
+        end
+      end
+
+      safe_join(hidden_fields, "\n")
+    end
+
+    private
+
+    def flatten_hash(hash = params, ancestor_names = [])
+      flat_hash = {}
+      hash.each do |k, v|
+        names = Array.new(ancestor_names)
+        names << k
+        if v.is_a?(Hash)
+          flat_hash.merge!(flatten_hash(v, names))
+        else
+          key = flat_hash_key(names)
+          key += "[]" if v.is_a?(Array)
+          flat_hash[key] = v
+        end
+      end
+
+      flat_hash
+    end
+
+    def flat_hash_key(names)
+      names = Array.new(names)
+      name = names.shift.to_s.dup
+      names.each do |n|
+        name << "[#{n}]"
+      end
+      name
+    end
+  end
+end

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

@@ -29,3 +29,7 @@
     </span>
   </div>
 <% end %>
+
+<% if presenter.advanced_search_enabled? %>
+  <%= link_to t('blacklight.advanced_search.more_options'), @advanced_search_url, class: 'advanced_search btn btn-secondary'%>
+<% end %>

data/app/components/blacklight/search_bar_component.rb

@@ -6,12 +6,14 @@ module Blacklight
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
-      url:, params:, classes: ['search-query-form'], presenter: nil,
-      prefix: '', method: 'GET', q: nil, query_param: :q,
+      url:, advanced_search_url: nil, params:,
+      classes: ['search-query-form'], presenter: nil, prefix: '',
+      method: 'GET', q: nil, query_param: :q,
       search_field: nil, search_fields: [], autocomplete_path: nil,
       autofocus: nil, i18n: { scope: 'blacklight.search.form' }
     )
       @url = url
+      @advanced_search_url = advanced_search_url
       @q = q || params[:q]
       @query_param = query_param
       @search_field = search_field || params[:search_field]

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

@@ -25,7 +25,7 @@ module Blacklight::Bookmarks
   def action_documents
     bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
-    search_service.fetch(bookmark_ids)
+    search_service.fetch(bookmark_ids, rows: bookmark_ids.count)
   end
 
   def action_success_redirect_path

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

@@ -56,6 +56,12 @@ module Blacklight::Catalog
     end
   end
 
+  def advanced_search
+    empty_service = search_service_class.new(config: blacklight_config, user_params: {}, **search_service_context)
+
+    (@response, _deprecated_document_list) = empty_service.search_results
+  end
+
   # get a single document from the index
   def raw
     raise(ActionController::RoutingError, 'Not Found') unless blacklight_config.raw_endpoint.enabled

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -10,7 +10,7 @@ module Blacklight
     deprecation_deprecate :document_action_label
 
     # @deprecated
-    def document_action_path action_opts, url_opts = nil
+    def document_action_path action_opts, url_opts = {}
       if action_opts.path
         send(action_opts.path, url_opts)
       elsif url_opts[:id].class.respond_to?(:model_name)

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -189,7 +189,7 @@ module Blacklight::ConfigurationHelperBehavior
 
     field = fields.first if document.nil?
     field ||= fields.find { |f| document.has? f }
-    field &&= field.try(:to_sym)
+    field &&= field&.to_sym
 
     field
   end
@@ -198,7 +198,7 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Default sort field
   def default_sort_field
-    (active_sort_fields.find { |_k, config| config.respond_to?(:default) && config.default } || active_sort_fields.first).try(:last)
+    (active_sort_fields.find { |_k, config| config.respond_to?(:default) && config.default } || active_sort_fields.first)&.last
   end
 
   ##

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -180,7 +180,7 @@ module Blacklight::FacetsHelperBehavior
   # @return [String]
   def facet_partial_name(display_facet = nil)
     config = facet_configuration_for_field(display_facet.name)
-    name = config.try(:partial)
+    name = config.partial
     name ||= "facet_pivot" if config.pivot
     name || "facet_limit"
   end

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -21,43 +21,7 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
   # @param [Hash] hash
   # @return [String]
   def render_hash_as_hidden_fields(hash)
-    hidden_fields = []
-    flatten_hash(hash).each do |name, value|
-      value = Array.wrap(value)
-      value.each do |v|
-        hidden_fields << hidden_field_tag(name, v.to_s, id: nil)
-      end
-    end
-
-    safe_join(hidden_fields, "\n")
-  end
-  deprecation_deprecate render_hash_as_hidden_fields: 'Moving to a private method of Blacklight::SearchBarComponent'
-
-  private
-
-  def flatten_hash(hash = params, ancestor_names = [])
-    flat_hash = {}
-    hash.each do |k, v|
-      names = Array.new(ancestor_names)
-      names << k
-      if v.is_a?(Hash)
-        flat_hash.merge!(flatten_hash(v, names))
-      else
-        key = flat_hash_key(names)
-        key += "[]" if v.is_a?(Array)
-        flat_hash[key] = v
-      end
-    end
-
-    flat_hash
-  end
-
-  def flat_hash_key(names)
-    names = Array.new(names)
-    name = names.shift.to_s.dup
-    names.each do |n|
-      name << "[#{n}]"
-    end
-    name
+    render Blacklight::HiddenSearchStateComponent.new(params: hash)
   end
+  deprecation_deprecate render_hash_as_hidden_fields: 'Use Blacklight::HiddenSearchStateComponent instead'
 end

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -12,7 +12,7 @@ module Blacklight::IconHelperBehavior
   def blacklight_icon(icon_name, options = {})
     Rails.cache.fetch([:blacklight_icons, icon_name, options]) do
       icon = Blacklight::Icon.new(icon_name, **options)
-      tag.span(icon.svg.html_safe, icon.options)
+      tag.span(icon.svg.html_safe, **icon.options)
     end
   end
 end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -88,8 +88,8 @@ module Blacklight::RenderConstraintsHelperBehavior
       return "".html_safe if search_state.filter_params.blank?
 
       Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
-        safe_join(search_state.filter_params.each_pair.map do |facet, values|
-          render_filter_element(facet, values, search_state)
+        safe_join(search_state.filters.map do |field|
+          render_filter_element(field.key, field.values, search_state)
         end, "\n")
       end
     end

data/app/javascript/blacklight/button_focus.js

@@ -1,6 +1,7 @@
 Blacklight.onLoad(function() {
   // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
   // Safari both do not set focus to a button on button click.
+  // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
   document.querySelectorAll('button.collapse-toggle').forEach((button) => {
     button.addEventListener('click', () => {
       event.target.focus();

data/app/javascript/blacklight/modal.js

@@ -101,12 +101,18 @@ Blacklight.modal.modalCloseSelector   = '[data-blacklight-modal~=close]';
 // Called on fatal failure of ajax load, function returns content
 // to show to user in modal.  Right now called only for extreme
 // network errors.
-Blacklight.modal.onFailure = function(data) {
-  var contents =  '<div class="modal-header">' +
-            '<div class="modal-title">Network Error</div>' +
+Blacklight.modal.onFailure = function(jqXHR, textStatus, errorThrown) {
+  console.error('Server error:', this.url, jqXHR.status, errorThrown);
+
+  var contents = '<div class="modal-header">' +
+            '<div class="modal-title">There was a problem with your request.</div>' +
             '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' +
             '  <span aria-hidden="true">&times;</span>' +
-            '</button>';
+            '</button></div>' +
+            ' <div class="modal-body"><p>Expected a successful response from the server, but got an error</p>' +
+            '<pre>' +
+            this.type + ' ' + this.url + "\n" + jqXHR.status + ': ' + errorThrown +
+            '</pre></div>';
   $(Blacklight.modal.modalSelector).find('.modal-content').html(contents);
   $(Blacklight.modal.modalSelector).modal('show');
 }

data/app/models/concerns/blacklight/suggest/response.rb

@@ -22,7 +22,7 @@ module Blacklight
       # present
       # @return [Array]
       def suggestions
-        (response.try(:[], suggest_path).try(:[], suggester_name).try(:[], request_params[:q]).try(:[], 'suggestions') || []).uniq
+        (response.dig(suggest_path, suggester_name, request_params[:q], 'suggestions') || []).uniq
       end
     end
   end

data/app/presenters/blacklight/clause_presenter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ClausePresenter
+    attr_reader :key, :user_parameters, :field_config, :view_context, :search_state
+
+    def initialize(key, user_parameters, field_config, view_context, search_state = view_context.search_state)
+      @key = key
+      @user_parameters = user_parameters
+      @field_config = field_config
+      @view_context = view_context
+      @search_state = search_state
+    end
+
+    def field_label
+      field_config.display_label('search')
+    end
+
+    ##
+    # Get the displayable version of a facet's value
+    #
+    # @return [String]
+    def label
+      user_parameters[:query]
+    end
+
+    def remove_href(path = search_state)
+      view_context.search_action_path(path.reset_search(clause: path.clause_params.except(key)))
+    end
+
+    private
+
+    def facet_field_presenter
+      @facet_field_presenter ||= view_context.facet_field_presenter(facet_config, {})
+    end
+  end
+end

data/app/presenters/blacklight/document_presenter.rb

@@ -97,8 +97,12 @@ module Blacklight
       field_presenter(field_config, options).render
     end
 
+    def thumbnail_presenter_class
+      view_config.thumbnail_presenter || thumbnail_presenter
+    end
+
     def thumbnail
-      @thumbnail ||= thumbnail_presenter.new(document, view_context, view_config)
+      @thumbnail ||= thumbnail_presenter_class.new(document, view_context, view_config)
     end
 
     ##

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -40,6 +40,10 @@ module Blacklight
       view_context.facet_field_label(key)
     end
 
+    def values
+      search_state&.filter(facet_field)&.values || []
+    end
+
     # @private
     # @deprecated
     def html_id

data/app/presenters/blacklight/facet_grouped_item_presenter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetGroupedItemPresenter < Blacklight::FacetItemPresenter
+    attr_reader :group
+
+    delegate :key, to: :facet_config
+
+    def initialize(group, facet_item, facet_config, view_context, facet_field, search_state = view_context.search_state)
+      @group = group
+      @facet_item = facet_item
+      @facet_config = facet_config
+      @view_context = view_context
+      @facet_field = facet_field
+      @search_state = search_state
+    end
+
+    ##
+    # Check if the query parameters have the given facet field with the
+    # given value.
+    def selected?
+      group.include?(facet_item)
+    end
+
+    # @private
+    def remove_href(path = search_state)
+      new_state = path.filter(facet_config).remove(group)
+      new_state = new_state.filter(facet_config).add(group - [facet_item])
+
+      view_context.search_action_path(new_state)
+    end
+
+    # @private
+    def add_href(_path_options = {})
+      if facet_config.url_method
+        return view_context.public_send(facet_config.url_method, facet_config.key, facet_item)
+      end
+
+      new_state = search_state.filter(facet_config).remove(@group)
+      new_state = new_state.filter(facet_config).add(@group + [facet_item])
+
+      view_context.search_action_path(new_state)
+    end
+  end
+end