blacklight 7.27.0 → 7.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39fe32f4252deb7d8bb08a1d2781a8d1af7e387eb2bafc93fc083cd13eda9b21
-  data.tar.gz: f0b41d058163f54ca1f5a11b745077c8404eea4f8cea43d87c8ea4e6d6ed0d30
+  metadata.gz: 752a397403b186b177e51a6f260f7f385d9e1db6c26abdb9b37c9c25ecf2ad04
+  data.tar.gz: f81dc90a28f7c9d9cecc35f60e119bd09ec96bd12584b8f1ffb39e51845a0588
 SHA512:
-  metadata.gz: e02cee90b4acb73a5b3fe4883c2a076f37146200fdec169bc3bbf0012ffcd79e5244019ee703c97c601f7100bdaecacf65617dccbc2050911b0fa4e7a24eefbd
-  data.tar.gz: 80036e1203a14f9d7f90e11a8fd02309e447d29be4f1deb4250d7628a3bcfad1ed00e43d57d9152fd1fff751e27e983af0adb0747978978039a6d1d81309e688
+  metadata.gz: 54c453918cd5521dd2ee24df0d7d874c48705d14422f8746a10bd262681e411ed54efef1202f9785beec20169ca5ca9acd4d648e730df8a930d2aa659190d905
+  data.tar.gz: 8014988552c75ebb9bbbd82dcad688dfcd3ea2b6126b63c4c178ab32fe034787bdd61b75a826ecdb1c9022e148a7f9911eb99e7c35090de9361d434756fb85a1

data/.github/workflows/ruby.yml

@@ -76,11 +76,11 @@ jobs:
     - name: Install dependencies
       run: bundle install
       env:
-        RAILS_VERSION: 6.0.3.7
+        RAILS_VERSION: 6.0.5.1
     - name: Run tests
       run: bundle exec rake ci
       env:
-        RAILS_VERSION: 6.0.3.7
+        RAILS_VERSION: 6.0.5.1
         ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
   test_rails5_2:
     runs-on: ubuntu-latest
@@ -96,11 +96,11 @@ jobs:
     - name: Install dependencies
       run: bundle install
       env:
-        RAILS_VERSION: 5.2.4.6
+        RAILS_VERSION: 5.2.8.1
     - name: Run tests
       run: bundle exec rake ci
       env:
-        RAILS_VERSION: 5.2.4.6
+        RAILS_VERSION: 5.2.8.1
         ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
 
   test_rails6_1:
@@ -117,11 +117,11 @@ jobs:
     - name: Install dependencies
       run: bundle install
       env:
-        RAILS_VERSION: 6.1.5
+        RAILS_VERSION: 6.1.6.1
     - name: Run tests
       run: bundle exec rake ci
       env:
-        RAILS_VERSION: 6.1.5
+        RAILS_VERSION: 6.1.6.1
         ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-keeps --skip-action-cable --skip-test'
   api_test:
     runs-on: ubuntu-latest

data/VERSION

@@ -1 +1 @@
-7.27.0
+7.29.0

data/app/assets/stylesheets/blacklight/_group.scss

@@ -1,5 +1,5 @@
 .group-key {
-  border-bottom: 1px solid darken($table-border-color, 60%);
+  border-bottom: 1px solid darken($border-color, 60%);
   clear: right;
 }
 
@@ -11,4 +11,4 @@
 
 .more-in-group {
   float: right;
-}
+}

data/app/components/blacklight/advanced_search_form_component.rb

@@ -43,7 +43,7 @@ module Blacklight
         search_field_control do
           fields_for('clause[]', i, include_id: false) do |f|
             content_tag(:div, class: 'form-group advanced-search-field row') do
-              f.label(:query, field.display_label('search'), class: "col-md-3 col-form-label text-md-right") +
+              f.label(:query, field.display_label('search'), class: "col-sm-3 col-form-label text-md-right") +
                 content_tag(:div, class: 'col-sm-9') do
                   f.hidden_field(:field, value: field.key) +
                     f.text_field(:query, value: query_for_search_clause(field.key), class: 'form-control')

