blacklight 7.12.0 → 7.14.0

data/lib/blacklight/solr/repository.rb

@@ -41,7 +41,7 @@ module Blacklight::Solr
     # @return [boolean] true if the repository is reachable
     def ping
       response = connection.send_and_receive 'admin/ping', {}
-      Blacklight.logger.info("Ping [#{connection.uri}] returned: '#{response['status']}'")
+      Blacklight.logger&.info("Ping [#{connection.uri}] returned: '#{response['status']}'")
       response['status'] == "OK"
     end
 
@@ -63,8 +63,8 @@ module Blacklight::Solr
 
         solr_response = blacklight_config.response_model.new(res, solr_params, document_model: blacklight_config.document_model, blacklight_config: blacklight_config)
 
-        Blacklight.logger.debug("Solr query: #{blacklight_config.http_method} #{path} #{solr_params.to_hash.inspect}")
-        Blacklight.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) && ::BLACKLIGHT_VERBOSE_LOGGING
+        Blacklight.logger&.debug("Solr query: #{blacklight_config.http_method} #{path} #{solr_params.to_hash.inspect}")
+        Blacklight.logger&.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) && ::BLACKLIGHT_VERBOSE_LOGGING
         solr_response
       end
     rescue Errno::ECONNREFUSED => e

data/lib/blacklight/solr/response.rb

@@ -93,7 +93,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
       value.each { |v| force_to_utf8(v) }
     when String
       if value.encoding != Encoding::UTF_8
-        Blacklight.logger.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
+        Blacklight.logger&.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
         value.dup.force_encoding('UTF-8')
       else
         value

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -32,18 +32,22 @@ module Blacklight::Solr
     # including config's "search field" params for current search field.
     # also include setting spellcheck.q.
     def add_query_to_solr(solr_parameters)
-      ###
-      # Merge in search field configured values, if present, over-writing general
-      # defaults
       ###
       # legacy behavior of user param :qt is passed through, but over-ridden
       # by actual search field config if present. We might want to remove
       # this legacy behavior at some point. It does not seem to be currently
       # rspec'd.
-      solr_parameters[:qt] = blacklight_params[:qt] if blacklight_params[:qt]
+      if search_state.params[:qt]
+        Deprecation.warn(Blacklight::Solr::SearchBuilderBehavior, 'Passing the Solr qt as a parameter is deprecated.')
+        solr_parameters[:qt] = blacklight_params[:qt]
+      end
+
+      ###
+      # Merge in search field configured values, if present, over-writing general
+      # defaults
 
       if search_field
-        solr_parameters[:qt] = search_field.qt
+        solr_parameters[:qt] = search_field.qt if search_field.qt
         solr_parameters.merge!(search_field.solr_parameters) if search_field.solr_parameters
       end
 
@@ -52,32 +56,14 @@ module Blacklight::Solr
       # solr LocalParams in config, using solr LocalParams syntax.
       # http://wiki.apache.org/solr/LocalParams
       ##
-      if search_field && search_field.solr_local_parameters.present?
-        local_params = search_field.solr_local_parameters.map do |key, val|
-          key.to_s + "=" + solr_param_quote(val, quote: "'")
-        end.join(" ")
-        solr_parameters[:q] = "{!#{local_params}}#{blacklight_params[:q]}"
-
-        ##
-        # Set Solr spellcheck.q to be original user-entered query, without
-        # our local params, otherwise it'll try and spellcheck the local
-        # params!
-        solr_parameters["spellcheck.q"] ||= blacklight_params[:q]
-      elsif blacklight_params[:q].is_a? Hash
-        q = blacklight_params[:q]
-        solr_parameters[:q] = if q.values.any?(&:blank?)
-                                # if any field parameters are empty, exclude _all_ results
-                                "{!lucene}NOT *:*"
-                              else
-                                "{!lucene}" + q.map do |field, values|
-                                  "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
-                                end.join(" AND ")
-                              end
-
-        solr_parameters[:defType] = 'lucene'
-        solr_parameters[:spellcheck] = 'false'
+      if search_field&.query_builder.present?
+        add_search_field_query_builder_params(solr_parameters)
+      elsif search_field&.solr_local_parameters.present?
+        add_search_field_with_local_parameters(solr_parameters)
+      elsif search_state.query_param.is_a? Hash
+        add_multifield_search_query(solr_parameters)
       elsif blacklight_params[:q]
-        solr_parameters[:q] = blacklight_params[:q]
+        solr_parameters[:q] = search_state.query_param
       end
     end
 
@@ -90,13 +76,17 @@ module Blacklight::Solr
         solr_parameters[:fq] = [solr_parameters[:fq]]
       end
 
