blacklight 6.14.0 → 7.0.0

data/app/presenters/blacklight/index_presenter.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 module Blacklight
-  class IndexPresenter
-    extend Deprecation
-    self.deprecation_horizon = 'Blacklight version 7.0.0'
+  class IndexPresenter < DocumentPresenter
+    class_attribute :thumbnail_presenter
+    self.thumbnail_presenter = ThumbnailPresenter
 
-    attr_reader :document, :configuration, :view_context
+    attr_reader :view_config
 
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
@@ -13,6 +13,7 @@ module Blacklight
       @document = document
       @view_context = view_context
       @configuration = configuration
+      @view_config = configuration.view_config(view_context.document_index_view_type)
     end
 
     ##
@@ -24,81 +25,63 @@ module Blacklight
     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)
-        document[field_or_string_or_proc]
-      when Proc
-        field_or_string_or_proc.call(document, opts)
-      when String
-        field_or_string_or_proc
-      end
+                when Symbol
+                  config = field_config(field_or_string_or_proc)
+                  document[field_or_string_or_proc]
+                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
       field_values(config, value: value)
     end
 
-    # @deprecated
-    def render_document_index_label(*args)
-      label(*args)
-    end
-    deprecation_deprecate render_document_index_label: 'Use #label instead'
-
     ##
     # Render the index field label for a document
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [String] field
+    # @param [Configuration::Field] field
     # @param [Hash] options
     # @option options [String] :value
     def field_value field, options = {}
-      field_config = field_config(field)
-      field_values(field_config, options)
+      field_values(field, options)
     end
 
-    # @deprecated
-    def render_index_field_value(*args)
-      field_value(*args)
+    def thumbnail
+      @thumbnail ||= thumbnail_presenter.new(document, view_context, view_config)
     end
-    deprecation_deprecate render_index_field_value: 'replaced by #field_value'
 
-    # @deprecated
-    def get_field_values(field_config, options={})
-      field_values(field_config, options)
-    end
-    deprecation_deprecate get_field_values: "replaced by #field_value"
+    private
 
-    # @deprecated
-    def render_field_values(values, field_config = Configuration::NullField.new)
-      field_values(field_config, value: Array(values))
+    # @return [Hash<String,Configuration::Field>] all the fields for this index view
+    def fields
+      configuration.index_fields_for(document)
     end
-    deprecation_deprecate render_field_values: "replaced by #field_value"
 
-    # @deprecated
-    def render_values(values, field_config = Configuration::NullField.new)
-      field_values(field_config, value: Array(values))
+    ##
+    # Get the value for a document's field, and prepare to render it.
+    # - highlight_field
+    # - accessor
+    # - solr field
+    #
+    # Rendering:
+    #   - helper_method
+    #   - link_to_facet
+    # @param [Blacklight::Configuration::Field] field_config solr field configuration
+    # @param [Hash] options additional options to pass to the rendering helpers
+    def field_values(field_config, options = {})
+      FieldPresenter.new(view_context, document, field_config, options).render
     end
-    deprecation_deprecate render_values: "replaced by #field_value"
-
-    private
 
-      ##
-      # Get the value for a document's field, and prepare to render it.
-      # - highlight_field
-      # - accessor
-      # - solr field
-      #
-      # Rendering:
-      #   - helper_method
-      #   - link_to_search
-      # @param [Blacklight::Configuration::Field] field_config solr field configuration
-      # @param [Hash] options additional options to pass to the rendering helpers
-      def field_values(field_config, options={})
-        FieldPresenter.new(view_context, document, field_config, options).render
-      end
-
-      def field_config(field)
-        configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
-      end
+    def field_config(field)
+      configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
+    end
   end
 end

data/app/presenters/blacklight/json_presenter.rb

@@ -4,25 +4,21 @@ module Blacklight
     include Blacklight::Facet
 
     # @param [Solr::Response] response raw solr response.
-    # @param [Array<SolrDocument>] documents a list of documents
-    # @param [Array] facets list of facets
-    def initialize(response, documents, facets, blacklight_config)
+    # @param [Configuration] blacklight_config the configuration
+    def initialize(response, blacklight_config)
       @response = response