data/app/components/blacklight/facet_component.rb

@@ -11,8 +11,8 @@ module Blacklight
     # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
     # @param [Blacklight::Configuration] blacklight_config
     # @param [Boolean] layout
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def initialize(display_facet_or_field_config: nil, display_facet: nil, field_config: nil, response: nil, blacklight_config: nil, **component_args)
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists
+    def initialize(display_facet_or_field_config: nil, display_facet: nil, field_config: nil, response: nil, blacklight_config: nil, component: nil, **component_args)
       if display_facet_or_field_config.is_a? Blacklight::FacetFieldPresenter
         @facet_field_presenter = display_facet_or_field_config
         @field_config = @facet_field_presenter.facet_field
@@ -30,9 +30,10 @@ module Blacklight
         raise ArgumentError, 'You must provide one of display_facet or field_config' unless @field_config
       end
 
+      @component = component || (@field_config.component == true ? Blacklight::FacetFieldListComponent : @field_config.component)
       @component_args = component_args
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists
 
     def render?
       helpers.should_render_field?(@field_config, @display_facet)
@@ -41,10 +42,8 @@ module Blacklight
     def call
       return render_partial if @field_config.partial
 
-      component = @field_config.component == true ? Blacklight::FacetFieldListComponent : @field_config.component
-
       render(
-        component.new(
+        @component.new(
           facet_field: @facet_field_presenter || helpers.facet_field_presenter(@field_config, @display_facet),
           **@component_args
         )

data/app/components/blacklight/search_context_component.html.erb

@@ -1,10 +1,10 @@
 <div class='pagination-search-widgets'>
 
   <div class="page-links">
-    <%= link_to_previous_document @search_context[:prev] %> |
+    <%= link_to_previous_document %> |
 
     <%= item_page_entry_info %> |
 
-    <%= link_to_next_document @search_context[:next] %>
+    <%= link_to_next_document %>
   </div>
 </div>

data/app/components/blacklight/search_context_component.rb

@@ -19,15 +19,15 @@ module Blacklight
       end
     end
 
-    def link_to_previous_document(*args)
+    def link_to_previous_document(document = nil, *args, **kwargs)
       Deprecation.silence(Blacklight::UrlHelperBehavior) do
-        helpers.link_to_previous_document(*args)
+        helpers.link_to_previous_document(document || @search_context[:prev], *args, **kwargs)
       end
     end
 
-    def link_to_next_document(*args)
+    def link_to_next_document(document = nil, *args, **kwargs)
       Deprecation.silence(Blacklight::UrlHelperBehavior) do
-        helpers.link_to_next_document(*args)
+        helpers.link_to_next_document(document || @search_context[:next], *args, **kwargs)
       end
     end
   end

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

@@ -253,6 +253,7 @@ module Blacklight::Catalog
   # By default, any search action from a Blacklight::Catalog controller
   # should use the current controller when constructing the route.
   def search_action_url options = {}
+    options = options.to_h if options.is_a? Blacklight::SearchState
     url_for(options.reverse_merge(action: 'index'))
   end
 

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -52,8 +52,8 @@ module Blacklight::UrlHelperBehavior
   ##
   # Link to the previous document in the current search context
   # @deprecated
-  def link_to_previous_document(previous_document)
-    link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: "previous", rel: 'prev')
+  def link_to_previous_document(previous_document, classes: 'previous', **addl_link_opts)
+    link_opts = session_tracking_params(previous_document, search_session['counter'].to_i - 1).merge(class: classes, rel: 'prev').merge(addl_link_opts)
     link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), url_for_document(previous_document), link_opts do
       tag.span raw(t('views.pagination.previous')), class: 'previous'
     end
@@ -63,8 +63,8 @@ module Blacklight::UrlHelperBehavior
   ##
   # Link to the next document in the current search context
   # @deprecated
