blacklight 7.40.0 → 8.0.0.beta1

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, action_name: view_context.action_name)
-    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) }
+      configuration.view_config(view_context.document_index_view_type)
     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/link_to_facet.rb

@@ -3,7 +3,6 @@
 module Blacklight
   module Rendering
     class LinkToFacet < AbstractStep
-      extend Deprecation
       def render
         return next_step(values) unless config.link_to_facet
 
@@ -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/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

data/app/presenters/blacklight/thumbnail_presenter.rb

@@ -72,7 +72,7 @@ module Blacklight
     end
 
     def thumbnail_value_from_document
-      Array(thumbnail_field).lazy.map { |field| retrieve_values(field_config(field)).first }.reject(&:blank?).first
+      Array(thumbnail_field).lazy.map { |field| retrieve_values(field_config(field)).first }.compact_blank.first
     end
 
     def retrieve_values(field_config)

data/app/services/blacklight/bookmarks_search_builder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Extends the search Builders to add bookmarks
+  class BookmarksSearchBuilder < ::SearchBuilder
+    ##
+    # Filters the query to only include the bookmarked items
+    #
+    # @param [Hash] solr_parameters
+    #
+    # @return [void]
+    def bookmarked(solr_parameters)
+      solr_parameters[:fq] ||= []
+      bookmarks = @scope.context.fetch(:bookmarks)
+      return unless bookmarks
+
+      document_ids = bookmarks.collect { |b| b.document_id.to_s }
+      solr_parameters[:fq] += ["{!terms f=id}#{document_ids.join(',')}"]
+    end
+    self.default_processor_chain += [:bookmarked]
+  end
+end

data/app/services/blacklight/field_retriever.rb

@@ -22,19 +22,17 @@ module Blacklight
 
     # @return [Array]
     def fetch
-      if field_config.highlight
-        value = retrieve_highlight
-      end
-      if value.blank?
-        value = if field_config.accessor
-                  retieve_using_accessor
-                elsif field_config.values
-                  retrieve_values
-                else
-                  retrieve_simple
-                end
-      end
-      Array.wrap(value)
+      Array.wrap(
+        if field_config.highlight
+          retrieve_highlight
+        elsif field_config.accessor
+          retieve_using_accessor
+        elsif field_config.values
+          retrieve_values
+        else
+          retrieve_simple
+        end
+      )
     end
 
     private
@@ -69,14 +67,7 @@ module Blacklight
     end
 
     def retrieve_values
-      values_method = field_config.values
-
-      if values_method.respond_to?(:arity) && values_method.arity.abs == 2
-        Deprecation.warn(self, ":values parameter for field #{field_config.key} only accepts 2 arguments; should accept 3")
-        values_method.call(field_config, document)
-      else
-        values_method.call(field_config, document, view_context)
-      end
+      field_config.values.call(field_config, document, view_context)
     end
   end
 end

data/app/services/blacklight/search_service.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # SearchService returns search results from the repository
 module Blacklight
   class SearchService
@@ -33,17 +34,17 @@ module Blacklight
       response = repository.search(builder)
 
       if response.grouped? && grouped_key_for_results
-        [response.group(grouped_key_for_results), []]
+        response.group(grouped_key_for_results)
       elsif response.grouped? && response.grouped.length == 1
-        [response.grouped.first, []]
+        response.grouped.first
       else
-        [response, response.documents]
+        response
       end
     end
 
     # retrieve a document, given the doc id
     # @param [Array{#to_s},#to_s] id
-    # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
+    # @return [Blacklight::SolrDocument] the solr response object and the first document
     def fetch(id = nil, extra_controller_params = {})
       if id.is_a? Array
         fetch_many(id, extra_controller_params)
@@ -123,7 +124,7 @@ module Blacklight
 
       if index > 0
         solr_params[:start] = index - window # get one before
-        solr_params[:rows] = 2 * window + 1 # and one after
+        solr_params[:rows] = (2 * window) + 1 # and one after
       else
         solr_params[:start] = 0 # there is no previous doc
         solr_params[:rows] = 2 * window # but there should be one after
@@ -146,22 +147,14 @@ module Blacklight
               .merge(blacklight_config.fetch_many_document_params)
               .merge(extra_controller_params)
 
