blacklight 7.37.0 → 8.0.0.beta1

data/lib/blacklight/configuration/facet_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::FacetField < Blacklight::Configuration::Field
     ##
@@ -19,9 +20,6 @@ module Blacklight
     #   @return [Symbol|Hash] the i18n localization option for a date or time value; used as the second parameter for the I18n.l method
     # @!attribute link_to_facet
     #   @return [Boolean]
-    # @!attribute link_to_search
-    #   @deprecated use link_to_facet instead.
-    #   @return [Boolean]
     # @!attribute helper_method
     #   @return [Symbol] the name of a helper method used to display the facet's value to the user; it receives the facet value.
     # @!attribute url_method
@@ -67,22 +65,20 @@ module Blacklight
     # @!attribute partial
     #   @return [String] Rails view partial used to render the facet field
 
-    extend Deprecation
-
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def normalize! blacklight_config = nil
       query.stringify_keys! if query
 
+      normalize_pivot_config! if pivot
       self.collapse = true if collapse.nil?
       self.show = true if show.nil?
       self.if = show if self.if.nil?
       self.index_range = 'A'..'Z' if index_range == true
       self.presenter ||= Blacklight::FacetFieldPresenter
-
-      if link_to_search
-        Deprecation.warn(Blacklight::Configuration::FacetField, '`link_to_search:` is deprecated, use `link_to_facet:` instead')
-        self.link_to_facet = link_to_search if link_to_facet.nil?
-      end
-
+      self.item_presenter ||= Blacklight::FacetItemPresenter
+      self.component = Blacklight::FacetFieldListComponent if component.nil? || component == true
+      self.advanced_search_component ||= Blacklight::FacetFieldCheckboxesComponent
+      self.item_component ||= Blacklight::FacetItemComponent
       super
 
       if single && tag.blank? && ex.blank?
@@ -92,5 +88,15 @@ module Blacklight
 
       self
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    private
+
+    def normalize_pivot_config!
+      self.item_presenter ||= Blacklight::FacetItemPivotPresenter
+      self.item_component ||= Blacklight::FacetItemPivotComponent
+      self.filter_class ||= Blacklight::SearchState::PivotFilterField
+      self.filter_query_builder ||= Blacklight::SearchState::PivotFilterField::QueryBuilder
+    end
   end
 end

data/lib/blacklight/configuration/field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::Field < OpenStructWithHashAccess
     # @!attribute field

data/lib/blacklight/configuration/fields.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration
     # This mixin provides Blacklight::Configuration with generic
     # solr fields configuration
     module Fields
       extend ActiveSupport::Concern
-      extend Deprecation
-      self.deprecation_horizon = 'blacklight version 8.0.0'
 
       class_methods do
         # Add a configuration block for a collection of solr fields
@@ -84,20 +83,20 @@ module Blacklight
       #
       def add_blacklight_field config_key, *args, &block
         field_config = case args.first
-                         when String
-                           field_config_from_key_and_hash(config_key, *args)
-                         when Symbol
-                           args[0] = args[0].to_s
-                           field_config_from_key_and_hash(config_key, *args)
-                         when Array
-                           field_config_from_array(config_key, *args, &block)
-                           return # we've iterated over the array above.
-                         else
-                           field_config_from_field_or_hash(config_key, *args)
+                       when String
+                         field_config_from_key_and_hash(config_key, *args)
+                       when Symbol
+                         args[0] = args[0].to_s
+                         field_config_from_key_and_hash(config_key, *args)
+                       when Array
+                         field_config_from_array(config_key, *args, &block)
+                         return # we've iterated over the array above.
+                       else
+                         field_config_from_field_or_hash(config_key, *args)
                        end
 
         if (field_config.field || field_config.key).to_s =~ /\*/
-          field_config.match = Regexp.new("^" + (field_config.field || field_config.key).to_s.gsub('*', '.+') + "$")
+          field_config.match = Regexp.new("^#{(field_config.field || field_config.key).to_s.gsub('*', '.+')}$")
         end
 
         # look up any dynamic fields
@@ -155,8 +154,6 @@ module Blacklight
 
         @table[:reflected_fields] || {}
       end
-      alias luke_fields reflected_fields
-      deprecation_deprecate luke_fields: 'use reflected_fields instead'
 
       # Add a solr field by a solr field name and hash
       def field_config_from_key_and_hash config_key, field_name, field_or_hash = {}

data/lib/blacklight/configuration/index_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::IndexField < Blacklight::Configuration::DisplayField
   end

data/lib/blacklight/configuration/null_display_field.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Returned if no config is defined for a display field in the Blacklight::Configuration
+  class Configuration::NullDisplayField < Blacklight::Configuration::DisplayField
+    def initialize(field_or_hash = nil)
+      case field_or_hash
+      when String, Symbol
+        super(field: field_or_hash)
+      else
+        super
+      end
+
+      normalize!
+    end
+  end
+end

data/lib/blacklight/configuration/search_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::SearchField < Blacklight::Configuration::Field
     # @!attribute include_in_simple_select

data/lib/blacklight/configuration/show_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::ShowField < Blacklight::Configuration::DisplayField
   end

data/lib/blacklight/configuration/sort_field.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::SortField < Blacklight::Configuration::Field
     # @!attribute sort

data/lib/blacklight/configuration/tool_config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration::ToolConfig < OpenStructWithHashAccess
     # @!attribute partial

data/lib/blacklight/configuration/view_config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Blacklight::Configuration
   class ViewConfig < Blacklight::OpenStructWithHashAccess
     # @!attribute template
@@ -23,25 +24,34 @@ class Blacklight::Configuration
     #   @return [Class] component class used to render the constraints
     # @!attribute search_bar_component
     #   @return [Class] component class used to render the search bar
+    # @!attribute search_header_component
+    #   @return [Class] component class used to render the header above the documents
     def search_bar_presenter_class
       super || Blacklight::SearchBarPresenter
     end
 
-    def display_label(deprecated_key = nil, **options)
-      Deprecation.warn(Blacklight::Configuration::ViewConfig, 'Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
-
+    def display_label(**options)
       I18n.t(
-        :"blacklight.search.view_title.#{deprecated_key || key}",
+        :"blacklight.search.view_title.#{key}",
         default: [
-          :"blacklight.search.view.#{deprecated_key || key}",
+          :"blacklight.search.view.#{key}",
           label,
           title,
-          (deprecated_key || key).to_s.humanize
+          key.to_s.humanize
         ],
         **options
       )
     end
 
+    # Translate an ordinary field into the expected DisplayField object
+    def title_field=(value)
+      if value.is_a?(Blacklight::Configuration::Field) && !value.is_a?(Blacklight::Configuration::DisplayField)
+        super(Blacklight::Configuration::DisplayField.new(value.to_h))
+      else
+        super
+      end
+    end
+
     class Show < ViewConfig
       # @!attribute route
       #   @return [Hash] Default route parameters for 'show' requests.