Class: Quby::Compiler::Entities::Question

Inherits:
Item
  • Object
show all
Defined in:
lib/quby/compiler/entities/question.rb

Constant Summary collapse

MARKDOWN_ATTRIBUTES = 
%w(description title).freeze

Instance Attribute Summary collapse

Attributes inherited from Item

#presentation, #raw_content, #switch_cycle

Instance Method Summary collapse

Constructor Details

#initialize(key, options = {}) ⇒ Question

rubocop:disable CyclomaticComplexity, Metrics/MethodLength



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/quby/compiler/entities/question.rb', line 131

def initialize(key, options = {})
  super(options)

  @extra_data ||= {}
  @options = []
  @allow_duplicate_option_values = options[:allow_duplicate_option_values]
  @questionnaire = options[:questionnaire]
  @key = key
  @sbg_key = options[:sbg_key]
  @type = options[:type]
  @as = options[:as]
  @title = options[:title]
  @context_free_title = options[:context_free_title]
  @allow_blank_titles = options[:allow_blank_titles]
  @description = options[:description]
  @display_modes = options[:display_modes]
  @presentation = options[:presentation]
  @validations = []
  @parent = options[:parent]
  @hidden = options[:hidden]
  @table = options[:table]
  @parent_option_key = options[:parent_option_key]
  @autocomplete = options[:autocomplete] || "off"
  @show_values = options[:show_values] || :bulk
  @deselectable = (options[:deselectable].nil? || options[:deselectable])
  @disallow_bulk = options[:disallow_bulk]
  @score_header = options[:score_header] || :none
  @sets_textvar = "#{questionnaire.key}_#{options[:sets_textvar]}" if options[:sets_textvar]
  @unit = options[:unit]
  @lines = options[:lines] || 6
  @cols = options[:cols] || 40
  @default_invisible = options[:default_invisible] || false
  @labels ||= []

  @col_span = options[:col_span] || 1
  @row_span = options[:row_span] || 1

  set_depends_on(options[:depends_on])

  @question_group = options[:question_group]
  @group_minimum_answered = options[:group_minimum_answered]
  @group_maximum_answered = options[:group_maximum_answered]

  @input_data = {}
  @input_data[:value_tooltip] = true if options[:value_tooltip]

  # Require subquestions of required questions by default
  options[:required] = true if @parent&.validations&.first&.fetch(:type, nil) == :requires_answer
  @validations << {type: :requires_answer, explanation: options[:error_explanation]} if options[:required]

  if @type == :float
    @validations << {type: :valid_float, explanation: options[:error_explanation]}
  elsif @type == :integer
    @validations << {type: :valid_integer, explanation: options[:error_explanation]}
  end

  if options[:minimum] and (@type == :integer || @type == :float)
    fail "deprecated" # pretty sure this is not used anywhere
  end
  if options[:maximum] and (@type == :integer || @type == :float)
    fail "deprecated" # pretty sure this is not used anywhere
  end
  @default_position = options[:default_position]

  if @question_group
    if @group_minimum_answered
      @validations << {type: :answer_group_minimum, group: @question_group, value: @group_minimum_answered,
                       explanation: options[:error_explanation]}
    end
    if @group_maximum_answered
      @validations << {type: :answer_group_maximum, group: @question_group, value: @group_maximum_answered,
                       explanation: options[:error_explanation]}
    end
  end
end

Instance Attribute Details

#allow_blank_titles ⇒ Object

Question validation fails when there are no title and no context_free_title. When :allow_blank_titles => true passed, validation does not fail. Any other value will raise the failure.



50
51
52
 
# File 'lib/quby/compiler/entities/question.rb', line 50

def allow_blank_titles
  @allow_blank_titles
end

#allow_duplicate_option_values ⇒ Object (readonly)

Whether to skip the uniqueness validation on radio and select option values



35
36
37
 
# File 'lib/quby/compiler/entities/question.rb', line 35

def allow_duplicate_option_values
  @allow_duplicate_option_values
end

#as ⇒ Object

How should we display this question



28
29
30
 
# File 'lib/quby/compiler/entities/question.rb', line 28

def as
  @as
end

#autocomplete ⇒ Object

