blacklight 8.0.0.beta1 → 8.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 8.0.0.beta1
+  version: 8.0.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -113,16 +113,22 @@ dependencies:
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.66'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.66'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -369,6 +375,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- app/assets/config/blacklight/manifest.js
 - app/assets/images/blacklight/logo.png
 - app/assets/images/favicon.ico
 - app/assets/javascripts/blacklight/blacklight.esm.js
@@ -416,6 +423,8 @@ files:
 - app/components/blacklight/document/group_component.rb
 - app/components/blacklight/document/more_like_this_component.html.erb
 - app/components/blacklight/document/more_like_this_component.rb
+- app/components/blacklight/document/show_tools_component.html.erb
+- app/components/blacklight/document/show_tools_component.rb
 - app/components/blacklight/document/sidebar_component.html.erb
 - app/components/blacklight/document/sidebar_component.rb
 - app/components/blacklight/document/thumbnail_component.html.erb
@@ -453,6 +462,7 @@ files:
 - app/components/blacklight/metadata_field_component.rb
 - app/components/blacklight/metadata_field_layout_component.html.erb
 - app/components/blacklight/metadata_field_layout_component.rb
+- app/components/blacklight/metadata_field_plain_text_layout_component.rb
 - app/components/blacklight/response/facet_group_component.html.erb
 - app/components/blacklight/response/facet_group_component.rb
 - app/components/blacklight/response/pagination_component.html.erb
@@ -470,8 +480,10 @@ files:
 - app/components/blacklight/search_bar_component.html.erb
 - app/components/blacklight/search_bar_component.rb
 - app/components/blacklight/search_button_component.rb
-- app/components/blacklight/search_context_component.html.erb
-- app/components/blacklight/search_context_component.rb
+- app/components/blacklight/search_context/server_applied_params_component.html.erb
+- app/components/blacklight/search_context/server_applied_params_component.rb
+- app/components/blacklight/search_context/server_item_pagination_component.html.erb
+- app/components/blacklight/search_context/server_item_pagination_component.rb
 - app/components/blacklight/search_header_component.html.erb
 - app/components/blacklight/search_header_component.rb
 - app/components/blacklight/search_history_constraint_layout_component.rb
@@ -500,6 +512,7 @@ files:
 - app/helpers/blacklight/catalog_helper_behavior.rb
 - app/helpers/blacklight/component_helper_behavior.rb
 - app/helpers/blacklight/configuration_helper_behavior.rb
+- app/helpers/blacklight/document_helper_behavior.rb
 - app/helpers/blacklight/facets_helper_behavior.rb
 - app/helpers/blacklight/icon_helper_behavior.rb
 - app/helpers/blacklight/layout_helper_behavior.rb
@@ -525,12 +538,10 @@ files:
 - app/models/concerns/blacklight/document/attributes.rb
 - app/models/concerns/blacklight/document/cache_key.rb
 - app/models/concerns/blacklight/document/dublin_core.rb
-- app/models/concerns/blacklight/document/email.rb
 - app/models/concerns/blacklight/document/export.rb
 - app/models/concerns/blacklight/document/extensions.rb
 - app/models/concerns/blacklight/document/schema_org.rb
 - app/models/concerns/blacklight/document/semantic_fields.rb
-- app/models/concerns/blacklight/document/sms.rb
 - app/models/concerns/blacklight/suggest/response.rb
 - app/models/concerns/blacklight/user.rb
 - app/models/record_mailer.rb
@@ -681,6 +692,7 @@ files:
 - lib/blacklight/configuration/null_display_field.rb
 - lib/blacklight/configuration/null_field.rb
 - lib/blacklight/configuration/search_field.rb
+- lib/blacklight/configuration/session_tracking_config.rb
 - lib/blacklight/configuration/show_field.rb
 - lib/blacklight/configuration/sort_field.rb
 - lib/blacklight/configuration/tool_config.rb
@@ -766,12 +778,14 @@ 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/header_component_spec.rb
 - spec/components/blacklight/hidden_search_state_component_spec.rb
 - spec/components/blacklight/metadata_field_component_spec.rb
 - spec/components/blacklight/response/spellcheck_component_spec.rb
 - spec/components/blacklight/response/view_type_component_spec.rb
 - spec/components/blacklight/search_bar_component_spec.rb
-- spec/components/blacklight/search_context_component_spec.rb
+- spec/components/blacklight/search_context/server_applied_params_component_spec.rb
+- spec/components/blacklight/search_context/server_item_pagination_component_spec.rb
 - spec/components/blacklight/start_over_button_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
