blacklight 7.18.1 → 7.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5a489af479cba41b095c127d35112702c19436855e558a727b9b6667455d2d
-  data.tar.gz: 199b0847364f2f8c5d5d2fd2cd86d0d969b1a802144127df77141f42da97a316
+  metadata.gz: 3b17640ea1dd81a41048bfbb2362bf692300e228045fac8f0d42aa0fbd281a63
+  data.tar.gz: 6956aa4b0fd67802b24d04b0f27677ca9f84d5692bdf8a34cd21b043d3fe8df9
 SHA512:
-  metadata.gz: d900379c48b0118bc87a6711989cce5cafb84fc13e4fae4c300ea9d1ec34278634fe69195179231c5c167f01170b95b493171d668e21a37bf4cf7b2e40301f3e
-  data.tar.gz: '089e1155d4a910bdc6657775cc5c4e8e0cc27b02307f36c15123f92cb55429d958d987ed202ff8a0ec9022cfc371ab0b8a769908c549ec784b11e956c25e00ba'
+  metadata.gz: bc71e8e6c0ee060b4303052caf0b9341c58a42c71e5f9badfe03f8013c6e3b96ba43f66d0d477c525edb58263a1993b9d9da143cf3f5f1c7fdb032568df5db87
+  data.tar.gz: e31975c219b1b709bdc6b765f123ffbf13978f56a26936f75d08cc7796e38703f163dc459e735f37bc36da3338e43f481d24b57d8308052509f6d19c0864bb7c

data/VERSION

@@ -1 +1 @@
-7.18.1
+7.19.0

data/app/components/blacklight/content_areas_shim.rb

@@ -5,7 +5,8 @@ module Blacklight
   module ContentAreasShim
     # Shim the `with` helper to write content into slots instead
     def with(slot_name, *args, **kwargs, &block)
-      Deprecation.warn('ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
+      Deprecation.warn(Blacklight::ContentAreasShim,
+                       'ViewComponents deprecated `with` and it will be removed in ViewComponents 3.0. content_areas. Use slots (https://viewcomponent.org/guide/slots.html) instead.')
       public_send(slot_name, *args, **kwargs, &block)
     end
   end

data/app/components/blacklight/document_component.rb

@@ -25,7 +25,7 @@ module Blacklight
       next static_content if static_content.present?
       next unless component
 
-      Deprecation.warn('Pass the presenter to the DocumentComponent') if @presenter.nil?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if @presenter.nil?
 
       component.new(*args, document: @document, presenter: @presenter, document_counter: @document_counter, **kwargs)
     end)
