Class: BatchesController

Inherits:
ApplicationController show all
Defined in:
app/controllers/batches_controller.rb

Overview

Batches represent collections of requests processed through a Pipeline at the same time. They are created via selecting requests on the pipelines show page

Constant Summary

Constants included from FlashTruncation

FlashTruncation::STRING_OVERHEAD

Instance Method Summary collapse

Methods inherited from ApplicationController

#block_api_access, #evil_parameter_hack!, #extract_header_info, #set_cache_disabled!

Methods included from FlashTruncation

#max_flash_size, #truncate_flash, #truncate_flash_array

Instance Method Details

#batch_parametersObject

rubocop:enable Metrics/MethodLength


107
108
109
# File 'app/controllers/batches_controller.rb', line 107

def batch_parameters
  @batch_parameters ||= params.require(:batch).permit(:assignee_id)
end

#completedObject


175
176
177
178
179
180
# File 'app/controllers/batches_controller.rb', line 175

def completed
  # The params fall-back here reflects an older route where pipeline got passed in as :id. It should be removed
  # in the near future.
  @pipeline = Pipeline.find(params[:pipeline_id] || params[:id])
  @batches = @pipeline.batches.completed.order(id: :desc).includes(%i[user pipeline]).page(params[:page])
end

#createObject

rubocop:todo Metrics/MethodLength


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'app/controllers/batches_controller.rb', line 112

def create # rubocop:todo Metrics/AbcSize
  @pipeline = Pipeline.find(params[:id])

  requests = @pipeline.extract_requests_from_input_params(request_parameters)

  # TODO: These should be different endpoints
  case params[:action_on_requests]
  when 'cancel_requests'
    transition_requests(requests, :cancel_before_started!, 'Requests cancelled')
  when 'hide_from_inbox'
    transition_requests(requests, :hold!, 'Requests hidden from inbox')
  else
    # This is the standard create action
    standard_create(requests)
  end
rescue ActiveRecord::RecordInvalid => e
  respond_to do |format|
    format.html do
      flash[:error] = e.record.errors.full_messages
      redirect_to(pipeline_path(@pipeline))
    end
    format.xml { render xml: @batch.errors.to_xml }
  end
end

#download_spreadsheetObject

Used in Cherrypicking pipeline to generate the template for CSV driven picks


370
371
372
373
# File 'app/controllers/batches_controller.rb', line 370

def download_spreadsheet
  csv_string = Tasks::PlateTemplateHandler.generate_spreadsheet(@batch)
  send_data csv_string, type: 'text/plain', filename: "#{@batch.id}_cherrypick_layout.csv", disposition: 'attachment'
end

#editObject

rubocop:enable Metrics/MethodLength


77
78
79
80
81
82
# File 'app/controllers/batches_controller.rb', line 77

def edit
  @rits = @batch.pipeline.request_information_types
  @requests = @batch.ordered_requests.includes(:batch_request, :asset, :target_asset, :comments)
  @users = User.all
  @controls = @batch.pipeline.controls
end

#failObject


189
190
191
# File 'app/controllers/batches_controller.rb', line 189

def fail
  @fail_reasons = @batch.workflow.source_is_internal? ? FAILURE_REASONS['internal'] : FAILURE_REASONS['external']
end

#fail_itemsObject

rubocop:todo Metrics/AbcSize


193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'app/controllers/batches_controller.rb', line 193

def fail_items # rubocop:todo Metrics/AbcSize
  ActiveRecord::Base.transaction do
    fail_params =
      params.permit(:id, requested_fail: {}, requested_remove: {}, failure: %i[reason comment fail_but_charge])
    fail_and_remover = Batch::RequestFailAndRemover.new(fail_params)
    if fail_and_remover.save
      flash[:notice] = truncate_flash(fail_and_remover.notice)
    else
      flash[:error] = truncate_flash(fail_and_remover.errors.full_messages.join(';'))
    end
    redirect_to action: :fail, id: params[:id]
  end
end

#failedObject


182
183
184
185
186
187
# File 'app/controllers/batches_controller.rb', line 182

