Class: Quby::Questionnaires::Entities::Questionnaire

Inherits:
Object
  • Object
show all
Extended by:
ActiveModel::Naming
Includes:
ActiveModel::Validations
Defined in:
lib/quby/questionnaires/entities/questionnaire.rb

Defined Under Namespace

Classes: InputKeyAlreadyDefined, UnknownInputKey, ValidationError

Constant Summary collapse

VALID_LICENSES = 
[:unknown,
:free,               # freely available without license costs,
:pay_per_completion, # costs associated with each completed questionnaire,
:private,            # not a publicly available questionnaire
:deprecated]
RESPONDENT_TYPES = 
%i( profess patient parent second_parent teacher caregiver )

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, attributes = {}) ⇒ Questionnaire

Returns a new instance of Questionnaire.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 34

def initialize(key, attributes = {})
  @key = key
  @attributes = attributes
  @sbg_domains = []
  @score_calculations = {}.with_indifferent_access
  @charts = Charting::Charts.new
  @fields = Fields.new(self)
  @license = :unknown
  @renderer_version = :v1
  @extra_css = ""
  @allow_switch_to_bulk = false
  @panels = []
  @flags = {}.with_indifferent_access
  @textvars = {}.with_indifferent_access
  @language = :nl
  @respondent_types = []
  @tags = OpenStruct.new
  @check_key_clashes = true
  @validate_html = true
  @score_schemas = {}.with_indifferent_access
  @outcome_tables = []
  @check_score_keys_consistency = true
  @lookup_tables = {}
end

Instance Attribute Details

#abortable ⇒ Object

Returns the value of attribute abortable.



69
70
71
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 69

def abortable
  @abortable
end

#allow_hotkeys ⇒ Object 



118
119
120
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 118

def allow_hotkeys
  (@allow_hotkeys || :bulk).to_s
end

#allow_switch_to_bulk ⇒ Object

Returns the value of attribute allow_switch_to_bulk.



78
79
80
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 78

def allow_switch_to_bulk
  @allow_switch_to_bulk
end

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



59
60
61
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 59

def attributes
  @attributes
end

#charts ⇒ Object

Returns the value of attribute charts.



96
97
98
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 96

def charts
  @charts
end

#check_key_clashes ⇒ Object

whether to check for clashes between question input keys (HTML form keys)



87
88
89
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 87

def check_key_clashes
  @check_key_clashes
end

#check_score_keys_consistency ⇒ Object

whether to check consistency of score subkeys during seed generation



89
90
91
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 89

def check_score_keys_consistency
  @check_score_keys_consistency
end

#deactivate_answers_requested_at ⇒ Object

Returns the value of attribute deactivate_answers_requested_at.



85
86
87
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 85

def deactivate_answers_requested_at
  @deactivate_answers_requested_at
end

#default_answer_value ⇒ Object

Returns the value of attribute default_answer_value.



73
74
75
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 73

def default_answer_value
  @default_answer_value
end

#description ⇒ Object

Returns the value of attribute description.



63
64
65
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 63

def description
  @description
end

#enable_previous_questionnaire_button ⇒ Object

Returns the value of attribute enable_previous_questionnaire_button.



70
71
72
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 70

def enable_previous_questionnaire_button
  @enable_previous_questionnaire_button
end

#extra_css ⇒ Object

Returns the value of attribute extra_css.



77
78
79
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 77

def extra_css
  @extra_css
end

#fields ⇒ Object (readonly)

Returns the value of attribute fields.



76
77
78
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 76

def fields
  @fields
end

#flags ⇒ Object

Returns the value of attribute flags.



98
99
100
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 98

def flags
  @flags
end

#key ⇒ Object

Returns the value of attribute key.



61
62
63
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 61

def key
  @key
end

#language ⇒ Object

Returns the value of attribute language.



81
82
83
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 81

def language
  @language
end

#last_author ⇒ Object

Returns the value of attribute last_author.



93
94
95
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 93

def last_author
  @last_author
end

#leave_page_alert ⇒ Object 



113
114
115
116
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 113

def leave_page_alert
  return nil unless Settings.enable_leave_page_alert
  @leave_page_alert || "Als u de pagina verlaat worden uw antwoorden niet opgeslagen."
end

#license ⇒ Object

Returns the value of attribute license.



79
80
81
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 79

def license
  @license
end

#licensor ⇒ Object

Returns the value of attribute licensor.



80
81
82
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 80

def licensor
  @licensor
end

#lookup_tables ⇒ Object

Returns the value of attribute lookup_tables.



103
104
105
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 103

def lookup_tables
  @lookup_tables
end

#outcome_description ⇒ Object

Returns the value of attribute outcome_description.



64
65
66
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 64

def outcome_description
  @outcome_description
end

