blacklight 8.0.0.beta7 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0662c318e51fa886e7bb99d4e1b92fe25475758a713f3cb294b1db20cdde838f
-  data.tar.gz: d5478a9723172b23520d55b0550b23c8b57d7f72aa26e5844e837f13cbc43cad
+  metadata.gz: bf15f6dbb817f0839a3b5729997535274d21043ff834b4882cbd50af5ad37f05
+  data.tar.gz: 57101760654230e5c50eaae71bdaf2fc679230d2ed739ad2023a1f48cea7a2ea
 SHA512:
-  metadata.gz: '0818d78cb403856c00378967fdad5ce88ee63fe1cfbff4c22dc09b1dd9eaf29dc04834d4575f71b52a66a0fa227a47d059f3a5c519d38f34909c5c0f8e45362d'
-  data.tar.gz: 0566a3bc3a8ee90b05529d22819d9cca9253ff1c6ecedb300eb49b55a117c0735ffbcace049cf280f1bd13220be42ee80fd74794ec2fa402457b9bb9ec2801e5
+  metadata.gz: bd8d458da8677de400d1e96104fbb0d0831ba674a1d1790dbfcdf2b4e939cc270dc6b263f48d20e2ddd309f5cff7a312d003d573cb4ab5b9455ecd970c8caa99
+  data.tar.gz: f2f66d799ca0c97a97705fb8d9d7f71ac2f374a9d0f69ecf02e620a5223ee1a72054b3911c8025959276a26bb71d6b852d3ab196d7b151d1d5aea3964a720e93

data/VERSION

@@ -1 +1 @@
-8.0.0.beta7
+8.0.0

data/app/assets/config/blacklight/manifest.js

@@ -1,3 +1,3 @@
-//= link_tree ../../images
+//= link_tree ../../images .png
 //= link_directory ../../stylesheets .css
 //= link_tree ../../../javascript .js

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

@@ -0,0 +1,12 @@
+<div class="card show-tools">
+  <div class="card-header">
+    <h2 class="mb-0 h6"><%= t('blacklight.tools.title') %></h2>
+  </div>
+  <%= render Blacklight::Document::ActionsComponent.new(document: document,
+                                                        tag: 'ul',
+                                                        classes: 'list-group list-group-flush',
+                                                        wrapping_tag: 'li',
+                                                        wrapping_classes: 'list-group-item list-group-item-action',
+                                                        actions: actions,
+                                                        url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h)) %>
+</div>

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Document
+    # Render the tools that display on the sidebar of the show page
+    class ShowToolsComponent < Blacklight::Component
+      # @param [Blacklight::Document] document
+      def initialize(document:)
+        @document = document
+      end
+
+      attr_reader :document
+
+      def render?
+        helpers.show_doc_actions?
+      end
+
+      def actions
+        helpers.document_actions(document)
+      end
+    end
+  end
+end

data/app/components/blacklight/document_component.rb

@@ -6,15 +6,17 @@ module Blacklight
   ##
   # A component for rendering a single document
   #
-  # @note when subclassing this component, you must explicitly specify the collection parameter
-  #    as `document` and handle the `document` parameter in your initializer.
+  # @note when subclassing this component, if you override the initializer,
+  #    you must explicitly specify the counter variable `document_counter` even if you don't use it.
+  #    Otherwise view_component will not provide the count value when calling the component.
+  #
+  # @see https://viewcomponent.org/guide/collections.html#collection-counter
   #
   # @example
   #  class MyDocumentComponent < Blacklight::DocumentComponent
-  #    with_collection_parameter :document
-  #
-  #    def initialize(document:, **kwargs)
-  #      super(document: document, **kwargs)
+  #    def initialize(document_counter: nil, **kwargs)
+  #      super
+  #      ... custom code ...
   #    end
   #  end
   class DocumentComponent < Blacklight::Component
@@ -35,7 +37,7 @@ module Blacklight
 
     # The document title with some reasonable default behavior
     renders_one :title, (lambda do |*args, component: nil, **kwargs|
-      component ||= Blacklight::DocumentTitleComponent
+      component ||= @presenter&.view_config&.title_component || Blacklight::DocumentTitleComponent
 
       component.new(*args, counter: @counter, document: @document, presenter: @presenter, as: @title_component, actions: !@show, link_to_document: !@show, document_component: self, **kwargs)
     end)
