blacklight 7.16.0 → 7.17.0

data/app/views/catalog/_citation.html.erb

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.tools.citation')) %>
+  <% component.title { t('blacklight.tools.citation') } %>
 
   <%= render Blacklight::Document::CitationComponent.with_collection(@documents) if @documents.present? %>
 <% end %>

data/app/views/catalog/_document.html.erb

@@ -1,6 +1,6 @@
 <% # container for a single doc -%>
-<%= render (blacklight_config.view_config(document_index_view_type).document_component || Blacklight::DocumentComponent).new(document: document, counter: document_counter_with_offset(document_counter)) do |component| %>
-  <% component.with(blacklight_config.view_config(document_index_view_type).document_component.blank? && blacklight_config.view_config(document_index_view_type).partials.any? ? :body : :partials) do %>
+<%= render (blacklight_config.view_config(document_index_view_type).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
+  <% component.public_send(blacklight_config.view_config(document_index_view_type).document_component.blank? && blacklight_config.view_config(document_index_view_type).partials.any? ? :body : :partial) do %>
     <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, component: component, document_counter: document_counter %>
   <% end %>
 <% end %>

data/app/views/catalog/_facet_layout.html.erb

@@ -1,8 +1,8 @@
 <%= render(Blacklight::FacetFieldComponent.new(facet_field: facet_field_presenter(facet_field, nil))) do |component| %>
-  <% component.with(:label) do %>
+  <% component.label do %>
     <%= facet_field_label(facet_field.key) %>
   <% end %>
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= yield %>
   <% end %>
 <% end %>

data/app/views/catalog/_show_main_content.html.erb

@@ -3,8 +3,8 @@
 <% @page_title = t('blacklight.search.show.title', document_title: Deprecation.silence(Blacklight::BlacklightHelperBehavior) { document_show_html_title }, application_name: application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>
 
-<%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(document: @document, component: :div, title_component: :h1, show: true) do |component| %>
-  <% component.with(:footer) do %>
+<%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), component: :div, title_component: :h1, show: true) do |component| %>
+  <% component.footer do %>
     <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
       <!--
            // COinS, for Zotero among others.
@@ -17,7 +17,7 @@
 
   <%# Use :body for complete backwards compatibility (overriding the component body markup),
         but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
-  <% component.with(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partials) do %>
+  <% component.public_send(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partial) do %>
     <div id="doc_<%= @document.id.to_s.parameterize %>">
       <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
     </div>

data/app/views/catalog/email.html.erb

@@ -1,7 +1,7 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.email.form.title')) %>
+  <% component.title { t('blacklight.email.form.title') } %>
 
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= render 'email_form' %>
   <% end %>
 <% end %>

data/app/views/catalog/email_success.html.erb

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.email.form.title')) %>
+  <% component.title { t('blacklight.email.form.title') } %>
 
   <%= render partial: '/shared/flash_msg' %>
   <span data-blacklight-modal="close"></span>

data/app/views/catalog/facet.html.erb

@@ -1,11 +1,11 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:prefix) do %>
+  <% component.prefix do %>
     <div class="facet-pagination top row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>
   <% end %>
 
-  <% component.with(:title, facet_field_label(@facet.key)) %>
+  <% component.title { facet_field_label(@facet.key) } %>
 
   <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
 
@@ -13,7 +13,7 @@
     <%= render_facet_limit(@display_facet, layout: false) %>
   </div>
 
-  <% component.with(:footer) do %>
+  <% component.footer do %>
     <div class="facet-pagination bottom row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>

data/app/views/catalog/sms.html.erb

@@ -1,7 +1,7 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.sms.form.title')) %>
+  <% component.title { t('blacklight.sms.form.title') } %>
 
-  <% component.with(:body) do %>
+  <% component.body do %>
     <%= render 'sms_form' %>
   <% end %>
 <% end %>

data/app/views/catalog/sms_success.html.erb

@@ -1,5 +1,5 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.with(:title, t('blacklight.sms.form.title')) %>
+  <% component.title { t('blacklight.sms.form.title') } %>
 
   <%= render partial: '/shared/flash_msg' %>
   <span data-blacklight-modal="close"></span>

data/blacklight.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency "deprecation"
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '>= 2.23.0'
+  s.add_dependency "view_component", '>= 2.28.0'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", "~> 4.0.0.beta2"

data/config/locales/blacklight.de.yml

@@ -3,7 +3,7 @@ de:
     pagination:
       first: '« Erste'
       last: 'Letzte »'
-      previous: '« Voherige'
+      previous: '« Vorherige'
       next: 'Nächste »'
       truncate: '…'
       aria:
