blacklight 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d0587369df20fe60865e7e145ee2331b24bb10e
-  data.tar.gz: 45af7e3cca647a11de41d7d87c5b9d29bfe84585
+  metadata.gz: 550e843bc936edf7872cd484e377e2b3b47fd095
+  data.tar.gz: bef46f39d076a8eea2b16e9e5e58ecd7b05bd714
 SHA512:
-  metadata.gz: 6e3916a1be5e25e6d1455de5a76bdea0102fada96d69e1ccb182b8e674d45968f36509f25e2a163e6533d3ef3caa65474867aa91ece5de100eb54674b156ec4e
-  data.tar.gz: db866f3d02c5a0e8b2a9a5c773c999308cb8f68fdd3cf79d366efecaefd2e41b279df6774ee5f5237a6097bf7ee122be82d5ab8b63f353012cd52e2bf4293b5b
+  metadata.gz: 10dc73791badec8cdbbb1fa1309d15863b979bfae3a26116496cc8f4ef03204ea62f3262b559e216053e916908c57c9aa82c1df1220a21e83912373b22cd876e
+  data.tar.gz: c1bee8205d70bdff994225c1e3d9341252191b482ec59edfbd1f5cde7f3927f7522a2d99bb362e2677c61355b6030eb09070e433a26193e7980f8e2fc6cde082

data/Gemfile

@@ -12,9 +12,8 @@ group :test do
   gem "bootstrap-sass"
   gem 'turbolinks'
   gem 'poltergeist'
-  gem "unicode", :platforms => [:mri_18, :mri_19]
 end
 
 if File.exists?('spec/test_app_templates/Gemfile.extra')
   eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
-end
+end

data/VERSION

@@ -1 +1 @@
-4.5.0
+4.6.0

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

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

data/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 @@ module Blacklight::BlacklightHelperBehavior
   # 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 @@ module Blacklight::BlacklightHelperBehavior
   # 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 @@ module Blacklight::BlacklightHelperBehavior
   # @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 @@ module Blacklight::BlacklightHelperBehavior
   # @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 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # 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
 
   ##

data/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 @@ module Blacklight::CatalogHelperBehavior
   #
   # 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,6 +42,48 @@ module Blacklight::CatalogHelperBehavior
         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? 
@@ -50,7 +91,7 @@ module Blacklight::CatalogHelperBehavior
     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,

data/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 @@ module Blacklight::FacetsHelperBehavior
   #
   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)

data/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,12 +62,16 @@ 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
@@ -72,11 +79,13 @@ module Blacklight::HtmlHeadHelperBehavior
   # 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,12 +94,15 @@ module Blacklight::HtmlHeadHelperBehavior
   # 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
@@ -98,6 +110,9 @@ module Blacklight::HtmlHeadHelperBehavior
   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

data/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 %>

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

@@ -0,0 +1,5 @@
+<%= render 'did_you_mean' %>
+
+<%= render 'constraints' %>
+
+<%= render 'sort_and_per_page' %>

data/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' %>

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

@@ -14,13 +14,9 @@
       <% @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 'did_you_mean' %>
-
-      <%= render 'constraints' %>
-
-      <%= render 'sort_and_per_page' %>
+      <%= render 'search_header' %>
 
       <h2 class="hide-text"><%= t('blacklight.search.search_results') %></h2>
 

data/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 %>">

data/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 %>

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

@@ -19,7 +19,7 @@
     <%= stylesheet_link_tag    "application" %>
     <%= javascript_include_tag "application" %>
     <%= csrf_meta_tags %>
-    <%= raw(render_head_content) %> 
+    <%= Deprecation.silence(Blacklight::HtmlHeadHelperBehavior) { raw(render_head_content) } %> 
 
     <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
     <!--[if lt IE 9]>
@@ -36,7 +36,7 @@
   <div id="main-container" class="container">
             <!-- Top bar -->
             <div id="search-found" class="row hidden-phone">
-              <%= topbar_items.join('').html_safe %>
+              <%= Deprecation.silence(Blacklight::BlacklightHelperBehavior) { topbar_items.join('').html_safe } %>
             </div>
             <!-- /Top bar -->
                   <div class="row">

data/blacklight.gemspec

@@ -27,9 +27,11 @@ Gem::Specification.new do |s|
   s.add_dependency "marc",      ">= 0.4.3", "< 1.1"  # Marc record parser.
   s.add_dependency "rsolr",     "~> 1.0.6"  # Library for interacting with rSolr.
   s.add_dependency "kaminari", "~> 0.13"  # the pagination (page 1,2,3, etc..) of our search results
