blacklight 6.5.0 → 6.6.0

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -10,12 +10,11 @@
 # This is used to serialize a complete current query from current params
 # to form fields used for sort and change per-page
 module Blacklight::HashAsHiddenFieldsHelperBehavior
-
   ##
   # Writes out zero or more <input type="hidden"> elements, completely
   # representing a hash passed in using Rails-style request parameters
   # for hashes nested with arrays and other hashes.
-  # @param [Hash]
+  # @param [Hash] hash
   # @return [String] 
   def render_hash_as_hidden_fields(hash)
     

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -6,11 +6,10 @@
 # Includes methods for rendering contraints graphically on the
 # search results page (render_constraints(_*))
 module Blacklight::RenderConstraintsHelperBehavior
-
   ##
   # Check if the query has any constraints defined (a query, facet, etc)
   #
-  # @param [Hash] query parameters
+  # @param [Hash] localized_params query parameters
   # @return [Boolean]
   def query_has_constraints?(localized_params = params)
     !(localized_params[:q].blank? and localized_params[:f].blank?)
@@ -20,7 +19,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # Render the actual constraints, not including header or footer
   # info.
   #
-  # @param [Hash] query parameters
+  # @param [Hash] localized_params query parameters
   # @return [String]
   def render_constraints(localized_params = params)
     render_constraints_query(localized_params) + render_constraints_filters(localized_params)
@@ -29,7 +28,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   ##
   # Render the query constraints
   #
-  # @param [ActionController::Parameters] query parameters
+  # @param [ActionController::Parameters] localized_params query parameters
   # @return [String]
   def render_constraints_query(localized_params = params)
     # So simple don't need a view template, we can just do it here.
@@ -84,12 +83,12 @@ module Blacklight::RenderConstraintsHelperBehavior
   def render_filter_element(facet, values, path)
     facet_config = facet_configuration_for_field(facet)
 
-    safe_join(values.map do |val|
+    safe_join(Array(values).map do |val|
       next if val.blank? # skip empty string
-      render_constraint_element( facet_field_label(facet_config.key), facet_display_value(facet, val),
-                  remove: search_action_path(path.remove_facet_params(facet, val)),
-                  classes: ["filter", "filter-" + facet.parameterize]
-                )
+      render_constraint_element(facet_field_label(facet_config.key),
+                                facet_display_value(facet, val),
+                                remove: search_action_path(path.remove_facet_params(facet, val)),
+                                classes: ["filter", "filter-" + facet.parameterize])
     end, "\n")
   end
 

data/app/helpers/blacklight/render_partials_helper.rb

@@ -3,7 +3,7 @@ module Blacklight::RenderPartialsHelper
   ##
   # Render the document index view
   #
-  # @param [Array<SolrDocument>] list of documents to render
+  # @param [Array<SolrDocument>] documents list of documents to render
   # @param [Hash] locals to pass to the render call
   # @return [String]
   def render_document_index documents = nil, locals = {}
@@ -19,9 +19,11 @@ module Blacklight::RenderPartialsHelper
 
   ##
   # Return the list of partials for a given solr document
-  # @param [SolrDocument]
-  # @return [String]
-  def render_document_partials(doc, partials = [], locals ={})
+  # @param [SolrDocument] doc solr document to render partials for
+  # @param [Array<String>] partials list of partials to render
+  # @param [Hash] locals local variables to pass to the render call
+  # @return [String] 
+  def render_document_partials(doc, partials = [], locals = {})
     safe_join(partials.map do |action_name|
       render_document_partial(doc, action_name, locals)
     end, "\n")
@@ -37,8 +39,8 @@ module Blacklight::RenderPartialsHelper
   # @see #document_partial_path_templates
   #
   # @param [SolrDocument] doc
-  # @param [String] base name for the partial
-  # @param [Hash] locales to pass through to the partials
+  # @param [String] base_name base name for the partial
+  # @param [Hash] locals local variables to pass through to the partials
   def render_document_partial(doc, base_name, locals = {})
     format = document_partial_name(doc, base_name)
 
@@ -63,7 +65,7 @@ module Blacklight::RenderPartialsHelper
   # @see #document_index_path_templates
   #
   # @param [String] view type
-  # @param [Array<SolrDocument>] list of documents to render
+  # @param [Array<SolrDocument>] documents list of documents to render
   # @param [Hash] locals to pass to the render call
   # @return [String]
   def render_document_index_with_view view, documents, locals = {}
@@ -94,8 +96,8 @@ module Blacklight::RenderPartialsHelper
     ]
   end
 
