RubyGems - blacklight - Versions diffs - 6.24.0 → 7.0.0.rc1 - Mend

blacklight 6.24.0 → 7.0.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (393) hide show

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb CHANGED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,16 @@
+##
+# 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 CHANGED Viewed

@@ -11,13 +11,6 @@ module Blacklight
       "#{main_content_classes} show-document"
     end
-    ##
-    # Attributes to add to the <html> tag (e.g. lang and dir)
-    # @return [Hash]
-    def html_tag_attributes
-      { lang: I18n.locale }
-    end
     ##
     # Classes added to a document's sidebar div
     # @return [String]
@@ -29,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 CHANGED Viewed

@@ -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
   ##
@@ -67,7 +67,7 @@ module Blacklight::RenderConstraintsHelperBehavior
     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
@@ -107,6 +107,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

data/app/helpers/blacklight/render_partials_helper_behavior.rb ADDED Viewed

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+module Blacklight::RenderPartialsHelperBehavior
+  ##
+  # Render the document index view
+  #
+  # @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 = {}
+    documents ||= @response.documents
+    render_document_index_with_view(document_index_view_type, documents, locals)
+  end
+  ##
+  # Render the document index for a grouped response
+  def render_grouped_document_index
+    render 'catalog/group'
+  end
+  ##
+  # Return the list of partials for a given solr document
+  # @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")
+  end
+  ##
+  # Given a doc and a base name for a partial, this method will attempt to render
+  # an appropriate partial based on the document format and view type.
+  #
+  # If a partial that matches the document format is not found,
+  # render a default partial for the base name.
+  #
+  # @see #document_partial_path_templates
+  #
+  # @param [SolrDocument] doc
+  # @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)
+    view_type = document_index_view_type
+    template = cached_view ['show', view_type, base_name, format].join('_') do
+      find_document_show_template_with_view(view_type, base_name, format, locals)
+    end
+    if template
+      template.render(self, locals.merge(document: doc))
+    else
+      ''
+    end
+  end
+  ##
+  # Render the document index for the given view type with the
+  # list of documents.
+  #
+  # This method will interpolate the list of templates with
+  # the current view, and gracefully handles missing templates.
+  #
+  # @see #document_index_path_templates
+  #
+  # @param [String] view type
+  # @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 = {}
+    template = cached_view ['index', view].join('_') do
+      find_document_index_template_with_view(view, locals)
+    end
+    if template
+      template.render(self, locals.merge(documents: documents))
+    else
+      ''
+    end
+  end
+  ##
+  # A list of document partial templates to attempt to render
+  #
+  # @see #render_document_index_with_view
+  # @return [Array<String>]
+  def document_index_path_templates
+    # first, the legacy template names for backwards compatbility
+    # followed by the new, inheritable style
+    # finally, a controller-specific path for non-catalog subclasses
+    @document_index_path_templates ||= [
+      "document_%{index_view_type}",
+      "catalog/document_%{index_view_type}",
+      "catalog/document_list"
+    ]
+  end
+  ##
+  # Return a normalized partial name for rendering a single document
+  #
+  # @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)
+    display_type = if base_name && view_config.key?(:"#{base_name}_display_type_field")
+                     document[view_config[:"#{base_name}_display_type_field"]]
+                   end
+    display_type ||= document[view_config.display_type_field]
+    display_type ||= 'default'
+    type_field_to_partial_name(document, display_type)
+  end
+  private
+  ##
+  # Return a partial name for rendering a document
+  # this method can be overridden in order to transform the value
+  #   (e.g. 'PdfBook' => 'pdf_book')
+  #
+  # @param [SolrDocument] document
+  # @param [String, Array] display_type a value suggestive of a partial
+  # @return [String] the name of the partial to render
+  # @example
+  #  type_field_to_partial_name(['a book-article'])
+  #  => 'a_book_article'
+  def type_field_to_partial_name(_document, display_type)
+    # using "_" as sep. to more closely follow the views file naming conventions
+    # parameterize uses "-" as the default sep. which throws errors
+    underscore = '_'.freeze
+    Array(display_type).join(' '.freeze).tr('-'.freeze, underscore).parameterize(separator: underscore)
+  end
+  ##
+  # A list of document partial templates to try to render for a document
+  #
+  # The partial names will be interpolated with the following variables:
+  #   - action_name: (e.g. index, show)
+  #   - index_view_type: (the current view type, e.g. list, gallery)
+  #   - format: the document's format (e.g. book)
+  #
+  # @see #render_document_partial
+  def document_partial_path_templates
+    # first, the legacy template names for backwards compatbility
+    # followed by the new, inheritable style
+    # finally, a controller-specific path for non-catalog subclasses
+    @partial_path_templates ||= [
+      "%{action_name}_%{index_view_type}_%{format}",
+      "%{action_name}_%{index_view_type}_default",
+      "%{action_name}_%{format}",
+      "%{action_name}_default",
+      "%{action_name}",
+      "catalog/%{action_name}_%{format}",
+      "catalog/_%{action_name}_partials/%{format}",
+      "catalog/_%{action_name}_partials/default"
+    ]
+  end
+  def find_document_show_template_with_view view_type, base_name, format, locals
+    document_partial_path_templates.each do |str|
+      partial = format(str, action_name: base_name, format: format, index_view_type: view_type)
+      logger.debug "Looking for document partial #{partial}"
+      template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:document], {}).first
+      return template if template
+    end
+    nil
+  end
+  def find_document_index_template_with_view view_type, locals
+    document_index_path_templates.each do |str|
+      partial = format(str, index_view_type: view_type)
+      logger.debug "Looking for document index partial #{partial}"
+      template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:documents], {}).first
+      return template if template
+    end
+    nil
+  end
+  ##
+  # @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)
+      @view_cache[key]
+    else
+      @view_cache[key] = yield
+    end
+  end
+end

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb CHANGED Viewed

