blacklight 5.0.3 → 5.1.0

data/spec/features/alternate_controller_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe "Alternate Controller Behaviors" do
   it "should have the correct per-page form" do
     visit alternate_index_path
-    page.should have_selector("form[action='#{alternate_index_path}']")
+    page.should have_selector("form[action='#{alternate_index_url}']")
     fill_in "q", :with=>"history"
     click_button 'search'
     expect(current_path).to match /#{alternate_index_path}/
@@ -15,7 +15,7 @@ describe "Alternate Controller Behaviors" do
 
   it "should have the correct search field form" do
     visit alternate_index_path
-    page.should have_selector("form[action='#{alternate_index_path}']")
+    page.should have_selector("form[action='#{alternate_index_url}']")
     fill_in "q", :with=>"history"
     click_button 'search'
     expect(current_path).to match /#{alternate_index_path}/
@@ -25,7 +25,7 @@ describe "Alternate Controller Behaviors" do
 
   it "should display document thumbnails" do
     visit alternate_index_path
-    page.should have_selector("form[action='#{alternate_index_path}']")
+    page.should have_selector("form[action='#{alternate_index_url}']")
     fill_in "q", :with=>"history"
     click_button 'search'
     expect(page).to have_selector ".document-thumbnail"

data/spec/features/record_view_spec.rb

@@ -35,6 +35,6 @@ describe "Record View" do
   it "should not display 404" do
     visit catalog_path('this_id_does_not_exist')
     page.driver.status_code.should == 404
-    expect(page).to have_content "Sorry, you have requested a record that doesn't exist." 
+    expect(page).to have_content "The page you were looking for doesn't exist." 
   end
 end

data/spec/helpers/blacklight_helper_spec.rb

@@ -12,7 +12,7 @@ describe BlacklightHelper do
   end
 
   before(:each) do
-    helper.stub(:search_action_url) do |*args|
+    helper.stub(:search_action_path) do |*args|
       catalog_index_url *args
     end
   end
@@ -155,14 +155,14 @@ describe BlacklightHelper do
       doc = double()
       doc.should_receive(:get).with('link_to_search_true', :sep => nil).and_return('x')
       value = helper.render_index_field_value :document => doc, :field => 'link_to_search_true'
-      expect(value).to eq helper.link_to("x", helper.search_action_url(:f => { :link_to_search_true => ['x'] }))
+      expect(value).to eq helper.link_to("x", helper.search_action_path(:f => { :link_to_search_true => ['x'] }))
     end
 
     it "should check for a link_to_search with a field name" do
       doc = double()
       doc.should_receive(:get).with('link_to_search_named', :sep => nil).and_return('x')
       value = helper.render_index_field_value :document => doc, :field => 'link_to_search_named'
-      expect(value).to eq helper.link_to("x", helper.search_action_url(:f => { :some_field => ['x'] }))
+      expect(value).to eq helper.link_to("x", helper.search_action_path(:f => { :some_field => ['x'] }))
     end
 
     it "should gracefully handle when no highlight field is available" do
@@ -253,14 +253,14 @@ describe BlacklightHelper do
       doc = double()
       doc.should_receive(:get).with('link_to_search_true', :sep => nil).and_return('x')
       value = helper.render_document_show_field_value :document => doc, :field => 'link_to_search_true'
-      expect(value).to eq helper.link_to("x", helper.search_action_url(:f => { :link_to_search_true => ['x'] }))
+      expect(value).to eq helper.link_to("x", helper.search_action_path(:f => { :link_to_search_true => ['x'] }))
     end
 
     it "should check for a link_to_search with a field name" do
       doc = double()
       doc.should_receive(:get).with('link_to_search_named', :sep => nil).and_return('x')
       value = helper.render_document_show_field_value :document => doc, :field => 'link_to_search_named'
-      expect(value).to eq helper.link_to("x", helper.search_action_url(:f => { :some_field => ['x'] }))
+      expect(value).to eq helper.link_to("x", helper.search_action_path(:f => { :some_field => ['x'] }))
     end
 
     it "should gracefully handle when no highlight field is available" do

data/spec/helpers/catalog_helper_spec.rb

@@ -177,9 +177,9 @@ describe CatalogHelper do
   end
 
   describe "render_thumbnail_tag" do
