blacklight 4.0.1 → 4.1.0

data/test_support/features/search.feature

@@ -30,13 +30,10 @@ Feature: Search
     And I should see "All Fields"
     And I should see "history"
     And I should see select list "select#search_field" with "All Fields" selected
-    And I should see "per page"
-    And I should see a selectable list with per page choices
     And I should see "1."
     And I should see "2."
     And I should see "3."
     And I should see "Sort by"
-    
 
   Scenario: Submitting a Search with specific field selected
     When I am on the home page

data/test_support/features/search_pagination.feature

@@ -0,0 +1,53 @@
+@search_pagination
+Feature: Search Pagination
+  In order to find lower ranked documents
+  As a user
+  I want to be able to page through search results and be able to choose how
+  many documents to display per page
+
+  Background:
+    Given the application is configured to have per page with values "10, 20, 50"
+
+  Scenario: Results Page Supports Paging
+    Given I am on the home page
+    When I fill in "q" with ""
+    And I press "search"
+    Then I should see "1 - 10 of"
+    When I follow "Next »"
+    Then I should see "11 - 20 of"
+    When I follow "« Previous"
+    Then I should see "1 - 10 of"
+
+  Scenario: Results Page Has Per Page Available
+    Given I am on the home page
+    When I fill in "q" with ""
+    And I press "search"
+    Then I should see "per page"
+    And I should see the per_page dropdown with values "10, 20, 50"
+
+  Scenario: Results Page Can Display 20 Items Per Page
+    Given I am on the home page
+    And I fill in "q" with ""
+    When I press "search"
+    Then I should see "1 - 10 of"
+    When I show 20 per page
+    Then I should see "1 - 20 of"
+
+  Scenario: Application Can Be Configured for Other Per Page Values
+    Given the application is configured to have per page with values "15, 30"
+    And I am on the home page
+    When I fill in "q" with ""
+    And I press "search"
+    Then I should see the per_page dropdown with values "15, 30"
+    And I should see "1 - 15 of"
+    When I show 30 per page
+    Then I should see "1 - 30 of"
+
+  Scenario: Page Offset Resets to 1 When Changing Per Page
+    Given I am on the home page
+    And I fill in "q" with ""
+    When I press "search"
+    And I follow "Next »"
+    Then I should see "11 - 20 of"
+    When I show 20 per page
+    Then I should see "1 - 20 of"

data/test_support/features/step_definitions/search_pagination_steps.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+Given /^the application is configured to have per page with values "([^\"]*)"$/ do |values|
+  values = values.split(", ")
+  CatalogController.blacklight_config[:per_page] = []
+  values.each do |value|
+    CatalogController.blacklight_config[:per_page] << value
+  end
+  CatalogController.blacklight_config[:default_solr_params][:rows] = values[0]
+end
+
+
+Then /^I should see a selectable list with per page choices$/ do
+  page.should have_selector("#per_page-dropdown")
+end
+
+Then /^I should see the per_page dropdown with values "(.*?)"$/ do |arg1|
+  page.should have_selector('#per_page-dropdown') do
+    labels = values.split(", ")
+    labels.each do |label|
+      with_tag('li', label)
+    end
+  end
+end
+
+When /^I show (\d+) per page$/ do |value|
+  within('#per_page-dropdown .css-dropdown ul') do
+    click_link("#{value} per page")
+  end
+end

data/test_support/features/step_definitions/search_steps.rb

@@ -8,17 +8,6 @@ Then /^I should see a selectable list with field choices$/ do
   page.should have_selector("select#search_field")
 end
 
-Then /^I should see a selectable list with per page choices$/ do
-  page.should have_selector("#per_page-dropdown")
-end
-
-
-When /^I show (\d+) per page$/ do |value|
-  page.should have_selector('#per_page-dropdown') do
-    click_link(value)
-  end
-end
-
 Then /^I should see the sort dropdown$/ do
   page.should have_selector("#sort-dropdown")
 end

