blacklight 7.12.0 → 7.14.0

data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb

@@ -14,4 +14,13 @@ RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
       expect(copy.a[:b]).to eq 1
     end
   end
+
+  describe '#<<' do
+    subject { described_class.new(Blacklight::Configuration::Field) }
+
+    it 'includes the key in the hash' do
+      subject << :blah
+      expect(subject.blah).to have_attributes(key: :blah)
+    end
+  end
 end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::SearchState::FilterField do
+  let(:search_state) { Blacklight::SearchState.new(params.with_indifferent_access, blacklight_config, controller) }
+
+  let(:params) { { f: { some_field: %w[1 2], another_field: ['3'] } } }
+  let(:blacklight_config) do
+    Blacklight::Configuration.new.configure do |config|
+      config.add_facet_field 'some_field'
+      config.add_facet_field 'another_field', single: true
+    end
+  end
+  let(:controller) { double }
+
+  describe '#add' do
+    it 'adds the parameter to the filter list' do
+      filter = search_state.filter('some_field')
+      new_state = filter.add('4')
+
+      expect(new_state.filter('some_field').values).to eq %w[1 2 4]
+    end
+
+    it 'creates new parameter as needed' do
+      filter = search_state.filter('unknown_field')
+      new_state = filter.add('4')
+
+      expect(new_state.filter('unknown_field').values).to eq %w[4]
+      expect(new_state.params[:f]).to include(:unknown_field)
+    end
+
+    context 'without any parameters in the url' do
+      let(:params) { {} }
+
+      it 'adds the necessary structure' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add('1')
+
+        expect(new_state.filter('some_field').values).to eq %w[1]
+        expect(new_state.params).to include(:f)
+      end
+    end
+
+    context 'with a single-valued field' do
+      it 'replaces any existing parameter from the filter list' do
+        filter = search_state.filter('another_field')
+        new_state = filter.add('5')
+
+        expect(new_state.filter('another_field').values).to eq %w[5]
+      end
+    end
+
+    context 'with a pivot facet-type item' do
+      it 'includes the pivot facet fqs' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(OpenStruct.new(fq: { some_other_field: '5' }, value: '4'))
+
+        expect(new_state.filter('some_field').values).to eq %w[1 2 4]
+        expect(new_state.filter('some_other_field').values).to eq %w[5]
+      end
+
+      it 'handles field indirection' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(OpenStruct.new(field: 'some_other_field', value: '4'))
+
+        expect(new_state.filter('some_other_field').values).to eq %w[4]
+      end
+
+      it 'handles value indirection' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(OpenStruct.new(value: '4'))
+
+        expect(new_state.filter('some_field').values).to eq %w[1 2 4]
+      end
+    end
+  end
+
+  describe '#remove' do
+    it 'returns a search state without the given filter applied' do
+      filter = search_state.filter('some_field')
+      new_state = filter.remove('1')
+
+      expect(new_state.filter('some_field').values).to eq ['2']
+    end
+
+    it 'removes the whole field if there are no filter left for the field' do
+      filter = search_state.filter('another_field')
+      new_state = filter.remove('3')
+
+      expect(new_state.filter('another_field').values).to eq []
+      expect(new_state.params[:f]).not_to include :another_field
+    end
+
+    it 'removes the filter parameter entirely if there are no filters left' do
+      new_state = search_state.filter('some_field').remove('1')
+      new_state = new_state.filter('some_field').remove('2')
+      new_state = new_state.filter('another_field').remove('3')
+
+      expect(new_state.params).not_to include :f
+    end
+
+    it 'handles value indirection' do
+      filter = search_state.filter('some_field')
+      new_state = filter.remove(OpenStruct.new(value: '1'))
+
+      expect(new_state.filter('some_field').values).to eq ['2']
+    end
+  end
+
+  describe '#values' do
+    it 'returns the currently selected values of the filter' do
+      expect(search_state.filter('some_field').values).to eq %w[1 2]
+    end
+  end
+
+  describe '#include?' do
+    it 'checks whether the value is currently selected' do
+      expect(search_state.filter('some_field').include?('1')).to eq true
+      expect(search_state.filter('some_field').include?('3')).to eq false
+    end
+
+    it 'handles value indirection' do
+      expect(search_state.filter('some_field').include?(OpenStruct.new(value: '1'))).to eq true
+    end
+  end
+end

data/spec/lib/blacklight/search_state_spec.rb

