blacklight 9.0.0.beta1 → 9.0.0.beta3

data/app/components/blacklight/document/thumbnail_component.rb

@@ -9,19 +9,20 @@ module Blacklight
       # @param [Blacklight::DocumentPresenter] presenter
       # @param [Integer] counter
       # @param [Hash] image_options options for the thumbnail presenter's image tag
-      def initialize(counter:, presenter: nil, document: nil, image_options: {})
+      def initialize(counter:, presenter: nil, image_options: {})
         @presenter = presenter
-        @document = presenter&.document || document
         @counter = counter
         @image_options = { alt: '' }.merge(image_options)
       end
 
-      def render?
-        presenter.thumbnail.exists?
+      attr_accessor :presenter
+
+      def thumbnail_value
+        @thumbnail_value ||= presenter.thumbnail.render(@image_options)
       end
 
-      def presenter
-        @presenter ||= helpers.document_presenter(@document)
+      def render?
+        presenter.thumbnail && thumbnail_value
       end
     end
   end

data/app/components/blacklight/document_component.html.erb

@@ -1,11 +1,11 @@
 <%= content_tag @component,
   id: @id,
   data: {
-    'document-id': @document.id.to_s.parameterize,
-    'document-counter': @counter,
+    'document-id': document.id.to_s.parameterize,
+    'document-counter': counter,
   },
   itemscope: true,
-  itemtype: @document.itemtype,
+  itemtype: document.itemtype,
   class: classes.flatten.join(' ') do %>
   <%= header %>
   <% if body.present? %>

data/app/components/blacklight/document_component.rb

@@ -36,7 +36,7 @@ module Blacklight
     renders_one :title, (lambda do |*args, component: nil, **kwargs|
       component ||= view_config.title_component || Blacklight::DocumentTitleComponent
 
-      component.new(*args, counter: @counter, document: @document, presenter: @presenter, as: @title_component, actions: !@show, link_to_document: !@show, document_component: self, **kwargs)
+      component.new(*args, counter: @counter, presenter: @presenter, as: @title_component, actions: !@show, link_to_document: !@show, document_component: self, **kwargs)
     end)
 
     renders_one :embed, (lambda do |static_content = nil, *args, component: nil, **kwargs|
@@ -46,7 +46,7 @@ module Blacklight
 
       next unless component
 
-      component.new(*args, document: @document, presenter: @presenter, document_counter: @document_counter, **kwargs)
+      component.new(*args, presenter: @presenter, document_counter: @document_counter, **kwargs)
     end)
 
     # The primary metadata section
@@ -66,7 +66,7 @@ module Blacklight
 
       component ||= view_config.thumbnail_component || Blacklight::Document::ThumbnailComponent
 
