blacklight 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a001b98201040df18b0c251d644db58d7b462cb
-  data.tar.gz: f193d5ea8bb6f8b106e525884982a34578c50cf1
+  metadata.gz: fea671a4828e18416d64b657b46a176d12825b99
+  data.tar.gz: 559e98ff68f295b5f353eb50272eebf4b856443e
 SHA512:
-  metadata.gz: 632d7373d5a5060a2459df1d57c57d26bfe5584bb7c7883e3382f9190f8b53eef02450bd971e282fb1e8912c9411ce1b665efab6bc2f6c81beb02c7cc00c720d
-  data.tar.gz: 991c52e5c79ececb1a29300ce97a8f457c8489cbb2447a6913374d6c24bfb8b9a7fc5802a9af279dfeaf0aaa95bb6b2089b7503377a98cc4c246c00016a2260f
+  metadata.gz: 665816f47ac58bbdff19053888a885fe2b4b682e56b59bcf390e859c0d2c4f8b2aac7dd07bdd269eb620ff2d5271bcd9e0527dba75423c920a83d08502bf24e8
+  data.tar.gz: 37756999f96379e3908381a2959e6437533a7f0c860ccd29479bac5e64a24f9ed0014b207169641d6de1368b8204b6bd81c52ae8e6a7bff58b4631cb4d624697

data/.travis.yml

@@ -2,6 +2,7 @@ notifications:
   email: false
 
 rvm:
+  - 2.1.1
   - 2.1.0
   - 2.0.0
   - 1.9.3
@@ -13,6 +14,7 @@ before_install:
 gemfile:
   - gemfiles/rails3.gemfile
   - gemfiles/rails4.gemfile
+  - gemfiles/rails4.1.gemfile
 
 notifications:
   irc: "irc.freenode.org#blacklight"

data/VERSION

@@ -1 +1 @@
-5.1.1
+5.2.0

data/app/assets/javascripts/blacklight/search_context.js

@@ -1,28 +1,42 @@
 //= require blacklight/core
 (function($) {
   Blacklight.do_search_context_behavior = function() {
-      $('a[data-counter]').click(function(event) {
-      var f = document.createElement('form'); f.style.display = 'none'; 
-      this.parentNode.appendChild(f); 
-      f.method = 'POST'; 
-      f.action = $(this).attr('href');
-      if(event.metaKey || event.ctrlKey){f.target = '_blank';};
-      var d = document.createElement('input'); d.setAttribute('type', 'hidden'); 
-      d.setAttribute('name', 'counter'); d.setAttribute('value', $(this).data('counter')); f.appendChild(d);
-      var id = document.createElement('input'); id.setAttribute('type', 'hidden');
-      id.setAttribute('name', 'search_id'); id.setAttribute('value', $(this).data('search_id')); f.appendChild(id);
-      var m = document.createElement('input'); m.setAttribute('type', 'hidden'); 
-      m.setAttribute('name', '_method'); m.setAttribute('value', 'put'); f.appendChild(m);
-      var m = document.createElement('input'); m.setAttribute('type', 'hidden'); 
-      m.setAttribute('name', $('meta[name="csrf-param"]').attr('content')); m.setAttribute('value', $('meta[name="csrf-token"]').attr('content')); f.appendChild(m);
-
-      f.submit();
-        
-      return false;
-      });
-
-    };  
-Blacklight.onLoad(function() {
-  Blacklight.do_search_context_behavior();  
-});
+    $('a[data-context-href]').on('click.search-context', Blacklight.handleSearchContextMethod);
+  };
+
+  // this is the $.rails.handleMethod with a couple adjustments, described inline:
+  // first, we're attaching this directly to the event handler, so we can check for meta-keys
+  Blacklight.handleSearchContextMethod = function(event) {
+    var link = $(this);
+
+    // instead of using the normal href, we need to use the context href instead
+    var href = link.data('context-href'),
+      method = 'post',
+      target = link.attr('target'),
+      csrfToken = $('meta[name=csrf-token]').attr('content'),
+      csrfParam = $('meta[name=csrf-param]').attr('content'),
+      form = $('<form method="post" action="' + href + '"></form>'),
+      metadataInput = '<input name="_method" value="' + method + '" type="hidden" />',
+      redirectHref = '<input name="redirect" value="' + link.attr('href') + '" type="hidden" />';
+
+    // check for meta keys.. if set, we should open in a new tab
+    if(event.metaKey || event.ctrlKey) {
+      target = '_blank';
+    }
+
+    if (csrfParam !== undefined && csrfToken !== undefined) {
+      metadataInput += '<input name="' + csrfParam + '" value="' + csrfToken + '" type="hidden" />';
+    }
+
+    if (target) { form.attr('target', target); }
+
+    form.hide().append(metadataInput).append(redirectHref).appendTo('body');
+    form.submit();
+
+    return false;
+  };
+
+  Blacklight.onLoad(function() {
+    Blacklight.do_search_context_behavior();
+  });
 })(jQuery);

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -15,13 +15,21 @@ module Blacklight::BlacklightHelperBehavior
   #  - the Rails configuration
   #  - an i18n string (key: blacklight.application_name; preferred)
   # 
