blacklight 7.33.0 → 8.0.0

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/models/blacklight/document/email_spec.rb

@@ -1,57 +0,0 @@
-# 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
-
-  it "onlies return values that are available in the field semantics" do
-    doc = SolrDocument.new(id: "1234", title_tsim: "My Title")
-    email_body = doc.to_email_text
-    expect(email_body).to match(/Title: My Title/)
-    expect(email_body).not_to match(/Author/)
-  end
-
-  it "handles multi-values fields correctly" do
-    doc = SolrDocument.new(id: "1234", title_tsim: ["My Title", "My Alt. Title"])
-    email_body = doc.to_email_text
-    expect(email_body).to match(/Title: My Title My Alt. Title/)
-  end
-
-  it "returns nil if there are no valid field semantics to build the email body from" 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,58 +0,0 @@
-# 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
-
-  it "onlies return values that are available in the field semantics" do
-    doc = SolrDocument.new(id: "1234", title_tsim: "My Title", author_tsim: "Joe Schmoe")
-    sms_text = doc.to_sms_text
-    expect(sms_text).to match(/My Title by Joe Schmoe/)
-  end
-
-  it "handles multi-values fields correctly and only take the first" do
-    doc = SolrDocument.new(id: "1234", title_tsim: ["My Title", "My Alt. Title"])
-    sms_text = doc.to_sms_text
-    expect(sms_text).to match(/My Title/)
-    expect(sms_text).not_to match(/My Alt\. Title/)
-  end
-
-  it "returns nil if there are no valid field semantics to build the email body from" 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/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/support/view_component_capybara_test_helpers.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponentCapybaraTestHelpers
-  # 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
-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

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/_previous_next_doc.html.erb" do
-  before do
-    allow(view).to receive(:search_session).and_return({})
-  end
-
-  it "without next or previous does not render content" do
-    assign(:search_context, {})
-    render
-    expect(rendered).not_to have_selector ".pagination-search-widgets"
-  end
-
-  it "with next or previous does render content" do
-    assign(:search_context, next: 'foo', prev: 'bar')
-    allow(view).to receive(:link_to_previous_document).and_return('')
-    allow(view).to receive(:item_page_entry_info).and_return('')
-    allow(view).to receive(:link_to_next_document).and_return('')
-    render
-    expect(rendered).to have_selector ".pagination-search-widgets"
-  end
-end

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

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# spec for default partial to display solr document fields in catalog show view
-
-RSpec.describe "catalog/_show" do
-  include BlacklightHelper
-  include CatalogHelper
-
-  before do
-    allow(controller).to receive(:action_name).and_return('show')
-    @config = Blacklight::Configuration.new do |config|
-      config.show.display_type_field = 'asdf'
-      config.add_show_field 'one_field', label: 'One:'
-      config.add_show_field 'empty_field', label: 'Three:'
-      config.add_show_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 = "Two:"
-    @flabel_4 = "Four:"
-
-    allow(view).to receive(:blacklight_config).and_return(@config)
-    assigns[:document] = @document
-    @rendered = view.render_document_partial @document, :show
-  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/_thumbnail.html.erb_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe "catalog/_thumbnail" do
-  let :document_without_thumbnail_field do
-    SolrDocument.new id: 'xyz', format: 'a'
-  end
-
-  let :document_with_thumbnail_field do
-    SolrDocument.new id: 'xyz', format: 'a', thumbnail_url: 'http://localhost/logo.png'
-  end
-
-  let :blacklight_config do
-    Blacklight::Configuration.new do |config|
-      config.index.thumbnail_field = :thumbnail_url
-    end
-  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
-    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive(:session_tracking_params).and_return({})
-  end
-
-  it "renders the thumbnail if the document has one" do
-    render partial: "catalog/thumbnail", locals: { document: document_with_thumbnail_field, document_counter: 1 }
-    expect(rendered).to match /document-thumbnail/
-    expect(rendered).to match %r{src="http://localhost/logo.png"}
-  end
-
-  it "does not render a thumbnail if the document does not have one" do
-    render partial: "catalog/thumbnail", locals: { document: document_without_thumbnail_field, document_counter: 1 }
-    expect(rendered).to eq ""
-  end
-end