@@ -8,8 +8,8 @@
 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?
-  # But too tricky for now, too many changes to existing CSS. TODO.
+  # maybe even using the very same HTML with different CSS?
+  # But too tricky for now, too many changes to existing CSS. TODO.
   def render_search_to_s(params)
     render_search_to_s_q(params) +
     render_search_to_s_filters(params)
@@ -22,7 +22,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
     label = label_for_search_field(params[:search_field]) unless default_search_field && params[:search_field] == default_search_field[:key]
-    render_search_to_s_element(label , render_filter_value(params['q']) )
+    render_search_to_s_element(label, render_filter_value(params['q']))
   end
   ##
@@ -32,24 +32,29 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
     safe_join(params[:f].collect do |facet_field, value_list|
       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')))
+                                 safe_join(value_list.collect do |value|
+                                   render_filter_value(value, facet_field)
+                                 end,
+                                           content_tag(:span, " #{t('blacklight.and')} ", class: 'filter-separator')))
     end, " \n ")
   end
   # value can be Array, in which case elements are joined with
   # 'and'.   Pass in option :escape_value => false to pass in pre-rendered
-  # html for value. key with escape_key if needed.
-  def render_search_to_s_element(key, value, options = {})
-    content_tag(:span, render_filter_name(key) + content_tag(:span, value, :class => 'filterValues'), :class => 'constraint')
+  # html for value. key with escape_key if needed.
+  def render_search_to_s_element(key, value, _options = {})
+    content_tag(:span,
+                render_filter_name(key) + content_tag(:span, value, class: 'filter-values'),
+                class: 'constraint')
   end
   ##
   # Render the name of the facet
   def render_filter_name name
     return "".html_safe if name.blank?
-    content_tag(:span, t('blacklight.search.filters.label', :label => name), :class => 'filterName')
+    content_tag(:span,
+                t('blacklight.search.filters.label', label: name),
+                class: 'filter-name')
   end
   ##
@@ -57,6 +62,8 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   def render_filter_value value, key = nil
     display_value = value
     display_value = facet_display_value(key, value) if key
-    content_tag(:span, h(display_value), :class => 'filterValue')
+    content_tag(:span,
+                h(display_value),
+                class: 'filter-value')
   end
 end

data/app/helpers/blacklight/suggest_helper_behavior.rb CHANGED Viewed

@@ -7,5 +7,6 @@ module Blacklight
       blacklight_config.autocomplete_enabled.present? &&
         blacklight_config.autocomplete_path.present?
     end
+    deprecation_deprecate autocomplete_enabled?: "use SearchBarPresenter#autocomplete_enabled?"
   end
 end

data/app/helpers/blacklight/url_helper_behavior.rb CHANGED Viewed

@@ -2,12 +2,6 @@
 ##
 # URL helper methods
 module Blacklight::UrlHelperBehavior
