blacklight 7.14.1 → 7.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fa09c963759adb956f189243824f10d2c16ee518849c33ed0e6343240dec93
-  data.tar.gz: 61d5a9c3f582555de951e49a1912ad7a4feceb16f2635f1650eafa7a2200be39
+  metadata.gz: 1e26542ca54e79594290b86c0506e4bc3a26a225d84e17537893381b4ad2c421
+  data.tar.gz: c812f19a30e663a1350888600307e7ba1b089b8794570eeadb38f89a6de57d27
 SHA512:
-  metadata.gz: 9ed401d79a83ca244fd44f3d5ecc08e45a57ec69d76e84265dec12b450594e228906a3db51eb7d2c38560e5ed6a3d643c0ecf16eea9941eb0830cbc64f88294c
-  data.tar.gz: 90388ff2eab28a18cf4810769995b18143badd8c325b00ad075dbef243d5b3b074de5bb7442c65f6905f009485feca10452ff7b9c4d749b453e7b28da2a3a21d
+  metadata.gz: 8f167c42362e5372a681777ce1cd1a72bf6ca9f5762098686bc6bb8872f59afd3f110312d15c1436320b511df272281ddb04be6cf9c10620535389aa87c91169
+  data.tar.gz: 9ae4c4178d7eff8eb4656d03353fe4fb2cd4f66e32fffdebd8645275f213b26aadd9c8204c2feba9f6479160ad925ba220ce6e1ec59bff42f9ca298dfd7cbb5c

data/.rubocop.yml

@@ -57,6 +57,7 @@ Naming/MethodParameterName:
   AllowedNames:
     - id
     - q
+    - as
 
 Naming/PredicateName:
   ForbiddenPrefixes:
@@ -122,3 +123,6 @@ Style/RedundantRegexpEscape:
 
 Style/SlicingWithRange:
   Enabled: true
+
+Rails/ContentTag:
+  Enabled: false

data/VERSION

@@ -1 +1 @@
-7.14.1
+7.17.0

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

@@ -14,8 +14,12 @@
 
 .btn.btn-icon {
   padding: $btn-padding-y;
-  
+
   &.btn-sm {
     padding: $btn-padding-y-sm;
   }
 }
+
+.remove-icon {
+  font-family: $remove-icon-font-family;
+}

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

@@ -5,3 +5,8 @@ $logo-image: image_url('blacklight/logo.png') !default;
 /* label (field names) */
 $field_name_color: $text-muted !default;
 $zindex-typeahead: $zindex-dropdown;
+
+// the default bootstrap font-family list includes "Segoe UI Emoji", which, on windows
+// renders our remove icon as an emoji-sized x instead of what we see on all other platforms...
+// so, for now (until we replace it with an SVG icon or something), we get to override bootstrap:
+$remove-icon-font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", "Liberation Sans", sans-serif !default;

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

@@ -0,0 +1,52 @@
+<% if constraints.present? %>
+  <div class="constraints well search_history">
+    <h4><%= t 'blacklight.advanced_search.form.search_context' %></h4>
+    <% constraints.each do |constraint| %>
+      <%= constraint %>
+    <% end %>
+  </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.each do |control| %>
+          <%= control %>
+        <% end %>
+      </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.each do |control| %>
+            <%= control %>
+          <% end %>
+        </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,88 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class AdvancedSearchFormComponent < SearchBarComponent
+    include Blacklight::ContentAreasShim
+
+    renders_many :constraints
+    renders_many :search_field_controls
+    renders_many :search_filter_controls, (lambda do |config:, display_facet:, presenter: nil, component: nil, **kwargs|
+      presenter ||= (config.presenter || Blacklight::FacetFieldPresenter).new(config, display_facet, @view_context)
+      component = component || config.advanced_search_component || Blacklight::FacetFieldCheckboxesComponent
+
+      component.new(facet_field: presenter, **kwargs)
+    end)
+
+    def initialize(response:, **options)
+      super(**options)
+      @response = response
+    end
+
+    def before_render
+      initialize_search_field_controls if search_field_controls.blank?
+      initialize_search_filter_controls if search_filter_controls.blank?
+      initialize_constraints if constraints.blank?
+    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
+
+    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
+
+    private
+
+    def initialize_search_field_controls
+      search_fields.values.each.with_index do |field, i|
+        search_field_control do
+          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
+      end
+    end
+
+    def initialize_search_filter_controls
+      fields = blacklight_config.facet_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+
+      fields.each do |_k, config|
+        display_facet = @response.aggregations[config.field]
+        search_filter_control(config: config, display_facet: display_facet)
+      end
+    end
+
+    def initialize_constraints
+      constraint do
+        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
+    end
+
+    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_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/constraint_layout_component.html.erb

@@ -9,7 +9,7 @@
   </span>
   <% if @remove_path.present? %>
     <%= link_to(@remove_path, class: 'btn btn-outline-secondary remove') do %>
-      <span class="remove-icon">✖</span>
+      <span class="remove-icon" aria-hidden="true">✖</span>
       <span class="sr-only">
         <%= if @label.blank?
             t('blacklight.search.filters.remove.value', value: @value)

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

