blacklight 6.5.0 → 6.6.0

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

@@ -8,7 +8,6 @@ module Blacklight::TokenBasedUser
     rescue_from Blacklight::Exceptions::ExpiredSessionToken do
       head :unauthorized
     end
-
   end
 
   protected
@@ -49,5 +48,4 @@ module Blacklight::TokenBasedUser
   def message_encryptor
     ActiveSupport::MessageEncryptor.new(export_secret_token)
   end
-
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -36,8 +36,8 @@ module Blacklight::BlacklightHelperBehavior
   #
   # Returns empty string if no links available.
   #
-  # @params [SolrDocument] document
-  # @params [Hash] options
+  # @param [SolrDocument] document
+  # @param [Hash] options
   # @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
@@ -122,13 +122,13 @@ module Blacklight::BlacklightHelperBehavior
   # @overload render_index_field_label(options)
   #   Use the default, document-agnostic configuration
   #   @param [Hash] opts
-  #   @options opts [String] :field
+  #   @option opts [String] :field
   # @overload render_index_field_label(document, options)
   #   Allow an extention point where information in the document
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field
+  #   @option opts [String] :field
   def render_index_field_label *args
     options = args.extract_options!
     document = args.first
@@ -143,23 +143,23 @@ module Blacklight::BlacklightHelperBehavior
   # @overload render_index_field_value(options)
   #   Use the default, document-agnostic configuration
   #   @param [Hash] opts
-  #   @options opts [String] :field
-  #   @options opts [String] :value
-  #   @options opts [String] :document
+  #   @option opts [String] :field
+  #   @option opts [String] :value
+  #   @option opts [String] :document
   # @overload render_index_field_value(document, options)
   #   Allow an extention point where information in the document
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field
-  #   @options opts [String] :value
+  #   @option opts [String] :field
+  #   @option opts [String] :value
   # @overload render_index_field_value(document, field, options)
   #   Allow an extention point where information in the document
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [String] field
   #   @param [Hash] opts
-  #   @options opts [String] :value
+  #   @option opts [String] :value
   # @deprecated use IndexPresenter#field_value
   def render_index_field_value *args
     render_field_value(*args)
@@ -182,13 +182,13 @@ module Blacklight::BlacklightHelperBehavior
   # @overload render_document_show_field_label(options)
   #   Use the default, document-agnostic configuration
   #   @param [Hash] opts
-  #   @options opts [String] :field
+  #   @option opts [String] :field
   # @overload render_document_show_field_label(document, options)
   #   Allow an extention point where information in the document
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field
+  #   @option opts [String] :field
   def render_document_show_field_label *args
     options = args.extract_options!
     document = args.first
@@ -204,30 +204,29 @@ module Blacklight::BlacklightHelperBehavior
   # @overload render_document_show_field_value(options)
   #   Use the default, document-agnostic configuration
   #   @param [Hash] opts
-  #   @options opts [String] :field
-  #   @options opts [String] :value
-  #   @options opts [String] :document
+  #   @option opts [String] :field
+  #   @option opts [String] :value
+  #   @option opts [String] :document
   # @overload render_document_show_field_value(document, options)
   #   Allow an extention point where information in the document
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [Hash] opts
-  #   @options opts [String] :field
-  #   @options opts [String] :value
+  #   @option opts [String] :field
+  #   @option opts [String] :value
   # @overload render_document_show_field_value(document, field, options)
   #   Allow an extention point where information in the document
   #   may drive the value of the field
   #   @param [SolrDocument] doc
   #   @param [String] field
   #   @param [Hash] opts
-  #   @options opts [String] :value
+  #   @option opts [String] :value
   # @deprecated use ShowPresenter#field_value
   def render_document_show_field_value *args
     render_field_value(*args)
   end
   deprecation_deprecate render_document_show_field_value: 'replaced by ShowPresenter#field_value'
 
-
   ##
   # Get the value of the document's "title" field, or a placeholder
   # value (if empty)
@@ -255,12 +254,12 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # Render the document "heading" (title) in a content tag
   # @overload render_document_heading(document, options)
-  #   @params [SolrDocument] document
-  #   @params [Hash] options
-  #   @options options [Symbol] :tag
+  #   @param [SolrDocument] document
+  #   @param [Hash] options
+  #   @option options [Symbol] :tag
   # @overload render_document_heading(options)
-  #   @params [Hash] options
-  #   @options options [Symbol] :tag
+  #   @param [Hash] options
+  #   @option options [Symbol] :tag
   def render_document_heading(*args)
     options = args.extract_options!
     document = args.first
@@ -280,8 +279,8 @@ module Blacklight::BlacklightHelperBehavior
   #   - helper_method
   #   - link_to_search
   # @param [SolrDocument] document
-  # @param [String] field name
-  # @param [Blacklight::Configuration::Field] solr field configuration
+  # @param [String] _field name
+  # @param [Blacklight::Configuration::Field] field_config solr field configuration
   # @param [Hash] options additional options to pass to the rendering helpers
   def get_field_values document, _field, field_config, options = {}
     presenter(document).field_values field_config, options
@@ -291,7 +290,7 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # Get the current "view type" (and ensure it is a valid type)
   #
-  # @param [Hash] the query parameters to check
+  # @param [Hash] query_params the query parameters to check
   # @return [Symbol]
   def document_index_view_type query_params=params
     view_param = query_params[:view]
@@ -324,7 +323,7 @@ module Blacklight::BlacklightHelperBehavior
   # Should we render a grouped response (because the response
   # contains a grouped response instead of the normal response)
   def render_grouped_response? response = @response
-    return response.grouped?
+    response.grouped?
   end
 
   ##

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 module Blacklight::CatalogHelperBehavior
-
   # @param [Hash] options 
   # @option options :route_set the route scope to use when constructing the link
   def rss_feed_link_tag(options = {})
@@ -18,7 +17,7 @@ module Blacklight::CatalogHelperBehavior
   # implementation.
   # Displays the "showing X through Y of N" message.
   #
-  # @param [RSolr::Resource] (or other Kaminari-compatible objects)
+  # @param [RSolr::Resource] collection (or other Kaminari-compatible objects)
   # @return [String]
   def page_entries_info(collection, options = {})
     return unless show_pagination? collection
@@ -67,7 +66,8 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Get the offset counter for a document
   #
-  # @param [Integer] document index
+  # @param [Integer] idx document index
+  # @param [Integer] offset additional offset to incremenet the counter by
   # @return [Integer]
   def document_counter_with_offset idx, offset = nil
     offset ||= @response.start if @response
@@ -134,7 +134,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Render the sidebar partial for a document
   #
-  # @param [SolrDocument]
+  # @param [SolrDocument] document
   # @return [String]
   def render_document_sidebar_partial(document = @document)
     render :partial => 'show_sidebar'
@@ -143,7 +143,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Render the main content partial for a document
   #
-  # @param [SolrDocument]
+  # @param [SolrDocument] document
   # @return [String]
   def render_document_main_content_partial(document = @document)
     render partial: 'show_main_content'
@@ -152,7 +152,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Should we display the sort and per page widget?
   # 
-  # @param [Blacklight::Solr::Response]
+  # @param [Blacklight::Solr::Response] response
   # @return [Boolean]
   def show_sort_and_per_page? response = nil
     response ||= @response
@@ -162,7 +162,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Should we display the pagination controls?
   #
-  # @param [Blacklight::Solr::Response]
+  # @param [Blacklight::Solr::Response] response
   # @return [Boolean]
   def show_pagination? response = nil
     response ||= @response
@@ -183,7 +183,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Does the document have a thumbnail to render?
   # 
-  # @param [SolrDocument]
+  # @param [SolrDocument] document
   # @return [Boolean]
   def has_thumbnail? document
     blacklight_config.view_config(document_index_view_type).thumbnail_method.present? or
@@ -194,9 +194,9 @@ module Blacklight::CatalogHelperBehavior
   # Render the thumbnail, if available, for a document and
   # link it to the document record.
   # 
-  # @param [SolrDocument]
-  # @param [Hash] options to pass to the image tag
-  # @param [Hash] url options to pass to #link_to_document
+  # @param [SolrDocument] document
+  # @param [Hash] image_options to pass to the image tag
+  # @param [Hash] url_options to pass to #link_to_document
   # @return [String]
   def render_thumbnail_tag document, image_options = {}, url_options = {}
     value = if blacklight_config.view_config(document_index_view_type).thumbnail_method
