blacklight 7.33.0 → 8.0.0

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

@@ -21,6 +21,7 @@ module Blacklight::Document
   include Blacklight::Document::SemanticFields
   include Blacklight::Document::CacheKey
   include Blacklight::Document::Export
+  include Blacklight::Document::Attributes
 
   included do
     extend ActiveModel::Naming
@@ -30,6 +31,17 @@ module Blacklight::Document
     class_attribute :inspector_fields, default: [:_source]
   end
 
+  Email = Module.new do
+    def self.included(mod)
+      Blacklight.deprecation.warn("Blacklight::Document::Email is deprecated and will be removed (included in #{mod}).")
+    end
+  end
+  Sms = Module.new do
+    def self.included(mod)
+      Blacklight.deprecation.warn("Blacklight::Document::Sms is deprecated and will be removed (included in #{mod}).")
+    end
+  end
+
   attr_reader :response, :_source
   alias_method :solr_response, :response
 
@@ -70,13 +82,20 @@ module Blacklight::Document
   alias has_field? has?
   alias has_key? key?
 
-  def fetch key, *default
+  NO_DEFAULT_PROVIDED = Object.new # :nodoc:
+  def fetch key, default = NO_DEFAULT_PROVIDED
     if key? key
       self[key]
-    elsif default.empty? && !block_given?
-      raise KeyError, "key not found \"#{key}\""
+    elsif block_given?
+      yield(self) if block_given?
+    elsif default != NO_DEFAULT_PROVIDED
+      if default.respond_to?(:call)
+        default.call(self)
+      else
+        default
+      end
     else
-      (yield(self) if block_given?) || default.first
+      raise KeyError, "key not found \"#{key}\""
     end
   end
 
@@ -116,21 +135,5 @@ module Blacklight::Document
     def unique_key
       @unique_key ||= 'id'
     end
-
-    # Define an attribute reader on a document model
-    # @example
-    #   class SolrDocument
-    #     include Blacklight::Solr::Document
-    #     attribute :title, Blacklight::Types::String, 'title_tesim'
-    #   end
-    #
-    #   doc = SolrDocument.new(title_tesim: ["One flew over the cuckoo's nest"])
-    #   doc.title
-    #   #=> "One flew over the cuckoo's nest"
-    def attribute(name, type, field)
-      define_method name do
-        type.coerce(self[field])
-      end
-    end
   end
 end

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,28 +1,23 @@
 # frozen_string_literal: true
-# Only works for documents with a #to_marc right now.
-class RecordMailer < ActionMailer::Base
-  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
 
-    subject = I18n.t('blacklight.email.text.subject',
-                     count: documents.length,
-                     title: Array(title).first)
+# Only works for documents with a #to_marc right now.
+class RecordMailer < ApplicationMailer
+  helper CatalogHelper
+  helper_method :blacklight_config, :blacklight_configuration_context
 
+  def email_record(documents, details, url_gen_params)
     @documents      = documents
     @message        = details[:message]
     @config         = details[:config]
     @url_gen_params = url_gen_params
 
-    mail(to: details[:to],  subject: subject)
+    title = view_context.document_presenter(documents.first).html_title || I18n.t('blacklight.email.text.default_title')
+
+    subject = I18n.t('blacklight.email.text.subject',
+                     count: documents.length,
+                     title: Array(title).first)
+
+    mail(to: details[:to], subject: subject)
   end
 
   def sms_record(documents, details, url_gen_params)
@@ -30,6 +25,16 @@ 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
+
+  def blacklight_config
+    @config || Blacklight.default_configuration
+  end
+
+  ##
+  # Context in which to evaluate blacklight configuration conditionals
+  def blacklight_configuration_context
+    @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(self)
   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

@@ -11,18 +11,20 @@ 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)
+    def initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {})
       @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
-      return to_enum(:fields_to_render) unless block_given?
+    def fields_to_render(document_fields = fields, **kwargs)
+      return to_enum(:fields_to_render, document_fields, **kwargs) unless block_given?
 
-      fields.each do |name, field_config|
-        field_presenter = field_presenter(field_config)
+      document_fields.each do |name, field_config|
+        field_presenter = field_presenter(field_config, kwargs)
 
         next unless field_presenter.render_field? && field_presenter.any?
 
@@ -30,10 +32,10 @@ module Blacklight
       end
     end
 
-    def field_presenters
-      return to_enum(:field_presenters) unless block_given?
+    def field_presenters(document_fields = fields, **kwargs)
+      return to_enum(:field_presenters, document_fields, **kwargs) unless block_given?
 
-      fields_to_render.each { |_, _, config| yield config }
+      fields_to_render(document_fields, **kwargs).each { |_, _, config| yield config }
     end
 
     ##
@@ -79,10 +81,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
 
     ##
@@ -122,7 +122,7 @@ module Blacklight
     end
 
     def show_view_config
-      configuration.view_config(:show)
+      configuration.view_config(:show, action_name: view_context.action_name)
     end
 
     def inspect
@@ -132,33 +132,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

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]

data/app/presenters/blacklight/index_presenter.rb

