blacklight 6.21.0 → 7.0.0

data/spec/spec_helper.rb

@@ -5,14 +5,9 @@
 
 ENV["RAILS_ENV"] ||= 'test'
 
-if ENV["COVERAGE"] or ENV["CI"]
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-  SimpleCov.start do
-    add_filter "/spec/"
-  end
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
 end
 
 require 'rsolr'
@@ -25,18 +20,33 @@ require 'rspec/rails'
 require 'rspec/its'
 require 'rspec/collection_matchers'
 require 'capybara/rspec'
-require 'webdrivers'
+require 'selenium-webdriver'
 require 'equivalent-xml'
 
-Capybara.javascript_driver = :selenium_chrome_headless
+Capybara.javascript_driver = :headless_chrome
+
+Capybara.register_driver :headless_chrome do |app|
+  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
+    chromeOptions: { args: %w[headless disable-gpu no-sandbox] }
+  )
+
+  Capybara::Selenium::Driver.new(app,
+                                 browser: :chrome,
+                                 desired_capabilities: capabilities)
+end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 # Blacklight, again, make sure we're looking in the right place for em.
 # Relative to HERE, NOT to Rails.root, which is off somewhere else.
-Dir[Pathname.new(File.expand_path("../support/**/*.rb", __FILE__))].each {|f| require f}
+Dir[Pathname.new(File.expand_path('support/**/*.rb', __dir__))].each { |f| require f }
 
 RSpec.configure do |config|
+  config.disable_monkey_patching!
+
+  # When we're testing the API, only run the api tests
+  config.filter_run api: true if ENV['BLACKLIGHT_API_TEST']
+
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   config.fixture_path = "#{::Rails.root}/spec/fixtures"
 
@@ -49,6 +59,7 @@ RSpec.configure do |config|
     config.include Devise::Test::ControllerHelpers, type: :controller
   else
     config.include Devise::TestHelpers, type: :controller
+    config.include Devise::TestHelpers, type: :i18n
   end
 
   config.infer_spec_type_from_file_location!
@@ -59,10 +70,6 @@ RSpec.configure do |config|
   config.include(ControllerLevelHelpers, type: :view)
   config.before(:each, type: :view) { initialize_controller_helpers(view) }
 
-  unless Rails.version > '5'
-    config.include BackportTest, type: :controller
-  end
-
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

data/spec/support/features.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # spec/support/features.rb
 
-require File.expand_path("../features/session_helpers.rb", __FILE__)
+require File.expand_path('features/session_helpers.rb', __dir__)
 
 RSpec.configure do |config|
   config.include Features::SessionHelpers, type: :feature

data/spec/support/features/session_helpers.rb

@@ -13,11 +13,11 @@ module Features
 
     def sign_in(login = 'user1')
       email = "#{login}@#{login}.com"
-      user = User.create(:email => email, :password => "password", :password_confirmation => "password")
+      User.create(email: email, password: "password", password_confirmation: "password")
       visit new_user_session_path
-      fill_in("user_email", :with => email) 
-      fill_in("user_password", :with => "password") 
-      
+      fill_in("user_email", with: email)
+      fill_in("user_password", with: "password")
+
       if has_button? "Sign in"
         click_button("Sign in")
       elsif has_button? "Log in"

data/spec/test_app_templates/Gemfile.extra

@@ -1,5 +1,2 @@
-if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^5\./ || ENV['RAILS_VERSION'] == 'edge'
-  gem 'rails-controller-testing'
-  gem 'thor', '~> 0.20'
-  gem 'deprecation'
-end
+gem 'rails-controller-testing'
+gem 'thor', '~> 0.20'

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -2,32 +2,31 @@
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base
-  source_root File.expand_path("../../../../test_app_templates", __FILE__)
+  source_root File.expand_path('../../../test_app_templates', __dir__)
 
