blacklight 9.0.0.beta1 → 9.0.0.beta2

data/app/components/blacklight/facet_field_no_layout_component.rb

@@ -1,14 +1,6 @@
 # frozen_string_literal: true
 
 module Blacklight
-  class FacetFieldNoLayoutComponent < Blacklight::Component
-    renders_one :label
-    renders_one :body
-
-    def initialize(**); end
-
-    def call
-      body.to_s
-    end
-  end
+  class FacetFieldNoLayoutComponent < Facets::NoLayoutComponent; end
+  FacetFieldNoLayoutComponent = ActiveSupport::Deprecation::DeprecatedConstantProxy.new("FacetFieldNoLayoutComponent", "Blacklight::Facets::NoLayoutComponent", ActiveSupport::Deprecation.new)
 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,6 @@
 # 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)
-    end
-  end
+  class FacetItemComponent < Facets::ItemComponent; end
+  FacetItemComponent = ActiveSupport::Deprecation::DeprecatedConstantProxy.new("FacetItemComponent", "Blacklight::Facets::ItemComponent", ActiveSupport::Deprecation.new)
 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 %>">
+    <%= render Blacklight::Facets::SuggestComponent.new(presenter: presenter) %>
+    <%= render Blacklight::Facets::IndexNavigationComponent.new(presenter: presenter) %>
+  </div>

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

@@ -0,0 +1,27 @@
+# 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')
+      @presenter = presenter
+      @classes = classes
+    end
+
+    def facet
+      @presenter.facet_field
+    end
+
+    attr_reader :classes, :presenter
+
+    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
+  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

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class ItemComponent < 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
+        concat render(Blacklight::Facets::SelectedValueComponent.new(label: label, href: href))
+        concat 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 = {})
+        classes = (options[:classes] || []) << "facet-count"
+
+        render Blacklight::Facets::CountComponent.new(hits: hits, classes: classes)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+<%= render(@layout.new(facet_field: @facet_field)) do |component| %>
+  <% component.with_label do %>
+    <%= @facet_field.label %>
+  <% end %>
+  <% component.with_body do %>
+    <%= render(Blacklight::Facets::InclusiveConstraintComponent.new(facet_field: @facet_field)) %>
+    <ul class="facet-values list-unstyled">
+      <%= render facet_items %>
+    </ul>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class ListComponent < Blacklight::Component
+      def initialize(facet_field:, layout: nil)
+        @facet_field = facet_field
+        @layout = layout == false ? Blacklight::Facets::NoLayoutComponent : Blacklight::Facets::FieldComponent
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class NoLayoutComponent < Blacklight::Component
+      renders_one :label
+      renders_one :body
+
+      def initialize(**); end
+
+      def call
+        body.to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    # Standard display of a selected facet value (e.g. without a link and with a remove button)
+    class SelectedValueComponent < Blacklight::Component
+      def initialize(label:, href:)
+        @label = label
+        @href = href
+        super
+      end
+
+      attr_reader :label, :href
+
+      def call
+        tag.span(class: "facet-label") do
+          tag.span(label, class: "selected") + remove_link
+        end
+      end
+
+      def remove_link
+        link_to(href, class: "remove ps-2", rel: "nofollow") do
+          render(Blacklight::Icons::RemoveComponent.new(aria_hidden: true)) +
+            tag.span(t(:'blacklight.search.facets.selected.remove'), class: 'visually-hidden')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+<label for="facet_suggest_<%= key %>">
+  <%= I18n.t('blacklight.search.facets.suggest.label', field_label: label) %>
+</label>
+<%= text_field_tag "facet_suggest_#{key}",
+  nil,
+  class: "facet-suggest form-control mb-3",
+  data: {
+    facet_field: key,
+    facet_search_context: helpers.search_facet_path(id: key)
+  },
+  placeholder: I18n.t('blacklight.search.form.search.placeholder')
+%>

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Facets
+    class SuggestComponent < Blacklight::Component
+      def initialize(presenter:)
+        @presenter = presenter
+      end
+
+      private
+
+      attr_accessor :presenter
+
+      delegate :suggest, :key, :label, to: :presenter
+
+      def render?
+        # Draw if suggest is true or not present
+        suggest != false
+      end
+    end
+  end
+end

