blacklight 7.39.0 → 7.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f22fe88564a62b7817f8f70d715f3bb41c52e742e397a5276e7b6adb5fd82c4
-  data.tar.gz: 556f88d174f56f549955b8d505446f2ee06f75738bac240ba69658bea52f40d0
+  metadata.gz: 4e1a5889b0f9dee50b64165ffe292482619e54780bac24b14af00b3b1cba2fdd
+  data.tar.gz: 0ed718e93da4bca43bb242e5a97c6ced3546aa8ec9f17d18ce00a444dca95d93
 SHA512:
-  metadata.gz: ad3e2e137494e604fe6253a78bf960c6a933c3c6d863bb3c873eec700a91a25743a9e348b61f8bfdc4f446864318e11fd7a79bcd158b89f56ce285276f97cf11
-  data.tar.gz: 0bba87c8470d46409e7483d52bd33ca013b17ee8090ee0c68e38827afbcd3664acd1ca14f98b547c213ffadf1d8ead1514b0ac2316bddf007c50afd603777ad5
+  metadata.gz: ee5a1dc4ddb014510defa98a6c36a3d0e3ef9913c5cce5195878c688d062f7b95e3b30b376558adbc300ce4586f894e2e2af75dac933bc621c5401e2f7cf1eff
+  data.tar.gz: 0cd9ec1e44e68aeae47dbc86f95e18f1402831579b94d942c6ed4e9b264eab2b1f698bbe776616f962b4f6f28b4fe0fedb1e8e6d37aeb4b5be376425cd7d795d

data/.env

@@ -1,6 +1,6 @@
 ALPINE_RUBY_VERSION=3.2.2
 RAILS_VERSION=7.0.8
-VIEW_COMPONENT_VERSION=2.66.0
+VIEW_COMPONENT_VERSION=2.74.0
 SOLR_PORT=8983
 SOLR_URL=http://solr:8983/solr/blacklight-core
 SOLR_VERSION=latest

data/.github/workflows/ruby.yml

@@ -109,14 +109,14 @@ jobs:
       run: bundle exec rake ci
       env:
         ENGINE_CART_RAILS_OPTIONS: '--skip-keeps --skip-test'
-  test_vc3:
+  test_vc2:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby: ['3.2']
     env:
       RAILS_VERSION: 7.0.8
-      VIEW_COMPONENT_VERSION: ${{ matrix.view_component_version }}
+      VIEW_COMPONENT_VERSION: "~> 2.74"
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.rubocop.yml

@@ -42,6 +42,7 @@ Metrics/ClassLength:
     - "lib/blacklight/search_builder.rb"
     - "lib/blacklight/search_state.rb"
     - "lib/blacklight/search_state/filter_field.rb"
+    - "app/presenters/blacklight/document_presenter.rb"
 
 Layout/LineLength:
   Max: 200

data/VERSION

@@ -1 +1 @@
-7.39.0
+7.40.0

data/app/presenters/blacklight/document_presenter.rb

@@ -11,18 +11,26 @@ module Blacklight
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
-    def initialize(document, view_context, configuration = view_context.blacklight_config)
+    def initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {})
       @document = document
       @view_context = view_context
       @configuration = configuration
+      @view_config = view_config
+      @field_presenter_options = field_presenter_options
     end
 
     # @return [Hash<String,Configuration::Field>]  all the fields for this index view that should be rendered
-    def fields_to_render
-      return to_enum(:fields_to_render) unless block_given?
+    def fields_to_render(document_fields = fields, **kwargs)
+      unless block_given?
+        return to_enum(:fields_to_render, document_fields, **kwargs) unless method(:fields_to_render).arity.zero?
 
-      fields.each do |name, field_config|
-        field_presenter = field_presenter(field_config)
+        Deprecation.warn(self.class, 'In Blacklight 8, Blacklight::DocumentPresenter#fields_to_render accepts additional arguments')
+
+        return to_enum(:fields_to_render)
+      end
+
+      document_fields.each do |name, field_config|
+        field_presenter = field_presenter(field_config, kwargs)
 
         next unless field_presenter.render_field? && field_presenter.any?
 
@@ -30,10 +38,21 @@ module Blacklight
       end
     end
 
