Y26 031 labware location report by retention instructions

app/controllers/location_reports_controller.rb

@@ -62,6 +62,7 @@ def location_report_params # rubocop:todo Metrics/MethodLength
       :end_date,
       :barcodes,
       :barcodes_text,
+      retention_instructions: [],
       faculty_sponsor_ids: [],
       plate_purpose_ids: []
     )

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)) }
@@ -176,14 +176,30 @@ def generate_study_cols_for_row(cur_study)
   end
 
   def search_for_labware_by_selection
-    params = { faculty_sponsor_ids:, study_id:, start_date:, end_date:, plate_purpose_ids:, barcodes: }
+    params = { faculty_sponsor_ids:, study_id:, start_date:, end_date:, plate_purpose_ids:, barcodes:,
+               retention_instructions: }
+    validate_result_size(params)
+
+    # Only plates and tubes are currently supported by this report
+    labwares = Labware.search_for_labware(params).filter { |labware| labware.is_a?(Plate) || labware.is_a?(Tube) }
+
+    filter_labware_by_retention_instructions(labwares)
+  end
+
+  def filter_labware_by_retention_instructions(labwares)
+    return labwares if retention_instructions.blank?
+
+    labwares.select do |lw|
+      retention_instructions.include?(normalize_retention_instruction(lw.retention_instructions))
+    end
+  end
+
+  def validate_result_size(params)
     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
 
   def search_for_labware_by_labwhere_locn_bc
@@ -208,5 +224,9 @@ def get_labwares_per_location(curr_locn_bc)
     curr_locn_children = LabWhereClient::Location.children(curr_locn_bc)
     curr_locn_children.each { |curr_locn| get_labwares_per_location(curr_locn.barcode) } if curr_locn_children.present?
   end
+
+  def normalize_retention_instruction(value)
+    value.to_s.parameterize(separator: '_')
+  end
 end
 # rubocop:enable Metrics/ClassLength

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

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.2].define(version: 2026_03_17_142326) do
+ActiveRecord::Schema[7.2].define(version: 2026_03_25_134057) do
   create_table "accession_sample_statuses", charset: "utf8mb4", collation: "utf8mb4_unicode_ci", force: :cascade do |t|
     t.integer "sample_id", null: false
     t.string "status", null: false
@@ -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

spec/models/location_report_spec.rb

@@ -46,14 +46,15 @@
 
   # add retention instruction metadata to plate 1 custom metadatum collection
   let(:retention_key) { 'retention_instruction' }
-  let(:retention_value) { 'Long term storage' }
+  let(:retention_value_1) { 'Long term storage' }
+  let(:retention_value_2) { 'Return to customer after 2 years' }
   let(:plate_1_custom_metadatum_collection) { create(:custom_metadatum_collection, asset: plate_1, user: user) }
   let(:plate_1_custom_metadatum) do
     create(
       :custom_metadatum,
       custom_metadatum_collection: plate_1_custom_metadatum_collection,
       key: retention_key,
-      value: retention_value
+      value: retention_value_1
     )
   end
 
@@ -89,7 +90,7 @@
       :custom_metadatum,
       custom_metadatum_collection: plate_3_custom_metadatum_collection,
       key: retention_key,
-      value: retention_value
+      value: retention_value_1
     )
   end
 
@@ -110,7 +111,7 @@
       :custom_metadatum,
       custom_metadatum_collection: tube_1_custom_metadatum_collection,
       key: retention_key,
-      value: retention_value
+      value: retention_value_1
     )
   end
 
@@ -145,7 +146,8 @@
         start_date:,
         end_date:,
         plate_purpose_ids:,
-        barcodes:
+        barcodes:,
+        retention_instructions:
       )
     end
     let(:report_type) { nil }
@@ -157,6 +159,7 @@
     let(:end_date) { nil }
     let(:plate_purpose_ids) { nil }
     let(:barcodes) { nil }
+    let(:retention_instructions) { nil }
 
     describe 'validations' do
       context 'when no report type is set' do
@@ -244,7 +247,7 @@
 
         let(:plt_1_line) do
           # rubocop:todo Layout/LineLength
-          "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+          "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
           # rubocop:enable Layout/LineLength
         end
         let(:plt_2_line_1) do
@@ -259,12 +262,12 @@
         end
         let(:plt_3_line) do
           # rubocop:todo Layout/LineLength
-          "#{plate_3.machine_barcode},#{plate_3.human_barcode},#{plt_3_purpose},#{plt_3_created},#{plt_3_received_date},#{locn_prefix} - Shelf 3,LabWhere,#{retention_value},#{study_2.name},#{study_2.id},#{study_2_sponsor.name}"
+          "#{plate_3.machine_barcode},#{plate_3.human_barcode},#{plt_3_purpose},#{plt_3_created},#{plt_3_received_date},#{locn_prefix} - Shelf 3,LabWhere,#{retention_value_1},#{study_2.name},#{study_2.id},#{study_2_sponsor.name}"
           # rubocop:enable Layout/LineLength
         end
         let(:tube_1_line) do
           # rubocop:todo Layout/LineLength
-          "#{tube_1.machine_barcode},#{tube_1.human_barcode},#{tube_1_purpose},#{tube_1_created},#{tube_1_received_date},#{locn_prefix} - Shelf 4,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+          "#{tube_1.machine_barcode},#{tube_1.human_barcode},#{tube_1_purpose},#{tube_1_created},#{tube_1_received_date},#{locn_prefix} - Shelf 4,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
           # rubocop:enable Layout/LineLength
         end
 
@@ -473,6 +476,52 @@
 
           it_behaves_like 'a successful report'
         end
