blacklight 7.34.0 → 7.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65ccb9085e62a93389eab98519e5cb673b61d8fc3c6e973a2810e4ac66a87cf1
-  data.tar.gz: 56e423a036a4e82382f6bda36084b79758c966ccc8757dfe004deb26963ee400
+  metadata.gz: 841946108f3216c1dfc66f10787069b43fdcca041e9cc3e114524bf0a5cf6aa1
+  data.tar.gz: 621f2d5648013ab85fa3c3c99a001824e49b24be263cd1eda45a7f5ed9e22daa
 SHA512:
-  metadata.gz: 49ebde9d47e594d7ddeaaf893f2a9a99c4162592065800d8c4d5b3f84b7e08d2c95a57f47f20a079b0ba8bfc36e6c83fc31e96aa4587695db913a40194999a42
-  data.tar.gz: 94a1cfe6e885d009a1117a7bede81a4db4f8215cd8b3f37b2d38fa89da17e239478556809f2265fb9a47761644da5c0ef6487042276655151b9372b0919664f8
+  metadata.gz: 9ae81c46a04f928701d7e16c227bf33ae9ed0ae214e6ef94bbf96bc0b33aa22ff889e286a1235d6c6a225e11597fe3e832db2c5242cc71a533229ee75dc2b407
+  data.tar.gz: 2005c22b35ac7a9f4c3fb065f412a6369bcf903f918bc46770d23999a509bae45d855c83b14a0e167f3acbafd900ae63f6fe4cfe30de98f8d97bb17980a64c49

data/VERSION

@@ -1 +1 @@
-7.34.0
+7.35.0

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -42,7 +42,11 @@ module Blacklight::Bookmarks
     @bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
     @response, deprecated_document_list = search_service.fetch(bookmark_ids)
-    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, "The @document_list instance variable is now deprecated and will be removed in Blacklight 8.0")
+    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
+      deprecated_document_list,
+      "The @document_list instance variable is now deprecated",
+      ActiveSupport::Deprecation.new("8.0", "blacklight")
+    )
 
     respond_to do |format|
       format.html {}

data/app/controllers/concerns/blacklight/catalog.rb

@@ -34,7 +34,11 @@ module Blacklight::Catalog
   def index
     (@response, deprecated_document_list) = search_service.search_results
 
-    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, 'The @document_list instance variable is deprecated; use @response.documents instead.')
+    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
+      deprecated_document_list,
+      'The @document_list instance variable is deprecated; use @response.documents instead.',
+      ActiveSupport::Deprecation.new("8.0", "blacklight")
+    )
 
     respond_to do |format|
       format.html { store_preferred_view }
@@ -53,7 +57,11 @@ module Blacklight::Catalog
   # to add responses for formats other than html or json see _Blacklight::Document::Export_
   def show
     deprecated_response, @document = search_service.fetch(params[:id])
-    @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_response, 'The @response instance variable is deprecated; use @document.response instead.')
+    @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
+      deprecated_response,
+      'The @response instance variable is deprecated; use @document.response instead.',
+      ActiveSupport::Deprecation.new("8.0", "blacklight")
+    )
 
     respond_to do |format|
       format.html { @search_context = setup_next_and_previous_documents }

data/app/models/concerns/blacklight/document/active_model_shim.rb

@@ -28,6 +28,16 @@ module Blacklight::Document
       def find id
         repository.find(id).documents.first
       end
+
+      # In Rails 7.1+, needs this method
+      def composite_primary_key?
+        false
+      end
+
+      # In Rails 7.1+, needs this method
+      def has_query_constraints?
+        false
+      end
     end
 
     ##

data/app/models/search.rb

@@ -4,7 +4,12 @@ class Search < ApplicationRecord
   belongs_to :user, optional: true
 
   # use a backwards-compatible serializer until the Rails API stabilizes and we can evaluate for major-revision compatibility
-  serialize :query_params, Blacklight::SearchParamsYamlCoder
+  if ::Rails.version.to_f >= 7.1
+    # non-deprecated coder: keyword arg for Rails 7.1+
+    serialize :query_params, coder: Blacklight::SearchParamsYamlCoder
+  else
+    serialize :query_params, Blacklight::SearchParamsYamlCoder
+  end
 
   # A Search instance is considered a saved search if it has a user_id.
   def saved?

data/app/services/blacklight/field_retriever.rb

@@ -22,17 +22,19 @@ module Blacklight
 
     # @return [Array]
     def fetch
-      Array.wrap(
-        if field_config.highlight
-          retrieve_highlight
-        elsif field_config.accessor
-          retieve_using_accessor
-        elsif field_config.values
-          retrieve_values
-        else
-          retrieve_simple
-        end
-      )
+      if field_config.highlight
+        value = retrieve_highlight
+      end
+      if value.blank?
+        value = if field_config.accessor
+                  retieve_using_accessor
+                elsif field_config.values
+                  retrieve_values
+                else
+                  retrieve_simple
+                end
+      end
+      Array.wrap(value)
     end
 
     private

