blacklight 5.0.0.pre3 → 5.0.0.pre4

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -75,7 +75,7 @@ module Blacklight::CatalogHelperBehavior
   end
 
   def render_document_class(document = @document)
-   'blacklight-' + document.get(blacklight_config.index.record_display_type).parameterize rescue nil
+    'blacklight-' + document.get(blacklight_config.view_config(document_index_view_type_field).display_type_field).parameterize rescue nil
   end
 
   def render_document_sidebar_partial(document = @document)
@@ -98,14 +98,14 @@ module Blacklight::CatalogHelperBehavior
   end
 
   def has_thumbnail? document
-    blacklight_config.index.thumbnail_method or
-      blacklight_config.index.thumbnail_field && document.has?(blacklight_config.index.thumbnail_field)
+    blacklight_config.view_config(document_index_view_type).thumbnail_method or
+      blacklight_config.view_config(document_index_view_type).thumbnail_field && document.has?(blacklight_config.view_config(document_index_view_type).thumbnail_field)
   end
 
   def render_thumbnail_tag document, image_options = {}, url_options = {}
-    value = if blacklight_config.index.thumbnail_method
-      send(blacklight_config.index.thumbnail_method, document, image_options)
-    elsif blacklight_config.index.thumbnail_field
+    value = if blacklight_config.view_config(document_index_view_type).thumbnail_method
+      send(blacklight_config.view_config(document_index_view_type).thumbnail_method, document, image_options)
+    elsif blacklight_config.view_config(document_index_view_type).thumbnail_field
       image_tag thumbnail_url(document), image_options
     end
 
@@ -115,12 +115,24 @@ module Blacklight::CatalogHelperBehavior
   end
 
   def thumbnail_url document
-    if document.has? blacklight_config.index.thumbnail_field
-      document.first(blacklight_config.index.thumbnail_field)
+    if document.has? blacklight_config.view_config(document_index_view_type).thumbnail_field
+      document.first(blacklight_config.view_config(document_index_view_type).thumbnail_field)
     end
   end
 
   def add_group_facet_params_and_redirect group
     add_facet_params_and_redirect(group.field, group.key)
   end
+
+  def has_alternative_views?
+    blacklight_config.view.keys.length > 1
+  end
+
+  def render_view_type_group_icon view
+    content_tag :span, '', class: "glyphicon #{blacklight_config.view[view].icon_class || default_view_type_group_icon_classes(view) }"
+  end
+
+  def default_view_type_group_icon_classes view
+    "glyphicon-#{view.to_s.parameterize } view-icon-#{view.to_s.parameterize}"
+  end
 end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -117,89 +117,6 @@ module Blacklight::FacetsHelperBehavior
     content_tag("span", t('blacklight.search.facets.count', :number => num), :class => classes)
   end
   