@@ -3,6 +3,8 @@
 RSpec.describe Blacklight::SearchState do
   subject(:search_state) { described_class.new(params, blacklight_config, controller) }
 
+  around { |test| Deprecation.silence(described_class) { test.call } }
+
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
       config.index.title_field = 'title_tsim'
@@ -242,9 +244,9 @@ RSpec.describe Blacklight::SearchState do
       end
 
       it "uses the facet's key in the url" do
-        allow(search_state).to receive(:facet_configuration_for_field).with('some_field').and_return(double(single: true, field: "a_solr_field", key: "some_key"))
+        blacklight_config.add_facet_field 'some_key', single: true, field: "a_solr_field"
 
-        result_params = search_state.add_facet_params('some_field', 'my_value')
+        result_params = search_state.add_facet_params('some_key', 'my_value')
 
         expect(result_params[:f]['some_key']).to have(1).item
         expect(result_params[:f]['some_key'].first).to eq 'my_value'
@@ -284,7 +286,7 @@ RSpec.describe Blacklight::SearchState do
       let(:params) { parameter_class.new f: { 'single_value_facet_field' => 'other_value' } }
 
       it "replaces facets configured as single" do
-        allow(search_state).to receive(:facet_configuration_for_field).with('single_value_facet_field').and_return(double(single: true, key: "single_value_facet_field"))
+        blacklight_config.add_facet_field 'single_value_facet_field', single: true
         result_params = search_state.add_facet_params('single_value_facet_field', 'my_value')
 
         expect(result_params[:f]['single_value_facet_field']).to have(1).item
@@ -415,4 +417,131 @@ RSpec.describe Blacklight::SearchState do
       expect(new_state.to_hash).to eq('a' => 1)
     end
   end
+
+  describe '#page' do
+    context 'with a page' do
+      let(:params) { { 'page' => '3' } }
+
+      it 'is mapped from page' do
+        expect(search_state.page).to eq 3
+      end
+    end
+
+    context 'without a page' do
+      let(:params) { {} }
+
+      it 'is defaults to page 1' do
+        expect(search_state.page).to eq 1
+      end
+
+      context 'with negative numbers or other bad data' do
+        let(:params) { { 'page' => '-3' } }
+
+        it 'is defaults to page 1' do
+          expect(search_state.page).to eq 1
+        end
+      end
+    end
+  end
+
+  describe '#per_page' do
+    context 'with rows' do
+      let(:params) { { rows: '30' } }
+
+      it 'maps from rows' do
+        expect(search_state.per_page).to eq 30
+      end
+    end
+
+    context 'with per_page' do
+      let(:params) { { per_page: '14' } }
+
+      it 'maps from rows' do
+        expect(search_state.per_page).to eq 14
+      end
+    end
+
+    context 'it defaults to the configured value' do
+      let(:params) { {} }
+
+      it 'maps from rows' do
+        expect(search_state.per_page).to eq 10
+      end
+    end
+  end
+
+  describe '#sort_field' do
+    let(:params) { { 'sort' => 'author' } }
+
+    before do
+      blacklight_config.add_sort_field 'relevancy', label: 'relevance'
+      blacklight_config.add_sort_field 'author', label: 'asd'
+    end
+
+    it 'returns the current search field' do
+      expect(search_state.sort_field).to have_attributes(key: 'author')
+    end
+
+    context 'without a search field' do
+      let(:params) { {} }
+
+      it 'returns the current search field' do
+        expect(search_state.sort_field).to have_attributes(key: 'relevancy')
+      end
+    end
+  end
+
+  describe '#search_field' do
+    let(:params) { { 'search_field' => 'author' } }
+
+    before do
+      blacklight_config.add_search_field 'author', label: 'asd'
+    end
+
+    it 'returns the current search field' do
+      expect(search_state.search_field).to have_attributes(key: 'author')
+    end
+  end
+
+  describe '#facet_page' do
+    context 'with a page' do
+      let(:params) { { 'facet.page' => '3' } }
+
+      it 'is mapped from facet.page' do
+        expect(search_state.facet_page).to eq 3
+      end
+    end
+
+    context 'without a page' do
+      let(:params) { {} }
+
+      it 'is defaults to page 1' do
+        expect(search_state.facet_page).to eq 1
+      end
+    end
+
+    context 'with negative numbers or other bad data' do
+      let(:params) { { 'facet.page' => '-3' } }
+
+      it 'is defaults to page 1' do
+        expect(search_state.facet_page).to eq 1
+      end
+    end
+  end
+
+  describe '#facet_sort' do
+    let(:params) { { 'facet.sort' => 'index' } }
+
+    it 'is mapped from facet.sort' do
+      expect(search_state.facet_sort).to eq 'index'
+    end
+  end
+
+  describe '#facet_prefix' do
+    let(:params) { { 'facet.prefix' => 'A' } }
+
+    it 'is mapped from facet.prefix' do
+      expect(search_state.facet_prefix).to eq 'A'
+    end
+  end
 end

