blacklight 7.33.0 → 8.0.0

data/app/views/catalog/index.html.erb

@@ -1,5 +1,11 @@
+<% content_for(:head) do %>
+  <meta name="blacklight-search-storage" content="<%= blacklight_config.track_search_session.storage %>">
+<% end %>
 <% content_for(:sidebar) do %>
-  <%= render 'search_sidebar' %>
+  <% conf = blacklight_config.view_config(document_index_view_type) %>
+  <%= render conf.sidebar_component.new(blacklight_config: blacklight_config,
+                                        response: @response,
+                                        view_config: conf) %>
 <% end %>
 
 <% unless has_search_parameters? %>

data/app/views/catalog/index.json.jbuilder

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 json.links do
   json.self url_for(search_state.to_h.merge(only_path: false))
   json.prev url_for(search_state.to_h.merge(only_path: false, page: @response.prev_page.to_s)) if @response.prev_page
@@ -13,7 +14,7 @@ end
 json.data do
   json.array! @presenter.documents do |document|
     doc_presenter = document_presenter(document)
-    document_url = Deprecation.silence(Blacklight::UrlHelperBehavior) { polymorphic_url(url_for_document(document)) }
+    document_url = polymorphic_url(search_state.url_for_document(document))
     json.id document.id
     json.type doc_presenter.display_type.first
     json.attributes do
@@ -51,14 +52,10 @@ json.included do
             json.hits item.hits
           end
           json.links do
-            Deprecation.silence(Blacklight::FacetsHelperBehavior) do
-              if facet_in_params?(facet.name, item.value)
-                Deprecation.silence(Blacklight::SearchState) do
-                  json.remove search_action_path(search_state.remove_facet_params(facet.name, item.value))
-                end
-              else
-                json.self path_for_facet(facet.name, item.value, only_path: false)
-              end
+            if search_state.filter(facet_config).include?(facet_value_for_facet_item(item.value))
+              json.remove search_action_path(search_state.filter(facet.name).remove(item.value))
+            else
+              json.self facet_item_presenter(facet_config, item.value, facet.name).href(only_path: false)
             end
           end
         end
@@ -69,16 +66,19 @@ json.included do
     end
   end
 
-  Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-    json.array! search_fields do |(label, key)|
-      json.type 'search_field'
-      json.id key
-      json.attributes do
-        json.label label
-      end
-      json.links do
-        json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
-      end
+  search_fields = blacklight_config.search_fields
+                                   .values
+                                   .select { |field_def| should_render_field?(field_def) }
+                                   .collect { |field_def| [label_for_search_field(field_def.key), field_def.key] }
+
+  json.array! search_fields do |(label, key)|
+    json.type 'search_field'
+    json.id key
+    json.attributes do
+      json.label label
+    end
+    json.links do
+      json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
     end
   end
 

data/app/views/catalog/index.rss.builder