@@ -208,7 +208,7 @@ module Blacklight::CatalogHelperBehavior
     end
 
     if value
-      if url_options === false || url_options[:suppress_link]
+      if url_options == false || url_options[:suppress_link]
         value
       else
         link_to_document document, value, url_options
@@ -219,7 +219,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Get the URL to a document's thumbnail image
   # 
-  # @param [SolrDocument]
+  # @param [SolrDocument] document
   # @return [String]
   def thumbnail_url document
     if document.has? blacklight_config.view_config(document_index_view_type).thumbnail_field
@@ -230,7 +230,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Render the view type icon for the results view picker
   # 
-  # @param [String]
+  # @param [String] view
   # @return [String]
   def render_view_type_group_icon view
     content_tag :span, '', class: "glyphicon #{blacklight_config.view[view].icon_class || default_view_type_group_icon_classes(view)}"
@@ -239,7 +239,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Get the default view type classes for a view in the results view picker
   #
-  # @param [String]
+  # @param [String] view
   # @return [String]
   def default_view_type_group_icon_classes view
     "glyphicon-#{view.to_s.parameterize} view-icon-#{view.to_s.parameterize}"

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 module Blacklight
   module ComponentHelperBehavior
-
     def document_action_label action, opts
       t("blacklight.tools.#{action}", default: opts.label || action.to_s.humanize)
     end
 
     def document_action_path action_opts, url_opts = nil
-      case
-      when action_opts.path
+      if action_opts.path
         self.send(action_opts.path, url_opts)
-      when url_opts[:id].class.respond_to?(:model_name)
+      elsif url_opts[:id].class.respond_to?(:model_name)
         url_for([action_opts.key, url_opts[:id]])
       else
         self.send("#{action_opts.key}_#{controller_name}_path", url_opts)
@@ -80,6 +78,5 @@ module Blacklight
     def render_show_doc_actions(document=@document, options={}, &block)
       render_filtered_partials(blacklight_config.show.document_actions, { document: document }.merge(options), &block)
     end
-
   end
 end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 module Blacklight::ConfigurationHelperBehavior
-
   ##
   # Index fields to display for a type of document
   # 
@@ -42,7 +41,7 @@ module Blacklight::ConfigurationHelperBehavior
   # Return a label for the currently selected search field.
   # If no "search_field" or the default (e.g. "all_fields") is selected, then return nil
   # Otherwise grab the label of the selected search field.
-  # @param [Hash] query parameters
+  # @param [Hash] localized_params query parameters
   # @return [String]
   def constraint_query_label(localized_params = params)
     label_for_search_field(localized_params[:search_field]) unless default_search_field?(localized_params[:search_field])
@@ -50,7 +49,7 @@ module Blacklight::ConfigurationHelperBehavior
 
   ##
   # Is the search form using the default search field ("all_fields" by default)?
-  # @param [String] the currently selected search_field
+  # @param [String] selected_search_field the currently selected search_field
   # @return [Boolean]
   def default_search_field?(selected_search_field)
     selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])

data/app/helpers/blacklight/deprecated_url_helper_behavior.rb

@@ -51,9 +51,7 @@ module Blacklight
     end
     deprecation_deprecate :remove_facet_params
 
-    def add_facet_params_and_redirect(field, item)
-      search_state.add_facet_params_and_redirect(field, item)
-    end
+    delegate :add_facet_params_and_redirect, to: :search_state
     deprecation_deprecate :add_facet_params_and_redirect
   end
 end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -5,7 +5,7 @@ module Blacklight::FacetsHelperBehavior
   ##
   # Check if any of the given fields have values
   #
-  # @param [Array<String>]
+  # @param [Array<String>] fields
   # @param [Hash] options
   # @return [Boolean]
   def has_facet_values? fields = facet_field_names, options = {}
@@ -16,7 +16,7 @@ module Blacklight::FacetsHelperBehavior
   # Render a collection of facet fields.
   # @see #render_facet_limit 
   # 
-  # @param [Array<String>]
+  # @param [Array<String>] fields
   # @param [Hash] options
   # @return String
   def render_facet_partials fields = facet_field_names, options = {}