-
   protected
+
     ##
     # Return a partial name for rendering a document
     # this method can be overridden in order to transform the value
@@ -126,8 +128,8 @@ module Blacklight::RenderPartialsHelper
     ##
     # Return a normalized partial name for rendering a single document
     #
-    # @param [SolrDocument]
-    # @param [Symbol] base name for the partial
+    # @param [SolrDocument] document
+    # @param [Symbol] base_name base name for the partial
     # @return [String]
     def document_partial_name(document, base_name = nil)
       view_config = blacklight_config.view_config(:show)
@@ -190,9 +192,8 @@ module Blacklight::RenderPartialsHelper
     end
 
     ##
-    # @param [Symbol] page the page type, either :index or :show
-    # @param [String] type the type of object
-    # @block the block to evaluate if the cache misses
+    # @param key fetches or writes data to a cache, using the given key.
+    # @yield the block to evaluate (and cache) if there is a cache miss
     def cached_view key
       @view_cache ||= {}
       if @view_cache.key?(key)

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -6,7 +6,6 @@
 # Includes methods for rendering more textually on Search History page
 # (render_search_to_s(_*))
 module Blacklight::SearchHistoryConstraintsHelperBehavior
-
   # Simpler textual version of constraints, used on Search History page.
   # Theoretically can may be DRY'd up with results page render_constraints,
   # maybe even using the very same HTML with different CSS? 
@@ -35,8 +34,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
       render_search_to_s_element(facet_field_label(facet_field),
         safe_join(value_list.collect do |value|
           render_filter_value(value, facet_field)
-        end, content_tag(:span, " #{t('blacklight.and')} ", :class =>'filterSeparator'))
-      )    
+        end, content_tag(:span, " #{t('blacklight.and')} ", :class =>'filterSeparator')))    
     end, " \n ")
   end
 
@@ -61,5 +59,4 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
     display_value = facet_display_value(key, value) if key
     content_tag(:span, h(display_value), :class => 'filterValue')
   end
-
 end

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -147,7 +147,7 @@ module Blacklight::UrlHelperBehavior
 
   # Get url parameters to a search within a grouped result set
   #
-  # @param [Blacklight::Solr::Response::Group]
+  # @param [Blacklight::Solr::Response::Group] group
   # @return [Hash]
   def add_group_facet_params_and_redirect group
     search_state.add_facet_params_and_redirect(group.field, group.key)

data/app/models/blacklight/facet_paginator.rb

@@ -23,7 +23,7 @@ module Blacklight
     # all_facet_values is a list of facet value objects returned by solr,
     # asking solr for n+1 facet values.
     # options:
-    # :limit =>  number to display per page, or (default) nil. Nil means
+    # :limit =>  number to display per page, or (default) ?. Nil means
     #            display all with no previous or next. 
     # :offset => current item offset, default 0
     # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'. 
@@ -52,7 +52,7 @@ module Blacklight
 
     def current_page
       # A nil limit is unlimited, thus only one page.
-      if limit.nil? || limit == 0 #check for divide by zero
+      if limit.nil? || limit.zero? #check for divide by zero
         1
       else
         @offset / limit + 1

data/app/models/concerns/blacklight/document.rb

@@ -88,9 +88,7 @@ module Blacklight::Document
   end
   alias has_field? has?
 