@@ -54,7 +56,7 @@ module Blacklight
     renders_one :metadata, (lambda do |static_content = nil, *args, component: nil, fields: nil, **kwargs|
       next static_content if static_content.present?
 
-      component ||= Blacklight::DocumentMetadataComponent
+      component ||= @presenter&.view_config&.metadata_component || Blacklight::DocumentMetadataComponent
 
       component.new(*args, fields: fields || @presenter&.field_presenters || [], **kwargs)
     end)

data/app/components/blacklight/top_navbar_component.html.erb

@@ -1,6 +1,6 @@
 <nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
   <div class="<%= container_classes %>">
-    <%= link_to application_name, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo' %>
+    <%= logo_link %>
     <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>

data/app/components/blacklight/top_navbar_component.rb

@@ -9,5 +9,9 @@ module Blacklight
     attr_reader :blacklight_config
 
     delegate :application_name, :container_classes, to: :helpers
+
+    def logo_link(title: application_name)
+      link_to title, blacklight_config.logo_link, class: 'mb-0 navbar-brand navbar-logo'
+    end
   end
 end

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -59,6 +59,7 @@ render document_component.new(presenter: document_presenter(document), component
     if template
       template.render(self, locals.merge(document: doc))
     else
+      logger.warn("No template was found for base_name: '#{base_name}', view_type: '#{view_type}' in render_document_partial")
       ''
     end
   end

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

@@ -1,14 +1 @@
-<% if show_doc_actions? %>
-  <div class="card show-tools">
-    <div class="card-header">
-      <h2 class="mb-0 h6"><%= t('blacklight.tools.title') %></h2>
-    </div>
-    <%= render Blacklight::Document::ActionsComponent.new(document: document,
-                                                          tag: 'ul',
-                                                          classes: 'list-group list-group-flush',
-                                                          wrapping_tag: 'li',
-                                                          wrapping_classes: 'list-group-item list-group-item-action',
-                                                          actions: document_actions(document),
-                                                          url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h)) %>
-  </div>
-<% end %>
+<%= render Blacklight::Document::ShowToolsComponent.new(document: document) %>

data/lib/generators/blacklight/assets_generator.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'shellwords'
+
 module Blacklight
   class AssetsGenerator < Rails::Generators::Base
     class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
 
     def run_asset_pipeline_specific_generator
-      generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
       generator = if defined?(Propshaft)
                     'blacklight:assets:propshaft'

data/lib/generators/blacklight/install_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'shellwords'
+
 module Blacklight
   class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
@@ -35,7 +37,7 @@ module Blacklight
     # Call external generator in AssetsGenerator, so we can
     # leave that callable seperately too.
     def copy_public_assets
-      generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
       generate "blacklight:assets", generated_options unless options[:'skip-assets']
     end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.0.0-beta.7",
+  "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)",
   "main": "app/assets/javascripts/blacklight",
   "module": "app/assets/javascripts/blacklight/blacklight.esm.js",

data/spec/components/blacklight/document_component_spec.rb

@@ -76,6 +76,10 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
   end
 
   context 'index view' do
+    before do
+      controller.action_name = "index"
+    end
+
     let(:attr) { { counter: 5 } }
 
     it 'has data properties' do
@@ -111,13 +115,22 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     it 'renders a thumbnail' do
       expect(rendered).to have_selector 'a[href="/catalog/x"] img[src="http://example.com/image.jpg"]'
     end
+
+    context 'with default metadata component' do
+      it 'renders metadata' do
+        expect(rendered).to have_selector 'dl.document-metadata'
+        expect(rendered).to have_selector 'dt', text: 'Title:'
+        expect(rendered).to have_selector 'dd', text: 'Title'
+        expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
+      end
+    end
   end
 
   context 'show view' do
     let(:attr) { { title_component: :h1, show: true } }
 
     before do
-      allow(view_context).to receive(:action_name).and_return('show')
+      controller.action_name = "show"
     end
 
     it 'renders with an id' do
@@ -148,13 +161,46 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
       blacklight_config.show.embed_component = StubComponent
       expect(rendered).to have_content 'embed'
     end
-  end
 
