blacklight 8.0.0.beta7 → 8.0.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0662c318e51fa886e7bb99d4e1b92fe25475758a713f3cb294b1db20cdde838f
-  data.tar.gz: d5478a9723172b23520d55b0550b23c8b57d7f72aa26e5844e837f13cbc43cad
+  metadata.gz: bf6f2c77b039ffcb18b23c50795dd2acd9dd410e50749422a55a2d6b7f85d9aa
+  data.tar.gz: f5edad3ff59994077cbe368027d5af44ed1284cad8d561b8dba46e12a82a0688
 SHA512:
-  metadata.gz: '0818d78cb403856c00378967fdad5ce88ee63fe1cfbff4c22dc09b1dd9eaf29dc04834d4575f71b52a66a0fa227a47d059f3a5c519d38f34909c5c0f8e45362d'
-  data.tar.gz: 0566a3bc3a8ee90b05529d22819d9cca9253ff1c6ecedb300eb49b55a117c0735ffbcace049cf280f1bd13220be42ee80fd74794ec2fa402457b9bb9ec2801e5
+  metadata.gz: 4f8630de40970d3cd1422168e292445057172b55942eebd6fccbda3ca6be8141c89b9981ee459880b8185482d4c37d957803bcc610b87afa612876760085439d
+  data.tar.gz: 90e98ba147b335d833ca80b139776b89c622c18184a59e8c19083fa0b651983206ab209aa3b0429a673b34781a9cdfcc53dc6b12bafeaf74e4da575a00cd2151

data/VERSION

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

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
@@ -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/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-beta.8",
   "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,26 @@ 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
   end
 
   it 'renders partials' do

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,

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.beta8
 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-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails