Merge pull request #673 from projectblacklight/4.x-deprecations

4.x deprecations and backports from 5.x

Author: jcoyne

app/assets/javascripts/blacklight/blacklight.js

@@ -60,4 +60,4 @@
         };
 */
 
-$('.no-js').removeClass('no-js')
+$('.no-js').removeClass('no-js').addClass('js');

app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -4,6 +4,10 @@
 # Methods added to this helper will be available to all templates in the hosting application
 #
 module Blacklight::BlacklightHelperBehavior
+
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
   include HashAsHiddenFieldsHelper
   include RenderConstraintsHelper
   include HtmlHeadHelper
@@ -61,14 +65,15 @@ def render_body_class
   # collection of items to be rendered in the @sidebar
   # @deprecated
   def sidebar_items
-    ActiveSupport::Deprecation.warn("#sidebar_items helper is deprecated, and should be replaced by overriding the appropriate partial")
     @sidebar_items ||= []
   end
+  deprecation_deprecate :sidebar_items
 
   # collection of items to be rendered in the @topbar
   def topbar_items
     @topbar_items ||= []
   end
+  deprecation_deprecate :topbar_items
 
   def render_search_bar
     render :partial=>'catalog/search_form'
@@ -121,6 +126,7 @@ def should_render_index_field? document, solr_field
   # Field keys for the index fields
   # @deprecated
   def index_field_names document=nil
+    Deprecation.warn(self, "#index_field_names helper is deprecated, and should be replaced by overriding the appropriate partial")
     index_fields(document).keys
   end
 
@@ -129,6 +135,8 @@ def index_field_names document=nil
   # @deprecated
   def index_field_labels document=nil
     # XXX DEPRECATED
+    Deprecation.warn(self, "#index_field_labels helper is deprecated, and should be replaced by overriding the appropriate partial")
+  
     Hash[*index_fields(document).map { |key, field| [key, field.label] }.flatten]
   end
 
@@ -255,6 +263,8 @@ def document_show_fields document=nil
   # @deprecated
   def document_show_field_labels document=nil
     # XXX DEPRECATED
+    Deprecation.warn(self, "#document_show_field_labels helper is deprecated, and should be replaced by overriding the appropriate partial")
+    
     Hash[*document_show_fields(document).map { |key, field| [key, field.label] }.flatten]
   end
 
@@ -609,8 +619,8 @@ def render_endnote_texts(documents)
   ##
   # Should we render a grouped response (because the response 
   # contains a grouped response instead of the normal response) 
-  def render_grouped_response?
-    return @response.grouped?
+  def render_grouped_response? response = @response
+    return response.grouped?
   end
 
   ##

app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,6 +1,9 @@
 # -*- 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.
@@ -25,11 +28,7 @@ def format_num(num); 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 = {})
-   # TODO: i18n the entry_name
-      entry_name = options[:entry_name]
-      entry_name ||= response.docs.first.class.name.underscore.sub('_', ' ') unless response.docs.empty?
-      entry_name ||= t('blacklight.entry_name.default')
-
+      entry_name = options[:entry_name] || t('blacklight.entry_name.default')
 
       end_num = if render_grouped_response?
         format_num(response.start + response.groups.length)
@@ -43,14 +42,56 @@ def render_pagination_info(response, options = {})
         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
+  deprecation_deprecate :render_pagination_info
+
+  # 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.humanize.downcase
+    elsif collection.respond_to? :model_name and !collection.model_name.nil? # AR, Blacklight::PaginationMethods
+        collection.model_name.humanize.downcase
+    elsif collection.is_a?(::Kaminari::PaginatableArray)
+      'entry'
+    else
+      t('blacklight.entry_name.default')
+    end
+
+    entry_name = entry_name.pluralize unless collection.total_count == 1
+
+    # grouped response objects need special handling
+    end_num = if collection.respond_to? :groups and render_grouped_response? collection
+      collection.groups.length
+    else
+      collection.limit_value
+    end
+
+    end_num = if collection.offset_value + end_num <= collection.total_count
+      format_num(collection.offset_value + end_num)
+    else
+      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 => 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
     end
   end
 
-  # Like  #render_pagination_info above, but for an individual
+  # Like  #page_entries_info above, but for an individual
   # item show page. Displays "showing X of Y items" message. Actually takes
   # data from session though (not a great design).
   # Code should call this method rather than interrogating session directly,

app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,5 +1,9 @@
 module Blacklight::FacetsHelperBehavior
 
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
+
   include Blacklight::Facet
 
   # used in the catalog/_facets partial
@@ -31,7 +35,7 @@ def render_facet_partials fields = facet_field_names, options = {}
   #
   def render_facet_limit(display_facet, options = {})
     if display_facet.is_a? String or display_facet.is_a? Symbol