-  # @return [String] the application named
+  # @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 <link rel="alternate"> links from a documents dynamically
   # provided export formats. Currently not used by standard BL layouts,
@@ -201,10 +209,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    field_config = index_fields(document)[field]
-    value = options[:value] || get_field_values(document, field, field_config, options)
-
-    render_field_value value, field_config
+    presenter(document).render_index_field_value field, options
   end
 
   ##
@@ -226,7 +231,7 @@ module Blacklight::BlacklightHelperBehavior
 
     field = options[:field]
 
-    html_escape t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
+    t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
   end
 
   ##
@@ -257,10 +262,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    field_config = document_show_fields(document)[field]
-    value = options[:value] || get_field_values(document, field, field_config, options)
-
-    render_field_value value, field_config
+    presenter(document).render_document_show_field_value field, options
   end
 
   ##
@@ -271,7 +273,7 @@ module Blacklight::BlacklightHelperBehavior
   # @return [String]
   def document_heading document=nil
     document ||= @document
-    render_field_value(document[blacklight_config.view_config(:show).title_field] || document.id)
+    presenter(document).document_heading
   end
 
   ##
@@ -284,11 +286,7 @@ module Blacklight::BlacklightHelperBehavior
   def document_show_html_title document=nil
     document ||= @document
 
-    if blacklight_config.view_config(:show).html_title_field
-      render_field_value(document[blacklight_config.view_config(:show).html_title_field])
-    else
-      document_heading document
-    end
+    presenter(document).document_show_html_title
   end
 
   ##
@@ -310,7 +308,7 @@ module Blacklight::BlacklightHelperBehavior
 
     tag ||= :h4
 
-    content_tag(tag, render_field_value(document_heading(document)), :itemprop => "name")
+    content_tag(tag, presenter(document).document_heading, :itemprop => "name")
   end
 
   ##
@@ -329,55 +327,18 @@ module Blacklight::BlacklightHelperBehavior
   # @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 = {}
-    # retrieving values
-    value = case    
-      when (field_config and field_config.highlight)
-        # retrieve the document value from the highlighting response
-        document.highlight_field(field_config.field).map { |x| x.html_safe } if document.has_highlight_field? field_config.field
-      when (field_config and field_config.accessor)
-        # implicit method call
-        if field_config.accessor === true
-          document.send(field)
-        # arity-1 method call (include the field name in the call)
-        elsif !field_config.accessor.is_a?(Array) && document.method(field_config.accessor).arity != 0
-          document.send(field_config.accessor, field)
-        # chained method calls
-        else
-          Array(field_config.accessor).inject(document) do |result, method|
-            result.send(method)
-          end
-        end
-      else
-        # regular solr
-        document.get(field, :sep => nil) if field
-    end
-
-    # rendering values
-    case
-      when (field_config and field_config.helper_method)
-        send(field_config.helper_method, options.merge(:document => document, :field => field, :value => value))
-      when (field_config and field_config.link_to_search)
-        link_field = if field_config.link_to_search === true
-          field_config.field
-        else
-          field_config.link_to_search
-        end
-
-        Array(value).map do |v|
-          link_to render_field_value(v, field_config), search_action_path(add_facet_params(link_field, v, {}))
-        end if field
-      else
-        value
-      end
+    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
@@ -392,6 +353,7 @@ module Blacklight::BlacklightHelperBehavior
   #
   # @return [String]
   def field_value_separator
