blacklight 7.40.0 → 8.0.0.beta1

data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
-  around { |test| Deprecation.silence(described_class) { test.call } }
-
-  let(:config) do
-    Blacklight::Configuration.new do |config|
-      config.add_facet_field 'type'
-      config.add_search_field 'title'
-    end
-  end
-
-  before do
-    # the helper methods below infer paths from the current route
-    controller.request.path_parameters[:controller] = 'catalog'
-    allow(helper).to receive(:search_action_path) do |*args|
-      search_catalog_path *args
-    end
-
-    allow(helper).to receive(:blacklight_config).and_return(config)
-    allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
-  end
-
-  describe '#render_constraints_query' do
-    subject { helper.render_constraints_query(params) }
-
-    let(:my_engine) { double("Engine") }
-    let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }) }
-
-    it "has a link relative to the current url" do
-      expect(subject).to have_link 'Remove constraint', href: '/catalog?f%5Btype%5D%5B%5D=journal'
-    end
-  end
-
-  describe '#render_constraints_clauses' do
-    subject { helper.render_constraints_clauses(params) }
-
-    let(:my_engine) { double("Engine") }
-    let(:params) { ActionController::Parameters.new(clause: { "0": { field: 'title', query: 'nature' } }, f: { type: 'journal' }) }
-
-    it 'renders the clause constraint' do
-      expect(subject).to have_selector '.constraint-value', text: /Title\s+nature/
-    end
-
-    it "has a link relative to the current url" do
-      expect(subject).to have_link 'Remove constraint Title: nature', href: '/catalog?f%5Btype%5D%5B%5D=journal'
-    end
-  end
-
-  describe '#render_filter_element' do
-    subject { helper.render_filter_element('type', ['journal'], path) }
-
-    before do
-      allow(helper).to receive(:blacklight_config).and_return(config)
-      expect(helper).to receive(:facet_field_label).with('type').and_return("Item Type")
-    end
-
-    let(:params) { ActionController::Parameters.new q: 'biz' }
-    let(:path) { Blacklight::SearchState.new(params, config, controller) }
-
-    it "has a link relative to the current url" do
-      expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
-      expect(subject).to have_selector ".filter-name", text: 'Item Type'
-    end
-
-    context 'with string values' do
-      subject { helper.render_filter_element('type', 'journal', path) }
-
-      it "handles string values gracefully" do
-        expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
-      end
-    end
-
-    context 'with multivalued facets' do
-      subject { helper.render_filter_element('type', [%w[journal book]], path) }
-
-      it "handles such values gracefully" do
-        expect(subject).to have_link "Remove constraint Item Type: journal OR book", href: "/catalog?q=biz"
-      end
-    end
-  end
-
-  describe "#render_constraints_filters" do
-    subject { helper.render_constraints_filters(params) }
-
-    let(:params) { ActionController::Parameters.new f: { 'type' => [''] } }
-
-    it "renders nothing for empty facet limit param" do
-      expect(subject).to be_blank
-    end
-  end
-end