data/blacklight.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency "rails", '>= 5.1', '< 7.1'
+  s.add_dependency "rails", '>= 5.1', '< 7.2'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'hashdiff'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
-  s.add_development_dependency "rspec-rails", "~> 5.0"
+  s.add_development_dependency "rspec-rails", ">= 5.0" # some versions tested need >= 6.0
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency 'axe-core-rspec'
   s.add_development_dependency "capybara", '~> 3'

data/lib/blacklight/engine.rb

@@ -6,6 +6,17 @@ module Blacklight
   class Engine < Rails::Engine
     engine_name "blacklight"
 
+    config.before_configuration do
+      # see https://github.com/fxn/zeitwerk#for_gem
+      # Blacklight puts a generator into LOCAL APP lib/generators, so tell
+      # zeitwerk to ignore the whole directory? If we're using zeitwerk
+      #
+      # https://github.com/cbeer/engine_cart/issues/117
+      if Rails.try(:autoloaders).try(:main).respond_to?(:ignore)
+        Rails.autoloaders.main.ignore(Rails.root.join('lib/generators'))
+      end
+    end
+
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
     initializer 'blacklight.helpers' do

data/spec/components/blacklight/facet_component_spec.rb

@@ -51,7 +51,17 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     end
 
     before do
-      controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('catalog/_facet_partial.html.erb' => 'facet partial'))
+      # Not sure why we need to re-implement rspec's stub_template, but
+      # we already were, and need a Rails 7.1+ safe alternate too
+      # https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
+      # https://github.com/rspec/rspec-rails/issues/2696
+
+      replace_hash = { 'catalog/_facet_partial.html.erb' => 'facet partial' }
+      if ::Rails.version.to_f >= 7.1
+        controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+      else
+        controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+      end
     end
 
     it 'renders the partial' do

data/spec/helpers/blacklight_helper_spec.rb

@@ -331,12 +331,17 @@ RSpec.describe BlacklightHelper 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'
+        # Not sure why we need to re-implement rspec's stub_template, but
+        # we already were, and need a Rails 7.1+ safe alternate too
+        # https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
+        # https://github.com/rspec/rspec-rails/issues/2696
+        replace_hash = { 'my/_partial.html.erb' => 'some content' }
+        if ::Rails.version.to_f >= 7.1
+          controller.prepend_view_path(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for(replace_hash))
+        else
+          view.view_paths.unshift(ActionView::FixtureResolver.new(replace_hash))
+        end
 
         response = helper.render_document_index_with_view :gallery, [obj1, obj1]
 

data/spec/services/blacklight/field_retriever_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::FieldRetriever, api: true do
+  let(:service) { described_class.new(document, blacklight_field_config) }
+
+  let(:blacklight_field_config) { Blacklight::Configuration::Field.new(field: 'author_field', highlight: true) }
+  let(:document) { SolrDocument.new({ 'id' => 'doc1', 'title_field' => 'doc1 title', 'author_field' => 'author_someone' }, 'highlighting' => { 'doc1' => { 'title_tsimext' => ['doc <em>1</em>'] } }) }
+  let(:view_context) { {} }
+
+  context "highlighting" do
+    describe '#fetch' do
+      it "retrieves an author even if it's not highlighted" do
+        expect(service.fetch).to eq(['author_someone'])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -117,3 +117,31 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 end
+
+# RSpec's stub_template method needs a differnet implementation for Rails 7.1, that
+# isn't yet in an rspec-rails release.
+#
+# First rspec-rails tried this:
+#   https://github.com/rspec/rspec-rails/commit/4d65bea0619955acb15023b9c3f57a3a53183da8
+#
+# But it was subject to this problem:
+#   https://github.com/rspec/rspec-rails/issues/2696
+#
+# Below implementation appears to work for our purposes here, so we will patch it in
+# if we are on Rails 7.1+, and  not yet rspec-rails 6.1 which we expect to have it.
+
+if ::Rails.version.to_f >= 7.1 && Gem.loaded_specs["rspec-rails"].version.release < Gem::Version.new('6.1')
+
+  module RSpec
+    module Rails
+      module ViewExampleGroup
+        module ExampleMethods
+          def stub_template(hash)
+            controller.prepend_view_path(StubResolverCache.resolver_for(hash))
+          end
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.34.0
+  version: 7.35.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,7 +28,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -181,14 +181,14 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
@@ -894,6 +894,7 @@ files:
 - spec/presenters/thumbnail_presenter_spec.rb
 - spec/routing/catalog_routing_spec.rb
 - spec/routing/search_history_spec.rb
+- spec/services/blacklight/field_retriever_spec.rb
 - spec/services/blacklight/search_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/controller_level_helpers.rb
@@ -954,7 +955,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
@@ -1077,6 +1078,7 @@ test_files:
 - spec/presenters/thumbnail_presenter_spec.rb
 - spec/routing/catalog_routing_spec.rb
 - spec/routing/search_history_spec.rb
+- spec/services/blacklight/field_retriever_spec.rb
 - spec/services/blacklight/search_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/controller_level_helpers.rb