-  s.add_dependency "sass-rails"
+  s.add_dependency "sass-rails" 
   s.add_dependency "bootstrap-sass", ">= 2.2.0", "< 2.4"
+  s.add_dependency "deprecation"
   s.add_development_dependency "jettywrapper", ">= 1.4.1"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"
+  s.add_development_dependency "equivalent-xml"
 end

data/config/locales/blacklight.en.yml

@@ -186,7 +186,7 @@ en:
         title: 'Results navigation'
       pagination_info:
         no_items_found: 'No %{entry_name} found'
-        single_item_found: '<strong>1</strong> to <strong>1</strong> of <strong>1</strong>'
+        single_item_found: '<strong>1</strong> %{entry_name} found'
         pages:
           one: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num}</strong>'
           other: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> of <strong>%{total_num}</strong>'

data/gemfiles/rails3.gemfile

@@ -17,10 +17,9 @@ group :test do
   gem 'turbolinks'
   gem 'uglifier'
   gem 'poltergeist'
-  gem "unicode", :platforms => [:mri_18, :mri_19]
 end
 
 f = File.expand_path(File.dirname(__FILE__) + '/../spec/test_app_templates/Gemfile.extra')
 if File.exists?(f)
   eval File.read(f), nil, f
-end
+end

data/gemfiles/rails4.gemfile

@@ -16,7 +16,6 @@ group :test do
   gem "bootstrap-sass"
   gem 'turbolinks'
   gem 'poltergeist'
-  gem "unicode", :platforms => [:mri_18, :mri_19]
 end
 
 f = File.expand_path(File.dirname(__FILE__) + '/../spec/test_app_templates/Gemfile.extra')

data/lib/blacklight.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
 require 'kaminari'
 require 'rsolr'
+require 'deprecation'
 
 module Blacklight
 

data/lib/blacklight/catalog.rb

@@ -1,5 +1,8 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::Catalog   
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
   extend ActiveSupport::Concern
   
   include Blacklight::Base
@@ -28,8 +31,10 @@ module Blacklight::Catalog
       
       respond_to do |format|
         format.html { 
-          extra_head_content << view_context.auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => t('blacklight.search.rss_feed') )
-          extra_head_content << view_context.auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => t('blacklight.search.atom_feed') )
+          Deprecation.silence(Blacklight::LegacyControllerMethods) do
+            extra_head_content << view_context.auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => t('blacklight.search.rss_feed') )
+            extra_head_content << view_context.auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => t('blacklight.search.atom_feed') )
+          end
         }
         format.rss  { render :layout => false }
         format.atom { render :layout => false }
@@ -201,7 +206,7 @@ module Blacklight::Catalog
     # include certain partials or not
     def adjust_for_results_view
       # deprecated in blacklight 4.x
-      ActiveSupport::Deprecation.warn("#adjust_for_results_view helper was deprecated in Blacklight 4.x")
+      Deprecation.warn(self, "#adjust_for_results_view helper was deprecated in Blacklight 4.x")
     end
 
     # extract the pagination info from the response object

data/lib/blacklight/catalog/search_context.rb

@@ -30,11 +30,19 @@ module Blacklight::Catalog::SearchContext
       find_or_initialize_search_session_from_params params
     elsif params[:search_context] and !params[:search_context].blank?
       find_or_initialize_search_session_from_params JSON.load(params[:search_context])
-    elsif params[:search_id] and !params[:search_id].blank?
-      # TODO : check the search id signature.
-      searches_from_history.find(params[:search_id]) rescue nil
+    elsif params[:search_id].present?
+      begin
+        # TODO : check the search id signature.      
+        searches_from_history.find(params[:search_id])
+      rescue ActiveRecord::RecordNotFound
+        nil
+      end
     elsif search_session[:id]
-      searches_from_history.find(search_session[:id]) rescue nil
+      begin
+        searches_from_history.find(search_session[:id])
+      rescue ActiveRecord::RecordNotFound
+        nil
+      end
     end
 
     if @current_search_session
@@ -121,4 +129,4 @@ module Blacklight::Catalog::SearchContext
     ActiveSupport::Deprecation.warn("#set_additional_search_session_values helper was deprecated in Blacklight 4.x")
   end
 
-end
+end