-      # find_many was introduced in Blacklight 8.4. Before that, we used the
-      # regular search method (possibly with a find-many specific `qt` parameter).
-      # In order to support Repository implementations that may not have a find_many,
-      # we'll fall back to search if find_many isn't available.
-      solr_response = if repository.respond_to?(:find_many)
-                        repository.find_many(query)
-                      else
-                        repository.search(query)
-                      end
-
-      [solr_response, solr_response.documents]
+      solr_response = repository.search(query)
+
+      solr_response.documents
     end
 
     def fetch_one(id, extra_controller_params)
       solr_response = repository.find id, extra_controller_params
-      [solr_response, solr_response.documents.first]
+      solr_response.documents.first
     end
   end
 end

data/app/values/blacklight/types.rb

@@ -16,10 +16,6 @@ module Blacklight
         new.cast(input)
       end
 
-      def initialize(**kwargs)
-        @kwargs = kwargs
-      end
-
       def cast(input)
         if input.is_a?(::Array)
           input.first
@@ -69,19 +65,6 @@ module Blacklight
       end
     end
 
-    class Time < Value
-      def cast(input)
-        value = super
-        return if value.blank?
-
-        begin
-          ::Time.parse(value.to_s) # rubocop:disable Rails/TimeZone
-        rescue ArgumentError
-          Rails.logger&.info "Unable to parse time: #{value.inspect}"
-        end
-      end
-    end
-
     class Boolean < Value
       def cast(input)
         ActiveModel::Type::Boolean.new.cast(super)
@@ -123,7 +106,6 @@ module Blacklight
     register :boolean, Boolean
     register :string, String
     register :date, Date
-    register :time, Time
     register :array, Array
     register :json, JsonValue
     register :html, Html

data/app/views/bookmarks/_clear_bookmarks_widget.html.erb

@@ -1 +1,8 @@
-  <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path, :method => :delete, :data => { :confirm => t('blacklight.bookmarks.clear.action_confirm') }, :class => 'clear-bookmarks btn btn-danger' %>
+  <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path,
+      method: :delete, # for rails-UJS
+      data: {
+        confirm: t('blacklight.bookmarks.clear.action_confirm'), # for rails-UJS
+        turbo_method: :delete,
+        turbo_confirm: t('blacklight.bookmarks.clear.action_confirm')
+      },
+      class: 'clear-bookmarks btn btn-danger' %>

data/app/views/bookmarks/_tools.html.erb

@@ -1,12 +1,7 @@
-<% if render_show_doc_actions_method_from_blacklight? %>
-  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'div', classes: "#{controller_name}Tools", link_classes: 'btn btn-outline-primary', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
-<% else %>
-  <% Deprecation.warn(self, '#render_show_doc_actions is deprecated; use ActionComponents instead') %>
-  <ul class="<%= controller_name %>Tools nav nav-pills">
-    <%= render_show_doc_actions document_list, document: nil, document_list: @response.documents, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h) do |config, inner| %>
-      <li class="nav-item">
-        <%= inner %>
-      </li>
-    <% end %>
-  </ul>
-<% end %>
+<%= render Blacklight::Document::ActionsComponent.new(document: nil,
+                                                      tag: 'div',
+                                                      classes: "#{controller_name}Tools",
+                                                      link_classes: 'btn btn-outline-primary',
+                                                      actions: document_actions(document_list, options: { document: nil }),
+                                                      options: { document_list: @response.documents },
+                                                      url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h)) %>

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

@@ -2,6 +2,5 @@
       url: search_action_url,
       classes: ['advanced', 'form-horizontal'],
       params: search_state.params_for_search.except(:qt),
-      search_fields: Deprecation.silence(Blacklight::ConfigurationHelperBehavior) { search_fields },
       response: @response
     )) %>

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

@@ -1 +1 @@
-<%= render Blacklight::Document::BookmarkComponent.new(document: document) if current_or_guest_user %>
+<%= render Blacklight::Document::BookmarkComponent.new(document: document, action: document_action_config) %>

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/_constraints.html.erb