+    Deprecation.warn self, "field_value_separator is deprecated. Use DocumentPresenter.field_value_separator instead"
     ', '
   end
 
@@ -466,19 +428,25 @@ module Blacklight::BlacklightHelperBehavior
 
   ##
   # 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)
-    display_type = document[blacklight_config.view_config(:show).display_type_field]
+  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]
 
-    return 'default' unless display_type
-    display_type = display_type.join(" ") if display_type.respond_to?(:join)
+    display_type ||= 'default'
 
     # .to_s is necessary otherwise the default return value is not always a string
     # using "_" as sep. to more closely follow the views file naming conventions
     # parameterize uses "-" as the default sep. which throws errors
-    "#{display_type.gsub("-"," ")}".parameterize("_").to_s
+    Array(display_type).join(" ").gsub("-","_").parameterize("_")
   end
 
   ##
@@ -504,7 +472,12 @@ module Blacklight::BlacklightHelperBehavior
   # @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 = document_partial_name(doc)
+    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
@@ -544,12 +517,7 @@ module Blacklight::BlacklightHelperBehavior
   # @option opts [Proc] :label Evaluate the given proc
   # @option opts [String] :label Render the given string
   def render_document_index_label doc, opts = {}
-    label = nil
-    label ||= doc.get(opts[:label], :sep => nil) if opts[:label].instance_of? Symbol
-    label ||= opts[:label].call(doc, opts) if opts[:label].instance_of? Proc
-    label ||= opts[:label] if opts[:label].is_a? String
-    label ||= doc.id
-    render_field_value label
+    presenter(doc).render_document_index_label opts
   end
 
   ##
@@ -582,4 +550,15 @@ module Blacklight::BlacklightHelperBehavior
     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
 end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -61,7 +61,7 @@ module Blacklight::CatalogHelperBehavior
   # @see #page_entries_info
   # @return [String]
   def item_page_entry_info
-    t('blacklight.search.entry_pagination_info.other', :current => number_with_delimiter(search_session[:counter]), :total => number_with_delimiter(search_session[:total]), :count => search_session[:total].to_i).html_safe
+    t('blacklight.search.entry_pagination_info.other', :current => number_with_delimiter(search_session['counter']), :total => number_with_delimiter(search_session['total']), :count => search_session['total'].to_i).html_safe
   end
 
   ##
@@ -113,13 +113,6 @@ module Blacklight::CatalogHelperBehavior
     render :partial => 'show_sidebar'
   end
 
-  ##
-  # Check if any search parameters have been set
-  # @return [Boolean] 
-  def has_search_parameters?
-    !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
-  end
-
   ##
   # Should we display the sort and per page widget?
   # 

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -116,6 +116,14 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # The default value for search results per page
   def default_per_page
-    blacklight_config.per_page.first unless blacklight_config.per_page.blank?
+    blacklight_config.default_per_page || blacklight_config.per_page.first
   end
-end
+  
+  ##
+  # 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]
+    end
+  end
+end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -166,7 +166,7 @@ module Blacklight::FacetsHelperBehavior
 
     value = facet_value_for_facet_item(item)
 
-    facet_field_in_params?(field) and params[:f][field].include?(value)
+    params[:f] and params[:f][field] and params[:f][field].include?(value)
   end
 
   ##
@@ -198,6 +198,9 @@ module Blacklight::FacetsHelperBehavior
     end
   end
 
+  def facet_field_id facet_field
+    "facet-#{facet_field.field.parameterize}"
+  end
 
   private
 

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -19,13 +19,13 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   ##
   # Render the search query constraint
   def render_search_to_s_q(params)
