blacklight 6.14.0 → 7.0.0

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -7,21 +7,23 @@ module Blacklight
 
     def document_action_path action_opts, url_opts = nil
       if action_opts.path
-        self.send(action_opts.path, url_opts)
+        send(action_opts.path, url_opts)
       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)
+        send("#{action_opts.key}_#{controller_name}_path", url_opts)
       end
     end
 
     ##
     # Render "document actions" area for navigation header
     # (normally renders "Saved Searches", "History", "Bookmarks")
+    # These things are added by add_nav_action and the default config is
+    # provided by DefaultComponentConfiguration
     #
     # @param [Hash] options
     # @return [String]
-    def render_nav_actions(options={}, &block)
+    def render_nav_actions(options = {}, &block)
       render_filtered_partials(blacklight_config.navbar.partials, options, &block)
     end
 
@@ -33,7 +35,7 @@ module Blacklight
     # @param [Hash] options
     # @option options [String] :wrapping_class
     # @return [String]
-    def render_index_doc_actions(document, options={})
+    def render_index_doc_actions(document, options = {})
       wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
       rendered = render_filtered_partials(blacklight_config.view_config(document_index_view_type).document_actions, { document: document }.merge(options))
       content_tag("div", rendered, class: wrapping_class) unless rendered.blank?
@@ -52,20 +54,6 @@ module Blacklight
       content_tag("div", rendered, class: wrapping_class) unless rendered.blank?
     end
 
-    def render_filtered_partials(partials, options={}, &block)
-      content = []
-      filter_partials(partials, options).each do |key, config|
-        config.key ||= key
-        rendered = render(partial: config.partial || key.to_s, locals: { document_action_config: config }.merge(options))
-        if block_given?
-          yield config, rendered
-        else
-          content << rendered
-        end
-      end
-      safe_join(content, "\n") unless block_given?
-    end
-
     ##
     # Render "document actions" for the item detail 'show' view.
     # (this normally renders next to title)
@@ -75,7 +63,7 @@ module Blacklight
     # @param [SolrDocument] document
     # @param [Hash] options
     # @return [String]
-    def render_show_doc_actions(document=@document, options={}, &block)
+    def render_show_doc_actions(document = @document, options = {}, &block)
       render_filtered_partials(blacklight_config.show.document_actions, { document: document }.merge(options), &block)
     end
 
@@ -85,6 +73,20 @@ module Blacklight
 
     private
 
+    def render_filtered_partials(partials, options = {})
+      content = []
+      filter_partials(partials, options).each do |key, config|
+        config.key ||= key
+        rendered = render(partial: config.partial || key.to_s, locals: { document_action_config: config }.merge(options))
+        if block_given?
+          yield config, rendered
+        else
+          content << rendered
+        end
+      end
+      safe_join(content, "\n") unless block_given?
+    end
+
     def filter_partials(partials, options)
       partials.select { |_, config| blacklight_configuration_context.evaluate_if_unless_configuration config, options }
     end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,32 +1,24 @@
 # frozen_string_literal: true
 module Blacklight::ConfigurationHelperBehavior
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 7.x'
-
   ##
   # Index fields to display for a type of document
-  # 
+  #
   # @param [SolrDocument] document
-  # @return [Array<Blacklight::Configuration::Field>] 
-  def index_fields document=nil
+  # @return [Array<Blacklight::Configuration::Field>]
+  def index_fields _document = nil
+    Deprecation.warn(self, "index_fields is deprecated and will be removed in Blacklight 8. Use IndexPresenter#fields instead")
     blacklight_config.index_fields
   end
 
-  # Used in the document_list partial (search view) for building a select element
-  def sort_fields
-    active_sort_fields.map { |_sort_key, field_config| [sort_field_label(field_config.key), field_config.key] }
-  end
-  deprecation_deprecate :sort_fields
-  
   def active_sort_fields
-    blacklight_config.sort_fields.select { |sort_key, field_config| should_render_field?(field_config) }
+    blacklight_config.sort_fields.select { |_sort_key, field_config| should_render_field?(field_config) }
   end
 
   # Used in the search form partial for building a select tag
   def search_fields
     search_field_options_for_select
   end
-  
+
   # Returns suitable argument to options_for_select method, to create
   # an html select based on #search_field_list. Skips search_fields
   # marked :include_in_simple_select => false
@@ -36,8 +28,9 @@ module Blacklight::ConfigurationHelperBehavior
     end.compact
   end
 