-  def fix_travis_rails_4 
-    if ENV['TRAVIS']
-      insert_into_file 'app/assets/stylesheets/application.css', :before =>'/*' do      
-        "@charset \"UTF-8\";\n"
-      end
-    end
-  end
-
-  def remove_index 
+  def remove_index
     remove_file "public/index.html"
   end
 
   def run_blacklight_generator
-    say_status("warning", "GENERATING BL", :yellow)       
+    say_status("warning", "GENERATING BL", :yellow)
 
     Bundler.with_clean_env do
       run "bundle install"
     end
+    options = '--devise'
+    if ENV['BLACKLIGHT_API_TEST']
+      options += ' --skip-assets'
+      inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController' do
+        "  include ActionController::MimeResponds\n" # see https://github.com/projectblacklight/blacklight/issues/1894
+      end
+    end
 
-    generate 'blacklight:install', '--devise --marc --jettywrapper'
+    generate 'blacklight:install', options
   end
 
   def run_test_support_generator
-    say_status("warning", "GENERATING test_support", :yellow)       
+    say_status("warning", "GENERATING test_support", :yellow)
 
     generate 'blacklight:test_support'
   end

data/spec/views/catalog/_constraints.html.erb_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe "catalog/constraints" do
+RSpec.describe "catalog/constraints" do
   let :blacklight_config do
     Blacklight::Configuration.new do |config|
       config.view.xyz
@@ -18,8 +18,7 @@ describe "catalog/constraints" do
     allow(view).to receive_messages(query_has_constraints?: true)
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     render partial: "catalog/constraints"
-    expect(rendered).to have_selector("#startOverLink")
-    expect(rendered).to have_link("Start Over", :href => 'http://xyz')
+    expect(rendered).to have_link("Start Over", href: 'http://xyz')
   end
 
   it "renders a start over link with the current view type" do
@@ -28,8 +27,6 @@ describe "catalog/constraints" do
     params[:view] = 'xyz'
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     render partial: "catalog/constraints"
-    expect(rendered).to have_selector("#startOverLink")
-    expect(rendered).to have_link("Start Over", :href => 'http://xyz?view=xyz')
+    expect(rendered).to have_link("Start Over", href: 'http://xyz?view=xyz')
   end
-
 end

data/spec/views/catalog/_constraints_element.html.erb_spec.rb

@@ -1,26 +1,28 @@
 # frozen_string_literal: true
 
-describe "catalog/_constraints_element.html.erb" do
+RSpec.describe "catalog/_constraints_element.html.erb" do
   describe "for simple display" do
     before do
-      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value"}
+      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value" }
     end
+
     it "renders label and value" do
-      expect(rendered).to have_selector("span.appliedFilter.constraint") do |s|
+      expect(rendered).to have_selector("span.applied-filter.constraint") do |s|
         expect(s).to have_css("span.constraint-value")
-        expect(s).to_not have_css("a.constraint-value")
-        expect(s).to have_selector "span.filterName", :content => "my label"
-        expect(s).to have_selector "span.filterValue", :content => "my value"
+        expect(s).not_to have_css("a.constraint-value")
+        expect(s).to have_selector "span.filter-name", content: "my label"
+        expect(s).to have_selector "span.filter-value", content: "my value"
       end
     end
   end
 
   describe "with remove link" do
     before do
-      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:remove => "http://remove"}}
+      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { remove: "http://remove" } }
     end
+
     it "includes remove link" do
-      expect(rendered).to have_selector("span.appliedFilter") do |s|
+      expect(rendered).to have_selector("span.applied-filter") do |s|
         expect(s).to have_selector(".remove[href='http://remove']")
       end
     end
@@ -33,20 +35,22 @@ describe "catalog/_constraints_element.html.erb" do
 
   describe "with custom classes" do
     before do
-      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:classes => ["class1", "class2"]}}
+      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { classes: %w[class1 class2] } }
     end
+
     it "includes them" do
-      expect(rendered).to have_selector("span.appliedFilter.constraint.class1.class2")
+      expect(rendered).to have_selector("span.applied-filter.constraint.class1.class2")
     end
   end
 
   describe "with no escaping" do
     before do
