Module: AccessionHelper

Included in:
Accession::SampleAccessioning, Admin::AccessioningToolsController, SampleManifestExcel::Upload::Base, SamplesController, StudiesController
Defined in:
app/helpers/accession_helper.rb

Overview

Helper methods to determine accessionablity and permissions at application level.

See Study#samples_accessionable? for study level. See Sample#should_be_accessioned? for sample level.

Instance Method Summary collapse

Instance Method Details

#accessioning_enabled? ⇒ Boolean

Checks if accessioning is enabled in this environment. This is controlled by a a feature flag

Returns:

  • (Boolean) —

    true if accessioning is enabled, false otherwise



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'app/helpers/accession_helper.rb', line 11

has_metadata do
  # NOTE: The following attribute is not required for Microarray Genotyping.
  # I think this might be broken and suggests that there should be separate classes for project: one for
  # next-gen sequencing that includes this attribute in it's metadata, and one for microarray genotyping
  # that doesn't.
  include ProjectManager::Associations
  include BudgetDivision::Associations

  custom_attribute(:project_cost_code, required: true)
  custom_attribute(:funding_comments)
  custom_attribute(:collaborators)
  custom_attribute(:external_funding_source)
  custom_attribute(:sequencing_budget_cost_centre)
  custom_attribute(:project_funding_model, in: PROJECT_FUNDING_MODELS)
  custom_attribute(:gt_committee_tracking_id)

  before_validation do |record|
    record.project_cost_code = nil if record.project_cost_code.blank?
    record.project_funding_model = nil if record.project_funding_model.blank?
  end
end

#permitted_to_accession?(object) ⇒ Boolean

Checks if the current user is permitted to accession the given object.

Parameters:

  • object (Sample, Study) —

    the object to check permissions for

Returns:

  • (Boolean) —

    true if the user has permission, false otherwise



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'app/helpers/accession_helper.rb', line 18

has_metadata do
  # NOTE: The following attribute is not required for Microarray Genotyping.
  # I think this might be broken and suggests that there should be separate classes for project: one for
  # next-gen sequencing that includes this attribute in it's metadata, and one for microarray genotyping
  # that doesn't.
  include ProjectManager::Associations
  include BudgetDivision::Associations

  custom_attribute(:project_cost_code, required: true)
  custom_attribute(:funding_comments)
  custom_attribute(:collaborators)
  custom_attribute(:external_funding_source)
  custom_attribute(:sequencing_budget_cost_centre)
  custom_attribute(:project_funding_model, in: PROJECT_FUNDING_MODELS)
  custom_attribute(:gt_committee_tracking_id)

  before_validation do |record|
    record.project_cost_code = nil if record.project_cost_code.blank?
    record.project_funding_model = nil if record.project_funding_model.blank?
  end
end