-  # adds the value and/or field to params[:f]
-  # Does NOT remove request keys and otherwise ensure that the hash
-  # is suitable for a redirect. See
-  # add_facet_params_and_redirect
-  def add_facet_params(field, item, source_params = params)
-
-    if item.respond_to? :field
-      field = item.field
-    end
-
-    facet_config = facet_configuration_for_field(field)
-
-    value = facet_value_for_facet_item(item)
-
-    p = source_params.dup
-    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
-    p[:f][field] = (p[:f][field] || []).dup
-
-    if facet_config.single and not p[:f][field].empty?
-      p[:f][field] = []
-    end
-    
-    p[:f][field].push(value)
-
-    if item and item.respond_to?(:fq) and item.fq
-      item.fq.each do |f,v|
-        p = add_facet_params(f, v, p)
-      end
-    end
-
-    p
-  end
-
-  # Used in catalog/facet action, facets.rb view, for a click
-  # on a facet value. Add on the facet params to existing
-  # search constraints. Remove any paginator-specific request
-  # params, or other request params that should be removed
-  # for a 'fresh' display. 
-  # Change the action to 'index' to send them back to
-  # catalog/index with their new facet choice. 
-  def add_facet_params_and_redirect(field, item)
-    new_params = add_facet_params(field, item)
-
-    # Delete page, if needed. 
-    new_params.delete(:page)
-
-    # Delete any request params from facet-specific action, needed
-    # to redir to index action properly. 
-    Blacklight::Solr::FacetPaginator.request_keys.values.each do |paginator_key| 
-      new_params.delete(paginator_key)
-    end
-    new_params.delete(:id)
-
-    # Force action to be index. 
-    new_params[:action] = "index"
-    new_params    
-  end
-  # copies the current params (or whatever is passed in as the 3rd arg)
-  # removes the field value from params[:f]
-  # removes the field if there are no more values in params[:f][field]
-  # removes additional params (page, id, etc..)
-  def remove_facet_params(field, item, source_params=params)
-    if item.respond_to? :field
-      field = item.field
-    end
-
-    value = facet_value_for_facet_item(item)
-
-    p = source_params.dup
-    # need to dup the facet values too,
-    # if the values aren't dup'd, then the values
-    # from the session will get remove in the show view...
-    p[:f] = (p[:f] || {}).dup
-    p[:f][field] = (p[:f][field] || []).dup
-    p.delete :page
-    p.delete :id
-    p.delete :counter
-    p.delete :commit
-    p[:f][field] = p[:f][field] - [value]
-    p[:f].delete(field) if p[:f][field].size == 0
-    p
-  end
-
   def facet_field_in_params? field
     params[:f] and params[:f][field]
   end

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -14,7 +14,7 @@ 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. 
-  def hash_as_hidden_fields(hash)
+  def render_hash_as_hidden_fields(hash)
     
     hidden_fields = []
     flatten_hash(hash).each do |name, value|

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -0,0 +1,201 @@
+module Blacklight::UrlHelperBehavior
+
+  # link_to_document(doc, :label=>'VIEW', :counter => 3)
+  # Use the catalog_path RESTful route to create a link to the show page for a specific item.
+  # catalog_path accepts a HashWithIndifferentAccess object. 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.
+  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, doc, search_session_params(opts[:counter]).merge(opts.reject { |k,v| [:label, :counter].include? k  })
+  end
+
+  def link_to_previous_document(previous_document)
+    link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), previous_document, search_session_params(search_session[:counter].to_i - 1).merge(:class => "previous", :rel => 'prev')  do
+      content_tag :span, raw(t('views.pagination.previous')), :class => 'previous'
+    end
+  end
+
+  def link_to_next_document(next_document)
+    link_to_unless next_document.nil?, raw(t('views.pagination.next')), next_document, search_session_params(search_session[:counter].to_i + 1).merge(:class => "next", :rel => 'next') do
+      content_tag :span, raw(t('views.pagination.next')), :class => 'next'
+    end
+  end
+
+  def search_session_params counter
+    { :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
+  end
+
+  #
+  # link based helpers ->
+  #
+
+  # create link to query (e.g. spelling suggestion)
+  def link_to_query(query)
+    p = params.except(:page, :action)
+    p[:q]=query
+    link_url = catalog_index_path(p)
+    link_to(query, link_url)
+  end
+
+  ##
+  # 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 = { }
+    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
+
+    search_action_url(h)
+  end
+
+  # Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
+  # @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})
+    scope = opts.delete(:route_set) || self
+    query_params = current_search_session.try(:query_params) || {}
+    link_url = scope.url_for(query_params)
+    label = opts.delete(:label)
+
+    if link_url =~ /bookmarks/
+      label ||= t('blacklight.back_to_bookmarks')
+    end
+
+    label ||= t('blacklight.back_to_search')
+
+    link_to label, link_url, opts
+  end
+
+  # Search History and Saved Searches display
+  def link_to_previous_search(params)
+    link_to(render_search_to_s(params), catalog_index_path(params))
+  end
+
+  # @overload params_for_search(source_params, params_to_merge)
+  #   Merge the source params with the params_to_merge hash
+  #   @param [Hash] Hash 
+  #   @param [Hash] Hash to merge into above
+  # @overload params_for_search(params_to_merge)
+  #   Merge the current search parameters with the 
+  #      parameters provided. 
+  #   @param [Hash] Hash to merge into the parameters
+  # @overload params_for_search
+  #   Returns the current search parameters after being sanitized by #sanitize_search_params
+  # @yield [params] The merged parameters hash before being sanitized
+  def params_for_search(*args, &block)
+
+    source_params, params_to_merge = case args.length
+    when 0
+      [params, {}]
+    when 1
+      [params, args.first]
+    when 2
+      [args.first, args.last]
+    else
+      raise ArgumentError.new "wrong number of arguments (#{args.length} for 0..2)"
+    end
+
+    # params hash we'll return
+    my_params = source_params.dup.merge(params_to_merge.dup)
+
+    if block_given?
+      yield my_params
+    end
+
+    if my_params[:page] and (my_params[:per_page] != source_params[:per_page] or my_params[:sort] != source_params[:sort] )
+      my_params[:page] = 1
+    end
+
+    sanitize_search_params(my_params)
+  end
+
+  ##
+  # Sanitize the search parameters by removing unnecessary parameters
+  # from the provided parameters
+  # @param [Hash] Hash of parameters
+  def sanitize_search_params source_params
+
+    my_params = source_params.reject { |k,v| v.nil? }
+
+    my_params.except(:action, :controller, :id, :commit, :utf8)
+
+  end
+
+  # adds the value and/or field to params[:f]
+  # Does NOT remove request keys and otherwise ensure that the hash
+  # is suitable for a redirect. See
+  # add_facet_params_and_redirect
+  def add_facet_params(field, item, source_params = params)
+
+    if item.respond_to? :field
+      field = item.field
+    end
+
+    facet_config = facet_configuration_for_field(field)
+
+    value = facet_value_for_facet_item(item)
+
+    p = source_params.dup
+    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
+    p[:f][field] = (p[:f][field] || []).dup
+
+    if facet_config.single and not p[:f][field].empty?
+      p[:f][field] = []
+    end
+    
+    p[:f][field].push(value)
+
+    if item and item.respond_to?(:fq) and item.fq
+      item.fq.each do |f,v|
+        p = add_facet_params(f, v, p)
+      end
+    end
+
+    p
+  end
+
+  # Used in catalog/facet action, facets.rb view, for a click
+  # on a facet value. Add on the facet params to existing
+  # search constraints. Remove any paginator-specific request
+  # params, or other request params that should be removed
+  # for a 'fresh' display. 
+  # Change the action to 'index' to send them back to
+  # catalog/index with their new facet choice. 
+  def add_facet_params_and_redirect(field, item)
+    new_params = add_facet_params(field, item)
+    new_params.except! :page, :id
+
+    # Delete any request params from facet-specific action, needed
+    # to redir to index action properly. 
+    new_params.except! *Blacklight::Solr::FacetPaginator.request_keys.values
+
+    # Force action to be index. 
+    new_params[:action] = "index"
+    new_params    
+  end
+  # copies the current params (or whatever is passed in as the 3rd arg)
+  # removes the field value from params[:f]
+  # removes the field if there are no more values in params[:f][field]
+  # removes additional params (page, id, etc..)
+  def remove_facet_params(field, item, source_params=params)
+    if item.respond_to? :field
+      field = item.field
+    end
+
+    value = facet_value_for_facet_item(item)
+
+    p = source_params.dup
+    # need to dup the facet values too,
+    # if the values aren't dup'd, then the values
+    # from the session will get remove in the show view...
+    p[:f] = (p[:f] || {}).dup
+    p[:f][field] = (p[:f][field] || []).dup
+    p.except! :page, :id, :counter, :commit
+    p[:f][field] = p[:f][field] - [value]
+    p[:f].delete(field) if p[:f][field].size == 0
+    p
+  end
+
+end

data/app/helpers/blacklight_url_helper.rb

@@ -0,0 +1,3 @@
+module BlacklightUrlHelper
+  include Blacklight::UrlHelperBehavior
+end

data/app/views/bookmarks/_tools.html.erb

@@ -2,13 +2,10 @@
       <li class="cite">
         <%= link_to t('blacklight.tools.cite'), citation_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @bookmarks.collect{|doc| doc.document_id}), {:id => 'citeLink', :name => 'citation', :class => 'btn btn-default', :data => {:ajax_modal => "trigger"}} %>
       </li>
