blacklight 7.17.0 → 7.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e26542ca54e79594290b86c0506e4bc3a26a225d84e17537893381b4ad2c421
-  data.tar.gz: c812f19a30e663a1350888600307e7ba1b089b8794570eeadb38f89a6de57d27
+  metadata.gz: 3b17640ea1dd81a41048bfbb2362bf692300e228045fac8f0d42aa0fbd281a63
+  data.tar.gz: 6956aa4b0fd67802b24d04b0f27677ca9f84d5692bdf8a34cd21b043d3fe8df9
 SHA512:
-  metadata.gz: 8f167c42362e5372a681777ce1cd1a72bf6ca9f5762098686bc6bb8872f59afd3f110312d15c1436320b511df272281ddb04be6cf9c10620535389aa87c91169
-  data.tar.gz: 9ae4c4178d7eff8eb4656d03353fe4fb2cd4f66e32fffdebd8645275f213b26aadd9c8204c2feba9f6479160ad925ba220ce6e1ec59bff42f9ca298dfd7cbb5c
+  metadata.gz: bc71e8e6c0ee060b4303052caf0b9341c58a42c71e5f9badfe03f8013c6e3b96ba43f66d0d477c525edb58263a1993b9d9da143cf3f5f1c7fdb032568df5db87
+  data.tar.gz: e31975c219b1b709bdc6b765f123ffbf13978f56a26936f75d08cc7796e38703f163dc459e735f37bc36da3338e43f481d24b57d8308052509f6d19c0864bb7c

data/VERSION

@@ -1 +1 @@
-7.17.0
+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/thumbnail_component.html.erb

@@ -1,12 +1,12 @@
-<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag(@image_options, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render(@image_options) %>
+<% value = use_thumbnail_tag_behavior? ? presenter.thumbnail.thumbnail_tag(@image_options, 'aria-hidden': true, tabindex: -1, counter: @counter) : presenter.thumbnail.render(@image_options) %>
 
 <% if value %>
   <div class="document-thumbnail">
-    <% if @use_thumbnail_tag %>
+    <% if use_thumbnail_tag_behavior? %>
       <% warn_about_deprecated_behavior %>
       <%= value %>
     <% else %>
-      <%= helpers.link_to_document(@presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
+      <%= helpers.link_to_document(presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
     <% end %>
   </div>
 <% end %>

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

@@ -9,20 +9,28 @@ module Blacklight
       # @param [Blacklight::DocumentPresenter] presenter
       # @param [Integer] counter
       # @param [Hash] image_options options for the thumbnail presenter's image tag
-      def initialize(presenter:, counter:, image_options: {})
+      def initialize(presenter: nil, document: nil, counter:, image_options: {})
         @presenter = presenter
+        @document = presenter&.document || document
         @counter = counter
         @image_options = { alt: '' }.merge(image_options)
-        @use_thumbnail_tag = !@presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 
       def render?
-        @presenter.thumbnail.exists?
+        presenter.thumbnail.exists?
+      end
+
+      def use_thumbnail_tag_behavior?
+        !presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 
       def warn_about_deprecated_behavior
         Deprecation.warn(Blacklight::Document::ThumbnailComponent, 'Detected as custom thumbnail presenter; make sure it has a #render method that returns just the thumbnail image tag')
       end
+
+      def presenter
+        @presenter ||= @view_context.document_presenter(@document)
+      end
     end
   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,9 +48,9 @@ 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, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
+      component.new(*args, document: @document, presenter: @presenter, counter: @counter, image_options: image_options_or_static_content, **kwargs)
     end)
 
     # A container for partials rendered using the view config partials configuration. Its use is discouraged, but necessary until
@@ -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/components/blacklight/response/view_type_button_component.rb

@@ -15,12 +15,14 @@ module Blacklight
       end
 
       def icon
-        @view_context.render_view_type_group_icon(@view)
+        Deprecation.silence(Blacklight::CatalogHelperBehavior) do
+          @view_context.render_view_type_group_icon(@view.icon || @key)
+        end
       end
 
       def label
         Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
-          @view_context.view_label(@view)
+          @view_context.view_label(@key)
         end
       end
 

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -253,11 +253,13 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Render the view type icon for the results view picker
   #
+  # @deprecated
   # @param [String] view
   # @return [String]
   def render_view_type_group_icon view
     blacklight_icon(view)
   end
+  deprecation_deprecate render_view_type_group_icon: 'call blacklight_icon instead'
 
   ##
   # Get the default view type classes for a view in the results view picker

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
@@ -11,6 +13,8 @@ class Blacklight::Configuration
     #   @return [String, Symbol] solr field to use to render a document title
     # @!attribute display_type_field
     #   @return [String, Symbol] solr field to use to render format-specific partials
+    # @!attribute icon
+    #   @return [String, Symbol] icon file to use in the view picker
     # @!attribute document_actions
     #   @return [NestedOpenStructWithHashAccess{Symbol => Blacklight::Configuration::ToolConfig}] 'tools' to render for each document
     def search_bar_presenter_class
@@ -18,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

@@ -5,18 +5,21 @@ module Blacklight
   # An OpenStruct refinement that converts any hash-keys into
   # additional instances of NestedOpenStructWithHashAccess
   class NestedOpenStructWithHashAccess < OpenStructWithHashAccess
+    extend Deprecation
+    self.deprecation_horizon = 'blacklight 8.0'
+
     attr_reader :nested_class
 
     delegate :default_proc=, to: :to_h
 
     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
@@ -34,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
@@ -86,15 +89,31 @@ module Blacklight
     ##
     # Override #method_missing from OpenStruct to ensure the default_proc logic
     # gets triggered.
-    def method_missing(mid, *args)
+    def method_missing(mid, *args, **kwargs, &block)
       len = args.length
 
-      if len.zero?
-        new_ostruct_member!(mid)
-        @table[mid]
-      else
-        super
-      end
+      res = if mid.to_s.end_with?('!')
+              m = mid[0...-1].to_sym
+              new_ostruct_member!(m)
+              @table[m]
+            elsif mid.to_s.end_with?('=')
+              m = mid[0...-1].to_sym
+              new_ostruct_member!(m)
+              @table[m] = args.first
+            elsif len.zero? && kwargs.blank? && !block
+              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(key: mid, **(args.first || {}), **kwargs)
+            end
+
+      block&.call(res)
+
+      res
     end
 
     private

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,6 +45,7 @@ module Blacklight
     ##
     # Update the :q (query) parameter
     def where(conditions)
+      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

@@ -32,6 +32,7 @@ module Blacklight::Solr
     # Take the user-entered query, and put it in the solr params,
     # including config's "search field" params for current search field.
     # also include setting spellcheck.q.
+    # rubocop:disable Metrics/CyclomaticComplexity
     def add_query_to_solr(solr_parameters)
       ###
       # legacy behavior of user param :qt is passed through, but over-ridden
@@ -64,11 +65,15 @@ module Blacklight::Solr
       elsif search_field&.solr_local_parameters.present?
         add_search_field_with_local_parameters(solr_parameters)
       elsif search_state.query_param.is_a? Hash
-        add_additional_filters(solr_parameters, search_state.query_param)
+        if search_state.query_param == @additional_filters && !processor_chain.include?(:add_additional_filters)
+          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
         solr_parameters.append_query search_state.query_param
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def add_additional_filters(solr_parameters, additional_filters = nil)
       q = additional_filters || @additional_filters
@@ -322,6 +327,7 @@ module Blacklight::Solr
     # around the term unless it's a bare-word. Escape internal quotes
     # if needed.
     def solr_param_quote(val, options = {})
+      val = val.to_s
       options[:quote] ||= '"'
       unless val =~ /^[a-zA-Z0-9$_\-\^]+$/
         val = options[:quote] +

data/lib/generators/blacklight/install_generator.rb

@@ -37,8 +37,10 @@ module Blacklight
     end
 
     def bundle_install
-      Bundler.with_clean_env do
-        run "bundle install"
+      inside destination_root do
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
     end
 
@@ -81,9 +83,7 @@ module Blacklight
       blacklight_marc = String.new('blacklight-marc')
       gem blacklight_marc, '>= 7.0.0.rc1', '< 8'
 
-      Bundler.with_clean_env do
-        run "bundle install"
-      end
+      bundle_install
 
       generate 'blacklight:marc:install'
     end

data/lib/generators/blacklight/solr_generator.rb

@@ -35,8 +35,10 @@ module Blacklight
     end
 
     def bundle_install
-      Bundler.with_clean_env do
-        run "bundle install"
+      inside destination_root do
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
     end
   end

data/lib/generators/blacklight/user_generator.rb

@@ -24,8 +24,10 @@ module Blacklight
       gem "devise"
       gem "devise-guests", "~> 0.6"
 
-      Bundler.with_clean_env do
-        run "bundle install"
+      inside destination_root do
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
 
       generate "devise:install"

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -33,9 +33,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe "#default_document_index_view_type" do
     it "uses the first view with default set to true" do
-      blacklight_config.view.a
-      blacklight_config.view.b
-      blacklight_config.view.b.default = true
+      blacklight_config.view.a({})
+      blacklight_config.view.b(default: true)
       expect(helper.default_document_index_view_type).to eq :b
     end
 
@@ -48,8 +47,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
   describe "#document_index_views" do
     before do
       blacklight_config.view.abc = false
-      blacklight_config.view.def.if = false
-      blacklight_config.view.xyz.unless = true
+      blacklight_config.view.def(if: false)
+      blacklight_config.view.xyz(unless: true)
     end
 
     it "filters views using :if/:unless configuration" do
@@ -62,8 +61,8 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
 
   describe '#document_index_view_controls' do
     before do
-      blacklight_config.view.a
-      blacklight_config.view.b.display_control = false
+      blacklight_config.view.a({})
+      blacklight_config.view.b(display_control: false)
     end
 
     it "filters index views to those set to display controls" do

data/spec/helpers/blacklight_helper_spec.rb

@@ -127,7 +127,7 @@ RSpec.describe BlacklightHelper do
 
       it "renders view type specific actions" do
         allow(helper).to receive(:document_index_view_type).and_return(:custom)
-        config.view.custom.document_actions = []
+        config.view.custom(document_actions: [])
         expect(helper.render_index_doc_actions(document)).to be_blank
       end
     end
@@ -315,11 +315,29 @@ RSpec.describe BlacklightHelper do
     end
 
     it "ignores missing templates" do
-      blacklight_config.view.view_type.partials = %w[index_header a b]
+      blacklight_config.view.view_type(partials: %w[index_header a b])
 
       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/helpers/catalog_helper_spec.rb

@@ -323,7 +323,7 @@ RSpec.describe CatalogHelper do
 
     it "supports view-specific field configuration" do
       allow(helper).to receive(:document_index_view_type).and_return(:some_view_type)
-      blacklight_config.view.some_view_type.display_type_field = :other_type
+      blacklight_config.view.some_view_type(display_type_field: :other_type)
       doc = { other_type: "document" }
       expect(helper.render_document_class(doc)).to eq "blacklight-document"
     end

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
@@ -23,4 +43,20 @@ RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
       expect(subject.blah).to have_attributes(key: :blah)
     end
   end
+
+  describe 'adding new parameters' do
+    subject { described_class.new(Blacklight::Configuration::Field) }
+
+    it 'strips the trailing !' do
+      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/models/blacklight/solr/search_builder_spec.rb

@@ -800,4 +800,13 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       expect(subject.to_hash.with_indifferent_access.dig(:json, :query, :bool, :must, 1, :edismax, :qf)).to eq '${author_qf}'
     end
   end
+
+  describe '#where' do
+    let(:user_params) { {} }
+
+    it 'adds additional query filters on the search' do
+      subject.where(id: [1, 2, 3])
+      expect(subject.to_hash).to include q: '{!lucene}id:(1 OR 2 OR 3)'
+    end
+  end
 end

data/spec/services/blacklight/search_service_spec.rb

@@ -477,7 +477,7 @@ RSpec.describe Blacklight::SearchService, api: true do
     end
 
     before do
-      blacklight_config.view.opensearch.title_field = :field
+      blacklight_config.view.opensearch(title_field: :field)
       allow(repository).to receive(:search).and_return(mock_response)
     end
 

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

@@ -3,7 +3,7 @@
 RSpec.describe "catalog/constraints" do
   let :blacklight_config do
     Blacklight::Configuration.new do |config|
-      config.view.xyz
+      config.view.xyz({})
     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

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

@@ -3,13 +3,9 @@
 RSpec.describe "catalog/_view_type_group" do
   let(:blacklight_config) { Blacklight::Configuration.new }
   let(:response) { instance_double(Blacklight::Solr::Response, empty?: false) }
-  let(:icon_instance) { instance_double(Blacklight::Icon) }
 
   before do
     allow(view).to receive(:view_label), &:to_s
-    allow(Blacklight::Icon).to receive(:new).and_return icon_instance
-    allow(icon_instance).to receive(:svg).and_return '<svg></svg>'
-    allow(icon_instance).to receive(:options).and_return({})
     allow(view).to receive_messages(how_sort_and_per_page?: true, blacklight_config: blacklight_config)
     controller.request.path_parameters[:action] = 'index'
     assign(:response, response)
@@ -24,13 +20,16 @@ RSpec.describe "catalog/_view_type_group" do
   it "displays the group" do
     blacklight_config.configure do |config|
       config.view.delete(:list)
-      config.view.a
-      config.view.b
-      config.view.c
+      config.view.a(icon: :list)
+      config.view.b(icon: :list)
+      config.view.c(icon: :list)
     end
     render partial: 'catalog/view_type_group'
     expect(rendered).to have_selector('.btn-group.view-type-group')
     expect(rendered).to have_selector('.view-type-a', text: 'a')
+    within '.view-type-a' do
+      expect(rendered).to have_selector 'svg'
+    end
     expect(rendered).to have_selector('.view-type-b', text: 'b')
     expect(rendered).to have_selector('.view-type-c', text: 'c')
   end
@@ -38,8 +37,8 @@ RSpec.describe "catalog/_view_type_group" do
   it "sets the current view to 'active'" do
     blacklight_config.configure do |config|
       config.view.delete(:list)
-      config.view.a
-      config.view.b
+      config.view.a(icon: :list)
+      config.view.b(icon: :list)
     end
     render partial: 'catalog/view_type_group'
     expect(rendered).to have_selector('.active', text: 'a')

metadata

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