-  def key? k
-    _source.key? k
-  end
+  delegate :key?, to: :_source
   alias has_key? key?
 
   def fetch key, *default
@@ -129,12 +127,10 @@ module Blacklight::Document
   # Certain class-level methods needed for the document-specific
   # extendability architecture
   module ClassMethods
-
     attr_writer :unique_key
     def unique_key
       @unique_key ||= 'id' 
     end
-
   end
   
   private
@@ -142,5 +138,4 @@ module Blacklight::Document
   def _source_responds_to? *args
     _source && self != _source && _source.respond_to?(*args)
   end
-
 end

data/app/models/concerns/blacklight/document/active_model_shim.rb

@@ -70,6 +70,5 @@ module Blacklight::Document
     def to_partial_path
       'catalog/document'
     end
-
   end
 end

data/app/models/concerns/blacklight/document/cache_key.rb

@@ -7,10 +7,10 @@
 # types in search results like gallery and list)
 module Blacklight::Document::CacheKey
   def cache_key
-    case
-    when new_record?
+    if new_record?
       "#{self.class.model_name.cache_key}/new"
-    when cache_version_value = self[cache_version_key]
+    elsif self.key? cache_version_key
+      cache_version_value = self[cache_version_key]
       "#{self.class.model_name.cache_key}/#{id}-#{Array(cache_version_value).join}"
     else
       "#{self.class.model_name.cache_key}/#{id}"

data/app/models/concerns/blacklight/document/dublin_core.rb

@@ -3,7 +3,6 @@ require 'builder'
 
 # This module provide Dublin Core export based on the document's semantic values
 module Blacklight::Document::DublinCore
-
   def self.extended(document)
     # Register our exportable formats
     Blacklight::Document::DublinCore.register_export_formats( document )

data/app/models/concerns/blacklight/document/email.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Email
-
   # Return a text string that will be the body of the email
   def to_email_text
     semantics = self.to_semantic_values
@@ -12,5 +11,4 @@ module Blacklight::Document::Email
     body << I18n.t('blacklight.email.text.language', value: semantics[:language].join(" ")) unless semantics[:language].blank?
     return body.join("\n") unless body.empty?
   end
-
 end

data/app/models/concerns/blacklight/document/export.rb

@@ -39,7 +39,6 @@
 #   end
 #
 module Blacklight::Document::Export
-
   ##
   # Register exportable formats supported by the individual document.
   # Usually called by an extension in it's self.extended method, to
@@ -66,7 +65,7 @@ module Blacklight::Document::Export
       Mime::Type.register_alias(content_type, short_name)
     end
 
-    export_formats[short_name] =  { content_type: content_type }
+    export_formats[short_name] = { content_type: content_type }
   end
 
   # Collects formats that this doc can export as.

data/app/models/concerns/blacklight/document/schema_org.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 module Blacklight::Document::SchemaOrg
-
   def itemtype
     "http://schema.org/Thing"
   end
-
 end

data/app/models/concerns/blacklight/document/sms.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Sms
-
   # Return a text string that will be the body of the email
   def to_sms_text
     semantics = self.to_semantic_values
@@ -10,5 +9,4 @@ module Blacklight::Document::Sms
     body << I18n.t('blacklight.sms.text.author', value: semantics[:author].first) unless semantics[:author].blank?
     return body.join unless body.empty?
   end
-
 end

data/app/models/concerns/blacklight/solr/document.rb

@@ -32,5 +32,4 @@ module Blacklight::Solr::Document
   def highlight_field k
     response['highlighting'][self.id][k.to_s].map(&:html_safe) if has_highlight_field? k
   end
-
 end

data/app/models/record_mailer.rb

@@ -22,5 +22,4 @@ class RecordMailer < ActionMailer::Base
     @url_gen_params = url_gen_params
     mail(:to => details[:to], :subject => "")
   end
-
 end

data/app/models/solr_document.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 class SolrDocument
-
   include Blacklight::Solr::Document
-
 end

data/app/presenters/blacklight/document_presenter.rb

