blacklight 7.13.0 → 7.15.0

data/app/components/blacklight/document_metadata_component.rb

@@ -15,7 +15,7 @@ module Blacklight
     end
 
     def field_component(field)
-      field.try(:component) || Blacklight::MetadataFieldComponent
+      field&.component || Blacklight::MetadataFieldComponent
     end
   end
 end

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

@@ -0,0 +1,23 @@
+<%= render(@layout.new(facet_field: @facet_field)) do |component| %>
+  <% component.with(:label) do %>
+    <%= @facet_field.label %>
+  <% end %>
+
+  <% component.with(:body) do %>
+    <ul class="facet-values list-unstyled blacklight-facet-checkboxes">
+      <% presenters.each_with_index do |presenter, idx| -%>
+        <li>
+          <span class="facet-checkbox">
+            <%= check_box_tag "f_inclusive[#{@facet_field.key}][]", presenter.value, presenter.selected?, id: "f_inclusive_#{@facet_field.key}_#{idx}"%>
+          </span>
+
+          <span class="label-and-count">
+            <%= label_tag "f_inclusive_#{@facet_field.key}_#{idx}" do %>
+              <%= presenter.label %>
+            <% end %>
+          <span>
+        </li>
+      <% end -%>
+    </ul>
+  <% end %>
+<% end %>

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

@@ -1,9 +1,9 @@
 <div class="prev_next_links btn-group">
-  <%= link_to_previous_page @facet_field.paginator, raw(t('views.pagination.previous')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
+  <%= @view_context.link_to_previous_page @facet_field.paginator, raw(t('views.pagination.previous')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
     <%= content_tag :span, raw(t('views.pagination.previous')), class: 'disabled btn' %>
   <% end %>
 
-  <%= link_to_next_page @facet_field.paginator, raw(t('views.pagination.next')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
+  <%= @view_context.link_to_next_page @facet_field.paginator, raw(t('views.pagination.next')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
     <%= content_tag :span, raw(t('views.pagination.next')), class: 'disabled btn' %>
   <% end %>
 </div>
@@ -11,9 +11,9 @@
 <div class="sort-options btn-group">
   <% if @facet_field.paginator.sort == 'index' -%>
     <span class="active az btn btn-outline-secondary"><%= t('blacklight.search.facets.sort.index') %></span>
-    <%= link_to(t('blacklight.search.facets.sort.count'), sort_facet_url('count'), class: "sort_change numeric btn btn-outline-secondary", data: { blacklight_modal: "preserve" }) %>
+    <%= @view_context.link_to(t('blacklight.search.facets.sort.count'), sort_facet_url('count'), class: "sort_change numeric btn btn-outline-secondary", data: { blacklight_modal: "preserve" }) %>
   <% elsif @facet_field.paginator.sort == 'count' -%>
-    <%=  link_to(t('blacklight.search.facets.sort.index'), sort_facet_url('index'), class: "sort_change az btn btn-outline-secondary",  data: { blacklight_modal: "preserve" }) %>
+    <%= @view_context.link_to(t('blacklight.search.facets.sort.index'), sort_facet_url('index'), class: "sort_change az btn btn-outline-secondary",  data: { blacklight_modal: "preserve" }) %>
     <span class="active numeric btn btn-outline-secondary"><%= t('blacklight.search.facets.sort.count') %></span>
   <% end -%>
 </div>

data/app/components/blacklight/facet_field_pagination_component.rb

@@ -6,10 +6,6 @@ module Blacklight
       @facet_field = facet_field
     end
 
-    def render?
-      @facet_field.facet_field.index_range&.any?
-    end
-
     def sort_facet_url(sort)
       @facet_field.paginator.params_for_resort_url(sort, @facet_fieldsearch_state.to_h)
     end

data/app/components/blacklight/facet_item_component.rb

@@ -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

@@ -1,29 +1,35 @@
-<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => t('blacklight.search.form.submit') do %>
+<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => scoped_t('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>
+    <label for="search_field" class="sr-only"><%= scoped_t('search_field.label') %></label>
   <% end %>
   <div class="input-group">
+    <%= prepend %>
+
     <% 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'),
+                       title: scoped_t('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 %>
+    <label for="<%= @prefix %><%= @query_param %>" class="sr-only"><%= 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 }  %>
 
     <span class="input-group-append">
+      <%= append %>
+
       <button type="submit" class="btn btn-primary search-btn" id="<%= @prefix %>search">
-        <span class="submit-search-text"><%= t('blacklight.search.form.submit') %></span>
+        <span class="submit-search-text"><%= scoped_t('submit') %></span>
         <%= blacklight_icon :search, aria_hidden: true %>
       </button>
     </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

@@ -2,10 +2,20 @@
 
 module Blacklight
   class SearchBarComponent < ::ViewComponent::Base
+    with_content_areas :append, :prepend
+
     # 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)
+    def initialize(
+      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]
       @params = params.except(:q, :search_field, :utf8, :page)
       @prefix = prefix
@@ -15,6 +25,7 @@ module Blacklight
       @autocomplete_path = autocomplete_path
       @autofocus = autofocus
       @search_fields = search_fields
+      @i18n = i18n
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -47,5 +58,9 @@ module Blacklight
         @view_context.render_hash_as_hidden_fields(*args)
       end
     end
+
+    def scoped_t(key, **args)
+      t(key, default: t(key, scope: 'blacklight.search.form'), **@i18n, **args)
+    end
   end
 end

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
@@ -133,7 +139,7 @@ module Blacklight::Catalog
   # Check if any search parameters have been set
   # @return [Boolean]
   def has_search_parameters?
-    params[:q].present? || params[:f].present? || params[:search_field].present?
+    params[:search_field].present? || search_state.has_constraints?
   end
 
   # TODO: deprecate this constant with #facet_limit_for
@@ -316,11 +322,11 @@ module Blacklight::Catalog
     # If there are errors coming from the index page, we want to trap those sensibly
 
     if flash[:notice] == flash_notice
-      logger.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
+      logger&.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
       raise exception
     end
 
-    logger.error exception
+    logger&.error exception
 
     flash[:notice] = flash_notice
     redirect_to search_action_url

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

@@ -117,7 +117,7 @@ module Blacklight::SearchContext
       { prev: documents.first, next: documents.last }
     end
   rescue Blacklight::Exceptions::InvalidRequest => e
-    logger.warn "Unable to setup next and previous documents: #{e}"
+    logger&.warn "Unable to setup next and previous documents: #{e}"
     nil
   end
 end

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