blacklight 7.14.1 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fa09c963759adb956f189243824f10d2c16ee518849c33ed0e6343240dec93
-  data.tar.gz: 61d5a9c3f582555de951e49a1912ad7a4feceb16f2635f1650eafa7a2200be39
+  metadata.gz: 8cb69c90e780b277faa807c99cf35b99d2ad0e04b68fd3c56f36a6c170eb8112
+  data.tar.gz: d5d7f85ff7af44d193e93a041a658a332a2d0ae31d9dd362f2000135e97ad54d
 SHA512:
-  metadata.gz: 9ed401d79a83ca244fd44f3d5ecc08e45a57ec69d76e84265dec12b450594e228906a3db51eb7d2c38560e5ed6a3d643c0ecf16eea9941eb0830cbc64f88294c
-  data.tar.gz: 90388ff2eab28a18cf4810769995b18143badd8c325b00ad075dbef243d5b3b074de5bb7442c65f6905f009485feca10452ff7b9c4d749b453e7b28da2a3a21d
+  metadata.gz: 9e8369e2769bb01b1388da32990b3a4868a14a9214ac070a6827871f5aa8a3659804cf0c11eb53b5f3d49a8f5925fafbd063be53977d1159cfa6f24954762771
+  data.tar.gz: 91046b20b9d00fc7cbe8a2f65f888e6a3e891fbf33230b203d0f4f7dc8d1a6d8317acdeec6d067f284bd47ecc51e469c0b6999a053816eec75fde5b7328b526a

data/VERSION

@@ -1 +1 @@
-7.14.1
+7.15.0

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

@@ -0,0 +1,46 @@
+<% if constraints.present? %>
+  <div class="constraints well search_history">
+    <h4><%= t 'blacklight.advanced_search.form.search_context' %></h4>
+    <%= constraints %>
+  </div>
+<% end %>
+
+<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => t('blacklight.search.form.submit') do %>
+  <%= render_hash_as_hidden_fields(@params) %>
+
+  <div class="input-criteria">
+    <div class="query-criteria">
+      <h2 class="query-criteria-heading">
+        <%= t('blacklight.advanced_search.form.query_criteria_heading_html', select_menu: default_operator_menu) %>
+      </h2>
+
+      <div id="advanced_search">
+        <%= search_field_controls %>
+      </div>
+    </div>
+
+    <div class="limit-criteria">
+      <h2 class="limit-criteria-heading"><%= t('blacklight.advanced_search.form.limit_criteria_heading_html')%></h2>
+
+      <div id="advanced_search_facets" class="limit_input">
+        <div class="advanced-facet-limits panel-group">
+          <%= search_filter_controls %>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <%= content_tag :h2, t('blacklight.advanced_search.form.sort_label') %>
+  <div class="form-group row">
+    <div class="col-sm-offset-3 col-sm-4">
+      <%= sort_fields_select %>
+    </div>
+  </div>
+
+  <div class="form-group row">
+    <div class="submit-buttons col-sm-offset-3 col-sm-9">
+      <%= submit_tag t('blacklight.advanced_search.form.search_btn_html'), class: 'btn btn-primary advanced-search-submit', id: "advanced-search-submit" %>
+      <%= button_tag t('blacklight.advanced_search.form.start_over_html'), type: 'reset', class: 'btn btn-link advanced-search-start-over' %>
+    </div>
+  </div>
+<% end %>

data/app/components/blacklight/advanced_search_form_component.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class AdvancedSearchFormComponent < SearchBarComponent
+    with_content_areas :constraints, :search_field_controls, :search_filter_controls
+
+    def initialize(response:, **options)
+      super(**options)
+      @response = response
+    end
+
+    def default_operator_menu
+      options_with_labels = [:must, :should].index_by { |op| t(op, scope: 'blacklight.advanced_search.op') }
+      select_tag(:op, options_for_select(options_with_labels, params[:op]), class: 'input-small')
+    end
+
+    # Rubocop is just wrong here, so...:
+    # rubocop:disable Rails/ContentTag
+    def search_field_controls
+      @search_field_controls || safe_join(search_fields.values.map.with_index do |field, i|
+        fields_for('clause[]', i, include_id: false) do |f|
+          content_tag(:div, class: 'form-group advanced-search-field row') do
+            f.label(:query, field.display_label('search'), class: "col-sm-3 col-form-label") +
+            content_tag(:div, class: 'col-sm-9') do
+              f.hidden_field(:field, value: field.key) +
+              f.text_field(:query, value: query_for_search_clause(field.key), class: 'form-control')
+            end
+          end
+        end
+      end, "\n")
+    end
+    # rubocop:enable Rails/ContentTag
+
+    def query_for_search_clause(key)
+      field = (@params[:clause] || {}).values.find { |value| value['field'].to_s == key.to_s }
+
+      field&.dig('query')
+    end
+
+    def search_filter_controls
+      return @search_filter_controls if @search_filter_controls
+
+      fields = blacklight_config.facet_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+
+      safe_join(fields.map do |_k, config|
+        display_facet = @response.aggregations[config.field]
+
+        presenter = (config.presenter || Blacklight::FacetFieldPresenter).new(config, display_facet, @view_context)
+        component = config.advanced_search_component || Blacklight::FacetFieldCheckboxesComponent
+        @view_context.render(component.new(facet_field: presenter))
+      end, "\n")
+    end
+
+    def constraints
+      params = @view_context.search_state.params_for_search.except :page, :f_inclusive, :q, :search_field, :op, :index, :sort
+
+      params.except!(*search_fields.map { |_key, field_def| field_def[:key] })
+
+      @view_context.render_search_to_s(params)
+    end
+
+    def sort_fields_select
+      options = sort_fields.values.map { |field_config| [@view_context.sort_field_label(field_config.key), field_config.key] }
+      select_tag(:sort, options_for_select(options, params[:sort]), class: "form-control sort-select")
+    end
+
+    def search_fields
+      blacklight_config.search_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+    end
+
+    def sort_fields
+      blacklight_config.sort_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+    end
+  end
+end

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

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

