Class: Quby::Questionnaires::Entities::Flag

Inherits:
Struct
  • Object
show all
Defined in:
lib/quby/questionnaires/entities/flag.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, description_true: nil, description_false: nil, description: nil, internal: false, trigger_on: true, shows_questions: [], hides_questions: [], depends_on: nil, default_in_interface: nil) ⇒ Flag

rubocop:disable ParameterLists



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 9

def initialize(key:,
               description_true: nil,
               description_false: nil,
               description: nil,
               internal: false,
               trigger_on: true,
               shows_questions: [],
               hides_questions: [],
               depends_on: nil, # used in interface to hide this flag unless the depended on flag is set to true
               default_in_interface: nil) # used in interface to set a default for the flag state,
                                          # does not have an effect outside of the interface
  super(key, description_true, description_false, description, internal, trigger_on, shows_questions,
        hides_questions, depends_on, default_in_interface)
  ensure_valid_descriptions
end

Instance Attribute Details

#default_in_interface ⇒ Object

Returns the value of attribute default_in_interface

Returns:

  • (Object) —

    the current value of default_in_interface



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def default_in_interface
  @default_in_interface
end

#depends_on ⇒ Object

Returns the value of attribute depends_on

Returns:

  • (Object) —

    the current value of depends_on



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def depends_on
  @depends_on
end

#description ⇒ Object

Returns the value of attribute description

Returns:

  • (Object) —

    the current value of description



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def description
  @description
end

#description_false ⇒ Object

Returns the value of attribute description_false

Returns:

  • (Object) —

    the current value of description_false



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def description_false
  @description_false
end

#description_true ⇒ Object

Returns the value of attribute description_true

Returns:

  • (Object) —

    the current value of description_true



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def description_true
  @description_true
end

#hides_questions ⇒ Object

Returns the value of attribute hides_questions

Returns:

  • (Object) —

    the current value of hides_questions



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def hides_questions
  @hides_questions
end

#internal ⇒ Object

Returns the value of attribute internal

Returns:

  • (Object) —

    the current value of internal



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def internal
  @internal
end

#key ⇒ Object

Returns the value of attribute key

Returns:

  • (Object) —

    the current value of key



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def key
  @key
end

#shows_questions ⇒ Object

Returns the value of attribute shows_questions

Returns:

  • (Object) —

    the current value of shows_questions



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def shows_questions
  @shows_questions
end

#trigger_on ⇒ Object

Returns the value of attribute trigger_on

Returns:

  • (Object) —

    the current value of trigger_on



6
7
8
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 6

def trigger_on
  @trigger_on
end

Instance Method Details

#if_triggered_by(answer_flags) ⇒ Object

rubocop:enable ParameterLists



26
27
28
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 26

def if_triggered_by(answer_flags)
  yield if answer_flags[key] == trigger_on
end

#to_codebook(_options = {}) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 34

def to_codebook(_options = {})
  output = []
  output << "#{key} flag"
  output << "'#{description}'" if description.present?
  output << " 'true' - #{description_true}"
  output << " 'false' - #{description_false}"
  output << " '' (leeg) - Vlag niet ingesteld, informatie onbekend"
  output << ""
  output.join("\n")
end

#variable_description ⇒ Object 



30
31
32
 
# File 'lib/quby/questionnaires/entities/flag.rb', line 30

def variable_description
  "#{description} (true - '#{description_true}', false - '#{description_false}')"
end