data/spec/helpers/blacklight/search_history_constraints_helper_behavior_spec.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Blacklight::SearchHistoryConstraintsHelperBehavior do
-  around { |test| Deprecation.silence(described_class) { test.call } }
-
-  before(:all) do
-    @config = Blacklight::Configuration.new do |config|
-      config.add_search_field 'default_search_field', label: 'Default'
-
-      config.add_facet_field 'some_facet', label: 'Some'
-      config.add_facet_field 'other_facet', label: 'Other'
-      config.add_facet_field 'i18n_facet'
-
-      I18n.backend.store_translations(:en, blacklight: { search: { fields: { facet: { i18n_facet: 'English facet label' } } } })
-      I18n.backend.store_translations(:de, blacklight: { search: { fields: { facet: { i18n_facet: 'German facet label' } } } })
-    end
-  end
-
-  before do
-    allow(helper).to receive(:blacklight_config).and_return(@config)
-  end
-
-  describe "render_search_to_s_*" do
-    describe "render_search_to_s_element" do
-      it "renders basic element" do
-        response = helper.render_search_to_s_element("key", "value")
-        expect(response).to have_selector("span.constraint") do |span|
-          expect(span).to have_selector("span.filter-name", text: "key:")
-          expect(span).to have_selector("span.filter-values", text: "value")
-        end
-        expect(response).to be_html_safe
-      end
-
-      it "escapes them that need escaping" do
-        response = helper.render_search_to_s_element("key>", "value>")
-        expect(response).to have_selector("span.constraint") do |span|
-          expect(span).to have_selector("span.filter-name", text: 'key>:')
-          expect(span).to have_selector("span.filter-values", text: 'value>')
-        end
-        expect(response).to be_html_safe
-      end
-
-      xit "does not escape with options set thus" do
-        response = helper.render_search_to_s_element("<key>", "value>", escape_key: false, escape_value: false)
-        expect(response).to have_selector("span.constraint") do |span|
-          expect(span).to have_selector("span.filter-name", text: "key>:")
-          expect(span).to have_selector("span.filter-values", text: "value>")
-        end
-        expect(response).to be_html_safe
-      end
-    end
-
-    describe "render_search_to_s" do
-      before do
-        @params = { q: "history", f: { "some_facet" => %w[value1 value1], "other_facet" => ["other1"] } }
-      end
-
-      it "calls lesser methods" do
-        allow(helper).to receive(:blacklight_config).and_return(@config)
-        allow(helper).to receive(:default_search_field).and_return(Blacklight::Configuration::SearchField.new(key: 'default_search_field', display_label: 'Default'))
-        allow(helper).to receive(:label_for_search_field).with(nil).and_return('')
-        # API hooks expect this to be so
-        response = helper.render_search_to_s(@params)
-
-        expect(response).to include(helper.render_search_to_s_q(@params))
-        expect(response).to include(helper.render_search_to_s_filters(@params))
-        expect(response).to be_html_safe
-      end
-    end
-
-    describe "render_search_to_s_filters" do
-      it "renders a constraint for a selected facet in the config" do
-        response = helper.render_search_to_s_filters(f: { "some_facet" => %w[value1 value2] })
-        expect(response).to eq("<span class=\"constraint\"><span class=\"filter-name\">Some:</span><span class=\"filter-values\"><span class=\"filter-value\">value1</span><span class=\"filter-separator\"> and </span><span class=\"filter-value\">value2</span></span></span>")
-      end
-
-      it "renders a constraint for a selected facet not in the config" do
-        response = helper.render_search_to_s_filters(f: { "undefined_facet" => %w[value1 value2] })
-        expect(response).to eq("<span class=\"constraint\"><span class=\"filter-name\">#{'undefined_facet'.titleize}:</span><span class=\"filter-values\"><span class=\"filter-value\">value1</span><span class=\"filter-separator\"> and </span><span class=\"filter-value\">value2</span></span></span>")
-      end
-
-      context 'with I18n translations for selected facet' do
-        before do
-          @orig_locale = I18n.locale
-        end
-
-        after do
-          I18n.locale = @orig_locale
-        end
-
-        it 'renders the correct I18n label for a selected facet with I18n translations' do
-          { en: 'English facet label', de: 'German facet label' }.each do |locale, label|
-            I18n.locale = locale
-            response = helper.render_search_to_s_filters(f: { 'i18n_facet' => %w[value1 value2] })
-            expect(response).to include(label)
-          end
-        end
-      end
-    end
-  end
-end

data/spec/helpers/blacklight/suggest_helper_behavior_spec.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Blacklight::SuggestHelperBehavior do
-  before do
-    allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
-    expect(Deprecation).to receive(:warn)
-  end
-
-  describe '#autocomplete_enabled?' do
-    describe 'with autocomplete config' do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.autocomplete_enabled = true
-          config.autocomplete_path = 'suggest'
-        end
-      end
-
-      it 'is enabled' do
-        expect(helper.autocomplete_enabled?).to be true
-      end
-    end
-
-    describe 'without disabled config' do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.autocomplete_enabled = false
-          config.autocomplete_path = 'suggest'
-        end
-      end
-
-      it 'is disabled' do
-        expect(helper.autocomplete_enabled?).to be false
-      end
-    end
-
-    describe 'without path config' do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.autocomplete_enabled = true
-        end
-      end
-
-      it 'is disabled' do
-        expect(helper.autocomplete_enabled?).to be false
-      end
-    end
-  end
-end