-      $stderr.puts "DEPRECATION WARNING: Blacklight::FacetsHelper#render_facet_limit: use #render_facet_partials to render facets by field name"
+      Deprecation.warn(self, "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)

app/helpers/blacklight/html_head_helper_behavior.rb

@@ -1,4 +1,7 @@
 module Blacklight::HtmlHeadHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
   ##
   # This method should be included in any Blacklight layout, including
   # custom ones. It will output results of #render_js_includes,
@@ -59,24 +62,30 @@ module Blacklight::HtmlHeadHelperBehavior
   # stylesheet_links << ["stylesheet1.css", "stylesheet2.css", {:cache => "mykey"}]
   # javascript_includes << ["myjavascript.js", {:plugin => :myplugin} ]
   def render_head_content
-    render_stylesheet_includes +
-    render_js_includes +
-    render_extra_head_content +
+    Deprecation.silence(Blacklight::HtmlHeadHelperBehavior) do
+      render_stylesheet_includes +
+      render_js_includes +
+      render_extra_head_content
+    end +
     content_for(:head)
   end
 
+  deprecation_deprecate :render_head_content
+  
   ##
   # Assumes controller has a #stylesheet_link_tag method, array with
   # each element being a set of arguments for stylesheet_link_tag
   # See #render_head_content for instructions on local code or plugins
   # adding stylesheets. 
   def render_stylesheet_includes
     return "".html_safe unless respond_to?(:stylesheet_links)
-    
-    stylesheet_links.uniq.collect do |args|
-      stylesheet_link_tag(*args)
-    end.join("\n").html_safe
+    Deprecation.silence(Blacklight::LegacyControllerMethods) do
+      stylesheet_links.uniq.collect do |args|
+        stylesheet_link_tag(*args)
+      end.join("\n").html_safe
+    end
   end
+  deprecation_deprecate :render_stylesheet_includes
 
 
   ##
@@ -85,19 +94,25 @@ def render_stylesheet_includes
   # See #render_head_content for instructions on local code or plugins
   # adding js files. 
   def render_js_includes
-    return "".html_safe unless respond_to?(:javascript_includes)    
-  
-    javascript_includes.uniq.collect do |args|
-      javascript_include_tag(*args)
-    end.join("\n").html_safe
+    return "".html_safe unless respond_to?(:javascript_includes) 
+
+    Deprecation.silence(Blacklight::LegacyControllerMethods) do
+      javascript_includes.uniq.collect do |args|
+        javascript_include_tag(*args)
+      end.join("\n").html_safe
+    end
   end
+  deprecation_deprecate :render_js_includes
 
   ## 
   # Assumes controller has a #extra_head_content method
   #
   def render_extra_head_content
     return "".html_safe unless respond_to?(:extra_head_content)
 
-    extra_head_content.join("\n").html_safe
+    Deprecation.silence(Blacklight::LegacyControllerMethods) do
+      extra_head_content.join("\n").html_safe
+    end
   end
+  deprecation_deprecate :render_extra_head_content
 end

app/views/catalog/_paginate_compact.html.erb

@@ -1,5 +1,5 @@
 <% if @response.total_pages > 1 %>
 <%= paginate @response, :theme => :blacklight_compact %>
 <% else %>
-<%= render_pagination_info(@response) %>
+<%= page_entries_info(@response) %>
 <% end %>

app/views/catalog/facet.html.erb

@@ -1,6 +1,8 @@
+<% Deprecation.silence(Blacklight::BlacklightHelperBehavior) do -%>
 <% sidebar_items << capture do %>
   <p><%= link_back_to_catalog %></p>
 <% end %>
+<% end %>
 
 <div class="facet_pagination top">
   <%= render :partial=>'facet_pagination' %>

app/views/catalog/index.html.erb

@@ -14,7 +14,7 @@
       <% @page_title = t('blacklight.search.title', :application_name => application_name) %>
 
 
-      <% extra_head_content << render_opensearch_response_metadata.html_safe %>
+      <% Deprecation.silence(Blacklight::LegacyControllerMethods) { extra_head_content << render_opensearch_response_metadata.html_safe } %>
 
       <%= render 'search_header' %>
 

app/views/catalog/show.html.erb

@@ -4,7 +4,7 @@
 
 
 <% @page_title = t('blacklight.search.show.title', :document_title => document_show_html_title, :application_name => application_name) %>
-<% extra_head_content << render_link_rel_alternates %>
+<% Deprecation.silence(Blacklight::LegacyControllerMethods) { extra_head_content << render_link_rel_alternates } %>
 
 <%# this should be in a partial -%>
 <div id="document" class="<%= render_document_class %>">

app/views/kaminari/blacklight_compact/_paginator.html.erb

@@ -8,7 +8,7 @@
 
    Paginator now using the Bootstrap paginator class
 -%>
-<%- pagination_info_cache = render_pagination_info @response %>
+<%- pagination_info_cache = page_entries_info @response %>
 
 <%= paginator.render do -%>
   <%= prev_page_tag %> |  <%= pagination_info_cache %> |  <%= next_page_tag %>