-      # :fq, map from :f.
-      if blacklight_params[:f]
-        f_request_params = blacklight_params[:f]
+      search_state.filters.each do |filter|
+        if filter.config.filter_query_builder
+          filter_query, subqueries = filter.config.filter_query_builder.call(self, filter, solr_parameters)
 
-        f_request_params.each_pair do |facet_field, value_list|
-          Array(value_list).reject(&:blank?).each do |value|
-            solr_parameters.append_filter_query facet_value_to_fq_string(facet_field, value)
+          solr_parameters.append_filter_query(filter_query)
+          solr_parameters.merge!(subqueries) if subqueries
+        else
+          filter.values.reject(&:blank?).each do |value|
+            filter_query, subqueries = facet_value_to_fq_string(filter.config.key, value)
+            solr_parameters.append_filter_query(filter_query)
+            solr_parameters.merge!(subqueries) if subqueries
           end
         end
       end
@@ -171,9 +161,7 @@ module Blacklight::Solr
 
     # Remove the group parameter if we've faceted on the group field (e.g. for the full results for a group)
     def add_group_config_to_solr solr_parameters
-      if blacklight_params[:f] && blacklight_params[:f][grouped_key_for_results]
-        solr_parameters[:group] = false
-      end
+      solr_parameters[:group] = false if search_state.filter(grouped_key_for_results).any?
     end
 
     def add_facet_paging_to_solr(solr_params)
@@ -191,22 +179,17 @@ module Blacklight::Solr
                 facet_config.fetch(:more_limit, blacklight_config.default_more_limit)
               end
 
-      page = blacklight_params.fetch(request_keys[:page], 1).to_i
+      page = search_state.facet_page
+      sort = search_state.facet_sort
+      prefix = search_state.facet_prefix
       offset = (page - 1) * limit
 
-      sort = blacklight_params[request_keys[:sort]]
-      prefix = blacklight_params[request_keys[:prefix]]
-
       # Need to set as f.facet_field.facet.* to make sure we
       # override any field-specific default in the solr request handler.
       solr_params[:"f.#{facet_config.field}.facet.limit"] = limit + 1
       solr_params[:"f.#{facet_config.field}.facet.offset"] = offset
-      if blacklight_params[request_keys[:sort]]
-        solr_params[:"f.#{facet_config.field}.facet.sort"] = sort
-      end
-      if blacklight_params[request_keys[:prefix]]
-        solr_params[:"f.#{facet_config.field}.facet.prefix"] = prefix
-      end
+      solr_params[:"f.#{facet_config.field}.facet.sort"] = sort if sort
+      solr_params[:"f.#{facet_config.field}.facet.prefix"] = prefix if prefix
       solr_params[:rows] = 0
     end
 
@@ -314,8 +297,45 @@ module Blacklight::Solr
       end
     end
 
-    def request_keys
-      blacklight_config.facet_paginator_class.request_keys
+    def search_state
+      return super if defined?(super)
+
+      @search_state ||= Blacklight::SearchState.new(blacklight_params, blacklight_config)
+    end
+
+    def add_search_field_query_builder_params(solr_parameters)
+      q, additional_parameters = search_field.query_builder.call(self, search_field, solr_parameters)
+
+      solr_parameters[:q] = q
+      solr_parameters.merge!(additional_parameters) if additional_parameters
+    end
+
+    def add_search_field_with_local_parameters(solr_parameters)
+      local_params = search_field.solr_local_parameters.map do |key, val|
+        key.to_s + "=" + solr_param_quote(val, quote: "'")
+      end.join(" ")
+      solr_parameters[:q] = "{!#{local_params}}#{search_state.query_param}"
+
+      ##
+      # Set Solr spellcheck.q to be original user-entered query, without
+      # our local params, otherwise it'll try and spellcheck the local
+      # params!
+      solr_parameters["spellcheck.q"] ||= search_state.query_param
+    end
+
+    def add_multifield_search_query(solr_parameters)
+      q = search_state.query_param
+      solr_parameters[:q] = if q.values.any?(&:blank?)
+                              # if any field parameters are empty, exclude _all_ results
+                              "{!lucene}NOT *:*"
+                            else
+                              "{!lucene}" + q.map do |field, values|
+                                "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
+                              end.join(" AND ")
+                            end
+
+      solr_parameters[:defType] = 'lucene'
+      solr_parameters[:spellcheck] = 'false'
     end
   end
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "blacklight-frontend",
   "version": "7.10.0",
