blacklight 7.40.0 → 8.0.0.beta1

data/app/javascript/blacklight/modalForm.js

@@ -0,0 +1,60 @@
+// The email and sms forms are displayed inside a modal.  When the form is submitted,
+// this script closes the modal and puts the output on the main part of the page.
+// By default it is rendering catalog/sms_success and catalog/email_succcess.
+// These templates deliver a payload of the format used by turbo-streams.
+// See https://turbo.hotwired.dev/handbook/streams
+// That format allows a downstream application to override the template to define
+// multiple customizable areas of the page to get updated.
+export default class {
+    constructor(errorHandler, badRequestHandler, hideModal) {
+      this.errorHandler = errorHandler
+      this.badRequestHandler = badRequestHandler
+      this.hideModal = hideModal
+    }
+
+    get triggerFormSelector() {
+      return 'form[data-blacklight-modal~=trigger]'
+    }
+
+    bind() {
+      document.addEventListener('submit', (e) => {
+         if (e.target.matches(this.triggerFormSelector))
+          this.onSubmit(e)
+      })
+    }
+
+    // This is like a light-weight version of turbo that only supports append presently.
+    updateTurboStream(data) {
+        this.hideModal()
+        const domparser = new DOMParser();
+        const dom = domparser.parseFromString(data, "text/html")
+        dom.querySelectorAll("turbo-stream[action='append']").forEach((node) => {
+          const target = node.getAttribute('target')
+          const element = document.getElementById(target)
+          if (element)
+            element.append(node.querySelector('template').content.cloneNode(true))
+          else
+            console.error(`Unable to find an element on the page with and ID of "${target}""`)
+        })
+    }
+
+    onSubmit(e) {
+        e.preventDefault();
+        const form = e.target
+        fetch(form.action, {
+            body: new FormData(form),
+            headers: { "X-Requested-With": "XMLHttpRequest" }, // Ensures rails will return true when checking request.xhr?
+            method: form.method,
+          })
+          .then(response => {
+             if (response.status === 422) {
+               return response.text().then(content => this.badRequestHandler(content) )
+             }
+             if (!response.ok) {
+               throw new TypeError("Request failed");
+             }
+             response.text().then(content => this.updateTurboStream(content))
+           })
+          .catch(error => this.errorHandler(error))
+    }
+}

data/app/javascript/blacklight/search_context.js

@@ -1,67 +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)
+      }
     })
-  })
-};
+  };
 
-// 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
+  Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
+  Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
 
-  // 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
+  // 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
 
-  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) {
-    form.dataset.turbo = "false";
-    target = '_blank';
-  }
+    let formContent = `<input name="_method" value="post" type="hidden" />
+      <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
 
-  if (csrfParam !== undefined && csrfToken !== undefined) {
-    formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
-  }
+    // check for meta keys.. if set, we should open in a new tab
+    if(event.metaKey || event.ctrlKey) {
+      target = '_blank';
+    }
 
-  // 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 (csrfParam !== undefined && csrfToken !== undefined) {
+      formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
+    }
 
-  if (target) { form.setAttribute('target', target); }
+    // 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" />'
 
-  form.style.display = 'none'
-  form.innerHTML = formContent
-  document.body.appendChild(form)
-  form.querySelector('[type="submit"]').click()
+    if (target) { form.setAttribute('target', target); }
 
-  event.preventDefault()
-  event.stopPropagation()
-};
+    form.style.display = 'none'
+    form.innerHTML = formContent
+    document.body.appendChild(form)
+    form.querySelector('[type="submit"]').click()
+
+    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
@@ -28,16 +29,6 @@ module Blacklight::Document
       def find id
         repository.find(id).documents.first
       end
-
-      # In Rails 7.1+, needs this method
-      def composite_primary_key?
-        false
-      end
-
-      # In Rails 7.1+, needs this method
-      def has_query_constraints?
-        false
-      end
     end
 
     ##

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
@@ -30,7 +31,7 @@ module Blacklight::Document
     # but extensions should call super and modify hash returned, to avoid
     # unintentionally erasing values provided by other extensions.
     def to_semantic_values
-      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |(key, field_names), hash|
+      @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_names), hash|
         ##
         # Handles single string field_name or an array of field_names
         value = Array.wrap(field_names).map { |field_name| self[field_name] }.flatten.compact

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,13 +3,7 @@
 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
-  if ::Rails.version.to_f >= 7.1
-    # non-deprecated coder: keyword arg for Rails 7.1+
-    serialize :query_params, coder: Blacklight::SearchParamsYamlCoder
-  else
-    serialize :query_params, Blacklight::SearchParamsYamlCoder
-  end
+  serialize :query_params, Blacklight::SearchParamsYamlCoder
 
   # A Search instance is considered a saved search if it has a user_id.
   def saved?

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

@@ -11,26 +11,18 @@ module Blacklight
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
-    def initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {})
+    def initialize(document, view_context, configuration = view_context.blacklight_config)
       @document = document
       @view_context = view_context
       @configuration = configuration
-      @view_config = view_config
-      @field_presenter_options = field_presenter_options
     end
 
     # @return [Hash<String,Configuration::Field>]  all the fields for this index view that should be rendered
-    def fields_to_render(document_fields = fields, **kwargs)
-      unless block_given?
-        return to_enum(:fields_to_render, document_fields, **kwargs) unless method(:fields_to_render).arity.zero?
+    def fields_to_render
+      return to_enum(:fields_to_render) unless block_given?
 
-        Deprecation.warn(self.class, 'In Blacklight 8, Blacklight::DocumentPresenter#fields_to_render accepts additional arguments')
-
-        return to_enum(:fields_to_render)
-      end
-
-      document_fields.each do |name, field_config|
-        field_presenter = field_presenter(field_config, kwargs)
+      fields.each do |name, field_config|
+        field_presenter = field_presenter(field_config)
 
         next unless field_presenter.render_field? && field_presenter.any?
 
@@ -38,21 +30,10 @@ module Blacklight
       end
     end
 
-    def field_presenters(document_fields = fields, **kwargs)
-      unless block_given?
-        return to_enum(:field_presenters, document_fields, **kwargs) unless method(:field_presenters).arity.zero?
-
-        Deprecation.warn(self.class, 'In Blacklight 8, Blacklight::DocumentPresenter#field_presenters accepts additional arguments')
-
-        return to_enum(:field_presenters)
-      end
+    def field_presenters
+      return to_enum(:field_presenters) unless block_given?
 
-      if method(:fields_to_render).arity.zero?
-        Deprecation.warn(self.class, 'In Blacklight 8, Blacklight::DocumentPresenter#fields_to_render accept additional arguments')
-        fields_to_render.each { |_, _, config| yield config }
-      else
-        fields_to_render(document_fields, **kwargs).each { |_, _, config| yield config }
-      end
+      fields_to_render.each { |_, _, config| yield config }
     end
 
     ##
@@ -98,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
 
     ##
@@ -137,11 +116,11 @@ module Blacklight
     end
 
     def view_config
-      @view_config ||= show_view_config
+      show_view_config
     end
 
     def show_view_config
-      configuration.view_config(:show, action_name: view_context.action_name)
+      configuration.view_config(:show)
     end
 
     def inspect
@@ -151,33 +130,27 @@ 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
-      @field_presenter_options ||= {}
+      {}
     end
   end
 end