-    return "".html_safe if params[:q].blank?
+    return "".html_safe if params['q'].blank?
     
     label = (default_search_field && params[:search_field] == default_search_field[:key]) ? 
       nil :
       label_for_search_field(params[:search_field])
     
-    render_search_to_s_element(label , render_filter_value(params[:q]) )
+    render_search_to_s_element(label , render_filter_value(params['q']) )
   end
 
   ##

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -1,11 +1,19 @@
+require 'deprecation'
 module Blacklight::UrlHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 6.0'
 
   ##
   # Extension point for downstream applications
-  # to provide more interesting routing to 
+  # to provide more interesting routing to
   # documents
   def url_for_document doc
-    doc
+    if controller.is_a? Blacklight::Catalog and doc.is_a? SolrDocument and
+        (!doc.respond_to?(:to_model) or doc.to_model.is_a? SolrDocument)
+      { controller: controller_name, action: :show, id: doc }
+    else
+      doc
+    end
   end
 
   # link_to_document(doc, :label=>'VIEW', :counter => 3)
@@ -15,13 +23,19 @@ module Blacklight::UrlHelperBehavior
   def link_to_document(doc, opts={:label=>nil, :counter => nil})
     opts[:label] ||= document_show_link_field(doc)
     label = render_document_index_label doc, opts
-    link_to label, url_for_document(doc), search_session_params(opts[:counter]).merge(opts.reject { |k,v| [:label, :counter].include? k  })
+    link_to label, url_for_document(doc), document_link_params(doc, opts)
   end
 
+  def document_link_params(doc, opts)
+    session_tracking_params(doc, opts[:counter]).deep_merge(opts.except(:label, :counter))
+  end
+  protected :document_link_params
+
   ##
   # Link to the previous document in the current search context
   def link_to_previous_document(previous_document)
-    link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), search_session_params(search_session[:counter].to_i - 1).merge(:class => "previous", :rel => 'prev')  do
+    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'
     end
   end
@@ -29,16 +43,35 @@ module Blacklight::UrlHelperBehavior
   ##
   # Link to the next document in the current search context
   def link_to_next_document(next_document)
-    link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), search_session_params(search_session[:counter].to_i + 1).merge(:class => "next", :rel => 'next') do
+    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'
     end
   end
 
   ##
   # Current search context parameters
