blacklight 7.33.0 → 8.0.0

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/session_tracking_config.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Blacklight::Configuration
+  class SessionTrackingConfig < Blacklight::OpenStructWithHashAccess
+    # @!attribute storage
+    #   @return [String, FalseClass] 'server': use server-side tracking; 'client': delegate search tracking and prev/next navigation to client
+    # @!attribute applied_params_component
+    #   @return [Class] component class used to render a facet group
+    # @!attribute item_pagination_component
+    #   @return [Class] component class used to render the constraints
+
+    def initialize(property_hash = {})
+      super({ storage: 'server' }.merge(property_hash))
+    end
+
+    def applied_params_component
+      super || default_applied_params_component(storage)
+    end
+
+    def item_pagination_component
+      super || default_item_pagination_component(storage)
+    end
+
+    def url_helper
+      super || default_url_helper(storage)
+    end
+
+    def default_applied_params_component(storage)
+      return Blacklight::SearchContext::ServerAppliedParamsComponent if storage == 'server'
+
+      nil
+    end
+
+    def default_item_pagination_component(storage)
+      return Blacklight::SearchContext::ServerItemPaginationComponent if storage == 'server'
+
+      nil
+    end
+
+    # extension point for alternative storage types
+    def default_url_helper(_storage)
+      nil
+    end
+  end
+end

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,30 @@ 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
-    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?
-
+    # @!attribute search_header_component
+    #   @return [Class] component class used to render the header above the documents
+    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.