blacklight 9.0.0.beta1 → 9.0.0.beta3

data/spec/features/facets_spec.rb

@@ -99,7 +99,7 @@ RSpec.describe "Facets" do
     end
   end
 
-  describe 'Facet modal' do
+  describe 'Facet modal content' do
     it 'allows the user to filter a long list of facet values', :js do
       visit '/catalog/facet/subject_ssim'
       expect(page).to have_no_link 'Old age' # This is on the second page of facet values
@@ -107,6 +107,7 @@ RSpec.describe "Facets" do
 
       fill_in 'facet_suggest_subject_ssim', with: "ag"
 
+      expect(page).to have_css '.facet-suggestions'
       expect(page).to have_link 'Old age'
       expect(page).to have_css 'a.facet-select', count: 2
     end
@@ -115,19 +116,81 @@ RSpec.describe "Facets" do
       visit '/catalog/facet/subject_ssim?q=tibet&search_field=all_fields'
       fill_in 'facet_suggest_subject_ssim', with: 'la'
 
+      expect(page).to have_css '.facet-suggestions'
       expect(page).to have_link 'Tibetan language'
+      expect(page).to have_no_link 'Law'
       expect(page).to have_css 'a.facet-select', count: 1
     end
 
-    it 'allows the user to filter more than once', :js do
+    it 'allows the user to toggle the sort, then filter', :js do
       visit '/catalog/facet/subject_ssim'
-      expect(page).to have_no_link 'Old age' # This is on the second page of facet values
-      expect(page).to have_css 'a.facet-select', count: 20
 
-      fill_in 'facet_suggest_subject_ssim', with: "ag"
+      fill_in 'facet_suggest_subject_ssim', with: 'po'
 
-      expect(page).to have_link 'Old age'
-      expect(page).to have_link('Old age', href: '/?f%5Bsubject_ssim%5D%5B%5D=Old+age')
+      expect(page).to have_css '.facet-suggestions'
+      expect(page).to have_css('.facet-values li:nth-child(1)', text: 'Political plays, Japanese')
+      expect(page).to have_css('.facet-values li:nth-child(2)', text: 'Military weapons')
+      expect(page).to have_css('.facet-values li:nth-child(3)', text: 'Political science')
+
+      first(:link, 'A-Z Sort').click
+
+      expect(page).to have_css('.facet-suggest[data-facet-search-context*="facet.sort=index"]')
+
+      fill_in 'facet_suggest_subject_ssim', with: 'po'
+
+      expect(page).to have_css '.facet-suggestions'
+      expect(page).to have_css('.facet-values li:nth-child(1)', text: 'Military weapons')
+      expect(page).to have_css('.facet-values li:nth-child(2)', text: 'Political plays, Japanese')
+      expect(page).to have_css('.facet-values li:nth-child(3)', text: 'Political science')
+    end
+
+    it 'allows the user to choose a starting letter, then filter', :js do
+      visit '/catalog/facet/subject_ssim'
+
+      first(:link, 'A-Z Sort').click
+      expect(page).to have_css('.facet-suggest[data-facet-search-context*="facet.sort=index"]')
+
+      click_on 'M'
+      expect(page).to have_css('.facet-suggest[data-facet-search-context*="facet.prefix=M"]')
+
+      fill_in 'facet_suggest_subject_ssim', with: 'te'
+
+      expect(page).to have_css '.facet-suggestions'
+      expect(page).to have_link 'Maternity insurance'
+      expect(page).to have_no_link 'Teaching'
+    end
+
+    it 'hides previous/next links when filtering', :js do
+      visit '/catalog/facet/subject_ssim'
+      expect(page).to have_link 'Next »'
+
+      fill_in 'facet_suggest_subject_ssim', with: 'te'
+      expect(page).to have_css '.facet-suggestions'
+      expect(page).to have_no_link 'Next »'
+
+      fill_in 'facet_suggest_subject_ssim', with: ''
+      expect(page).to have_no_css '.facet-suggestions'
+      expect(page).to have_link 'Next »'
+    end
+
+    context 'when facet is configured with suggest: false' do
+      before do
+        enabled = CatalogController.blacklight_config.dup
+        enabled.facet_fields[:subject_ssim].merge!({ suggest: false })
+        allow(CatalogController).to receive(:blacklight_config).and_return enabled
+      end
+
+      it 'does not offer the user a way to filter the list of facet values' do
+        visit '/catalog/facet/subject_ssim'
+        expect(page).to have_no_field 'facet_suggest_subject_ssim'
+      end
+    end
+  end
+
+  describe 'facebook-style facet parameters' do
+    it 'can perform a search' do
+      visit '/?f[subject_ssim][0]=Iran.+Viza%CC%84rat-i+Kishvar'
+      expect(page).to have_text 'Naqdī barā-yi tamām-i fuṣūl'
     end
   end
 end

