blacklight 7.11.1 → 7.12.0

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

@@ -0,0 +1,12 @@
+<nav class="alpha-filter">
+  <ol class="pagination pagination-sm justify-content-center">
+    <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| %>
+      <li class="page-item <%= 'active' if prefix == letter %>">
+        <%= link_to(letter, facet_prefix_url(letter), class: 'page-link', data: { blacklight_modal: "preserve" }) %>
+      </li>
+    <% end %>
+  </ol>
+</nav>

data/app/components/blacklight/facet_field_filter_component.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldFilterComponent < ::ViewComponent::Base
+    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))
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+<div class="prev_next_links btn-group">
+  <%= 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' %>
+  <% end %>
+
+  <%= 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' %>
+  <% end %>
+</div>
+
+<div class="sort-options btn-group">
+  <% if @facet_field.paginator.sort == 'index' -%>
+    <span class="active az btn btn-outline-secondary"><%= t('blacklight.search.facets.sort.index') %></span>
+    <%= link_to(t('blacklight.search.facets.sort.count'), sort_facet_url('count'), class: "sort_change numeric btn btn-outline-secondary", data: { blacklight_modal: "preserve" }) %>
+  <% elsif @facet_field.paginator.sort == 'count' -%>
+    <%=  link_to(t('blacklight.search.facets.sort.index'), sort_facet_url('index'), class: "sort_change az btn btn-outline-secondary",  data: { blacklight_modal: "preserve" }) %>
+    <span class="active numeric btn btn-outline-secondary"><%= t('blacklight.search.facets.sort.count') %></span>
+  <% end -%>
+</div>

data/app/components/blacklight/facet_field_pagination_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetFieldPaginationComponent < ::ViewComponent::Base
+    def initialize(facet_field:)
+      @facet_field = facet_field
+    end
+
+    def render?
+      @facet_field.facet_field.index_range&.any?
+    end
+
+    def sort_facet_url(sort)
+      @facet_field.paginator.params_for_resort_url(sort, @facet_fieldsearch_state.to_h)
+    end
+
+    def param_name
+      @facet_field.paginator.class.request_keys[:page]
+    end
+  end
+end

data/app/components/blacklight/facet_item_component.rb

@@ -2,6 +2,8 @@
 
 module Blacklight
   class FacetItemComponent < ::ViewComponent::Base
+    extend Deprecation
+
     with_collection_parameter :facet_item
 
     def initialize(facet_item:, wrapping_element: 'li', suppress_link: false)
@@ -55,7 +57,7 @@ module Blacklight
     # @deprecated
     # @private
     def content_from_legacy_view_helper
-      Deprecation.warn('Calling out to the #render_facet_item helper for backwards compatibility.')
+      Deprecation.warn(self.class, 'Calling out to the #render_facet_item helper for backwards compatibility.')
       Deprecation.silence(Blacklight::FacetsHelperBehavior) do
         @view_context.render_facet_item(@facet_item.facet_field, @facet_item.facet_item)
       end
@@ -66,10 +68,6 @@ module Blacklight
     # partial and catalog/facet expanded list. Will output facet value name as
     # a link to add that to your restrictions, with count in parens.
     #
-    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-    # @param [Blacklight::Solr::Response::Facets::FacetItem] item
-    # @param [Hash] options
-    # @option options [Boolean] :suppress_link display the facet, but don't link to it
     # @return [String]
     # @private
     def render_facet_value
@@ -81,8 +79,7 @@ module Blacklight
     ##
     # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
     # @see #render_facet_value
-    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
-    # @param [String] item
+    #
     # @private
     def render_selected_facet_value
       tag.span(class: "facet-label") do
@@ -99,7 +96,6 @@ module Blacklight
     # 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 [Integer] num number of facet results
     # @param [Hash] options
     # @option options [Array<String>]  an array of classes to add to count span.
     # @return [String]

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

@@ -20,6 +20,8 @@
   </div>
 
   <%= content_tag :div, id: @panel_id, class: 'facets-collapse collapse' do %>
-    <%= @view_context.render_facet_partials @fields, response: @response %>
+    <% Deprecation.silence(Blacklight::FacetsHelperBehavior) do %>
+      <%= @view_context.render_facet_partials @fields, response: @response %>
+    <% end %>
   <% end %>
 <% end %>

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

@@ -2,7 +2,12 @@
 
 module Blacklight
   module Response
+    # Render a group of facet fields
     class FacetGroupComponent < ::ViewComponent::Base
+      # @param [Blacklight::Response] response
+      # @param [Array<String>] fields facet fields to render
+      # @param [String] title the title of the facet group section
+      # @param [String] id a unique identifier for the group
       def initialize(response:, fields: [], title: nil, id: nil)
         @response = response
         @fields = fields
@@ -12,7 +17,9 @@ module Blacklight
       end
 
       def render?
-        @view_context.has_facet_values?(@fields, @response)
+        Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+          @view_context.has_facet_values?(@fields, @response)
+        end
       end
     end
   end

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

@@ -2,7 +2,10 @@
 
 module Blacklight
   module Response
+    # Render a pagination widget for search results
     class PaginationComponent < ::ViewComponent::Base
+      # @param [Blacklight::Response] response
+      # @param [Hash] html html options for the pagination container
       def initialize(response:, html: {}, **pagination_args)
         @response = response
         @html_attr = { aria: { label: t('views.pagination.aria.container_label') } }.merge(html)

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

@@ -1,4 +1,4 @@
-<%= render(Blacklight::System::DropdownComponent.new(
+<%= @view_context.render(Blacklight::System::DropdownComponent.new(
       param: @param,
       choices: @choices,
       id: @id,

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

@@ -2,18 +2,25 @@
 
 module Blacklight
   module Response
+    # Render spellcheck results for a search query
     class SpellcheckComponent < ViewComponent::Base
+      # @param [Blacklight::Response] response
+      # @param [Array<String>] options explicit spellcheck options to render
       def initialize(response:, options: nil)
         @response = response
         @options = options || @response&.spelling&.words
       end
 
       def link_to_query(query)
-        @view_context.link_to_query(query)
+        Deprecation.silence(Blacklight::UrlHelperBehavior) do
+          @view_context.link_to_query(query)
+        end
       end
 
       def render?
-        @options.any? && @view_context.should_show_spellcheck_suggestions?(@response)
+        Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
+          @options.any? && @view_context.should_show_spellcheck_suggestions?(@response)
+        end
       end
     end
   end

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

@@ -0,0 +1,11 @@
+<div class="view-type">
+  <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
+  <div class="view-type-group btn-group">
+    <% @views.each do |view, config| %>
+      <%= link_to url(view), title: label(view), class: "btn btn-outline-secondary btn-icon view-type-#{ view.to_s.parameterize } #{"active" if @selected == view}" do %>
+        <%= icon(view) %>
+        <span class="caption"><%= label(view) %></span>
+      <% end %>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Response
+    # Render spellcheck results for a search query
+    class ViewTypeComponent < ViewComponent::Base
+      # @param [Blacklight::Response] response
+      def initialize(response:, views: {}, search_state:, selected: nil)
+        @response = response
+        @views = views
+        @search_state = search_state
+        @selected = selected
+      end
+
+      def render?
+        Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+          @view_context.has_alternative_views?
+        end
+      end
+
+      def icon(view)
+        @view_context.render_view_type_group_icon(view)
+      end
+
+      def label(view)
+        Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+          @view_context.view_label(view)
+        end
+      end
+
+      def url(view)
+        @view_context.url_for(@search_state.to_h.merge(view: view))
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@
     <% end %>
 
     <label for="<%= @prefix %>q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
-    <%= text_field_tag :q, @q, placeholder: t('blacklight.search.form.search.placeholder'), class: "search-q q form-control rounded-#{@search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: @autocomplete_path.present? ? "off" : "", autofocus: @autofocus, data: { autocomplete_enabled: @autocomplete_path.present?, autocomplete_path: @autocomplete_path }  %>
+    <%= text_field_tag :q, @q, placeholder: t('blacklight.search.form.search.placeholder'), class: "search-q q form-control rounded-#{@search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
 
     <%= content %>
 

data/app/components/blacklight/search_bar_component.rb

@@ -41,5 +41,11 @@ module Blacklight
     def blacklight_config
       @view_context.blacklight_config
     end
+
+    def render_hash_as_hidden_fields(*args)
+      Deprecation.silence(Blacklight::HashAsHiddenFieldsHelperBehavior) do
+        @view_context.render_hash_as_hidden_fields(*args)
+      end
+    end
   end
 end

data/app/components/blacklight/search_context_component.rb

@@ -20,11 +20,15 @@ module Blacklight
     end
 
     def link_to_previous_document(*args)
-      @view_context.link_to_previous_document(*args)
+      Deprecation.silence(Blacklight::UrlHelperBehavior) do
+        @view_context.link_to_previous_document(*args)
+      end
     end
 
     def link_to_next_document(*args)
-      @view_context.link_to_next_document(*args)
+      Deprecation.silence(Blacklight::UrlHelperBehavior) do
+        @view_context.link_to_next_document(*args)
+      end
     end
   end
 end

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

@@ -6,7 +6,7 @@
   <div class="dropdown-menu" role="menu">
     <%- @choices.each do |option| %>
       <% text, value = option_text_and_value(option) %>
-      <%= link_to(text, url_for(@search_state.params_for_search(@param => value)), class: 'dropdown-item', role: 'menuitem') %>
+      <%= link_to(text, @view_context.url_for(@search_state.params_for_search(@param => value)), class: 'dropdown-item', role: 'menuitem') %>
     <%- end -%>
   </div>
 <% end %>

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

@@ -0,0 +1,4 @@
+<div class="alert <%= @classes %>">
+  <%= @message %>
+  <a class="close" data-dismiss="alert" href="#">&times;</a>
+</div>

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module System
+    class FlashMessageComponent < ViewComponent::Base
+      with_collection_parameter :message
+
+      def initialize(message:, type:)
+        @message = message
+        @classes = alert_class(type)
+      end
+
+      def alert_class(type)
+        case type.to_s
+        when 'success' then "alert-success"
+        when 'notice'  then "alert-info"
+        when 'alert'   then "alert-warning"
+        when 'error'   then "alert-danger"
+        else "alert-#{type}"
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,8 @@ module Blacklight::Catalog
   include Blacklight::Facet
   include Blacklight::Searchable
 
+  extend Deprecation
+
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do
@@ -85,7 +87,9 @@ module Blacklight::Catalog
 
     @response = search_service.facet_field_response(@facet.key)
     @display_facet = @response.aggregations[@facet.field]
-    @pagination = facet_paginator(@facet, @display_facet)
+
+    @presenter = (@facet.presenter || Blacklight::FacetFieldPresenter).new(@facet, @display_facet, view_context)
+    @pagination = @presenter.paginator
     respond_to do |format|
       format.html do
         # Draw the partial for the "more" facet modal window:
@@ -132,6 +136,7 @@ module Blacklight::Catalog
     params[:q].present? || params[:f].present? || params[:search_field].present?
   end
 
+  # TODO: deprecate this constant with #facet_limit_for
   DEFAULT_FACET_LIMIT = 10
 
   # Look up facet limit for given facet_field. Will look at config, and
@@ -158,6 +163,7 @@ module Blacklight::Catalog
       facet.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
     end
   end
+  deprecation_deprecate facet_limit_for: 'moving to private logic in Blacklight::FacetFieldPresenter'
 
   private
 

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

@@ -21,18 +21,21 @@ module Blacklight::Controller
 
       # extra head content
       helper_method :has_user_authentication_provider?
-      helper_method :blacklight_config, :blacklight_configuration_context
-      helper_method :search_action_url, :search_action_path, :search_facet_path
-      helper_method :search_state
+      helper_method :blacklight_config, :blacklight_configuration_context # move to Catalog
+      helper_method :search_action_url, :search_action_path
+      helper_method :search_facet_path # move to catalog? deprecate?
+      helper_method :search_state # move to catalog?
     end
 
     # Which class to use for the search state. You can subclass SearchState if you
     # want to override any of the methods (e.g. SearchState#url_for_document)
+    # TODO: move to Searchable
     class_attribute :search_state_class
     self.search_state_class = Blacklight::SearchState
 
     # Which class to use for the search service. You can subclass SearchService if you
     # want to override any of the methods (e.g. SearchService#fetch)
+    # TODO: move to Searchable
     class_attribute :search_service_class
     self.search_service_class = Blacklight::SearchService
 
@@ -42,6 +45,7 @@ module Blacklight::Controller
     set_callback :logging_in_user, :before, :transfer_guest_user_actions_to_current_user
   end
 
+  # @private
   def default_catalog_controller
     CatalogController
   end
@@ -52,6 +56,7 @@ module Blacklight::Controller
 
   ##
   # Context in which to evaluate blacklight configuration conditionals
+  # TODO: move to catalog?
   def blacklight_configuration_context
     @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(self)
   end
@@ -64,6 +69,7 @@ module Blacklight::Controller
   end
 
   # @return [Blacklight::SearchState] a memoized instance of the parameter state.
+  # TODO: move to catalog?
   def search_state
     @search_state ||= search_state_class.new(params, blacklight_config, self)
   end
@@ -84,6 +90,7 @@ module Blacklight::Controller
     search_action_url(*args)
   end
 
+  # TODO: move to catalog? deprecate?
   def search_facet_path(options = {})
     opts = search_state
            .to_h
@@ -94,6 +101,7 @@ module Blacklight::Controller
   end
 
   # Returns a list of Searches from the ids in the user's history.
+  # TODO: move to catalog? SearchHistory?
   def searches_from_history
     session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
   end
@@ -124,6 +132,7 @@ module Blacklight::Controller
   def require_user_authentication_provider
     raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
   end
+  deprecation_deprecate require_user_authentication_provider: 'removed without replacement'
 
   ##
   # When a user logs in, transfer any saved searches or bookmarks to the current_user