-  it 'renders metadata' do
-    expect(rendered).to have_selector 'dl.document-metadata'
-    expect(rendered).to have_selector 'dt', text: 'Title:'
-    expect(rendered).to have_selector 'dd', text: 'Title'
-    expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
+    context 'with configured metadata component' do
+      let(:custom_component_class) do
+        Class.new(Blacklight::DocumentMetadataComponent) do
+          # Override component rendering with our own value
+          def call
+            'blah'
+          end
+        end
+      end
+
+      before do
+        stub_const('MyMetadataComponent', custom_component_class)
+        blacklight_config.show.metadata_component = MyMetadataComponent
+      end
+
+      it 'renders custom component' do
+        expect(rendered).to have_text 'blah'
+      end
+    end
+
+    context 'with configured title component' do
+      let(:custom_component_class) do
+        Class.new(Blacklight::DocumentTitleComponent) do
+          # Override component rendering with our own value
+          def call
+            'Titleriffic'
+          end
+        end
+      end
+
+      before do
+        stub_const('MyTitleComponent', custom_component_class)
+        blacklight_config.show.title_component = MyTitleComponent
+      end
+
+      it 'renders custom component' do
+        expect(rendered).to have_text 'Titleriffic'
+      end
+    end
   end
 
   it 'renders partials' do

data/spec/components/blacklight/header_component_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::HeaderComponent, type: :component do
+  before do
+    with_controller_class(CatalogController) do
+      allow(controller).to receive(:current_user).and_return(nil)
+      allow(controller).to receive(:search_action_url).and_return('/search')
+      render
+    end
+  end
+
+  context 'with no slots' do
+    let(:render) { render_inline(described_class.new(blacklight_config: CatalogController.blacklight_config)) }
+
+    it 'draws the topbar' do
+      expect(page).to have_css 'nav.topbar'
+      expect(page).to have_link 'Blacklight', href: '/'
+    end
+  end
+end

data/spec/components/blacklight/response/view_type_component_spec.rb

@@ -11,7 +11,24 @@ RSpec.describe Blacklight::Response::ViewTypeComponent, type: :component do
   let(:search_state) { instance_double(Blacklight::SearchState, to_h: { controller: 'catalog', action: 'index' }) }
   let(:view_config) { Blacklight::Configuration::ViewConfig.new }
 
+  let(:custom_component_class) do
+    Class.new(Blacklight::Icons::IconComponent) do
+      # Override component rendering with our own value
+      def call
+        'blah'
+      end
+    end
+  end
+
+  before do
+    stub_const('Blacklight::Icons::DefComponent', custom_component_class)
+  end
+
   describe "when some views exist" do
