blacklight 8.0.0 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf15f6dbb817f0839a3b5729997535274d21043ff834b4882cbd50af5ad37f05
-  data.tar.gz: 57101760654230e5c50eaae71bdaf2fc679230d2ed739ad2023a1f48cea7a2ea
+  metadata.gz: 788296244ed7711b196967fcc206a6b7836db4b384bcbbe7e062cdf9f29d8b06
+  data.tar.gz: 4f83e1cf3421afde9db8cd8bfb7fed298c5f3c5874de2f22f7e7a48db2fe5979
 SHA512:
-  metadata.gz: bd8d458da8677de400d1e96104fbb0d0831ba674a1d1790dbfcdf2b4e939cc270dc6b263f48d20e2ddd309f5cff7a312d003d573cb4ab5b9455ecd970c8caa99
-  data.tar.gz: f2f66d799ca0c97a97705fb8d9d7f71ac2f374a9d0f69ecf02e620a5223ee1a72054b3911c8025959276a26bb71d6b852d3ab196d7b151d1d5aea3964a720e93
+  metadata.gz: 193f6a74d712c28cd42a7354ff0da15b7e303b94e51a3854de54401a38ef2e444bf76a1878130fcef71d5286080943cc5635d46f3f38b8bce7c539d2af6f10fe
+  data.tar.gz: 0cf1904df3915ed93d122d54d653201b576c2b4027b182fdb88e6d02bcc9885bac69ecc9c7f6331f4dd3d9ca7f637600e869a5edcb106dad03b2c88868e77e86

data/VERSION

@@ -1 +1 @@
-8.0.0
+8.0.1

data/app/components/blacklight/document/sidebar_component.html.erb

@@ -1,2 +1,2 @@
-<%= render 'show_tools', document: document %>
+<%= render_show_tools %>
 <%= render(Blacklight::Document::MoreLikeThisComponent.new(document: document)) %>

data/app/components/blacklight/document/sidebar_component.rb

@@ -11,6 +11,18 @@ module Blacklight
       end
 
       attr_reader :document
+
+      delegate :blacklight_config, to: :helpers
+
+      private
+
+      def render_show_tools
+        blacklight_config.view_config(:show).show_tools_component&.tap do |show_tools_component_class|
+          return render show_tools_component_class.new(document: document)
+        end
+
+        render 'show_tools', document: document, silence_deprecation: helpers.partial_from_blacklight?('show_tools')
+      end
     end
   end
 end

data/app/components/blacklight/response/pagination_component.html.erb

@@ -1,3 +1,3 @@
-<%= content_tag :section, class: 'pagination',  **@html_attr do %>
+<%= content_tag :section, class: 'pagination',  **html_attr do %>
   <%= pagination %>
 <% end %>

data/app/components/blacklight/response/pagination_component.rb

@@ -8,10 +8,14 @@ module Blacklight
       # @param [Hash] html html options for the pagination container
       def initialize(response:, html: {}, **pagination_args)
         @response = response
-        @html_attr = { aria: { label: t('views.pagination.aria.container_label') } }.merge(html)
+        @html = html
         @pagination_args = pagination_args
       end
 
+      def html_attr
+        { aria: { label: t('views.pagination.aria.container_label') } }.merge(@html)
+      end
+
       def pagination
         helpers.paginate @response, **Blacklight::Engine.config.blacklight.default_pagination_options, **@pagination_args
       end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -37,4 +37,14 @@ module Blacklight::BlacklightHelperBehavior
     self.formats = old_formats
     nil
   end
+
+  def self.blacklight_gem_path
+    @blacklight_gem_path ||= Gem.loaded_specs["blacklight"].full_gem_path
+  end
+
+  def partial_from_blacklight?(partial)
+    path = lookup_context.find_all(partial, lookup_context.prefixes + [""], true).first&.identifier
+
+    path.nil? ? false : path.starts_with?(Blacklight::BlacklightHelperBehavior.blacklight_gem_path)
+  end
 end

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

@@ -1 +1,2 @@
+<% Blacklight.deprecation.warn('The partial _show_tools.html.erb will be removed in 9.0. Configure blacklight_config.show.show_tools_component instead (default Blacklight::Document::ShowToolsComponent).') unless local_assigns[:silence_deprecation] %>
 <%= render Blacklight::Document::ShowToolsComponent.new(document: document) %>

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

@@ -5,9 +5,6 @@
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 
-    <!-- Internet Explorer use the highest version available -->
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-
     <title><%= render_page_title %></title>
     <script>
       document.querySelector('html').classList.remove('no-js');

data/lib/blacklight/configuration.rb

@@ -181,6 +181,9 @@ module Blacklight
         # document presenter class used by helpers and views
         document_presenter_class: nil,
         document_component: Blacklight::DocumentComponent,
+        # in Blacklight 9, the default show_tools_component configuration will
+        # be Blacklight::Document::ShowToolsComponent
+        show_tools_component: nil,
         sidebar_component: Blacklight::Document::SidebarComponent,
         display_type_field: nil,
         # the "field access" key to use to look up the document display fields