+    let(:document) { double }
     it "should call the provided thumbnail method" do
       helper.stub(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      document = double()
       helper.stub(:xyz => "some-thumbnail")
 
       helper.should_receive(:link_to_document).with(document, :label => "some-thumbnail")
@@ -188,8 +188,7 @@ describe CatalogHelper do
 
     it "should create an image tag from the given field" do
       helper.stub(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-      document = double()
-
+      
       document.stub(:has?).with(:xyz).and_return(true)
       document.stub(:first).with(:xyz).and_return("http://example.com/some.jpg")
 
@@ -197,18 +196,32 @@ describe CatalogHelper do
       helper.render_thumbnail_tag document
     end
 
+    it "should not link to the document if the url options are false" do
+      helper.stub(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
+      helper.stub(:xyz => "some-thumbnail")
+
+      result = helper.render_thumbnail_tag document, {}, false
+      expect(result).to eq "some-thumbnail"
+    end
+
+    it "should not link to the document if the url options have :suppress_link" do
+      helper.stub(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
+      helper.stub(:xyz => "some-thumbnail")
+
+      result = helper.render_thumbnail_tag document, {}, suppress_link: true
+      expect(result).to eq "some-thumbnail"
+    end
+    
+
     it "should return nil if no thumbnail is available" do
       helper.stub(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
-
-      document = double()
       expect(helper.render_thumbnail_tag document).to be_nil
     end
 
     it "should return nil if no thumbnail is returned from the thumbnail method" do
       helper.stub(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
       helper.stub(:xyz => nil)
-      document = double()
-
+      
       expect(helper.render_thumbnail_tag document).to be_nil
     end
   end

data/spec/helpers/configuration_helper_spec.rb

@@ -58,4 +58,46 @@ describe BlacklightConfigurationHelper do
       expect(helper.spell_check_max).to eq config_value
     end
   end
+
+  describe "#index_field_label" do
+    let(:document) { double }
+    it "should look up the label to display for the given document and field" do
+      helper.stub(:index_fields).and_return({ "my_field" => double(label: "some label") })
+      helper.should_receive(:solr_field_label).with("some label", :"blacklight.search.fields.index.my_field", :"blacklight.search.fields.my_field")
+      helper.index_field_label document, "my_field"
+    end
+  end
+
+  describe "#document_show_field_label" do
+    let(:document) { double }
+    it "should look up the label to display for the given document and field" do
+      helper.stub(:document_show_fields).and_return({ "my_field" => double(label: "some label") })
+      helper.should_receive(:solr_field_label).with("some label", :"blacklight.search.fields.show.my_field", :"blacklight.search.fields.my_field")
+      helper.document_show_field_label document, "my_field"
+    end
+  end
+
+  describe "#facet_field_label" do
+    let(:document) { double }
+    it "should look up the label to display for the given document and field" do
+      blacklight_config.stub(:facet_fields).and_return({ "my_field" => double(label: "some label") })
+      helper.should_receive(:solr_field_label).with("some label", :"blacklight.search.fields.facet.my_field", :"blacklight.search.fields.my_field")
+      helper.facet_field_label "my_field"
+    end
+  end
+
+  describe "#solr_field_label" do
+    it "should look up the label as an i18n string" do
+      helper.should_receive(:t).with(:some_key).and_return "my label"
+      label = helper.solr_field_label :some_key
+
+      expect(label).to eq "my label"
+    end
+
+    it "should pass the provided i18n keys to I18n.t" do
+      helper.should_receive(:t).with(:key_a, default: [:key_b, "default text"])
+
+      label = helper.solr_field_label "default text", :key_a, :key_b
+    end
+  end
 end

data/spec/helpers/facets_helper_spec.rb

@@ -299,9 +299,13 @@ describe FacetsHelper do
       helper.stub(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil, :single => false))
       helper.should_receive(:facet_display_value).and_return('Z')
       helper.should_receive(:add_facet_params_and_redirect).and_return({controller:'catalog'})
+      
+      helper.stub(:search_action_path) do |*args|
+        catalog_index_path *args
+      end
     end
     describe "simple case" do
-      let(:expected_html) { "<span class=\"facet-label\"><a class=\"facet_select\" href=\"/\">Z</a></span><span class=\"facet-count\">10</span>" }
+      let(:expected_html) { "<span class=\"facet-label\"><a class=\"facet_select\" href=\"/catalog\">Z</a></span><span class=\"facet-count\">10</span>" }
       it "should use facet_display_value" do
         result = helper.render_facet_value('simple_field', item)
         expect(result).to be_equivalent_to(expected_html).respecting_element_order
@@ -315,17 +319,6 @@ describe FacetsHelper do
         expect(result).to be_equivalent_to(expected_html).respecting_element_order
       end
     end
-
-    describe "when a route_set is passed" do
-      let(:my_engine) { double("Engine") }
-      let(:expected_html) { "<span class=\"facet-label\"><a class=\"facet_select\" href=\"/\">Z</a></span><span class=\"facet-count\">10</span>" }
-
-      it "should use the engine scope" do
-        expect(my_engine).to receive(:url_for).and_return({controller: 'catalog'})
-        result = helper.render_facet_value('simple_field', item, route_set: my_engine)
-        expect(result).to be_equivalent_to(expected_html).respecting_element_order
-      end
-    end
   end
  
   describe "#facet_display_value" do

data/spec/helpers/render_constraints_helper_spec.rb

@@ -5,6 +5,9 @@ describe RenderConstraintsHelper do
   before do
     # the helper methods below infer paths from the current route
     controller.request.path_parameters["controller"] = 'catalog'
+    helper.stub(:search_action_path) do |*args|
+      catalog_index_path *args
+    end
   end
 
   describe '#render_constraints_query' do
@@ -23,7 +26,7 @@ describe RenderConstraintsHelper do
     it "should have a link relative to the current url" do
       result = helper.render_filter_element('type', ['journal'], {:q=>'biz'})
       # I'm not certain how the ampersand gets in there. It's not important.
-      expect(result).to have_selector "a[href='/?&q=biz']"
+      expect(result).to have_link "Remove constraint Type: journal", href: "/catalog?&q=biz"
     end
   end
 

data/spec/helpers/url_helper_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe BlacklightHelper do
+describe BlacklightUrlHelper do
 
   let(:blacklight_config) do
     @config ||= Blacklight::Configuration.new.configure do |config|
@@ -10,15 +10,12 @@ describe BlacklightHelper do
   end
 
   before(:each) do
-    helper.stub(:search_action_url) do |*args|
+    helper.stub(:search_action_path) do |*args|
       catalog_index_url *args
     end
 
-    helper.stub(:blacklight_config).and_return blacklight_config
-  end
-
-  def current_search_session
-
+    helper.stub(blacklight_config: blacklight_config)
+    helper.stub(current_search_session: nil)
   end
 
   describe "link_back_to_catalog" do
@@ -61,96 +58,96 @@ describe BlacklightHelper do
   describe "link_to_query" do
     it "should build a link tag to catalog using query string (no other params)" do
       query = "brilliant"
-      self.should_receive(:params).and_return({})
-      tag = link_to_query(query)
+      helper.stub(params: {})
+      tag = helper.link_to_query(query)
       expect(tag).to match /q=#{query}/
       expect(tag).to match />#{query}<\/a>/
     end
     it "should build a link tag to catalog using query string and other existing params" do
       query = "wonderful"
-      self.should_receive(:params).and_return({:qt => "title_search", :per_page => "50"})
-      tag = link_to_query(query)
+      helper.stub(params: {:qt => "title_search", :per_page => "50"})
+      tag = helper.link_to_query(query)
       expect(tag).to match /qt=title_search/
       expect(tag).to match /per_page=50/
     end
     it "should ignore existing :page param" do
       query = "yes"
-      self.should_receive(:params).and_return({:page => "2", :qt => "author_search"})
-      tag = link_to_query(query)
+      helper.stub(params: {:page => "2", :qt => "author_search"})
+      tag = helper.link_to_query(query)
       expect(tag).to match /qt=author_search/
       expect(tag).to_not match /page/
     end
     it "should be html_safe" do
       query = "brilliant"
-      self.should_receive(:params).and_return({:page => "2", :qt => "author_search"})
-      tag = link_to_query(query)
+      helper.stub(params: {:page => "2", :qt => "author_search"})
+      tag = helper.link_to_query(query)
       expect(tag).to be_html_safe
     end
   end
 
   describe "sanitize_search_params" do
     it "should strip nil values" do
-      result = sanitize_search_params(:a => nil, :b => 1)
+      result = helper.sanitize_search_params(:a => nil, :b => 1)
       expect(result).to_not have_key(:a)
       expect(result[:b]).to eq 1
     end
 
     it "should remove blacklisted keys" do
-      result = sanitize_search_params(:action => true, :controller => true, :id => true, :commit => true, :utf8 => true)
+      result = helper.sanitize_search_params(:action => true, :controller => true, :id => true, :commit => true, :utf8 => true)
       expect(result).to be_empty
     end
   end
 
   describe "params_for_search" do
-    def params
-      { 'default' => 'params'}
+    before do
+      helper.stub(params: { 'default' => 'params'})
     end
 
     it "should default to using the controller's params" do
-      result = params_for_search
-      expect(result).to eq params
+      result = helper.params_for_search
+      expect(result).to eq({ 'default' => 'params' })
       expect(params.object_id).to_not eq result.object_id
     end
 
     it "should let you pass in params to merge into the controller's params" do
       source_params = { :q => 'query'}
-      result = params_for_search( source_params )
+      result = helper.params_for_search( source_params )
       expect(result).to include(:q => 'query', 'default' => 'params')
     end
 
     it "should not return blacklisted elements" do
       source_params = { :action => 'action', :controller => 'controller', :id => "id", :commit => 'commit'}
-      result = params_for_search(source_params)
+      result = helper.params_for_search(source_params)
       expect(result.keys).to_not include(:action, :controller, :commit, :id)
     end
 
     it "should adjust the current page if the per_page changes" do
       source_params = { :per_page => 20, :page => 5}
-      result = params_for_search(source_params, :per_page => 100)
+      result = helper.params_for_search(source_params, :per_page => 100)
       expect(result[:page]).to eq 1
     end
 
     it "should not adjust the current page if the per_page is the same as it always was" do
       source_params = { :per_page => 20, :page => 5}
-      result = params_for_search(source_params, :per_page => 20)
+      result = helper.params_for_search(source_params, :per_page => 20)
       expect(result[:page]).to eq 5
     end
 
     it "should adjust the current page if the sort changes" do
       source_params = { :sort => 'field_a', :page => 5}
-      result = params_for_search(source_params, :sort => 'field_b')
+      result = helper.params_for_search(source_params, :sort => 'field_b')
       expect(result[:page]).to eq 1
     end
 
     it "should not adjust the current page if the sort is the same as it always was" do
       source_params = { :sort => 'field_a', :page => 5}
-      result = params_for_search(source_params, :sort => 'field_a')
+      result = helper.params_for_search(source_params, :sort => 'field_a')
       expect(result[:page]).to eq 5
     end
 
     describe "params_for_search with a block" do
       it "should evalute the block and allow it to add or remove keys" do
-        result = params_for_search({:a => 1, :b => 2}, :c => 3) do |params|
+        result = helper.params_for_search({:a => 1, :b => 2}, :c => 3) do |params|
           params.except! :a, :b 
           params[:d] = 'd'
         end
@@ -183,53 +180,53 @@ describe BlacklightHelper do
     it "should consist of the document title wrapped in a <a>" do
       data = {'id'=>'123456','title_display'=>['654321'] }
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document, { :label => :title_display })).to have_selector("a", :text => '654321', :count => 1)
+      expect(helper.link_to_document(@document, { :label => :title_display })).to have_selector("a", :text => '654321', :count => 1)
     end
 
     it "should accept and return a string label" do
       data = {'id'=>'123456','title_display'=>['654321'] }
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document, { :label => "title_display" })).to have_selector("a", :text => 'title_display', :count => 1)
+      expect(helper.link_to_document(@document, { :label => "title_display" })).to have_selector("a", :text => 'title_display', :count => 1)
     end
 
     it "should accept and return a Proc" do
       data = {'id'=>'123456','title_display'=>['654321'] }
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document, { :label => Proc.new { |doc, opts| doc.get(:id) + ": " + doc.get(:title_display) } })).to have_selector("a", :text => '123456: 654321', :count => 1)
+      expect(helper.link_to_document(@document, { :label => Proc.new { |doc, opts| doc.get(:id) + ": " + doc.get(:title_display) } })).to have_selector("a", :text => '123456: 654321', :count => 1)
     end
 
     it "should return id when label is missing" do
       data = {'id'=>'123456'}
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document, { :label => :title_display })).to have_selector("a", :text => '123456', :count => 1)
+      expect(helper.link_to_document(@document, { :label => :title_display })).to have_selector("a", :text => '123456', :count => 1)
     end
 
     it "should be html safe" do
       data = {'id'=>'123456'}
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document, { :label => :title_display })).to be_html_safe
+      expect(helper.link_to_document(@document, { :label => :title_display })).to be_html_safe
     end
 
     it "should convert the counter parameter into a data- attribute" do
       data = {'id'=>'123456','title_display'=>['654321']}
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document, { :label => :title_display, :counter => 5  })).to match /data-counter="5"/
+      expect(helper.link_to_document(@document, { :label => :title_display, :counter => 5  })).to match /data-counter="5"/
     end
 
     it "passes on the title attribute to the link_to_with_data method" do
       @document = SolrDocument.new('id'=>'123456')