-      render( :partial => "catalog/constraints_element", :locals => {:label => "<span class='custom_label'>my label</span>".html_safe, :value => "<span class='custom_value'>my value</span>".html_safe} )
+      render(partial: "catalog/constraints_element", locals: { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe })
     end
+
     it "does not escape key and value" do
-      expect(rendered).to have_selector("span.appliedFilter.constraint span.filterName span.custom_label")
-      expect(rendered).to have_selector("span.appliedFilter.constraint span.filterValue span.custom_value")
+      expect(rendered).to have_selector("span.applied-filter.constraint span.filter-name span.custom_label")
+      expect(rendered).to have_selector("span.applied-filter.constraint span.filter-value span.custom_value")
     end
   end
 end

data/spec/views/catalog/_document.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-describe "catalog/_document" do
-  let(:document) { SolrDocument.new :id => 'xyz', :format => 'a' }
+RSpec.describe "catalog/_document" do
+  let(:document) { SolrDocument.new id: 'xyz', format: 'a' }
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
@@ -10,23 +10,23 @@ describe "catalog/_document" do
   end
 
   it "renders the header, thumbnail and index by default" do
-    stub_template "catalog/_index_header_default.html.erb" => "document_header"
-    stub_template "catalog/_thumbnail_default.html.erb" => "thumbnail_default"
+    stub_template "catalog/_index_header.html.erb" => "document_header"
+    stub_template "catalog/_thumbnail.html.erb" => "thumbnail_default"
     stub_template "catalog/_index_default.html.erb" => "index_default"
-    render :partial => "catalog/document", :locals => {:document => document, :document_counter => 1}
+    render partial: "catalog/document", locals: { document: document, document_counter: 1 }
     expect(rendered).to match /document_header/
     expect(rendered).to match /thumbnail_default/
     expect(rendered).to match /index_default/
-    expect(rendered).to have_selector('div.document[@itemscope]')
-    expect(rendered).to have_selector('div.document[@itemtype="http://schema.org/Thing"]')
+    expect(rendered).to have_selector('.document[@itemscope]')
+    expect(rendered).to have_selector('.document[@itemtype="http://schema.org/Thing"]')
   end
 
   it "uses the index.partials parameter to determine the partials to render" do
-    blacklight_config.index.partials = ['a', 'b', 'c']
+    blacklight_config.index.partials = %w[a b c]
     stub_template "catalog/_a_default.html.erb" => "a_partial"
     stub_template "catalog/_b_default.html.erb" => "b_partial"
     stub_template "catalog/_c_default.html.erb" => "c_partial"
-    render :partial => "catalog/document", :locals => {:document => document, :document_counter => 1}
+    render partial: "catalog/document", locals: { document: document, document_counter: 1 }
     expect(rendered).to match /a_partial/
     expect(rendered).to match /b_partial/
     expect(rendered).to match /c_partial/
@@ -35,12 +35,12 @@ describe "catalog/_document" do
   it 'has a css class with the document position' do
     allow(view).to receive(:render_document_partials)
     render partial: 'catalog/document', locals: { document: document, document_counter: 5 }
-    expect(rendered).to have_selector 'div.document-position-5'
+    expect(rendered).to have_selector '.document-position-5'
   end
 
   it 'has a data attribute with the document position' do
     allow(view).to receive(:render_document_partials)
     render partial: 'catalog/document', locals: { document: document, document_counter: 5 }
-    expect(rendered).to have_selector 'div.document[@data-document-counter="5"]'
+    expect(rendered).to have_selector '.document[@data-document-counter="5"]'
   end
 end

data/spec/views/catalog/_document_list.html.erb_spec.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-describe "catalog/_document_list", type: :view do
+RSpec.describe "catalog/_document_list", type: :view do
   before do
     allow(view).to receive_messages(document_index_view_type: "some-view", documents: [])
   end