-      component.new(*args, document: @document, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
+      component.new(*args, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
     end)
 
     # A container for partials rendered using the view config partials configuration. Its use is discouraged, but necessary until
@@ -126,7 +126,7 @@ module Blacklight
 
       view_partials.each do |view_partial|
         with_partial(view_partial) do
-          helpers.render_document_partial @document, view_partial, component: self, document_counter: @counter
+          helpers.render_document_partial document, view_partial, component: self, document_counter: counter
         end
       end
     end
@@ -135,7 +135,7 @@ module Blacklight
 
     delegate :view_config, to: :@presenter
 
-    attr_reader :document_counter, :presenter, :view_partials
+    attr_reader :document_counter, :counter, :document, :presenter, :view_partials
 
     def show?
       @show

data/app/components/blacklight/document_title_component.rb

@@ -7,12 +7,9 @@ module Blacklight
     renders_many :actions
 
     # rubocop:disable Metrics/ParameterLists
-    def initialize(title = nil, document: nil, presenter: nil, as: :h3, counter: nil, classes: 'index_title document-title-heading col h5', link_to_document: true, document_component: nil,
+    def initialize(title = nil, presenter:, as: :h3, counter: nil, classes: 'index_title document-title-heading col h5', link_to_document: true, document_component: nil,
                    actions: true)
-      raise ArgumentError, 'missing keyword: :document or :presenter' if presenter.nil? && document.nil?
-
       @title = title
-      @document = document
       @presenter = presenter
       @as = as || :h3
       @counter = counter
@@ -20,9 +17,14 @@ module Blacklight
       @link_to_document = link_to_document
       @document_component = document_component
       @actions = actions
+      @document = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(@presenter.document,
+                                                                        "Don't use the @document instance variable. Instead use @presenter",
+                                                                        ActiveSupport::Deprecation.new)
     end
     # rubocop:enable Metrics/ParameterLists
 
+    attr_accessor :presenter
+
     # Content for the document title area; should be an inline element
     def title
       if @link_to_document
@@ -53,11 +55,5 @@ module Blacklight
         t('blacklight.search.documents.counter', counter: @counter)
       end
     end
-
-    private
-
-    def presenter
-      @presenter ||= helpers.document_presenter(@document)
-    end
   end
 end

data/app/components/blacklight/facet_field_checkboxes_component.rb

@@ -1,24 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldCheckboxesComponent < Blacklight::Component
-    def initialize(facet_field:, layout: nil)
-      @facet_field = facet_field
-      @layout = layout == false ? FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
-    end
-
-    def render?
-      presenters.any?
-    end
-
-    def presenters
-      return [] unless @facet_field.paginator
-
-      return to_enum(:presenters) unless block_given?
-
-      @facet_field.paginator.items.each do |item|
-        yield Blacklight::FacetCheckboxItemPresenter.new(item, @facet_field.facet_field, helpers, @facet_field.key, @facet_field.search_state)
-      end
+  class FacetFieldCheckboxesComponent < Facets::CheckboxesComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetFieldCheckboxesComponent is deprecated. Use Blacklight::Facets::CheckboxesComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_field_component.rb

@@ -1,21 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldComponent < Blacklight::Component
-    renders_one :label
-    renders_one :body
-
-    # @param [Blacklight::FacetFieldPresenter] facet_field
-    def initialize(facet_field:)
-      @facet_field = facet_field
-    end
-
-    def html_id
-      "facet-#{@facet_field.key.parameterize}"
-    end
-
-    def header_html_id
-      "#{html_id}-header"
+  class FacetFieldComponent < Facets::FieldComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetFieldComponent is deprecated. Use Blacklight::Facets::FacetFieldComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_field_filter_component.rb

@@ -1,25 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldFilterComponent < Blacklight::Component
-    def initialize(facet_field:)
-      @facet_field = facet_field
-    end
-
-    def render?
-      @facet_field.facet_field.index_range.any?
-    end
-
-    def prefix
-      @facet_field.paginator.prefix
-    end
-
-    def clear_facet_prefix_url
-      @facet_field.paginator.params_for_resort_url('index', @facet_field.search_state.to_h.except(@facet_field.paginator.request_keys[:prefix]))
-    end
-
-    def facet_prefix_url(letter)
-      @facet_field.paginator.params_for_resort_url('index', @facet_field.search_state.to_h.merge(@facet_field.paginator.request_keys[:prefix] => letter))
+  class FacetFieldFilterComponent < Facets::IndexNavigationComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetFieldFilterComponent is deprecated. Use Blacklight::Facets::IndexNavigationComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_field_inclusive_constraint_component.rb

@@ -1,29 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldInclusiveConstraintComponent < Blacklight::Component
-    with_collection_parameter :facet_field
-
-    def initialize(facet_field:, values: nil)
-      @facet_field = facet_field
-      @values = values
-    end
-
-    def values
-      @values ||= @facet_field.values.find { |v| v.is_a? Array }
-      @values || []
-    end
-
-    def render?
-      values.present?
-    end
-
-    def presenters
-      return to_enum(:presenters) unless block_given?
-
-      values.each do |item|
-        yield Blacklight::FacetGroupedItemPresenter.new(values, item, @facet_field.facet_field, helpers, @facet_field.key, @facet_field.search_state)
-      end
+  class FacetFieldInclusiveConstraintComponent < Facets::InclusiveConstraintComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetFieldInclusiveConstraintComponent is deprecated. Use Blacklight::Facets::InclusiveConstraintComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_field_list_component.rb

@@ -1,36 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldListComponent < Blacklight::Component
-    def initialize(facet_field:, layout: nil)
-      @facet_field = facet_field
-      @layout = layout == false ? FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
-    end
-
-    def facet_items(wrapping_element: :li, **item_args)
-      facet_item_component_class.with_collection(facet_item_presenters, wrapping_element: wrapping_element, **item_args)
-    end
-
-    def facet_item_presenters
-      @facet_field.paginator.items.map do |item|
-        facet_item_presenter(item)
-      end
-    end
-
-    def render?
-      @facet_field.paginator&.items&.any?
-    end
-
-    def facet_item_presenter(facet_item)
-      facet_config.item_presenter.new(facet_item, facet_config, helpers, @facet_field.key)
-    end
-
-    def facet_item_component_class
-      facet_config.item_component
-    end
-
-    def facet_config
-      @facet_field.facet_field
+  class FacetFieldListComponent < Facets::ListComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetFieldListComponent is deprecated. Use Blacklight::Facets::ListComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_field_no_layout_component.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldNoLayoutComponent < Blacklight::Component
-    renders_one :label
-    renders_one :body
-
-    def initialize(**); end
-
-    def call
-      body.to_s
+  class FacetFieldNoLayoutComponent < Facets::NoLayoutComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetFieldNoLayoutComponent is deprecated. Use Blacklight::Facets::NoLayoutComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_field_pagination_component.html.erb

@@ -1,10 +1,10 @@
 <div class="prev_next_links btn-group">
   <%= helpers.link_to_previous_page @facet_field.paginator, raw(t('views.pagination.previous')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
-    <%= content_tag :span, raw(t('views.pagination.previous')), class: 'disabled btn' %>
+    <%= content_tag :a, raw(t('views.pagination.previous')), class: 'disabled btn btn-link text-decoration-none', aria: { disabled: true } %>
   <% end %>
 
   <%= helpers.link_to_next_page @facet_field.paginator, raw(t('views.pagination.next')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
-    <%= content_tag :span, raw(t('views.pagination.next')), class: 'disabled btn' %>
+    <%= content_tag :a, raw(t('views.pagination.next')), class: 'disabled btn btn-link text-decoration-none', aria: { disabled: true } %>
   <% end %>
 </div>
 

data/app/components/blacklight/facet_item_component.rb

@@ -1,78 +1,10 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetItemComponent < Blacklight::Component
-    attr_reader :label, :href, :hits
-
-    with_collection_parameter :facet_item
-
-    def initialize(facet_item:, wrapping_element: 'li', suppress_link: false)
-      @facet_item = facet_item
-      @label = facet_item.label
-      @hits = facet_item.hits
-      @href = facet_item.href
-      @selected = facet_item.selected?
-      @wrapping_element = wrapping_element
-      @suppress_link = suppress_link
-    end
-
-    def call
-      # if the downstream app has overridden the helper methods we'd usually call,
-      # use the helpers to preserve compatibility
-      content = if @selected
-                  render_selected_facet_value
-                else
-                  render_facet_value
-                end
-
-      return '' if content.blank?
-      return content unless @wrapping_element
-
-      content_tag @wrapping_element, content
-    end
-
-    ##
-    # Standard display of a facet value in a list. Used in both _facets sidebar
-    # partial and catalog/facet expanded list. Will output facet value name as
-    # a link to add that to your restrictions, with count in parens.
-    #
-    # @return [String]
-    # @private
-    def render_facet_value
-      tag.span(class: "facet-label") do
-        link_to_unless(@suppress_link, label, href, class: "facet-select", rel: "nofollow")
-      end + render_facet_count
-    end
-
-    ##
-    # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
-    # @see #render_facet_value
-    #
-    # @private
-    def render_selected_facet_value
-      tag.span(class: "facet-label") do
-        tag.span(label, class: "selected") +
-          # remove link
-          link_to(href, class: "remove", rel: "nofollow") do
-            render(Blacklight::Icons::RemoveComponent.new(aria_hidden: true)) +
-              tag.span(helpers.t(:'blacklight.search.facets.selected.remove'), class: 'visually-hidden')
-          end
-      end + render_facet_count(classes: ["selected"])
-    end
-
-    ##
-    # Renders a count value for facet limits. Can be over-ridden locally
-    # to change style. And can be called by plugins to get consistent display.
-    #
-    # @param [Hash] options
-    # @option options [Array<String>]  an array of classes to add to count span.
-    # @return [String]
-    # @private
-    def render_facet_count(options = {})
-      return '' if hits.blank?
-
-      classes = (options[:classes] || []) << "facet-count"
-      tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(hits)), class: classes)
+  class FacetItemComponent < Facets::ItemComponent
+    def initialize(...)
+      Rails.logger.warn("Blacklight::FacetItemComponent is deprecated. Use Blacklight::Facets::ItemComponent instead.")
+      super
     end
   end
 end

data/app/components/blacklight/facet_item_pivot_component.rb

@@ -28,7 +28,7 @@ module Blacklight
     end
 
     def call
-      facet = Blacklight::FacetItemComponent.new(facet_item: @facet_item, wrapping_element: nil, suppress_link: @suppress_link)
+      facet = Blacklight::Facets::ItemComponent.new(facet_item: @facet_item, wrapping_element: nil, suppress_link: @suppress_link)
 
       id = "h-#{self.class.mint_id}" if @collapsing && has_items?
 

data/app/components/blacklight/facets/checkboxes_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class CheckboxesComponent < Blacklight::Component
+      def initialize(facet_field:, layout: nil)
+        @facet_field = facet_field
+        @layout = layout == false ? Blacklight::Facets::NoLayoutComponent : Blacklight::Facets::FieldComponent
+      end
+
+      def render?
+        presenters.any?
+      end
+
+      def presenters
+        return [] unless @facet_field.paginator
+
+        return to_enum(:presenters) unless block_given?
+
+        @facet_field.paginator.items.each do |item|
+          yield Blacklight::FacetCheckboxItemPresenter.new(item, @facet_field.facet_field, helpers, @facet_field.key, @facet_field.search_state)
+        end
+      end
+    end
+  end
+end

data/app/components/blacklight/facets/count_component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    # Display count of a facet value
+    class CountComponent < Blacklight::Component
+      def initialize(hits:, classes:)
+        @hits = hits
+        @classes = classes
+      end
+
+      attr_reader :hits, :classes
+
+      def render?
+        hits.present?
+      end
+
+      def call
+        tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(hits)), class: classes)
+      end
+    end
+  end
+end