@@ -4,7 +4,7 @@ xml.instruct! :xml, version: "1.0"
 xml.rss(version: "2.0") {
   xml.channel {
     xml.title(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
-    xml.link(search_action_url(params.to_unsafe_h))
+    xml.link(search_action_url(search_state.to_h.merge(only_path: false)))
     xml.description(t('blacklight.search.page_title.title', constraints: render_search_to_page_title(params), application_name: application_name))
     xml.language('en-us')
     @response.documents.each_with_index do |document, document_counter|

data/app/views/catalog/opensearch.xml.builder

@@ -8,5 +8,5 @@ xml.OpenSearchDescription(xmlns: 'http://a9.com/-/spec/opensearch/1.1/') {
   xml.Contact
   xml.Url type: 'text/html', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}?q={searchTerms}&page={startPage?}"
   xml.Url type: 'application/rss+xml', method: 'get', template: "#{url_for controller: 'catalog', only_path: false}.rss?q={searchTerms}&page={startPage?}"
-  xml.Url type: 'application/x-suggestions+json', method: 'get', template: "#{url_for controller: 'catalog',action: 'opensearch', format: 'json', only_path: false}?q={searchTerms}"
+  xml.Url type: 'application/x-suggestions+json', method: 'get', template: "#{url_for controller: 'catalog', action: 'opensearch', format: 'json', only_path: false}?q={searchTerms}"
 }

data/app/views/catalog/show.html.erb

@@ -1,9 +1,4 @@
-<% if current_search_session %>
-  <div id="appliedParams" class="clearfix constraints-container">
-    <%= render 'start_over' %>
-    <%= link_back_to_catalog class: 'btn btn-outline-secondary' %>
-  </div>
-<% end %>
+<%= render blacklight_config.track_search_session.applied_params_component.new if blacklight_config.track_search_session.applied_params_component %>
 
 <%= render 'show_main_content' %>
 

data/app/views/catalog/sms_success.html.erb

@@ -1,6 +1,5 @@
-<%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.title { t('blacklight.sms.form.title') } %>
-
-  <%= render partial: '/shared/flash_msg' %>
-  <span data-blacklight-modal="close"></span>
-<% end %>
+<turbo-stream action="append" target="main-flashes">
+  <template>
+    <%= render '/shared/flash_msg' %>
+  </template>
+</turbo-stream>

data/app/views/catalog/suggest.html.erb

@@ -0,0 +1,3 @@
+<% @suggestions.each do |suggestion| %>
+  <li role="option"><span><%= suggestion['term'] %></span></li>
+<% end %>

data/app/views/layouts/blacklight/base.html.erb

@@ -14,8 +14,18 @@
     </script>
     <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
     <%= favicon_link_tag %>
-    <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload" %>
-    <%= javascript_include_tag "application", "data-turbo-track": "reload" %>
+    <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload"  %>
+    <% if defined? Importmap %>
+      <%= javascript_importmap_tags %>
+    <% elsif defined? Propshaft %>
+      <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+    <% else %>
+      <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+      <%= javascript_include_tag "blacklight/blacklight", type: 'module' %>
+      <script type="module">
+        import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
+      </script>
+    <% end %>
 
     <%= csrf_meta_tags %>
     <%= content_for(:head) %>
@@ -28,15 +38,15 @@
     </nav>
     <%= render partial: 'shared/header_navbar' %>
 
-  <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
-    <%= content_for(:container_header) %>
+    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+      <%= content_for(:container_header) %>
 
-    <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
+      <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
 
-    <div class="row">
-      <%= content_for?(:content) ? yield(:content) : yield %>
-    </div>
-  </main>
+      <div class="row">
+        <%= content_for?(:content) ? yield(:content) : yield %>
+      </div>
+    </main>
 
     <%= render partial: 'shared/footer' %>
     <%= render partial: 'shared/modal' %>

data/app/views/record_mailer/email_record.text.erb

@@ -1,6 +1,7 @@
+<%= t('blacklight.email.text.message', message: @message) %>
+
 <% @documents.each do |document| %>
-<%= document.to_email_text %>
-<%= t('blacklight.email.text.url', :url =>polymorphic_url(document, @url_gen_params)) %>
+  <%= render Blacklight::DocumentMetadataComponent.new(fields: document_presenter(document).field_presenters(blacklight_config.email_fields), tag: nil, field_layout: Blacklight::MetadataFieldPlainTextLayoutComponent, field_presenter_options: { format: 'text' }) %>
 
+  <%= t('blacklight.email.text.url', url: polymorphic_url(document, @url_gen_params)) %>
 <% end %>
-<%= t('blacklight.email.text.message', :message => @message) %>

data/app/views/record_mailer/sms_record.text.erb

@@ -1,4 +1,4 @@
-<% @documents.each do |document| %>
-<%= document.to_sms_text(@config) %>
-<%= t('blacklight.sms.text.url', :url => polymorphic_url(document, @url_gen_params) ) %>
-<% end %>
+<% @documents.each do |document| %>
+  <%= render Blacklight::DocumentMetadataComponent.new(fields: document_presenter(document).field_presenters(blacklight_config.sms_fields), tag: nil, field_layout: Blacklight::MetadataFieldPlainTextLayoutComponent, field_presenter_options: { format: 'text' }) %>
+  <%= t('blacklight.sms.text.url', url: polymorphic_url(document, @url_gen_params)) %>
+<% end %>

data/app/views/search_history/index.html.erb

@@ -7,8 +7,12 @@
 <% else %>
   <%= link_to t('blacklight.search_history.clear.action_title'),
               blacklight.clear_search_history_path,
-              method: :delete,
-              data: { confirm: t('blacklight.search_history.clear.action_confirm') },
+              method: :delete, # for rails-ujs
+              data: {
+                confirm: t('blacklight.search_history.clear.action_confirm'), # for rails-ujs
+                turbo_confirm: t('blacklight.search_history.clear.action_confirm'),
+                turbo_method: :delete
+              },
               class: 'btn btn-danger float-md-right float-md-end' %>
   <h2 class='section-heading'><%= t('blacklight.search_history.recent') %></h2>
   <table class="table table-striped search-history">

data/app/views/shared/_header_navbar.html.erb

@@ -1,22 +1 @@
-<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
-  <div class="<%= container_classes %>">
-    <%= link_to application_name, root_path, class: 'mb-0 navbar-brand navbar-logo' %>
-    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
-      <span class="navbar-toggler-icon"></span>
-    </button>
-
-    <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
-      <%= render 'shared/user_util_links' %>
-    </div>
-  </div>
-</nav>
-
-<%= content_tag :div, class: 'navbar-search navbar navbar-light bg-light', role: 'navigation', aria: { label: t('blacklight.search.header') } do %>
-  <div class="<%= container_classes %>">
-    <%= render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component ||Blacklight::SearchBarComponent).new(
-          url: search_action_url,
-          advanced_search_url: search_action_url(action: 'advanced_search'),
-          params: search_state.params_for_search.except(:qt),
-          autocomplete_path: search_action_path(action: :suggest))) %>
-  </div>
-<% end %>
+<%= render blacklight_config.header_component.new(blacklight_config: blacklight_config) %>

data/app/views/shared/_modal.html.erb

@@ -1,6 +1,6 @@
-<div id="blacklight-modal" class="modal fade" tabindex="-1" role="dialog" aria-hidden="true">
-  <div class="modal-dialog modal-lg" role="document">
+<dialog id="blacklight-modal" class="modal" data-turbo="false">
+  <div class="modal-dialog modal-lg">
     <div class="modal-content">
     </div>
   </div>
-</div>
+</dialog>

data/blacklight.gemspec

@@ -17,26 +17,24 @@ Gem::Specification.new do |s|
     full text and/or metadata.)
   s.license     = "Apache 2.0"
 
-  s.files         = `git ls-files -z`.split("\x0")
+  s.files         = `git ls-files -z`.split("\x0") + Dir.glob("app/assets/javascripts/blacklight/**/*")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 2.7'
 
-  s.add_dependency "rails", '>= 5.1', '< 7.1'
+  s.add_dependency "rails", '>= 6.1', '< 8'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
-  s.add_dependency "deprecation"
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '~> 2.66'
-  s.add_dependency 'hashdiff'
+  s.add_dependency "view_component", '>= 2.66', '< 3.1'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
-  s.add_development_dependency "rspec-rails", "~> 5.0"
+  s.add_development_dependency "rspec-rails", "~> 6.0"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency 'axe-core-rspec'
   s.add_development_dependency "capybara", '~> 3'
@@ -45,9 +43,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov"
-  s.add_development_dependency "rubocop", '~> 0.85'
-  s.add_development_dependency "rubocop-rails", '~> 2.6'
-  s.add_development_dependency "rubocop-rspec", '~> 1.43'
+  s.add_development_dependency "rubocop", '~> 1.0'
+  s.add_development_dependency "rubocop-rails"
+  s.add_development_dependency "rubocop-rspec"
   s.add_development_dependency "i18n-tasks"
   s.add_development_dependency "solr_wrapper"
 end

data/config/importmap.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+pin_all_from File.expand_path("../app/javascript/blacklight", __dir__), under: "blacklight"