-  "description": "[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=master)](https://coveralls.io/github/projectblacklight/blacklight?branch=master)",
+  "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=master)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=master)](https://coveralls.io/github/projectblacklight/blacklight?branch=master)",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {
     "js-compile-bundle": "shx cat app/javascript/blacklight/core.js app/javascript/blacklight/autocomplete.js app/javascript/blacklight/bookmark_toggle.js app/javascript/blacklight/button_focus.js app/javascript/blacklight/checkbox_submit.js app/javascript/blacklight/facet_load.js app/javascript/blacklight/modal.js app/javascript/blacklight/search_context.js | shx sed \"s/^(import|export).*//\" | babel --filename app/javascript/blacklight/blacklight.js > app/assets/javascripts/blacklight/blacklight.js"
@@ -10,6 +10,10 @@
     "type": "git",
     "url": "git+https://github.com/projectblacklight/blacklight.git"
   },
+  "files": [
+    "app/assets",
+    "app/javascript"
+  ],
   "author": "",
   "license": "Apache-2.0",
   "bugs": {

data/spec/components/blacklight/constraint_layout_component_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
   subject(:render) do
-    render_inline(described_class.new(params))
+    render_inline(described_class.new(**params))
   end
 
   let(:rendered) do

data/spec/components/blacklight/document_component_spec.rb

@@ -33,6 +33,8 @@ RSpec.describe Blacklight::DocumentComponent, type: :component 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_context)
     allow(controller).to receive(:current_or_guest_user).and_return(User.new)
     allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
     allow(view_context).to receive(:search_session).and_return({})
@@ -42,11 +44,13 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   it 'has some defined content areas' do
     component.with(:title, 'Title')
+    component.with(:embed, 'Embed')
     component.with(:metadata, 'Metadata')
     component.with(:thumbnail, 'Thumbnail')
     component.with(:actions, 'Actions')
 
     expect(rendered).to have_content 'Title'
+    expect(rendered).to have_content 'Embed'
     expect(rendered).to have_content 'Metadata'
     expect(rendered).to have_content 'Thumbnail'
     expect(rendered).to have_content 'Actions'
@@ -126,6 +130,19 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       expect(rendered).to have_selector 'dt', text: 'ISBN:'
       expect(rendered).to have_selector 'dd', text: 'Value'
     end
+
+    it 'renders an embed' do
+      stub_const('StubComponent', Class.new(ViewComponent::Base) do
+        def initialize(**); end
+
+        def call
+          'embed'
+        end
+      end)
+
+      blacklight_config.show.embed_component = StubComponent
+      expect(rendered).to have_content 'embed'
+    end
   end
 
   it 'renders metadata' do

data/spec/components/blacklight/hidden_search_state_component_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::HiddenSearchStateComponent, type: :component do
+  subject(:render) { render_inline(instance) }
+
+  let(:params) do
+    { q: "query",
+      search_field: "search_field",
+      per_page: 10,
+      extra_arbitrary_key: "arbitrary_value",
+      f: { field1: %w[a b], field2: ["z"] } }
+  end
+  let(:instance) { described_class.new(params: params) }
+  let(:generated) { Capybara::Node::Simple.new("<div>#{render.to_html}</div>") }
+
+  it "converts a hash with nested complex data to Rails-style hidden form fields" do
+    expect(generated).to have_selector("input[type='hidden'][name='q'][value='query']", visible: :hidden)
+    expect(generated).to have_selector("input[type='hidden'][name='per_page'][value='10']", visible: :hidden)
+    expect(generated).to have_selector("input[type='hidden'][name='extra_arbitrary_key'][value='arbitrary_value']", visible: :hidden)
+    expect(generated).to have_selector("input[type='hidden'][name='f[field2][]'][value='z']", visible: :hidden)
+    expect(generated).to have_selector("input[type='hidden'][name='f[field1][]'][value='a']", visible: :hidden)
+    expect(generated).to have_selector("input[type='hidden'][name='f[field1][]'][value='b']", visible: :hidden)
+  end
+end

data/spec/features/facets_spec.rb

@@ -56,10 +56,6 @@ RSpec.describe "Facets" do
 
     expect(page).to have_css('#facet-format', visible: false)
 
-    within('#facets .facets-header') do
-      page.find('button.navbar-toggler').click
-    end
-
     page.find('h3.facet-field-heading button', text: 'Format').click
 
     sleep(1) # let facet animation finish and wait for it to potentially re-collapse
@@ -70,14 +66,10 @@ RSpec.describe "Facets" do
   it 'is able to expand pivot facets when javascript is enabled', js: true do
     visit root_path
 
-    within('#facets .facets-header') do
-      page.find('button.navbar-toggler').click
-    end
-
     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 30')
+      expect(page).to have_css('.facet-leaf-node', text: "Book\t30")
       expect(page).not_to have_css('.facet-select', text: 'Tibetan')
       page.find('.facet-toggle-handle').click
       click_link 'Tibetan'
@@ -88,15 +80,8 @@ RSpec.describe "Facets" do
   end
 
   describe 'heading button focus with Firefox' do
-    before do
-      Capybara.current_driver = :selenium_headless
-    end
-
-    after do
-      Capybara.current_driver = :rack_test
-    end
-
     it 'changes to the button on button click in Firefox' do
+      pending 'Capybara::NotSupportedByDriverError: Capybara::Driver::Base#evaluate_script'
       visit root_path
       page.find('h3.facet-field-heading button', text: 'Format').click
       focused_element_data_target = page.evaluate_script("document.activeElement")['data-target']

data/spec/features/search_filters_spec.rb

@@ -168,26 +168,16 @@ RSpec.describe "Facets" do
   end
 
   it "is collapsed when not selected", js: true do
-    skip("Test passes locally but not on Travis.") if ENV['TRAVIS']
     visit root_path
 
-    within('#facets .facets-header') do
-      page.find('button.navbar-toggler').click
-    end
-
     within(".blacklight-subject_ssim") do
       expect(page).not_to have_selector(".card-body", visible: true)
     end
   end
 
   it "expands when the heading button is clicked", js: true do
-    skip("Test passes locally but not on Travis.") if ENV['TRAVIS']
     visit root_path
 
-    within('#facets .facets-header') do
-      page.find('button.navbar-toggler').click
-    end
-
     within(".blacklight-subject_ssim") do
       expect(page).not_to have_selector(".card-body", visible: true)
       find(".card-header button").click
@@ -196,13 +186,8 @@ RSpec.describe "Facets" do
   end
 
   it "expands when the button is clicked", js: true do
-    skip("Test passes locally but not on Travis.") if ENV['TRAVIS']
     visit root_path
 
-    within('#facets .facets-header') do
-      page.find('button.navbar-toggler').click
-    end
-
     within(".blacklight-subject_ssim") do
       expect(page).not_to have_selector(".card-body", visible: true)
       find(".card-header").click
@@ -211,13 +196,8 @@ RSpec.describe "Facets" do
   end
 
   it "keeps selected facets expanded on page load", js: true do
-    skip("Test passes locally but not on Travis.") if ENV['TRAVIS']
     visit root_path
 
-    within('#facets .facets-header') do
-      page.find('button.navbar-toggler').click
-    end
-
     within(".blacklight-subject_ssim") do
       page.find('h3.facet-field-heading', text: 'Topic').click
       expect(page).to have_selector(".panel-collapse", visible: true)

data/spec/features/search_spec.rb

@@ -115,9 +115,4 @@ RSpec.describe "Search Page" do
     expect(page).to have_content "Welcome!"
     expect(page).not_to have_selector "#q[value='history']"
   end
-
-  it "handles searches with invalid facet parameters" do
-    visit root_path f: { missing_s: [1] }
-    expect(page).to have_content "No results found for your search"
-  end
 end

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -122,8 +122,7 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe "#view_label" do
     it "looks up the label to display for the view" do
-      allow(blacklight_config).to receive(:view).and_return("my_view" => double(label: "some label", title: nil))
-      allow(helper).to receive(:field_label).with(:"blacklight.search.view_title.my_view", :"blacklight.search.view.my_view", "some label", nil, "My view")
+      allow(blacklight_config).to receive(:view).and_return("my_view" => double(display_label: "some label"))
 
       helper.view_label "my_view"
     end

data/spec/helpers/blacklight/hash_as_hidden_fields_behavior_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Blacklight::HashAsHiddenFieldsHelperBehavior do
   let(:generated) { helper.render_hash_as_hidden_fields(params) }
 
   it "converts a hash with nested complex data to Rails-style hidden form fields" do
+    allow(Deprecation).to receive(:warn)
     expect(generated).to have_selector("input[type='hidden'][name='q'][value='query']", visible: false)
     expect(generated).to have_selector("input[type='hidden'][name='per_page'][value='10']", visible: false)
     expect(generated).to have_selector("input[type='hidden'][name='page'][value='5']", visible: false)

data/spec/helpers/blacklight/url_helper_behavior_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Blacklight::UrlHelperBehavior do
   let(:parameter_class) { ActionController::Parameters }
 
   before do
+    allow(controller).to receive(:controller_name).and_return('test')
     allow(helper).to receive(:search_action_path) do |*args|
       search_catalog_url *args
     end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::Configuration::ViewConfig do
+  subject { described_class.new(key: key, label: label) }
+
+  let(:key) { 'my_view' }
+  let(:label) { 'some label' }
+
+  describe '#display_label' do
+    it "looks up the label to display for the given document and field" do
+      allow(I18n).to receive(:t).with(:"blacklight.search.view_title.my_view", default: [:"blacklight.search.view.my_view", label, nil, "My view"]).and_return('x')
+      expect(subject.display_label(key)).to eq 'x'
+    end
+  end
+end