Module: ValidationStateGuard

Included in:
Sample
Defined in:
app/models/validation_state_guard.rb

Overview

It's such a common pattern in the code to have a guard on some our validations that this module provides that facility. You can declare a guard with:

extend ValidationStateGuard
validation_guard(:guard_name)

This then gives you private methods of guard_name, guard_name=, and guard_name? It also adds an after_save callback that ensures that guard_name is false so it doesn't leak.

If you have a method that should enable a guard and then disable it afterwards then you can do:

validation_guarded_by(:method_that_needs_guard_enabled, :guard_name)

This will set the guard_name to true before the method is called and return it to false afterwards.

JG: This pattern has been pretty much eliminated. It seems to just be used to control Sample renaming

Instance Method Summary collapse

Instance Method Details

#validation_guard(guard) ⇒ Object

rubocop:todo Metrics/MethodLength



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

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

#validation_guarded_by(method, guard) ⇒ Object

rubocop:todo Metrics/MethodLength



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/models/validation_state_guard.rb', line 39

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