update manifest conditional format by asset type

app/models/sample_manifest/column_conditional_format_updater.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+# This class is responsible for updating the conditional formatting for columns in the manifest.
+# The formatting is applied based on the asset type, specifically targeting columns related to library assets.
+#
+# Example Usage:
+#   conditional_updater = ConditionalFormatUpdater.new(columns: columns, asset_type: 'library')
+#   conditional_updater.update_by_asset_type
+# SampleManifest::Generator
+class SampleManifest::ColumnConditionalFormatUpdater
+  # Predefined conditional formats for required fields.
+  REQUIRED_COLUMNS_CONDITIONAL_FORMATS = [
+    SequencescapeExcel::ConditionalFormatting.new(
+      name: 'empty_mandatory_cell',
+      options: {
+        'type' => :cellIs,
+        'formula' => 'FALSE',
+        'operator' => :equal,
+        'priority' => 1
+      },
+      style: {
+        'bg_color' => 'DC3545',
+        'type' => :dxf
+      }
+    ),
+    SequencescapeExcel::ConditionalFormatting.new(
+      name: 'is_error',
+      options: {
+        'type' => :expression,
+        'priority' => 2
+      },
+      style: {
+        'bg_color' => 'FF0000',
+        'type' => :dxf
+      }
+    )
+  ].freeze
+
+  # Initializes the conditional format updater with columns and asset type.
+  #
+  # @param columns [Array<Column>] The collection of columns to be updated.
+  # @param asset_type [String] The type of the asset (e.g., 'library', 'library_plate').
+  def initialize(columns:, asset_type:)
+    @columns = columns
+    @asset_type = asset_type
+  end
+
+  # Checks if the asset is a library asset.
+  # @return [Boolean] Returns true if the asset type is either 'library' or 'library_plate'.
+  def library_asset?
+    %w[library library_plate].include?(@asset_type)
+  end
+
+  # Updates the conditional formatting for columns based on the asset type.
+  # Currently, it applies conditional formatting for library assets only.
+  # If the asset type is not library, no formatting is applied.
+  #
+  # @return [Array<Column>] The updated columns with conditional formatting applied.
+  def update_column_formatting_by_asset_type
+    if library_asset?
+      update_columns_formatting(%w[library_type insert_size_from insert_size_to], REQUIRED_COLUMNS_CONDITIONAL_FORMATS)
+    else
+      @columns
+    end
+  end
+
+  # Updates the conditional formatting for the specified columns.
+  # It applies the given set of conditional formats to the matching columns.
+  #
+  # @param columns_to_update [Array<string>] The list of column names to update.
+  # @param conditional_formats [Array<SequencescapeExcel::ConditionalFormatting>] The conditional formats to apply.
+  # @return [Array<Column>] The updated columns with the new conditional formatting.
+  def update_columns_formatting(columns_to_update, conditional_formats)
+    columns_to_update
+      .filter_map { |rc| @columns.find_by(:name, rc) }
+      .each do |column|
+        column.conditional_formattings.reset!
+        conditional_formats.each { |format| column.conditional_formattings.add(format) }
+      end
+    @columns
+  end
+end

app/models/sample_manifest/generator.rb

@@ -28,8 +28,24 @@ def initialize(params, user, configuration)
     @params = params
   end
 
+  # Retrieves and caches the columns for the current template configuration.
+  # This method first fetches the columns based on the provided template parameter.
+  # Then, it applies conditional formatting updates based on the asset type
+  # using the `SampleManifest::ColumnConditionalFormatUpdater` class.
+  #
+  # The conditional formatting is adjusted dynamically depending on whether
+  # the asset type requires specific formatting rules (e.g., for library assets).
+  #
+  # @return [Array<Column>] The columns associated with the specified template, with conditional formatting
+  #         updated if any.
+
   def columns
     @columns ||= configuration.columns.find(params[:template])
+    return unless asset_type
+    SampleManifest::ColumnConditionalFormatUpdater.new(
+      columns: @columns,
+      asset_type: asset_type
+    ).update_column_formatting_by_asset_type
   end
 
   def print_job_required?
@@ -105,7 +121,7 @@ def attributes
   end
 
   def asset_type