data/test_support/spec/controllers/catalog_controller_spec.rb

@@ -5,83 +5,6 @@ require 'marc'
 
 describe CatalogController do
   include Devise::TestHelpers
-#=begin
-  # ROUTES and MAPPING
-  describe "Paths Generated by Custom Routes:" do
-    # paths generated by custom routes
-    it "should map {:controller => 'catalog', :action => 'email'} to /catalog/email" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'email').should == '/catalog/email'
-      { :get => "/catalog/email" }.should route_to(:controller => 'catalog', :action => 'email')
-
-    end
-    it "should map {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'sms').should == '/catalog/sms'      
-      { :get => "/catalog/sms" }.should route_to(:controller => 'catalog', :action => 'sms')
-    end
-    it "should map { :controller => 'catalog', :action => 'show', :id => 666 } to /catalog/666" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'show', :id => '666').should == '/catalog/666'
-      { :get => "/catalog/666" }.should route_to(:controller => 'catalog', :action => 'show', :id => "666")
-    end
-    it "should map {:controller => 'catalog', :id => '111', :action => 'librarian_view'} to /catalog/111/librarian_view" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'librarian_view', :id => '111').should == '/catalog/111/librarian_view'
-      { :get => "/catalog/111/librarian_view" }.should route_to(:controller => 'catalog', :action => 'librarian_view', :id => "111")
-    end
-  end
-
-  # parameters generated from routes
-  describe "Parameters Generated from Routes:" do
-    it "should map /catalog/email to {:controller => 'catalog', :action => 'email'}" do
-      # RSpec <1.2.9: params_from(:get, '/catalog/email').should == {:controller => 'catalog', :action => 'email'}
-      { :get => "/catalog/email" }.should route_to(:controller => 'catalog', :action => 'email')
-    end
-    it "should map /catalog/sms to {:controller => 'catalog', :action => 'sms'}" do
-      #RSpec <1.2.9 :params_from(:get, '/catalog/sms').should == {:controller => 'catalog', :action => 'sms'}
-      { :get => "/catalog/sms" }.should route_to(:controller => 'catalog', :action => 'sms')
-    end
-    it "should map /catalog/666 to {:controller => 'catalog', :action => 'show', :id => 666}" do
-      #RSPEC <1.2.9  params_from(:get, '/catalog/666').should == {:controller => 'catalog', :action => 'show', :id => '666'}
-      { :get => "/catalog/666" }.should route_to(:controller => 'catalog', :action => 'show', :id => "666")
-    end
-    it "should map /catalog/111/librarian_view to {:controller => 'catalog', :action => 'librarian_view', :id => 111}" do
-#      params_from(:get, '/catalog/111/librarian_view').should == {:controller => 'catalog', :action => 'librarian_view', :id => '111'}
-      { :get => "/catalog/111/librarian_view" }.should route_to(:controller => 'catalog', :action => 'librarian_view', :id => "111")
-    end
-  end
-
-  describe "catalog_url for SolrDocument", :test => true do
-    it "should route correctly" do
-      { :get => catalog_url(SolrDocument.new(:id => 'asdf')) }.should route_to(:controller => 'catalog', :action => 'show', :id => 'asdf')
-    end
-
-    context "should escape solr document ids" do
-
-      it "should pass-through url-valid ids" do
-        { :get => catalog_url(SolrDocument.new(:id => 'qwerty'))}.should route_to(:controller => 'catalog', :action => 'show', :id => 'qwerty')
-      end
-
-      it "should route url-like ids" do
-        pending "This works if you configure your routing to have very liberal constraints on :id.. not sure how to go about testing it though"
-        { :get => catalog_url(SolrDocument.new(:id => 'http://example.com'))}.should route_to(:controller => 'catalog', :action => 'show', :id => 'http://example.com')
-      end
-
-      it "should route ids with whitespace" do
-        { :get => catalog_url(SolrDocument.new(:id => 'mm 123')) }.should route_to(:controller => 'catalog', :action => 'show', :id => 'mm 123')
-      end
-
-      it "should route ids with a literal '+'" do
-        { :get => catalog_url(SolrDocument.new(:id => 'this+that')) }.should route_to(:controller => 'catalog', :action => 'show', :id => 'this+that')
-      end
-
-      it "should route ids with a literal '/" do
-        pending "This works if you configure your routing to have very liberal constraints on :id.. not sure how to go about testing it though"
-        { :get => catalog_url(SolrDocument.new(:id => 'and/or')) }.should route_to(:controller => 'catalog', :action => 'show', :id => 'and/or')
-      end
-    end
-
-  end
-
-
-
   # INDEX ACTION
   describe "index action" do
     before(:each) do