data/spec/models/blacklight/configuration_spec.rb

@@ -62,6 +62,14 @@ RSpec.describe "Blacklight::Configuration", api: true do
     end
   end
 
+  describe 'config.index.document_actions' do
+    it 'allows you to use the << operator' do
+      config.index.document_actions << :blah
+      expect(config.index.document_actions.blah).to have_attributes key: :blah
+      expect(config.index.document_actions.blah.name).to eq :blah
+    end
+  end
+
   describe "config.index.respond_to" do
     it "has a list of additional formats for index requests to respond to" do
       config.index.respond_to.xml = true

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

@@ -109,7 +109,7 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
     let(:facet) { { name: "foo", value: "bar", hits: 1 } }
 
     before do
-      response.merge_facet(facet)
+      response.merge_facet(**facet)
     end
 
     context "facet does not already exist" do

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

@@ -186,9 +186,9 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
     end
 
     describe "for request params also passed in as argument" do
-      let(:user_params) { { q: "some query", 'q' => 'another value' } }
+      let(:user_params) { { 'q' => 'another value', q: "some query" } }
 
-      it "onlies have one value for the key 'q' regardless if a symbol or string" do
+      it "only has one value for the key 'q' regardless if a symbol or string" do
         expect(subject[:q]).to eq 'some query'
         expect(subject['q']).to eq 'some query'
       end
@@ -244,6 +244,21 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe 'with a facet with a custom filter query builder' do
+      let(:user_params) { { f: { some: ['value'] } }.with_indifferent_access }
+
+      before do
+        blacklight_config.add_facet_field 'some', filter_query_builder: (lambda do |*_args|
+          ['some:filter', { qq1: 'abc' }]
+        end)
+      end
+
+      it "has proper solr parameters" do
+        expect(subject[:fq]).to include('some:filter')
+        expect(subject[:qq1]).to include('abc')
+      end
+    end
+
     describe "solr parameters for a field search from config (subject)" do
       let(:user_params) { subject_search_params }
 
@@ -384,6 +399,21 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe 'the search field query_builder config' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new do |config|
+          config.add_search_field('built_query', query_builder: ->(builder, *_args) { [builder.blacklight_params[:q].reverse, qq1: 'xyz'] })
+        end
+      end
+
+      let(:user_params) { { search_field: 'built_query', q: 'value' } }
+
+      it 'uses the provided query builder' do
+        expect(subject[:q]).to eq 'eulav'
+        expect(subject[:qq1]).to eq 'xyz'
+      end
+    end
+
     describe "mapping facet.field" do
       let(:blacklight_config) do
         Blacklight::Configuration.new do |config|

data/spec/spec_helper.rb

@@ -20,12 +20,17 @@ require 'rspec/rails'
 require 'rspec/its'
 require 'rspec/collection_matchers'
 require 'capybara/rspec'
-require 'selenium-webdriver'
+require 'capybara/apparition'
 require 'equivalent-xml'
-require 'webdrivers'
 
-Capybara.javascript_driver = :selenium_chrome_headless
+Capybara.javascript_driver = :apparition
 Capybara.disable_animation = true
+# Capybara.enable_aria_label = true
+
+# Uncomment for a headed browser
+# Capybara.register_driver :apparition do |app|
+#   Capybara::Apparition::Driver.new(app, headless: false)
+# end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1,2 @@
 gem 'rails-controller-testing'
-gem 'thor', '~> 0.20'
+gem 'thor', '~> 0.20' if /^5.[12]/.match?(ENV['RAILS_VERSION'])

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

@@ -5,6 +5,7 @@ RSpec.describe "catalog/_document" do
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   before do
+    allow(controller).to receive(:controller_name).and_return('test')
     allow(view).to receive(:render_grouped_response?).and_return(false)
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
     assign(:response, instance_double(Blacklight::Solr::Response, start: 20))

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

@@ -16,6 +16,8 @@ RSpec.describe "catalog/_thumbnail" do
   end
 
   before do