def failed
  # The params fall-back here reflects an older route where pipeline got passed in as :id. It should be removed
  # in the near future.
  @pipeline = Pipeline.find(params[:pipeline_id] || params[:id])
  @batches = @pipeline.batches.failed.order(id: :desc).includes(%i[user pipeline]).page(params[:page])
end

#filteredObject


347
# File 'app/controllers/batches_controller.rb', line 347

def filtered; end

#find_batch_by_barcodeObject


393
394
395
396
397
398
399
400
401
402
403
# File 'app/controllers/batches_controller.rb', line 393

def find_batch_by_barcode
  batch_id = LabEvent.find_batch_id_by_barcode(params[:id])
  if batch_id.nil?
    @batch_error = 'Batch id not found.'
    render action: 'batch_error', format: :xml
    nil
  else
    @batch = Batch.find(batch_id)
    render action: 'show', format: :xml
  end
end

#find_batch_by_batch_idObject


379
380
381
# File 'app/controllers/batches_controller.rb', line 379

def find_batch_by_batch_id
  @batch = Batch.find(params[:batch_id])
end

#find_batch_by_idObject


375
376
377
# File 'app/controllers/batches_controller.rb', line 375

def find_batch_by_id
  @batch = Batch.find(params[:id])
end

#indexObject

rubocop:todo Metrics/AbcSize


35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'app/controllers/batches_controller.rb', line 35

def index # rubocop:todo Metrics/AbcSize
  if logged_in?
    @user = params.fetch(:user, current_user)
    @batches = Batch.for_user(@user).order(id: :desc).includes(:user, :assignee, :pipeline).page(params[:page])
  else
    # Can end up here with XML. And it causes pain.
    @batches = Batch.order(id: :asc).page(params[:page]).limit(10)
  end
  respond_to do |format|
    format.html
    format.xml { render xml: @batches.to_xml }
    format.json { render json: @batches.to_json.gsub(/null/, '""') }
  end
end

#pacbio_sample_sheetObject


383
384
385
386
# File 'app/controllers/batches_controller.rb', line 383

def pacbio_sample_sheet
  csv_string = PacBio::SampleSheet.new.create_csv_from_batch(@batch)
  send_data csv_string, type: 'text/plain', filename: "batch_#{@batch.id}_sample_sheet.csv", disposition: 'attachment'
end

#pendingObject


149
150
151
152
153
154
# File 'app/controllers/batches_controller.rb', line 149

def pending
  # The params fall-back here reflects an older route where pipeline got passed in as :id. It should be removed
  # in the near future.
  @pipeline = Pipeline.find(params[:pipeline_id] || params[:id])
  @batches = @pipeline.batches.pending.order(id: :desc).includes(%i[user pipeline]).page(params[:page])
end

#pipelineObject

rubocop:enable Metrics/MethodLength


139
140
141
142
143
144
145
146
147
# File 'app/controllers/batches_controller.rb', line 139

def pipeline
  # All pipeline batches routes should just direct to batches#index with pipeline and state as filter parameters
  @batches =
    Batch
      .where(pipeline_id: params[:pipeline_id] || params[:id])
      .order(id: :desc)
      .includes(:user, :pipeline)
      .page(params[:page])
end

#previous_qc_stateObject


340
341
342
343
344
345
# File 'app/controllers/batches_controller.rb', line 340

def previous_qc_state
  @batch.qc_previous_state!(current_user)
  @batch.save
  flash[:notice] = "Batch #{@batch.id} reset to state #{@batch.qc_state}"
  redirect_to batch_url(@batch)
end

Handles printing of the worksheet


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'app/controllers/batches_controller.rb', line 294

def print # rubocop:todo Metrics/AbcSize
  @task = Task.find_by(id: params[:task_id])
  @pipeline = @batch.pipeline
  @comments = @batch.comments
  template = @pipeline.batch_worksheet

  if template == 'cherrypick_worksheet'
    robot_id = params.fetch(:robot_id, @batch.robot_id)
    @robot = robot_id ? Robot.find(robot_id) : Robot.default_for_verification
    @plates = params[:barcode] ? Plate.with_barcode(params[:barcode]) : @batch.output_plates
  end

  if template
    render action: template, layout: false
  else
    redirect_back fallback_location: batch_path(@batch), alert: "No worksheet for #{@pipeline.name}"
  end