@@ -16,7 +16,7 @@ de:
         go_to_previous_page: Zurück zur letzten Seite
 
     pagination_compact:
-      previous: '« Voherige'
+      previous: '« Vorherige'
       next: 'Nächste »'
 
   blacklight:

data/lib/blacklight/engine.rb

@@ -8,7 +8,9 @@ module Blacklight
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer 'blacklight.helpers' do
-      ActionView::Base.include BlacklightHelper
+      config.after_initialize do
+        ActionView::Base.include BlacklightHelper
+      end
     end
 
     # This makes our rake tasks visible.

data/lib/blacklight/solr/facet_paginator.rb

@@ -20,6 +20,8 @@ module Blacklight::Solr
     def initialize(all_facet_values, arguments = {})
       super
 
+      @sort = arguments[:sort].keys.first.to_s if arguments[:sort].is_a? Hash
+
       # count is solr's default
       @sort ||= if @limit.to_i > 0
                   'count'

data/lib/blacklight/solr/request.rb

@@ -17,6 +17,37 @@ class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
     end
   end
 
+  def append_query(query)
+    if self['q'] || dig(:json, :query, :bool)
+      self[:json] ||= { query: { bool: { must: [] } } }
+      self[:json][:query] ||= { bool: { must: [] } }
+      self[:json][:query][:bool][:must] << query
+
+      if self['q']
+        self[:json][:query][:bool][:must] << self['q']
+        delete 'q'
+      end
+    else
+      self['q'] = query
+    end
+  end
+
+  def append_boolean_query(bool_operator, query)
+    return if query.blank?
+
+    self[:json] ||= { query: { bool: { bool_operator => [] } } }
+    self[:json][:query] ||= { bool: { bool_operator => [] } }
+    self[:json][:query][:bool][bool_operator] ||= []
+
+    if self['q']
+      self[:json][:query][:bool][:must] ||= []
+      self[:json][:query][:bool][:must] << self['q']
+      delete 'q'
+    end
+
+    self[:json][:query][:bool][bool_operator] << query
+  end
+
   def append_filter_query(query)
     self['fq'] << query
   end

data/lib/blacklight/solr/response.rb

@@ -9,6 +9,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
     autoload :MoreLikeThis
     autoload :GroupResponse
     autoload :Group
+    autoload :Params
   end
 
   include PaginationMethods
@@ -16,6 +17,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
   include Facets
   include Response
   include MoreLikeThis
+  include Params
 
   attr_reader :request_params
   attr_accessor :blacklight_config, :options
@@ -33,22 +35,6 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
     self['responseHeader'] || {}
   end
 
-  def params
-    header['params'] || request_params
-  end
-
-  def start
-    params[:start].to_i
-  end
-
-  def rows
-    params[:rows].to_i
-  end
-
-  def sort
-    params[:sort]
-  end
-
   def documents
     @documents ||= (response['docs'] || []).collect { |doc| document_factory.build(doc, self, options) }
   end

data/lib/blacklight/solr/response/facets.rb

@@ -29,6 +29,7 @@ module Blacklight::Solr::Response::Facets
   # represents a facet; which is a field and its values
   class FacetField
     attr_reader :name, :items
+    attr_accessor :missing
 
     def initialize name, items, options = {}
       @name = name
@@ -52,6 +53,14 @@ module Blacklight::Solr::Response::Facets
       @options[:prefix] || solr_default_prefix
     end
 
+    def type
+      @options[:type] || 'terms'
+    end
+
+    def data
+      @options[:data] || {}
+    end
+
     def index?
       sort == 'index'
     end
@@ -90,7 +99,7 @@ module Blacklight::Solr::Response::Facets
   # Get all the Solr facet data (fields, queries, pivots) as a hash keyed by
   # both the Solr field name and/or by the blacklight field name
   def aggregations
-    @aggregations ||= {}.merge(facet_field_aggregations).merge(facet_query_aggregations).merge(facet_pivot_aggregations)
+    @aggregations ||= {}.merge(facet_field_aggregations).merge(facet_query_aggregations).merge(facet_pivot_aggregations).merge(json_facet_aggregations)
   end
 
   def facet_counts
@@ -159,19 +168,24 @@ module Blacklight::Solr::Response::Facets
       items = values.map do |value, hits|
         i = FacetItem.new(value: value, hits: hits)
 
-        # solr facet.missing serialization
+        # legacy solr facet.missing serialization
         if value.nil?
           i.label = I18n.t(:"blacklight.search.fields.facet.missing.#{facet_field_name}", default: [:"blacklight.search.facets.missing"])
           i.fq = "-#{facet_field_name}:[* TO *]"