-  def link_to_next_document(next_document)
-    link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: "next", rel: 'next')
+  def link_to_next_document(next_document, classes: 'next', **addl_link_opts)
+    link_opts = session_tracking_params(next_document, search_session['counter'].to_i + 1).merge(class: classes, rel: 'next').merge(addl_link_opts)
     link_to_unless next_document.nil?, raw(t('views.pagination.next')), url_for_document(next_document), link_opts do
       tag.span raw(t('views.pagination.next')), class: 'next'
     end

data/app/models/search.rb

@@ -3,7 +3,8 @@
 class Search < ApplicationRecord
   belongs_to :user, optional: true
 
-  serialize :query_params
+  # use a backwards-compatible serializer until the Rails API stabilizes and we can evaluate for major-revision compatibility
+  serialize :query_params, Blacklight::SearchParamsYamlCoder
 
   # A Search instance is considered a saved search if it has a user_id.
   def saved?

data/app/services/blacklight/search_params_yaml_coder.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # This is a custom YAML coder for (de)serializing blacklight search parameters that
+  # supports deserializing HashWithIndifferentAccess parameters (as was historically done by Blacklight).
+  class SearchParamsYamlCoder
+    # Serializes an attribute value to a string that will be stored in the database.
+    def self.dump(obj)
+      # Convert HWIA to an ordinary hash so we have some hope of using the regular YAML encoder in the future
+      obj = obj.to_hash if obj.is_a?(ActiveSupport::HashWithIndifferentAccess)
+
+      YAML.dump(obj)
+    end
+
+    # Deserializes a string from the database to an attribute value.
+    def self.load(yaml)
+      return yaml unless yaml.is_a?(String) && yaml.start_with?("---")
+
+      params = yaml_load(yaml)
+
+      params.with_indifferent_access
+    end
+
+    # rubocop:disable Security/YAMLLoad
+    if YAML.respond_to?(:unsafe_load)
+      def self.yaml_load(payload)
+        if ActiveRecord.try(:use_yaml_unsafe_load) || ActiveRecord::Base.try(:use_yaml_unsafe_load)
+          YAML.unsafe_load(payload)
+        else
+          permitted_classes = (ActiveRecord.try(:yaml_column_permitted_classes) || ActiveRecord::Base.try(:yaml_column_permitted_classes) || []) +
+                              Blacklight::Engine.config.blacklight.search_params_permitted_classes
+          YAML.safe_load(payload, permitted_classes: permitted_classes, aliases: true)
+        end
+      end
+    else
+      def self.yaml_load(payload)
+        if ActiveRecord.try(:use_yaml_unsafe_load) || ActiveRecord::Base.try(:use_yaml_unsafe_load)
+          YAML.load(payload)
+        else
+          permitted_classes = (ActiveRecord.try(:yaml_column_permitted_classes) || ActiveRecord::Base.try(:yaml_column_permitted_classes) || []) +
+                              Blacklight::Engine.config.blacklight.search_params_permitted_classes
+          YAML.safe_load(payload, permitted_classes: permitted_classes, aliases: true)
+        end
+      end
+    end
+    # rubocop:enable Security/YAMLLoad
+  end
+end

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

@@ -1,6 +1,6 @@
 <div class='card card-default'>
   <div class="card-body">
-    <h4 class="card-title">Search tips</h4>
+    <h2 class="h4 card-title">Search tips</h4>
     <ul class="advanced-help">
      <li>Select "match all" to require all fields.
      </li>

data/app/views/catalog/index.json.jbuilder

@@ -67,14 +67,16 @@ json.included do
     end
   end
 
-  json.array! search_fields do |(label, key)|
-    json.type 'search_field'
-    json.id key
-    json.attributes do
-      json.label label
-    end
-    json.links do
-      json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
+  Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+    json.array! search_fields do |(label, key)|
+      json.type 'search_field'
+      json.id key
+      json.attributes do
+        json.label label
+      end
+      json.links do
+        json.self url_for(search_state.to_h.merge(search_field: key, only_path: false))
+      end
     end
   end
 

data/lib/blacklight/engine.rb

@@ -59,6 +59,8 @@ module Blacklight
       outer_window: 2
     }
 