data/spec/features/modal_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe 'Modal' do
     expect(page).to have_no_selector 'dialog#blacklight-modal'
     click_on 'Email'
     expect(page).to have_css 'dialog#blacklight-modal'
-    click_on '×'
+    find('button[aria-label=Close]').click
     expect(page).to have_no_selector 'dialog#blacklight-modal'
   end
 end

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -26,4 +26,14 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
       expect(presenter).to be_a SomePresenter
     end
   end
+
+  describe "#search_facet_path" do
+    before do
+      params[:controller] = 'catalog'
+    end
+
+    it "is the same as the catalog path" do
+      expect(helper.search_facet_path(id: "some_facet", page: 5)).to eq facet_catalog_path(id: "some_facet")
+    end
+  end
 end

data/spec/lib/blacklight/configuration/facet_field_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Blacklight::Configuration::FacetField do
       subject.normalize!
 
       expect(subject.presenter).to eq Blacklight::FacetFieldPresenter
-      expect(subject.component).to eq Blacklight::FacetFieldListComponent
+      expect(subject.component).to eq Blacklight::Facets::ListComponent
     end
 
     context 'when component is set to true' do
@@ -34,7 +34,7 @@ RSpec.describe Blacklight::Configuration::FacetField do
       it 'casts to the default component' do
         subject.normalize!
 
-        expect(subject.component).to eq Blacklight::FacetFieldListComponent
+        expect(subject.component).to eq Blacklight::Facets::ListComponent
       end
     end
   end

data/spec/lib/blacklight/parameters_spec.rb

@@ -52,7 +52,7 @@ RSpec.describe Blacklight::Parameters do
     let(:search_state) { Blacklight::SearchState.new(query_params, blacklight_config) }
     let(:blacklight_config) { Blacklight::Configuration.new }
 