@@ -452,18 +375,30 @@ describe CatalogController do
       response.should_not be_success
       response.status.should == 404
     end
-    it "should return a status 500 for a bad search" do
+    it "should redirect the user to the root url for a bad search" do
       req = {}
       res = {}
       fake_error = RSolr::Error::Http.new(req, res) 
       controller.stub(:get_search_results) { |*args| raise fake_error }
       controller.logger.should_receive(:error).with(fake_error)
       get :index, :q=>"+"
+
       response.redirect_url.should == root_url
       request.flash[:notice].should == "Sorry, I don't understand your search."
       response.should_not be_success
-      response.status.should == 500
-      response.should render_template(:file=>"#{Rails.root}/public/500.html")
+      response.status.should == 302
+    end
+    it "should return status 500 if the catalog path is raising an exception" do
+
+      req = {}
+      res = {}
+      fake_error = RSolr::Error::Http.new(req, res) 
+      controller.stub(:get_search_results) { |*args| raise fake_error }
+      controller.flash.stub!(:sweep)
+      controller.stub(:flash).and_return(:notice => I18n.t('blacklight.search.errors.request_error'))
+      expect {
+      get :index, :q=>"+"
+      }.to raise_error 
     end
 
   end

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -146,35 +146,88 @@ describe BlacklightHelper do
     end
   end
 
-  describe "search_as_hidden_fields", :asdf => true do
+  describe "params_for_search" do
     def params
-      {:q => "query", :sort => "sort", :per_page => "20", :search_field => "search_field", :page => 100, :arbitrary_key => "arbitrary_value", :f => {"field" => ["value1", "value2"], "other_field" => ['asdf']}, :controller => "catalog", :action => "index", :commit => "search"}
+      { 'default' => 'params'}
     end
-    describe "for default arguments" do
-      it "should default to omitting :page" do
-        search_as_hidden_fields.should have_selector("input[type='hidden']", :count =>8)
-        search_as_hidden_fields.should_not have_selector("input[name='page']")
+
+    it "should default to using the controller's params" do
+      result = params_for_search
+      result.should == params
+      params.object_id.should_not == result.object_id
+    end
+
+    it "should let you pass in params to use" do
+      source_params = { :q => 'query'}
+      result = params_for_search(:params => source_params )
+      source_params.should == result
+      source_params.object_id.should_not == result.object_id
+    end
+
+    it "should not return blacklisted elements" do
+      source_params = { :action => 'action', :controller => 'controller', :commit => 'commit'}
+      result = params_for_search(:params => source_params )
+      result.keys.should_not include(:action, :controller, :commit)
+
+    end
+
+    it "should adjust the current page if the per_page changes" do
+      source_params = { :per_page => 20, :page => 5}
+      result = params_for_search(:params => source_params, :per_page => 100)
+      result[:page].should == 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(:params => source_params, :per_page => 20)
+      result[:page].should == 5
+    end
+
+    it "should adjust the current page if the sort changes" do
+      source_params = { :sort => 'field_a', :page => 5}
+      result = params_for_search(:params => source_params, :sort => 'field_b')
+      result[:page].should == 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(:params => source_params, :sort => 'field_a')
+      result[:page].should == 5
+    end
+
+    describe "omit keys parameter" do
+      it "should omit keys by key name" do
+        source_params = { :a => 1, :b => 2, :c => 3}
+        result = params_for_search(:params => source_params, :omit_keys => [:a, :b] )
+
+        result.keys.should_not include(:a, :b)
+        result[:c].should == 3
       end