-      @documents = documents
-      @facets = facets
       @blacklight_config = blacklight_config
     end
 
-    attr_reader :documents, :blacklight_config
+    attr_reader :blacklight_config
 
-    def search_facets_as_json
-      @facets.as_json.each do |f|
-        f.delete "options"
-        f["label"] = facet_configuration_for_field(f["name"]).label
-        f["items"] = f["items"].as_json.each do |i|
-          i['label'] ||= i['value']
-        end
-      end
+    def documents
+      @response.documents
+    end
+
+    # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
+    def search_facets
+      facets_from_request.select { |display_facet| display_facet.items.present? }
     end
 
     # extract the pagination info from the response object

data/app/presenters/blacklight/link_alternate_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   # Create <link rel="alternate"> links from a documents dynamically
   class LinkAlternatePresenter
@@ -12,7 +14,7 @@ module Blacklight
 
     attr_reader :view_context, :document, :options
 
-    # Renders links to alternate representations 
+    # Renders links to alternate representations
     # provided by export formats. Returns empty string if no links available.
     def render
       seen = Set.new

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class AbstractStep
@@ -12,12 +14,12 @@ module Blacklight
 
       attr_reader :values, :config, :document, :context, :options, :stack
 
-      protected
+      private
 
-        def next_step(output_values)
-          first, *rest = *stack
-          first.new(output_values, config, document, context, options, rest).render
-        end
+      def next_step(output_values)
+        first, *rest = *stack
+        first.new(output_values, config, document, context, options, rest).render
+      end
     end
   end
 end

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

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class HelperMethod < AbstractStep
       def render
         if config.helper_method
           render_helper # short circut the rest of the steps
-        else  
+        else
           next_step(values)
         end
       end
 
       private
 
-        def render_helper
-          context.send(config.helper_method,
-                       options.merge(document: document,
-                                     field: config.field,
-                                     config: config,
-                                     value: values))
-        end
+      def render_helper
+        context.send(config.helper_method,
+                     options.merge(document: document,
+                                   field: config.field,
+                                   config: config,
+                                   value: values))
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class Join < AbstractStep
@@ -8,9 +10,9 @@ module Blacklight
 
       private
 
-        def html_escape(*args)
-          ERB::Util.html_escape(*args)
-        end
+      def html_escape(*args)
+        ERB::Util.html_escape(*args)
+      end
     end
   end
 end

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

@@ -1,35 +1,39 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class LinkToFacet < AbstractStep
+      extend Deprecation
       def render
-        # TODO: We should rename the config variable, because it creates a link to a facet.
-        return next_step(values) unless config.link_to_search
+        return next_step(values) unless config.link_to_facet
+
         next_step(render_link)
       end
 
       private
 
-        # This allows the link to wrap an itemprop
-        def render_link
-          values.map { |v| link(link_field, v) }
-        end
+      # This allows the link to wrap an itemprop
+      def render_link
+        values.map { |v| link(link_field, v) }
+      end
+
+      def link_field
+        return config.key if config.link_to_facet == true
 
-        def link_field
-          return config.key if config.link_to_search == true
-          config.link_to_search
-        end
+        config.link_to_facet
+      end
 
-        def link(field, v)
-          context.link_to v, search_path(field, v)
-        end
+      def link(field, v)
+        context.link_to v, search_path(field, v)
+      end
 
-        def search_path(field, v)
-          context.search_action_path(facet_params(field, v))
-        end
+      def search_path(field, v)
+        context.search_action_path(facet_params(field, v))
+      end
 
-        def facet_params(field, v)
-          context.search_state.reset.add_facet_params(field, v)
-        end
+      def facet_params(field, v)
+        context.search_state.reset.add_facet_params(field, v)
+      end
     end
   end
 end

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

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class Microdata < AbstractStep
       include ActionView::Helpers::TagHelper
       def render
         return next_step(values) unless config.itemprop
