Y26 031 labware location report by retention instructions

app/controllers/location_reports_controller.rb

@@ -60,8 +60,7 @@ def location_report_params # rubocop:todo Metrics/MethodLength
       :study_id,
       :start_date,
       :end_date,
-      :barcodes,
-      :barcodes_text,
+      retention_instructions: [],
       faculty_sponsor_ids: [],
       plate_purpose_ids: []
     )

app/models/labware.rb

@@ -155,12 +155,21 @@ def receptacle_proxy
         }
 
   # Used for location report
+  def self.map_retention_instructions(values)
+    return if values.blank?
+
+    values.filter_map { |v| Labware.retention_instructions[v] }
+  end
+
   def self.search_for_labware(params)
     with_faculty_sponsor_ids(params[:faculty_sponsor_ids] || nil)
       .with_study_id(params[:study_id] || nil)
       .with_plate_purpose_ids(params[:plate_purpose_ids] || nil)
       .created_between(params[:start_date], params[:end_date])
       .filter_by_barcode(params[:barcodes] || nil)
+      .with_retention_instructions(
+        map_retention_instructions(params[:retention_instructions])
+      )
       .distinct
   end
 
@@ -186,6 +195,10 @@ def self.search_for_count_of_labware(params)
   scope :with_plate_purpose_ids,
         ->(plate_purpose_ids) { where(plate_purpose_id: plate_purpose_ids) if plate_purpose_ids.present? }
 
+  scope :with_retention_instructions, ->(retention_instructions) {
+    where(retention_instruction: retention_instructions) if retention_instructions.present?
+  }
+
   scope :created_between,
         ->(start_date, end_date) do
           where(created_at: (start_date.midnight..(end_date || Time.current).end_of_day)) if start_date.present?

app/models/location_report.rb

@@ -9,6 +9,7 @@ class LocationReport < ApplicationRecord
   serialize :faculty_sponsor_ids, type: Array, coder: YAML
   serialize :plate_purpose_ids, type: Array, coder: YAML
   serialize :barcodes, type: Array, coder: YAML
+  serialize :retention_instructions, type: Array, coder: YAML
   self.per_page = 20
   enum :report_type, { type_selection: 0, type_labwhere: 1 }
 
@@ -49,7 +50,7 @@ def check_location_barcode
   end
 
   def check_any_select_field_present
-    attr_list = %i[faculty_sponsor_ids study_id start_date end_date plate_purpose_ids barcodes]
+    attr_list = %i[faculty_sponsor_ids study_id start_date end_date plate_purpose_ids barcodes retention_instructions]
     if attr_list.all? { |attr| send(attr).blank? }
       errors.add(:base, I18n.t('location_reports.errors.no_selection_fields_filled'))
     end
@@ -119,7 +120,6 @@ def generate_report_rows # rubocop:todo Metrics/MethodLength
     end
 
     yield column_headers
-
     labware_list.each do |cur_labware|
       if cur_labware.studies.present?
         cur_labware.studies.each { |cur_study| yield(generate_report_row(cur_labware, cur_study)) }
@@ -175,13 +175,15 @@ def generate_study_cols_for_row(cur_study)
     cols << (cur_study.study_metadata.faculty_sponsor&.name || 'Unknown')
   end
 
-  def search_for_labware_by_selection
-    params = { faculty_sponsor_ids:, study_id:, start_date:, end_date:, plate_purpose_ids:, barcodes: }
+  def search_for_labware_by_selection # rubocop:todo Metrics/AbcSize
+    params = { faculty_sponsor_ids:, study_id:, start_date:, end_date:, plate_purpose_ids:, barcodes:,
+               retention_instructions: }
     count = Labware.search_for_count_of_labware(params)
     if count > configatron.fetch(:location_reports_fetch_count_max, 25000)
       errors.add(:base, I18n.t('location_reports.errors.too_many_labwares_found', count:))
       return []
     end
+
     # Only plates and tubes are currently supported by this report
     Labware.search_for_labware(params).filter { |labware| labware.is_a?(Plate) || labware.is_a?(Tube) }
   end

app/models/location_report/location_report_form.rb

@@ -10,7 +10,8 @@ class LocationReport::LocationReportForm
   include ActiveModel::AttributeMethods
 
   # Attributes
-  attr_accessor :user, :report_type, :faculty_sponsor_ids, :study_id, :start_date, :end_date, :plate_purpose_ids
+  attr_accessor :user, :report_type, :faculty_sponsor_ids, :study_id, :start_date, :end_date, :retention_instructions,
+                :plate_purpose_ids
 
   attr_accessor :barcodes_text
   attr_reader :name, :location_barcode
@@ -44,7 +45,8 @@ def location_report
           start_date: start_date&.to_datetime,
           end_date: end_date&.to_datetime,
           plate_purpose_ids: plate_purpose_ids,
-          barcodes: barcodes
+          barcodes: barcodes,
+          retention_instructions: retention_instructions
         )
   end
 

app/views/location_reports/_location_labware_selection_form.html.erb

@@ -31,6 +31,11 @@
     </div>
   </div>
 
+  <div class='form-group'>
+    <%= f.label 'retention_instructions', 'Retention instructions' %>
+    <%= f.select :retention_instructions, options_for_select(retention_instruction_option_for_select, location_report_form.retention_instructions), { include_hidden: false }, { class: 'form-control select2', :multiple => true } %>
+  </div>
+
   <div class='form-group'>
     <%= f.label 'plate_purpose_ids', 'Labware purposes (can select multiple)' %>
     <%= f.select :plate_purpose_ids, options_for_select(Purpose.alphabetical.pluck(:name, :id), location_report_form.plate_purpose_ids), { include_hidden: false }, { class: 'form-control select2', :multiple => true } %>

db/migrate/20260325134057_add_retention_instructions_to_location_reports.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class AddRetentionInstructionsToLocationReports < ActiveRecord::Migration[7.2]
+  def change
+    add_column :location_reports, :retention_instructions, :string
+  end
+end

db/schema.rb

@@ -637,6 +637,7 @@
     t.string "report_filename"
     t.datetime "created_at", precision: nil, null: false
     t.datetime "updated_at", precision: nil, null: false
+    t.string "retention_instructions"
     t.index ["study_id"], name: "index_location_reports_on_study_id"
     t.index ["user_id"], name: "index_location_reports_on_user_id"
   end