Whether the browser should autocomplete this question (off by default)



54
55
56
 
# File 'lib/quby/compiler/entities/question.rb', line 54

def autocomplete
  @autocomplete
end

#col_span ⇒ Object 



228
229
230
 
# File 'lib/quby/compiler/entities/question.rb', line 228

def col_span
  options.length > 0 && type != :select ? options.length : @col_span
end

#cols ⇒ Object

Returns the value of attribute cols.



112
113
114
 
# File 'lib/quby/compiler/entities/question.rb', line 112

def cols
  @cols
end

#context_free_title ⇒ Object

Returns the value of attribute context_free_title.



19
20
21
 
# File 'lib/quby/compiler/entities/question.rb', line 19

def context_free_title
  @context_free_title
end

#default_invisible ⇒ Object

Returns the value of attribute default_invisible.



121
122
123
 
# File 'lib/quby/compiler/entities/question.rb', line 121

def default_invisible
  @default_invisible
end

#default_position ⇒ Object 



287
288
289
290
291
 
# File 'lib/quby/compiler/entities/question.rb', line 287

def default_position
  return unless as == :slider
  half = (type == :float) ? 2.0 : 2
  @default_position || ((minimum + maximum) / half if minimum && maximum)
end

#dependencies ⇒ Object

Returns the value of attribute dependencies.



68
69
70
 
# File 'lib/quby/compiler/entities/question.rb', line 68

def dependencies
  @dependencies
end

#depends_on ⇒ Object

This question should not validate itself unless the depends_on question is answered. May also be an array of “#question_key_#option_key” strings that specify options this question depends on.



90
91
92
 
# File 'lib/quby/compiler/entities/question.rb', line 90

def depends_on
  @depends_on
end

#description ⇒ Object

Returns the value of attribute description.



20
21
22
 
# File 'lib/quby/compiler/entities/question.rb', line 20

def description
  @description
end

#deselectable ⇒ Object

Whether this radio question is deselectable



76
77
78
 
# File 'lib/quby/compiler/entities/question.rb', line 76

def deselectable
  @deselectable
end

#disallow_bulk ⇒ Object

Whether we can collapse this in bulk view



84
85
86
 
# File 'lib/quby/compiler/entities/question.rb', line 84

def disallow_bulk
  @disallow_bulk
end

#display_modes ⇒ Object

In what modes do we display this question NOTE We always display questions in print-view (if they have an answer)



40
41
42
 
# File 'lib/quby/compiler/entities/question.rb', line 40

def display_modes
  @display_modes
end

#extra_data ⇒ Object

Extra data hash to store on the question item’s html element



93
94
95
 
# File 'lib/quby/compiler/entities/question.rb', line 93

def extra_data
  @extra_data
end

#group_maximum_answered ⇒ Object

Returns the value of attribute group_maximum_answered.



104
105
106
 
# File 'lib/quby/compiler/entities/question.rb', line 104

def group_maximum_answered
  @group_maximum_answered
end

#group_minimum_answered ⇒ Object

Returns the value of attribute group_minimum_answered.



103
104
105
 
# File 'lib/quby/compiler/entities/question.rb', line 103

def group_minimum_answered
  @group_minimum_answered
end

#hidden ⇒ Object

To hide old questions



31
32
33
 
# File 'lib/quby/compiler/entities/question.rb', line 31

def hidden
  @hidden
end

#input_data ⇒ Object

data-attributes for the input tag.



96
97
98
 
# File 'lib/quby/compiler/entities/question.rb', line 96

def input_data
  @input_data
end

#key ⇒ Object

Standard attributes



14
15
16
 
# File 'lib/quby/compiler/entities/question.rb', line 14

def key
  @key
end

#labels ⇒ Object

Returns the value of attribute labels.



22
23
24
 
# File 'lib/quby/compiler/entities/question.rb', line 22

def labels
  @labels
end

#lines ⇒ Object

Amount of rows and cols a textarea has



111
112
113
 
# File 'lib/quby/compiler/entities/question.rb', line 111

def lines
  @lines
end

#options ⇒ Object

Multiple-choice questions have options to choose from



43
44
45
 
# File 'lib/quby/compiler/entities/question.rb', line 43

def options
  @options
