blacklight 7.34.0 → 8.0.0.beta1

data/app/javascript/blacklight/search_context.js

@@ -1,69 +1,59 @@
-Blacklight.doSearchContextBehavior = function() {
-  if (typeof Blacklight.do_search_context_behavior == 'function') {
-    console.warn("do_search_context_behavior is deprecated. Use doSearchContextBehavior instead.");
-    return Blacklight.do_search_context_behavior();
-  }
-
-  const elements = document.querySelectorAll('a[data-context-href]')
-  // Equivalent to Array.from(), but supports ie11
-  const nodes = Array.prototype.slice.call(elements)
-
-  nodes.forEach(function(element) {
-    element.addEventListener('click', function(e) {
-      Blacklight.handleSearchContextMethod.call(e.currentTarget, e)
+import Blacklight from './core'
+
+const SearchContext = (() => {
+  Blacklight.doSearchContextBehavior = function() {
+    document.addEventListener('click', (e) => {
+      if (e.target.matches('[data-context-href]')) {
+        Blacklight.handleSearchContextMethod.call(e.target, e)
+      }
     })
-  })
-};
+  };
 
-Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
-Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
+  Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
+  Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
 
-// this is the Rails.handleMethod with a couple adjustments, described inline:
-// first, we're attaching this directly to the event handler, so we can check for meta-keys
-Blacklight.handleSearchContextMethod = function(event) {
-  if (typeof Blacklight.handle_search_context_method == 'function') {
-    console.warn("handle_search_context_method is deprecated. Use handleSearchContextMethod instead.");
-    return Blacklight.handle_search_context_method(event);
-  }
-  var link = this
+  // this is the Rails.handleMethod with a couple adjustments, described inline:
+  // first, we're attaching this directly to the event handler, so we can check for meta-keys
+  Blacklight.handleSearchContextMethod = function(event) {
+    const link = this
 
-  // instead of using the normal href, we need to use the context href instead
-  let href = link.getAttribute('data-context-href')
-  let target = link.getAttribute('target')
-  let csrfToken = Blacklight.csrfToken()
-  let csrfParam = Blacklight.csrfParam()
-  let form = document.createElement('form')
-  form.method = 'post'
-  form.action = href
+    // instead of using the normal href, we need to use the context href instead
+    let href = link.getAttribute('data-context-href')
+    let target = link.getAttribute('target')
+    let csrfToken = Blacklight.csrfToken()
+    let csrfParam = Blacklight.csrfParam()
+    let form = document.createElement('form')
+    form.method = 'post'
+    form.action = href
 
 
-  let formContent = `<input name="_method" value="post" type="hidden" />
-    <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
+    let formContent = `<input name="_method" value="post" type="hidden" />
+      <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
 
-  // check for meta keys.. if set, we should open in a new tab
-  if(event.metaKey || event.ctrlKey) {
-    target = '_blank';
-  }
+    // check for meta keys.. if set, we should open in a new tab
+    if(event.metaKey || event.ctrlKey) {
+      target = '_blank';
+    }
 
-  if (csrfParam !== undefined && csrfToken !== undefined) {
-    formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
-  }
+    if (csrfParam !== undefined && csrfToken !== undefined) {
+      formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
+    }
 
-  // Must trigger submit by click on a button, else "submit" event handler won't work!
-  // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
-  formContent += '<input type="submit" />'
+    // Must trigger submit by click on a button, else "submit" event handler won't work!
+    // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
+    formContent += '<input type="submit" />'
 
-  if (target) { form.setAttribute('target', target); }
+    if (target) { form.setAttribute('target', target); }
 
-  form.style.display = 'none'
-  form.innerHTML = formContent
-  document.body.appendChild(form)
-  form.querySelector('[type="submit"]').click()
+    form.style.display = 'none'
+    form.innerHTML = formContent
+    document.body.appendChild(form)
+    form.querySelector('[type="submit"]').click()
 
-  event.preventDefault()
-  event.stopPropagation()
-};
+    event.preventDefault()
+  };
 
-Blacklight.onLoad(function() {
   Blacklight.doSearchContextBehavior();
-});
+})()
+
+export default SearchContext

data/app/models/blacklight/facet_paginator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   # Pagination for facet values -- works by setting the limit to max
   # displayable. You have to ask Solr for limit+1, to get enough
@@ -52,10 +53,10 @@ module Blacklight
 
     def current_page
       # A nil limit is unlimited, thus only one page.
-      if limit.nil? || limit.zero? #check for divide by zero
+      if limit.nil? || limit.zero? # check for divide by zero
         1
       else
-        @offset / limit + 1
+        (@offset / limit) + 1
       end
     end
 

data/app/models/blacklight/icon.rb

@@ -4,6 +4,8 @@ module Blacklight
   class Icon
     attr_reader :icon_name, :aria_hidden, :label, :role, :additional_options
 
+    delegate :present?, to: :file
+
     ##
     # @param [String, Symbol] icon_name
     # @param [String] classes additional classes separated by a string
@@ -32,7 +34,7 @@ module Blacklight
     end
 
     def icon_label
-      I18n.translate("blacklight.icon.#{icon_name_context}", default: icon_name.to_s.titleize)
+      I18n.t("blacklight.icon.#{icon_name_context}", default: icon_name.to_s.titleize)
     end
 
     ##
@@ -40,7 +42,7 @@ module Blacklight
     def options
       {
         class: classes,
-        "aria-hidden": (true if aria_hidden)
+        'aria-hidden': (true if aria_hidden)
       }
     end
 

data/app/models/bookmark.rb

@@ -4,8 +4,6 @@ class Bookmark < ApplicationRecord
   belongs_to :user, polymorphic: true
   belongs_to :document, polymorphic: true
 
-  validates :user_id, presence: true
-
   def document
     document_type.new document_type.unique_key => document_id
   end

data/app/models/concerns/blacklight/configurable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::Configurable
   extend ActiveSupport::Concern
 
@@ -6,7 +7,7 @@ module Blacklight::Configurable
     helper_method :blacklight_config if respond_to? :helper_method
   end
 
-  #instance methods for blacklight_config, so get a deep copy of the class-level config
+  # instance methods for blacklight_config, so get a deep copy of the class-level config
   def blacklight_config
     @blacklight_config ||= self.class.blacklight_config.deep_copy
   end
@@ -31,9 +32,9 @@ module Blacklight::Configurable
     end
     attr_writer :blacklight_config
 
-    #simply a convenience method for blacklight_config.configure
-    def configure_blacklight(*args, &block)
-      blacklight_config.configure(*args, &block)
+    # simply a convenience method for blacklight_config.configure
+    def configure_blacklight(...)
+      blacklight_config.configure(...)
     end
 
     ##

data/app/models/concerns/blacklight/document/active_model_shim.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_model/conversion'
 
 module Blacklight::Document

data/app/models/concerns/blacklight/document/cache_key.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This module provides the cache key which can be used by rails
 # caching to determine when to expire a particular object's cache
 # See http://apidock.com/rails/ActiveRecord/Integration/cache_key

data/app/models/concerns/blacklight/document/dublin_core.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'builder'
 
 # This module provide Dublin Core export based on the document's semantic values
@@ -26,7 +27,7 @@ module Blacklight::Document::DublinCore
              'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
              'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
              'xsi:schemaLocation' => %(http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd)) do
-      to_semantic_values.select { |field, _values| dublin_core_field_name? field  }.each do |field, values|
+      to_semantic_values.select { |field, _values| dublin_core_field_name? field }.each do |field, values|
         Array.wrap(values).each do |v|
           xml.tag! "dc:#{field}", v
         end

data/app/models/concerns/blacklight/document/email.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Email
   # Return a text string that will be the body of the email

data/app/models/concerns/blacklight/document/export.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # == Transformation conventions
 # The main use case for extensions is for transforming a Document to another
 # format. Either to another type of Ruby object, or to an exportable string in
@@ -55,7 +56,7 @@ module Blacklight::Document::Export
   # register it using Mime::Type.register_alias if it's not previously
   # registered. This is a bit sketchy though.
   def will_export_as(short_name, content_type = nil)
-    #Lookup in Rails Mime::Type, register if needed, otherwise take
+    # Lookup in Rails Mime::Type, register if needed, otherwise take
     # content-type from registration if needed.
     if defined?(Mime) && Mime[short_name.to_sym]
       content_type ||= Mime[short_name.to_sym]

data/app/models/concerns/blacklight/document/extensions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # = Document Extensions
 # An Blacklight::Document extension is simply a ruby module which is mixed
 # in to individual Document instances.  The intended use case is for documents

data/app/models/concerns/blacklight/document/schema_org.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::Document::SchemaOrg
   def itemtype
     "http://schema.org/Thing"

data/app/models/concerns/blacklight/document/semantic_fields.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::Document
   module SemanticFields
     extend ActiveSupport::Concern

data/app/models/concerns/blacklight/document/sms.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Sms
   # Return a text string that will be the body of the email

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   module Suggest
     class Response

data/app/models/concerns/blacklight/user.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
+
 module Blacklight::User
-  # This gives us an is_blacklight_user method that can be included in
-  # the containing applications models.
-  # SEE ALSO:  The /lib/blacklight/engine.rb class for how when this
-  # is injected into the hosting application through ActiveRecord::Base extend
-  def self.included(base)
-    return unless base.respond_to? :has_many
+  extend ActiveSupport::Concern
+  # SEE ALSO:  The lib/blacklight/generator/user_generator.rb class for where this
+  # is generated into the hosting application.
+  included do
+    class_attribute :string_display_key
 
-    base.send :has_many, :bookmarks, dependent: :destroy, as: :user
-    base.send :has_many, :searches,  dependent: :destroy, as: :user
+    has_many :bookmarks, dependent: :destroy, as: :user
+    has_many :searches,  dependent: :destroy, as: :user
   end
 
   def bookmarks_for_documents documents = []
@@ -28,4 +28,13 @@ module Blacklight::User
   def existing_bookmark_for(document)
     bookmarks_for_documents([document]).first
   end
+
+  ##
+  # @return [String] a user-displayable login/identifier for the user account
+  def to_s
+    string_display_key = self.class.string_display_key
+    return send(string_display_key) if respond_to?(string_display_key)
+
+    super
+  end
 end

data/app/models/record_mailer.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
+
 # Only works for documents with a #to_marc right now.
-class RecordMailer < ActionMailer::Base
+class RecordMailer < ApplicationMailer
   def email_record(documents, details, url_gen_params)
     title = begin
-              title_field = details[:config].email.title_field
-              if title_field
-                [documents.first[title_field]].flatten.first
-              else
-                documents.first.to_semantic_values[:title]
-              end
-            rescue
-              I18n.t('blacklight.email.text.default_title')
-            end
+      title_field = details[:config].email.title_field
+      if title_field
+        [documents.first[title_field]].flatten.first
+      else
+        documents.first.to_semantic_values[:title]
+      end
+    rescue
+      I18n.t('blacklight.email.text.default_title')
+    end
 
     subject = I18n.t('blacklight.email.text.subject',
                      count: documents.length,
@@ -22,7 +23,7 @@ class RecordMailer < ActionMailer::Base
     @config         = details[:config]
     @url_gen_params = url_gen_params
 
-    mail(to: details[:to],  subject: subject)
+    mail(to: details[:to], subject: subject)
   end
 
   def sms_record(documents, details, url_gen_params)
@@ -30,6 +31,6 @@ class RecordMailer < ActionMailer::Base
     @config         = details[:config]
     @url_gen_params = url_gen_params
 
-    mail(to: details[:to], subject: "")
+    mail(to: details[:to], subject: "") # rubocop:disable Rails/I18nLocaleTexts
   end
 end

data/app/models/search.rb

@@ -3,7 +3,6 @@
 class Search < ApplicationRecord
   belongs_to :user, optional: true
 
-  # use a backwards-compatible serializer until the Rails API stabilizes and we can evaluate for major-revision compatibility
   serialize :query_params, Blacklight::SearchParamsYamlCoder
 
   # A Search instance is considered a saved search if it has a user_id.

data/app/models/solr_document.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class SolrDocument
   include Blacklight::Solr::Document
 end

data/app/presenters/blacklight/clause_presenter.rb

@@ -29,7 +29,7 @@ module Blacklight
     end
 
     def remove_href(path = search_state)
-      view_context.search_action_path(path.reset_search(clause: path.clause_params.except(key)).to_h)
+      view_context.search_action_path(path.reset_search(clause: path.clause_params.except(key)))
     end
 
     private

data/app/presenters/blacklight/document_presenter.rb

@@ -79,10 +79,8 @@ module Blacklight
 
       fields += ['format'] if fields.empty? # backwards compatibility with the old default value for display_type_field
 
-      display_type = fields.lazy.map { |field| field_presenter(field_config(field)) }.detect(&:any?)&.values
-      display_type ||= Array(default) if default
-
-      display_type || []
+      display_type = fields.lazy.map { |field| field_presenter(display_fields[field] || Configuration::NullDisplayField.new(field)) }.detect(&:any?)&.values
+      display_type || Array(default)
     end
 
     ##
@@ -118,7 +116,7 @@ module Blacklight
     end
 
     def view_config
-      @view_config ||= show_view_config
+      show_view_config
     end
 
     def show_view_config
@@ -132,29 +130,23 @@ module Blacklight
 
     private
 
-    def render_field?(field_config)
-      field_presenter(field_config).render_field?
-    end
-    deprecation_deprecate render_field?: 'Use FieldPresenter#render_field?'
-
-    def has_value?(field_config)
-      field_presenter(field_config).any?
+    # @return [Hash<String,Configuration::Field>]
+    def fields
+      @fields ||= Array(display_type).inject(display_fields) do |fields, display_type|
+        fields.merge(display_fields(configuration.for_display_type(display_type)))
+      end
     end
-    deprecation_deprecate has_value?: 'Use FieldPresenter#any?'
 
-    def field_values(field_config, options = {})
-      field_value(field_config, options)
+    def display_fields(config = configuration)
+      config[view_config.document_fields_key || :index_fields]
     end
-    deprecation_deprecate field_values: 'Use #field_value'
 
-    def retrieve_values(field_config)
-      field_presenter(field_config).values
+    def field_config(field)
+      fields.fetch(field) { Configuration::NullDisplayField.new(field) }
     end
-    deprecation_deprecate retrieve_values: 'Use FieldPresenter#values'
 
     def field_presenter(field_config, options = {})
-      presenter_class = field_config.presenter || Blacklight::FieldPresenter
-      presenter_class.new(view_context, document, field_config, options.merge(field_presenter_options))
+      field_config.presenter.new(view_context, document, field_config, field_presenter_options.merge(options))
     end
 
     def field_presenter_options

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -15,15 +15,11 @@ module Blacklight
     end
 
     def collapsed?
-      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-        view_context.should_collapse_facet?(facet_field)
-      end
+      !active? && facet_field.collapse
     end
 
     def active?
-      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-        view_context.facet_field_in_params?(key)
-      end
+      search_state.filter(facet_field).any?
     end
 
     def in_modal?
@@ -44,20 +40,49 @@ module Blacklight
       search_state&.filter(facet_field)&.values || []
     end
 
-    # @private
-    # @deprecated
-    def html_id
-      Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-        view_context.facet_field_id(facet_field)
-      end
+    # Appease rubocop rules by implementing #each_value
+    def each_value(&block)
+      values.each(&block)
     end
 
     def paginator
       return unless display_facet
 
-      Deprecation.silence(Blacklight::Facet) do
-        @paginator ||= view_context.facet_paginator(facet_field, display_facet)
+      @paginator ||= blacklight_config.facet_paginator_class.new(
+        display_facet.items,
+        sort: display_facet.sort,
+        offset: display_facet.offset,
+        prefix: display_facet.prefix,
+        limit: facet_limit
+      )
+    end
+
+    DEFAULT_FACET_LIMIT = 10
+
+    # Look up facet limit for given facet_field. Will look at config, and
+    # if config is 'true' will look up from Solr @response if available. If
+    # no limit is available, returns nil. Used from #add_facetting_to_solr
+    # to supply f.fieldname.facet.limit values in solr request (no @response
+    # available), and used in display (with @response available) to create
+    # a facet paginator with the right limit.
+    def facet_limit
+      return unless facet_field.limit
+
+      if @display_facet
+        limit = @display_facet.limit
+
+        if limit.nil? # we didn't get or a set a limit, so infer one.
+          facet_field.limit if facet_field.limit != true
+        elsif limit == -1 # limit -1 is solr-speak for unlimited
+          nil
+        else
+          limit.to_i - 1 # we added 1 to find out if we needed to paginate
+        end
+      else
+        facet_field.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
       end
     end
+
+    delegate :blacklight_config, to: :search_state
   end
 end

data/app/presenters/blacklight/facet_grouped_item_presenter.rb

@@ -7,12 +7,8 @@ module Blacklight
     delegate :key, to: :facet_config
 
     def initialize(group, facet_item, facet_config, view_context, facet_field, search_state = view_context.search_state)
+      super(facet_item, facet_config, view_context, facet_field, 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
 
     ##

data/app/presenters/blacklight/facet_item_pivot_presenter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetItemPivotPresenter < FacetItemPresenter
+    ##
+    # Check if the query parameters have the given facet field with the
+    # given value.
+    def selected?
+      search_state.filter(facet_config).include?(facet_item)
+    end
+
+    def shown?
+      selected? || facet_item_presenters.any? { |x| x.try(:shown?) }
+    end
+
+    def field_label
+      facet_field_presenter.label
+    end
+
+    def facet_item_presenters
+      return to_enum(:facet_item_presenters) unless block_given?
+      return [] unless items
+
+      items.each { |i| yield facet_item_presenter(i) }
+    end
+
+    def facet_item_presenter(facet_item)
+      facet_config.item_presenter.new(facet_item, facet_config, view_context, facet_field, search_state)
+    end
+
+    ##
+    # Get the displayable version of a facet's value
+    #
+    # @return [String]
+    def label
+      label_source = facet_item.respond_to?(:label) ? facet_item.label : facet_item
+      if facet_config.helper_method
+        view_context.public_send(facet_config.helper_method, label_source)
+      else
+        item_fq = label_source.respond_to?(:fq) ? label_source.fq : {}
+        item_fq = item_fq.symbolize_keys
+        label_value = facet_config.pivot.map(&:to_sym).map { |k| item_fq[k] }
+        if label_source.respond_to?(:field)
+          label_value << value
+        else
+          label_value.unshift value
+        end
+        label_value.compact.join(" » ")
+      end
+    end
+
+    def value
+      if facet_item.respond_to? :value
+        facet_item.value
+      else
+        facet_item
+      end
+    end
+  end
+end

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -30,9 +30,7 @@ module Blacklight
     # Check if the query parameters have the given facet field with the
     # given value.
     def selected?
-      Deprecation.silence(Blacklight::SearchState) do
-        search_state.has_facet? facet_config, value: value
-      end
+      search_state.filter(facet_config).include?(value)
     end
 
     def field_label
@@ -44,8 +42,6 @@ module Blacklight
     #
     # @return [String]
     def label
-      return @view_context.facet_display_value(@facet_field, @facet_item) unless @view_context.method(:facet_display_value).owner == Blacklight::FacetsHelperBehavior
-
       label_value = if facet_item.respond_to? :label
                       facet_item.label
                     else
@@ -62,7 +58,7 @@ module Blacklight
         localization_options = facet_config.date == true ? {} : facet_config.date
         I18n.l(Time.zone.parse(label_value), **localization_options)
       else
-        label_value
+        label_value.to_s
       end
     end
 
@@ -92,9 +88,7 @@ module Blacklight
 
     # @private
     def remove_href(path = search_state)
-      Deprecation.silence(Blacklight::SearchState) do
-        view_context.search_action_path(path.remove_facet_params(facet_config.key, facet_item))
-      end
+      view_context.search_action_path(path.filter(facet_config.key).remove(facet_item))
     end
 
     # @private

data/app/presenters/blacklight/field_presenter.rb

@@ -30,6 +30,7 @@ module Blacklight
     end
 
     attr_reader :view_context, :document, :field_config, :except_operations, :options
+
     delegate :key, :component, to: :field_config
 
     # @return [String]