# frozen_string_literal: true

# Helper methods for catalog-like controllers that work with documents
module Blacklight::DocumentHelperBehavior
  ##
  # Get the classes to add to a document's div
  #
  # @param [Blacklight::Document] document
  # @return [String]
  def render_document_class(document = @document)
    types = document_presenter(document).display_type
    return if types.blank?

    Array(types).compact.map do |t|
      "#{document_class_prefix}#{t.try(:parameterize) || t}"
    end.join(' ')
  end

  ##
  # Return a prefix for the document classes infered from the document
  # @see #render_document_class
  # @return [String]
  def document_class_prefix
    'blacklight-'
  end

  ##
  # Render the sidebar partial for a document
  # This is used as an integration point by downstream apps to add to the
  # default sidebar.
  # See: https://github.com/geoblacklight/geoblacklight/blob/7d3c31c7af3362879b97e2c1351a2496c728c59c/app/helpers/blacklight_helper.rb#L7
  #
  # @param [SolrDocument] document
  # @deprecated
  # @return [String]
  def render_document_sidebar_partial(document)
    unless @render_document_sidebar_partials_deprecation_warning_shown
      partials = lookup_context.find_all('show_sidebar', lookup_context.prefixes, true, [], {})
      unless partials.first.identifier.starts_with? Blacklight.root
        Blacklight.deprecation.warn('The partial catalog/_show_sidebar.html.erb will not be rendered by #render_document_sidebar_partial in Blacklight 9.0.' \
                                    'Configure blacklight_config.show.sidebar_component instead (default Blacklight::Search::SidebarComponent).')
        @render_document_sidebar_partials_deprecation_warning_shown = true
      end
    end

    render 'show_sidebar', document: document
  end

  Blacklight.deprecation.deprecate_methods(self,
                                           render_document_sidebar_partial: 'has been replaced by calling the sidebar component (Blacklight::Search::SidebarComponent) directly. ' \
                                                                            'Set sidebar_component in the view config.')

  ##
  # return the Bookmarks on a set of documents (all bookmarks on the page)
  # @private
  # @return [Enumerable<Bookmark>]
  def current_bookmarks
    @current_bookmarks ||= begin
      documents = @document.presence || @response.documents
      current_or_guest_user.bookmarks_for_documents(Array(documents)).to_a
    end
  end
  private :current_bookmarks

  ##
  # Check if the document is in the user's bookmarks
  # @param [Blacklight::Document] document
  # @return [Boolean]
  def bookmarked? document
    current_bookmarks.any? { |x| x.document_id == document.id && x.document_type == document.class }
  end

  ##
  # Returns a document presenter for the given document
  def document_presenter(document)
    document_presenter_class(document).new(document, self)
  end

  ##
  # Override this method if you want to use a differnet presenter for your documents
  # @param [Blacklight::Document] _document optional, here for extension + backwards compatibility only
  def document_presenter_class(_document = nil)
    case action_name
    when 'show', 'citation'
      blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
    else
      blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
    end
  end
end