-  # used in the catalog/_show/_default partial
-  def document_show_fields document=nil
+  # used in the catalog/_show partial
+  def document_show_fields _document = nil
+    Deprecation.warn(self, "document_show_fields is deprecated and will be removed in Blacklight 8. Use ShowPresenter#fields instead")
     blacklight_config.show_fields
   end
 
@@ -62,38 +55,28 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Look up the label for the index field
   def index_field_label document, field
-    field_config = index_fields(document)[field]
+    field_config = blacklight_config.index_fields_for(document)[field]
+    field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
-    field_label(
-      :"blacklight.search.fields.index.#{field}",
-      :"blacklight.search.fields.#{field}",
-      (field_config.label if field_config),
-      field.to_s.humanize
-    )
+    field_config.display_label('index')
   end
 
   ##
   # Look up the label for the show field
   def document_show_field_label document, field
-    field_config = document_show_fields(document)[field]
+    field_config = blacklight_config.show_fields_for(document)[field]
+    field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
-    field_label(
-      :"blacklight.search.fields.show.#{field}",
-      :"blacklight.search.fields.#{field}",
-      (field_config.label if field_config),
-      field.to_s.humanize
-    )
+    field_config.display_label('show')
   end
 
   ##
   # Look up the label for the facet field
   def facet_field_label field
     field_config = blacklight_config.facet_fields[field]
-    defaults = [:"blacklight.search.fields.facet.#{field}", :"blacklight.search.fields.#{field}"]
-    defaults << field_config.label if field_config
-    defaults << field.to_s.humanize
+    field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
-    field_label(*defaults)
+    field_config.display_label('facet')
   end
 
   def view_label view
@@ -114,34 +97,25 @@ module Blacklight::ConfigurationHelperBehavior
     field_config = blacklight_config.search_fields[key]
     field_config ||= Blacklight::Configuration::NullField.new(key: key)
 
-    field_label(
-      :"blacklight.search.fields.search.#{field_config.key}",
-      :"blacklight.search.fields.#{field_config.key}",
-      (field_config.label if field_config),
-      key.to_s.humanize
-    )
+    field_config.display_label('search')
   end
 
   def sort_field_label(key)
     field_config = blacklight_config.sort_fields[key]
     field_config ||= Blacklight::Configuration::NullField.new(key: key)
 
-    field_label(
-      :"blacklight.search.fields.sort.#{key}",
-      (field_config.label if field_config),
-      key.to_s.humanize
-    )
+    field_config.display_label('sort')
   end
 
   ##
   # Look up the label for a solr field.
   #
   # @overload label
-  #   @param [Symbol] an i18n key 
+  #   @param [Symbol] an i18n key
   #
   # @overload label, i18n_key, another_i18n_key, and_another_i18n_key
   #   @param [String] default label to display if the i18n look up fails
-  #   @param [Symbol] i18n keys to attempt to look up 
+  #   @param [Symbol] i18n keys to attempt to look up
   #     before falling  back to the label
   #   @param [Symbol] any number of additional keys
   #   @param [Symbol] ...
@@ -152,7 +126,7 @@ module Blacklight::ConfigurationHelperBehavior
   end
 
   def document_index_views
-    blacklight_config.view.select do |k, config|
+    blacklight_config.view.select do |_k, config|
       should_render_field? config
     end
   end
@@ -167,7 +141,7 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Get the default index view type
   def default_document_index_view_type
-    document_index_views.select { |k,config| config.respond_to? :default and config.default }.keys.first || document_index_views.keys.first
+    document_index_views.select { |_k, config| config.respond_to?(:default) && config.default }.keys.first || document_index_views.keys.first
   end
 
   ##
@@ -183,7 +157,7 @@ module Blacklight::ConfigurationHelperBehavior
   end
 
   # Used in the document list partial (search view) for creating a link to the document show action
-  def document_show_link_field document=nil
+  def document_show_link_field document = nil
     fields = Array(blacklight_config.view_config(document_index_view_type).title_field)
 
     field = fields.first if document.nil?
@@ -197,23 +171,22 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Default sort field
   def default_sort_field
-    (active_sort_fields.find { |k,config| config.respond_to? :default and config.default } || active_sort_fields.first).try(:last)
+    (active_sort_fields.find { |_k, config| config.respond_to?(:default) && config.default } || active_sort_fields.first).try(:last)
   end
 
   ##
   # The default value for search results per page