end

#parent ⇒ Object

Some questions are a tree.



80
81
82
 
# File 'lib/quby/compiler/entities/question.rb', line 80

def parent
  @parent
end

#parent_option_key ⇒ Object

Returns the value of attribute parent_option_key.



81
82
83
 
# File 'lib/quby/compiler/entities/question.rb', line 81

def parent_option_key
  @parent_option_key
end

#question_group ⇒ Object

options for grouping questions and setting a minimum or maximum number of answered questions in the group



102
103
104
 
# File 'lib/quby/compiler/entities/question.rb', line 102

def question_group
  @question_group
end

#questionnaire ⇒ Object

Returns the value of attribute questionnaire.



17
18
19
 
# File 'lib/quby/compiler/entities/question.rb', line 17

def questionnaire
  @questionnaire
end

#row_span ⇒ Object

Returns the value of attribute row_span.



119
120
121
 
# File 'lib/quby/compiler/entities/question.rb', line 119

def row_span
  @row_span
end

#sbg_key ⇒ Object

Returns the value of attribute sbg_key.



16
17
18
 
# File 'lib/quby/compiler/entities/question.rb', line 16

def sbg_key
  @sbg_key
end

#score_header ⇒ Object

Whether we use the :description, the :value or :none for the score header above this question



99
100
101
 
# File 'lib/quby/compiler/entities/question.rb', line 99

def score_header
  @score_header
end

#sets_textvar ⇒ Object

Text variable name that will be replaced with the answer to this question In all following text elements that support markdown



108
109
110
 
# File 'lib/quby/compiler/entities/question.rb', line 108

def sets_textvar
  @sets_textvar
end

#show_values ⇒ Object

Whether we show the value for each option :all => in all questionnaire display modes :none => in none of display modes :paged => for only in :paged display mode :bulk => for only in :bulk display mode



61
62
63
 
# File 'lib/quby/compiler/entities/question.rb', line 61

def show_values
  @show_values
end

#size ⇒ Object

To specify size of string/number input boxes



73
74
75
 
# File 'lib/quby/compiler/entities/question.rb', line 73

def size
  @size
end

#table ⇒ Object

Table this question might belong to



115
116
117
 
# File 'lib/quby/compiler/entities/question.rb', line 115

def table
  @table
end

#title ⇒ Object

Returns the value of attribute title.



18
19
20
 
# File 'lib/quby/compiler/entities/question.rb', line 18

def title
  @title
end

#title_question ⇒ Object

string question that is displayed after the title of this question.



46
47
48
 
# File 'lib/quby/compiler/entities/question.rb', line 46

def title_question
  @title_question
end

#type ⇒ Object

What kind of question is this?



25
26
27
 
# File 'lib/quby/compiler/entities/question.rb', line 25

def type
  @type
end

#unit ⇒ Object

To display unit for number items



71
72
73
 
# File 'lib/quby/compiler/entities/question.rb', line 71

def unit
  @unit
end

#validations ⇒ Object

Structuring



67
68
69
 
# File 'lib/quby/compiler/entities/question.rb', line 67

def validations
  @validations
end

Instance Method Details

#answer_keys ⇒ Object

Returns all possible answer keys of this question (excluding subquestions, including options). radio/select/scale-options do not create answer_keys, but answer values.



283
284
285
 
# File 'lib/quby/compiler/entities/question.rb', line 283

def answer_keys
  [key]
end

#as_json(options = {}) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/quby/compiler/entities/question.rb', line 232

def as_json(options = {})
  # rubocop:disable SymbolName
  super.merge(
    key: key,
    title: Quby::Compiler::MarkdownParser.new(title).to_html,
    description: Quby::Compiler::MarkdownParser.new(description).to_html,
    type: type,
    size: size.presence && Integer(size), # 2022-11: 4k string and 7k integer
    hidden: hidden?,
    displayModes: display_modes,
    defaultInvisible: default_invisible,
    viewSelector: view_selector,
    parentKey: parent&.key,
    parentOptionKey: parent_option_key,
    deselectable: deselectable,
    presentation: presentation,
    as: as || type, # default to type so typescript can narrow on it.
    questionGroup: question_group
  ).tap do |json|
    json[:unit] = unit if %i[integer float string].include?(type) && as != :slider
    json[:showValues] = [true, :all].include?(show_values) if %i[radio scale].include?(type) && show_values
  end