data/spec/lib/blacklight/engine_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Blacklight::Engine do
-  [:bookmarks_http_method, :email_regexp, :facet_missing_param, :sms_mappings].each do |dep_key|
-    describe "config.#{dep_key}" do
-      subject { described_class.config }
-
-      let(:unlikely_value) { 'unlikely value' }
-
-      it 'is deprecated' do
-        allow(Deprecation).to receive(:warn)
-        subject.send(dep_key)
-        expect(Deprecation).to have_received(:warn)
-      end
-
-      it 'delegates to config.blacklight' do
-        allow(subject.blacklight).to receive(dep_key).and_return(unlikely_value)
-        expect(subject.send(dep_key)).to eql(unlikely_value)
-      end
-    end
-
-    describe "config.#{dep_key}=" do
-      subject { described_class.config }
-
-      let(:unlikely_value) { 'unlikely value' }
-
-      it 'is deprecated' do
-        allow(Deprecation).to receive(:warn)
-        allow(subject.blacklight).to receive(:"#{dep_key}=").with(unlikely_value)
-        subject.send(:"#{dep_key}=", unlikely_value)
-        expect(Deprecation).to have_received(:warn)
-      end
-
-      it 'delegates to config.blacklight' do
-        allow(subject.blacklight).to receive(:"#{dep_key}=").with(unlikely_value)
-        subject.send(:"#{dep_key}=", unlikely_value)
-        expect(subject.blacklight).to have_received(:"#{dep_key}=").with(unlikely_value)
-      end
-    end
-  end
-end

data/spec/presenters/blacklight/search_bar_presenter_spec.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-require 'spec_helper'
-
-RSpec.describe Blacklight::SearchBarPresenter do
-  let(:controller) { CatalogController.new }
-  let(:presenter) { described_class.new(controller, blacklight_config) }
-  let(:blacklight_config) { Blacklight::Configuration.new }
-
-  describe '#autocomplete_enabled?' do
-    subject { presenter.autocomplete_enabled? }
-
-    describe 'with autocomplete config' do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.autocomplete_enabled = true
-          config.autocomplete_path = 'suggest'
-        end
-      end
-
-      it { is_expected.to be true }
-    end
-
-    describe 'without disabled config' do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.autocomplete_enabled = false
-          config.autocomplete_path = 'suggest'
-        end
-      end
-
-      it { is_expected.to be false }
-    end
-
-    describe 'without path config' do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.autocomplete_enabled = true
-        end
-      end
-
-      it { is_expected.to be false }
-    end
-  end
-
-  describe "#autofocus?" do
-    subject { presenter.autofocus? }
-
-    context "on a catalog-like index page without query or facet parameters" do
-      let(:blacklight_config) do
-        Blacklight::Configuration.new.configure do |config|
-          config.enable_search_bar_autofocus = true
-        end
-      end
-
-      before do
-        allow(controller).to receive(:action_name).and_return('index')
-        allow(controller).to receive(:has_search_parameters?).and_return(false)
-      end
-
-      it { is_expected.to be true }
-    end
-
-    context "when disabled in config" do
-      before do
-        allow(controller).to receive(:action_name).and_return('index')
-        allow(controller).to receive(:has_search_parameters?).and_return(false)
-      end
-
-      it { is_expected.to be false }
-    end
-
-    context "when not the catalog controller" do
-      let(:controller) { ApplicationController.new }
-
-      it { is_expected.to be false }
-    end
-
-    context "when on the catalog controller show page" do
-      before do
-        allow(controller).to receive(:action_name).and_return('show')
-      end
-
-      it { is_expected.to be false }
-    end
-
-    context "when search parameters are provided" do
-      before do
-        allow(controller).to receive(:has_search_parameters?).and_return(true)
-      end
-
-      it { is_expected.to be false }
-    end
-  end
-end

data/spec/services/blacklight/field_retriever_spec.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Blacklight::FieldRetriever, api: true do
-  let(:service) { described_class.new(document, blacklight_field_config) }
-
-  let(:blacklight_field_config) { Blacklight::Configuration::Field.new(field: 'author_field', highlight: true) }
-  let(:document) { SolrDocument.new({ 'id' => 'doc1', 'title_field' => 'doc1 title', 'author_field' => 'author_someone' }, 'highlighting' => { 'doc1' => { 'title_tsimext' => ['doc <em>1</em>'] } }) }
-  let(:view_context) { {} }
-
-  context "highlighting" do
-    describe '#fetch' do
-      it "retrieves an author even if it's not highlighted" do
-        expect(service.fetch).to eq(['author_someone'])
-      end
-    end
-  end
-end

data/spec/support/view_component_test_helpers.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponentTestHelpers
-  # Work around for https://github.com/teamcapybara/capybara/issues/2466
-  def render_inline_to_capybara_node(component)
-    Capybara::Node::Simple.new(render_inline(component).to_s)
-  end
-
-  # Work-around for https://github.com/ViewComponent/view_component/pull/1661
-  # which made the component test's controller method (more) private. This makes
-  # it available so we can set up controller-level state for our tests.
-  def controller
-    # ViewComponent 2.x
-    return super if defined?(super)
-
-    # ViewComponent 3.x
-    return vc_test_controller if defined?(vc_test_controller)
-
-    ApplicationController.new.extend(Rails.application.routes.url_helpers)
-  end
-
-  # Nokogiri 1.15.0 upgrades the vendored libxml2 from v2.10.4 to v2.11.3
-  # libxml2 v2.11.0 introduces a change to parsing HTML href attributes
-  # in nokogiri < 1.15, brackets in href attributes are escaped:
-  # - <a class="facet-select" rel="nofollow" href="/catalog?f%5Bz%5D%5B%5D=x:1">x:1</a>
-  # in nokogiri >= 1.15, brackets in href attributes are not escaped:
-  # - <a class="facet-select" rel="nofollow" href="/catalog?f[z][]=x:1">x:1</a>
-  # until we can spec a minimum nokogiri version of 1.15.0, we need to see how
-  # the installed version parsed the html
-  def nokogiri_mediated_href(href)
-    start = "<a href=\"".length
-    stop = -"\"></a>".length
-    Nokogiri::HTML.fragment("<a href=\"#{href}\"></a>").to_s[start...stop]
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/constraints" do
-  let :blacklight_config do
-    Blacklight::Configuration.new do |config|
-      config.view.xyz({})
-    end
-  end
-
-  it "renders nothing if no constraints are set" do
-    allow(view).to receive_messages(query_has_constraints?: false)
-    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    render partial: "catalog/constraints"
-    expect(rendered.strip).to be_empty
-  end
-
-  it "renders a start over link" do
-    allow(view).to receive(:search_action_path).with({}).and_return('http://xyz')
-    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_link("Start Over", href: 'http://xyz')
-  end
-
-  it "renders a start over link with the current view type" do
-    allow(view).to receive(:search_action_path).with({ view: :xyz }).and_return('http://xyz?view=xyz')
-    allow(view).to receive_messages(query_has_constraints?: true)
-    params[:view] = 'xyz'
-    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    render partial: "catalog/constraints"
-    expect(rendered).to have_link("Start Over", href: 'http://xyz?view=xyz')
-  end
-end

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

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/_facet_group" 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).and_return('/catalog')
-    allow(view).to receive(:search_facet_path).and_return('/catalog')
-  end
-
-  context "without any facet fields" do
-    before do
-      allow(view).to receive_messages(groupname: nil, render_facet_partials: '')
-      render
-    end
-
-    it "does not have a header if no facets are displayed" do
-      expect(rendered).not_to have_selector('h4')
-    end
-  end
-
-  context "with facet groups" do
-    let :facet_field do
-      Blacklight::Configuration::FacetField.new(field: 'facet_field_1', label: 'label', group: nil).normalize!
-    end
-
-    let(:mock_display_facet1) do
-      double(name: 'facet_field_1', sort: nil, offset: nil, prefix: nil, items: [Blacklight::Solr::Response::Facets::FacetItem.new(value: 'Value', hits: 1234)])
-    end
-
-    let(:response) do
-      instance_double(Blacklight::Solr::Response, aggregations: { "facet_field_1" => mock_display_facet1 })
-    end
-
-    before do
-      blacklight_config.facet_fields['facet_field_1'] = facet_field
-      allow(view).to receive_messages(groupname: nil, facet_field_names: [:facet_field_1], facet_limit_for: 10)
-      @response = response
-    end
-
-    context "with the default facet group" do
-      it "has a header" do
-        allow(view).to receive_messages(render_facet_partials: '')
-        render
-        expect(rendered).to have_selector('.facets-heading')
-      end
-    end
-
-    context "with a named facet group" do
-      let :facet_field do
-        Blacklight::Configuration::FacetField.new(field: 'facet_field_1', label: 'label', group: 'group_1').normalize!
-      end
-
-      before do
-        blacklight_config.facet_fields['facet_field_1'] = facet_field
-        allow(view).to receive_messages(groupname: 'group_1', facet_field_names: [:facet_field_1], facet_limit_for: 10)
-      end
-
-      it "has a header" do
-        allow(view).to receive_messages(render_facet_partials: '')
-        render
-        expect(rendered).to have_selector('.facets-heading')
-        expect(rendered).to have_selector('#facets-group_1')
-      end
-    end
-
-    describe "facet display" do
-      it "has a(n accessible) header" do
-        render
-        expect(rendered).to have_selector('.facet-field-heading')
-      end
-
-      it "lists values" do
-        render
-        # 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 .facet-count')
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/_facets" do
-  context "with facet groups" do
-    before do
-      stub_template('catalog/_facet_group.html.erb' => 'text')
-      allow(view).to receive_messages(facet_group_names: [nil, nil])
-      render
-    end
-
-    it "Calls facet_group for each name" do
-      expect(rendered).to match(/^  text\n  text\n$/)
-    end
-  end
-end

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

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# spec for default partial to display solr document fields in catalog INDEX view
-
-RSpec.describe "catalog/_index" do
-  include BlacklightHelper
-  include CatalogHelper
-
-  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:'
-    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:"
-    @flabel_3 = "Three:"
-    @flabel_4 = "Four:"
-
-    allow(view).to receive(:blacklight_config).and_return(@config)
-    assigns[:document] = @document
-    @rendered = view.render_document_partial @document, :index
-  end
-
-  it "only displays fields listed in the initializer" do
-    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).not_to include(@fname_3)
-  end
-
-  it "displays field labels from initializer and raw solr field names in the class" do
-    # labels
-    expect(@rendered).to include(@flabel_1)
-    expect(@rendered).to include(@flabel_4)
-    # classes
-    expect(@rendered).to include("blacklight-#{@fname_1}")
-    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
-
-  it "has values for displayed fields" do
-    expect(@rendered).to include("val_1")
-    expect(@rendered).to include("val_4")
-    expect(@rendered).not_to include("val_2")
-  end
-end

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/_index_header" do
-  let :document do
-    SolrDocument.new id: 'xyz', format: 'a'
-  end
-
-  let(:blacklight_config) { Blacklight::Configuration.new }
-
-  before do
-    assign :response, instance_double(Blacklight::Solr::Response, start: 0)
-    allow(view).to receive(:render_grouped_response?).and_return false
-    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive(:session_tracking_params).and_return({})
-  end
-
-  it "renders the document header" do
-    allow(view).to receive(:render_index_doc_actions)
-    render partial: "catalog/index_header", locals: { document: document, document_counter: 1 }
-    expect(rendered).to have_selector('.document-counter', text: "2")
-  end
-
-  it "allows the title to take the whole space if no document tools are rendered" do
-    allow(view).to receive(:render_index_doc_actions)
-    render partial: "catalog/index_header", locals: { document: document, document_counter: 1 }
-    expect(rendered).to have_selector '.index_title.col-md-12'
-  end
-
-  it "gives the document actions space if present" do
-    allow(view).to receive(:render_index_doc_actions).and_return("DOCUMENT ACTIONS")
-    render partial: "catalog/index_header", locals: { document: document, document_counter: 1 }
-    expect(rendered).to have_selector '.index_title.col-sm-9'
-    expect(rendered).to have_content "DOCUMENT ACTIONS"
-  end
-end