-      it "should not return blacklisted elements" do
-        search_as_hidden_fields.should_not have_selector("input[name='action']")
-        search_as_hidden_fields.should_not have_selector("input[name='controller']")
-        search_as_hidden_fields.should_not have_selector("input[name='commit']")
+
+      it "should remove keys if a key/value pair was passed and no values are left for that key" do
+        source_params = { :f => ['a']}
+        result = params_for_search(:params => source_params, :omit_keys => [{:f => 'a' }])
+        result.keys.should_not include(:f)
       end
-      describe "for omit_keys parameter" do
-        it "should not include those keys" do
-           generated = search_as_hidden_fields(:omit_keys => [:per_page, :sort])
 
-           generated.should_not have_selector("input[name=sort]")
-           generated.should_not have_selector("input[name=per_page]")
+      it "should only remove keys when a key/value pair is based that are in that pair" do
 
-           generated.should have_selector("input[name=page]")
-        end
+        source_params = { :f => ['a', 'b']}
+        result = params_for_search(:params => source_params, :omit_keys => [{:f => 'a' }])
+        result[:f].should_not include('a')
+        result[:f].should include('b')
+      end
+    end
 
-        it "should support hash-based deleting" do
-           generated = search_as_hidden_fields(:omit_keys => [{:f => 'field' }])
-           generated.should have_selector("input[name='f[other_field][]']")
-           generated.should_not have_selector("input[name='f[field][]']")
-        end
+  end
+
+  describe "search_as_hidden_fields" do
+    def params
+      {:q => "query", :sort => "sort", :per_page => "20", :search_field => "search_field", :page => 100, :arbitrary_key => "arbitrary_value", :f => {"field" => ["value1", "value2"], "other_field" => ['asdf']}, :controller => "catalog", :action => "index", :commit => "search"}
+    end
+    describe "for default arguments" do
+      it "should default to omitting :page" do
+        search_as_hidden_fields.should_not have_selector("input[name='page']")
       end
     end
  end

data/test_support/spec/helpers/catalog_helper_spec.rb

@@ -6,7 +6,7 @@ describe CatalogHelper do
 
   def mock_response args
     current_page = args[:current_page] || 1
-    per_page = args[:per_page] || 10
+    per_page = args[:rows] || args[:per_page] || 10
     total = args[:total]
     start = (current_page - 1) * per_page
 
@@ -78,6 +78,13 @@ describe CatalogHelper do
       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.should == "<strong>21</strong> - <strong>40</strong> of <strong>47</strong>"
+      html.html_safe?.should == true
+    end
 
   end
 end

data/test_support/spec/helpers/html_head_helper_spec.rb

@@ -13,10 +13,15 @@ describe HtmlHeadHelper do
     it "should include script tags specified in controller#javascript_includes" do
       html = helper.render_js_includes
 
-      if use_asset_pipeline?
+      if Rails::VERSION::MAJOR == 4 
+        html.should have_selector("script[src='/javascripts/some_js.js']")
+        html.should have_selector("script[src='/javascripts/other_js.js']")      
+      elsif use_asset_pipeline?
+        # only for rails 3 with asset pipeline enabled
         html.should have_selector("script[src='/assets/some_js.js'][type='text/javascript']")
         html.should have_selector("script[src='/assets/other_js.js'][type='text/javascript']")
       else
+        # rails 3 with asset pipeline disabled
         html.should have_selector("script[src='/javascripts/some_js.js'][type='text/javascript']")
         html.should have_selector("script[src='/javascripts/other_js.js'][type='text/javascript']")      
       end
