blacklight 4.9.0 → 5.0.0.pre1

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,15 +1,10 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::CatalogHelperBehavior
 
-  extend Deprecation
-  self.deprecation_horizon = 'Blacklight 5.x'
-
   # Pass in an RSolr::Response (or duck-typed similar) object,
   # it translates to a Kaminari-paginatable
   # object, with the keys Kaminari views expect.
   def paginate_params(response)
-    Deprecation.warn Blacklight::CatalogHelperBehavior, "#paginate_params is deprecated; the original response object is Kaminari-compatible"
-
     response
   end
 
@@ -19,51 +14,25 @@ module Blacklight::CatalogHelperBehavior
   # kaminari paginate, passed on through.
   # will output HTML pagination controls.
   def paginate_rsolr_response(response, options = {}, &block)
-    Deprecation.warn Blacklight::CatalogHelperBehavior, "#paginate_rsolr_response is deprecated; the original response object is Kaminari-compatible"
     paginate response, options, &block
   end
 
   #
   # shortcut for built-in Rails helper, "number_with_delimiter"
   #
-  def format_num(num)
-    Deprecation.warn Blacklight::CatalogHelperBehavior, "#format_num is deprecated; use e.g. #number_with_delimiter directly"
-    number_with_delimiter(num)
-  end
-
-  #
-  # Pass in an RSolr::Response. Displays the "showing X through Y of N" message.
-  def render_pagination_info(response, options = {})
-    Deprecation.silence(Blacklight::CatalogHelperBehavior) do 
-      entry_name = options[:entry_name] || t('blacklight.entry_name.default')
-
-      end_num = if render_grouped_response?
-        number_with_delimiter(response.start + response.groups.length)
-      else
-        number_with_delimiter(response.start + response.docs.length)
-      end
-      
-      case response.total_count
-        when 0; t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name.pluralize ).html_safe
-        when 1; t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
-        else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name.pluralize, :current_page => response.current_page, :num_pages => response.total_pages, :start_num => format_num(response.start + 1) , :end_num => end_num, :total_num => response.total_count, :count => response.total_pages).html_safe
-      end
-    end
-  end
-  deprecation_deprecate :render_pagination_info
+  def format_num(num); number_with_delimiter(num) end
 
   # Override the Kaminari page_entries_info helper with our own, blacklight-aware
   # implementation
   #
   # Pass in an RSolr::Response. Displays the "showing X through Y of N" message.
-
   def page_entries_info(collection, options = {})
     entry_name = if options[:entry_name]
       options[:entry_name]
     elsif collection.respond_to? :model  # DataMapper
-        collection.model.model_name.human.downcase
+        collection.model.model_name.humanize.downcase
     elsif collection.respond_to? :model_name and !collection.model_name.nil? # AR, Blacklight::PaginationMethods
-        collection.model_name.human.downcase
+        collection.model_name.humanize.downcase
     elsif collection.is_a?(::Kaminari::PaginatableArray)
       'entry'
     else
@@ -80,19 +49,18 @@ module Blacklight::CatalogHelperBehavior
     end
 
     end_num = if collection.offset_value + end_num <= collection.total_count
-      collection.offset_value + end_num
+      format_num(collection.offset_value + end_num)
     else
-      collection.total_count
+      format_num(collection.total_count)
     end
       
     case collection.total_count
       when 0; t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name ).html_safe
       when 1; t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
-      else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name, :current_page => collection.current_page, :num_pages => collection.total_pages, :start_num => number_with_delimiter(collection.offset_value + 1) , :end_num => number_with_delimiter(end_num), :total_num => number_with_delimiter(collection.total_count), :count => collection.total_pages).html_safe
+      else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name, :current_page => collection.current_page, :num_pages => collection.total_pages, :start_num => format_num(collection.offset_value + 1) , :end_num => end_num, :total_num => collection.total_count, :count => collection.total_pages).html_safe
     end
   end
 
-
   def document_counter_with_offset idx 
     unless render_grouped_response? 
       idx + 1 + @response.params[:start].to_i
@@ -105,7 +73,7 @@ module Blacklight::CatalogHelperBehavior
   # Code should call this method rather than interrogating session directly,
   # because implementation of where this data is stored/retrieved may change.
   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 => format_num(search_session[:counter]), :total => format_num(search_session[:total]), :count => search_session[:total].to_i).html_safe
   end
 
   # Look up search field user-displayable label