+    before do
+      stub_const('Blacklight::Icons::AbcComponent', custom_component_class)
+    end
+
     let(:views) do
       {
         abc: view_config,

data/spec/controllers/catalog_controller_spec.rb

@@ -158,7 +158,7 @@ RSpec.describe CatalogController, api: true do
 
         format = facets.find { |x| x['id'] == 'format' }
 
-        expect(format['attributes']['items'].pluck('attributes')).to match_array([{ "value" => "Book", "hits" => 30, "label" => "Book" }])
+        expect(format['attributes']['items'].pluck('attributes')).to contain_exactly({ "value" => "Book", "hits" => 30, "label" => "Book" })
         expect(format['links']['self']).to eq facet_catalog_url(format: :json, id: 'format')
         expect(format['attributes']['items'].first['links']['self']).to eq search_catalog_url(format: :json, f: { format: ['Book'] })
       end

data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb

@@ -76,7 +76,7 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
 
     it "sorts the underlying hash" do
       sorted = subject.sort_by { |_k, v| v }
-      expect(sorted.keys).to match_array [:b, :a, :c]
+      expect(sorted.keys).to contain_exactly(:b, :a, :c)
     end
   end
 
@@ -85,7 +85,7 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
 
     it "sorts the underlying hash" do
       subject.sort_by! { |_k, v| v }
-      expect(subject.keys).to match_array [:b, :a, :c]
+      expect(subject.keys).to contain_exactly(:b, :a, :c)
     end
   end
 

data/spec/models/blacklight/configuration_spec.rb

@@ -172,8 +172,8 @@ RSpec.describe "Blacklight::Configuration", api: true do
 
       expect(config.a[:value]).to eq 1
       expect(config_copy.a[:value]).to eq 2
-      expect(config.b).to match_array [1, 2, 3]
-      expect(config_copy.b).to match_array [1, 2, 3, 5]
+      expect(config.b).to contain_exactly(1, 2, 3)
+      expect(config_copy.b).to contain_exactly(1, 2, 3, 5)
       expect(config.c.value).to match_array %w[a b]
       expect(config_copy.c.value).to match_array %w[a b c]
     end

data/spec/models/blacklight/search_builder_spec.rb

@@ -45,7 +45,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
 
     it "is mutable" do
       subject.processor_chain.insert(-1, :d)
-      expect(subject.processor_chain).to match_array [:a, :b, :c, :d]
+      expect(subject.processor_chain).to contain_exactly(:a, :b, :c, :d)
     end
   end
 
@@ -56,7 +56,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       builder = subject.append(:d, :e)
       expect(subject.processor_chain).to eq processor_chain
       expect(builder.processor_chain).not_to eq subject.processor_chain
-      expect(builder.processor_chain).to match_array [:a, :b, :c, :d, :e]
+      expect(builder.processor_chain).to contain_exactly(:a, :b, :c, :d, :e)
     end
   end
 
@@ -68,7 +68,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       expect(builder).not_to equal(subject)
       expect(subject.processor_chain).to eq processor_chain
       expect(builder.processor_chain).not_to eq subject.processor_chain
-      expect(builder.processor_chain).to match_array [:a, :c, :e]
+      expect(builder.processor_chain).to contain_exactly(:a, :c, :e)
     end
   end
 

data/spec/models/blacklight/solr/request_spec.rb

@@ -45,7 +45,7 @@ RSpec.describe Blacklight::Solr::Request, api: true do
       subject.append_query 'this is my query'
       subject.append_query 'another:query'
       expect(subject).not_to have_key 'q'
-      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['this is my query', 'another:query']
+      expect(subject.dig('json', 'query', 'bool', 'must')).to contain_exactly('this is my query', 'another:query')
     end
   end
 
@@ -62,7 +62,7 @@ RSpec.describe Blacklight::Solr::Request, api: true do
       subject['q'] = 'some query'
       subject.append_boolean_query :must, 'also required'
 
-      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['some query', 'also required']
+      expect(subject.dig('json', 'query', 'bool', 'must')).to contain_exactly('some query', 'also required')
     end
   end
 end

data/spec/support/view_component_test_helpers.rb

@@ -14,7 +14,7 @@ module ViewComponentTestHelpers
     return super if defined?(super)
 
     # ViewComponent 3.x
-    return __vc_test_helpers_controller if defined?(__vc_test_helpers_controller)
+    return vc_test_controller if defined?(vc_test_controller)
 
     ApplicationController.new.extend(Rails.application.routes.url_helpers)
   end

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

@@ -3,10 +3,10 @@
 RSpec.describe "catalog/_show_tools.html.erb" do
   let(:document) { SolrDocument.new id: 'xyz', format: 'a' }
   let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:component) { instance_double(Blacklight::Document::ActionsComponent) }
+  let(:component) { instance_double(Blacklight::Document::ShowToolsComponent) }
 
   before do
-    allow(Blacklight::Document::ActionsComponent).to receive(:new).and_return(component)
+    allow(Blacklight::Document::ShowToolsComponent).to receive(:new).and_return(component)
     allow(view).to receive(:render).with(component)
     allow(view).to receive(:render).with('catalog/show_tools', { document: document }).and_call_original
     allow(view).to receive(:blacklight_config).and_return blacklight_config

data/spec/views/catalog/index.json.jbuilder_spec.rb

@@ -93,7 +93,7 @@ RSpec.describe "catalog/index.json", api: true do
         expect(facets.pluck('id')).to include 'format'
         expect(format['links']).to include self: 'http://test.host/some/facet/url'
         expect(format['attributes']['label']).to eq 'Format'
-        expect(format_item_attributes).to match_array [{ value: 'Book', hits: 30, label: 'Book' }]
+        expect(format_item_attributes).to contain_exactly({ value: 'Book', hits: 30, label: 'Book' })
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 8.0.0.beta7
+  version: 8.0.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -423,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
@@ -776,6 +778,7 @@ 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
@@ -927,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)
@@ -949,6 +952,7 @@ 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