@@ -18,7 +18,6 @@ module Blacklight
     # Get the value of the document's "title" field, or a placeholder
     # value (if empty)
     #
-    # @param [SolrDocument] document
     # @return [String]
     # @deprecated use ShowPresenter#heading instead
     def document_heading
@@ -30,7 +29,7 @@ module Blacklight
     # Create <link rel="alternate"> links from a documents dynamically
     # provided export formats. Returns empty string if no links available.
     #
-    # @params [Hash] options
+    # @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
@@ -55,8 +54,9 @@ module Blacklight
     ##
     # Render the document index heading
     #
-    # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
-    # @param [Hash] opts
+    # @overload render_document_index_label(field, opts)
+    #   @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
+    #   @param [Hash] opts
     # @deprecated use IndexPresenter#label instead
     def render_document_index_label(*args)
       index_presenter.label(*args)
@@ -68,9 +68,10 @@ module Blacklight
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [String] field
-    # @param [Hash] opts
-    # @options opts [String] :value
+    # @overload render_index_field_value(field, opts)
+    #   @param [String] field
+    #   @param [Hash] opts
+    #   @option opts [String] :value
     # @deprecated use IndexPresenter#field_value instead
     def render_index_field_value *args
       index_presenter.field_value(*args)
@@ -82,9 +83,11 @@ module Blacklight
     #
     #   Allow an extention point where information in the document
     #   may drive the value of the field
+    #
+    # @overload render_index_field_value(field, options)
     #   @param [String] field
     #   @param [Hash] options
-    #   @options opts [String] :value
+    #   @option options [String] :value
     #   @deprecated use ShowPresenter#field_value
     def render_document_show_field_value *args
       show_presenter.field_value(*args)
@@ -100,8 +103,8 @@ module Blacklight
     # Rendering:
     #   - helper_method
     #   - link_to_search
-    # @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
     # @deprecated
     def get_field_values _field, field_config, options = {}
@@ -118,7 +121,7 @@ module Blacklight
     # Rendering:
     #   - helper_method
     #   - link_to_search
-    # @param [Blacklight::Configuration::Field] solr field configuration
+    # @param [Blacklight::Configuration::Field] field_config solr field configuration
     # @param [Hash] options additional options to pass to the rendering helpers
     def field_values(field_config, options={})
       FieldPresenter.new(@controller, @document, field_config, options).render

data/app/presenters/blacklight/index_presenter.rb

@@ -7,7 +7,7 @@ module Blacklight
     attr_reader :document, :configuration, :view_context
 
     # @param [SolrDocument] document
-    # @param [ActionView::Base] view context scope for linking and generating urls
+    # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
     def initialize(document, view_context, configuration = view_context.blacklight_config)
       @document = document
@@ -18,7 +18,7 @@ module Blacklight
     ##
     # Render the document index heading
     #
-    # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
+    # @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
     # TODO: the default field should be `document_show_link_field(doc)'
     def label(field_or_string_or_proc, opts = {})
@@ -49,8 +49,8 @@ module Blacklight
     # Allow an extention point where information in the document
     # may drive the value of the field
     # @param [String] field
-    # @param [Hash] opts
-    # @options opts [String] :value
+    # @param [Hash] options
+    # @option options [String] :value
     def field_value field, options = {}
       field_config = field_config(field)
       field_values(field_config, options)
@@ -91,7 +91,7 @@ module Blacklight
       # Rendering:
       #   - helper_method
       #   - link_to_search
-      # @param [Blacklight::Configuration::Field] solr field configuration
+      # @param [Blacklight::Configuration::Field] field_config solr field configuration
       # @param [Hash] options additional options to pass to the rendering helpers
       def field_values(field_config, options={})
         FieldPresenter.new(view_context, document, field_config, options).render

data/app/presenters/blacklight/json_presenter.rb

@@ -25,7 +25,6 @@ module Blacklight
       end
     end
 
-
     # extract the pagination info from the response object
     def pagination_info
       h = {}