blacklight 7.19.2 → 7.21.1

data/spec/features/facet_missing_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+RSpec.describe "Facet missing" do
+  before do
+    CatalogController.blacklight_config[:default_solr_params]["facet.missing"] = true
+  end
+
+  after do
+    CatalogController.blacklight_config[:default_solr_params].delete("facet.missing")
+  end
+
+  context "selecting missing field in facets" do
+    it "adds facet missing query and constraints" do
+      visit root_path
+
+      within "#facet-subject_geo_ssim" do
+        click_link "[Missing]"
+      end
+
+      within "#facet-subject_geo_ssim" do
+        expect(page).to have_selector("span.selected", text: "[Missing")
+        expect(page).to have_selector("span.facet-count.selected", text: "13")
+      end
+
+      within "#sortAndPerPage" do
+        expect(page).to have_content "1 - 10 of 13"
+      end
+
+      expect(page).to have_css(".constraint-value", text: "Region")
+      expect(page).to have_css(".constraint-value", text: "[Missing]")
+    end
+  end
+
+  context "unselecting the facet missing facet" do
+    it "unselects the missing field facet" do
+      visit root_path
+
+      within "#facet-subject_geo_ssim" do
+        click_link "[Missing]"
+      end
+
+      within "#facet-subject_geo_ssim" do
+        click_link "remove"
+      end
+
+      expect(page).not_to have_link "remove"
+      expect(page).to have_content("Welcome!")
+    end
+  end
+
+  context "unselecting the facet missing constraint" do
+    it "unselects the missing field facet" do
+      visit root_path
+
+      within "#facet-subject_geo_ssim" do
+        click_link "[Missing]"
+      end
+
+      within ".filter-subject_geo_ssim" do
+        click_link "Remove constraint Region: [Missing]"
+      end
+
+      expect(page).not_to have_link "remove"
+      expect(page).to have_content("Welcome!")
+    end
+  end
+end

data/spec/features/facets_spec.rb

@@ -69,7 +69,7 @@ RSpec.describe "Facets" do
     page.find('h3.facet-field-heading button', text: 'Pivot Field').click
 
     within '#facet-example_pivot_field' do
-      expect(page).to have_css('.facet-leaf-node', text: "Book\t30")
+      expect(page).to have_css('.facet-leaf-node', text: "Book 30")
       expect(page).not_to have_css('.facet-select', text: 'Tibetan')
       page.find('.facet-toggle-handle').click
       click_link 'Tibetan'

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -314,7 +314,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
     end
 
     describe "simple case" do
-      let(:expected_html) { '<span class="facet-label"><a class="facet-select" href="/catalog">Z</a></span><span class="facet-count">10</span>' }
+      let(:expected_html) { '<span class="facet-label"><a class="facet-select" rel="nofollow" href="/catalog">Z</a></span><span class="facet-count">10</span>' }
 
       it "uses facet_display_value" do
         result = helper.render_facet_value('simple_field', item)
@@ -323,7 +323,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
     end
 
     describe "when :url_method is set" do
-      let(:expected_html) { '<span class="facet-label"><a class="facet-select" href="/blabla">Z</a></span><span class="facet-count">10</span>' }
+      let(:expected_html) { '<span class="facet-label"><a class="facet-select" rel="nofollow" href="/blabla">Z</a></span><span class="facet-count">10</span>' }
 
       it "uses that method" do
         allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: :test_method))

data/spec/lib/blacklight/search_state/filter_field_spec.rb

@@ -159,6 +159,19 @@ RSpec.describe Blacklight::SearchState::FilterField do
         expect(new_state.filter('another_field').values).to eq ['3']
       end
     end
+
+    context "With facet.missing field" do
+      let(:params) do
+        { f: { "-some_field": ["[* TO *]"] } }
+      end
+
+      it "removes facet.missing facet params" do
+        filter = search_state.filter("some_field")
+        new_state = filter.remove(OpenStruct.new(key: 'some_field', missing: true))
+
+        expect(new_state.params).to eq({})
+      end
+    end
   end
 
   describe '#values' do

data/spec/models/blacklight/configuration_spec.rb

@@ -543,6 +543,98 @@ RSpec.describe "Blacklight::Configuration", api: true do
     end
   end
 