+
+        context 'with retention instructions' do
+          let(:start_date) { '2016-01-01 00:00:00' }
+          let(:end_date) { '2016-11-01 00:00:00' }
+          let(:retention_instructions) { %w[long_term_storage return_to_customer_after_2_years] }
+          # Only plate_1, plate_3, and tube_1 have this metadata, and the value is 'Long term storage' for all
+          let(:expected_lines) do
+            [
+              headers_line,
+              plt_1_line,
+              plt_3_line,
+              tube_1_line
+            ]
+          end
+
+          it_behaves_like 'a successful report'
+        end
+
+        context 'with multiple retention instruction filters' do
+          let(:start_date) { '2016-01-01 00:00:00' }
+          let(:end_date) { '2016-11-01 00:00:00' }
+          let(:retention_instructions) { %w[long_term_storage return_to_customer_after_2_years] }
+          let(:plate_3_custom_metadatum) do
+            create(
+              :custom_metadatum,
+              custom_metadatum_collection: plate_3_custom_metadatum_collection,
+              key: retention_key,
+              value: retention_value_2
+            )
+          end
+          let(:plt_3_line) do
+            # rubocop:todo Layout/LineLength
+            "#{plate_3.machine_barcode},#{plate_3.human_barcode},#{plt_3_purpose},#{plt_3_created},#{plt_3_received_date},#{locn_prefix} - Shelf 3,LabWhere,#{retention_value_2},#{study_2.name},#{study_2.id},#{study_2_sponsor.name}"
+            # rubocop:enable Layout/LineLength
+          end
+          let(:expected_lines) do
+            [
+              headers_line,
+              plt_1_line,
+              plt_3_line,
+              tube_1_line
+            ]
+          end
+
+          it_behaves_like 'a successful report'
+        end
       end
 
       context 'by labwhere location' do
@@ -503,7 +552,7 @@
           let(:location_barcode) { 'locn-1-at-lvl-1' }
           let(:plt_1_line) do
             # rubocop:todo Layout/LineLength
-            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
             # rubocop:enable Layout/LineLength
           end
           let(:expected_lines) { [headers_line, plt_1_line] }
@@ -530,7 +579,7 @@
           let(:location_barcode) { 'locn-1-at-lvl-1' }
           let(:plt_1_line) do
             # rubocop:todo Layout/LineLength
-            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1 - Box 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1 - Box 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
             # rubocop:enable Layout/LineLength
           end
           let(:plt_2_line_1) do
@@ -545,7 +594,7 @@
           end
           let(:tube_1_line) do
             # rubocop:todo Layout/LineLength
-            "#{tube_1.machine_barcode},#{tube_1.human_barcode},#{tube_1_purpose},#{tube_1_created},#{tube_1_received_date},#{locn_prefix} - Shelf 1 - Box 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+            "#{tube_1.machine_barcode},#{tube_1.human_barcode},#{tube_1_purpose},#{tube_1_created},#{tube_1_received_date},#{locn_prefix} - Shelf 1 - Box 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
             # rubocop:enable Layout/LineLength
           end
           let(:expected_lines) { [headers_line, plt_1_line, plt_2_line_1, plt_2_line_2, tube_1_line] }
@@ -607,7 +656,7 @@
           let(:location_barcode) { 'locn-1-at-lvl-1' }
           let(:plt_1_line) do
             # rubocop:todo Layout/LineLength
-            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1 - Box 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1 - Box 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
             # rubocop:enable Layout/LineLength
           end
           let(:plt_2_line_1) do
@@ -675,7 +724,7 @@
 
           # rubocop:todo Layout/LineLength
           let(:plt_1_line) do
-            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+            "#{plate_1.machine_barcode},#{plate_1.human_barcode},#{plt_1_purpose},#{plt_1_created},#{plt_1_received_date},#{locn_prefix} - Shelf 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
           end
           let(:plt_2_line_1) do
             "#{plate_2.machine_barcode},#{plate_2.human_barcode},#{plt_2_purpose},#{plt_2_created},#{plt_2_received_date},#{locn_prefix} - Shelf 1 - Tray 1,LabWhere,Unknown,#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
@@ -684,10 +733,10 @@
             "#{plate_2.machine_barcode},#{plate_2.human_barcode},#{plt_2_purpose},#{plt_2_created},#{plt_2_received_date},#{locn_prefix} - Shelf 1 - Tray 1,LabWhere,Unknown,#{study_2.name},#{study_2.id},#{study_2_sponsor.name}"
           end
           let(:plt_3_line) do
-            "#{plate_3.machine_barcode},#{plate_3.human_barcode},#{plt_3_purpose},#{plt_3_created},#{plt_3_received_date},#{locn_prefix} - Shelf 1 - Tray 1 - Box 1,LabWhere,#{retention_value},#{study_2.name},#{study_2.id},#{study_2_sponsor.name}"
+            "#{plate_3.machine_barcode},#{plate_3.human_barcode},#{plt_3_purpose},#{plt_3_created},#{plt_3_received_date},#{locn_prefix} - Shelf 1 - Tray 1 - Box 1,LabWhere,#{retention_value_1},#{study_2.name},#{study_2.id},#{study_2_sponsor.name}"
           end
           let(:tube_1_line) do
-            "#{tube_1.machine_barcode},#{tube_1.human_barcode},#{tube_1_purpose},#{tube_1_created},#{tube_1_received_date},#{locn_prefix} - Shelf 1 - Tray 1 - Box 1,LabWhere,#{retention_value},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
+            "#{tube_1.machine_barcode},#{tube_1.human_barcode},#{tube_1_purpose},#{tube_1_created},#{tube_1_received_date},#{locn_prefix} - Shelf 1 - Tray 1 - Box 1,LabWhere,#{retention_value_1},#{study_1.name},#{study_1.id},#{study_1_sponsor.name}"
           end
 
           # rubocop:enable Layout/LineLength