data/app/components/blacklight/constraints_component.rb

@@ -15,23 +15,25 @@ module Blacklight
     end
 
     def query_constraints
-      return if @search_state.query_param.blank?
-
       Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
-        @view_context.render(
-          @query_constraint_component.new(
-            search_state: @search_state,
-            value: @search_state.query_param,
-            label: label,
-            remove_path: @view_context.remove_constraint_url(@search_state),
-            classes: 'query'
+        if @search_state.query_param.present?
+          @view_context.render(
+            @query_constraint_component.new(
+              search_state: @search_state,
+              value: @search_state.query_param,
+              label: label,
+              remove_path: @view_context.remove_constraint_url(@search_state),
+              classes: 'query'
+            )
           )
-        )
-      end
+        else
+          ''.html_safe
+        end
+      end + @view_context.render(@facet_constraint_component.with_collection(clause_presenters.to_a))
     end
 
     def facet_constraints
-      @view_context.render(@facet_constraint_component.with_collection(facet_item_presenters))
+      @view_context.render(@facet_constraint_component.with_collection(facet_item_presenters.to_a))
     end
 
     def start_over_path
@@ -53,21 +55,38 @@ module Blacklight
     end
 
     def facet_item_presenters
-      Deprecation.silence(Blacklight::SearchState) do
-        @search_state.filter_params.each_pair.flat_map do |facet, values|
-          facet_config = @view_context.facet_configuration_for_field(facet)
+      return to_enum(:facet_item_presenters) unless block_given?
 
-          Array(values).map do |val|
+      Deprecation.silence(Blacklight::SearchState) do
+        @search_state.filters.map do |facet|
+          facet.values.map do |val|
             next if val.blank? # skip empty string
 
-            facet_item_presenter(facet_config, val, facet)
+            if val.is_a?(Array)
+              yield inclusive_facet_item_presenter(facet.config, val, facet.key) if val.any?(&:present?)
+            else
+              yield facet_item_presenter(facet.config, val, facet.key)
+            end
           end
         end
       end
     end
 
+    def clause_presenters
+      return to_enum(:clause_presenters) unless block_given?
+
+      @search_state.clause_params.each do |key, clause|
+        field_config = @view_context.blacklight_config.search_fields[clause[:field]]
+        yield Blacklight::ClausePresenter.new(key, clause, field_config, @view_context)
+      end
+    end
+
     def facet_item_presenter(facet_config, facet_item, facet_field)
       Blacklight::FacetItemPresenter.new(facet_item, facet_config, @view_context, facet_field)
     end
+
+    def inclusive_facet_item_presenter(facet_config, facet_item, facet_field)
+      Blacklight::InclusiveFacetItemPresenter.new(facet_item, facet_config, @view_context, facet_field)
+    end
   end
 end

data/app/components/blacklight/document/thumbnail_component.html.erb

@@ -1,4 +1,4 @@
-<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag({ alt: '' }, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render({ alt: '' }) %>
+<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag(@image_options, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render(@image_options) %>
 
 <% if value %>
   <div class="document-thumbnail">

data/app/components/blacklight/document/thumbnail_component.rb

@@ -7,9 +7,12 @@ module Blacklight
       with_collection_parameter :presenter
 
       # @param [Blacklight::DocumentPresenter] presenter
-      def initialize(presenter:, counter:)
+      # @param [Integer] counter
+      # @param [Hash] image_options options for the thumbnail presenter's image tag
+      def initialize(presenter:, counter:, image_options: {})
         @presenter = presenter
         @counter = counter
+        @image_options = { alt: '' }.merge(image_options)
         @use_thumbnail_tag = !@presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 

data/app/components/blacklight/document_component.rb

@@ -26,6 +26,7 @@ module Blacklight
                    id: nil, classes: [], component: :article, title_component: :h4,
                    metadata_component: Blacklight::DocumentMetadataComponent,
                    embed_component: nil,
+                   thumbnail_component: Blacklight::Document::ThumbnailComponent,
                    counter: nil, document_counter: nil, counter_offset: 0,
                    show: false)
       if presenter.nil? && document.nil?
@@ -42,6 +43,7 @@ module Blacklight
 
       @embed_component = embed_component
       @metadata_component = metadata_component
+      @thumbnail_component = thumbnail_component
 
       @document_counter = document_counter
       @counter = counter
@@ -83,11 +85,14 @@ module Blacklight
     end
 
     # Content for the document thumbnail area
-    def thumbnail
+    def thumbnail(image_options = {})
       return super if block_given?
+      return @thumbnail if @thumbnail
+
       return if @show
 
-      @thumbnail || render(Blacklight::Document::ThumbnailComponent.new(presenter: presenter, counter: @counter))
+      component = @thumbnail_component || presenter.view_config.thumbnail_component
+      render(component.new(presenter: presenter, counter: @counter, image_options: image_options))
     end
 
     # Content for the document metadata area

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_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/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/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/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/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