@@ -179,7 +147,6 @@ module Blacklight::CatalogHelperBehavior
   end
 
   def response_has_no_search_results?
-    Deprecation.warn(Blacklight::CatalogHelperBehavior, "#response_has_no_search_results? is deprecated; use Response#empty? to check instead")
-    @response.empty?
+    @response.total == 0 
   end
 end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,27 +1,16 @@
 module Blacklight::FacetsHelperBehavior
 
-  extend Deprecation
-  self.deprecation_horizon = 'Blacklight 5.x'
-
-
   include Blacklight::Facet
 
-  # used in the catalog/_facets partial
-  def facet_field_labels
-    # DEPRECATED
-    Hash[*blacklight_config.facet_fields.map { |key, facet| [key, facet.label] }.flatten]
-  end
-  
-
   def has_facet_values? fields = facet_field_names, options = {}
     facets_from_request(fields).any? { |display_facet| !display_facet.items.empty? }
   end
 
   # Render a collection of facet fields
   def render_facet_partials fields = facet_field_names, options = {}
-    facets_from_request(fields).map do |display_facet|
+    safe_join(facets_from_request(fields).map do |display_facet|
       render_facet_limit(display_facet, options)
-    end.compact.join("\n").html_safe
+    end.compact, "\n".html_safe)
   end
 
 
@@ -34,17 +23,12 @@ module Blacklight::FacetsHelperBehavior
   # @param [Hash] options parameters to use for rendering the facet limit partial
   #
   def render_facet_limit(display_facet, options = {})
-    if display_facet.is_a? String or display_facet.is_a? Symbol
-      Deprecation.warn(Blacklight::FacetsHelperBehavior, "Blacklight::FacetsHelper#render_facet_limit: use #render_facet_partials to render facets by field name")
-      return render_facet_partials([display_facet])
-    end
     return if not should_render_facet?(display_facet)
     options = options.dup
     options[:partial] ||= facet_partial_name(display_facet)
     options[:layout] ||= "facet_layout" unless options.has_key?(:layout)
     options[:locals] ||= {}
     options[:locals][:solr_field] ||= display_facet.name 
-    options[:locals][:solr_fname] ||= display_facet.name # DEPRECATED
     options[:locals][:facet_field] ||= facet_configuration_for_field(display_facet.name)
     options[:locals][:display_facet] ||= display_facet 
 
@@ -58,23 +42,7 @@ module Blacklight::FacetsHelperBehavior
   # @param [Blacklight::SolrResponse::Facets::FacetField] display_facet 
   def should_render_facet? display_facet
     # display when show is nil or true
-    facet_config = facet_configuration_for_field(display_facet.name)
-
-    display = case facet_config.show
-    when Symbol
-      arity = method(facet_config.show).arity
-
-      if arity == 0
-        send(facet_config.show)
-      else 
-        send(facet_config.show, display_facet)
-      end
-    when Proc
-      facet_config.show.call self, facet_config, display_facet
-    else
-      facet_config.show
-    end
-
+    display = facet_configuration_for_field(display_facet.name).show != false
     return display && display_facet.items.present?
   end
 
@@ -96,23 +64,33 @@ module Blacklight::FacetsHelperBehavior
   # a link to add that to your restrictions, with count in parens. 
   # first arg item is a facet value item from rsolr-ext.
   # options consist of:
-  # :suppress_link => true # do not make it a link, used for an already selected value for instance
+  # :suppress_link => true # do not make it a link
+  # :route_set => my_engine # call link_to on engine routes.
   def render_facet_value(facet_solr_field, item, options ={})    