data/app/components/blacklight/{facet_field_component.html.erb → facets/field_component.html.erb}

@@ -8,7 +8,7 @@
       data-target="#<%= html_id %>"
       data-bs-target="#<%= html_id %>"
       aria-expanded="<%= @facet_field.collapsed? ? 'false' : 'true' %>"
-      arial-controls="<%= html_id %>"
+      aria-controls="<%= html_id %>"
     >
       <%= label %>
     </button>

data/app/components/blacklight/facets/field_component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class FieldComponent < Blacklight::Component
+      renders_one :label
+      renders_one :body
+
+      # @param [Blacklight::FacetFieldPresenter] facet_field
+      def initialize(facet_field:)
+        @facet_field = facet_field
+      end
+
+      def html_id
+        "facet-#{@facet_field.key.parameterize}"
+      end
+
+      def header_html_id
+        "#{html_id}-header"
+      end
+    end
+  end
+end

data/app/components/blacklight/facets/filters_component.html.erb

@@ -0,0 +1,4 @@
+  <div class="<%= classes %>">
+    <%= suggestions %>
+    <%= index_navigation %>
+  </div>

data/app/components/blacklight/facets/filters_component.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Blacklight::Facets
+  class FiltersComponent < Blacklight::Component
+    # @param [Blacklight::FacetFieldPresenter] presenter
+    def initialize(presenter:, classes: 'facet-filters card card-body bg-light p-3 mb-3 border-0',
+                   suggestions_component: Blacklight::Facets::SuggestComponent,
+                   index_navigation_component: Blacklight::Facets::IndexNavigationComponent)
+      @presenter = presenter
+      @classes = classes
+      @suggestions_component = suggestions_component
+      @index_navigation_component = index_navigation_component
+    end
+
+    def facet
+      @presenter.facet_field
+    end
+
+    attr_reader :classes, :presenter, :suggestions_component, :index_navigation_component
+
+    delegate :display_facet, to: :presenter
+
+    def render?
+      facet.suggest != false || render_index_navigation?
+    end
+
+    def render_index_navigation?
+      facet.index_range && display_facet.index?
+    end
+
+    def suggestions
+      render suggestions_component.new(presenter: presenter)
+    end
+
+    def index_navigation
+      render index_navigation_component.new(presenter: presenter)
+    end
+  end
+end