-  include Blacklight::DeprecatedUrlHelperBehavior
-  ##
-  # Extension point for downstream applications
-  # to provide more interesting routing to
-  # documents
   def url_for_document(doc, options = {})
     search_state.url_for_document(doc, options)
   end
@@ -17,7 +11,7 @@ module Blacklight::UrlHelperBehavior
   # catalog_path accepts a hash. The solr query params are stored in the session,
   # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
   # TODO: move this to the IndexPresenter
-  def link_to_document(doc, field_or_opts = nil, opts={:counter => nil})
+  def link_to_document(doc, field_or_opts = nil, opts = { counter: nil })
     if field_or_opts.is_a? Hash
       opts = field_or_opts
     else
@@ -32,23 +26,23 @@ module Blacklight::UrlHelperBehavior
   def document_link_params(doc, opts)
     session_tracking_params(doc, opts[:counter]).deep_merge(opts.except(:label, :counter))
   end
-  protected :document_link_params
+  private :document_link_params
   ##
   # Link to the previous document in the current search context
   def link_to_previous_document(previous_document)
-    link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(:class => "previous", :rel => 'prev')
+    link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: "previous", rel: 'prev')
     link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
-      content_tag :span, raw(t('views.pagination.previous')), :class => 'previous'
+      content_tag :span, raw(t('views.pagination.previous')), class: 'previous'
     end
   end
   ##
   # Link to the next document in the current search context
   def link_to_next_document(next_document)
-    link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(:class => "next", :rel => 'next')
+    link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: "next", rel: 'next')
     link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
-      content_tag :span, raw(t('views.pagination.next')), :class => 'next'
+      content_tag :span, raw(t('views.pagination.next')), class: 'next'
     end
   end
@@ -66,9 +60,9 @@ module Blacklight::UrlHelperBehavior
       return {}
     end
-    { data: {:'context-href' => path } }
+    { data: { :'context-href' => path } }
   end
-  protected :session_tracking_params
+  private :session_tracking_params
   ##
   # Get the URL for tracking search sessions across pages using polymorphic routing
@@ -101,7 +95,7 @@ module Blacklight::UrlHelperBehavior
   # Get the path to the search action with any parameters (e.g. view type)
   # that should be persisted across search sessions.
   def start_over_path query_params = params
-    h = { }
+    h = {}
     current_index_view_type = document_index_view_type(query_params)
     h[:view] = current_index_view_type unless current_index_view_type == default_document_index_view_type
@@ -112,23 +106,23 @@ module Blacklight::UrlHelperBehavior
   # @example
   #   link_back_to_catalog(label: 'Back to Search')
   #   link_back_to_catalog(label: 'Back to Search', route_set: my_engine)
-  def link_back_to_catalog(opts={:label=>nil})
+  def link_back_to_catalog(opts = { label: nil })
     scope = opts.delete(:route_set) || self
     query_params = search_state.reset(current_search_session.try(:query_params)).to_hash
     if search_session['counter']
-      per_page = (search_session['per_page'] || default_per_page).to_i
+      per_page = (search_session['per_page'] || blacklight_config.default_per_page).to_i
       counter = search_session['counter'].to_i
-      query_params[:per_page] = per_page unless search_session['per_page'].to_i == default_per_page
-      query_params[:page] = ((counter - 1)/ per_page) + 1
+      query_params[:per_page] = per_page unless search_session['per_page'].to_i == blacklight_config.default_per_page
+      query_params[:page] = ((counter - 1) / per_page) + 1
     end
     link_url = if query_params.empty?
-      search_action_path(only_path: true)
-    else
-      scope.url_for(query_params)
-    end
+                 search_action_path(only_path: true)
+               else
+                 scope.url_for(query_params)
+               end
     label = opts.delete(:label)
     if link_url =~ /bookmarks/
@@ -153,11 +147,11 @@ module Blacklight::UrlHelperBehavior
     search_state.add_facet_params_and_redirect(group.field, group.key)
   end
-  # A URL to refworks export, with an embedded callback URL to this app.
-  # the callback URL is to bookmarks#export, which delivers a list of
+  # A URL to refworks export, with an embedded callback URL to this app.
+  # the callback URL is to bookmarks#export, which delivers a list of
   # user's bookmarks in 'refworks marc txt' format -- we tell refworks
-  # to expect that format.
+  # to expect that format.
   def bookmarks_export_url(format, params = {})
-    bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id) ))
+    bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id)))
   end
 end