@@ -1,47 +1,9 @@
 # frozen_string_literal: true
+
 module Blacklight
   class IndexPresenter < DocumentPresenter
-    ##
-    # Render the document index heading. This is used when making a link to a
-    # document, where we don't want any HTML markup added from the pipeline.
-    #
-    # @param [Symbol, Proc, String] field_or_string_or_proc Render the given field or evaluate the proc or render the given string
-    # @param [Hash] opts
-    def label(field_or_string_or_proc, opts = {})
-      config = Configuration::NullField.new
-      value = case field_or_string_or_proc
-                when Symbol
-                  config = field_config(field_or_string_or_proc)
-                  field_presenter(config).values
-                when Proc
-                  Deprecation.warn(self, "calling IndexPresenter.label with a Proc is deprecated. " \
-                                         "First argument must be a symbol. This will be removed in Blacklight 8")
-                  field_or_string_or_proc.call(document, opts)
-                when String
-                  Deprecation.warn(self, "calling IndexPresenter.label with a String is deprecated. " \
-                                         "First argument must be a symbol. This will be removed in Blacklight 8")
-                  field_or_string_or_proc
-              end
-
-      value = document.id if value.blank?
-      field_value(config, values: Array.wrap(value), except_operations: [Rendering::HelperMethod])
-    end
-
-    deprecation_deprecate label: 'Use #heading'
-
     def view_config
-      @view_config ||= configuration.view_config(view_context.document_index_view_type)
-    end
-
-    private
-
-    # @return [Hash<String,Configuration::Field>] all the fields for this index view
-    def fields
-      configuration.index_fields_for(display_type)
-    end
-
-    def field_config(field)
-      configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
+      @view_config ||= configuration.view_config(view_context.document_index_view_type, action_name: view_context.action_name)
     end
   end
 end

data/app/presenters/blacklight/json_presenter.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
+
 module Blacklight
   class JsonPresenter
-    include Blacklight::Facet
-
     # @param [Solr::Response] response raw solr response.
     # @param [Configuration] blacklight_config the configuration
     def initialize(response, blacklight_config)
@@ -12,15 +11,18 @@ module Blacklight
 
     attr_reader :blacklight_config
 
+    delegate :facet_field_names, :facet_configuration_for_field, to: :blacklight_config
+
     def documents
       @response.documents
     end
 
     # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
     def search_facets
-      Deprecation.silence(Blacklight::Facet) do
-        facets_from_request(facet_field_names, @response).select { |display_facet| display_facet.items.present? }
-      end
+      facet_field_names
+        .map { |field| @response.aggregations[facet_configuration_for_field(field).field] }
+        .compact
+        .select { |display_facet| display_facet.items.present? }
     end
 
     # extract the pagination info from the response object

data/app/presenters/blacklight/rendering/abstract_step.rb

@@ -20,6 +20,10 @@ module Blacklight
         first, *rest = *stack
         first.new(output_values, config, document, context, options, rest).render
       end
+
+      def html?
+        options[:format].nil? || options[:format].to_s == 'html'
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/join.rb

@@ -5,7 +5,13 @@ module Blacklight
     class Join < AbstractStep
       def render
         options = config.separator_options || {}
-        next_step(values.map { |x| html_escape(x) }.to_sentence(options).html_safe)
+        if values.one? || values.none?
+          next_step(values.first)
+        elsif !html?
+          next_step(values.to_sentence(options))
+        else
+          next_step(values.map { |x| x.html_safe? ? x : html_escape(x) }.to_sentence(options).html_safe)
+        end
       end
 
       private

data/app/presenters/blacklight/rendering/link_to_facet.rb

@@ -3,9 +3,8 @@
 module Blacklight
   module Rendering
     class LinkToFacet < AbstractStep
-      extend Deprecation
       def render
-        return next_step(values) unless config.link_to_facet
+        return next_step(values) unless config.link_to_facet && html?
 
         next_step(render_link)
       end
@@ -31,10 +30,8 @@ module Blacklight
         context.search_action_path(facet_params(field, v))
       end
 
-      def facet_params(field, v)
-        Deprecation.silence(Blacklight::SearchState) do
-          context.search_state.reset.add_facet_params(field, v)
-        end
+      def facet_params(field, item)
+        context.search_state.reset.filter(field).add(item).params
       end
     end
   end

data/app/presenters/blacklight/rendering/microdata.rb

@@ -5,7 +5,7 @@ module Blacklight
     class Microdata < AbstractStep
       include ActionView::Helpers::TagHelper
       def render
-        return next_step(values) unless config.itemprop
+        return next_step(values) unless config.itemprop && html?
 
         next_step(values.map { |x| itemprop(x, config.itemprop) })
       end

data/app/presenters/blacklight/show_presenter.rb

@@ -1,17 +1,9 @@
 # frozen_string_literal: true
+
 module Blacklight
   class ShowPresenter < DocumentPresenter
     private
 
-    # @return [Hash<String,Configuration::Field>]
-    def fields
-      configuration.show_fields_for(display_type)
-    end
-
-    def field_config(field)
-      configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
-    end
-
     def field_presenter_options
       { context: 'show' }
     end