sanger/limber

# frozen_string_literal: true

module Validators
  # Displays a warning if the study-specific required number of cells option is
  # not configured for the studies on the plate. The value of the option is used
  # for calculating the required volume of a sample going into a pool by study
  # while generating the driver file. If the option is not configured, a default
  # value is used. This validator is used to alert the user that the default
  # value will be used unless the option is configured for the studies missing
  # the option.
  #
  # When the driver file is generated, the current value of the option for each
  # study is used (or the default if it is missing). Therefore, it is possible
  # for the user to configure the option after seeing the warning and download
  # the driver file again to use the correct value.
  class RequiredNumberOfCellsValidator < ActiveModel::Validator
    STUDIES_WITHOUT_REQUIRED_NUMBER_OF_CELLS =
      'The required number of cells is not configured for all studies ' \
        'going into pooling on this plate. If not provided, the default ' \
        'value %s will be used for the samples of the following studies: ' \
        '%s. This value can be configured by study in Sequencescape. If you ' \
        'edit the study with an appropriate value, please download the ' \
        'driver file again to get the updated volumes.'

    # Checks if the required number of cells is configured for all studies
    # going into pooling. If not, it adds an error message to the presenter,
    # which is displayed to the user as a warning. It does not prevent the
    # user proceeding with the pooling. The validation is applied only when
    # the labware is in the pending state.
    #
    # @param presenter [Object] the presenter object
    # @return [void]
    def validate(presenter)
      return unless presenter.labware.state == 'pending'

      studies = source_studies_without_config(presenter, study_required_number_of_cells_key(presenter))
      return if studies.empty?

      formatted_string =
        format(
          STUDIES_WITHOUT_REQUIRED_NUMBER_OF_CELLS,
          default_required_number_of_cells(presenter),
          studies.join(', ')
        )
      presenter.errors.add(:required_number_of_cells, formatted_string)
    end

    private

    # Returns the names of the studies without the required number of cells
    # configuration.
    #
    # @param presenter [Object] the presenter object associated with the plate
    # @param key [String] the poly_metadatum key for study-specific cell count
    # @return [Array<String>] the names of the studies without the configuration
    # :reek:UtilityFunction { public_methods_only: true }
    def source_studies_without_config(presenter, key)
      presenter
        .labware
        .wells_in_columns
        .flat_map(&:transfer_requests_as_target)
        .flat_map { |transfer_req| transfer_req.source_asset.aliquots }
        .flat_map(&:study)
        .select { |study| study.poly_metadatum_by_key(key).blank? }
        .map(&:name)
        .uniq
    end

    # Retrieves the default required number of cells from the purpose config.
    #
    # @return [Integer] the default required number of cells
    # :reek:UtilityFunction { public_methods_only: true }
    def default_required_number_of_cells(presenter)
      Settings.purposes[presenter.labware.purpose.uuid][:presenter_class][:args][:default_required_number_of_cells]
    end

    # Retrieves the poly_metadatum key for the study-specific required number of cells.
    #
    # @return [String] the poly_metadatum key
    # :reek:UtilityFunction { public_methods_only: true }
    def study_required_number_of_cells_key(presenter)
      Settings.purposes[presenter.labware.purpose.uuid][:presenter_class][:args][:study_required_number_of_cells_key]
    end
  end
end