@@ -786,9 +800,11 @@ files:
 - spec/features/autocomplete_spec.rb
 - spec/features/axe_spec.rb
 - spec/features/bookmarks_spec.rb
+- spec/features/component_template_override_spec.rb
 - spec/features/did_you_mean_spec.rb
 - spec/features/facet_missing_spec.rb
 - spec/features/facets_spec.rb
+- spec/features/modal_spec.rb
 - spec/features/record_view_spec.rb
 - spec/features/search_context_spec.rb
 - spec/features/search_crawler_spec.rb
@@ -799,7 +815,7 @@ files:
 - spec/features/search_results_spec.rb
 - spec/features/search_sort_spec.rb
 - spec/features/search_spec.rb
-- spec/features/sitelinks_search_box.rb
+- spec/features/sitelinks_search_box_spec.rb
 - spec/fixtures/sample_solr_documents.yml
 - spec/helpers/blacklight/configuration_helper_behavior_spec.rb
 - spec/helpers/blacklight/facets_helper_behavior_spec.rb
@@ -814,6 +830,7 @@ files:
 - spec/lib/blacklight/component_spec.rb
 - spec/lib/blacklight/configuration/facet_field_spec.rb
 - spec/lib/blacklight/configuration/field_spec.rb
+- spec/lib/blacklight/configuration/session_tracking_config_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
@@ -829,8 +846,6 @@ files:
 - spec/models/blacklight/document/active_model_shim_spec.rb
 - spec/models/blacklight/document/cache_key_spec.rb
 - spec/models/blacklight/document/dublin_core_spec.rb
-- spec/models/blacklight/document/email_spec.rb
-- spec/models/blacklight/document/sms_spec.rb
 - spec/models/blacklight/document_spec.rb
 - spec/models/blacklight/facet_paginator_spec.rb
 - spec/models/blacklight/icon_spec.rb
@@ -873,7 +888,7 @@ files:
 - spec/support/features/search_helpers.rb
 - spec/support/features/session_helpers.rb
 - spec/support/presenter_test_helpers.rb
-- spec/support/view_component_capybara_test_helpers.rb
+- spec/support/view_component_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_document.html.erb_spec.rb
@@ -915,11 +930,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
@@ -937,12 +952,14 @@ 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/header_component_spec.rb
 - spec/components/blacklight/hidden_search_state_component_spec.rb
 - spec/components/blacklight/metadata_field_component_spec.rb
 - spec/components/blacklight/response/spellcheck_component_spec.rb
 - spec/components/blacklight/response/view_type_component_spec.rb
 - spec/components/blacklight/search_bar_component_spec.rb
-- spec/components/blacklight/search_context_component_spec.rb
+- spec/components/blacklight/search_context/server_applied_params_component_spec.rb
+- spec/components/blacklight/search_context/server_item_pagination_component_spec.rb
 - spec/components/blacklight/start_over_button_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
@@ -957,9 +974,11 @@ test_files:
 - spec/features/autocomplete_spec.rb
 - spec/features/axe_spec.rb
 - spec/features/bookmarks_spec.rb
+- spec/features/component_template_override_spec.rb
 - spec/features/did_you_mean_spec.rb
 - spec/features/facet_missing_spec.rb
 - spec/features/facets_spec.rb
+- spec/features/modal_spec.rb
 - spec/features/record_view_spec.rb
 - spec/features/search_context_spec.rb
 - spec/features/search_crawler_spec.rb
@@ -970,7 +989,7 @@ test_files:
 - spec/features/search_results_spec.rb
 - spec/features/search_sort_spec.rb
 - spec/features/search_spec.rb
-- spec/features/sitelinks_search_box.rb
+- spec/features/sitelinks_search_box_spec.rb
 - spec/fixtures/sample_solr_documents.yml
 - spec/helpers/blacklight/configuration_helper_behavior_spec.rb
 - spec/helpers/blacklight/facets_helper_behavior_spec.rb
@@ -985,6 +1004,7 @@ test_files:
 - spec/lib/blacklight/component_spec.rb
 - spec/lib/blacklight/configuration/facet_field_spec.rb
 - spec/lib/blacklight/configuration/field_spec.rb
+- spec/lib/blacklight/configuration/session_tracking_config_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
@@ -1000,8 +1020,6 @@ test_files:
 - spec/models/blacklight/document/active_model_shim_spec.rb
 - spec/models/blacklight/document/cache_key_spec.rb
 - spec/models/blacklight/document/dublin_core_spec.rb
-- spec/models/blacklight/document/email_spec.rb
-- spec/models/blacklight/document/sms_spec.rb
 - spec/models/blacklight/document_spec.rb
 - spec/models/blacklight/facet_paginator_spec.rb
 - spec/models/blacklight/icon_spec.rb