#outcome_regeneration_requested_at ⇒ Object

Returns the value of attribute outcome_regeneration_requested_at.



84
85
86
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 84

def outcome_regeneration_requested_at
  @outcome_regeneration_requested_at
end

#outcome_tables ⇒ Object

Returns the value of attribute outcome_tables.



101
102
103
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 101

def outcome_tables
  @outcome_tables
end

#panels ⇒ Object

Returns the value of attribute panels.



71
72
73
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 71

def panels
  @panels
end

#renderer_version ⇒ Object

Returns the value of attribute renderer_version.



74
75
76
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 74

def renderer_version
  @renderer_version
end

#respondent_types ⇒ Object

Returns the value of attribute respondent_types.



82
83
84
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 82

def respondent_types
  @respondent_types
end

#roqua_keys ⇒ Object 



122
123
124
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 122

def roqua_keys
  @roqua_keys || [key]
end

#sbg_domains ⇒ Object

Returns the value of attribute sbg_domains.



68
69
70
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 68

def sbg_domains
  @sbg_domains
end

#sbg_key ⇒ Object

not required to be unique



67
68
69
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 67

def sbg_key
  @sbg_key
end

#score_calculations ⇒ Object

Returns the value of attribute score_calculations.



72
73
74
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 72

def score_calculations
  @score_calculations
end

#score_schemas ⇒ Object

Returns the value of attribute score_schemas.



102
103
104
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 102

def score_schemas
  @score_schemas
end

#short_description ⇒ Object

Returns the value of attribute short_description.



65
66
67
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 65

def short_description
  @short_description
end

#tags ⇒ Object

tags= is manually defined below



83
84
85
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 83

def tags
  @tags
end

#textvars ⇒ Object

Returns the value of attribute textvars.



99
100
101
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 99

def textvars
  @textvars
end

#title ⇒ Object

Returns the value of attribute title.



62
63
64
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 62

def title
  @title
end

#validate_html ⇒ Object

If false, we don’t check html for validity (for mate1 and mate1_pre)



91
92
93
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 91

def validate_html
  @validate_html
end

Instance Method Details

#actions ⇒ Object 



219
220
221
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 219

def actions
  score_calculations.values.select(&:action)
end

#add_chart(chart) ⇒ Object 



227
228
229
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 227

def add_chart(chart)
  charts.add chart
end

#add_outcome_table(outcome_table_options) ⇒ Object 



341
342
343
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 341

def add_outcome_table(outcome_table_options)
  outcome_tables << OutcomeTable.new(**outcome_table_options, questionnaire: self)
end

#add_panel(panel) ⇒ Object 



130
131
132
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 130

def add_panel(panel)
  @panels << panel
end

#add_score_calculation(builder) ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 195

def add_score_calculation(builder)
  if score_calculations.key?(builder.key)
    fail InputKeyAlreadyDefined, "Score key `#{builder.key}` already defined."
  end
  score_calculations[builder.key] = builder
end

#add_score_schema(key, label, subschema_options) ⇒ Object 



202
203
204
205
206
207
208
209
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 202

def add_score_schema(key, label, subschema_options)
  schema = Entities::ScoreSchema.new(key: key, label: label, subscore_schemas: subschema_options)
  schema.valid?
  schema.errors.each do |error|
    errors.add("Score schema '#{key}'", "#{error.attribute} #{error.message}")
  end
  score_schemas[key] = schema
end

#answer_dsl_module ⇒ Object

rubocop:disable Metrics/MethodLength



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 253

def answer_dsl_module # rubocop:disable Metrics/MethodLength
  # Have to put this in a local variable so the module definition block can access it
  questions_in_var = questions

  @answer_dsl_cache ||= Module.new do
    questions_in_var.each do |question|
      next if question&.key.blank?
      case question.type
      when :date
        question.components.each do |component|
          # assignment to 'value' hash must be done under string keys
          key = question.send("#{component}_key").to_s
          define_method(key) do
            self.value ||= Hash.new
            self.value[key]
          end

          define_method("#{key}=") do |v|
            self.value ||= Hash.new
            self.value[key] = v&.strip
          end
        end

        define_method(question.key) do
          self.value ||= Hash.new

          components = question.components.sort
          component_values = components.map do |component|
            value_key = question.send("#{component}_key").to_s
            self.value[value_key]
          end
          case components
          when [:day, :month, :year]
            component_values.reverse.take_while { |p| p.present? }.reverse.join('-')
          when [:month, :year]
            component_values.reject(&:blank?).join('-')
          when [:hour, :minute]
            component_values.all?(&:blank?) ? '' : component_values.join(':')
          end
        end

      when :check_box

        define_method(question.key) do
          self.value ||= Hash.new
          self.value[question.key.to_s] ||= Hash.new
        end

        question.options.each do |opt|
          next if opt&.key.blank?
          define_method("#{opt.key}") do
            self.value ||= Hash.new
            self.value[question.key.to_s] ||= Hash.new
            self.value[opt.key.to_s] ||= 0
          end

          define_method("#{opt.key}=") do |v|
            v = v.to_i
            self.value ||= Hash.new
            self.value[question.key.to_s] ||= Hash.new
            self.value[question.key.to_s][opt.key.to_s] = v
            self.value[opt.key.to_s] = v
          end
        end
      else
        # Includes:
        # question.type == :radio
        # question.type == :scale
        # question.type == :select
        # question.type == :string
        # question.type == :textarea
        # question.type == :integer
        # question.type == :float

        define_method(question.key) do
          self.value ||= Hash.new
          self.value[question.key.to_s]
        end

        define_method(question.key.to_s + "=") do |v|
          self.value ||= Hash.new
          self.value[question.key.to_s] = v
        end
      end rescue nil
    end
  end