@@ -25,7 +25,6 @@ module Blacklight::FacetsHelperBehavior
     end.compact, "\n")
   end
 
-
   ##
   # Renders a single section for facet limit with a specified
   # solr field used for faceting. Can be over-ridden for custom
@@ -56,10 +55,7 @@ module Blacklight::FacetsHelperBehavior
   # removes any elements where render_facet_item returns a nil value. This enables an application
   # to filter undesireable facet items so they don't appear in the UI
   def render_facet_limit_list(paginator, facet_field, wrapping_element=:li)
-    safe_join(paginator.items.
-      map { |item| render_facet_item(facet_field, item) }.compact.
-      map { |item| content_tag(wrapping_element,item)}
-    )
+    safe_join(paginator.items.map { |item| render_facet_item(facet_field, item) }.compact.map { |item| content_tag(wrapping_element,item)})
   end
 
   ##
@@ -83,7 +79,7 @@ module Blacklight::FacetsHelperBehavior
     # display when show is nil or true
     facet_config = facet_configuration_for_field(display_facet.name)
     display = should_render_field?(facet_config, display_facet)
-    return display && display_facet.items.present?
+    display && display_facet.items.present?
   end
 
   ##
@@ -92,7 +88,7 @@ module Blacklight::FacetsHelperBehavior
   #   - if the facet is configured to collapse (the default), collapse
   #   - if the facet is configured not to collapse, don't collapse
   # 
-  # @param [Blacklight::Configuration::FacetField]
+  # @param [Blacklight::Configuration::FacetField] facet_field
   # @return [Boolean]
   def should_collapse_facet? facet_field
     !facet_field_in_params?(facet_field.field) && facet_field.collapse
@@ -117,8 +113,8 @@ module Blacklight::FacetsHelperBehavior
   # 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]
-  # @param [String] facet item
+  # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+  # @param [String] item
   # @param [Hash] options
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
   # @return [String]
@@ -131,8 +127,8 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Where should this facet link to?
-  # @param [Blacklight::Solr::Response::Facets::FacetField]
-  # @param [String] facet item
+  # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+  # @param [String] item
   # @return [String]
   def path_for_facet(facet_field, item)
     facet_config = facet_configuration_for_field(facet_field)
@@ -145,7 +141,9 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
-  # @params (see #render_facet_value)
+  # @see #render_facet_value
+  # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+  # @param [String] item
   def render_selected_facet_value(facet_field, item)
     remove_href = search_action_path(search_state.remove_facet_params(facet_field, item))
     content_tag(:span, class: "facet-label") do
@@ -162,7 +160,7 @@ module Blacklight::FacetsHelperBehavior
   # 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] number of facet results
+  # @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]
@@ -174,7 +172,7 @@ module Blacklight::FacetsHelperBehavior
   ##
   # Are any facet restrictions for a field in the query parameters?
   # 
-  # @param [String] facet field
+  # @param [String] field
   # @return [Boolean]
   def facet_field_in_params? field
     !facet_params(field).blank?
@@ -184,8 +182,8 @@ module Blacklight::FacetsHelperBehavior
   # Check if the query parameters have the given facet field with the 
   # given value.
   # 
-  # @param [Object] facet field
-  # @param [Object] facet value
+  # @param [Object] field
+  # @param [Object] item facet value
   # @return [Boolean]
   def facet_in_params?(field, item)
     value = facet_value_for_facet_item(item)
@@ -216,14 +214,13 @@ module Blacklight::FacetsHelperBehavior
       facet_value_for_facet_item(item)
     end
 
-    case
-    when facet_config.helper_method
+    if facet_config.helper_method
       send facet_config.helper_method, value
-    when (facet_config.query and facet_config.query[value])
+    elsif facet_config.query && facet_config.query[value]
       facet_config.query[value][:label]
-    when facet_config.date
-      localization_options = {}
-      localization_options = facet_config.date unless facet_config.date === true
+    elsif facet_config.date
+      localization_options = facet_config.date == true ? {} : facet_config.date
+
       l(value.to_datetime, localization_options)
     else
       value
@@ -243,5 +240,4 @@ module Blacklight::FacetsHelperBehavior
       item
     end
   end
-
 end