+
   it "includes a class for the current view" do
     render
     expect(rendered).to have_selector(".documents-some-view")

data/spec/views/catalog/_facet_index_navigation.html.erb_spec.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-describe 'catalog/_facet_index_navigation.html.erb', type: :view do
+RSpec.describe 'catalog/_facet_index_navigation.html.erb', type: :view do
   let(:pagination) { Blacklight::Solr::FacetPaginator.new([]) }
-  let(:facet) { Blacklight::Configuration::FacetField.new({ index_range: '0'..'9' })}
+  let(:facet) { Blacklight::Configuration::FacetField.new(index_range: '0'..'9') }
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
@@ -21,9 +21,9 @@ describe 'catalog/_facet_index_navigation.html.erb', type: :view do
     expect(rendered).to have_link '9'
   end
 
-  it 'renders a "clear filter" button' do
+  it 'renders an "all" button' do
     render
-    expect(rendered).to have_selector '.btn.disabled', text: 'Clear Filter'
+    expect(rendered).to have_selector '.page-link', text: 'All'
   end
 
   context 'with a selected index' do
@@ -35,7 +35,7 @@ describe 'catalog/_facet_index_navigation.html.erb', type: :view do
     end
     it 'enables the clear facets button' do
       render
-      expect(rendered).to have_link 'Clear Filter'
+      expect(rendered).to have_link 'All'
     end
   end
 end

data/spec/views/catalog/_facet_layout.html.erb_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe "catalog/facet_layout" do
+RSpec.describe "catalog/facet_layout" do
   let :blacklight_config do
     Blacklight::Configuration.new do |config|
       config.facet_fields[facet_field.field] = facet_field
@@ -22,19 +22,19 @@ describe "catalog/facet_layout" do
 
   it "has a title with a link for a11y" do
     render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_selector 'h3 a', text: 'Some Field'
+    expect(rendered).to have_selector 'h3', text: 'Some Field'
   end
 
   it "is collapsable" do
     render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to have_selector '.panel-heading.collapsed'
-    expect(rendered).to have_selector '.collapse .panel-body'
+    expect(rendered).to have_selector '.card-header.collapsed'
+    expect(rendered).to have_selector '.collapse.card-body'
   end
 
   it "is configured to be open by default" do
     allow(facet_field).to receive_messages(collapse: false)
     render partial: 'catalog/facet_layout', locals: { facet_field: facet_field }
-    expect(rendered).to_not have_selector '.panel-heading.collapsed'
-    expect(rendered).to have_selector '.in .panel-body'
+    expect(rendered).not_to have_selector '.card-header.collapsed'
+    expect(rendered).to have_selector '.show.card-body'
   end
 end

data/spec/views/catalog/_facets.html.erb_spec.rb

@@ -1,38 +1,36 @@
 # frozen_string_literal: true
 
-describe "catalog/_facets" do
+RSpec.describe "catalog/_facets" do
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
     allow(view).to receive_messages(blacklight_config: blacklight_config)
-    allow(view).to receive(:search_action_path) do |*args|
-      '/catalog'
-    end
+    allow(view).to receive(:search_action_path).and_return('/catalog')
   end
 
   context "without any facet fields" do
     it "does not have a header if no facets are displayed" do
-      allow(view).to receive_messages(:render_facet_partials => '')
+      allow(view).to receive_messages(render_facet_partials: '')
       render
-      expect(rendered).to_not have_selector('h4')
+      expect(rendered).not_to have_selector('h4')
     end
   end
-  context "with facet fields" do
 
+  context "with facet fields" do
     let :facet_field do
       Blacklight::Configuration::FacetField.new(field: 'facet_field_1', label: 'label').normalize!
     end
 
     before do
       blacklight_config.facet_fields['facet_field_1'] = facet_field