+    # Every call to view_context returns a different object. This ensures it stays stable.
+    allow(controller).to receive(:view_context).and_return(view)
     allow(controller).to receive(:action_name).and_return('index')
     assign :response, instance_double(Blacklight::Solr::Response, start: 0)
     allow(view).to receive(:render_grouped_response?).and_return false

data/tasks/blacklight.rake

@@ -14,14 +14,14 @@ require 'solr_wrapper'
 require 'open3'
 
 def system_with_error_handling(*args)
-  Open3.popen3(*args) do |stdout, stderr, status, _thread|
+  Open3.popen3(*args) do |_stdin, stdout, stderr, thread|
     puts stdout.read
-    raise "Unable to run #{args.inspect}: #{stderr.read}" unless status.success?
+    raise "Unable to run #{args.inspect}: #{stderr.read}" unless thread.value.success?
   end
 end
 
 def with_solr
-  if system('docker-compose')
+  if system('docker-compose -v')
     begin
       puts "Starting Solr"
       system_with_error_handling "docker-compose up -d solr"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.12.0
+  version: 7.14.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,10 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,20 +95,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.23.0
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -186,33 +214,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: webdrivers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: apparition
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.13.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.13.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -339,15 +353,14 @@ files:
 - ".docker/app/Dockerfile"
 - ".docker/app/entrypoint.sh"
 - ".env"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".jshintrc"
-- ".npmignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".solr_wrapper.yml"
-- ".travis.yml"
 - ".yardopts"
 - CONTRIBUTING.md
 - Gemfile
@@ -416,6 +429,7 @@ files:
 - app/components/blacklight/facet_field_pagination_component.rb
 - app/components/blacklight/facet_item_component.rb
 - app/components/blacklight/facet_item_pivot_component.rb
+- app/components/blacklight/hidden_search_state_component.rb
 - app/components/blacklight/metadata_field_component.html.erb
 - app/components/blacklight/metadata_field_component.rb
 - app/components/blacklight/metadata_field_layout_component.html.erb
@@ -653,6 +667,7 @@ files:
 - lib/blacklight/runtime_registry.rb
 - lib/blacklight/search_builder.rb
 - lib/blacklight/search_state.rb
+- lib/blacklight/search_state/filter_field.rb
 - lib/blacklight/solr.rb
 - lib/blacklight/solr/document.rb
 - lib/blacklight/solr/facet_paginator.rb
@@ -712,6 +727,7 @@ files:
 - spec/components/blacklight/facet_field_list_component_spec.rb
 - spec/components/blacklight/facet_item_component_spec.rb
 - spec/components/blacklight/facet_item_pivot_component_spec.rb
+- spec/components/blacklight/hidden_search_state_component_spec.rb
 - spec/components/blacklight/metadata_field_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
@@ -756,9 +772,11 @@ files:
 - spec/integration/generators/blacklight/solr_generator_spec.rb
 - spec/lib/blacklight/configuration/facet_field_spec.rb
 - spec/lib/blacklight/configuration/field_spec.rb
+- spec/lib/blacklight/configuration/view_config_spec.rb
 - spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/parameters_spec.rb
+- spec/lib/blacklight/search_state/filter_field_spec.rb
 - spec/lib/blacklight/search_state_spec.rb
 - spec/lib/blacklight_spec.rb
 - spec/lib/tasks/blacklight_task_spec.rb
@@ -846,23 +864,23 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.
@@ -875,6 +893,7 @@ test_files:
 - spec/components/blacklight/facet_field_list_component_spec.rb
 - spec/components/blacklight/facet_item_component_spec.rb
 - spec/components/blacklight/facet_item_pivot_component_spec.rb
+- spec/components/blacklight/hidden_search_state_component_spec.rb
 - spec/components/blacklight/metadata_field_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
@@ -919,9 +938,11 @@ test_files:
 - spec/integration/generators/blacklight/solr_generator_spec.rb
 - spec/lib/blacklight/configuration/facet_field_spec.rb
 - spec/lib/blacklight/configuration/field_spec.rb
+- spec/lib/blacklight/configuration/view_config_spec.rb
 - spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/parameters_spec.rb
+- spec/lib/blacklight/search_state/filter_field_spec.rb
 - spec/lib/blacklight/search_state_spec.rb
 - spec/lib/blacklight_spec.rb
 - spec/lib/tasks/blacklight_task_spec.rb