@@ -1,14 +1 @@
-<% if constraints_helpers_and_partials_from_blacklight? || blacklight_config&.view_config(document_index_view_type)&.constraints_component %>
-  <%= render((blacklight_config&.view_config(document_index_view_type)&.constraints_component || Blacklight::ConstraintsComponent).new(search_state: convert_to_search_state(controller.params != params ? params : search_state))) %>
-<% else %>
-  <% Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'Constraints helpers or partials were overridden; not using components') %>
-  <% if Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) { query_has_constraints? } %>
-    <div id="appliedParams" class="clearfix constraints-container">
-      <h2 class="sr-only visually-hidden"><%= t('blacklight.search.search_constraints_header') %></h2>
-
-      <%= render 'start_over' %>
-      <span class="constraints-label sr-only visually-hidden"><%= t('blacklight.search.filters.title') %></span>
-      <%= render_constraints(controller.params != params ? params : search_state) %>
-    </div>
-  <% end %>
-<% end %>
+<%= render (blacklight_config&.view_config(document_index_view_type)&.constraints_component || Blacklight::ConstraintsComponent).new(search_state: search_state) %>

data/app/views/catalog/_document.atom.builder

@@ -7,14 +7,12 @@ xml.entry do
   # updated is required, for now we'll just set it to now, sorry
   xml.updated Time.current.iso8601
 
-  Deprecation.silence(Blacklight::UrlHelperBehavior) do
-    xml.link "rel" => "alternate", "type" => "text/html", "href" => polymorphic_url(url_for_document(document))
-    # add other doc-specific formats, atom only lets us have one per
-    # content type, so the first one in the list wins.
-    xml << presenter.link_rel_alternates(unique: true)
+  xml.link "rel" => "alternate", "type" => "text/html", "href" => polymorphic_url(search_state.url_for_document(document))
+  # add other doc-specific formats, atom only lets us have one per
+  # content type, so the first one in the list wins.
+  xml << presenter.link_rel_alternates(unique: true)
 
-    xml.id polymorphic_url(url_for_document(document))
-  end
+  xml.id polymorphic_url(search_state.url_for_document(document))
 
   if document.to_semantic_values.key? :author
     xml.author { xml.name(document.to_semantic_values[:author].first) }
@@ -22,13 +20,12 @@ xml.entry do
 
   with_format(:html) do
     xml.summary "type" => "html" do
-      xml.text! render_document_partials(document,
-                                         blacklight_config.view_config(:atom).summary_partials,
-                                         document_counter: document_counter)
+      document_component = blacklight_config.view_config(:atom).summary_component
+      xml.text! render document_component.new(presenter: document_presenter(document), component: :div, show: true)
     end
   end
 
-  #If they asked for a format, give it to them.
+  # If they asked for a format, give it to them.
   if (params["content_format"] &&
     document.export_formats[params["content_format"].to_sym])
 
@@ -40,14 +37,15 @@ xml.entry do
       # encode properly. See:
       # http://tools.ietf.org/html/rfc4287#section-4.1.3.3
       type = type.downcase
-      if (type.downcase =~ %r{\+|/xml$})
+      case type.downcase
+      when %r{\+|/xml$}
         # xml, just put it right in
         content_element << data
-      elsif (type.downcase =~ %r{text/})
+      when %r{text/}
         # text, escape
         content_element.text! data
       else
-        #something else, base64 encode it
+        # something else, base64 encode it
         content_element << Base64.encode64(data)
       end
     end

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

@@ -1,7 +1,9 @@
 <% # container for a single doc -%>
 <% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type) %>
-<%= render (view_config.document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
-  <% component.public_send(view_config.document_component.blank? && view_config.partials.any? ? :with_body : :with_partial) do %>
-    <%= render_document_partials document, view_config.partials, component: component, document_counter: document_counter %>
+<%= render view_config.document_component.new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
+  <% view_config.partials.each do |partial| %>
+    <% component.partial do %>
+      <%= render_document_partial document, partial, component: component, document_counter: document_counter %>
+    <% end %>
   <% end %>
 <% end %>

data/app/views/catalog/_document.rss.builder

@@ -2,8 +2,6 @@
 
 xml.item do
   xml.title(document_presenter(document).heading || (document.to_semantic_values[:title].first if document.to_semantic_values.key?(:title)))
-  Deprecation.silence(Blacklight::UrlHelperBehavior) do
-    xml.link(polymorphic_url(url_for_document(document)))
-  end
-  xml.author( document.to_semantic_values[:author].first ) if document.to_semantic_values.key? :author
+  xml.link(polymorphic_url(search_state.url_for_document(document)))
+  xml.author(document.to_semantic_values[:author].first) if document.to_semantic_values.key? :author
 end