-  def search_session_params counter
+  def search_session_params counter 
     { :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
   end
+  deprecation_deprecate :search_session_params
+
+  ##
+  # Attributes for a link that gives a URL we can use to track clicks for the current search session
+  # @param [SolrDocument] document
+  # @param [Integer] counter
+  # @example
+  #   session_tracking_params(SolrDocument.new(id: 123), 7)
+  #   => { data: { :'tracker-href' => '/catalog/123/track?counter=7&search_id=999' } }
+  def session_tracking_params document, counter
+    if document.nil?
+      return {}
+    end
+  
+    { :data => {:'context-href' => track_solr_document_path(document, counter: counter, search_id: current_search_session.try(:id))}}
+  end
+  protected :session_tracking_params
+  
 
   #
   # link based helpers ->
@@ -140,7 +173,7 @@ module Blacklight::UrlHelperBehavior
   # Reset any search parameters that store search context
   # and need to be reset when e.g. constraints change
   def reset_search_params source_params
-    sanitize_search_params(source_params).except :page, :counter
+    sanitize_search_params(source_params).except(:page, :counter).with_indifferent_access
   end
 
   # adds the value and/or field to params[:f]
@@ -212,6 +245,7 @@ module Blacklight::UrlHelperBehavior
     p[:f][field] = (p[:f][field] || []).dup
     p[:f][field] = p[:f][field] - [value]
     p[:f].delete(field) if p[:f][field].size == 0
+    p.delete(:f) if p[:f].empty?
     p
   end
 

data/app/views/catalog/_facet_layout.html.erb

@@ -1,10 +1,10 @@
 <div class="panel panel-default facet_limit blacklight-<%= facet_field.field.parameterize %> <%= 'facet_limit-active' if facet_field_in_params?(facet_field.field) %>">
-  <div class="<%= "collapsed" if should_collapse_facet?(facet_field) %> collapse-toggle panel-heading" data-toggle="collapse" data-target="#facet-<%= facet_field.label.parameterize %>">
+  <div class="<%= "collapsed" if should_collapse_facet?(facet_field) %> collapse-toggle panel-heading" data-toggle="collapse" data-target="#<%= facet_field_id(facet_field) %>">
     <h5 class="panel-title">
       <%= link_to facet_field_label(facet_field.field), "#", :"data-no-turbolink" => true %>
     </h5>
   </div>
-  <div id="facet-<%= facet_field.label.parameterize %>" class="panel-collapse facet-content <%= should_collapse_facet?(facet_field) ? 'collapse' : 'in' %>">
+  <div id="<%= facet_field_id(facet_field) %>" class="panel-collapse facet-content <%= should_collapse_facet?(facet_field) ? 'collapse' : 'in' %>">
     <div class="panel-body">
       <%= yield %>
     </div>

data/app/views/catalog/_per_page_widget.html.erb

@@ -4,9 +4,9 @@
 <div id="per_page-dropdown" class="btn-group">
   <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown"><%= link_to(t(:'blacklight.search.per_page.button_label', :count => current_per_page), "#") %> <span class="caret"></span></button>
   <ul class="dropdown-menu">
-        <%- blacklight_config.per_page.each do |count| %>
-          <li><%= link_to(t(:'blacklight.search.per_page.label', :count => count).html_safe, url_for(params_for_search(:per_page => count))) %></li>
-        <%- end -%>
+    <%- per_page_options_for_select.each do |(label, count)| %>
+      <li><%= link_to(label, url_for(params_for_search(:per_page => count))) %></li>
+    <%- end -%>
   </ul>
 </div>
-<% end %>
+<% end %>

data/app/views/catalog/_previous_next_doc.html.erb

@@ -15,4 +15,4 @@
         <%=link_to "#{t('blacklight.search.start_over')}", start_over_path(current_search_session.try(:query_params) || {}), :id=>"startOverLink", :class => 'btn' %>
   	</div>
   </div>
-<% end %>
+<% end %>

data/app/views/catalog/_show_tools.html.erb

@@ -13,7 +13,7 @@
   </div>
 
   <div class="panel-body">
-  <ul class="nav nav-list">
+  <ul class="nav">
       <li>
         <%= render_show_doc_actions @document %>
       </li>

data/app/views/catalog/show.html.erb

@@ -3,7 +3,7 @@
   <%= render 'previous_next_doc' %>
 
    
-<% @page_title = t('blacklight.search.show.title', :document_title => document_show_html_title, :application_name => application_name) -%>
+<% @page_title = t('blacklight.search.show.title', :document_title => document_show_html_title, :application_name => application_name).html_safe -%>
 <% content_for(:head) { render_link_rel_alternates } -%>
 <%# this should be in a partial -%>
 

data/app/views/layouts/blacklight.html.erb

@@ -13,7 +13,7 @@
       <meta http-equiv="cleartype" content="on">
     <![endif]-->
 
-    <title><%= h(@page_title || application_name) %></title>
+    <title><%= render_page_title %></title>
     <link href="<%= opensearch_catalog_path(:format => 'xml', :only_path => false) %>" title="<%= application_name%>" type="application/opensearchdescription+xml" rel="search"/>
     <%= favicon_link_tag asset_path('favicon.ico') %>
     <%= stylesheet_link_tag    "application" %>

data/blacklight.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency "bootstrap-sass", "~> 3.0"
   s.add_dependency "deprecation"
 
-  s.add_development_dependency "jettywrapper", ">= 1.5.2"
+  s.add_development_dependency "jettywrapper", ">= 1.7.0"
   s.add_development_dependency "blacklight-marc", "~> 5.0"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "capybara"

data/config/jetty.yml

@@ -5,3 +5,6 @@ test:
   startup_wait: 60
   jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>
+production:
+  startup_wait: 15
+  jetty_port: 8983