end

284
285
286
287
288
289
290
291
# File 'app/controllers/batches_controller.rb', line 284

def print_barcodes
  if @batch.requests.empty?
    flash[:notice] = 'Your batch contains no requests.'
    redirect_to controller: 'batches', action: 'show', id: @batch.id
  else
    print_handler(LabelPrinter::Label::BatchTube)
  end
end

217
# File 'app/controllers/batches_controller.rb', line 217

def print_labels; end

rubocop:enable Metrics/MethodLength


276
277
278
# File 'app/controllers/batches_controller.rb', line 276

def print_multiplex_barcodes
  print_handler(LabelPrinter::Label::BatchMultiplex)
end

rubocop:todo Metrics/AbcSize


239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'app/controllers/batches_controller.rb', line 239

def print_multiplex_labels # rubocop:todo Metrics/AbcSize
  request = @batch.requests.first
  if request.tag_number.nil?
    flash[:error] = 'No tags have been assigned.'
  elsif request.target_asset.present? && request.target_asset.children.present?
    # We are trying to find the MX library tube or the stock MX library
    # tube. I've added a filter so it doesn't pick up Lanes.
    children = request.target_asset.children.last.children.select { |a| a.is_a?(Tube) }
    @asset = children.empty? ? request.target_asset.children.last : request.target_asset.children.last.children.last
  else
    flash[:notice] = 'There is no multiplexed library available.'
  end
end

280
281
282
# File 'app/controllers/batches_controller.rb', line 280

def print_plate_barcodes
  print_handler(LabelPrinter::Label::BatchRedirect)
end

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'app/controllers/batches_controller.rb', line 219

def print_plate_labels
  @pipeline = @batch.pipeline
  @output_barcodes = []

  @output_labware = @batch.plate_group_barcodes || []

  @output_labware.each do |parent, _children|
    next if parent.nil?

    plate_barcode = parent.human_barcode
    @output_barcodes << plate_barcode if plate_barcode.present?
  end

  return if @output_barcodes.present?

  # We have no output barcodes, which means a problem
  flash[:error] = 'Output plates do not have barcodes to print'
  redirect_to controller: 'batches', action: 'show', id: @batch.id
end

rubocop:todo Metrics/MethodLength


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'app/controllers/batches_controller.rb', line 254

def print_stock_multiplex_labels # rubocop:todo Metrics/AbcSize
  @batch = Batch.find(params[:id])
  request = @batch.requests.first
  pooled_library = request.target_asset.children.first
  stock_multiplexed_tube = nil

  if pooled_library.is_a_stock_asset?
    stock_multiplexed_tube = pooled_library
  elsif pooled_library.has_stock_asset?
    stock_multiplexed_tube = pooled_library.stock_asset
  end

  if stock_multiplexed_tube.nil?
    flash[:notice] = 'There is no stock multiplexed library available.'
    redirect_to controller: 'batches', action: 'show', id: @batch.id
  else
    @asset = stock_multiplexed_tube
  end
end

#releasedObject


163
164
165
166
167
168
169
170
171
172
173
# File 'app/controllers/batches_controller.rb', line 163

def released
  # The params fall-back here reflects an older route where pipeline got passed in as :id. It should be removed
  # in the near future.
  @pipeline = Pipeline.find(params[:pipeline_id] || params[:id])

  @batches = @pipeline.batches.released.order(id: :desc).includes(%i[user pipeline]).page(params[:page])
  respond_to do |format|
    format.html
    format.xml { render layout: false }
  end
end

#reset_batchObject


333
334
335
336
337
338
# File 'app/controllers/batches_controller.rb', line 333

def reset_batch
  pipeline = @batch.pipeline
  @batch.reset!(current_user)
  flash[:notice] = "Batch #{@batch.id} has been reset"
  redirect_to controller: 'pipelines', action: :show, id: pipeline.id
end

#sample_prep_worksheetObject


388
389
390
391
# File 'app/controllers/batches_controller.rb', line 388

