# frozen_string_literal: true
module Blacklight::ConfigurationHelperBehavior
  extend Deprecation

  ##
  # Index fields to display for a type of document
  #
  # @param [SolrDocument] _document
  # @return [Array<Blacklight::Configuration::Field>]
  def index_fields _document = nil
    Deprecation.warn(self, "index_fields is deprecated and will be removed in Blacklight 8. Use IndexPresenter#fields instead")
    blacklight_config.index_fields
  end

  ##
  # Return the available sort fields
  # @return [Array<Blacklight::Configuration::Field>]
  def active_sort_fields
    blacklight_config.sort_fields.select { |_sort_key, field_config| should_render_field?(field_config) }
  end

  # Used in the search form partial for building a select tag
  # @see #search_field_options_for_select
  def search_fields
    search_field_options_for_select
  end
  deprecation_deprecate search_fields: 'removed without replacement'

  # Returns suitable argument to options_for_select method, to create
  # an html select based on #search_field_list. Skips search_fields
  # marked :include_in_simple_select => false
  # @return [Array<Array>] the first element of the array is the label, the second is the sort field key
  def search_field_options_for_select
    blacklight_config.search_fields.collect do |_key, field_def|
      [label_for_search_field(field_def.key), field_def.key] if should_render_field?(field_def)
    end.compact
  end
  deprecation_deprecate search_field_options_for_select: 'removed without replacement'

  # used in the catalog/_show partial
  # @return [Array<Blacklight::Configuration::Field>]
  def document_show_fields _document = nil
    Deprecation.warn(self, "document_show_fields is deprecated and will be removed in Blacklight 8. Use ShowPresenter#fields instead")
    blacklight_config.show_fields
  end

  ##
  # Return a label for the currently selected search field.
  # If no "search_field" or the default (e.g. "all_fields") is selected, then return nil
  # Otherwise grab the label of the selected search field.
  # @param [Hash] localized_params query parameters
  # @return [String]
  def constraint_query_label(localized_params = params)
    label_for_search_field(localized_params[:search_field]) unless default_search_field?(localized_params[:search_field])
  end
  deprecation_deprecate constraint_query_label: 'Moving to Blacklight::ConstraintsComponent'

  ##
  # Is the search form using the default search field ("all_fields" by default)?
  # @param [String] selected_search_field the currently selected search_field
  # @return [Boolean]
  def default_search_field?(selected_search_field)
    Deprecation.silence(Blacklight::SearchFields) do
      selected_search_field.blank? || (default_search_field && selected_search_field == default_search_field[:key])
    end
  end

  ##
  # Look up the label for the index field
  # @deprecated
  # @return [String]
  def index_field_label document, field
    field_config = blacklight_config.index_fields_for(document_presenter(document).display_type)[field]
    field_config ||= Blacklight::Configuration::NullField.new(key: field)

    field_config.display_label('index')
  end
  deprecation_deprecate :index_field_label

  ##
  # Look up the label for the show field
  # @deprecated
  # @return [String]
  def document_show_field_label document, field
    field_config = blacklight_config.show_fields_for(document_presenter(document).display_type)[field]
    field_config ||= Blacklight::Configuration::NullField.new(key: field)

    field_config.display_label('show')
  end
  deprecation_deprecate :document_show_field_label

  ##
  # Look up the label for the facet field
  # @return [String]
  def facet_field_label field
    field_config = blacklight_config.facet_fields[field]
    field_config ||= Blacklight::Configuration::NullField.new(key: field)

    field_config.display_label('facet')
  end

  # Return the label for a search view
  # @return [String]
  def view_label(view)
    view_config = blacklight_config.view[view]
    view_config.display_label
  end
  deprecation_deprecate view_label: 'Moving to ViewConfig#display_label and Blacklight::Response::ViewTypeComponent'

  # Shortcut for commonly needed operation, look up display
  # label for the key specified.
  # @return [String]
  def label_for_search_field(key)
    field_config = blacklight_config.search_fields[key]
    return if key.nil? && field_config.nil?

    field_config ||= Blacklight::Configuration::NullField.new(key: key)

    field_config.display_label('search')
  end

  # @return [String]
  def sort_field_label(key)
    field_config = blacklight_config.sort_fields[key]
    field_config ||= Blacklight::Configuration::NullField.new(key: key)

    field_config.display_label('sort')
  end

  ##
  # Look up the label for a solr field.
  #
  # @overload label
  #   @param [Symbol] an i18n key
  #
  # @overload label, i18n_key, another_i18n_key, and_another_i18n_key
  #   @param [String] default label to display if the i18n look up fails
  #   @param [Symbol] i18n keys to attempt to look up
  #     before falling  back to the label
  #   @param [Symbol] any number of additional keys
  #   @param [Symbol] ...
  # @return [String]
  def field_label *i18n_keys
    first, *rest = i18n_keys.compact

    t(first, default: rest)
  end

  # @return [Hash<Symbol => Blacklight::Configuration::ViewConfig>]
  def document_index_views
    blacklight_config.view.select do |_k, config|
      should_render_field? config
    end
  end

  # filter #document_index_views to just views that should display in the view type control
  def document_index_view_controls
    document_index_views.select do |_k, config|
      config.display_control.nil? || blacklight_configuration_context.evaluate_configuration_conditional(config.display_control)
    end
  end

  ##
  # Get the default index view type
  def default_document_index_view_type
    document_index_views.select { |_k, config| config.respond_to?(:default) && config.default }.keys.first || document_index_views.keys.first
  end

  ##
  # Check if there are alternative views configuration
  # @return [Boolean]
  def has_alternative_views?
    document_index_views.keys.length > 1
  end
  deprecation_deprecate has_alternative_views?: 'Moving to Blacklight::Response::ViewTypeComponent'

  ##
  #  Maximum number of results for spell checking
  # @return [Number]
  def spell_check_max
    blacklight_config.spell_max
  end
  deprecation_deprecate spell_check_max: 'Use blacklight_config.spell_max directly'

  # Used in the document list partial (search view) for creating a link to the document show action
  # @deprecated
  def document_show_link_field document = nil
    fields = Array(blacklight_config.view_config(document_index_view_type).title_field)

    field = fields.first if document.nil?
    field ||= fields.find { |f| document.has? f }
    field &&= field&.to_sym

    field
  end
  deprecation_deprecate document_show_link_field: 'Deprecated without replacement'

  ##
  # Default sort field
  def default_sort_field
    (active_sort_fields.find { |_k, config| config.respond_to?(:default) && config.default } || active_sort_fields.first)&.last
  end

  ##
  # The default value for search results per page
  delegate :default_per_page, to: :blacklight_config
  deprecation_deprecate default_per_page: "Use blacklight_config.default_per_page instead"

  ##
  # The available options for results per page, in the style of #options_for_select
  def per_page_options_for_select
    return [] if blacklight_config.per_page.blank?

    blacklight_config.per_page.map do |count|
      [t(:'blacklight.search.per_page.label', count: count).html_safe, count]
    end
  end

  ##
  # Determine whether to render a field by evaluating :if and :unless conditions
  #
  # @param [Blacklight::Solr::Configuration::Field] field_config
  # @return [Boolean]
  def should_render_field?(field_config, *args)
    blacklight_configuration_context.evaluate_if_unless_configuration field_config, *args
  end
end