blacklight 5.3.0 → 5.4.0.rc1

data/spec/features/search_formats_spec.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+
+require 'spec_helper'
+
+describe "Search Formats" do
+  before do
+    # Get all the fields from Solr, so the #index documents have the MARC field (to trigger appropriate
+    # export formats)
+    CatalogController.blacklight_config.default_solr_params[:fl] = '*'
+  end
+
+  it "should have an RSS XML response" do
+    visit "/catalog.rss?q="
+    expect(page).to have_content "Blacklight Search Results"
+    doc = Nokogiri::XML(page.body)
+    expect(doc.xpath("//item")).to have(10).items
+  end
+
+  it "should have an ATOM XML response" do
+    visit "/catalog.atom?q="
+    expect(page).to have_content "Blacklight Search Results"
+    doc = Nokogiri::XML(page.body)
+    expect(doc.xpath("//atom:entry", atom: "http://www.w3.org/2005/Atom")).to have(10).entries
+  end
+
+  it "should return new-line separated RIS records" do
+    visit "/catalog.endnote?q=" 
+    expect(page.status_code).to eq 200
+    rmt_regex = /^%0/
+    expect(page).to have_content "%A Bstan-ʼdzin-rgya-mtsho,"
+    expect(page).to have_content "%@ 9789573908678"
+    expect(page.body).to match rmt_regex
+    expect(page.body.scan(rmt_regex).length).to eq 10
+  end
+
+  it "should return new-line separated MARC records" do
+    visit "/catalog.refworks_marc_txt?q=" 
+    expect(page.status_code).to eq 200
+    rmt_regex = /LEADER .+\n(\d\d\d .. .+\n)+/
+    expect(page).to have_content "LEADER 01221cam a22002534a 4500001"
+    expect(page).to have_content "LEADER 01127cam a22002895a 4500001"
+    expect(page.body).to match rmt_regex
+    expect(page.body.scan(rmt_regex).length).to eq 10 
+  end
+end

data/spec/helpers/blacklight_helper_spec.rb

@@ -122,6 +122,7 @@ describe BlacklightHelper do
       helper.stub(:blacklight_config).and_return(@config)
       helper.stub(:has_user_authentication_provider?).and_return(true)
       helper.stub(:current_or_guest_user).and_return(User.new)
+      helper.stub(current_bookmarks: [])
     end
     describe "render_index_doc_actions" do
       it "should render partials" do
@@ -136,6 +137,48 @@ describe BlacklightHelper do
       end
     end
   end
+  
+  describe "#should_render_index_field?" do
+    before do
+      helper.stub(should_render_field?: true, document_has_value?: true)
+    end
+    
+    it "should be true" do
+      expect(helper.should_render_index_field?(double, double)).to be_true
+    end
+    
+    it "should be false if the document doesn't have a value for the field" do
+      helper.stub(document_has_value?: false)
+      expect(helper.should_render_index_field?(double, double)).to be_false
+      
+    end
+    
+    it "should be false if the configuration has the field disabled" do
+      helper.stub(should_render_field?: false)
+      expect(helper.should_render_index_field?(double, double)).to be_false
+    end
+  end
+
+  describe "#should_render_show_field?" do
+    before do
+      helper.stub(should_render_field?: true, document_has_value?: true)
+    end
+    
+    it "should be true" do
+      expect(helper.should_render_show_field?(double, double)).to be_true
+    end
+    
+    it "should be false if the document doesn't have a value for the field" do
+      helper.stub(document_has_value?: false)
+      expect(helper.should_render_show_field?(double, double)).to be_false
+      
+    end
+    
+    it "should be false if the configuration has the field disabled" do
+      helper.stub(should_render_field?: false)
+      expect(helper.should_render_show_field?(double, double)).to be_false
+    end
+  end
 
   describe "render_index_field_value" do
     before do
@@ -336,38 +379,13 @@ describe BlacklightHelper do
       expect(value).to eq "123"
     end
   end