-  def default_per_page
-    blacklight_config.default_per_page || blacklight_config.per_page.first
-  end
-  
+  delegate :default_per_page, to: :blacklight_config
+  deprecation_deprecate default_per_page: "Use blacklight_config.default_per_page instead"
+
   ##
   # The available options for results per page, in the style of #options_for_select
   def per_page_options_for_select
     blacklight_config.per_page.map do |count|
-      [t(:'blacklight.search.per_page.label', :count => count).html_safe, count]
+      [t(:'blacklight.search.per_page.label', count: count).html_safe, count]
     end
   end
-  
+
   ##
   # Determine whether to render a field by evaluating :if and :unless conditions
   #

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -6,16 +6,15 @@ module Blacklight::FacetsHelperBehavior
   # Check if any of the given fields have values
   #
   # @param [Array<String>] fields
-  # @param [Hash] options
   # @return [Boolean]
-  def has_facet_values? fields = facet_field_names, options = {}
-    facets_from_request(fields).any? { |display_facet| !display_facet.items.empty? && should_render_facet?(display_facet) }
+  def has_facet_values? fields = facet_field_names
+    facets_from_request(fields).any? { |display_facet| should_render_facet?(display_facet) }
   end
 
   ##
   # Render a collection of facet fields.
-  # @see #render_facet_limit 
-  # 
+  # @see #render_facet_limit
+  #
   # @param [Array<String>] fields
   # @param [Hash] options
   # @return String
@@ -28,41 +27,42 @@ module Blacklight::FacetsHelperBehavior
   ##
   # Renders a single section for facet limit with a specified
   # solr field used for faceting. Can be over-ridden for custom
-  # display on a per-facet basis. 
+  # display on a per-facet basis.
   #
-  # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet 
+  # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
   # @param [Hash] options parameters to use for rendering the facet limit partial
   # @option options [String] :partial partial to render
   # @option options [String] :layout partial layout to render
   # @option options [Hash] :locals locals to pass to the partial
-  # @return [String] 
+  # @return [String]
   def render_facet_limit(display_facet, options = {})
-    return unless should_render_facet?(display_facet)
+    field_config = facet_configuration_for_field(display_facet.name)
+    return unless should_render_facet?(display_facet, field_config)
+
     options = options.dup
     options[:partial] ||= facet_partial_name(display_facet)
     options[:layout] ||= "facet_layout" unless options.key?(:layout)
     options[:locals] ||= {}
     options[:locals][:field_name] ||= display_facet.name
-    options[:locals][:solr_field] ||= display_facet.name # deprecated
-    options[:locals][:facet_field] ||= facet_configuration_for_field(display_facet.name)
-    options[:locals][:display_facet] ||= display_facet 
+    options[:locals][:facet_field] ||= field_config
+    options[:locals][:display_facet] ||= display_facet
 
     render(options)
   end
 
   ##
-  # Renders the list of values 
+  # Renders the list of values
   # 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)})
+  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) })
   end
 
   ##
   # Renders a single facet item
   def render_facet_item(facet_field, item)
-    if facet_in_params?(facet_field, item.value )
-      render_selected_facet_value(facet_field, item)          
+    if facet_in_params?(facet_field, item.value)
+      render_selected_facet_value(facet_field, item)
     else
       render_facet_value(facet_field, item)
     end
@@ -74,12 +74,14 @@ module Blacklight::FacetsHelperBehavior
   # By default, only render facets with items.
   #
   # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
-  # @return [Boolean] 
-  def should_render_facet? display_facet
+  # @param [Blacklight::Configuration::FacetField] facet_config
+  # @return [Boolean]
+  def should_render_facet? display_facet, facet_config = nil
+    return false if display_facet.items.blank?
+
     # display when show is nil or true
-    facet_config = facet_configuration_for_field(display_facet.name)
-    display = should_render_field?(facet_config, display_facet)
-    display && display_facet.items.present?
+    facet_config ||= facet_configuration_for_field(display_facet.name)
+    should_render_field?(facet_config, display_facet)
   end
 
   ##
@@ -87,7 +89,7 @@ module Blacklight::FacetsHelperBehavior
   #   - if the facet is 'active', don't collapse
   #   - 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] facet_field
   # @return [Boolean]
   def should_collapse_facet? facet_field
@@ -97,7 +99,7 @@ module Blacklight::FacetsHelperBehavior
   ##
   # The name of the partial to use to render a facet field.
   # uses the value of the "partial" field if set in the facet configuration
