blacklight 4.5.0 → 4.6.0

data/lib/blacklight/legacy_controller_methods.rb

@@ -6,11 +6,15 @@
 # in here, but you may find them useful. 
 module Blacklight
   module LegacyControllerMethods 
-  	extend ActiveSupport::Concern
+    extend ActiveSupport::Concern
+
+    extend Deprecation
+    self.deprecation_horizon = 'Blacklight 5.x'
+
 
     included do
 
-      before_filter :default_html_head # add JS/stylesheet stuff
+      before_filter :default_html_head_without_deprecation # add JS/stylesheet stuff
 
       helper_method :extra_head_content, :stylesheet_links, :javascript_includes
     end
@@ -25,21 +29,29 @@ module Blacklight
     # http://api.rubyonrails.org/classes/ActionController/Filters/ClassMethods.html
     # for how to turn off a filter in a sub-class and such.
     def default_html_head
- 
+      Deprecation.warn Blacklight::LegacyControllerMethods, "#default_html_head is deprecated"
     end
     
+    def default_html_head_without_deprecation
+      Deprecation.silence(Blacklight::LegacyControllerMethods) do
+        default_html_head
+      end
+    end
     
     # An array of strings to be added to HTML HEAD section of view.
     # See ApplicationHelper#render_head_content for details.
     def extra_head_content
+      Deprecation.warn Blacklight::LegacyControllerMethods, "#extra_head_content is deprecated"
+
       @extra_head_content ||= []
     end
 
-    
     # Array, where each element is an array of arguments to
     # Rails stylesheet_link_tag helper. See
     # ApplicationHelper#render_head_content for details.
     def stylesheet_links
+      Deprecation.warn Blacklight::LegacyControllerMethods, "#stylesheet_links is deprecated"
+
       @stylesheet_links ||= []
     end
     
@@ -47,6 +59,8 @@ module Blacklight
     # Rails javascript_include_tag helper. See
     # ApplicationHelper#render_head_content for details.
     def javascript_includes
+      Deprecation.warn Blacklight::LegacyControllerMethods, "#javascript_includes is deprecated"
+
       @javascript_includes ||= []
     end
     

data/lib/blacklight/solr/document.rb

@@ -16,6 +16,9 @@ require 'rsolr'
 #
 
 module Blacklight::Solr::Document
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
   autoload :Marc, 'blacklight/solr/document/marc'
   autoload :MarcExport, 'blacklight/solr/document/marc_export'
   autoload :DublinCore, 'blacklight/solr/document/dublin_core'
@@ -159,7 +162,10 @@ module Blacklight::Solr::Document
     attr_writer :unique_key
     def unique_key
       # XXX Blacklight.config[:unique_key] should be deprecated soon
-      @unique_key ||= Blacklight.config[:unique_key] if Blacklight.respond_to?(:config) and Blacklight.config[:unique_key]
+      if Blacklight.respond_to?(:config) and Blacklight.config[:unique_key]
+        Deprecation.warn(self, "Setting the unique key using Blacklight.config[:unique_key] has been deprecated. Use the SolrDocument.unique_key= setter instead")
+        @unique_key ||= Blacklight.config[:unique_key] 
+      end
       @unique_key ||= 'id' 
 
       @unique_key

data/lib/blacklight/solr/document/marc_export.rb

@@ -6,6 +6,9 @@
 # that provides a #to_marc returning a ruby-marc object.  This module will add
 # in export_as translation methods for a variety of formats. 
 module Blacklight::Solr::Document::MarcExport
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
   
   def self.register_export_formats(document)
     document.will_export_as(:xml)
@@ -104,14 +107,6 @@ module Blacklight::Solr::Document::MarcExport
   # proprietary marc-ish in text/plain format. See
   # http://robotlibrarian.billdueber.com/sending-marcish-data-to-refworks/
   def export_as_refworks_marc_txt
-    # plugin/gem weirdness means we do need to manually require
-    # here.
-    # As of 11 May 2010, Refworks has a problem with UTF-8 if it's decomposed,
-    # it seems to want C form normalization, although RefWorks support
-    # couldn't tell me that. -jrochkind
-    # DHF: moved this require a little lower in the method.
-    # require 'unicode'    
-  
     fields = to_marc.find_all { |f| ('000'..'999') === f.tag }
     text = "LEADER #{to_marc.leader}"
     fields.each do |field|
@@ -129,19 +124,12 @@ module Blacklight::Solr::Document::MarcExport
         end
     end
 