+  describe "add_sms_field" do
+    it "takes hash form" do
+      config.add_sms_field("title_tsim", label: "Title")
+
+      expect(config.sms_fields["title_tsim"]).not_to be_nil
+      expect(config.sms_fields["title_tsim"].label).to eq "Title"
+    end
+
+    it "takes ShowField argument" do
+      config.add_sms_field("title_tsim", Blacklight::Configuration::SmsField.new(field: "title_display", label: "Title"))
+
+      expect(config.sms_fields["title_tsim"]).not_to be_nil
+      expect(config.sms_fields["title_tsim"].label).to eq "Title"
+    end
+
+    it "takes block form" do
+      config.add_sms_field("title_tsim") do |f|
+        f.label = "Title"
+      end
+
+      expect(config.sms_fields["title_tsim"]).not_to be_nil
+      expect(config.sms_fields["title_tsim"].label).to eq "Title"
+    end
+
+    it "creates default label humanized from field" do
+      config.add_sms_field("my_custom_field")
+
+      expect(config.sms_fields["my_custom_field"].label).to eq "My Custom Field"
+    end
+
+    it "raises on nil solr field name" do
+      expect { config.add_sms_field(nil) }.to raise_error ArgumentError
+    end
+
+    it "takes wild-carded field names and dereference them to solr fields" do
+      allow(config).to receive(:reflected_fields).and_return(
+        "some_field_display" => {},
+        "another_field_display" => {},
+        "a_facet_field" => {}
+      )
+      config.add_sms_field "*_display"
+
+      expect(config.sms_fields.keys).to eq %w[some_field_display another_field_display]
+    end
+  end
+
+  describe "add_email_field" do
+    it "takes hash form" do
+      config.add_email_field("title_tsim", label: "Title")
+
+      expect(config.email_fields["title_tsim"]).not_to be_nil
+      expect(config.email_fields["title_tsim"].label).to eq "Title"
+    end
+
+    it "takes ShowField argument" do
+      config.add_email_field("title_tsim", Blacklight::Configuration::EmailField.new(field: "title_display", label: "Title"))
+
+      expect(config.email_fields["title_tsim"]).not_to be_nil
+      expect(config.email_fields["title_tsim"].label).to eq "Title"
+    end
+
+    it "takes block form" do
+      config.add_email_field("title_tsim") do |f|
+        f.label = "Title"
+      end
+
+      expect(config.email_fields["title_tsim"]).not_to be_nil
+      expect(config.email_fields["title_tsim"].label).to eq "Title"
+    end
+
+    it "creates default label humanized from field" do
+      config.add_email_field("my_custom_field")
+
+      expect(config.email_fields["my_custom_field"].label).to eq "My Custom Field"
+    end
+
+    it "raises on nil solr field name" do
+      expect { config.add_email_field(nil) }.to raise_error ArgumentError
+    end
+
+    it "takes wild-carded field names and dereference them to solr fields" do
+      allow(config).to receive(:reflected_fields).and_return(
+        "some_field_display" => {},
+        "another_field_display" => {},
+        "a_facet_field" => {}
+      )
+      config.add_email_field "*_display"
+
+      expect(config.email_fields.keys).to eq %w[some_field_display another_field_display]
+    end
+  end
+
   describe "#default_search_field" do
     it "uses the field with a :default key" do
       config.add_search_field('search_field_1')

data/spec/models/blacklight/document/email_spec.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe "Blacklight::Document::Email" do
+  let(:config) do
+    Blacklight::Configuration.new
+  end
+
   before(:all) do
     SolrDocument.use_extension(Blacklight::Document::Email)
   end
@@ -22,4 +26,32 @@ RSpec.describe "Blacklight::Document::Email" do
     doc = SolrDocument.new(id: "1234")
     expect(doc.to_email_text).to be_nil
   end
+
+  context "we pass in configuration with email fields set" do
+    it "uses the email fields for to_email_text" do
+      config.add_email_field("foo", label: "Foo:")
+      config.add_email_field("bar", label: "Bar:")
+      doc = SolrDocument.new(id: "1234", foo: ["Fuzz Fuzz", "Fizz Fizz"], bar: ["Buzz Buzz", "Bizz Bizz"])
+
+      expect(doc.to_email_text(config)).to eq("Foo: Fuzz Fuzz Fizz Fizz\nBar: Buzz Buzz Bizz Bizz")
+    end
+  end
+
+  context "we pass in configuration with email fields no set" do
+    it "falls back on default semantics setup" do
+      doc = SolrDocument.new(id: "1234", title_tsim: ["My Title", "My Alt. Title"])
+      email_body = doc.to_email_text(config)
+      expect(email_body).to match(/Title: My Title/)
+    end
+  end
+
+  context "document field is single valued" do
+    it "handles the single value field correctly" do
+      config.add_email_field("foo", label: "Foo:")
+      config.add_email_field("bar", label: "Bar:")
+      doc = SolrDocument.new(id: "1234", foo: "Fuzz Fuzz", bar: ["Buzz Buzz", "Bizz Bizz"])
+
+      expect(doc.to_email_text(config)).to eq("Foo: Fuzz Fuzz\nBar: Buzz Buzz Bizz Bizz")
+    end
+  end
 end