-  # otherwise uses "facet_pivot" if this facet is a pivot facet 
+  # otherwise uses "facet_pivot" if this facet is a pivot facet
   # defaults to 'facet_limit'
   #
   # @return [String]
@@ -105,9 +107,9 @@ module Blacklight::FacetsHelperBehavior
     config = facet_configuration_for_field(display_facet.name)
     name = config.try(:partial)
     name ||= "facet_pivot" if config.pivot
-    name ||= "facet_limit"
+    name || "facet_limit"
   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
@@ -118,10 +120,13 @@ module Blacklight::FacetsHelperBehavior
   # @param [Hash] options
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
   # @return [String]
-  def render_facet_value(facet_field, item, options ={})
+  def render_facet_value(facet_field, item, options = {})
     path = path_for_facet(facet_field, item)
-    content_tag(:span, :class => "facet-label") do
-      link_to_unless(options[:suppress_link], facet_display_value(facet_field, item), path, :class=>"facet_select")
+    content_tag(:span, class: "facet-label") do
+      link_to_unless(options[:suppress_link],
+                     facet_display_value(facet_field, item),
+                     path,
+                     class: "facet-select")
     end + render_facet_count(item.hits)
   end
 
@@ -130,12 +135,12 @@ module Blacklight::FacetsHelperBehavior
   # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
   # @param [String] item
   # @return [String]
-  def path_for_facet(facet_field, item)
+  def path_for_facet(facet_field, item, path_options = {})
     facet_config = facet_configuration_for_field(facet_field)
     if facet_config.url_method
       send(facet_config.url_method, facet_field, item)
     else
-      search_action_path(search_state.add_facet_params_and_redirect(facet_field, item))
+      search_action_path(search_state.add_facet_params_and_redirect(facet_field, item).merge(path_options))
     end
   end
 
@@ -150,15 +155,15 @@ module Blacklight::FacetsHelperBehavior
       content_tag(:span, facet_display_value(facet_field, item), class: "selected") +
       # remove link
       link_to(remove_href, class: "remove") do
-        content_tag(:span, '', class: "glyphicon glyphicon-remove") +
+        content_tag(:span, '✖', class: "remove-icon") +
         content_tag(:span, '[remove]', class: 'sr-only')
       end
-    end + render_facet_count(item.hits, :classes => ["selected"])
+    end + render_facet_count(item.hits, 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. 
+  # to change style. And can be called by plugins to get consistent display.
   #
   # @param [Integer] num number of facet results
   # @param [Hash] options
@@ -166,24 +171,24 @@ module Blacklight::FacetsHelperBehavior
   # @return [String]
   def render_facet_count(num, options = {})
     classes = (options[:classes] || []) << "facet-count"
-    content_tag("span", t('blacklight.search.facets.count', :number => number_with_delimiter(num)), :class => classes)
+    content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(num)), class: classes)
   end
-  
+
   ##
   # Are any facet restrictions for a field in the query parameters?
-  # 
+  #
   # @param [String] field
   # @return [Boolean]
   def facet_field_in_params? field
     !facet_params(field).blank?
   end
-  
+
   ##
-  # Check if the query parameters have the given facet field with the 
+  # Check if the query parameters have the given facet field with the
   # given value.
-  # 
-  # @param [Object] field
-  # @param [Object] item facet value
+  #
+  # @param [String] field
+  # @param [String] item facet value
   # @return [Boolean]
   def facet_in_params?(field, item)
     value = facet_value_for_facet_item(item)
@@ -201,18 +206,18 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Get the displayable version of a facet's value
-  # 
+  #
   # @param [Object] field
   # @param [String] item value
-  # @return [String] 
+  # @return [String]
   def facet_display_value field, item
     facet_config = facet_configuration_for_field(field)
-    
+
     value = if item.respond_to? :label
-      item.label
-    else
-      facet_value_for_facet_item(item)
-    end
+              item.label
+            else
+              facet_value_for_facet_item(item)
+            end
 
     if facet_config.helper_method
       send facet_config.helper_method, value
@@ -220,8 +225,7 @@ module Blacklight::FacetsHelperBehavior
       facet_config.query[value][:label]
     elsif facet_config.date
       localization_options = facet_config.date == true ? {} : facet_config.date
-
-      l(value.to_datetime, localization_options)
+      l(Time.zone.parse(value), localization_options)
     else
       value
     end

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -3,7 +3,7 @@
 # fields, works with hash nested with other hashes and arrays, standard rails
 # serialization style.  Oddly while Hash#to_query will do this for a URL
 # query parameters, there seems to be no built in way to do it to create