@@ -4,7 +4,23 @@
   <%= link_to t('blacklight.search.start_over'), start_over_path, class: "catalog_startOverLink btn btn-primary" %>
 
   <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
-  <%= query_constraints_area || query_constraints %>
-  <%= facet_constraints_area || facet_constraints %>
-  <%= additional_constraints %>
+  <% if query_constraints_area.present? %>
+    <% query_constraints_area.each do |constraint| %>
+      <%= constraint %>
+    <% end %>
+  <% else %>
+    <%= query_constraints %>
+  <% end %>
+
+  <% if facet_constraints_area.present? %>
+    <% facet_constraints_area.each do |constraint| %>
+      <%= constraint %>
+    <% end %>
+  <% else %>
+    <%= facet_constraints %>
+  <% end %>
+
+  <% additional_constraints.each do |constraints| %>
+    <%= constraints %>
+  <% end %>
 <% end %>

data/app/components/blacklight/constraints_component.rb

@@ -2,7 +2,11 @@
 
 module Blacklight
   class ConstraintsComponent < ::ViewComponent::Base
-    with_content_areas :query_constraints_area, :facet_constraints_area, :additional_constraints
+    include Blacklight::ContentAreasShim
+
+    renders_many :query_constraints_area
+    renders_many :facet_constraints_area
+    renders_many :additional_constraints
 
     def initialize(search_state:,
                    id: 'appliedParams', classes: 'clearfix constraints-container',
@@ -15,23 +19,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 +59,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/content_areas_shim.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Shim to support ViewComponent v2 slots using the content_areas API for backwards compatibility
+  module ContentAreasShim
+    # Shim the `with` helper to write content into slots instead
+    def with(slot_name, *args, **kwargs, &block)
+      Deprecation.warn('ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
+      public_send(slot_name, *args, **kwargs, &block)
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
   <%= link_to label,
               url,
               id: @id,
-              class: 'nav-link',
+              class: @link_classes,
               data: {}.merge(({ blacklight_modal: "trigger" } if @action.modal != false) || {}) %>
 <% else %>
   <%= @view_context.render(partial: @action.partial || @action.name.to_s, locals: { document: @document, document_action_config: @action }.merge(@options)) %>

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

@@ -7,12 +7,13 @@ module Blacklight
       with_collection_parameter :action
 
       # @param [Blacklight::Document] document
-      def initialize(document:, action:, options: {}, url_opts: {}, id: nil)
+      def initialize(document:, action:, options: {}, url_opts: {}, id: nil, link_classes: 'nav-link')
         @document = document
         @action = action
         @options = options
         @url_opts = url_opts
         @id = id || @action.fetch(:id, "#{@action.name}Link")
+        @link_classes = link_classes
       end
 
       def using_default_document_action?
@@ -33,6 +34,10 @@ module Blacklight
           @view_context.document_action_path(@action, @url_opts.merge(({ id: @document } if @document) || {}))
         end
       end
+
+      def key
+        @action.key
+      end
     end
   end
 end

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

@@ -1,13 +1,11 @@
 <%= content_tag @tag, class: @classes do %>
-  <% @actions.each do |action| %>
-    <% result = capture { @view_context.render((action.component || Blacklight::Document::ActionComponent).new(action: action, document: @document, options: @options, url_opts: @url_opts)) } %>
-
+  <% actions.each do |action| %>
     <% if @wrapping_tag %>
       <%= content_tag(@wrapping_tag, class: Array(@wrapping_classes) + [action.key]) do %>
-        <%= result %>
+        <%= action %>
       <% end %>
     <% else %>
-      <%= result %>
+      <%= action %>
     <% end %>
   <% end %>
 <% end %>

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

@@ -4,9 +4,14 @@ module Blacklight
   module Document
     # Render a bookmark widget to bookmark / unbookmark a document
     class ActionsComponent < ::ViewComponent::Base
+      renders_many :actions, (lambda do |action:, component: nil, **kwargs|
+        component ||= action.component || Blacklight::Document::ActionComponent
+        component.new(action: action, document: @document, options: @options, url_opts: @url_opts, link_classes: @link_classes, **kwargs)
+      end)
+
       # @param [Blacklight::Document] document
       # rubocop:disable Metrics/ParameterLists
-      def initialize(document: nil, actions: [], options: {}, url_opts: nil, tag: :div, classes: 'index-document-functions', wrapping_tag: nil, wrapping_classes: nil)
+      def initialize(document: nil, actions: [], options: {}, url_opts: nil, tag: :div, classes: 'index-document-functions', wrapping_tag: nil, wrapping_classes: nil, link_classes: 'nav-link')
         @document = document
         @actions = actions
         @tag = tag
@@ -15,11 +20,20 @@ module Blacklight
         @url_opts = url_opts
         @wrapping_tag = wrapping_tag
         @wrapping_classes = wrapping_classes
+        @link_classes = link_classes
       end
       # rubocop:enable Metrics/ParameterLists
 
+      def before_render
+        return if actions.present?
+
+        @actions.each do |a|
+          action(component: a.component, action: a)
+        end
+      end
+
       def render?
-        @actions.any?
+        actions.present?
       end
     end
   end