data/app/components/blacklight/{facet_field_inclusive_constraint_component.html.erb → facets/inclusive_constraint_component.html.erb}

@@ -1,6 +1,6 @@
 <div class="inclusive_or card card-body bg-light mb-3">
   <h5><%= t('blacklight.advanced_search.any_of') %></h5>
   <ul class="list-unstyled facet-values">
-    <%= render(Blacklight::FacetItemComponent.with_collection(presenters.to_a)) %>
+    <%= render Blacklight::Facets::ItemComponent.with_collection(presenters.to_a) %>
   </ul>
 </div>

data/app/components/blacklight/facets/inclusive_constraint_component.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class InclusiveConstraintComponent < Blacklight::Component
+      with_collection_parameter :facet_field
+
+      def initialize(facet_field:, values: nil)
+        @facet_field = facet_field
+        @values = values
+      end
+
+      def values
+        @values ||= @facet_field.values.find { |v| v.is_a? Array }
+        @values || []
+      end
+
+      def render?
+        values.present?
+      end
+
+      def presenters
+        return to_enum(:presenters) unless block_given?
+
+        values.each do |item|
+          yield Blacklight::FacetGroupedItemPresenter.new(values, item, @facet_field.facet_field, helpers, @facet_field.key, @facet_field.search_state)
+        end
+      end
+    end
+  end
+end