-
-  describe "#should_render_index_field?" do
-    it "should if the document has the field value" do
-      doc = double()
-      doc.stub(:has?).with('asdf').and_return(true)
-      field_config = double(:field => 'asdf')
-      helper.should_render_index_field?(doc, field_config).should == true
-    end
-
-    it "should if the document has a highlight field value" do
-      doc = double()
-      doc.stub(:has?).with('asdf').and_return(false)
-      doc.stub(:has_highlight_field?).with('asdf').and_return(true)
-      field_config = double(:field => 'asdf', :highlight => true)
-      helper.should_render_index_field?(doc, field_config).should == true
-    end
-
-    it "should if the field has a model accessor" do
-      doc = double()
-      doc.stub(:has?).with('asdf').and_return(false)
-      doc.stub(:has_highlight_field?).with('asdf').and_return(false)
-      field_config = double(:field => 'asdf', :highlight => true, :accessor => true)
-      helper.should_render_index_field?(doc, field_config).should == true
-    end
-  end
-
-  describe "#should_render_show_field?" do
+  
+  describe "#document_has_value?" do
     it "should if the document has the field value" do
       doc = double()
       doc.stub(:has?).with('asdf').and_return(true)
       field_config = double(:field => 'asdf')
-      expect(helper.should_render_show_field?(doc, field_config)).to be_true
+      helper.document_has_value?(doc, field_config).should == true
     end
 
     it "should if the document has a highlight field value" do
@@ -375,7 +393,7 @@ describe BlacklightHelper do
       doc.stub(:has?).with('asdf').and_return(false)
       doc.stub(:has_highlight_field?).with('asdf').and_return(true)
       field_config = double(:field => 'asdf', :highlight => true)
-      expect(helper.should_render_show_field?(doc, field_config)).to be_true
+      helper.document_has_value?(doc, field_config).should == true
     end
 
     it "should if the field has a model accessor" do
@@ -383,7 +401,7 @@ describe BlacklightHelper do
       doc.stub(:has?).with('asdf').and_return(false)
       doc.stub(:has_highlight_field?).with('asdf').and_return(false)
       field_config = double(:field => 'asdf', :highlight => true, :accessor => true)
-      helper.should_render_show_field?(doc, field_config).should == true
+      helper.document_has_value?(doc, field_config).should == true
     end
   end
 
@@ -552,4 +570,27 @@ describe BlacklightHelper do
       expect(subject).to have_selector "link[href='href']", visible: false
     end
   end
+  
+  describe "#render_document_index" do
+    it "should render the document index with the current view type" do
+      helper.stub(document_index_view_type: :current_view)
+      helper.should_receive(:render_document_index_with_view).with(:current_view, [], a: 1, b: 2)
+      helper.render_document_index [], a: 1, b: 2
+    end
+  end
+  
+  describe "#render_document_index_with_view" do
+    it "should ignore missing templates" do
+      helper.stub(:render) do |options|
+        if options[:partial] == "document_view_type"
+          raise ActionView::MissingTemplate.new [], '', '', '', ''
+        else
+          options[:partial]
+        end
+      end
+      
+      response = helper.render_document_index_with_view :view_type, [double, double]
+      expect(response).to eq "catalog/document_view_type"
+    end
+  end
 end

data/spec/helpers/configuration_helper_spec.rb

@@ -17,11 +17,18 @@ describe BlacklightConfigurationHelper do
 
   describe "#sort_fields" do
     it "should convert the sort fields to select-ready values" do
-      blacklight_config.stub(sort_fields: { 'a' => double(key: 'a', label: 'a'), 'b' => double(key: 'b', label: 'b'),  })
+      blacklight_config.stub(sort_fields: { 'a' => double(key: 'a', label: 'a'), 'b' => double(key: 'b', label: 'b'), c: double(key: 'c', if: false)  })
       expect(helper.sort_fields).to eq [['a', 'a'], ['b', 'b']]
     end
   end
 
+  describe "#active_sort_fields" do
+    it "should restrict the configured sort fields to only those that should be displayed" do
+      blacklight_config.stub(sort_fields: { a: double(if: false, unless: false), b: double(if:true, unless: true) })
+      expect(helper.active_sort_fields).to be_empty
+    end
+  end
+
   describe "#document_show_fields" do
     it "should pass through the configuration" do
       blacklight_config.stub(show_fields: config_value)
@@ -30,9 +37,31 @@ describe BlacklightConfigurationHelper do
   end
 
   describe "#default_document_index_view_type" do
-    it "should be the first configured index view" do
-      blacklight_config.stub(view: { 'a' => true, 'b' => true})
-      expect(helper.default_document_index_view_type).to eq 'a'
+    it "should use the first view with default set to true" do
+      blacklight_config.view.a
+      blacklight_config.view.b
+      blacklight_config.view.b.default = true
+      expect(helper.default_document_index_view_type).to eq :b
+    end
+    
+    it "should default to the first configured index view" do
+      blacklight_config.stub(view: { a: true, b: true})
+      expect(helper.default_document_index_view_type).to eq :a
+    end
+  end
+  
+  describe "#document_index_views" do
+    before do
+      blacklight_config.view.abc = false
+      blacklight_config.view.def.if = false
+      blacklight_config.view.xyz.unless = true
+    end
+
+    it "should filter views using :if/:unless configuration" do
+      helper.document_index_views.should have_key :list
+      helper.document_index_views.should_not have_key :abc
+      helper.document_index_views.should_not have_key :def
+      helper.document_index_views.should_not have_key :xyz
     end
   end
 
@@ -113,6 +142,18 @@ describe BlacklightConfigurationHelper do
     end
   end
   
+  describe "#default_sort_field" do
+    it "should be the configured default field" do
+      helper.stub(blacklight_config: double(sort_fields: { a: double(default: nil), b: double(key: 'b', default: true) }))
+      expect(helper.default_sort_field.key).to eq 'b'
+    end
+    
+    it "should be the first per-page value if a default isn't set" do
+      helper.stub(blacklight_config: double(sort_fields: { a: double(key: 'a', default: nil), b: double(key: 'b', default: nil) }))
+      expect(helper.default_sort_field.key).to eq 'a'
+    end
+  end
+  
   describe "#per_page_options_for_select" do
     it "should be the per-page values formatted as options_for_select" do
       helper.stub(blacklight_config: double(per_page: [11, 22, 33]))
@@ -121,4 +162,87 @@ describe BlacklightConfigurationHelper do
       expect(helper.per_page_options_for_select).to include ["33<span class=\"sr-only\"> per page</span>", 33]
     end
   end
+  
+  describe "#should_render_field?" do
+    let(:field_config) { double('field config', if: true, unless: false) }
+    
+    before do
+      helper.stub(document_has_value?: true)
+    end
+
+    it "should be true" do
+      expect(helper.should_render_field?(field_config)).to be_true
+    end
+    
+    it "should be false if the :if condition is false" do
+      field_config.stub(if: false)
+      expect(helper.should_render_field?(field_config)).to be_false
+    end
+    
+    it "should be false if the :unless condition is true" do
+      field_config.stub(unless: true)
+      expect(helper.should_render_field?(field_config)).to be_false
+    end
+  end
+  
+  describe "#evaluate_configuration_conditional" do
+    it "should pass through regular values" do
+      val = double
+      expect(helper.evaluate_configuration_conditional(val)).to eq val
+    end
+
+    it "should execute a helper method" do
+      helper.stub(:my_helper => true)
+      expect(helper.evaluate_configuration_conditional(:my_helper)).to be_true
+    end
+
+    it "should call a helper to determine if it should render a field" do
+      a = double
+      helper.should_receive(:my_helper_with_an_arg).with(a).and_return(true)
+      expect(helper.evaluate_configuration_conditional(:my_helper_with_an_arg, a)).to be_true
+    end
+
+    it "should evaluate a Proc to determine if it should render a field" do
+      one_arg_lambda = lambda { |context, a| true }
+      two_arg_lambda = lambda { |context, a, b| true }
+      expect(helper.evaluate_configuration_conditional(one_arg_lambda, 1)).to be_true
+      expect(helper.evaluate_configuration_conditional(two_arg_lambda, 1, 2)).to be_true
+    end
+  end
+  
+  describe "#search_field_options_for_select" do
+    
+    before do
+    
+      @config = Blacklight::Configuration.new do |config|
+        config.default_solr_params = { :qt => 'search' }
+        
+        config.add_search_field 'all_fields', :label => 'All Fields'
+        config.add_search_field 'title', :qt => 'title_search'
+        config.add_search_field 'author', :qt => 'author_search'
+        config.add_search_field 'subject', :qt => 'subject_search'
+        config.add_search_field 'no_display', :qt => 'something', :include_in_simple_select => false
+      end
+
+      helper.stub(blacklight_config: @config)
+    end
+    
+    it "should return proper options_for_select arguments" do
+
+      select_arguments = helper.search_field_options_for_select
+
+      select_arguments.each do |(label, key)|
+         config_hash = @config.search_fields[key]
+
+         expect(label).to eq config_hash.label
+         expect(key).to eq config_hash.key
+      end    
+    end
+
+    it "should not include fields in select if :display_in_simple_search=>false" do
+      select_arguments = helper.search_field_options_for_select
+
+      expect(select_arguments).not_to include(["No Display", "no_display"])
+    end
+  end
 end