-      <li class="refworks">
-        <%= render :partial => 'catalog/refworks_form', :locals => {:documents=>@document_list} %>
-      </li>
-
-      <li class="endnote">
-        <%= link_to t('blacklight.tools.endnote'), endnote_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @bookmarks.collect {|doc| doc.document_id}, :format => 'endnote'), {:class => 'btn btn-default'}%>
-      </li>
+      <% if defined? BlacklightMarc %>
+        <%= render partial: 'bookmarks/refworks' %>
+        <%= render partial: 'bookmarks/endnote' %>
+      <% end %>
       <li class="email">
         <%= link_to t('blacklight.tools.email'), email_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @bookmarks.collect {|doc| doc.document_id}), :class=>"btn btn-default", :id => "emailLink", :data => {:ajax_modal => "trigger"} %>
       </li>

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

@@ -1,7 +1,7 @@
 
 <% @documents.each do |document| %>
 
-  <h3 class="modal-title"><%= citation_title(document) %></h3>
+  <h3 class="modal-title"><%= document_heading(document) %></h3>
 
 <% if document.respond_to?(:export_as_mla_citation_txt) %>
   <h4><%= t('blacklight.citation.mla') %></h4>

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

@@ -1,4 +1,4 @@
-<% if @response.total <= spell_check_max and @response.spelling.words.size > 0 %>
+<% if should_show_spellcheck_suggestions? @response %>
   <div id="spell">
     <h4 class="suggest"><em><%= t('blacklight.did_you_mean', :options => safe_join(@response.spelling.words.map { |word| link_to_query(word) }, " #{t('blacklight.or')} ")).html_safe %></em></h4>
   </div>

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