-    configuration.manifest_types.find_by(params[:template]).asset_type
+    configuration.manifest_types.find_by(params[:template])&.asset_type
   end
 
   # Retrieves the value of the rows_per_well attribute from the manifest_types.yml config.

spec/models/sample_manifest/column_conditional_format_updater_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe SampleManifest::ColumnConditionalFormatUpdater do
+  let(:columns) { instance_double(SequencescapeExcel::Column) }
+
+  describe '#library_asset?' do
+    subject { described_class.new(columns:, asset_type:).library_asset? }
+
+    context 'when asset type is a library' do
+      let(:asset_type) { 'library_plate' }
+
+      it { is_expected.to be true }
+    end
+
+    context 'when asset type is not a library' do
+      let(:asset_type) { 'plate' }
+
+      it { is_expected.to be false }
+    end
+  end
+
+  describe '#update_column_formatting_by_asset_type' do
+    before do
+      SampleManifestExcel.configure do |config|
+        config.folder = File.join('spec', 'data', 'sample_manifest_excel')
+        config.load!
+      end
+    end
+
+    context 'when asset type is a library' do
+      let(:columns) { SampleManifestExcel.configuration.columns.tube_library_with_tag_sequences }
+      let(:asset_type) { 'library' }
+      let(:updater) { described_class.new(columns:, asset_type:) }
+      let(:required_column) { columns.find_by(:name, 'library_type') }
+      let(:non_required_column) { columns.find_by(:name, 'reference_genome') }
+
+      # rubocop:disable RSpec/MultipleExpectations
+      it 'updates the conditional format for the required columns' do
+        init_required_column_format = required_column.conditional_formattings.find_by(:name, 'empty_cell')
+        expect(init_required_column_format).not_to be_nil
+        updater.update_column_formatting_by_asset_type
+        expect(required_column.conditional_formattings.find_by(:name, 'empty_cell')).to be_nil
+        expect(required_column.conditional_formattings.find_by(:name, 'empty_mandatory_cell')).not_to be_nil
+      end
+      # rubocop:enable RSpec/MultipleExpectations
+
+      it 'does not change the format for non-required columns' do
+        initial_format = non_required_column.conditional_formattings.dup
+        updater.update_column_formatting_by_asset_type
+        expect(non_required_column.conditional_formattings).to eq(initial_format)
+      end
+    end
+
+    context 'when asset type is not a library' do
+      let(:columns) { SampleManifestExcel.configuration.columns.tube_multiplexed_library }
+      let(:asset_type) { 'multiplexed_library' }
+      let(:updater) { described_class.new(columns:, asset_type:) }
+      let(:library_type_column) { columns.find_by(:name, 'library_type') }
+
+      it 'does not update the conditional format' do
+        initial_format = library_type_column.conditional_formattings.dup
+
+        updater.update_column_formatting_by_asset_type
+
+        expect(library_type_column.conditional_formattings).to eq(initial_format)
+      end
+    end
+  end
+end

spec/models/sample_manifest/generator_spec.rb

@@ -30,6 +30,8 @@
     { template: template, study_id: study.id, supplier_id: supplier.id, count: '4' }.with_indifferent_access
   end
 
+  let(:column_updater_spy) { instance_double(SampleManifest::ColumnConditionalFormatUpdater) }
+
   after(:all) { SampleManifestExcel.reset! }
 
   it 'model name is sample manifest' do
@@ -91,6 +93,15 @@
     expect(generator.sample_manifest.asset_type).to eq(configuration.manifest_types.find_by('tube_full').asset_type)
   end
 
+  it 'calls ColumnConditionalFormatUpdater during sample manifest generation' do
+    generator = described_class.new(attributes.merge(template: 'tube_full'), user, configuration)
+    allow(column_updater_spy).to receive(:update_column_formatting_by_asset_type)
+    allow(SampleManifest::ColumnConditionalFormatUpdater).to receive(:new).and_return(column_updater_spy)
+    generator.execute
+
+    expect(column_updater_spy).to have_received(:update_column_formatting_by_asset_type)
+  end
+
   it 'prints labels if barcode printer is present' do
     allow(LabelPrinter::PmbClient).to receive(:get_label_template_by_name).and_return('data' => [{ 'id' => 15 }])