-    if Blacklight.jruby? 
-      require 'java'
-      java_import java.text.Normalizer
-      Normalizer.normalize(text, Normalizer::Form::NFC).to_s
-    else 
-      begin
-        require 'unicode'
-        Unicode.normalize_C(text)
-      rescue LoadError
-        Blacklight.logger.warn "Unable to load unicode library in #export_as_refworks_marc_txt; skipping unicode normalization"
-        text
-      end
-    end
+    # As of 11 May 2010, Refworks has a problem with UTF-8 if it's decomposed,
+    # it seems to want C form normalization, although RefWorks support
+    # couldn't tell me that. -jrochkind
+    text = ActiveSupport::Multibyte::Unicode.normalize(text, :c)
+    
+    return text
   end 
 
   # Endnote Import Format. See the EndNote User Guide at:
@@ -209,17 +197,17 @@ module Blacklight::Solr::Document::MarcExport
   # be gotten rid of eventually.
 
   def to_zotero(format)
-    warn("[DEPRECATION]  Simply call document.export_as_openurl_kev to get an openURL kev context object suitable for including in a COinS; then have view code make the span for the COinS. ")
+    Deprecation.warn(self, "Simply call document.export_as_openurl_kev to get an openURL kev context object suitable for including in a COinS; then have view code make the span for the COinS. ")
     "<span class=\"Z3988\" title=\"#{export_as_openurl_kev(format)}\"></span>"
   end
 
   def to_apa
-    warn("[DEPRECATION] Call document.export_as_apa_citation instead.")
+    Deprecation.warn(self, "Call document.export_as_apa_citation instead.")
     export_as_apa_citation
   end
 
   def to_mla
-    warn("[DEPRECATION] Call document.export_as_mla_citation instead.")
+    Deprecation.warn(self, "Call document.export_as_mla_citation instead.")
   end
   
   

data/lib/blacklight/solr_helper.rb

@@ -45,6 +45,9 @@
 #   end  
 
 module Blacklight::SolrHelper
+  extend Deprecation
+  self.deprecation_horizon = 'Blacklight 5.x'
+
   extend ActiveSupport::Concern
   include Blacklight::SearchFields
   include Blacklight::Facet
@@ -148,7 +151,7 @@ module Blacklight::SolrHelper
       # generated blacklight_config.default_solr_params with that
       # value. Move it over to rows.
       if solr_params.has_key?(:per_page)
-        $stderr.puts "DEPRECATION WARNING: Blacklight::SolrHelper#solr_search_params: magic :per_page key deprecated, use :rows instead. (Check default_solr_params in blacklight config?)"
+        Deprecation.warn self, "Blacklight::SolrHelper#solr_search_params: magic :per_page key deprecated, use :rows instead. (Check default_solr_params in blacklight config?)"
         per_page = solr_params.delete(:per_page)
         solr_params[:rows] ||= per_page
       end

data/lib/blacklight/solr_response/pagination_methods.rb

@@ -15,6 +15,12 @@ module Blacklight::SolrResponse::PaginationMethods
     total
   end
 
+  def model_name
+    if !docs.empty? and docs.first.respond_to? :model_name
+      docs.first.model_name
+    end
+  end
+
   ## Methods in kaminari master that we'd like to use today.
   # Next page number in the collection
   def next_page

data/lib/generators/blacklight/blacklight_generator.rb

