blacklight 7.33.1 → 7.35.0

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -270,9 +270,9 @@ module Blacklight::BlacklightHelperBehavior
   #
   # @param [Hash] query_params the query parameters to check
   # @return [Symbol]
-  def document_index_view_type query_params = params
+  def document_index_view_type query_params = params || {}
     view_param = query_params[:view]
-    view_param ||= session[:preferred_view]
+    view_param ||= session[:preferred_view] if respond_to?(:session)
     if view_param && document_index_views.key?(view_param.to_sym)
       view_param.to_sym
     else

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -69,6 +69,7 @@ module Blacklight::RenderPartialsHelperBehavior
     if template
       template.render(self, locals.merge(document: doc))
     else
+      logger.warn("No template was found for base_name: '#{base_name}', view_type: '#{view_type}' in render_document_partial")
       ''
     end
   end

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/concerns/blacklight/document/attributes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'active_model/conversion'
+
+module Blacklight::Document
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :attribute_types, instance_accessor: false
+      self.attribute_types = Hash.new(Blacklight::Types::Value)
+    end
+
+    class_methods do
+      # Define an attribute reader on a document model
+      # @param [Symbol] name the name of the attribute to define
+      # @param [Symbol, Class] type the type of the attribute to define
+      # @param [String] field the name of the document's field to use for this attribute
+      # @param [any, Proc] default the default value for the attribute
+      # @example
+      #   class SolrDocument
+      #     include Blacklight::Solr::Document
+      #     attribute :title, :string, 'title_tesim'
+      #
+      #     Deprecated syntax:
+      #     attribute :title, Blacklight::Types::String, 'title_tesim'
+      #   end
+      #
+      #   doc = SolrDocument.new(title_tesim: ["One flew over the cuckoo's nest"])
+      #   doc.title
+      #   #=> "One flew over the cuckoo's nest"
+      def attribute(name, type = :value, deprecated_field = name, field: nil, default: nil, **kwargs)
+        field ||= deprecated_field
+
+        define_method name do
+          if type.respond_to?(:coerce) && !(type < Blacklight::Types::Value)
+            # deprecated behavior using a bespoke api
+            type.coerce(fetch(field, default))
+          else
+            # newer behavior better aligned with ActiveModel::Type
+            instance = Blacklight::Types.lookup(type, **kwargs) if type.is_a? Symbol
+            instance ||= type.new(**kwargs)
+
+            instance.cast(fetch(field, default))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,7 @@ module Blacklight::Document
   include Blacklight::Document::SemanticFields
   include Blacklight::Document::CacheKey
   include Blacklight::Document::Export
+  include Blacklight::Document::Attributes
 
   included do
     extend ActiveModel::Naming
@@ -70,13 +71,20 @@ module Blacklight::Document
   alias has_field? has?
   alias has_key? key?
 
-  def fetch key, *default
+  NO_DEFAULT_PROVIDED = Object.new # :nodoc:
+  def fetch key, default = NO_DEFAULT_PROVIDED
     if key? key
       self[key]
-    elsif default.empty? && !block_given?
-      raise KeyError, "key not found \"#{key}\""
+    elsif block_given?
+      yield(self) if block_given?
+    elsif default != NO_DEFAULT_PROVIDED
+      if default.respond_to?(:call)
+        default.call(self)
+      else
+        default
+      end
     else
-      (yield(self) if block_given?) || default.first
+      raise KeyError, "key not found \"#{key}\""
     end
   end
 
@@ -116,21 +124,5 @@ module Blacklight::Document
     def unique_key
       @unique_key ||= 'id'
     end
-
-    # Define an attribute reader on a document model
-    # @example
-    #   class SolrDocument
-    #     include Blacklight::Solr::Document
-    #     attribute :title, Blacklight::Types::String, 'title_tesim'
-    #   end
-    #
-    #   doc = SolrDocument.new(title_tesim: ["One flew over the cuckoo's nest"])
-    #   doc.title
-    #   #=> "One flew over the cuckoo's nest"
-    def attribute(name, type, field)
-      define_method name do
-        type.coerce(self[field])
-      end
-    end
   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/presenters/blacklight/rendering/join.rb

@@ -5,7 +5,7 @@ module Blacklight
     class Join < AbstractStep
       def render
         options = config.separator_options || {}
-        next_step(values.map { |x| html_escape(x) }.to_sentence(options).html_safe)
+        next_step(values.map { |x| x.html_safe? ? x : html_escape(x) }.to_sentence(options).html_safe)
       end
 
       private

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/app/values/blacklight/types.rb