-    def field_presenters
-      return to_enum(:field_presenters) unless block_given?
+    def field_presenters(document_fields = fields, **kwargs)
+      unless block_given?
+        return to_enum(:field_presenters, document_fields, **kwargs) unless method(:field_presenters).arity.zero?
+
+        Deprecation.warn(self.class, 'In Blacklight 8, Blacklight::DocumentPresenter#field_presenters accepts additional arguments')
 
-      fields_to_render.each { |_, _, config| yield config }
+        return to_enum(:field_presenters)
+      end
+
+      if method(:fields_to_render).arity.zero?
+        Deprecation.warn(self.class, 'In Blacklight 8, Blacklight::DocumentPresenter#fields_to_render accept additional arguments')
+        fields_to_render.each { |_, _, config| yield config }
+      else
+        fields_to_render(document_fields, **kwargs).each { |_, _, config| yield config }
+      end
     end
 
     ##
@@ -122,7 +141,7 @@ module Blacklight
     end
 
     def show_view_config
-      configuration.view_config(:show)
+      configuration.view_config(:show, action_name: view_context.action_name)
     end
 
     def inspect
@@ -158,7 +177,7 @@ module Blacklight
     end
 
     def field_presenter_options
-      {}
+      @field_presenter_options ||= {}
     end
   end
 end

data/app/presenters/blacklight/index_presenter.rb

@@ -30,7 +30,7 @@ module Blacklight
     deprecation_deprecate label: 'Use #heading'
 
     def view_config
-      @view_config ||= configuration.view_config(view_context.document_index_view_type)
+      @view_config ||= configuration.view_config(view_context.document_index_view_type, action_name: view_context.action_name)
     end
 
     private

data/blacklight.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   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', '< 4'
+  s.add_dependency "view_component", '>= 2.74', '< 4'
   s.add_dependency 'hashdiff'
   s.add_dependency "zeitwerk"
 

data/lib/blacklight/component.rb

@@ -3,57 +3,20 @@
 module Blacklight
   class Component < ViewComponent::Base
     class << self
-      # Workaround for https://github.com/ViewComponent/view_component/issues/1565
-      def config
-        @config ||= ViewComponent::Config.defaults.merge(ViewComponent::Base.config)
-      end
+      alias upstream_sidecar_files sidecar_files
 
-      # rubocop:disable Naming/MemoizedInstanceVariableName
-      def compiler
-        @__vc_compiler ||= EngineCompiler.new(self)
+      def reset_compiler!
+        @__vc_compiler = nil
       end
-      # rubocop:enable Naming/MemoizedInstanceVariableName
-
-      alias sidecar_files _sidecar_files unless ViewComponent::Base.respond_to? :sidecar_files
-    end
-
-    EXCLUDE_VARIABLES = [
-      :@lookup_context, :@view_renderer, :@view_flow, :@view_context,
-      :@tag_builder, :@current_template,
-      :@__vc_set_slots, :@__vc_original_view_context,
-      :@__vc_variant, :@__vc_content_evaluated,
-      :@__vc_render_in_block, :@__vc_content, :@__vc_helpers
-    ].freeze
-
-    def inspect
-      # Exclude variables added by render_in
-      render_variables = instance_variables - EXCLUDE_VARIABLES
-      fields = render_variables.map { |ivar| "#{ivar}:#{instance_variable_get(ivar).inspect}" }.join(', ')
-      "#<#{self.class.name}:#{object_id} #{fields}>"
-    end
-
-    class EngineCompiler < ::ViewComponent::Compiler
-      # ViewComponent::Compiler locates and caches templates from sidecar files to the component source file.
-      # While this is sensible in a Rails application, it prevents component templates defined in an Engine
-      # from being overridden by an installing application without subclassing the component, which may also
-      # require modifying any partials rendering the component. This subclass of compiler overrides the template
-      # location algorithm to take the sidecar file names from the Engine, but look to see if a file of the
-      # same name existing in the installing application (ie, under Rails.root). If the latter exists, this
-      # compiler will cache that template instead of the engine-defined file; if not, the compiler will fall
-      # back to the engine-defined file.
-      def templates
-        @templates ||= begin
-          extensions = ActionView::Template.template_handler_extensions
 
-          component_class.sidecar_files(extensions).each_with_object([]) do |path, memo|
-            pieces = File.basename(path).split(".")
-            app_path = "#{Rails.root}/#{path.slice(path.index(component_class.view_component_path)..-1)}"
+      def sidecar_files(*args, **kwargs)
+        upstream_sidecar_files(*args, **kwargs).map do |path|
+          app_path = Rails.root.join(path.slice(path.index(view_component_path)..-1).to_s).to_s
 
-            memo << {
-              path: File.exist?(app_path) ? app_path : path,
-              variant: pieces.second.split("+").second&.to_sym,
-              handler: pieces.last
-            }
+          if File.exist?(app_path)
+            app_path
+          else
+            path
           end
         end
       end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.39.0",
+  "version": "7.40.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {

data/spec/lib/blacklight/component_spec.rb

@@ -1,43 +1,48 @@
 # frozen_string_literal: true
 
-RSpec.describe Blacklight::Component do
-  let(:component_class) { Blacklight::DocumentTitleComponent }
+RSpec.describe Blacklight::Component, type: :component do
+  let(:component_class) { Blacklight::System::ModalComponent }
 
-  context "subclassed" do
-    it "returns our Compiler implementation" do
-      expect(component_class.ancestors).to include described_class
-      expect(component_class.compiler).to be_a Blacklight::Component::EngineCompiler
+  before do
+    component_class.reset_compiler!
+    ViewComponent::CompileCache.invalidate!
+
+    component_class.class_eval do
+      undef :call if method_defined?(:call)
     end
   end
 
-  describe Blacklight::Component::EngineCompiler do
-    subject(:compiler) { described_class.new(component_class) }
+  after do
+    component_class.reset_compiler!
+    ViewComponent::CompileCache.invalidate!
 
-    let(:original_compiler) { ViewComponent::Compiler.new(component_class) }
-    let(:original_path) { original_compiler.send(:templates).first[:path] }
-    let(:resolved_path) { compiler.templates.first[:path] }
+    component_class.class_eval do
+      undef :call if method_defined?(:call)
+    end
+  end
 
-    context "without overrides" do
-      it "links to engine template" do
-        expect(resolved_path).not_to include(".internal_test_app")
-        expect(resolved_path).to eql(original_path)
-      end
+  context "without overrides" do
+    it "renders the engine template" do
+      render_inline(component_class.new)
+      expect(page).to have_css('.modal-header')
     end
+  end
 
-    context "with overrides" do
-      let(:path_match) do
-        Regexp.new(Regexp.escape(File.join(".internal_test_app", component_class.view_component_path)))
+  context "with overrides" do
+    around do |ex|
+      FileUtils.mkdir_p(Rails.root.join('app/components/blacklight/system'))
+      Rails.root.join("app/components/blacklight/system/modal_component.html.erb").open("w") do |f|
+        f.puts '<div class="custom-modal">Overridden</div>'
       end
 
-      before do
-        allow(File).to receive(:exist?).and_call_original
-        allow(File).to receive(:exist?).with(path_match).and_return(true)
-      end
+      ex.run
+    ensure
+      Rails.root.join('app/components/blacklight/system/modal_component.html.erb').unlink
+    end
 
-      it "links to application template" do
-        expect(resolved_path).to include(".internal_test_app")
-        expect(resolved_path).not_to eql(original_path)
-      end
+    it "renders to application template" do
+      render_inline(component_class.new)
+      expect(page).to have_css('.custom-modal')
     end
   end
 end

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe Blacklight::DocumentPresenter do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
+    allow(request_context).to receive(:action_name).and_return(:show)
   end
 
   describe '#fields_to_render' do

data/spec/presenters/blacklight/index_presenter_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe Blacklight::IndexPresenter, api: true do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
+    allow(request_context).to receive(:action_name).and_return(:index)
   end
 
   describe '#fields' do

data/spec/presenters/blacklight/show_presenter_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe Blacklight::ShowPresenter, api: true do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
+    allow(request_context).to receive(:action_name).and_return(:show)
   end
 
   describe "link_rel_alternates" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.39.0
+  version: 7.40.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,7 +129,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.66'
+        version: '2.74'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -139,7 +139,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.66'
+        version: '2.74'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'