@@ -37,7 +42,10 @@ describe HtmlHeadHelper do
     it "should render stylesheets specified in controller #stylesheet_links" do
       html = helper.render_stylesheet_includes      
 
-      if use_asset_pipeline?
+      if Rails::VERSION::MAJOR == 4 
+        html.should have_selector("link[href='/stylesheets/my_stylesheet.css'][rel='stylesheet']")
+        html.should have_selector("link[href='/stylesheets/other_stylesheet.css'][rel='stylesheet']")
+      elsif use_asset_pipeline?
         html.should have_selector("link[href='/assets/my_stylesheet.css'][rel='stylesheet'][type='text/css']")
         html.should have_selector("link[href='/assets/other_stylesheet.css'][rel='stylesheet'][type='text/css']")
       else
@@ -98,12 +106,18 @@ describe HtmlHeadHelper do
         @output.should have_selector("link[rel=rel][type=type][href=href]")
       end
       it "should include render_javascript_includes" do
-        @output.should have_selector("script[src='/assets/my_js.js'][type='text/javascript']")
-        #@output.index( render_js_includes ).should_not be_nil
+        if Rails::VERSION::MAJOR == 4 
+          @output.should have_selector("script[src='/javascripts/my_js.js']")
+        else
+          @output.should have_selector("script[src='/assets/my_js.js'][type='text/javascript']")
+        end
       end
       it "should include render_stylesheet_links" do
-        @output.should have_selector("link[href='/assets/my_css.css'][type='text/css']")
-        #@output.index( render_stylesheet_includes ).should_not be_nil
+        if Rails::VERSION::MAJOR == 4 
+          @output.should have_selector("link[href='/stylesheets/my_css.css']")
+        else
+          @output.should have_selector("link[href='/assets/my_css.css'][type='text/css']")
+        end
       end
       it "should include content_for :head" do
         @output.should have_selector("meta[keywords]")
@@ -121,7 +135,7 @@ describe HtmlHeadHelper do
 
   private
   def use_asset_pipeline?
-    (Rails::VERSION::MAJOR >= 3 and Rails::VERSION::MINOR >= 1) and Rails.application.config.assets.enabled
+    Rails::VERSION::MAJOR == 4 || ((Rails::VERSION::MAJOR == 3 and Rails::VERSION::MINOR >= 1) and Rails.application.config.assets.enabled)
   end
 
 end

data/test_support/spec/lib/blacklight_configurable_spec.rb

@@ -69,6 +69,18 @@ describe "Blacklight::Configurable" do
       
       klass.blacklight_config.my_key.should == 'value'
     end
+
+    it "allows the instance to set a radically different config from the class" do
+      klass = Class.new
+      klass.send(:include, Blacklight::Configurable)
+      klass.blacklight_config.foo = "bar"
+
+      instance = klass.new
+      instance.blacklight_config = Blacklight::Configuration.new
+      
+      instance.blacklight_config.should_not == klass.blacklight_config
+      instance.blacklight_config.foo.should be_nil
+    end
     
     it "allows instance to set it's own config seperate from class" do
       # this is built into class_attribute; we spec it both to document it,
@@ -77,14 +89,16 @@ describe "Blacklight::Configurable" do
       klass = Class.new
       klass.send(:include, Blacklight::Configurable)
       klass.blacklight_config.foo = "bar"
+      klass.blacklight_config.bar = []
+      klass.blacklight_config.bar << "asd"
       
       instance = klass.new
-      
-      instance.blacklight_config = Blacklight::Configuration.new
-      
+      instance.blacklight_config.bar << "123"
       instance.blacklight_config.should_not == klass.blacklight_config
-      instance.blacklight_config.foo.should be_nil
       klass.blacklight_config.foo.should == "bar"
+      instance.blacklight_config.foo.should == "bar"
+      klass.blacklight_config.bar.should_not include("123")
+      instance.blacklight_config.bar.should include("asd", "123")
     end
 
     it "configurable classes should not mutate the default configuration object" do