-      expect(link_to_document(@document,:label=>"Some crazy long label...",:title=>"Some crazy longer label")).to match(/title=\"Some crazy longer label\"/)
+      expect(helper.link_to_document(@document,:label=>"Some crazy long label...",:title=>"Some crazy longer label")).to match(/title=\"Some crazy longer label\"/)
     end
 
     it "doesn't add an erroneous title attribute if one isn't provided" do
       @document = SolrDocument.new('id'=>'123456')
-      expect(link_to_document(@document,:label=>"Some crazy long label...")).to_not match(/title=/)
+      expect(helper.link_to_document(@document,:label=>"Some crazy long label...")).to_not match(/title=/)
     end
 
     it "should  work with integer ids" do
       data = {'id'=> 123456 }
       @document = SolrDocument.new(data)
-      expect(link_to_document(@document)).to have_selector("a")
+      expect(helper.link_to_document(@document)).to have_selector("a")
     end
 
   end
@@ -238,7 +235,7 @@ describe BlacklightHelper do
     it "should link to the given search parameters" do
       params = {}
       helper.should_receive(:render_search_to_s).with(params).and_return "link text"
-      expect(helper.link_to_previous_search({})).to eq helper.link_to("link text", catalog_index_path)
+      expect(helper.link_to_previous_search({})).to eq helper.link_to("link text", helper.search_action_path)
     end
   end
 
@@ -330,17 +327,12 @@ describe BlacklightHelper do
                 :per_page => "50",
                 :page => "5",
                 :f => {"facet_field_1" => ["value1"], "facet_field_2" => ["value2", "value2a"]},
-                Blacklight::Solr::FacetPaginator.request_keys[:offset] => "100",
+                Blacklight::Solr::FacetPaginator.request_keys[:page] => "100",
                 Blacklight::Solr::FacetPaginator.request_keys[:sort] => "index",
                 :id => 'facet_field_name'
       }
       helper.stub(:params).and_return(catalog_facet_params)
     end
-    it "should redirect to 'index' action" do
-      params = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
-
-      expect(params[:action]).to eq "index"
-    end
     it "should not include request parameters used by the facet paginator" do
       params = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
 
@@ -351,17 +343,13 @@ describe BlacklightHelper do
     end
     it 'should remove :page request key' do
       params = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
-
       expect(params.keys).to_not include(:page)
     end
     it "should otherwise do the same thing as add_facet_params" do
       added_facet_params = helper.add_facet_params("facet_field_2", "facet_value")
       added_facet_params_from_facet_action = helper.add_facet_params_and_redirect("facet_field_2", "facet_value")
 
-      added_facet_params_from_facet_action.each_pair do |key, value|
-        next if key == :action
-        expect(value).to eq added_facet_params[key]
-      end      
+      expect(added_facet_params_from_facet_action).to eq added_facet_params.except(Blacklight::Solr::FacetPaginator.request_keys[:page], Blacklight::Solr::FacetPaginator.request_keys[:sort])     
     end
   end
 end