data/spec/models/blacklight/document/sms_spec.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe "Blacklight::Document::Email" do
+  let(:config) do
+    Blacklight::Configuration.new
+  end
+
   before(:all) do
     SolrDocument.use_extension(Blacklight::Document::Sms)
   end
@@ -22,4 +26,33 @@ RSpec.describe "Blacklight::Document::Email" do
     doc = SolrDocument.new(id: "1234")
     expect(doc.to_sms_text).to be_nil
   end
+
+  context "we pass in configuration with sms fields set" do
+    it "uses the sms fields for to_sms_text" do
+      config.add_sms_field("foo", label: "Foo:")
+      config.add_sms_field("bar", label: " by")
+      doc = SolrDocument.new(id: "1234", foo: ["Fuzz Fuzz", "Fizz Fizz"], bar: ["Buzz Buzz", "Bizz Bizz"])
+
+      expect(doc.to_sms_text(config)).to eq("Foo: Fuzz Fuzz by Buzz Buzz")
+    end
+  end
+
+  context "we pass in configuration with sms fields no set" do
+    it "falls back on default semantics setup" do
+      doc = SolrDocument.new(id: "1234", title_tsim: ["My Title", "My Alt. Title"])
+      sms_text = doc.to_sms_text(config)
+      expect(sms_text).to match(/My Title/)
+      expect(sms_text).not_to match(/My Alt\. Title/)
+    end
+  end
+
+  context "document field is single valued" do
+    it "handles the single value field correctly" do
+      config.add_sms_field("foo", label: "Foo:")
+      config.add_sms_field("bar", label: " by")
+      doc = SolrDocument.new(id: "1234", foo: "Fuzz Fuzz", bar: ["Buzz Buzz", "Bizz Bizz"])
+
+      expect(doc.to_sms_text(config)).to eq("Foo: Fuzz Fuzz by Buzz Buzz")
+    end
+  end
 end

data/spec/models/blacklight/solr/response/facets_spec.rb

@@ -155,7 +155,7 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
     end
 
     it "marks the facet.missing field with a human-readable label and fq" do
-      missing = subject.aggregations["some_field"].items.find { |i| i.value.nil? }
+      missing = subject.aggregations["some_field"].items.find(&:missing)
 
       expect(missing.label).to eq "[Missing]"
       expect(missing.fq).to eq "-some_field:[* TO *]"

data/spec/models/blacklight/solr/response/group_response_spec.rb

@@ -69,8 +69,9 @@ RSpec.describe Blacklight::Solr::Response::GroupResponse, api: true do
     it "accesses a custom field grouped i18n key" do
       allow(I18n).to receive(:t).with(
         'blacklight.entry_name.grouped.result_group_ssi',
-        default: :'blacklight.entry_name.grouped.default'
-      ).and_return('cool group')
+        default: :'blacklight.entry_name.grouped.default',
+        count: 2
+      ).and_return('cool groups')
       expect(group.entry_name(count: 2)).to eq 'cool groups'
     end
 

data/spec/models/record_mailer_spec.rb

@@ -1,17 +1,24 @@
 # frozen_string_literal: true
 
 RSpec.describe RecordMailer do
+  let(:config) do
+    Blacklight::Configuration.new
+  end
+
+  let(:document) do
+    SolrDocument.new(id: "123456", format: ["book"], title_tsim: "The horn", language_ssim: "English", author_tsim: "Janetzky, Kurt")
+  end
+
   before do
     allow(described_class).to receive(:default).and_return(from: 'no-reply@projectblacklight.org')
     SolrDocument.use_extension(Blacklight::Document::Email)
     SolrDocument.use_extension(Blacklight::Document::Sms)
-    document = SolrDocument.new(id: "123456", format: ["book"], title_tsim: "The horn", language_ssim: "English", author_tsim: "Janetzky, Kurt")
     @documents = [document]
   end
 
   describe "email" do
     before do