+          i.missing = true
         end
 
         i
       end
 
       options = facet_field_aggregation_options(facet_field_name)
-      hash[facet_field_name] = FacetField.new(facet_field_name,
-                                              items,
-                                              options)
+      facet_field = FacetField.new(facet_field_name, items, options)
+
+      if values[nil]
+        facet_field.missing = items.find(&:missing)
+      end
+
+      hash[facet_field_name] = facet_field
 
       # alias all the possible blacklight config names..
       blacklight_config.facet_fields.select { |_k, v| v.field == facet_field_name }.each_key do |key|
@@ -180,23 +194,6 @@ module Blacklight::Solr::Response::Facets
     end
   end
 
-  def facet_field_aggregation_options(facet_field_name)
-    options = {}
-    options[:sort] = (params[:"f.#{facet_field_name}.facet.sort"] || params[:'facet.sort'])
-    if params[:"f.#{facet_field_name}.facet.limit"] || params[:"facet.limit"]
-      options[:limit] = (params[:"f.#{facet_field_name}.facet.limit"] || params[:"facet.limit"]).to_i
-    end
-
-    if params[:"f.#{facet_field_name}.facet.offset"] || params[:'facet.offset']
-      options[:offset] = (params[:"f.#{facet_field_name}.facet.offset"] || params[:'facet.offset']).to_i
-    end
-
-    if params[:"f.#{facet_field_name}.facet.prefix"] || params[:'facet.prefix']
-      options[:prefix] = (params[:"f.#{facet_field_name}.facet.prefix"] || params[:'facet.prefix'])
-    end
-    options
-  end
-
   ##
   # Aggregate Solr's facet_query response into the virtual facet fields defined
   # in the blacklight configuration
@@ -211,12 +208,28 @@ module Blacklight::Solr::Response::Facets
         Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
       end
 
+      items += facet_query_aggregations_from_json(facet_field)
+
       items = items.sort_by(&:hits).reverse if facet_field.sort && facet_field.sort.to_sym == :count
 
       hash[field_name] = Blacklight::Solr::Response::Facets::FacetField.new field_name, items
     end
   end
 
+  def facet_query_aggregations_from_json(facet_field)
+    return [] unless self['facets']
+
+    salient_facet_queries = facet_field.query.map { |_k, x| x[:fq] }
+
+    relevant_facet_data = self['facets'].select { |k, _v| salient_facet_queries.include?(k) }.reject { |_key, data| data['count'].zero? }
+
+    relevant_facet_data.map do |key, data|
+      salient_fields = facet_field.query.select { |_key, val| val[:fq] == key }
+      facet_key = ((salient_fields.keys if salient_fields.respond_to? :keys) || salient_fields.first).first
+      Blacklight::Solr::Response::Facets::FacetItem.new(value: facet_key, hits: data[:count], label: facet_field.query[facet_key][:label])
+    end
+  end
+
   ##
   # Convert Solr's facet_pivot response into
   # a hash of Blacklight::Solr::Response::Facet::FacetField objects
@@ -244,4 +257,45 @@ module Blacklight::Solr::Response::Facets
 
     Blacklight::Solr::Response::Facets::FacetItem.new(value: lst[:value], hits: lst[:count], field: lst[:field], items: items, fq: parent_fq)
   end
+
+  def construct_json_nested_facet_fields(bucket, parent_fq = {})
+    bucket.select { |_, nested| nested.is_a?(Hash) && nested.key?('buckets') }.map do |facet_field_name, nested|
+      nested['buckets'].map do |subbucket|
+        i = Blacklight::Solr::Response::Facets::FacetItem.new(field: facet_field_name, value: subbucket['val'], hits: subbucket['count'], fq: parent_fq, data: subbucket)
+
+        i.items = construct_json_nested_facet_fields(subbucket, parent_fq.merge(key => subbucket['val'])) if has_json_nested_facets?(subbucket)
+        i
+      end
+    end.flatten
+  end
+
+  def has_json_nested_facets?(bucket)
+    bucket.any? { |_, nested| nested.is_a?(Hash) && nested.key?('buckets') }
+  end
+
+  def json_facet_aggregations
+    return {} unless self['facets']
+
+    self['facets'].each_with_object({}) do |(facet_field_name, data), hash|
+      next if facet_field_name == 'count'
+
+      items = (data['buckets'] || []).map do |bucket|
+        i = Blacklight::Solr::Response::Facets::FacetItem.new(value: bucket['val'], hits: bucket['count'], data: bucket)
+
+        i.items = construct_json_nested_facet_fields(bucket, facet_field_name => bucket['val']) if has_json_nested_facets?(bucket)
+
+        i
+      end
+
+      options = facet_field_aggregation_options(facet_field_name).merge(data: data)
+      facet_field = FacetField.new(facet_field_name, items, options)
+
+      facet_field.missing = Blacklight::Solr::Response::Facets::FacetItem.new(
+        hits: data.dig('missing', 'count'),
+        data: data['missing']
+      ) if data['missing']
+
+      hash[facet_field_name] = facet_field
+    end
+  end
 end

