Class: Primer::Forms::Dsl::Input

Inherits:
Object
  • Object
show all
Includes:
ClassNameHelper
Defined in:
app/lib/primer/forms/dsl/input.rb

Overview

:nodoc:

Constant Summary collapse

SPACE_DELIMITED_ARIA_ATTRIBUTES = 
%i[describedby].freeze
DEFAULT_SIZE = 
:medium
SIZE_MAPPINGS = 
{
  :small => "FormControl-small",
  DEFAULT_SIZE => "FormControl-medium",
  :large => "FormControl-large"
}.freeze
SIZE_OPTIONS = 
SIZE_MAPPINGS.keys
DEFAULT_INPUT_WIDTH = 
:auto
INPUT_WIDTH_MAPPINGS = 
{
  DEFAULT_INPUT_WIDTH => "FormControl-input-width--auto",
  :xsmall => "FormControl-input-width--xsmall",
  :small => "FormControl-input-width--small",
  :medium => "FormControl-input-width--medium",
  :large => "FormControl-input-width--large",
  :xlarge => "FormControl-input-width--xlarge",
  :xxlarge => "FormControl-input-width--xxlarge"
}.freeze
INPUT_WIDTH_OPTIONS = 
INPUT_WIDTH_MAPPINGS.keys

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(builder:, form:, **system_arguments) ⇒ Input

Returns a new instance of Input.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'app/lib/primer/forms/dsl/input.rb', line 72

def initialize(builder:, form:, **system_arguments)
  @builder = builder
  @form = form

  @input_arguments = system_arguments
  @input_arguments.delete(:id) unless @input_arguments[:id].present?
  @label_arguments = @input_arguments.delete(:label_arguments) || {}
  @label_arguments[:for] = id if id.present?

  @label_arguments[:class] = class_names(
    @label_arguments[:class],
    @input_arguments.fetch(:visually_hide_label, false) ? "sr-only" : nil
  )

  @input_arguments.delete(:visually_hide_label)

  @input_arguments.delete(:class) if @input_arguments[:class].blank?
  @label_arguments.delete(:class) if @label_arguments[:class].blank?

  @caption = @input_arguments.delete(:caption)
  @validation_message = @input_arguments.delete(:validation_message)
  @invalid = @input_arguments.delete(:invalid)
  @full_width = @input_arguments.delete(:full_width) { true }
  @size = @input_arguments.delete(:size)
  @input_width = @input_arguments.delete(:input_width)

  # If scope_name_to_model is false, the name of the input for eg. `my_field`
  # will be `my_field` instead of the Rails default of `model[my_field]`.
  #
  # We achieve this by passing the `name` option to Rails form builder
  # methods. These methods will use the passed name if provided instead
  # of generating a scoped one.
  #
  unless @input_arguments.delete(:scope_name_to_model) { true }
    @input_arguments[:name] = name
  end
  # rubocop:enable Style/IfUnlessModifier

  # If scope_id_to_model is false, the name of the input for eg. `my_field`
  # will be `my_field` instead of the Rails default of `model_my_field`.
  #
  # We achieve this by passing the `id` option to Rails form builder
  # methods. These methods will use the passed id if provided instead
  # of generating a scoped one. The id is the name of the field unless
  # explicitly provided in system_arguments.
  #
  # rubocop:disable Style/IfUnlessModifier
  unless @input_arguments.delete(:scope_id_to_model) { true }
    @input_arguments[:id] = @input_arguments.delete(:id) { name }
  end
  # rubocop:enable Style/IfUnlessModifier

  # Whether or not to wrap the component in a FormControl, which renders a
  # label above and validation message beneath the input.
  @form_control = @input_arguments.delete(:form_control) { true }

  @input_arguments[:invalid] = "true" if invalid?

  @base_id = SecureRandom.uuid

  @ids = {}.tap do |id_map|
    id_map[:validation] = "validation-#{@base_id}" if supports_validation?
    id_map[:character_limit_caption] = "character_limit-#{@base_id}" if character_limit?
    id_map[:caption] = "caption-#{@base_id}" if caption? || caption_template?
  end

  add_input_aria(:required, true) if required?
  add_input_aria(:invalid, true) if invalid?
  add_input_aria(:describedby, ids.values) if ids.any?

  # avoid browser-native validation, which doesn't match Primer's style
  input_arguments.delete(:required)
end

Instance Attribute Details

#base_id ⇒ Object (readonly)

Returns the value of attribute base_id.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def base_id
  @base_id
end

#builder ⇒ Object (readonly)

Returns the value of attribute builder.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def builder
  @builder
end

#caption ⇒ Object (readonly)

Returns the value of attribute caption.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def caption
  @caption
end

#form ⇒ Object (readonly)

Returns the value of attribute form.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def form
  @form
end

#form_control ⇒ Object (readonly) Also known as: form_control?

Returns the value of attribute form_control.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def form_control
  @form_control
end

#ids ⇒ Object (readonly)

Returns the value of attribute ids.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def ids
  @ids
end

#input_arguments ⇒ Object (readonly)

Returns the value of attribute input_arguments.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def input_arguments
  @input_arguments
end

#label_arguments ⇒ Object (readonly)

Returns the value of attribute label_arguments.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def label_arguments
  @label_arguments
end

#validation_message ⇒ Object (readonly)

Returns the value of attribute validation_message.



68
69
70
 
# File 'app/lib/primer/forms/dsl/input.rb', line 68

def validation_message
  @validation_message
end

Instance Method Details

#add_input_aria(key, value) ⇒ Object 



158
159
160
161
162
163
164
165
166
 
# File 'app/lib/primer/forms/dsl/input.rb', line 158

def add_input_aria(key, value)
  @input_arguments[:aria] ||= {}

  @input_arguments[:aria][key] = if space_delimited_aria_attribute?(key)
                                   aria_join(@input_arguments[:aria][key], *Array(value))
                                 else
                                   value
                                 end
end

#add_input_classes(*class_names) ⇒ Object 



146
147
148
149
150
 
# File 'app/lib/primer/forms/dsl/input.rb', line 146

def add_input_classes(*class_names)
  input_arguments[:class] = class_names(
    input_arguments[:class], *class_names
  )
end

#add_input_data(key, value) ⇒ Object 



168
169
170
 
# File 'app/lib/primer/forms/dsl/input.rb', line 168

def add_input_data(key, value)
  input_data[key] = value
end

#add_label_classes(*class_names) ⇒ Object 



152
153
154
155
156
 
# File 'app/lib/primer/forms/dsl/input.rb', line 152

def add_label_classes(*class_names)
  label_arguments[:class] = class_names(
    label_arguments[:class], *class_names
  )
end

#autofocus! ⇒ Object 



285
286
287
 
# File 'app/lib/primer/forms/dsl/input.rb', line 285

def autofocus!
  input_arguments[:autofocus] = true
end

#caption? ⇒ Boolean

Returns:

  • (Boolean) 


206
207
208
 
# File 'app/lib/primer/forms/dsl/input.rb', line 206

def caption?
  caption.present?
end

#caption_id ⇒ Object 



202
203
204
 
# File 'app/lib/primer/forms/dsl/input.rb', line 202

def caption_id
  ids[:caption]
end

#caption_template? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
213
214
 
# File 'app/lib/primer/forms/dsl/input.rb', line 210

def caption_template?
  return false unless form

  form.caption_template?(caption_template_name)
end

#character_limit? ⇒ Boolean

Returns:

  • (Boolean) 


220
221
222
 
# File 'app/lib/primer/forms/dsl/input.rb', line 220

def character_limit?
  false
end

#character_limit_id ⇒ Object 



224
225
226
 
# File 'app/lib/primer/forms/dsl/input.rb', line 224

def character_limit_id
  ids[:character_limit_caption]
end

#character_limit_target_prefix ⇒ Object 



228
229
230
231
232
233
234
235
236
237
 
# File 'app/lib/primer/forms/dsl/input.rb', line 228

def character_limit_target_prefix
  case type
  when :text_field
    "primer-text-field"
  when :text_area
    "primer-text-area"
  else
    ""
  end
end

#disabled? ⇒ Boolean

Returns:

  • (Boolean) 


258
259
260
 
# File 'app/lib/primer/forms/dsl/input.rb', line 258

def disabled?
  !!input_arguments[:disabled]
end

#focusable? ⇒ Boolean

:nocov:

Returns:

  • (Boolean) 


316
317
318
 
# File 'app/lib/primer/forms/dsl/input.rb', line 316

def focusable?
  false
end

#full_width? ⇒ Boolean

Returns:

  • (Boolean) 


262
263
264
 
# File 'app/lib/primer/forms/dsl/input.rb', line 262

def full_width?
  @full_width
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


247
248
249
 
# File 'app/lib/primer/forms/dsl/input.rb', line 247

def hidden?
  !!input_arguments[:hidden]
end

#id ⇒ Object 



289
290
291
 
# File 'app/lib/primer/forms/dsl/input.rb', line 289

def id
  @input_arguments[:id]
end

#input? ⇒ Boolean

Returns:

  • (Boolean) 


320
321
322
 
# File 'app/lib/primer/forms/dsl/input.rb', line 320

def input?
  true
end

#input_width ⇒ Object 



270
271
272
 
# File 'app/lib/primer/forms/dsl/input.rb', line 270

def input_width
  @input_width ||= INPUT_WIDTH_MAPPINGS.include?(@input_width) ? @input_width : DEFAULT_INPUT_WIDTH
end

