# -*- encoding : utf-8 -*-
# -*- coding: utf-8 -*-
#
# Methods added to this helper will be available to all templates in the hosting application
#
module Blacklight::BlacklightHelperBehavior
include BlacklightUrlHelper
include BlacklightConfigurationHelper
include HashAsHiddenFieldsHelper
include RenderConstraintsHelper
include FacetsHelper
##
# Get the name of this application, from either:
# - the Rails configuration
# - an i18n string (key: blacklight.application_name; preferred)
#
# @return [String] the application name
def application_name
return Rails.application.config.application_name if Rails.application.config.respond_to? :application_name
t('blacklight.application_name')
end
##
# Get the page's HTML title
#
# @return [String]
def render_page_title
(content_for(:page_title) if content_for?(:page_title)) || @page_title || application_name
end
##
# Create links from a documents dynamically
# provided export formats. Currently not used by standard BL layouts,
# but available for your custom layouts to provide link rel alternates.
#
# Returns empty string if no links available.
#
# @params [SolrDocument] document
# @params [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] :exclude array of format shortnames to not include in the output
def render_link_rel_alternates(document=@document, options = {})
options = {:unique => false, :exclude => []}.merge(options)
return nil if document.nil?
seen = Set.new
html = ""
document.export_formats.each_pair do |format, spec|
unless( options[:exclude].include?(format) ||
(options[:unique] && seen.include?(spec[:content_type]))
)
html << tag(:link, {:rel=>"alternate", :title=>format, :type => spec[:content_type], :href=> polymorphic_url(document, :format => format)}) << "\n"
seen.add(spec[:content_type]) if options[:unique]
end
end
return html.html_safe
end
##
# Render OpenSearch headers for this search
# @return [String]
def render_opensearch_response_metadata
render :partial => 'catalog/opensearch_response_metadata'
end
##
# Render classes for the element
# @return [String]
def render_body_class
extra_body_classes.join " "
end
##
# List of classes to be applied to the element
# @see render_body_class
# @return [Array]
def extra_body_classes
@extra_body_classes ||= ['blacklight-' + controller.controller_name, 'blacklight-' + [controller.controller_name, controller.action_name].join('-')]
end
##
# Render the search navbar
# @return [String]
def render_search_bar
render :partial=>'catalog/search_form'
end
##
# Render "docuemnt actions" area for search results view
# (normally renders next to title in the list view)
#
# @param [SolrDocument] document
# @param [Hash] options
# @option options [String] :wrapping_class
# @return [String]
def render_index_doc_actions(document, options={})
wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
content = []
content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
content_tag("div", safe_join(content, "\n"), :class=> wrapping_class)
end
##
# Render "docuemnt actions" for the item detail 'show' view.
# (this normally renders next to title)
#
# By default includes 'Bookmarks'
#
# @param [SolrDocument] document
# @param [Hash] options
# @option options [String] :wrapping_class
# @return [String]
def render_show_doc_actions(document=@document, options={})
wrapping_class = options.delete(:wrapping_class) || "documentFunctions"
content = []
content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
content_tag("div", safe_join(content, "\n"), :class=> wrapping_class)
end
##
# Determine whether to render a given field in the index view.
#
# @param [SolrDocument] document
# @param [Blacklight::Solr::Configuration::SolrField] solr_field
# @return [Boolean]
def should_render_index_field? document, solr_field
should_render_field?(solr_field, document) && document_has_value?(document, solr_field)
end
##
# Determine whether to render a given field in the show view
#
# @param [SolrDocument] document
# @param [Blacklight::Solr::Configuration::SolrField] solr_field
# @return [Boolean]
def should_render_show_field? document, solr_field
should_render_field?(solr_field, document) && document_has_value?(document, solr_field)
end
##
# Check if a document has (or, might have, in the case of accessor methods) a value for
# the given solr field
# @param [SolrDocument] document
# @param [Blacklight::Solr::Configuration::SolrField] solr_field
# @return [Boolean]
def document_has_value? document, field_config
document.has?(field_config.field) ||
(document.has_highlight_field? field_config.field if field_config.highlight) ||
field_config.accessor
end
##
# Determine whether to display spellcheck suggestions
#
# @param [Blacklight::SolrResponse] response
# @return [Boolean]
def should_show_spellcheck_suggestions? response
response.total <= spell_check_max and response.spelling.words.size > 0
end
##
# Render the index field label for a document
#
# @overload render_index_field_label(options)
# Use the default, document-agnostic configuration
# @param [Hash] opts
# @options 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
def render_index_field_label *args
options = args.extract_options!
document = args.first
field = options[:field]
html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: index_field_label(document, field))
end
##
# Render the index field label for a document
#
# @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
# @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
# @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
def render_index_field_value *args
options = args.extract_options!
document = args.shift || options[:document]
field = args.shift || options[:field]
presenter(document).render_index_field_value field, options
end
##
# Render the show field label for a document
#
# @overload render_document_show_field_label(options)
# Use the default, document-agnostic configuration
# @param [Hash] opts
# @options 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
def render_document_show_field_label *args
options = args.extract_options!
document = args.first
field = options[:field]
t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
end
##
# Render the index field label for a document
#
# @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
# @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
# @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
def render_document_show_field_value *args
options = args.extract_options!
document = args.shift || options[:document]
field = args.shift || options[:field]
presenter(document).render_document_show_field_value field, options
end
##
# Get the value of the document's "title" field, or a placeholder
# value (if empty)
#
# @param [SolrDocument] document
# @return [String]
def document_heading document=nil
document ||= @document
presenter(document).document_heading
end
##
# Get the document's "title" to display in the element.
# (by default, use the #document_heading)
#
# @see #document_heading
# @param [SolrDocument] document
# @return [String]
def document_show_html_title document=nil
document ||= @document
presenter(document).document_show_html_title
end
##
# Render the document "heading" (title) in a content tag
# @overload render_document_heading(tag)
# @overload render_document_heading(document, options)
# @params [SolrDocument] document
# @params [Hash] options
# @options options [Symbol] :tag
def render_document_heading(*args)
options = args.extract_options!
if args.first.is_a? SolrDocument
document = args.shift
tag = options[:tag]
else
document = nil
tag = args.first || options[:tag]
end
tag ||= :h4
content_tag(tag, presenter(document).document_heading, :itemprop => "name")
end
##
# Get the value for a document's field, and prepare to render it.
# - highlight_field
# - accessor
# - solr field
#
# Rendering:
# - helper_method
# - link_to_search
# TODO : maybe this should be merged with render_field_value, and the ugly signature
# simplified by pushing some of this logic into the "model"
# @param [SolrDocument] document
# @param [String] field name
# @param [Blacklight::Solr::Configuration::SolrField] 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).get_field_values field, field_config, options
end
##
# Render a value (or array of values) from a field
#
# @deprecated Use DocumentPresenter instead
# @param [String] value or list of values to display
# @param [Blacklight::Solr::Configuration::SolrField] solr field configuration
# @return [String]
def render_field_value value=nil, field_config=nil
Deprecation.warn self, "render_field_value is deprecated. Use DocumentPresenter.render_field_value instead"
safe_values = Array(value).collect { |x| x.respond_to?(:force_encoding) ? x.force_encoding("UTF-8") : x }
if field_config and field_config.itemprop
safe_values = safe_values.map { |x| content_tag :span, x, :itemprop => field_config.itemprop }
end
safe_join(safe_values, (field_config.separator if field_config) || field_value_separator)
end
##
# Default separator to use in #render_field_value
#
# @return [String]
def field_value_separator
Deprecation.warn self, "field_value_separator is deprecated. Use DocumentPresenter.field_value_separator instead"
', '
end
##
# Get the current "view type" (and ensure it is a valid type)
#
# @param [Hash] the query parameters to check
# @return [Symbol]
def document_index_view_type query_params=params
if query_params[:view] and blacklight_config.view.keys.include? query_params[:view].to_sym
query_params[:view].to_sym
else
default_document_index_view_type
end
end
##
# Render the document index view
#
# @param [Array<SolrDocument>] list of documents to render
# @param [Hash] locals to pass to the render call
# @return [String]
def render_document_index documents = nil, locals = {}
documents ||= @document_list
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 :partial => 'catalog/group_default'
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>] 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 = {}
document_index_path_templates.each do |str|
# XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
# for determining if a partial template exists..
begin
return render(:partial => (str % { :index_view_type => view }), :locals => locals.merge(:documents => documents) )
rescue ActionView::MissingTemplate
nil
end
end
return ""
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]
# @param [Symbol] 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 and view_config.has_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
##
# 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
Array(display_type).join(" ").gsub("-","_").parameterize("_")
end
##
# Return the list of partials for a given solr document
# @param [SolrDocument]
# @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 for the partial
# @param [Hash] locales to pass through to the partials
def render_document_partial(doc, base_name, locals = {})
format = if method(:document_partial_name).arity == 1
Deprecation.warn self, "The #document_partial_name with a single argument is deprecated. Update your override to include a second argument for the 'base name'"
document_partial_name(doc)
else
document_partial_name(doc, base_name)
end
document_partial_path_templates.each do |str|
# XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
# for determining if a partial template exists..
begin
return render :partial => (str % { :action_name => base_name, :format => format, :index_view_type => document_index_view_type }), :locals=>locals.merge(:document=>doc)
rescue ActionView::MissingTemplate
nil
end
end
return ''
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", "catalog/%{action_name}_%{format}", "catalog/_%{action_name}_partials/%{format}", "catalog/_%{action_name}_partials/default"]
end
##
# Render the document index heading
#
# @param [SolrDocument] doc
# @param [Hash] opts
# @option opts [Symbol] :label Render the given field from the document
# @option opts [Proc] :label Evaluate the given proc
# @option opts [String] :label Render the given string
def render_document_index_label doc, opts = {}
presenter(doc).render_document_index_label opts
end
##
# Render a partial of an arbitrary format inside a
# template of a different format. (e.g. render an HTML
# partial from an XML template)
# code taken from:
# http://stackoverflow.com/questions/339130/how-do-i-render-a-partial-of-a-different-format-in-rails (zgchurch)
#
# @param [String] format suffix
# @yield
def with_format(format, &block)
old_formats = formats
self.formats = [format]
block.call
self.formats = old_formats
nil
end
##
# 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?
end
##
# Determine whether to render the bookmarks control
def render_bookmarks_control?
has_user_authentication_provider? and current_or_guest_user.present?
end
##
# Returns a document presenter for the given document
def presenter(document)
presenter_class.new(document, self)
end
##
# Override this method if you want to use a different presenter class
def presenter_class
Blacklight::DocumentPresenter
end
##
# Open Search discovery tag for HTML <head> links
def opensearch_description_tag title, href
tag :link, href: href, title: title, type: "application/opensearchdescription+xml", rel: "search"
end
end