-      details = { to: 'test@test.com', message: "This is my message" }
+      details = { to: 'test@test.com', message: "This is my message", config: config }
       @email = described_class.email_record(@documents, details, host: 'projectblacklight.org', protocol: 'https')
     end
 
@@ -42,6 +49,27 @@ RSpec.describe RecordMailer do
       @https_email = described_class.email_record(@documents, details, host: 'projectblacklight.org', protocol: 'https')
       expect(@https_email.body).to match %r{https://projectblacklight.org/}
     end
+
+    context "email title_field is configured and multi valued" do
+      let(:document) { SolrDocument.new(id: "123456", foo: ["Fizz Fizz", "Fuzz Fuzz"], format: ["book"], title_tsim: "The horn", language_ssim: "English", author_tsim: "Janetzky, Kurt") }
+
+      it "uses configured email title_field" do
+        config.email.title_field = "foo"
+        expect(@email.subject).to match("Fizz Fizz")
+        expect(@email.subject).not_to match("Fuzz Fuzz")
+        expect(@email.subject).not_to match("The horn")
+      end
+    end
+
+    context "email title_field is configured and single valued" do
+      let(:document) { SolrDocument.new(id: "123456", foo: "Fizz Fizz", format: ["book"], title_tsim: "The horn", language_ssim: "English", author_tsim: "Janetzky, Kurt") }
+
+      it "uses configured email title_field" do
+        config.email.title_field = "foo"
+        expect(@email.subject).to match("Fizz Fizz")
+        expect(@email.subject).not_to match("The horn")
+      end
+    end
   end
 
   describe "SMS" do

data/spec/spec_helper.rb

@@ -10,27 +10,33 @@ SimpleCov.start do
   add_filter "/spec/"
 end
 
-require 'rsolr'
-require 'blacklight'
-
 require 'engine_cart'
 EngineCart.load_application!
 
 require 'rspec/rails'
 require 'rspec/its'
 require 'rspec/collection_matchers'
-require 'capybara/rspec'
-require 'capybara/apparition'
+require 'capybara/rails'
+require 'webdrivers'
+require 'selenium-webdriver'
 require 'equivalent-xml'
+require 'axe-rspec'
+
+require 'rsolr'
+require 'blacklight'
 
-Capybara.javascript_driver = :apparition
-Capybara.disable_animation = true
-# Capybara.enable_aria_label = true
+Capybara.javascript_driver = :headless_chrome
 
-# Uncomment for a headed browser
-# Capybara.register_driver :apparition do |app|
-#   Capybara::Apparition::Driver.new(app, headless: false)
-# end
+Capybara.register_driver :headless_chrome do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.args << '--headless'
+    opts.args << '--disable-gpu'
+    opts.args << '--no-sandbox'
+    opts.args << '--window-size=1280,1696'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

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

@@ -17,9 +17,6 @@ class TestAppGenerator < Rails::Generators::Base
     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', options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.19.2
+  version: 7.21.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,10 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -127,16 +127,16 @@ dependencies:
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: '2.42'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: '2.42'
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +199,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: axe-core-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +228,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: apparition
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -350,6 +378,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".babelrc"
 - ".docker/app/Dockerfile"
 - ".docker/app/entrypoint.sh"
 - ".env"
@@ -762,8 +791,10 @@ files:
 - spec/features/advanced_search_spec.rb
 - spec/features/alternate_controller_spec.rb
 - spec/features/autocomplete_spec.rb
+- spec/features/axe_spec.rb
 - spec/features/bookmarks_spec.rb
 - spec/features/did_you_mean_spec.rb
+- spec/features/facet_missing_spec.rb
 - spec/features/facets_spec.rb
 - spec/features/record_view_spec.rb
 - spec/features/search_context_spec.rb
@@ -888,7 +919,7 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -903,8 +934,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.
@@ -934,8 +965,10 @@ test_files:
 - spec/features/advanced_search_spec.rb
 - spec/features/alternate_controller_spec.rb
 - spec/features/autocomplete_spec.rb
+- spec/features/axe_spec.rb
 - spec/features/bookmarks_spec.rb
 - spec/features/did_you_mean_spec.rb
+- spec/features/facet_missing_spec.rb
 - spec/features/facets_spec.rb
 - spec/features/record_view_spec.rb
 - spec/features/search_context_spec.rb