end

#claimed_keys ⇒ Object

The keys this question claims as his own. Not including options and subquestions. Includes keys for the question, inputs and answers.



277
278
279
 
# File 'lib/quby/compiler/entities/question.rb', line 277

def claimed_keys
  [key]
end

#context_free_title_or_title ⇒ Object

rubocop:enable CyclomaticComplexity, Metrics/MethodLength



208
209
210
 
# File 'lib/quby/compiler/entities/question.rb', line 208

def context_free_title_or_title
  context_free_title || title
end

#expand_depends_on_input_keys ⇒ Object

rubocop:enable AccessorMethodName



220
221
222
223
224
225
226
 
# File 'lib/quby/compiler/entities/question.rb', line 220

def expand_depends_on_input_keys
  return unless @depends_on
  @depends_on = questionnaire.expand_input_keys(@depends_on)
  @extra_data[:"depends-on"] = @depends_on.to_json
rescue => e
  raise e.class, "Question #{key} depends_on contains an error: #{e.message}"
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


311
312
313
 
# File 'lib/quby/compiler/entities/question.rb', line 311

def hidden?
  hidden
end

#html_id ⇒ Object 



303
304
305
 
# File 'lib/quby/compiler/entities/question.rb', line 303

def html_id
  "answer_#{key}_input"
end

#input_keys ⇒ Object

Returns all keys belonging to html inputs generated by this question.



261
262
263
264
265
266
267
268
 
# File 'lib/quby/compiler/entities/question.rb', line 261

def input_keys
  if options.blank?
    answer_keys
  else
    # Some options don't have a key (inner_title), they are stripped
    options.map { |opt| opt.input_key }.compact
  end
end

#key_in_use?(k) ⇒ Boolean

Returns:

  • (Boolean) 


270
271
272
273
 
# File 'lib/quby/compiler/entities/question.rb', line 270

def key_in_use?(k)
  claimed_keys.include?(k) ||
  options.any? { |option| option.key_in_use?(k) }
end

#maximum ⇒ Object

Maximum value for float and integer types, set by validation



299
300
301
 
# File 'lib/quby/compiler/entities/question.rb', line 299

def maximum
  validations.find { |i| i[:type] == :maximum }.try(:fetch, :value)
end

#minimum ⇒ Object

Minimum value for float and integer types, set by validation



294
295
296
 
# File 'lib/quby/compiler/entities/question.rb', line 294

def minimum
  validations.find { |i| i[:type] == :minimum }.try(:fetch, :value)
end

#set_depends_on(keys) ⇒ Object

rubocop:disable AccessorMethodName



213
214
215
216
217
 
# File 'lib/quby/compiler/entities/question.rb', line 213

def set_depends_on(keys)
  return if keys.blank?
  keys = [keys] unless keys.is_a?(Array)
  @depends_on = keys
end

#show_values_in_mode?(mode) ⇒ Boolean

Returns:

  • (Boolean) 


315
316
317
318
319
320
321
 
# File 'lib/quby/compiler/entities/question.rb', line 315

def show_values_in_mode?(mode)
  case show_values
  when :none then false
  when :all then true
  else show_values == mode
  end
end

#subquestion? ⇒ Boolean

Returns:

  • (Boolean) 


327
328
329
 
# File 'lib/quby/compiler/entities/question.rb', line 327

def subquestion?
  !parent_option_key.nil?
end

#subquestions ⇒ Object 



323
324
325
 
# File 'lib/quby/compiler/entities/question.rb', line 323

def subquestions
  options.map { |opt| opt.questions }.flatten
end

#title_question? ⇒ Boolean

Returns:

  • (Boolean) 


256
257
258
 
# File 'lib/quby/compiler/entities/question.rb', line 256

def title_question?
  presentation == :next_to_title
end

#view_selector ⇒ Object 



307
308
309
 
# File 'lib/quby/compiler/entities/question.rb', line 307

def view_selector
  table.blank? ? "#item_#{key}" : "[data-for=#{key}], #answer_#{key}_input"
end