blacklight 8.0.0.beta4 → 8.0.0.beta6

data/spec/spec_helper.rb

@@ -68,7 +68,7 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.include PresenterTestHelpers, type: :presenter
   config.include ViewComponent::TestHelpers, type: :component
-  config.include ViewComponentCapybaraTestHelpers, type: :component
+  config.include ViewComponentTestHelpers, type: :component
 
   config.include(ControllerLevelHelpers, type: :helper)
   config.before(:each, type: :helper) { initialize_controller_helpers(helper) }

data/spec/support/view_component_test_helpers.rb

@@ -0,0 +1,21 @@
+# 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_helpers_controller if defined?(__vc_test_helpers_controller)
+
+    ApplicationController.new.extend(Rails.application.routes.url_helpers)
+  end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1,6 @@
 gem 'rails-controller-testing'
 gem 'thor', '~> 0.20' if /^5.[12]/.match?(ENV['RAILS_VERSION'])
+
+unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
+  gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -34,4 +34,12 @@ class TestAppGenerator < Rails::Generators::Base
 
     run "yarn add #{Blacklight::Engine.root}"
   end
+
+  def add_component_template_override
+    src_template = File.join(Blacklight::Engine.root, 'app', 'components', 'blacklight', 'top_navbar_component.html.erb')
+    target_template = File.join('app', 'components', 'blacklight', 'top_navbar_component.html.erb')
+    create_file(target_template) do
+      File.read(src_template).gsub('role="navigation"', 'role="navigation" data-template-override="top_navbar_component"')
+    end
+  end
 end

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

@@ -19,9 +19,30 @@ RSpec.describe "catalog/_document" do
     stub_template "catalog/_a_default.html.erb" => "a_partial"
     stub_template "catalog/_b_default.html.erb" => "b_partial"
     stub_template "catalog/_c_default.html.erb" => "c_partial"
-    render partial: "catalog/document", locals: { document: document, document_counter: 1 }
+    render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
     expect(rendered).to match /a_partial/
     expect(rendered).to match /b_partial/
     expect(rendered).to match /c_partial/
   end
+
+  context 'with a configured document component' do
+    let(:custom_component_class) do
+      Class.new(Blacklight::DocumentComponent) do
+        # Override component rendering with our own value
+        def call
+          'blah'
+        end
+      end
+    end
+
+    before do
+      stub_const('MyDocumentComponent', custom_component_class)
+      blacklight_config.index.document_component = MyDocumentComponent
+    end
+
+    it 'renders the document component' do
+      render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: blacklight_config.index }
+      expect(rendered).to match /blah/
+    end
+  end
 end

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

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 RSpec.describe "catalog/_document_list", type: :view do
+  let(:view_type) { 'some-view' }
+  let(:view_config) { double(Blacklight::Configuration::ViewConfig) }
+
   before do
-    allow(view).to receive_messages(document_index_view_type: "some-view", documents: [], blacklight_config: nil)
+    allow(view_config).to receive_messages(key: view_type, document_component: Blacklight::DocumentComponent, partials: [])
+    allow(view).to receive_messages(document_index_view_type: view_type, documents: [], blacklight_config: nil)
+    assign(:response, instance_double(Blacklight::Solr::Response, start: 0))
   end
 
   it "includes a class for the current view" do
-    render
+    render(partial: "catalog/document_list", locals: { view_config: view_config })
     expect(rendered).to have_selector(".documents-some-view")
   end
 end

data/tasks/blacklight.rake

@@ -43,7 +43,7 @@ end
 
 # rubocop:disable Rails/RakeEnvironment
 desc "Run test suite"
-task :ci do
+task ci: ['build:npm'] do
   with_solr do
     Rake::Task['blacklight:internal:seed'].invoke
     within_test_app do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 8.0.0.beta4
+  version: 8.0.0.beta6
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -375,12 +375,9 @@ 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
-- app/assets/javascripts/blacklight/blacklight.esm.js.map
-- app/assets/javascripts/blacklight/blacklight.js
-- app/assets/javascripts/blacklight/blacklight.js.map
 - app/assets/stylesheets/blacklight/_autocomplete.scss
 - app/assets/stylesheets/blacklight/_balanced_list.scss
 - app/assets/stylesheets/blacklight/_blacklight_base.scss
@@ -459,6 +456,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
@@ -476,8 +474,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
@@ -506,6 +506,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
@@ -531,12 +532,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
@@ -687,6 +686,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
@@ -777,7 +777,8 @@ files:
 - 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
@@ -792,9 +793,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
@@ -805,7 +808,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
@@ -820,6 +823,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
@@ -835,8 +839,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
@@ -879,7 +881,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
@@ -948,7 +950,8 @@ test_files:
 - 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
@@ -963,9 +966,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
@@ -976,7 +981,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
@@ -991,6 +996,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
@@ -1006,8 +1012,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
@@ -1050,7 +1054,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