data/spec/helpers/facets_helper_spec.rb

@@ -65,7 +65,7 @@ describe FacetsHelper do
 
     it "should call a helper to determine if it should render a field" do
       a = double(:items => [1,2], :name=>'helper_with_an_arg_show')
-      helper.should_receive(:my_helper_with_an_arg).with(a).and_return(true)
+      helper.should_receive(:my_helper_with_an_arg).with(@config.facet_fields['helper_with_an_arg_show'], a).and_return(true)
       expect(helper.should_render_facet?(a)).to be_true
     end
 

data/spec/lib/blacklight/configuration_spec.rb

@@ -39,11 +39,6 @@ describe "Blacklight::Configuration" do
       expect(@config.index).to be_a_kind_of OpenStruct
     end
 
-    it "should introspect SolrDocument for sensible defaults  for show + index" do
-      expect(@config.view_config(:show).title_field).to eq 'id'
-      expect(@config.index.title_field).to eq 'id'
-    end
-
     it "should have ordered hashes for field configuration" do
       expect(@config.facet_fields).to be_a_kind_of ActiveSupport::OrderedHash
       expect(@config.index_fields).to be_a_kind_of ActiveSupport::OrderedHash

data/spec/lib/blacklight/search_fields_spec.rb

@@ -32,28 +32,6 @@ describe Blacklight::SearchFields do
   it "should fill in default qt where needed" do
     expect(@search_field_obj.search_field_def_for_key("all_fields").qt).to eq @config.default_solr_params[:qt]
   end
-  
-  it "should return proper options_for_select arguments" do
-
-    select_arguments = @search_field_obj.search_field_options_for_select
-
-    select_arguments.each_index do |index|
-       argument = select_arguments[index]
-       config_hash = @search_field_obj.search_field_list[index]
-
-       expect(argument).to have(2).items
-       expect(argument[0]).to eq config_hash.label
-       expect(argument[1]).to eq config_hash.key
-    end    
-  end
-
-  it "should not include fields in select if :display_in_simple_search=>false" do
-    select_arguments = @search_field_obj.search_field_options_for_select
-
-    expect(select_arguments).not_to include(["No Display", "no_display"])
-  end
-
-  
 
   it "should lookup field definitions by key" do
     expect(@search_field_obj.search_field_def_for_key("title").key).to eq "title"

data/spec/lib/blacklight/solr/document_spec.rb

@@ -172,6 +172,12 @@ describe "Blacklight::Solr::Document" do
         doc.will_export_as(:marc, "application/marc")
         expect(doc.export_as(:marc)).to eq "fake_marc"
       end
+      
+      it "should know if a document is exportable" do
+        doc = MockDocument.new
+        doc.will_export_as(:marc, "application/marc")
+        expect(doc.exports_as?(:marc)).to be_true
+      end
     end
 
     context "to_semantic_fields" do

data/spec/lib/blacklight/solr_helper_spec.rb

@@ -254,7 +254,19 @@ describe Blacklight::SolrHelper do
       it "should pass date-type fields through" do
         blacklight_config.facet_fields.stub(:[]).with('facet_name').and_return(double(:date => true, :query => nil, :tag => nil))
 
