class SimpleForm::Inputs::Base

Attributes

attribute_name[R]
column[R]
html_classes[R]
input_html_classes[R]
input_html_options[R]
input_type[R]
options[R]
reflection[R]

Public Class Methods

disable(*keys) click to toggle source
# File lib/simple_form/inputs/base.rb, line 36
def self.disable(*keys)
  options = self.default_options.dup
  keys.each { |key| options[key] = false }
  self.default_options = options
end
enable(*keys) click to toggle source
# File lib/simple_form/inputs/base.rb, line 30
def self.enable(*keys)
  options = self.default_options.dup
  keys.each { |key| options.delete(key) }
  self.default_options = options
end
new(builder, attribute_name, column, input_type, options = {}) click to toggle source
Calls superclass method SimpleForm::Components::HTML5.new
# File lib/simple_form/inputs/base.rb, line 48
def initialize(builder, attribute_name, column, input_type, options = {})
  super

  options             = options.dup
  @builder            = builder
  @attribute_name     = attribute_name
  @column             = column
  @input_type         = input_type
  @reflection         = options.delete(:reflection)
  @options            = options.reverse_merge!(self.class.default_options)
  @required           = calculate_required

  # Notice that html_options_for receives a reference to input_html_classes.
  # This means that classes added dynamically to input_html_classes will
  # still propagate to input_html_options.
  @html_classes = SimpleForm.additional_classes_for(:input) { additional_classes }

  @input_html_classes = @html_classes.dup
  @input_html_options = html_options_for(:input, input_html_classes).tap do |o|
    o[:readonly]  = true if has_readonly?
    o[:disabled]  = true if has_disabled?
    o[:autofocus] = true if has_autofocus?
  end
end

Public Instance Methods

additional_classes() click to toggle source
# File lib/simple_form/inputs/base.rb, line 81
def additional_classes
  @additional_classes ||= [input_type, required_class, readonly_class, disabled_class].compact
end
input() click to toggle source
# File lib/simple_form/inputs/base.rb, line 73
def input
  raise NotImplementedError
end
input_options() click to toggle source
# File lib/simple_form/inputs/base.rb, line 77
def input_options
  options
end

Private Instance Methods

add_size!() click to toggle source
# File lib/simple_form/inputs/base.rb, line 87
def add_size!
  input_html_options[:size] ||= [limit, SimpleForm.default_input_size].compact.min
end
column_limit() click to toggle source
# File lib/simple_form/inputs/base.rb, line 97
def column_limit
  column.limit
end
decimal_limit() click to toggle source

Add one for decimal point

# File lib/simple_form/inputs/base.rb, line 102
def decimal_limit
  column_limit && (column_limit + 1)
end
decimal_or_float?() click to toggle source
# File lib/simple_form/inputs/base.rb, line 106
def decimal_or_float?
  column.number? && column.type != :integer
end
html_options_for(namespace, css_classes) click to toggle source

Retrieve options for the given namespace from the options hash

# File lib/simple_form/inputs/base.rb, line 120
def html_options_for(namespace, css_classes)
  html_options = options[:"#{namespace}_html"]
  html_options = html_options ? html_options.dup : {}
  css_classes << html_options[:class] if html_options.key?(:class)
  html_options[:class] = css_classes unless css_classes.empty?
  html_options
end
limit() click to toggle source
# File lib/simple_form/inputs/base.rb, line 91
def limit
  if column
    decimal_or_float? ? decimal_limit : column_limit
  end
end
nested_boolean_style?() click to toggle source
# File lib/simple_form/inputs/base.rb, line 110
def nested_boolean_style?
  options.fetch(:boolean_style, SimpleForm.boolean_style) == :nested
end
reflection_or_attribute_name() click to toggle source

Find reflection name when available, otherwise use attribute

# File lib/simple_form/inputs/base.rb, line 115
def reflection_or_attribute_name
  reflection ? reflection.name : attribute_name
end
translate(namespace, default='') click to toggle source

Lookup translations for the given namespace using I18n, based on object name, actual action and attribute name. Lookup priority as follows:

 simple_form.{namespace}.{model}.{action}.{attribute}
 simple_form.{namespace}.{model}.{attribute}
 simple_form.{namespace}.defaults.{attribute}

Namespace is used for :labels and :hints.

Model is the actual object name, for a @user object you'll have :user.
Action is the action being rendered, usually :new or :edit.
And attribute is the attribute itself, :name for example.

The lookup for nested attributes is also done in a nested format using
both model and nested object names, such as follow:

 simple_form.{namespace}.{model}.{nested}.{action}.{attribute}
 simple_form.{namespace}.{model}.{nested}.{attribute}
 simple_form.{namespace}.{nested}.{action}.{attribute}
 simple_form.{namespace}.{nested}.{attribute}
 simple_form.{namespace}.defaults.{attribute}

Example:

  simple_form:
    labels:
      user:
        new:
          email: 'E-mail para efetuar o sign in.'
        edit:
          email: 'E-mail.'

Take a look at our locale example file.
# File lib/simple_form/inputs/base.rb, line 161
def translate(namespace, default='')
  model_names = lookup_model_names.dup
  lookups     = []

  while !model_names.empty?
    joined_model_names = model_names.join(".")
    model_names.shift

    lookups << :"#{joined_model_names}.#{lookup_action}.#{reflection_or_attribute_name}"
    lookups << :"#{joined_model_names}.#{reflection_or_attribute_name}"
  end
  lookups << :"defaults.#{lookup_action}.#{reflection_or_attribute_name}"
  lookups << :"defaults.#{attribute_name}"
  lookups << default

  I18n.t(lookups.shift, :scope => :"simple_form.#{namespace}", :default => lookups).presence
end