@@ -20,10 +20,6 @@ This generator makes the following changes to your application:
 Thank you for Installing Blacklight.
        """ 
 
-  def add_unicode_gem
-    gem "unicode", :platforms => [:mri_18, :mri_19] unless defined?(:RUBY_VERSION) and RUBY_VERSION == '2.0.0'
-  end
-
   def add_bootstrap_gem
     # Don't need a version here, because we specify the version in blacklight.gemspec
     gem 'bootstrap-sass'

data/lib/generators/blacklight/marc_generator.rb

@@ -17,7 +17,7 @@ module Blacklight
     # register_alias) will allow content-negotiation for the format. 
     def add_mime_types
       puts "Updating Mime Types"
-      insert_into_file "config/initializers/mime_types.rb", :after => "# Be sure to restart your server when you modify this file." do <<EOF
+      insert_into_file "config/initializers/mime_types.rb", :after => "# Be sure to restart your server when you modify this file.\n" do <<EOF
 Mime::Type.register_alias "text/plain", :refworks_marc_txt
 Mime::Type.register_alias "text/plain", :openurl_kev
 Mime::Type.register "application/x-endnote-refer", :endnote
@@ -63,4 +63,4 @@ EOF
     end
 
   end
-end
+end

data/spec/controllers/application_controller_spec.rb

@@ -7,12 +7,14 @@ describe ApplicationController do
   describe "head content from variables" do
 
     describe "#default_html_head" do
-      it "should setup js and css defaults" do                
-        controller.send(:default_html_head)
-
-        # by default, these should be empty, but left in for backwards compatibility 
-        controller.javascript_includes.should be_empty
-        controller.stylesheet_links.should be_empty
+      it "should setup js and css defaults" do   
+        Deprecation.silence(Blacklight::LegacyControllerMethods) do             
+          controller.send(:default_html_head)
+
+          # by default, these should be empty, but left in for backwards compatibility 
+          controller.javascript_includes.should be_empty
+          controller.stylesheet_links.should be_empty
+        end
       end
     end
 

data/spec/controllers/catalog_controller_spec.rb

@@ -138,7 +138,7 @@ describe CatalogController do
 
       it "should get the documents" do
         docs.size.should == 10
-        docs.first.keys.should == ["published_display", "author_display", "lc_callnum_display", "pub_date", "subtitle_display", "format", "material_type_display", "title_display", "id", "subject_topic_facet", "language_facet", "score"]
+        expect(docs.first.keys).to match_array(["published_display", "author_display", "lc_callnum_display", "pub_date", "subtitle_display", "format", "material_type_display", "title_display", "id", "subject_topic_facet", "language_facet", "score"])
       end
 
       it "should get the facets" do
@@ -150,8 +150,8 @@ describe CatalogController do
         let(:query_facet_items) { facets.last['items'] }
         let(:regular_facet_items) { facets.first['items'] }
         it "should have items with labels and values" do
-          query_facet_items.first['label'].should == 'within 5 Years'
-          query_facet_items.first['value'].should == 'years_5'
+          query_facet_items.first['label'].should == 'within 10 Years'
+          query_facet_items.first['value'].should == 'years_10'
           regular_facet_items.first['label'].should == "Book"
           regular_facet_items.first['value'].should == "Book"
         end
@@ -191,7 +191,7 @@ describe CatalogController do
         get :show, id: doc_id, format: 'json'
         response.should be_success
         json = JSON.parse response.body
-        json["response"]["document"].keys.should == ["author_t", "opensearch_display", "marc_display", "published_display", "author_display", "lc_callnum_display", "title_t", "pub_date", "pub_date_sort", "subtitle_display", "format", "url_suppl_display", "material_type_display", "title_display", "subject_addl_t", "subject_t", "isbn_t", "id", "title_addl_t", "subject_geo_facet", "subject_topic_facet", "author_addl_t", "language_facet", "subtitle_t", "timestamp"]
+        expect(json["response"]["document"].keys).to match_array(["author_t", "opensearch_display", "marc_display", "published_display", "author_display", "lc_callnum_display", "title_t", "pub_date", "pub_date_sort", "subtitle_display", "format", "url_suppl_display", "material_type_display", "title_display", "subject_addl_t", "subject_t", "isbn_t", "id", "title_addl_t", "subject_geo_facet", "subject_topic_facet", "author_addl_t", "language_facet", "subtitle_t", "timestamp"])
       end
     end
     

data/spec/features/did_you_mean_spec.rb

@@ -26,7 +26,7 @@ describe "Did You Mean" do
       expect(page).to have_content("Did you mean")
       click_link 'yehudiyim'
       within ("#sortAndPerPage") do
-        expect(page).to have_content "1 to 1 of 1"
+        expect(page).to have_content "1 entry found"
       end
       within ("select#search_field") do
         expect(page).to have_selector("option[selected]", text: "Title")
@@ -44,7 +44,7 @@ describe "Did You Mean" do
       expect(page).to have_content("Did you mean")
       click_link 'sharma'
       within ("#sortAndPerPage") do
-        expect(page).to have_content "1 to 1 of 1"
+        expect(page).to have_content "1 entry found"
       end
       within ("select#search_field") do
         expect(page).to have_selector("option[selected]", text: "Author")
@@ -91,7 +91,7 @@ describe "Did You Mean" do
       
       click_link 'bon'
       within ("#sortAndPerPage") do
-        expect(page).to have_content "1 to 1 of 1"
+        expect(page).to have_content "1 entry found"
       end
     end
     

data/spec/features/search_filters_spec.rb

@@ -46,7 +46,7 @@ describe "Facets" do
     click_link "2004"
 
     within ("#sortAndPerPage") do
-      expect(page).to have_content "1 to 1 of 1"
+      expect(page).to have_content "1 entry found"
     end
     within(".blacklight-language_facet") do 
       expect(page).to have_selector("span.selected", :text => "Tibetan 1")

data/spec/features/search_spec.rb

@@ -74,7 +74,7 @@ describe "Search Page" do
       expect(page).to have_content "1."
     end
     within ("#sortAndPerPage") do
-      expect(page).to have_content "1 to 1 of 1"
+      expect(page).to have_content "1 entry found"
     end
   end
 

data/spec/helpers/blacklight_helper_spec.rb

@@ -670,10 +670,16 @@ describe BlacklightHelper do
 
 
   describe "render_grouped_response?" do
-    it "should check if the response contains grouped data" do
+    it "should check if the response ivar contains grouped data" do
       assign(:response, double("SolrResponse", :grouped? => true))
       expect(helper.render_grouped_response?).to be_true
     end
+
+
+    it "should check if the response param contains grouped data" do
+      response = double("SolrResponse", :grouped? => true)
+      expect(helper.render_grouped_response?(response)).to be_true
+    end
   end
 
   describe "render_grouped_document_index" do

data/spec/helpers/catalog_helper_spec.rb

@@ -10,14 +10,11 @@ describe CatalogHelper do
     total = args[:total]
     start = (current_page - 1) * per_page
 
-    mock_response = double("Blacklight::SolrResponse")
-    mock_response.stub(:total_count).and_return(total)
-    mock_response.stub(:current_page).and_return(current_page)
-    mock_response.stub(:total_pages).and_return((total / per_page).to_i + 1)
-    mock_response.stub(:rows).and_return(per_page)
-    mock_response.stub(:start).and_return(start)
-    mock_response.stub(:docs).and_return((1..total).to_a.slice(start, per_page))
+    mock_docs = (1..total).to_a.map { {}.with_indifferent_access }
+    
+    mock_response = Kaminari.paginate_array(mock_docs).page(current_page).per(per_page)
 
+    mock_response.stub(:docs).and_return(mock_docs.slice(start, per_page))
     mock_response
   end
 
@@ -26,14 +23,14 @@ describe CatalogHelper do
   end
   
   
-  describe "render_pagination_info" do
+  describe "page_entries_info" do
     before(:all) do
     end
 
     it "with no results" do
       @response = mock_response :total => 0
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, { :entry_name => 'entry_name' })
       html.should == "No entry_names found"
       html.html_safe?.should == true
     end
@@ -41,23 +38,42 @@ describe CatalogHelper do
     it "with no results (and no entry_name provided)" do
       @response = mock_response :total => 0
 
-      html = render_pagination_info(@response)
+      html = page_entries_info(@response)
       html.should == "No entries found"
       html.html_safe?.should == true
     end
 
-    it "with a single result" do
-      @response = mock_response :total => 1
+    describe "with a single result" do
+      it "should use the provided entry name" do
+        response = mock_response :total => 1
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
-      html.should == "<strong>1</strong> to <strong>1</strong> of <strong>1</strong>"
-      html.html_safe?.should == true
+        html = page_entries_info(response, { :entry_name => 'entry_name' })
+        html.should == "<strong>1</strong> entry_name found"
+        html.html_safe?.should == true
+      end
+
+      it "should infer a name" do
+        response = mock_response :total => 1
+
+        html = page_entries_info(response)
+        html.should == "<strong>1</strong> entry found"
+        html.html_safe?.should == true
+      end
+
+      it "should use the model_name from the response" do
+        response = mock_response :total => 1
+        response.stub(:model_name).and_return('thingy')
+
+        html = page_entries_info(response)
+        expect(html).to eq "<strong>1</strong> thingy found"
+        expect(html).to be_html_safe
+      end
     end
 
     it "with a single page of results" do
-      @response = mock_response :total => 7
+      response = mock_response :total => 7
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(response, { :entry_name => 'entry_name' })
       html.should == "<strong>1</strong> - <strong>7</strong> of <strong>7</strong>"
       html.html_safe?.should == true
     end
@@ -65,7 +81,7 @@ describe CatalogHelper do
     it "on the first page of multiple pages of results" do
       @response = mock_response :total => 15, :per_page => 10
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, { :entry_name => 'entry_name' })
       html.should == "<strong>1</strong> - <strong>10</strong> of <strong>15</strong>"
       html.html_safe?.should == true
     end
@@ -73,7 +89,7 @@ describe CatalogHelper do
     it "on the second page of multiple pages of results" do
       @response = mock_response :total => 47, :per_page => 10, :current_page => 2
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, { :entry_name => 'entry_name' })
       html.should == "<strong>11</strong> - <strong>20</strong> of <strong>47</strong>"
       html.html_safe?.should == true
     end
@@ -81,14 +97,14 @@ describe CatalogHelper do
     it "on the last page of results" do
       @response = mock_response :total => 47, :per_page => 10, :current_page => 5
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, { :entry_name => 'entry_name' })
       html.should == "<strong>41</strong> - <strong>47</strong> of <strong>47</strong>"
       html.html_safe?.should == true
     end
     it "should work with rows the same as per_page" do
       @response = mock_response :total => 47, :rows => 20, :current_page => 2
 
-      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
+      html = page_entries_info(@response, { :entry_name => 'entry_name' })
       html.should == "<strong>21</strong> - <strong>40</strong> of <strong>47</strong>"
       html.html_safe?.should == true
     end