def sample_prep_worksheet
  csv_string = PacBio::Worksheet.new.create_csv_from_batch(@batch)
  send_data csv_string, type: 'text/plain', filename: "batch_#{@batch.id}_worksheet.csv", disposition: 'attachment'
end

#saveObject


213
214
215
# File 'app/controllers/batches_controller.rb', line 213

def save
  redirect_to action: :show, id: @batch.id
end

#showObject

rubocop:todo Metrics/MethodLength


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'app/controllers/batches_controller.rb', line 51

def show # rubocop:todo Metrics/AbcSize
  respond_to do |format|
    format.html do
      @submenu_presenter = Presenters::BatchSubmenuPresenter.new(current_user, @batch)

      @pipeline = @batch.pipeline
      @tasks = @batch.tasks.sort_by(&:sorted)
      @rits = @pipeline.request_information_types
      @input_labware = @batch.input_labware_report
      @output_labware = @batch.output_labware_report

      if @pipeline.pick_data
        @robot = @batch.robot_id ? Robot.find(@batch.robot_id) : Robot.with_verification_behaviour.first

        # In the event we have no robots with the correct behaviour, and none are specialised on the batch, fall-back
        # to the first robot.
        @robot ||= Robot.first
        @robots = Robot.with_verification_behaviour
      end
    end
    format.xml { render layout: false }
  end
end

#sortObject


207
208
209
210
211
# File 'app/controllers/batches_controller.rb', line 207

def sort
  @batch.assign_positions_to_requests!(params['requests_list'].map(&:to_i))
  @batch.rebroadcast
  head :ok
end

#startedObject


156
157
158
159
160
161
# File 'app/controllers/batches_controller.rb', line 156

def started
  # The params fall-back here reflects an older route where pipeline got passed in as :id. It should be removed
  # in the near future.
  @pipeline = Pipeline.find(params[:pipeline_id] || params[:id])
  @batches = @pipeline.batches.started.order(id: :desc).includes(%i[user pipeline]).page(params[:page])
end

#swapObject

rubocop:todo Metrics/AbcSize


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'app/controllers/batches_controller.rb', line 349

def swap # rubocop:todo Metrics/AbcSize
  if @batch.swap(
       current_user,
       'batch_1' => {
         'id' => params['batch']['1'],
         'lane' => params['batch']['position']['1']
       },
       'batch_2' => {
         'id' => params['batch']['2'],
         'lane' => params['batch']['position']['2']
       }
     )
    flash[:notice] = 'Successfully swapped lane positions'
    redirect_to batch_path(@batch)
  else
    flash[:error] = @batch.errors.full_messages.join('<br />')
    redirect_to action: :filtered, id: @batch.id
  end
end

#updateObject

rubocop:todo Metrics/MethodLength


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'app/controllers/batches_controller.rb', line 85

def update # rubocop:todo Metrics/AbcSize
  if batch_parameters[:assignee_id]
    user = User.find(batch_parameters[:assignee_id])
    assigned_message = "Assigned to #{user.name} (#{user.})."
  else
    assigned_message = ''
  end

  respond_to do |format|
    if @batch.update(batch_parameters)
      flash[:notice] = "Batch was successfully updated. #{assigned_message}"
      format.html { redirect_to batch_url(@batch) }
      format.xml { head :ok }
    else
      format.html { render action: 'edit' }
      format.xml { render xml: @batch.errors.to_xml }
    end
  end
end

#verifyObject


313
314
315
316
317
# File 'app/controllers/batches_controller.rb', line 313

def verify
  @requests = @batch.ordered_requests
  @pipeline = @batch.pipeline
  @count = @requests.length
end

#verify_tube_layoutObject

rubocop:todo Metrics/AbcSize


319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'app/controllers/batches_controller.rb', line 319

def verify_tube_layout # rubocop:todo Metrics/AbcSize
  tube_barcodes = Array.new(@batch.requests.count) { |i| params["barcode_#{i}"] }

  results = @batch.verify_tube_layout(tube_barcodes, current_user)

  if results
    flash[:notice] = 'All of the tubes are in their correct positions.'
    redirect_to batch_path(@batch)
  elsif !results
    flash[:error] = @batch.errors.full_messages.sort
    redirect_to action: :verify, id: @batch.id
  end
end