data/app/components/blacklight/{facet_field_filter_component.html.erb → facets/index_navigation_component.html.erb}

@@ -3,7 +3,7 @@
     <li class="page-item <%= 'active' if prefix.blank? %>">
       <%= link_to t('blacklight.search.facets.all'), clear_facet_prefix_url, data: { blacklight_modal: "preserve" }, class: 'page-link' %>
     </li>
-    <% @facet_field.facet_field.index_range.each do |letter| %>
+    <% index_range.each do |letter| %>
       <li class="page-item <%= 'active' if prefix == letter %>">
         <%= link_to(letter, facet_prefix_url(letter), class: 'page-link', data: { blacklight_modal: "preserve" }) %>
       </li>

data/app/components/blacklight/facets/index_navigation_component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class IndexNavigationComponent < Blacklight::Component
+      # @params [Blacklight::FacetFieldPresenter] presenter
+      def initialize(presenter:)
+        @presenter = presenter
+      end
+
+      def render?
+        index_range && @presenter.display_facet.index?
+      end
+
+      def index_range
+        @presenter.facet_field.index_range
+      end
+
+      def prefix
+        @presenter.paginator.prefix
+      end
+
+      def clear_facet_prefix_url
+        @presenter.paginator.params_for_resort_url('index', @presenter.search_state.to_h.except(@presenter.paginator.request_keys[:prefix]))
+      end
+
+      def facet_prefix_url(letter)
+        @presenter.paginator.params_for_resort_url('index', @presenter.search_state.to_h.merge(@presenter.paginator.request_keys[:prefix] => letter))
+      end
+    end
+  end
+end