-    (link_to_unless(options[:suppress_link], facet_display_value(facet_solr_field, item), add_facet_params_and_redirect(facet_solr_field, item), :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
+    scope = options.delete(:route_set) || self
+    path = scope.url_for(add_facet_params_and_redirect(facet_solr_field, item).merge(only_path: true))
+    content_tag(:span, :class => "facet-label") do
+      link_to_unless(options[:suppress_link], facet_display_value(facet_solr_field, item), path, :class=>"facet_select")
+    end + render_facet_count(item.hits)
   end
 
   # Standard display of a SELECTED facet value, no link, special span
   # with class, and 'remove' button.
   def render_selected_facet_value(facet_solr_field, item)
-    #Updated class for Bootstrap Blacklight 
-    content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected") +
-      link_to(content_tag(:i, '', :class => "icon-remove") + content_tag(:span, '[remove]', :class => 'hide-text'), remove_facet_params(facet_solr_field, item, params), :class=>"remove")
+    content_tag(:span, :class => "facet-label") do
+      content_tag(:span, facet_display_value(facet_solr_field, item), :class => "selected") +
+      # remove link
+      link_to(content_tag(:span, '', :class => "glyphicon glyphicon-remove") + content_tag(:span, '[remove]', :class => 'sr-only'), remove_facet_params(facet_solr_field, item, params), :class=>"remove")
+    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. 
-  def render_facet_count(num)
-    content_tag("span", t('blacklight.search.facets.count', :number => num), :class => "count") 
+  #
+  # option :class takes an array of classes to add to count span.
+  def render_facet_count(num, options = {})
+    classes = (options[:classes] || []) << "facet-count"
+    content_tag("span", t('blacklight.search.facets.count', :number => num), :class => classes)
   end
   
   # adds the value and/or field to params[:f]
@@ -195,7 +173,6 @@ module Blacklight::FacetsHelperBehavior
     p.delete :commit
     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/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -10,13 +10,11 @@
 # This is used to serialize a complete current query from current params
 # to form fields used for sort and change per-page
 module Blacklight::HashAsHiddenFieldsHelperBehavior
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 5.0'
 
   # 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 render_hash_as_hidden_fields(hash)
+  def hash_as_hidden_fields(hash)
     
     hidden_fields = []
     flatten_hash(hash).each do |name, value|
@@ -26,12 +24,7 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
       end
     end
     
-    hidden_fields.join("\n").html_safe
-  end
-
-  def hash_as_hidden_fields *args
-    Deprecation.warn(Blacklight::HashAsHiddenFieldsHelperBehavior, "#hash_as_hidden_fields is deprecated; use #render_hash_as_hidden_fields instead")
-    render_hash_as_hidden_fields *args
+    safe_join(hidden_fields, "\n".html_safe)
   end
 
   protected

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -14,7 +14,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # Render actual constraints, not including header or footer
   # info. 
   def render_constraints(localized_params = params)
-    (render_constraints_query(localized_params) + render_constraints_filters(localized_params)).html_safe
+    render_constraints_query(localized_params) + render_constraints_filters(localized_params)
   end
   
   def render_constraints_query(localized_params = params)
@@ -41,22 +41,21 @@ module Blacklight::RenderConstraintsHelperBehavior
      content = []
      localized_params[:f].each_pair do |facet,values|
        content << render_filter_element(facet, values, localized_params)
-     end 
+     end
 
-     return content.flatten.join("\n").html_safe    
+     safe_join(content.flatten, "\n".html_safe)    
   end
 
   def render_filter_element(facet, values, localized_params)
     facet_config = facet_configuration_for_field(facet)
 
-    values.map do |val|
-
-      render_constraint_element( facet_field_labels[facet],
-                  facet_display_value(facet, val), 
+    safe_join(values.map do |val|
+      render_constraint_element( blacklight_config.facet_fields[facet].label,
+                  facet_display_value(facet, val),
                   :remove => url_for(remove_facet_params(facet, val, localized_params)),
-                  :classes => ["filter", "filter-" + facet.parameterize] 
-                ) + "\n"                 					            
-    end
+                  :classes => ["filter", "filter-" + facet.parameterize]
+                )
+    end, "\n".html_safe)
   end
 
   # Render a label/value constraint on the screen. Can be called
@@ -77,10 +76,6 @@ module Blacklight::RenderConstraintsHelperBehavior
   # [:escape_value]
   #    default true, HTML escape. 
   def render_constraint_element(label, value, options = {})
-    if (options[:escape_label] and !label.html_safe?) or (options.has_key?(:escape_value) and !value.html_safe?)
-      Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, "Calling #render_constraint_element with :escape_label or :escape_value parameters is deprecated; make sure your values are #html_safe instead")
-    end
-
     render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})    
   end
 

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -17,25 +17,25 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   end
 
   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
 
   def render_search_to_s_filters(params)
     return "".html_safe unless params[:f]
 