@@ -1,4 +1,4 @@
 <% # container for a single doc -%>
 <div class="document <%= render_document_class document %>" itemscope itemtype="<%= document.itemtype %>">
-  <%= render_document_partials document, blacklight_config.index.partials, :document_counter => document_counter %>
+  <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, :document_counter => document_counter %>
 </div>

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

@@ -1,5 +1,5 @@
   <%= form_tag search_action_url, :method => :get, :class => 'search-query-form form-inline clearfix navbar-form' do %>
-    <%= search_as_hidden_fields(:omit_keys => [:q, :search_field, :qt, :page, :utf8]) %>
+    <%= render_hash_as_hidden_fields(params_for_search().except(:q, :search_field, :qt, :page, :utf8)) %>
 
     <div class="input-group">
     <% unless search_fields.empty? %>

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

@@ -1,3 +1,3 @@
 <li class="more_like_this_document">
-  <span class="mlt_title"><%= link_to_document document, :label=>document_show_link_field %></span>
+  <span class="mlt_title"><%= link_to_document document, :label=>document_show_link_field(document) %></span>
 </li>

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

@@ -1,10 +1,10 @@
-<% if blacklight_config.document_index_view_types.length > 1 -%>
+<% if has_alternative_views? -%>
 <div class="view-type">
   <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
-    <%  blacklight_config.document_index_view_types.each do |view| %>
-    <%= link_to url_for(params.merge(:view => view)), :title => t("blacklight.search.view_title.#{view}", default: t("blacklight.search.view.#{view}", default: "")), :class => "btn btn-default view-type-#{ view.parameterize } #{"active" if document_index_view_type == view}" do %>
-        <span class="glyphicon glyphicon-<%= view.parameterize %> view-icon-<%= view.parameterize %>"></span>
+    <%  blacklight_config.view.keys.each do |view| %>
+    <%= link_to url_for(params.merge(:view => view)), :title => t("blacklight.search.view_title.#{view}", default: t("blacklight.search.view.#{view}", default: blacklight_config.view[view].title)), :class => "btn btn-default view-type-#{ view.to_s.parameterize } #{"active" if document_index_view_type == view}" do %>
+      <%= render_view_type_group_icon view %>
         <span class="caption"><%= t("blacklight.search.view.#{view}") %></span>
       <% end %>
     <% end %>

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

@@ -1,5 +1,5 @@
 <div class="modal-header">
-<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+<button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
 <h1 class="modal-title"><%= t('blacklight.email.form.title') %></h1>
   </div>
-<%= render :partial => 'email_form' %>
+<%= render :partial => 'email_form' %>

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

@@ -3,7 +3,7 @@
 </div>
 
 <div class="modal-header">
-  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+  <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
   <h3 class="modal-title"><%= blacklight_config.facet_fields[params[:id]].label %></h3>
 </div>
 <div class="modal-body">