data/lib/railties/blacklight.rake

@@ -40,7 +40,7 @@ namespace :blacklight do
         exit 1
       end
     rescue => e
-      puts e.to_s
+      puts e
       exit 1
     end
 
@@ -70,7 +70,7 @@ namespace :blacklight do
         end
       rescue => e
         errors += 1
-        puts e.to_s
+        puts e
       end
 
       print " - search_results: "
@@ -92,7 +92,7 @@ namespace :blacklight do
         end
       rescue => e
         errors += 1
-        puts e.to_s
+        puts e
       end
 
       print " - fetch: "
@@ -112,7 +112,7 @@ namespace :blacklight do
         end
       rescue => e
         errors += 1
-        puts e.to_s
+        puts e
       end
 
       exit 1 if errors > 0

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.0.0",
-  "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=main)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=main)](https://coveralls.io/github/projectblacklight/blacklight?branch=main)",
+  "version": "8.0.1",
+  "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "module": "app/assets/javascripts/blacklight/blacklight.esm.js",
   "scripts": {

data/spec/components/blacklight/document/sidebar_component_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::Document::SidebarComponent, type: :component do
+  subject(:component) { described_class.new(presenter: document) }
+
+  let(:view_context) { controller.view_context }
+  let(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:document) { view_context.document_presenter(presented_document) }
+
+  let(:presented_document) { SolrDocument.new(id: 'x', title_tsim: 'Title') }
+
+  let(:blacklight_config) do
+    CatalogController.blacklight_config.deep_copy
+  end
+
+  let(:expected_html) { "<div class=\"expected-show_tools\">Expected Content</div>".html_safe }
+
+  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_context)
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+  end
+
+  describe '#render_show_tools' do
+    # rubocop:disable RSpec/SubjectStub
+    before do
+      allow(component).to receive(:render).with(an_instance_of(Blacklight::Document::MoreLikeThisComponent)).and_return("")
+    end
+
+    context "without a configured ShowTools component" do
+      before do
+        allow(component).to receive(:render).with('show_tools', document: presented_document, silence_deprecation: false).and_return(expected_html)
+      end
+
+      it 'renders show_tools partial' do
+        expect(rendered).to have_selector 'div[@class="expected-show_tools"]'
+      end
+    end
+
+    context "with a configured ShowTools component" do
+      let(:show_tools_component) { Class.new(Blacklight::Document::ShowToolsComponent) }
+
+      before do
+        blacklight_config.show.show_tools_component = show_tools_component
+        allow(component).to receive(:render).with(an_instance_of(show_tools_component)).and_return(expected_html)
+      end
+
+      it 'renders configured show_tools component' do
+        expect(rendered).to have_selector 'div[@class="expected-show_tools"]'
+      end
+    end
+    # rubocop:enable RSpec/SubjectStub
+  end
+end

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -50,10 +50,6 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
       MockDocument.use_extension(MockExtension)
 
-      def mock_document_app_helper_url *args
-        solr_document_url(*args)
-      end
-
       allow(request_context).to receive(:polymorphic_url) do |_, opts|
         "url.#{opts[:format]}"
       end
@@ -68,12 +64,10 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
         tmp_value = Capybara.ignore_hidden_elements
         Capybara.ignore_hidden_elements = false
         document.export_formats.each_pair do |format, _spec|
-          expect(subject).to have_selector("link[href$='.#{format}']") do |matches|
-            expect(matches).to have(1).match
-            tag = matches[0]
-            expect(tag.attributes["rel"].value).to eq "alternate"
-            expect(tag.attributes["title"].value).to eq format.to_s
-            expect(tag.attributes["href"].value).to eq mock_document_app_helper_url(document, format: format)
+          expect(subject).to have_selector("link[href$='.#{format}']", count: 1) do |tag|
+            expect(tag["rel"]).to eq "alternate"
+            expect(tag["title"]).to eq format.to_s
+            expect(tag["href"]).to eq "url.#{format}"
           end
         end
         Capybara.ignore_hidden_elements = tmp_value

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.0.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -771,6 +771,7 @@ files:
 - spec/components/blacklight/constraints_component_spec.rb
 - spec/components/blacklight/document/action_component_spec.rb
 - spec/components/blacklight/document/group_component_spec.rb
+- spec/components/blacklight/document/sidebar_component_spec.rb
 - spec/components/blacklight/document_component_spec.rb
 - spec/components/blacklight/document_metadata_component_spec.rb
 - spec/components/blacklight/facet_component_spec.rb
@@ -934,7 +935,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
@@ -945,6 +946,7 @@ test_files:
 - spec/components/blacklight/constraints_component_spec.rb
 - spec/components/blacklight/document/action_component_spec.rb
 - spec/components/blacklight/document/group_component_spec.rb
+- spec/components/blacklight/document/sidebar_component_spec.rb
 - spec/components/blacklight/document_component_spec.rb
 - spec/components/blacklight/document_metadata_component_spec.rb
 - spec/components/blacklight/facet_component_spec.rb