-        expect(subject.send(:facet_value_to_fq_string, "facet_name", "2012-01-01")).to eq "facet_name:2012-01-01"
+        expect(subject.send(:facet_value_to_fq_string, "facet_name", "2012-01-01")).to eq "facet_name:2012\\-01\\-01"
+      end
+
+      it "should escape datetime-type fields" do
+        blacklight_config.facet_fields.stub(:[]).with('facet_name').and_return(double(:date => true, :query => nil, :tag => nil))
+
+        expect(subject.send(:facet_value_to_fq_string, "facet_name", "2003-04-09T00:00:00Z")).to eq "facet_name:2003\\-04\\-09T00\\:00\\:00Z"
+      end
+      
+      it "should format Date objects correctly" do
+        blacklight_config.facet_fields.stub(:[]).with('facet_name').and_return(double(:date => nil, :query => nil, :tag => nil))
+        d = DateTime.parse("2003-04-09T00:00:00")
+        expect(subject.send(:facet_value_to_fq_string, "facet_name", d)).to eq "facet_name:2003\\-04\\-09T00\\:00\\:00Z"      
       end
 
       it "should handle range requests" do
@@ -463,7 +475,12 @@ describe Blacklight::SolrHelper do
         config.add_search_field("test_field",
                              :display_label => "Test", 
                              :key=>"test_field", 
-                             :solr_parameters => {:qf => "fieldOne^2.3 fieldTwo fieldThree^0.4", :pf => "", :spellcheck => 'false', :rows => "55", :sort => "request_params_sort" }
+                             :solr_parameters => {
+                               :qf => "fieldOne^2.3 fieldTwo fieldThree^0.4", 
+                               :pf => "", 
+                               :spellcheck => 'false', 
+                               :rows => "55", 
+                               :sort => "request_params_sort" }
                             )
         return config
       end
@@ -701,8 +718,10 @@ describe Blacklight::SolrHelper do
   end
   
    describe "get_facet_pagination", :integration => true do
-    before(:each) do
-      @facet_paginator = subject.get_facet_pagination(@facet_field)
+    before do
+      Deprecation.silence(Blacklight::SolrHelper) do
+        @facet_paginator = subject.get_facet_pagination(@facet_field)
+      end
     end
     it 'should return a facet paginator' do
       expect(@facet_paginator).to be_a_kind_of(Blacklight::Solr::FacetPaginator)
@@ -1042,7 +1061,6 @@ describe Blacklight::SolrHelper do
       expect(@document.id).to eq @doc_id
     end
     it 'should have non-nil values for required fields set in initializer' do
-      expect(@document.get(blacklight_config.view_config(:show).title_field)).not_to be_nil
       expect(@document.get(blacklight_config.view_config(:show).display_type_field)).not_to be_nil
     end
   end
@@ -1097,7 +1115,9 @@ describe Blacklight::SolrHelper do
   describe "Get Document Via Search", :integration => true do
     before do
       @doc_row = 3
-      @doc = subject.get_single_doc_via_search(@doc_row, :q => @all_docs_query)
+      Deprecation.silence(Blacklight::SolrHelper) do
+        @doc = subject.get_single_doc_via_search(@doc_row, :q => @all_docs_query)
+      end
     end
 =begin
 # can't test these here, because the method only returns the document
@@ -1120,13 +1140,14 @@ describe Blacklight::SolrHelper do
     end
 
     it 'should have non-nil values for required fields set in initializer' do
-      expect(@doc[blacklight_config.view_config(:show).title_field]).not_to be_nil
       expect(@doc[blacklight_config.view_config(:show).display_type_field]).not_to be_nil
     end
 
     it "should limit search result by facets when supplied" do
-      doc2 = subject.get_single_doc_via_search(@doc_row , :q => @all_docs_query, :f => @multi_facets)
-      expect(doc2[:id]).not_to be_nil
+      Deprecation.silence(Blacklight::SolrHelper) do
+        doc2 = subject.get_single_doc_via_search(@doc_row , :q => @all_docs_query, :f => @multi_facets)
+        expect(doc2[:id]).not_to be_nil
+      end
     end
 
   end
@@ -1239,7 +1260,7 @@ describe Blacklight::SolrHelper do
     describe "#get_solr_response_for_field_values" do
       before do
         @mock_response = double()
-        @mock_response.stub(:docs => [])
+        @mock_response.stub(documents: [])
       end
       it "should contruct a solr query based on the field and value pair" do
         subject.should_receive(:find).with(hash_including(:q => "field_name:(value)")).and_return(@mock_response)