+
         next_step(values.map { |x| itemprop(x, config.itemprop) })
       end
 
       private
 
-        def itemprop(val, itemprop)
-          content_tag :span, val, itemprop: itemprop
-        end
+      def itemprop(val, itemprop)
+        content_tag :span, val, itemprop: itemprop
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     # The field rendering pipeline
@@ -26,12 +28,12 @@ module Blacklight
         first.new(values, config, document, context, options, rest).render
       end
 
-      protected
+      private
 
-        # Ordered list of operations, Terminator must be at the end.
-        def stack
-          operations + [Terminator]
-        end
+      # Ordered list of operations, Terminator must be at the end.
+      def stack
+        operations + [Terminator]
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class Terminator < AbstractStep

data/app/presenters/blacklight/search_bar_presenter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class SearchBarPresenter
+    attr_reader :configuration, :view_context, :controller
+
+    # Set the partial this presenter draws
+    class_attribute :partial
+    self.partial = 'catalog/search_form'
+
+    def initialize(controller, configuration = view_context.blacklight_config)
+      @controller = controller
+      @view_context = controller.view_context
+      @configuration = configuration
+    end
+
+    def render
+      view_context.render partial, presenter: self
+    end
+
+    ##
+    # @return [Boolean] should autocomplete be enabled in the UI
+    def autocomplete_enabled?
+      configuration.autocomplete_enabled.present? &&
+        configuration.autocomplete_path.present?
+    end
+
+    ##
+    # If no search parameters have been given, we should
+    # auto-focus the user's cursor into the searchbox
+    #
+    # @return [Boolean]
+    def autofocus?
+      controller.is_a?(Blacklight::Catalog) &&
+        controller.action_name == "index" &&
+        !controller.has_search_parameters?
+    end
+  end
+end

data/app/presenters/blacklight/show_presenter.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 module Blacklight
-  class ShowPresenter
-    extend Deprecation
-    self.deprecation_horizon = 'Blacklight version 7.0.0'
-
-    attr_reader :document, :configuration, :view_context
-
+  class ShowPresenter < DocumentPresenter
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
@@ -23,7 +18,6 @@ module Blacklight
     # @option options [Boolean] :unique ensures only one link is output for every
     #     content type, e.g. as required by atom
     # @option options [Array<String>] :exclude array of format shortnames to not include in the output
-    # @deprecated moved to ShowPresenter#link_rel_alternates
     def link_rel_alternates(options = {})
       LinkAlternatePresenter.new(view_context, document, options).render
     end
@@ -45,12 +39,6 @@ module Blacklight
       end
     end
 
-    # @deprecated
-    def document_show_html_title
-      html_title
-    end
-    deprecation_deprecate document_show_html_title: "use #html_title"
-
     ##
     # Get the value of the document's "title" field, or a placeholder
     # value (if empty)
@@ -63,71 +51,46 @@ module Blacklight
       field_values(field_config(f), value: document[f])
     end
 
-    # @deprecated
-    def document_heading
-      heading
-    end
-    deprecation_deprecate document_heading: "replaced by #heading"
-
     ##
     # Render the show field value for a document
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [String] field
+    # @param [Configuration::Field] field
     # @param [Hash] options
     # @option options [String] :value
-    def field_value field, options={}
-      field_values(field_config(field), options)
+    def field_value field, options = {}
+      field_values(field, options)
     end
 
-    # @deprecated
-    def render_document_show_field_value(*args)
-      field_value(*args)
-    end
-    deprecation_deprecate render_document_show_field_value: 'replaced by #field_value'
+    private
 
-    # @deprecated
-    def get_field_values(field_config, options={})
-      field_values(field_config, options)
+    # @return [Hash<String,Configuration::Field>]
+    def fields
+      configuration.show_fields_for(document)
     end
-    deprecation_deprecate get_field_values: "replaced by #field_value"
 