data/app/components/blacklight/metadata_field_plain_text_layout_component.rb

@@ -4,8 +4,8 @@ module Blacklight
   class MetadataFieldPlainTextLayoutComponent < Blacklight::MetadataFieldLayoutComponent
     with_collection_parameter :field
 
-    def initialize(field:, **kwargs)
-      super(field: field, **kwargs, value_tag: nil)
+    def initialize(field:, **)
+      super(field: field, **, value_tag: nil)
     end
 
     # rubocop:disable Rails/OutputSafety

data/app/components/blacklight/response/facet_group_component.html.erb

@@ -6,7 +6,7 @@
     <%= collapse_toggle_button(@panel_id) %>
   </div>
 
-  <div id="<%= @panel_id %>" class="facets-collapse d-lg-block collapse accordion">
+  <div id="<%= @panel_id %>" class="<%= body_classes %>">
     <%= body %>
   </div>
 <% end %>

data/app/components/blacklight/response/facet_group_component.rb

@@ -8,13 +8,16 @@ module Blacklight
 
       # @param [String] id a unique identifier for the group
       # @param [String] title the title of the facet group section
-      def initialize(id:, title: nil)
+      def initialize(id:, title: nil, body_classes: 'facets-collapse d-lg-block collapse accordion')
         @groupname = id
         @id = id ? "facets-#{id}" : 'facets'
         @title = title || I18n.t("blacklight.search.#{@id}.title")
         @panel_id = id ? "facet-panel-#{id}-collapse" : 'facet-panel-collapse'
+        @body_classes = body_classes
       end
 
+      attr_accessor :body_classes
+
       def collapse_toggle_button(panel_id)
         render button_component.new(panel_id: panel_id)
       end
@@ -24,6 +27,7 @@ module Blacklight
       end
 
       def render?
+        # debugger
         body.present?
       end
     end

data/app/components/blacklight/system/dropdown_component.html.erb

@@ -1,7 +1,7 @@
 <%= content_tag :div, id: @id, class: @classes.join(' ') do %>
   <%= button %>
 
-  <div class="dropdown-menu" role="menu">
+  <div class="dropdown-menu">
     <% options.each do |option| %>
       <%= option %>
     <% end %>

data/app/components/blacklight/system/dropdown_component.rb

@@ -6,7 +6,7 @@ module Blacklight
       renders_one :button, DropdownButtonComponent
 
       renders_many :options, (lambda do |text:, url:, selected: false|
-        link_to(text, url, class: "dropdown-item #{'active' if selected}", role: 'menuitem', aria: { current: ('page' if selected) })
+        link_to(text, url, class: "dropdown-item #{'active' if selected}", aria: { current: ('page' if selected) })
       end)
 
       # rubocop:disable Metrics/ParameterLists

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

@@ -1,4 +1,4 @@
-<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" aria-label="<%= aria_label %>">
+<nav class="navbar navbar-expand-md bg-dark topbar" aria-label="<%= aria_label %>">
   <div class="<%= container_classes %>">
     <%= logo_link %>
     <button class="navbar-toggler" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -36,8 +36,8 @@ module Blacklight::Bookmarks
 
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
-  def search_action_url *args
-    search_catalog_url(*args)
+  def search_action_url(*)
+    search_catalog_url(*)
   end
 
   # @return [Hash] a hash of context information to pass through to the search service
@@ -110,7 +110,7 @@ module Blacklight::Bookmarks
 
     success = @bookmarks.all? do |bookmark|
       bookmark = current_or_guest_user.bookmarks.find_by(bookmark)
-      bookmark && bookmark.delete && bookmark.destroyed?
+      bookmark&.delete && bookmark.destroyed?
     end
 
     if success