-    context 'with facebooks badly mangled query parameters' do
+    context 'with facebook\'s badly mangled query parameters' do
       let(:query_params) do
         ActionController::Parameters.new(
           f: { field: { '0': 'first', '1': 'second' } },
@@ -67,6 +67,17 @@ RSpec.describe Blacklight::Parameters do
       it 'normalizes the facets to the expected format' do
         expect(params.permit_search_params.to_h.with_indifferent_access).to include f: { field: %w[first second] }, f_inclusive: { field: %w[first second] }
       end
+
+      context 'when several fields are configured' do
+        before do
+          blacklight_config.add_facet_field 'other_field'
+          blacklight_config.add_facet_field 'some_other_pivot_field', pivot: %w[abc def]
+        end
+
+        it 'normalizes the facets to the expected format' do
+          expect(params.permit_search_params.to_h.with_indifferent_access).to include f: { field: %w[first second] }, f_inclusive: { field: %w[first second] }
+        end
+      end
     end
 
     context 'with filter_search_state_fields set to false' do

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

@@ -198,4 +198,22 @@ RSpec.describe Blacklight::SearchState::FilterField do
       expect(search_state.filter('some_field').include?(OpenStruct.new(value: '1'))).to be true
     end
   end
+
+  describe '#permitted_params' do
+    context 'with a pivot facet' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.configure do |config|
+          config.add_facet_field 'my_pivot', pivot: %w[format language_ssim]
+        end
+      end
+
+      it 'marks all the pivot fields as permitted' do
+        field = described_class.new blacklight_config.facet_fields['my_pivot'], search_state
+        expect(field.permitted_params).to eq({
+                                               f: { "-format" => [], "-language_ssim" => [], "format" => [], "language_ssim" => [] },
+                                               f_inclusive: { "format" => [], "language_ssim" => [] }
+                                             })
+      end
+    end
+  end
 end

data/spec/models/blacklight/configuration_spec.rb

@@ -1,8 +1,28 @@
 # frozen_string_literal: true
 
-RSpec.describe "Blacklight::Configuration", :api do
+RSpec.describe Blacklight::Configuration, :api do
   let(:config) do
-    Blacklight::Configuration.new
+    described_class.new
+  end
+
+  describe "#repository" do
+    context 'when the class is configured in blacklight.yml' do
+      it "uses the default repository class" do
+        expect(config.repository).to be_a(Blacklight::Solr::Repository)
+      end
+    end
+
+    context 'when the class is set in the configuration' do
+      let(:custom_repository_class) { Class.new(Blacklight::Solr::Repository) }
+
+      before do
+        config.repository_class = custom_repository_class
+      end
+
+      it "uses the custom repository class" do
+        expect(config.repository).to be_a(custom_repository_class)
+      end
+    end
   end
 
   it "supports arbitrary configuration values" do
@@ -17,14 +37,18 @@ RSpec.describe "Blacklight::Configuration", :api do
       expect(config).to be_a Blacklight::OpenStructWithHashAccess
     end
 
-    it "accepts a block for configuration" do
-      config = Blacklight::Configuration.new(a: 1) { |c| c.a = 2 }
+    context 'when passed a block' do
+      let(:config) do
+        described_class.new(a: 1) { |c| c.a = 2 }
+      end
 
-      expect(config.a).to eq 2
+      it "accepts a block for configuration" do
+        expect(config.a).to eq 2
 
-      config.configure { |c| c.a = 3 }
+        config.configure { |c| c.a = 3 }
 
-      expect(config.a).to eq 3
+        expect(config.a).to eq 3
+      end
     end
   end
 
@@ -84,11 +108,11 @@ RSpec.describe "Blacklight::Configuration", :api do
 
   describe "spell_max" do
     it "defaults to 5" do
-      expect(Blacklight::Configuration.new.spell_max).to eq 5
+      expect(config.spell_max).to eq 5
     end
 
     it "accepts config'd value" do
-      expect(Blacklight::Configuration.new(spell_max: 10).spell_max).to eq 10
+      expect(described_class.new(spell_max: 10).spell_max).to eq 10
     end
   end
 
@@ -181,9 +205,9 @@ RSpec.describe "Blacklight::Configuration", :api do
 
   describe "add alternative solr fields" do
     it "lets you define any arbitrary solr field" do
-      Blacklight::Configuration.define_field_access :my_custom_field
+      described_class.define_field_access :my_custom_field
 
-      config = Blacklight::Configuration.new do |config|
+      config = described_class.new do |config|
         config.add_my_custom_field 'qwerty', label: "asdf"
       end
 
@@ -191,9 +215,9 @@ RSpec.describe "Blacklight::Configuration", :api do
     end
 
     it "lets you define a field accessor that uses an existing field-type" do
-      Blacklight::Configuration.define_field_access :my_custom_facet_field, class: Blacklight::Configuration::FacetField
+      described_class.define_field_access :my_custom_facet_field, class: Blacklight::Configuration::FacetField
 
-      config = Blacklight::Configuration.new do |config|
+      config = described_class.new do |config|
         config.add_my_custom_facet_field 'qwerty', label: "asdf"
       end
 
@@ -406,13 +430,13 @@ RSpec.describe "Blacklight::Configuration", :api do
 
   describe "add_search_field" do
     it "accepts hash form" do
-      c = Blacklight::Configuration.new
+      c = described_class.new
       c.add_search_field(key: "my_search_key")
       expect(c.search_fields["my_search_key"]).not_to be_nil
     end
 
     it "accepts two-arg hash form" do
-      c = Blacklight::Configuration.new
+      c = described_class.new
 
       c.add_search_field("my_search_type",
                          key: "my_search_type",
@@ -428,7 +452,7 @@ RSpec.describe "Blacklight::Configuration", :api do
     end
 
     it "accepts block form" do
-      c = Blacklight::Configuration.new
+      c = described_class.new
 
       c.add_search_field("some_field") do |field|
         field.solr_parameters = { qf: "solr_field^10" }
@@ -443,7 +467,7 @@ RSpec.describe "Blacklight::Configuration", :api do
     end
 
     it "accepts SearchField object" do
-      c = Blacklight::Configuration.new
+      c = described_class.new
 
       f = Blacklight::Configuration::SearchField.new(foo: "bar")
 
@@ -481,7 +505,7 @@ RSpec.describe "Blacklight::Configuration", :api do
 
   describe "add_sort_field" do
     it "takes a hash" do
-      c = Blacklight::Configuration.new
+      c = described_class.new
       c.add_sort_field(key: "my_sort_key", sort: "score desc")
       expect(c.sort_fields["my_sort_key"]).not_to be_nil
     end
@@ -692,23 +716,23 @@ RSpec.describe "Blacklight::Configuration", :api do
 
   describe '.default_configuration' do
     it 'adds additional default configuration properties' do
-      Blacklight::Configuration.default_configuration do
-        Blacklight::Configuration.default_values[:a] = '123'
+      described_class.default_configuration do
+        described_class.default_values[:a] = '123'
       end
 
-      Blacklight::Configuration.default_configuration do
-        Blacklight::Configuration.default_values[:b] = 'abc'
+      described_class.default_configuration do
+        described_class.default_values[:b] = 'abc'
       end
 
-      expect(Blacklight::Configuration.default_values[:a]).to eq '123'
-      expect(Blacklight::Configuration.default_values[:b]).to eq 'abc'
+      expect(described_class.default_values[:a]).to eq '123'
+      expect(described_class.default_values[:b]).to eq 'abc'
     ensure
       # reset the default configuration
-      Blacklight::Configuration.default_values.delete(:a)
-      Blacklight::Configuration.default_values.delete(:b)
+      described_class.default_values.delete(:a)
+      described_class.default_values.delete(:b)
 
-      Blacklight::Configuration.default_configuration.delete_at(1)
-      Blacklight::Configuration.default_configuration.delete_at(2)
+      described_class.default_configuration.delete_at(1)
+      described_class.default_configuration.delete_at(2)
     end
   end
 end

data/spec/models/blacklight/facet_search_builder_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::FacetSearchBuilder, :api do
+  subject(:builder) { described_class.new processor_chain, scope }
+
+  let(:processor_chain) { [] }
+  let(:blacklight_config) { Blacklight::Configuration.new }
+  let(:scope) { double blacklight_config: blacklight_config, search_state_class: nil }
+
+  describe "#facet_suggestion_query" do
+    it "is nil if no value is set" do
+      expect(subject.facet_suggestion_query).to be_nil
+    end
+
+    it "sets facet_suggestion_query value" do
+      expect(subject.facet_suggestion_query('antel').facet_suggestion_query).to eq 'antel'
+    end
+  end
+end

data/spec/models/blacklight/search_builder_spec.rb

@@ -125,7 +125,7 @@ RSpec.describe Blacklight::SearchBuilder, :api do
       end
 
       subject.with(a: 1)
-      expect(subject.processed_parameters).to include step_1: 'builder'
+      expect(subject.send(:processed_parameters)).to include step_1: 'builder'
     end
   end
 
@@ -225,16 +225,6 @@ RSpec.describe Blacklight::SearchBuilder, :api do
     end
   end
 
-  describe "#facet_suggestion_query" do
-    it "is nil if no value is set" do
-      expect(subject.facet_suggestion_query).to be_nil
-    end
-
-    it "sets facet_suggestion_query value" do
-      expect(subject.facet_suggestion_query('antel').facet_suggestion_query).to eq 'antel'
-    end
-  end
-
   describe "#search_field" do
     it "uses the requested search field" do
       blacklight_config.add_search_field 'x'

data/spec/models/blacklight/solr/default_filter_query_builder_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::Solr::DefaultFilterQueryBuilder do
+  subject { described_class.new(blacklight_config: blacklight_config) }
+
+  let(:blacklight_config) { CatalogController.blacklight_config.deep_copy }
+
+  describe "#facet_value_to_fq_string" do
+    it "uses the configured field name" do
+      blacklight_config.add_facet_field :facet_key, field: "facet_name"
+      expect(subject.send(:facet_value_to_fq_string, "facet_key", "my value")).to eq "{!term f=facet_name}my value"
+    end
+
+    it "uses the raw handler for strings" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", "my value")).to eq "{!term f=facet_name}my value"
+    end
+
+    it "passes booleans through" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", true)).to eq '{!term f=facet_name}true'
+    end
+
+    it "passes boolean-like strings through" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", "true")).to eq '{!term f=facet_name}true'
+    end
+
+    it "passes integers through" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", 1)).to eq '{!term f=facet_name}1'
+    end
+
+    it "passes integer-like strings through" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", "1")).to eq '{!term f=facet_name}1'
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", -1)).to eq '{!term f=facet_name}-1'
+    end
+
+    it "passes floats through" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", 1.11)).to eq '{!term f=facet_name}1.11'
+    end
+
+    it "passes floats in strings through" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", "1.11")).to eq '{!term f=facet_name}1.11'
+    end
+
+    context 'date handling' do
+      before { allow(blacklight_config.facet_fields).to receive(:[]).with('facet_name').and_return(double(date: true, query: nil, tag: nil, field: 'facet_name')) }
+
+      it "passes date-type fields through" do
+        expect(subject.send(:facet_value_to_fq_string, "facet_name", "2012-01-01")).to eq '{!term f=facet_name}2012-01-01'
+        expect(subject.send(:facet_value_to_fq_string, "facet_name", "2003-04-09T00:00:00Z")).to eq '{!term f=facet_name}2003-04-09T00:00:00Z'
+      end
+
+      it "formats Date objects correctly" do
+        allow(blacklight_config.facet_fields).to receive(:[]).with('facet_name').and_return(double(date: nil, query: nil, tag: nil, field: 'facet_name'))
+        d = DateTime.parse("2003-04-09T00:00:00")
+        expect(subject.send(:facet_value_to_fq_string, "facet_name", d)).to eq '{!term f=facet_name}2003-04-09T00:00:00Z'
+      end
+    end
+
+    it "handles range requests" do
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", 1..5)).to eq "facet_name:[1 TO 5]"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", 1..nil)).to eq "facet_name:[1 TO *]"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", nil..5)).to eq "facet_name:[* TO 5]"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", nil..nil)).to eq "facet_name:[* TO *]"
+    end
+
+    it "adds tag local parameters" do
+      allow(blacklight_config.facet_fields).to receive(:[]).with('facet_name').and_return(double(query: nil, tag: 'asdf', date: nil, field: 'facet_name'))
+
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", true)).to eq "{!term f=facet_name tag=asdf}true"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", "my value")).to eq "{!term f=facet_name tag=asdf}my value"
+    end
+  end
+end

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

@@ -179,10 +179,6 @@ RSpec.describe "Blacklight::Solr::Document", :api do
         # registration in an after, sorry.
       end
 
-      it "registers format" do
-        expect(defined?("Mime::MOCK2")).to be_truthy
-      end
-
       it "registers as alias only" do
         expect(Mime::Type.lookup("application/mock2")).not_to equal Mime::Type.lookup_by_extension("mock2")
       end