@@ -1,31 +1,119 @@
 # frozen_string_literal: true
 
+require "active_model"
+
 module Blacklight
   # These are data types that blacklight can use to coerce values from the index
   module Types
-    class Array
+    @registry = ActiveModel::Type::Registry.new
+
+    class << self
+      delegate :lookup, :register, to: :@registry
+    end
+
+    class Value
       def self.coerce(input)
-        ::Array.wrap(input)
+        new.cast(input)
+      end
+
+      def initialize(**kwargs)
+        @kwargs = kwargs
+      end
+
+      def cast(input)
+        if input.is_a?(::Array)
+          input.first
+        else
+          input
+        end
       end
     end
 
-    class String
-      def self.coerce(input)
-        ::Array.wrap(input).first
+    class Array < Value
+      def initialize(of: nil, **kwargs)
+        @of = of
+        @kwargs = kwargs
+      end
+
+      def cast(input)
+        ::Array.wrap(input).map do |value|
+          lookup_type.cast(value)
+        end
+      end
+
+      private
+
+      def lookup_type
+        return Blacklight::Types::Value.new(**@kwargs) if @of.nil?
+
+        @lookup_type ||= Blacklight::Types.lookup(@of, **@kwargs)
       end
     end
 
-    class Date
-      def self.coerce(input)
-        field = String.coerce(input)
-        return if field.blank?
+    class String < Value
+      def cast(input)
+        super&.to_s
+      end
+    end
+
+    class Date < Value
+      def cast(input)
+        value = super
+        return if value.blank?
 
         begin
-          ::Date.parse(field)
+          ::Date.parse(value.to_s)
         rescue ArgumentError
-          Rails.logger&.info "Unable to parse date: #{field.first.inspect}"
+          Rails.logger&.info "Unable to parse date: #{value.inspect}"
         end
       end
     end
+
+    class Boolean < Value
+      def cast(input)
+        ActiveModel::Type::Boolean.new.cast(super)
+      end
+    end
+
+    class JsonValue < Value
+      def cast(input)
+        value = super
+
+        return value unless value.is_a?(String)
+
+        JSON.parse(value)
+      end
+    end
+
+    class Selector < Array
+      def initialize(by: nil, block: nil, **kwargs)
+        super(**kwargs)
+        @by = by
+        @block = block
+      end
+
+      def cast(input)
+        return super.public_send(@by) unless @block
+
+        super.public_send(@by, &@block)
+      end
+    end
+
+    # rubocop:disable Rails/OutputSafety
+    class Html < String
+      def cast(input)
+        super&.html_safe
+      end
+    end
+    # rubocop:enable Rails/OutputSafety
+
+    register :boolean, Boolean
+    register :string, String
+    register :date, Date
+    register :array, Array
+    register :json, JsonValue
+    register :html, Html
+    register :select, Selector
+    register :value, Value
   end
 end

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

@@ -1,7 +1,7 @@
 <% # container for a single doc -%>
 <% 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 %>
+  <% component.public_send(view_config.document_component.blank? && view_config.partials.any? ? :with_body : :with_partial) do %>
     <%= render_document_partials document, view_config.partials, component: component, document_counter: document_counter %>
   <% end %>
 <% end %>

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

@@ -1,8 +1,8 @@
 <%= render(Blacklight::FacetFieldComponent.new(facet_field: facet_field_presenter(facet_field, nil))) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= facet_field_label(facet_field.key) %>
   <% end %>
-  <% component.body do %>
+  <% component.with_body do %>
     <%= yield %>
   <% end %>
 <% end %>

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

@@ -4,4 +4,4 @@
       advanced_search_url: search_action_url(action: 'advanced_search'),
       params: search_state.params_for_search.except(:qt),
       search_fields: Deprecation.silence(Blacklight::ConfigurationHelperBehavior) { search_fields },
-      autocomplete_path: search_action_path(action: :suggest))) %>
+      autocomplete_path: suggest_index_catalog_path)) %>

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

@@ -4,7 +4,7 @@
 <% content_for(:head) { render_link_rel_alternates } %>
 
 <%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), component: :div, title_component: :h1, show: true) do |component| %>
-  <% component.footer do %>
+  <% component.with_footer do %>
     <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
       <!--
            // COinS, for Zotero among others.
@@ -17,7 +17,7 @@
 
   <%# Use :body for complete backwards compatibility (overriding the component body markup),
         but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
-  <% component.public_send(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partial) do %>
+  <% component.public_send(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :with_body : :with_partial) do %>
     <div id="doc_<%= @document.id.to_s.parameterize %>">
       <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
     </div>

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

@@ -1,2 +1,2 @@
-<%= render 'show_tools' %>
+<%= render 'show_tools', document: document %>
 <%= render(Blacklight::Document::MoreLikeThisComponent.new(document: document)) %>

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

@@ -1,14 +1,15 @@
-<% if show_doc_actions? %>
+<% document = @document if local_assigns[:document].nil? %>
+<% if show_doc_actions? document %>
   <div class="card show-tools">
     <div class="card-header">
       <h2 class="mb-0 h6"><%= t('blacklight.tools.title') %></h2>
     </div>
     <% if render_show_doc_actions_method_from_blacklight? %>
-      <%= render(Blacklight::Document::ActionsComponent.new(document: @document, tag: 'ul', classes: 'list-group list-group-flush', wrapping_tag: 'li', wrapping_classes: 'list-group-item', actions: document_actions(@document), url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
+      <%= render(Blacklight::Document::ActionsComponent.new(document: document, tag: 'ul', classes: 'list-group list-group-flush', wrapping_tag: 'li', wrapping_classes: 'list-group-item', actions: document_actions(document), url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
     <% else %>
       <% Deprecation.warn(self, '#render_show_doc_actions is deprecated; use ActionComponents instead') %>
       <ul class="list-group list-group-flush">
-        <%= render_show_doc_actions @document do |config, inner| %>
+        <%= render_show_doc_actions document do |config, inner| %>
           <li class="list-group-item <%= config.key %>">
             <%= inner %>
           </li>

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

@@ -1,11 +1,11 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.prefix do %>
+  <% component.with_prefix do %>
     <div class="facet-pagination top row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>
   <% end %>
 
-  <% component.title { facet_field_label(@facet.key) } %>
+  <% component.with_title { facet_field_label(@facet.key) } %>
 
   <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
 
@@ -13,7 +13,7 @@
     <%= render_facet_limit(@display_facet, layout: false) %>
   </div>
 
-  <% component.footer do %>
+  <% component.with_footer do %>
     <div class="facet-pagination bottom row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>

data/app/views/layouts/blacklight/base.html.erb

@@ -28,15 +28,15 @@
     </nav>
     <%= render partial: 'shared/header_navbar' %>
 
-  <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
-    <%= content_for(:container_header) %>
+    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+      <%= content_for(:container_header) %>
 
-    <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
+      <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
 
-    <div class="row">
-      <%= content_for?(:content) ? yield(:content) : yield %>
-    </div>
-  </main>
+      <div class="row">
+        <%= content_for?(:content) ? yield(:content) : yield %>
+      </div>
+    </main>
 
     <%= render partial: 'shared/footer' %>
     <%= render partial: 'shared/modal' %>

data/app/views/shared/_header_navbar.html.erb

@@ -1,22 +1 @@
-<nav class="navbar navbar-expand-md navbar-dark bg-dark topbar" role="navigation">
-  <div class="<%= container_classes %>">
-    <%= link_to application_name, root_path, class: 'mb-0 navbar-brand navbar-logo' %>
-    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-bs-toggle="collapse" data-target="#user-util-collapse" data-bs-target="#user-util-collapse" aria-controls="user-util-collapse" aria-expanded="false" aria-label="Toggle navigation">
-      <span class="navbar-toggler-icon"></span>
-    </button>
-
-    <div class="collapse navbar-collapse justify-content-md-end" id="user-util-collapse">
-      <%= render 'shared/user_util_links' %>
-    </div>
-  </div>
-</nav>
-
-<%= content_tag :div, class: 'navbar-search navbar navbar-light bg-light', role: 'navigation', aria: { label: t('blacklight.search.header') } do %>
-  <div class="<%= container_classes %>">
-    <%= render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component ||Blacklight::SearchBarComponent).new(
-          url: search_action_url,
-          advanced_search_url: search_action_url(action: 'advanced_search'),
-          params: search_state.params_for_search.except(:qt),
-          autocomplete_path: search_action_path(action: :suggest))) %>
-  </div>
-<% end %>
+<%= render blacklight_config.header_component.new(blacklight_config: blacklight_config) %>

data/blacklight.gemspec

@@ -25,22 +25,21 @@ 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
   s.add_dependency "deprecation"
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '~> 2.66'
+  s.add_dependency "view_component", '>= 2.66', '< 4'
   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'
-  s.add_development_dependency 'webdrivers'
   s.add_development_dependency 'selenium-webdriver'
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"

data/config/locales/blacklight.en.yml

@@ -249,6 +249,7 @@ en:
       more_options: More options
       any_of: 'Any of:'
       op:
+        label: search operator
         must: all
         should: any
       page_title: Advanced search - %{application_name}

data/docker-compose.yml

@@ -17,6 +17,7 @@ services:
     environment:
       - SOLR_URL # Set via environment variable or use default defined in .env file
       - RAILS_VERSION # Set via environment variable or use default defined in .env file
+      - VIEW_COMPONENT_VERSION # Set via environment variable or use default defined in .env file
       - SOLR_ENV=docker-compose
       - ENGINE_CART_RAILS_OPTIONS=--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test --skip-solr
 

data/lib/blacklight/configuration.rb

@@ -20,16 +20,42 @@ module Blacklight
       autoload :ShowField
     end
 
+    class_attribute :default_values, default: {}
+
     # Set up Blacklight::Configuration.default_values to contain the basic, required Blacklight fields
     class << self
       def property(key, default: nil)
         default_values[key] = default
       end
 
-      def default_values
-        @default_values ||= {}
+      def default_configuration(&block)
+        @default_configurations ||= []
+
+        if block
+          @default_configurations << block
+
+          block.call if @default_configuration_initialized
+        end
+
+        @default_configurations
+      end
+
+      def initialize_default_configuration
+        @default_configurations&.map(&:call)
+        @default_configuration_initialized = true
       end
+
+      def initialized_default_configuration?
+        @default_configuration_initialized
+      end
+    end
+
+    property :logo_link
+    property :header_component, default: nil
+    def header_component
+      super || Blacklight::HeaderComponent
     end
+
     # === Search request configuration
 
     # @!attribute http_method
@@ -52,6 +78,10 @@ module Blacklight
     # @since v5.2.0
     # @return [String] The url path (relative to the solr base url) to use when requesting only a single document
     property :document_solr_path, default: 'get'
+    # @!attribute json_solr_path
+    # @since v7.34.0
+    # @return [String] The url path (relative to the solr base url) to use when using Solr's JSON Query DSL (as with the advanced search)
+    property :json_solr_path, default: nil
     # @!attribute document_unique_id_param
     # @since v5.2.0
     # @return [Symbol] The solr query parameter used for sending the unique identifiers for one or more documents
@@ -357,6 +387,8 @@ module Blacklight
     define_field_access :email_field, Blacklight::Configuration::DisplayField
 
     def initialize(hash = {})
+      self.class.initialize_default_configuration unless self.class.initialized_default_configuration?
+
       super(self.class.default_values.deep_dup.merge(hash))
       yield(self) if block_given?
 
@@ -368,6 +400,11 @@ module Blacklight
       repository_class.new(self)
     end
 
+    # @return [String] The destination for the link around the logo in the header
+    def logo_link
+      super || Rails.application.routes.url_helpers.root_path
+    end
+
     # DSL helper
     # @yield [config]
     # @yieldparam [Blacklight::Configuration]

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
@@ -14,6 +25,10 @@ module Blacklight
       end
     end
 
+    config.after_initialize do
+      Blacklight::Configuration.initialize_default_configuration
+    end
+
     # This makes our rake tasks visible.
     rake_tasks do
       Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..'))) do

data/lib/blacklight/solr/repository.rb

@@ -20,7 +20,7 @@ module Blacklight::Solr
     # Execute a search query against solr
     # @param [Hash] params solr query parameters
     def search params = {}
-      send_and_receive blacklight_config.solr_path, params.reverse_merge(qt: blacklight_config.qt)
+      send_and_receive search_path(params), params.reverse_merge(qt: blacklight_config.qt)
     end
 
     # @param [Hash] request_params
@@ -77,7 +77,7 @@ module Blacklight::Solr
     # @return [Hash]
     # @!visibility private
     def build_solr_request(solr_params)
-      if solr_params[:json].present?
+      if uses_json_query_dsl?(solr_params)
         {
           data: { params: solr_params.to_hash.except(:json) }.merge(solr_params[:json]).to_json,
           method: :post,
@@ -121,5 +121,17 @@ module Blacklight::Solr
         []
       end
     end
+
+    # @return [String]
+    def search_path(solr_params)
+      return blacklight_config.json_solr_path if blacklight_config.json_solr_path && uses_json_query_dsl?(solr_params)
+
+      blacklight_config.solr_path
+    end
+
+    # @return [Boolean]
+    def uses_json_query_dsl?(solr_params)
+      solr_params[:json].present?
+    end
   end
 end