@@ -1044,7 +1062,7 @@ test_files:
 - spec/support/features/search_helpers.rb
 - spec/support/features/session_helpers.rb
 - spec/support/presenter_test_helpers.rb
-- spec/support/view_component_capybara_test_helpers.rb
+- spec/support/view_component_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_document.html.erb_spec.rb

data/app/components/blacklight/search_context_component.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  class SearchContextComponent < Blacklight::Component
-    with_collection_parameter :search_context
-
-    def initialize(search_context:, search_session:)
-      @search_context = search_context
-      @search_session = search_session
-    end
-
-    def render?
-      @search_context.present? && (@search_context[:prev] || @search_context[:next])
-    end
-
-    ##
-    # Displays "showing X of Y items" message.
-    #
-    # @return [String]
-    def item_page_entry_info
-      t('blacklight.search.entry_pagination_info.other', current: number_with_delimiter(count),
-                                                         total: number_with_delimiter(total),
-                                                         count: total).html_safe
-    end
-
-    def link_to_previous_document(previous_document = nil, classes: 'previous', **link_opts)
-      previous_document ||= @search_context[:prev]
-      link_opts = session_tracking_params(previous_document, count - 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'prev').merge(link_opts)
-      link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
-        tag.span raw(t('views.pagination.previous')), class: 'previous'
-      end
-    end
-
-    def link_to_next_document(next_document = nil, classes: 'next', **link_opts)
-      next_document ||= @search_context[:next]
-      link_opts = session_tracking_params(next_document, count + 1, per_page: per_page, search_id: search_id).merge(class: classes, rel: 'next').merge(link_opts)
-      link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
-        tag.span raw(t('views.pagination.next')), class: 'next'
-      end
-    end
-
-    private
-
-    def count
-      @search_session['counter'].to_i
-    end
-
-    def per_page
-      @search_session['per_page']
-    end
-
-    def total
-      @search_session['total'].to_i
-    end
-
-    def search_id
-      controller.current_search_session&.id
-    end
-
-    def session_tracking_params(...)
-      helpers.session_tracking_params(...)
-    end
-
-    def url_for_document(...)
-      helpers.search_state.url_for_document(...)
-    end
-  end
-end

data/app/models/concerns/blacklight/document/email.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# This module provides the body of an email export based on the document's semantic values
-module Blacklight::Document::Email
-  # Return a text string that will be the body of the email
-  def to_email_text(config = nil)
-    body = []
-
-    if config
-      body = config.email_fields.map do |name, field|
-        values = [self[name]].flatten
-        "#{field.label} #{values.join(' ')}" if self[name].present?
-      end
-    end
-
-    # Use to_semantic_values for backwards compatibility
-    if body.empty?
-      semantics = to_semantic_values
-      body << I18n.t('blacklight.email.text.title', value: semantics[:title].join(" ")) if semantics[:title].present?
-      body << I18n.t('blacklight.email.text.author', value: semantics[:author].join(" ")) if semantics[:author].present?
-      body << I18n.t('blacklight.email.text.format', value: semantics[:format].join(" ")) if semantics[:format].present?
-      body << I18n.t('blacklight.email.text.language', value: semantics[:language].join(" ")) if semantics[:language].present?
-    end
-
-    return body.join("\n") unless body.empty?
-  end
-end

data/app/models/concerns/blacklight/document/sms.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# This module provides the body of an email export based on the document's semantic values
-module Blacklight::Document::Sms
-  # Return a text string that will be the body of the email
-  def to_sms_text(config = nil)
-    body = []
-
-    if config
-      body = config.sms_fields.map do |name, field|
-        values = [self[name]].flatten
-        "#{field.label} #{values.first}" if self[name].present?
-      end
-    end
-
-    # Use to_semantic_values for backwards compatibility
-    if body.empty?
-      semantics = to_semantic_values
-      body << I18n.t('blacklight.sms.text.title', value: semantics[:title].first) if semantics[:title].present?
-      body << I18n.t('blacklight.sms.text.author', value: semantics[:author].first) if semantics[:author].present?
-    end
-
-    return body.join unless body.empty?
-  end
-end

data/spec/features/sitelinks_search_box.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-describe 'Sitelinks search box' do
-  it 'is home page' do
-    visit root_path
-    expect(page).to have_css 'script[type="application/ld+json"]'
-  end
-
-  it 'on search page' do
-    visit search_catalog_path q: 'book'
-    expect(page).not_to have_css 'script[type="application/ld+json"]'
-  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/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