-    params[:f].collect do |facet_field, value_list|
+    safe_join(params[:f].collect do |facet_field, value_list|
       render_search_to_s_element(facet_configuration_for_field(facet_field).label,
-        value_list.collect do |value|
+        safe_join(value_list.collect do |value|
           render_filter_value(value, facet_field)
-        end.join(content_tag(:span, " #{t('blacklight.and')} ", :class =>'filterSeparator')).html_safe
+        end, content_tag(:span, " #{t('blacklight.and')} ", :class =>'filterSeparator'))
       )    
-    end.join(" \n ").html_safe    
+    end, " \n ".html_safe)
   end
 
   # value can be Array, in which case elements are joined with

data/app/views/_flash_msg.html.erb

@@ -1,8 +1,15 @@
 <div class="flash_messages">
   <% [:success, :notice, :error, :alert].each do |type| %>
-    <%- alert_class = type == :notice ? 'info' : type %>
+    <%- alert_class = case type
+      when :success then "alert-success"
+      when :notice  then "alert-info"
+      when :alert   then "alert-warning"
+      when :error   then "alert-danger"
+      else "alert-#{type}"
+      end
+    -%>
     <% if flash[type] %>
-      <div class="alert alert-<%=alert_class%>"><%= flash[type] %>
+      <div class="alert <%=alert_class %>"><%= flash[type] %>
          <a class="close" data-dismiss="alert" href="#">&times;</a>
       </div>
     <% end %>

data/app/views/_user_util_links.html.erb

@@ -1,22 +1,36 @@
-  <% if has_user_authentication_provider? %>
-    <div class="util-links-login">
-      <% if current_user %>
-        <%= link_to t('blacklight.header_links.logout'), destroy_user_session_path %> <%= "[#{ link_to current_user, edit_user_registration_path }]".html_safe unless current_user.to_s.blank? %>
-      <% else %>
-        <%= link_to t('blacklight.header_links.login'), new_user_session_path %>
-      <% end %>
-    </div>
-
-  <% end %>
-
-  <div class="util-links-other">
+<div class="navbar-right">
+  <ul class="nav navbar-nav">
     <% if render_bookmarks_control? %>
+    <li>
       <%= link_to t('blacklight.header_links.bookmarks'), bookmarks_path %>
+    </li>
     <% end %>
     <% if has_user_authentication_provider? and current_user %>
-      |
+      <li>
       <%= link_to t('blacklight.header_links.saved_searches'), saved_searches_path %>
+      </li>
     <% end %>
-    |
+    <li>
     <%= link_to t('blacklight.header_links.search_history'), search_history_path %>
-  </div>
+    </li>
+  </ul>
+
+  <% if has_user_authentication_provider? %>
+    <ul class="nav navbar-nav">
+      <% if current_user %>
+      <li>
+        <%= link_to t('blacklight.header_links.logout'), destroy_user_session_path %>
+      </li>
+      <% unless current_user.to_s.blank? -%>
+      <li>
+        [<%= link_to current_user, edit_user_registration_path %>]
+      </li>
+      <% end %>
+      <% else %>
+      <li>
+        <%= link_to t('blacklight.header_links.login'), new_user_session_path %>
+      </li>
+      <% end %>
+      </ul>
+  <% end %>
+</div>

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

@@ -1,18 +1,15 @@
-    <ul class="bookmarkTools">
+    <ul class="bookmarkTools nav nav-pills">
       <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 => 'lightboxLink btn'} %>
+        <%= 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'}%>
+        <%= 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>
       <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=>"lightboxLink btn", :id => "emailLink" %>
-      </li>
-      <li>
-        <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path, :method => :delete, :data => { :confirm => t('blacklight.bookmarks.clear.action_confirm') }, :class => 'btn' %>
+        <%= 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>
 </ul>

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

@@ -1,4 +1,4 @@
-<div id="content" class="span12">
+<div id="content" class="col-md-12">
 <h1><%= t('blacklight.bookmarks.title') %></h1>
 
 <%- if current_or_guest_user.blank? -%>
@@ -9,9 +9,10 @@
 
   <h3><%= t('blacklight.bookmarks.no_bookmarks') %></h3>
 <% else %>
+  <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path, :method => :delete, :data => { :confirm => t('blacklight.bookmarks.clear.action_confirm') }, :class => 'btn btn-danger pull-right' %>
   <%= render 'sort_and_per_page' %>
-
   <%= render 'tools' %>
+
   <%= render_document_index %>
   <%= render 'results_pagination' %>
 <% end %>