data/lib/blacklight/solr/response/params.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+module Blacklight::Solr::Response::Params
+  # From https://solr.apache.org/guide/8_8/json-request-api.html#supported-properties-and-syntax
+  QUERY_PARAMETER_TO_JSON_PARAMETER_MAPPING = {
+    q: :query,
+    fq: :filter,
+    start: :offset,
+    rows: :limit,
+    fl: :fields,
+    sort: :sort
+  }.freeze
+
+  def params
+    header['params'] || request_params
+  end
+
+  def start
+    search_builder&.start || single_valued_param(:start).to_i
+  end
+
+  def rows
+    search_builder&.rows || single_valued_param(:rows).to_i
+  end
+
+  def sort
+    search_builder&.sort || single_valued_param(:sort)
+  end
+
+  def facet_field_aggregation_options(facet_field_name)
+    defaults = {
+      sort: single_valued_param(:'facet.sort'),
+      limit: single_valued_param(:"facet.limit")&.to_i || 100,
+      offset: single_valued_param(:"facet.offset")&.to_i || 0,
+      prefix: single_valued_param(:"facet.prefix")
+    }
+
+    json_facet = json_params.dig('facet', facet_field_name)&.slice(:limit, :offset, :prefix, :sort)&.symbolize_keys || {}
+
+    param_facet = {
+      sort: single_valued_param(:"f.#{facet_field_name}.facet.sort"),
+      limit: single_valued_param(:"f.#{facet_field_name}.facet.limit")&.to_i,
+      offset: single_valued_param(:"f.#{facet_field_name}.facet.offset")&.to_i,
+      prefix: single_valued_param(:"f.#{facet_field_name}.facet.prefix")
+    }.reject { |_k, v| v.nil? }
+
+    options = defaults.merge(json_facet).merge(param_facet)
+    options[:sort] ||= options[:limit].positive? ? 'count' : 'index'
+
+    options
+  end
+
+  private
+
+  def search_builder
+    request_params if request_params.is_a?(Blacklight::SearchBuilder)
+  end
+
+  # Extract JSON Request API parameters from the response header or the request itself
+  def json_params
+    encoded_json_params = header&.dig('params', 'json')
+
+    return request_params['json'] || {} if encoded_json_params.blank?
+
+    @json_params ||= JSON.parse(encoded_json_params).with_indifferent_access
+  end
+
+  # Handle merging solr parameters from the myriad of ways they may be expressed by applying the single-value
+  # precedence logic:
+  #
+  # From https://solr.apache.org/guide/8_8/json-request-api.html#json-parameter-merging :
+  # When multiple parameter values conflict with one another a single value is chosen based on the following precedence rules:
+  # - Traditional query parameters (q, rows, etc.) take first precedence and are used over any other specified values.
+  # - json-prefixed query parameters are considered next.
+  # - Values specified in the JSON request body have the lowest precedence and are only used if specified nowhere else.
+  #
+  # @param [String] key the solr parameter to use
+  def single_valued_param(key)
+    json_key = QUERY_PARAMETER_TO_JSON_PARAMETER_MAPPING[key]
+
+    params[key] ||
+      params["json.#{key}"] ||
+      json_params[json_key || key] ||
+      json_params.dig(:params, key) ||
+      json_params.dig(:params, "json.#{key}")
+  end
+
+  # Merge together multi-valued solr parameters from the myriad of ways they may be expressed.
+  # Unlike single-valued parameters, this merges all the values across the params.
+  #
+  # @param [String] key the solr parameter to use
+  def multivalued_param(key)
+    json_key = QUERY_PARAMETER_TO_JSON_PARAMETER_MAPPING[key]
+
+    [
+      params[key],
+      params["json.#{key}"],
+      json_params[json_key || key],
+      json_params.dig(:params, key),
+      json_params.dig(:params, "json.#{key}")
+    ].select(&:present?).inject([]) do |memo, arr|
+      memo.concat(Array.wrap(arr))
+    end
+  end
+end