-# hidden form fields instead. 
+# hidden form fields instead.
 #
 # Code taken from http://marklunds.com/articles/one/314
 #
@@ -15,22 +15,21 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
   # representing a hash passed in using Rails-style request parameters
   # for hashes nested with arrays and other hashes.
   # @param [Hash] hash
-  # @return [String] 
+  # @return [String]
   def render_hash_as_hidden_fields(hash)
-    
     hidden_fields = []
     flatten_hash(hash).each do |name, value|
       value = Array.wrap(value)
       value.each do |v|
-        hidden_fields << hidden_field_tag(name, v.to_s, :id => nil)          
+        hidden_fields << hidden_field_tag(name, v.to_s, id: nil)
       end
     end
-    
+
     safe_join(hidden_fields, "\n")
   end
 
-  protected
-  
+  private
+
   def flatten_hash(hash = params, ancestor_names = [])
     flat_hash = {}
     hash.each do |k, v|
@@ -44,17 +43,16 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
         flat_hash[key] = v
       end
     end
-    
+
     flat_hash
   end
-  
+
   def flat_hash_key(names)
     names = Array.new(names)
-    name = names.shift.to_s.dup 
+    name = names.shift.to_s.dup
     names.each do |n|
       name << "[#{n}]"
     end
     name
   end
-  
 end

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+##
+# Module to help generate icon helpers for SVG images
+module Blacklight::IconHelperBehavior
+  ##
+  # Returns the raw SVG (String) for a Blacklight Icon located in
+  # app/assets/images/blacklight/*.svg. Caches them so we don't have to look up
+  # the svg everytime.
+  # @param [String, Symbol] icon_name
+  # @return [String]
+  def blacklight_icon(icon_name, options = {})
+    Rails.cache.fetch([:blacklight_icons, icon_name, options]) do
+      icon = Blacklight::Icon.new(icon_name, options)
+      content_tag(:span, icon.svg.html_safe, icon.options)
+    end
+  end
+end

data/app/helpers/blacklight/layout_helper_behavior.rb

@@ -22,20 +22,20 @@ module Blacklight
     # Classes used for sizing the main content of a Blacklight page
     # @return [String]
     def main_content_classes
-      'col-md-9 col-sm-8'
+      'col-md-9'
     end
 
     ##
     # Classes used for sizing the sidebar content of a Blacklight page
     # @return [String]
     def sidebar_classes
-      'col-md-3 col-sm-4'
+      'page-sidebar col-md-3'
     end
 
     ##
     # Class used for specifying main layout container classes. Can be
     # overwritten to return 'container-fluid' for Bootstrap full-width layout
-    # @return [String] 
+    # @return [String]
     def container_classes
       'container'
     end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -12,7 +12,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @param [Hash] localized_params query parameters
   # @return [Boolean]
   def query_has_constraints?(localized_params = params)
-    !(localized_params[:q].blank? and localized_params[:f].blank?)
+    !(localized_params[:q].blank? && localized_params[:f].blank?)
   end
 
   ##
@@ -35,9 +35,9 @@ module Blacklight::RenderConstraintsHelperBehavior
     return "".html_safe if localized_params[:q].blank?
 
     render_constraint_element(constraint_query_label(localized_params),
-          localized_params[:q],
-          classes: ["query"],
-          remove: remove_constraint_url(localized_params))
+                              localized_params[:q],
+                              classes: ["query"],
+                              remove: remove_constraint_url(localized_params))
   end
 
   ##
@@ -65,9 +65,10 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @return [String]
   def render_constraints_filters(localized_params = params)
     return "".html_safe unless localized_params[:f]
+
     path = controller.search_state_class.new(localized_params, blacklight_config, controller)
     content = []
-    localized_params[:f].each_pair do |facet,values|
+    localized_params[:f].each_pair do |facet, values|
       content << render_filter_element(facet, values, path)
     end
 
@@ -85,6 +86,7 @@ module Blacklight::RenderConstraintsHelperBehavior
 
     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)),
@@ -107,6 +109,6 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @option options [Array<String>] :classes an array of classes to add to container span for constraint.
   # @return [String]
   def render_constraint_element(label, value, options = {})
-    render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})
+    render(partial: "catalog/constraints_element", locals: { label: label, value: value, options: options })
   end
 end