-    # @deprecated
-    def render_field_values(values, field_config = Configuration::NullField.new)
-      field_values(field_config, value: Array(values))
+    ##
+    # Get the value for a document's field, and prepare to render it.
+    # - highlight_field
+    # - accessor
+    # - solr field
+    #
+    # Rendering:
+    #   - helper_method
+    #   - link_to_facet
+    # @param [Blacklight::Configuration::Field] field_config solr field configuration
+    # @param [Hash] options additional options to pass to the rendering helpers
+    def field_values(field_config, options = {})
+      FieldPresenter.new(view_context, document, field_config, options).render
     end
-    deprecation_deprecate render_field_values: "replaced by #field_value"
 
-    # @deprecated
-    def render_values(values, field_config = Configuration::NullField.new)
-      field_values(field_config, value: Array(values))
+    def view_config
+      configuration.view_config(:show)
     end
-    deprecation_deprecate render_values: "replaced by #field_value"
-
-    private
-
-      ##
-      # Get the value for a document's field, and prepare to render it.
-      # - highlight_field
-      # - accessor
-      # - solr field
-      #
-      # Rendering:
-      #   - helper_method
-      #   - link_to_search
-      # @param [Blacklight::Configuration::Field] field_config solr field configuration
-      # @param [Hash] options additional options to pass to the rendering helpers
-      def field_values(field_config, options={})
-        FieldPresenter.new(view_context, document, field_config, options).render
-      end
 
-      def view_config
-        configuration.view_config(:show)
-      end
-
-      def field_config(field)
-        configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
-      end
+    def field_config(field)
+      configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
+    end
   end
 end

data/app/presenters/blacklight/thumbnail_presenter.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ThumbnailPresenter
+    attr_reader :document, :view_context, :view_config
+
+    # @param [SolrDocument] document
+    # @param [ActionView::Base] view_context scope for linking and generating urls
+    #                                        as well as for invoking "thumbnail_method"
+    # @param [Blacklight::Configuration::ViewConfig] view_config
+    def initialize(document, view_context, view_config)
+      @document = document
+      @view_context = view_context
+      @view_config = view_config
+    end
+
+    ##
+    # Does the document have a thumbnail to render?
+    #
+    # @return [Boolean]
+    def exists?
+      thumbnail_method.present? ||
+        (thumbnail_field && thumbnail_value_from_document(document).present?) ||
+        default_thumbnail.present?
+    end
+
+    ##
+    # Render the thumbnail, if available, for a document and
+    # link it to the document record.
+    #
+    # @param [Hash] image_options to pass to the image tag
+    # @param [Hash] url_options to pass to #link_to_document
+    # @return [String]
+    def thumbnail_tag image_options = {}, url_options = {}
+      value = thumbnail_value(image_options)
+      return value if value.nil? || url_options[:suppress_link]
+
+      view_context.link_to_document document, value, url_options
+    end
+
+    private
+
+    delegate :thumbnail_field, :thumbnail_method, :default_thumbnail, to: :view_config
+
+    # @param [Hash] image_options to pass to the image tag
+    def thumbnail_value(image_options)
+      value = if thumbnail_method
+                view_context.send(thumbnail_method, document, image_options)
+              elsif thumbnail_field
+                image_url = thumbnail_value_from_document(document)
+                view_context.image_tag image_url, image_options if image_url.present?
+              end
+
+      value || default_thumbnail_value(image_options)
+    end
+
+    def default_thumbnail_value(image_options)
+      return unless default_thumbnail
+
+      case default_thumbnail
+      when Symbol
+        view_context.send(default_thumbnail, document, image_options)
+      when Proc
+        default_thumbnail.call(document, image_options)
+      else
+        view_context.image_tag default_thumbnail, image_options
+      end
+    end
+
+    def thumbnail_value_from_document(document)
+      Array(thumbnail_field).lazy.map { |field| document.first(field) }.reject(&:blank?).first
+    end
+  end
+end

data/app/services/blacklight/document_factory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class DocumentFactory
+    def self.build(data, response, options)
+      document_model(data, options).new(data, response)
+    end
+
+    def self.document_model(_data, options)
+      options[:solr_document_model] || options[:document_model] || SolrDocument
+    end
+  end
+end