+    bl_global_config.search_params_permitted_classes = [ActiveSupport::HashWithIndifferentAccess, Symbol]
+
     # Anything that goes into Blacklight::Engine.config is stored as a class
     # variable on Railtie::Configuration.  we're going to encapsulate all the
     # Blacklight specific stuff in this single struct:

data/lib/blacklight/search_builder.rb

@@ -27,7 +27,7 @@ module Blacklight
       end
 
       @blacklight_params = {}
-      search_state_class = @scope&.search_state_class || Blacklight::SearchState
+      search_state_class = @scope.try(:search_state_class) || Blacklight::SearchState
       @search_state = search_state_class.new(@blacklight_params, @scope&.blacklight_config, @scope)
       @additional_filters = {}
       @merged_params = {}

data/spec/components/blacklight/facet_component_spec.rb

@@ -26,6 +26,25 @@ RSpec.describe Blacklight::FacetComponent, type: :component do
     expect(rendered).to have_selector 'ul.facet-values'
   end
 
+  context 'with a provided component' do
+    let(:component_kwargs) { { field_config: facet_config, display_facet: display_facet, component: component_class } }
+    let(:component_class) do
+      Class.new(Blacklight::FacetFieldListComponent) do
+        def self.name
+          'CustomFacetComponent'
+        end
+
+        def call
+          'Custom facet rendering'
+        end
+      end
+    end
+
+    it 'renders the provided component' do
+      expect(rendered).to have_content 'Custom facet rendering'
+    end
+  end
+
   context 'with a facet configured to use a partial' do
     let(:facet_config) do
       Blacklight::Configuration::FacetField.new(key: 'field', partial: 'catalog/facet_partial').normalize!

data/spec/models/search_spec.rb

@@ -1,32 +1,51 @@
 # frozen_string_literal: true
 
 RSpec.describe Search do
+  let(:search) { described_class.new(user: user) }
   let(:user) { User.create! email: 'xyz@example.com', password: 'xyz12345' }
+  let(:hash_params) { { q: "query", f: { facet: "filter" } } }
+  let(:query_params) { hash_params }
 
   describe "query_params" do
-    before do
-      @search = described_class.new(user: user)
-      @query_params = { q: "query", f: "facet" }
+    shared_examples "persisting query_params" do
+      it "can save and retrieve the hash" do
+        search.query_params = query_params
+        search.save!
+        expect(described_class.find(search.id).query_params).to eq query_params.with_indifferent_access
+      end
     end
 
-    it "can save and retrieve the hash" do
-      @search.query_params = @query_params
-      @search.save!
-      expect(described_class.find(@search.id).query_params).to eq @query_params
+    context "are an indifferent hash" do
+      include_context "persisting query_params" do
+        let(:query_params) { hash_params.with_indifferent_access }
+      end
+    end
+
+    context "are a string-keyed hash" do
+      include_context "persisting query_params" do
+        let(:query_params) { hash_params.with_indifferent_access.to_hash }
+      end
+    end
+
+    context "include symbol keys" do
+      include_context "persisting query_params" do
+        let(:query_params) { hash_params }
+      end
     end
   end
 
   describe "saved?" do
     it "is true when user_id is not NULL and greater than 0" do
-      @search = described_class.new(user: user)
-      @search.save!
-
-      expect(@search).to be_saved
+      search.save!
+      expect(search).to be_saved
     end
 
-    it "is false when user_id is NULL or less than 1" do
-      @search = described_class.create
-      expect(@search).not_to be_saved
+    context "when user_id is NULL or less than 1" do
+      let(:search) { described_class.create }
+
+      it "is false" do
+        expect(search).not_to be_saved
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.27.0
+  version: 7.29.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,10 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -577,6 +577,7 @@ files:
 - app/presenters/blacklight/thumbnail_presenter.rb
 - app/services/blacklight/document_factory.rb
 - app/services/blacklight/field_retriever.rb
+- app/services/blacklight/search_params_yaml_coder.rb
 - app/services/blacklight/search_service.rb
 - app/values/blacklight/types.rb
 - app/views/blacklight/nav/_bookmark.html.erb
@@ -933,7 +934,7 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -948,8 +949,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.