#invalid? ⇒ Boolean

Returns:

  • (Boolean) 


243
244
245
 
# File 'app/lib/primer/forms/dsl/input.rb', line 243

def invalid?
  supports_validation? && !valid?
end

#label ⇒ Object 



302
303
304
 
# File 'app/lib/primer/forms/dsl/input.rb', line 302

def label
  raise_for_abstract_method!(__method__)
end

#merge_input_arguments!(arguments) ⇒ Object

:nocov:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'app/lib/primer/forms/dsl/input.rb', line 179

def merge_input_arguments!(arguments)
  arguments.each do |k, v|
    case k
    when :class, :classes, "class", "classes"
      add_input_classes(v)
    when :aria, "aria"
      v.each do |aria_k, aria_v|
        add_input_aria(aria_k, aria_v)
      end
    when :data, "data"
      v.each do |data_k, data_v|
        add_input_data(data_k, data_v)
      end
    else
      @input_arguments[k] = v
    end
  end
end

#name ⇒ Object

:nocov:



298
299
300
 
# File 'app/lib/primer/forms/dsl/input.rb', line 298

def name
  raise_for_abstract_method!(__method__)
end

#remove_input_data(key) ⇒ Object

:nocov:



173
174
175
 
# File 'app/lib/primer/forms/dsl/input.rb', line 173

def remove_input_data(key)
  input_data.delete(key)
end

#render_caption_template ⇒ Object 



216
217
218
 
# File 'app/lib/primer/forms/dsl/input.rb', line 216

def render_caption_template
  form.render_caption_template(caption_template_name)
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


251
252
253
254
255
256
 
# File 'app/lib/primer/forms/dsl/input.rb', line 251

def required?
  input_arguments[:required] ||
    input_arguments[:aria_required] ||
    input_arguments[:"aria-required"] ||
    input_arguments.dig(:aria, :required)
end

#size ⇒ Object 



266
267
268
 
# File 'app/lib/primer/forms/dsl/input.rb', line 266

def size
  @size ||= SIZE_MAPPINGS.include?(@size) ? @size : DEFAULT_SIZE
end

#supports_validation? ⇒ Boolean

Returns:

  • (Boolean) 


324
325
326
 
# File 'app/lib/primer/forms/dsl/input.rb', line 324

def supports_validation?
  true
end

#to_component ⇒ Object 



310
311
312
 
# File 'app/lib/primer/forms/dsl/input.rb', line 310

def to_component
  raise_for_abstract_method!(__method__)
end

#type ⇒ Object 



306
307
308
 
# File 'app/lib/primer/forms/dsl/input.rb', line 306

def type
  raise_for_abstract_method!(__method__)
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


239
240
241
 
# File 'app/lib/primer/forms/dsl/input.rb', line 239

def valid?
  supports_validation? && validation_messages.empty? && !@invalid
end

#validation_arguments ⇒ Object 



328
329
330
331
332
333
334
 
# File 'app/lib/primer/forms/dsl/input.rb', line 328

def validation_arguments
  {
    class: "FormControl-inlineValidation",
    id: validation_id,
    hidden: valid? || validation_messages.empty?
  }
end

#validation_error_icon_target ⇒ Object 



344
345
346
 
# File 'app/lib/primer/forms/dsl/input.rb', line 344

def validation_error_icon_target
  ""
end

#validation_id ⇒ Object 



198
199
200
 
# File 'app/lib/primer/forms/dsl/input.rb', line 198

def validation_id
  ids[:validation]
end

#validation_message_arguments ⇒ Object 



336
337
338
 
# File 'app/lib/primer/forms/dsl/input.rb', line 336

def validation_message_arguments
  {}
end

#validation_messages ⇒ Object 



274
275
276
277
278
279
280
281
282
283
 
# File 'app/lib/primer/forms/dsl/input.rb', line 274

def validation_messages
  @validation_messages ||=
    if validation_message
      [validation_message]
    elsif builder.object.respond_to?(:errors)
      name ? builder.object.errors.full_messages_for(name) : []
    else
      []
    end
end

#validation_success_icon_target ⇒ Object 



340
341
342
 
# File 'app/lib/primer/forms/dsl/input.rb', line 340

def validation_success_icon_target
  ""
end

#value ⇒ Object 



293
294
295
 
# File 'app/lib/primer/forms/dsl/input.rb', line 293

def value
  @input_arguments[:value]
end

#values_disambiguate_template_names? ⇒ Boolean

Whether or not the value: argument should be used to determine the caption template for a given field. This is useful in especially radio button groups where each option has the same name but a different value. Check box groups where the values are submitted as an array also use this feature, since each check box also has the same name.

Returns:

  • (Boolean) 


352
353
354
 
# File 'app/lib/primer/forms/dsl/input.rb', line 352

def values_disambiguate_template_names?
  false
end