Class: Quby::Questionnaires::Entities::Question

Inherits:
Item
  • Object
show all
Defined in:
lib/quby/questionnaires/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



122
123
124
125
126
127
128
129
130
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
 
# File 'lib/quby/questionnaires/entities/question.rb', line 122

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 = options[: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 = options[:sets_textvar]
  @unit = options[:unit]
  @lines = options[:lines] || 6
  @cols = options[:cols] || 40
  @default_invisible = options[:default_invisible] || false
  @labels = options[:labels] || []
  @size = options[:size]

  @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]

  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]
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.



45
46
47
 
# File 'lib/quby/questionnaires/entities/question.rb', line 45

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



34
35
36
 
# File 'lib/quby/questionnaires/entities/question.rb', line 34

def allow_duplicate_option_values
  @allow_duplicate_option_values
end

#as ⇒ Object

How should we display this question



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

def as
  @as
end

#autocomplete ⇒ Object

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



48
49
50
 
# File 'lib/quby/questionnaires/entities/question.rb', line 48

def autocomplete
  @autocomplete
end

#col_span ⇒ Object 



198
199
200
 
# File 'lib/quby/questionnaires/entities/question.rb', line 198

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

#cols ⇒ Object

Returns the value of attribute cols.



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

def cols
  @cols
end

#context_free_title ⇒ Object

rubocop:enable AccessorMethodName



187
188
189
 
# File 'lib/quby/questionnaires/entities/question.rb', line 187

def context_free_title
  @context_free_title || @title
end

#default_invisible ⇒ Object

Returns the value of attribute default_invisible.



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

def default_invisible
  @default_invisible
end

#default_position ⇒ Object 



251
252
253
254
 
# File 'lib/quby/questionnaires/entities/question.rb', line 251

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

#dependencies ⇒ Object

Returns the value of attribute dependencies.



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

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.



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

def depends_on
  @depends_on
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#deselectable ⇒ Object

Whether this radio question is deselectable



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

def deselectable
  @deselectable
end

#disallow_bulk ⇒ Object

Whether we can collapse this in bulk view



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

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)



38
39
40
 
# File 'lib/quby/questionnaires/entities/question.rb', line 38

def display_modes
  @display_modes
end

#extra_data ⇒ Object 



191
192
193
194
195
196
 
# File 'lib/quby/questionnaires/entities/question.rb', line 191

def extra_data
  result = @extra_data
  result = result.merge(:"depends-on" => @depends_on.to_json) if @depends_on
  result = result.merge(:placeholder => @options.find { |option| option.placeholder }&.key)
  result
end

#group_maximum_answered ⇒ Object

Returns the value of attribute group_maximum_answered.



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

def group_maximum_answered
  @group_maximum_answered
end

#group_minimum_answered ⇒ Object

Returns the value of attribute group_minimum_answered.



95
96
97
 
# File 'lib/quby/questionnaires/entities/question.rb', line 95

def group_minimum_answered
  @group_minimum_answered
end

#hidden ⇒ Object

To hide old questions



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

def hidden
  @hidden
end

#input_data ⇒ Object

data-attributes for the input tag.



88
89
90
 
# File 'lib/quby/questionnaires/entities/question.rb', line 88

def input_data
  @input_data
end

#key ⇒ Object

Standard attributes



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

def key
  @key
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#lines ⇒ Object

Amount of rows and cols a textarea has



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

def lines
  @lines
end

#options ⇒ Object

Multiple-choice questions have options to choose from



41
42
43
 
# File 'lib/quby/questionnaires/entities/question.rb', line 41

def options
  @options
end

#parent ⇒ Object

Some questions are a tree.



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

def parent
  @parent
end

#parent_option_key ⇒ Object

Returns the value of attribute parent_option_key.



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

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



94
95
96
 
# File 'lib/quby/questionnaires/entities/question.rb', line 94

def question_group
  @question_group
end

#questionnaire ⇒ Object

Returns the value of attribute questionnaire.



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

def questionnaire
  @questionnaire
end

#row_span ⇒ Object

Returns the value of attribute row_span.



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

def row_span
  @row_span
end

#sbg_key ⇒ Object

Returns the value of attribute sbg_key.



16
17
18
 
# File 'lib/quby/questionnaires/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



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

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



100
101
102
 
# File 'lib/quby/questionnaires/entities/question.rb', line 100

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



55
56
57
 
# File 'lib/quby/questionnaires/entities/question.rb', line 55

def show_values
  @show_values
end

#size ⇒ Object

To specify size of string/number input boxes



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

def size
  @size
end

#table ⇒ Object

Table this question might belong to



107
108
109
 
# File 'lib/quby/questionnaires/entities/question.rb', line 107

def table
  @table
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

#type ⇒ Object

What kind of question is this?



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

def type
  @type
end

#unit ⇒ Object

To display unit for number items



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

def unit
  @unit
end

#validations ⇒ Object

Structuring



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

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.



247
248
249
 
# File 'lib/quby/questionnaires/entities/question.rb', line 247

def answer_keys
  [key]
end

#as_json(options = {}) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/quby/questionnaires/entities/question.rb', line 202

def as_json(options = {})
  # rubocop:disable SymbolName
  super.merge(
    key: key,
    title: Quby::MarkdownParser.new(title).to_html,
    description: Quby::MarkdownParser.new(description).to_html,
    type: type,
    unit: unit,
    size: size,
    hidden: hidden?,
    displayModes: display_modes,
    defaultInvisible: default_invisible,
    viewSelector: view_selector,
    parentKey: parent&.key,
    parentOptionKey: parent_option_key,
    deselectable: deselectable,
    presentation: presentation,
    as: as,
    questionGroup: question_group
  )
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.



241
242
243
 
# File 'lib/quby/questionnaires/entities/question.rb', line 241

def claimed_keys
  [key]
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


274
275
276
 
# File 'lib/quby/questionnaires/entities/question.rb', line 274

def hidden?
  hidden
end

#html_id ⇒ Object 



266
267
268
 
# File 'lib/quby/questionnaires/entities/question.rb', line 266

def html_id
  "answer_#{key}_input"
end

#input_keys ⇒ Object

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



225
226
227
228
229
230
231
232
 
# File 'lib/quby/questionnaires/entities/question.rb', line 225

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) 


234
235
236
237
 
# File 'lib/quby/questionnaires/entities/question.rb', line 234

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



262
263
264
 
# File 'lib/quby/questionnaires/entities/question.rb', line 262

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

#minimum ⇒ Object

Minimum value for float and integer types, set by validation



257
258
259
 
# File 'lib/quby/questionnaires/entities/question.rb', line 257

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

#set_depends_on(keys) ⇒ Object

rubocop:disable AccessorMethodName



180
181
182
183
184
 
# File 'lib/quby/questionnaires/entities/question.rb', line 180

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) 


278
279
280
281
282
283
284
 
# File 'lib/quby/questionnaires/entities/question.rb', line 278

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) 


290
291
292
 
# File 'lib/quby/questionnaires/entities/question.rb', line 290

def subquestion?
  !parent_option_key.nil?
end

#subquestions ⇒ Object 



286
287
288
 
# File 'lib/quby/questionnaires/entities/question.rb', line 286

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

#view_selector ⇒ Object 



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

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