-      @mock_display_facet_1 = double(:name => 'facet_field_1', sort: nil, offset: nil, prefix: nil, :items => [Blacklight::Solr::Response::Facets::FacetItem.new(:value => 'Value', :hits => 1234)])
-      allow(view).to receive_messages(:facet_field_names => [:facet_field_1], :facet_limit_for => 10)
-      @response = double()
+      @mock_display_facet_1 = double(name: 'facet_field_1', sort: nil, offset: nil, prefix: nil, items: [Blacklight::Solr::Response::Facets::FacetItem.new(value: 'Value', hits: 1234)])
+      allow(view).to receive_messages(facet_field_names: [:facet_field_1], facet_limit_for: 10)
+      @response = double
       allow(@response).to receive(:aggregations).and_return("facet_field_1" => @mock_display_facet_1)
     end
 
     it "has a header" do
-      allow(view).to receive_messages(:render_facet_partials => '')
+      allow(view).to receive_messages(render_facet_partials: '')
       render
       expect(rendered).to have_selector('.facets-heading')
     end
@@ -47,7 +45,7 @@ describe "catalog/_facets" do
         # The .facet-content class is used by blacklight_range_limit js, and
         # should be applied to the .panel-collapse div that contains the collapsible
         # facet content. Please make sure it remains if possible.
-        expect(rendered).to have_selector('.facet-content a.facet_select')
+        expect(rendered).to have_selector('.facet-content a.facet-select')
         expect(rendered).to have_selector('.facet-content .facet-count')
       end
     end

data/spec/views/catalog/{_index_default.erb_spec.rb → _index.html.erb_spec.rb}

@@ -2,24 +2,24 @@
 
 # spec for default partial to display solr document fields in catalog INDEX view
 
-describe "/catalog/_index_default.erb" do
+RSpec.describe "/catalog/_index" do
   include BlacklightHelper
   include CatalogHelper
 
-  before(:each) do
+  before do
     allow(view).to receive(:action_name).and_return('index')
     @config = Blacklight::Configuration.new do |config|
       config.show.display_type_field = 'asdf'
-      config.add_index_field 'one_field', :label => 'One:'
-      config.add_index_field 'empty_field', :label => 'Three:'
-      config.add_index_field 'four_field', :label => 'Four:'
+      config.add_index_field 'one_field', label: 'One:'
+      config.add_index_field 'empty_field', label: 'Three:'
+      config.add_index_field 'four_field', label: 'Four:'
     end
 
     @fname_1 = "one_field"
     @fname_2 = "solr_field_not_in_config"
     @fname_3 = "empty_field"
     @fname_4 = "four_field"
-    
+
     @document = SolrDocument.new(id: 1, @fname_1 => "val_1", @fname_2 => "val2", @fname_4 => "val_4")
 
     @flabel_1 = "One:"
@@ -32,12 +32,12 @@ describe "/catalog/_index_default.erb" do
   end
 
   it "only displays fields listed in the initializer" do
-    expect(@rendered).to_not include("val_2")
-    expect(@rendered).to_not include(@fname_2)
+    expect(@rendered).not_to include("val_2")
+    expect(@rendered).not_to include(@fname_2)
   end
 
   it "skips over fields listed in initializer that are not in solr response" do
-    expect(@rendered).to_not include(@fname_3)
+    expect(@rendered).not_to include(@fname_3)
   end
 
   it "displays field labels from initializer and raw solr field names in the class" do
@@ -49,15 +49,14 @@ describe "/catalog/_index_default.erb" do
     expect(@rendered).to include("blacklight-#{@fname_4}")
   end
 
-# this test probably belongs in a Cucumber feature
-#  it "should display fields in the order listed in the initializer" do
-#    pending
-#  end
+  # this test probably belongs in a Cucumber feature
+  #  it "should display fields in the order listed in the initializer" do
+  #    pending
+  #  end
 
   it "has values for displayed fields" do
     expect(@rendered).to include("val_1")
     expect(@rendered).to include("val_4")
-    expect(@rendered).to_not include("val_2")
+    expect(@rendered).not_to include("val_2")
   end
-
 end