end

#as_json(options = {}) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 175

def as_json(options = {})
  {
    key: key,
    title: title,
    description: description,
    outcomeDescription: outcome_description,
    shortDescription: short_description,
    panels: panels,
    fields: fields,
    flags: flags,
    textvars: textvars,
    validations: validations,
    visibilityRules: visibility_rules
  }
end

#completion ⇒ Object 



223
224
225
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 223

def completion
  score_calculations.values.select(&:completion).first
end

#default_flags ⇒ Object 



237
238
239
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 237

def default_flags
  flags.to_h { |key, flag| [key, flag.default] }.reject { |key, value| value.nil? }
end

#default_textvars ⇒ Object 



247
248
249
250
251
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 247

def default_textvars
  textvars.select { |key, textvar| textvar.default.present? }
          .map    { |key, textvar| [key, textvar.default] }
          .to_h
end

#filter_flags(given_flags) ⇒ Object 



231
232
233
234
235
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 231

def filter_flags(given_flags)
  given_flags.select do |flag_key, _|
    flags.key? flag_key
  end
end

#filter_textvars(given_textvars) ⇒ Object 



241
242
243
244
245
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 241

def filter_textvars(given_textvars)
  given_textvars.select do |textvar_key, _|
    textvars.key? textvar_key
  end
end

#find_plottable(key) ⇒ Object 



215
216
217
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 215

def find_plottable(key)
  score_calculations[key] || question_hash.with_indifferent_access[key]
end

#key_in_use?(key) ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 191

def key_in_use?(key)
  fields.key_in_use?(key) || score_calculations.key?(key)
end

#questions ⇒ Object 



162
163
164
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 162

def questions
  question_hash.values
end

#questions_of_type(type) ⇒ Object 



166
167
168
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 166

def questions_of_type(type)
  questions.select { |question| question.type == type }
end

#questions_tree ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 150

def questions_tree
  return @questions_tree_cache if @questions_tree_cache

  recurse = lambda do |question|
    [question, question.subquestions.map(&recurse)]
  end

  @questions_tree_cache = (@panels && @panels.map do |panel|
    panel.items.map { |item| recurse.call(item) if item.is_a?(Quby::Questionnaires::Entities::Question) }
  end)
end

#register_question(question) ⇒ Object 



134
135
136
137
138
139
140
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 134

def register_question(question)
  fields.add(question)

  if question.sets_textvar && !textvars.key?(question.sets_textvar)
    fail "Undefined textvar: #{question.sets_textvar}"
  end
end

#scores ⇒ Object 



211
212
213
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 211

def scores
  score_calculations.values.select(&:score)
end

#to_param ⇒ Object 



126
127
128
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 126

def to_param
  key
end

#validate_questions ⇒ Object 



142
143
144
145
146
147
148
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 142

def validate_questions
  question_hash.each_value do |q|
    unless q.valid?
      q.errors.each { |attr, err| errors.add(attr, err) }
    end
  end
end

#validations ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 345

def validations
  @validations ||= fields.question_hash.values.flat_map do |question|
    question.validations.map do |validation|
      case validation[:type]
      when :answer_group_minimum, :answer_group_maximum
        Validation.new(validation.merge(field_keys: questions.select {|q| q.question_group == validation[:group]}.map(&:key)))
      else
        Validation.new(validation.merge(field_key: question.key))
      end
    end
  end.uniq(&:config)
end

#visibility_rules ⇒ Object 



358
359
360
361
 
# File 'lib/quby/questionnaires/entities/questionnaire.rb', line 358

def visibility_rules
  @visibility_rules ||= fields.question_hash.values.flat_map { |question| VisibilityRule.from(question) } \
                      + flags.values.flat_map { |flag| VisibilityRule.from_flag(flag) }
end