@@ -34,7 +34,7 @@ module Blacklight
     renders_one :metadata, (lambda do |static_content = nil, *args, component: nil, fields: nil, **kwargs|
       next static_content if static_content.present?
 
-      Deprecation.warn('Pass the presenter to the DocumentComponent') if !fields && @presenter.nil?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if !fields && @presenter.nil?
 
       component ||= Blacklight::DocumentMetadataComponent
 
@@ -48,7 +48,7 @@ module Blacklight
       next image_options_or_static_content if image_options_or_static_content.is_a? String
 
       component ||= @presenter&.view_config&.thumbnail_component || Blacklight::Document::ThumbnailComponent
-      Deprecation.warn('Pass the presenter to the DocumentComponent') if !component && @presenter.nil?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Pass the presenter to the DocumentComponent') if !component && @presenter.nil?
 
       component.new(*args, document: @document, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
     end)
@@ -93,13 +93,13 @@ module Blacklight
       @id = id || ('document' if show)
       @classes = classes
 
-      Deprecation.warn('Passing embed_component is deprecated') if @embed_component.present?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Passing embed_component is deprecated') if @embed_component.present?
       @embed_component = embed_component
 
-      Deprecation.warn('Passing metadata_component is deprecated') if @metadata_component.present?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Passing metadata_component is deprecated') if @metadata_component.present?
       @metadata_component = metadata_component || Blacklight::DocumentMetadataComponent
 
-      Deprecation.warn('Passing thumbnail_component is deprecated') if @thumbnail_component.present?
+      Deprecation.warn(Blacklight::DocumentComponent, 'Passing thumbnail_component is deprecated') if @thumbnail_component.present?
       @thumbnail_component = thumbnail_component || Blacklight::Document::ThumbnailComponent
 
       @document_counter = document_counter

data/app/components/blacklight/metadata_field_layout_component.rb

@@ -25,7 +25,7 @@ module Blacklight
     def value(*args, **kwargs, &block)
       return set_slot(:values, *args, **kwargs, &block) if block_given?
 
-      Deprecation.warn('The `value` content area is deprecated; render from the values slot instead')
+      Deprecation.warn(Blacklight::MetadataFieldLayoutComponent, 'The `value` content area is deprecated; render from the values slot instead')
 
       values.first
     end

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -84,12 +84,16 @@ module Blacklight::RenderPartialsHelperBehavior
   # @param [Hash] locals to pass to the render call
   # @return [String]
   def render_document_index_with_view view, documents, locals = {}
+    view_config = blacklight_config&.view_config(view)
+
+    return render partial: view_config.template, locals: locals.merge(documents: documents, view_config: view_config) if view_config&.template
+
     template = cached_view ['index', view].join('_') do
       find_document_index_template_with_view(view, locals)
     end
 
     if template
-      template.render(self, locals.merge(documents: documents))
+      template.render(self, locals.merge(documents: documents, view_config: view_config))
     else
       ''
     end

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

@@ -1,6 +1,7 @@
 <% # container for a single doc -%>
-<%= render (blacklight_config.view_config(document_index_view_type).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
-  <% component.public_send(blacklight_config.view_config(document_index_view_type).document_component.blank? && blacklight_config.view_config(document_index_view_type).partials.any? ? :body : :partial) do %>
-    <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, component: component, document_counter: document_counter %>
+<% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type) %>
+<%= render (view_config.document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
+  <% component.public_send(view_config.document_component.blank? && view_config.partials.any? ? :body : :partial) do %>
+    <%= render_document_partials document, view_config.partials, component: component, document_counter: document_counter %>
   <% end %>
 <% end %>

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

@@ -1,4 +1,5 @@
 <% # container for all documents in index list view -%>
-<div id="documents" class="documents-<%= document_index_view_type %>">
-  <%= render documents, :as => :document %>
+<% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
+<div id="documents" class="documents-<%= view_config&.key || document_index_view_type %>">
+  <%= render documents, as: :document, view_config: view_config %>
 </div>

data/lib/blacklight/configuration.rb

@@ -170,6 +170,8 @@ module Blacklight
     def initialize(hash = {})
       super(self.class.default_values.deep_dup.merge(hash))
       yield(self) if block_given?
+
+      @view_config ||= {}
     end
 
     def document_model
@@ -333,7 +335,6 @@ module Blacklight
         view_type = nil
       end
 
-      @view_config ||= {}
       @view_config[[view_type, action_name]] ||= begin
         if view_type.nil?
           action_config(action_name)
@@ -428,6 +429,11 @@ module Blacklight
       fields.merge(show_fields)
     end
 
+    def freeze
+      each { |_k, v| v.is_a?(OpenStruct) && v.freeze }
+      super
+    end
+
     private
 
     def add_action(config_hash, name, opts)

data/lib/blacklight/configuration/view_config.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 class Blacklight::Configuration
   class ViewConfig < Blacklight::OpenStructWithHashAccess
+    # @!attribute template
+    #   @return [String] partial to render around the documents
     # @!attribute partials
     #   @return [Array<String>] partials to render for each document(see #render_document_partials)
     # @!attribute document_presenter_class
@@ -20,7 +22,7 @@ class Blacklight::Configuration
     end
 
     def display_label(deprecated_key = nil, **options)
-      Deprecation.warn('Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
+      Deprecation.warn(Blacklight::Configuration::ViewConfig, 'Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
 
       I18n.t(
         :"blacklight.search.view_title.#{deprecated_key || key}",

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -14,12 +14,12 @@ module Blacklight
 
     def initialize(klass, hash = {})
       @nested_class = klass
-      value = hash.transform_values do |v|
-        if v.is_a? Hash
-          nested_class.new(v)
-        else
-          v
-        end
+      value = hash.each_with_object({}) do |(k, v), h|
+        h[k] = if v.is_a? Hash
+                 nested_class.new({ key: k.to_sym }.merge(v))
+               else
+                 v
+               end
       end
 
       super value
@@ -37,7 +37,7 @@ module Blacklight
     # into another NestedOpenStructWithHashAccess
     def []=(key, value)
       if value.is_a? Hash
-        send "#{key}=", nested_class.new(value)
+        send "#{key}=", nested_class.new({ key: key.to_sym }.merge(value))
       else
         super
       end
@@ -93,19 +93,22 @@ module Blacklight
       len = args.length
 
       res = if mid.to_s.end_with?('!')
-              m = mid[0...-1]
+              m = mid[0...-1].to_sym
               new_ostruct_member!(m)
               @table[m]
             elsif mid.to_s.end_with?('=')
-              m = mid[0...-1]
+              m = mid[0...-1].to_sym
               new_ostruct_member!(m)
               @table[m] = args.first
             elsif len.zero? && kwargs.blank? && !block
-              Deprecation.warn("Initializing a #{nested_class} implicitly (by calling #{mid}) is deprecated. Call it as #{mid}! or pass initialize arguments")
+              Deprecation.warn(Blacklight::NestedOpenStructWithHashAccess,
+                               "Initializing a #{nested_class} implicitly (by calling #{mid}) is deprecated. Call it as #{mid}! or pass initialize arguments")
+
+              new_ostruct_member!(mid)
               @table[mid]
             else
               new_ostruct_member!(mid)
-              @table[mid] = nested_class.new(*args, **kwargs)
+              @table[mid] = nested_class.new(key: mid, **(args.first || {}), **kwargs)
             end
 
       block&.call(res)

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -6,7 +6,7 @@ module Blacklight
   class OpenStructWithHashAccess < OpenStruct
     delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?,
              :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!,
-             :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
+             :replace, :fetch, :to_json, :as_json, :any?, :freeze, :unfreeze, :frozen?, to: :to_h
 
     ##
     # Expose the internal hash

data/lib/blacklight/search_builder.rb

@@ -45,7 +45,7 @@ module Blacklight
     ##
     # Update the :q (query) parameter
     def where(conditions)
-      Deprecation.warn("SearchBuilder#where must be called with a hash, received #{conditions.inspect}.") unless conditions.is_a? Hash
+      Deprecation.warn(Blacklight::SearchBuilder, "SearchBuilder#where must be called with a hash, received #{conditions.inspect}.") unless conditions.is_a? Hash
       params_will_change!
       @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
       @blacklight_params = @search_state.params.dup

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -66,7 +66,7 @@ module Blacklight::Solr
         add_search_field_with_local_parameters(solr_parameters)
       elsif search_state.query_param.is_a? Hash
         if search_state.query_param == @additional_filters && !processor_chain.include?(:add_additional_filters)
-          Deprecation.warn('Expecting to see the processor step add_additional_filters; falling back to legacy query handling')
+          Deprecation.warn(Blacklight::Solr::SearchBuilderBehavior, 'Expecting to see the processor step add_additional_filters; falling back to legacy query handling')
           add_additional_filters(solr_parameters, search_state.query_param)
         end
       elsif search_state.query_param

data/spec/helpers/blacklight_helper_spec.rb

@@ -320,6 +320,24 @@ RSpec.describe BlacklightHelper do
       response = helper.render_document_index_with_view :view_type, [obj1, obj1]
       expect(response).to have_selector "div#documents"
     end
+
+    context 'with a template partial provided by the view config' do
+      before do
+        blacklight_config.view.gallery(template: '/my/partial')
+      end
+
+      def stub_template(hash)
+        view.view_paths.unshift(ActionView::FixtureResolver.new(hash))
+      end
+
+      it 'renders that template' do
+        stub_template 'my/_partial.html.erb' => 'some content'
+
+        response = helper.render_document_index_with_view :gallery, [obj1, obj1]
+
+        expect(response).to eq 'some content'
+      end
+    end
   end
 
   describe "#document_index_view_type" do

data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb

@@ -1,6 +1,26 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
+  subject { described_class.new(Blacklight::OpenStructWithHashAccess) }
+
+  describe '#key' do
+    context 'for an object provided by the initializer' do
+      subject { described_class.new(Blacklight::OpenStructWithHashAccess, a: { b: 1 }) }
+
+      it 'copies the key to the initialized value' do
+        expect(subject.a).to have_attributes key: :a, b: 1
+      end
+    end
+
+    context 'for an object provided through assignment' do
+      it 'copies the key to the initialized value' do
+        subject.a!
+
+        expect(subject.a).to have_attributes key: :a
+      end
+    end
+  end
+
   describe "#deep_dup" do
     it "preserves the current class" do
       expect(described_class.new(described_class).deep_dup).to be_a_kind_of described_class
@@ -28,13 +48,15 @@ RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
     subject { described_class.new(Blacklight::Configuration::Field) }
 
     it 'strips the trailing !' do
-      subject.blaH!
+      subject.blah!
       expect(subject.blah).to have_attributes(key: :blah)
+      expect(subject.keys).to eq [:blah]
     end
 
     it 'supports direct assignment' do
       subject.blah = '123'
       expect(subject.blah).to eq '123'
+      expect(subject.keys).to eq [:blah]
     end
   end
 end

data/spec/models/blacklight/configuration_spec.rb

@@ -621,4 +621,14 @@ RSpec.describe "Blacklight::Configuration", api: true do
       end
     end
   end
+
+  describe '#freeze' do
+    it 'freezes the configuration' do
+      config.freeze
+
+      expect(config.a).to be_nil
+      expect { config.a = '123' }.to raise_error(FrozenError)
+      expect { config.view.a = '123' }.to raise_error(FrozenError)
+    end
+  end
 end

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

@@ -46,4 +46,13 @@ RSpec.describe "catalog/_document" do
     expect(rendered).to have_selector 'article.document header', text: '22. xyz'
     expect(rendered).not_to match(/partial/)
   end
+
+  it 'renders the partial using a provided view config' do
+    view_config = Blacklight::Configuration::ViewConfig.new partials: %w[a]
+    stub_template "catalog/_a_default.html.erb" => "partial"
+
+    render partial: "catalog/document", locals: { document: document, document_counter: 1, view_config: view_config }
+
+    expect(rendered).to match(/partial/)
+  end
 end

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

@@ -2,7 +2,7 @@
 
 RSpec.describe "catalog/_document_list", type: :view do
   before do
-    allow(view).to receive_messages(document_index_view_type: "some-view", documents: [])
+    allow(view).to receive_messages(document_index_view_type: "some-view", documents: [], blacklight_config: nil)
   end
 
   it "includes a class for the current view" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.18.1
+  version: 7.19.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails