blacklight 7.17.2 → 7.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cacc94e8533f909ef9e137dca8f86809489626624507e04051c0923f1471d21c
-  data.tar.gz: 83c86c5a1789266ca17d1ad446320f4634acf0c6a95c456dffd7cbd1653bb4e1
+  metadata.gz: 60b0a39be3483ff0a8968a73c07ad6e7fcd576c7249020606d602454401e3e81
+  data.tar.gz: 46aa7df118c340444ec95e045cd1006a62017595160adcfd953d99bafb1222db
 SHA512:
-  metadata.gz: 07aa3c78687f57145209b5834d4f3512ced41f80b34e4b2dd6d72271d229922041de56f015271ba58ad62dc9c21fbd7f7f9cc0eb284080036e6e6092de73a48e
-  data.tar.gz: 7cd2dd6b95c77c07d06b3c1c58e4e5d7dda5fe415a6dfd61498a8e2fc83778685b0a86d08a354fbc8fc60f69dbe842f1a45a9fea5da133978d75888ee9506026
+  metadata.gz: 02715a196cc746c2e3b23a453edcf4f7e50c43077a670ee2ec0975362969a36f71a299ad881d688d97207d25d75ddccedf460d14ed8c877347e3f626b9d43971
+  data.tar.gz: da5835cdb464f59d5b0715c0808e08ac81484e70271443b15baad6076f5266ed0000e5cad2d73cd9638796ec1532f891f57c0b3e4b87a85ea136e50ed38a0e13

data/VERSION

@@ -1 +1 @@
-7.17.2
+7.18.0

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

@@ -50,7 +50,7 @@ module Blacklight
       component ||= @presenter&.view_config&.thumbnail_component || Blacklight::Document::ThumbnailComponent
       Deprecation.warn('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

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -5,6 +5,9 @@ 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
@@ -86,15 +89,28 @@ 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.ends_with?('!')
+              m = mid[0...-1]
+              new_ostruct_member!(m)
+              @table[m]
+            elsif mid.to_s.ends_with?('=')
+              m = mid[0...-1]
+              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")
+              @table[mid]
+            else
+              new_ostruct_member!(mid)
+              @table[mid] = nested_class.new(*args, **kwargs)
+            end
+
+      block&.call(res)
+
+      res
     end
 
     private

data/lib/blacklight/search_builder.rb

@@ -45,6 +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
       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('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/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,7 +315,7 @@ 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"

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/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/_view_type_group.html.erb_spec.rb

@@ -20,9 +20,9 @@ RSpec.describe "catalog/_view_type_group" do
   it "displays the group" do
     blacklight_config.configure do |config|
       config.view.delete(:list)
-      config.view.a.icon = :list
-      config.view.b.icon = :list
-      config.view.c.icon = :list
+      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')
@@ -37,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.icon = :list
-      config.view.b.icon = :list
+      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.2
+  version: 7.18.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails