SimpleForm::FormBuilder

Helper for dealing with association selects/radios, generating the collection automatically. It's just a wrapper to input, so all options supported in input are also supported by association. Some extra options can also be given:

Examples

simple_form_for @user do |f|
  f.association :company          # Company.all
end

f.association :company, :collection => Company.all(:order => 'name')
# Same as using :order option, but overriding collection

Block

When a block is given, association simple behaves as a proxy to simple_fields_for:

f.association :company do |c|
  c.input :name
  c.input :type
end

From the options above, only :collection can also be supplied.

# File lib/simple_form/form_builder.rb, line 121
def association(association, options={}, &block)
  return simple_fields_for(*[association,
    options.delete(:collection), options].compact, &block) if block_given?

  raise ArgumentError, "Association cannot be used in forms not associated with an object" unless @object

  options[:as] ||= :select
  @reflection = find_association_reflection(association)
  raise "Association #{association.inspect} not found" unless @reflection

  case @reflection.macro
    when :belongs_to
      attribute = @reflection.options[:foreign_key] || :"#{@reflection.name}_id"
    when :has_one
      raise ":has_one association are not supported by f.association"
    else
      attribute = :"#{@reflection.name.to_s.singularize}_ids"

      if options[:as] == :select
        html_options = options[:input_html] ||= {}
        html_options[:size]   ||= 5
        html_options[:multiple] = true unless html_options.key?(:multiple)
      end
  end

  options[:collection] ||= @reflection.klass.all(
    :conditions => @reflection.options[:conditions], :order => @reflection.options[:order]
  )

  input(attribute, options).tap { @reflection = nil }
end

Creates a button:

form_for @user do |f|
  f.button :submit
end

It just acts as a proxy to method name given.

# File lib/simple_form/form_builder.rb, line 161
def button(type, *args, &block)
  if respond_to?(:"#{type}_button")
    send(:"#{type}_button", *args, &block)
  else
    send(type, *args, &block)
  end
end

Creates an error tag based on the given attribute, only when the attribute contains errors. All the given options are sent as :error_html.

Examples

f.error :name
f.error :name, :id => "cool_error"

# File lib/simple_form/form_builder.rb, line 177
def error(attribute_name, options={})
  define_simple_form_attributes(attribute_name, :error_html => options)
  SimpleForm::Inputs::Base.new(self).error
end

Creates an error notification message that only appears when the form object has some error. You can give a specific message with the :message option, otherwise it will look for a message using I18n. All other options given are passed straight as html options to the html tag.

Examples

f.error_notification
f.error_notification :message => 'Something went wrong'
f.error_notification :id => 'user_error_message', :class => 'form_error'

# File lib/simple_form/form_builder.rb, line 230
def error_notification(options={})
  SimpleForm::ErrorNotification.new(self, options).render
end

Creates a hint tag for the given attribute. Accepts a symbol indicating an attribute for I18n lookup or a string. All the given options are sent as :hint_html.

Examples

f.hint :name # Do I18n lookup
f.hint :name, :id => "cool_hint"
f.hint "Don't forget to accept this"

# File lib/simple_form/form_builder.rb, line 192
def hint(attribute_name, options={})
  attribute_name, options[:hint] = nil, attribute_name if attribute_name.is_a?(String)
  define_simple_form_attributes(attribute_name, :hint => options.delete(:hint), :hint_html => options)
  SimpleForm::Inputs::Base.new(self).hint
end

Basic input helper, combines all components in the stack to generate input html based on options the user define and some guesses through database column information. By default a call to input will generate label + input + hint (when defined) + errors (when exists), and all can be configured inside a wrapper html.

Examples

# Imagine @user has error "can't be blank" on name
simple_form_for @user do |f|
  f.input :name, :hint => 'My hint'
end

This is the output html (only the input portion, not the form):

<label class="string required" for="user_name">
  <abbr title="required">*</abbr> Super User Name!
</label>
<input class="string required" id="user_name" maxlength="100"
   name="user[name]" size="100" type="text" value="Carlos" />
<span class="hint">My hint</span>
<span class="error">can't be blank</span>

Each database type will render a default input, based on some mappings and heuristic to determine which is the best option.

You have some options for the input to enable/disable some functions:

:as => allows you to define the input type you want, for instance you
       can use it to generate a text field for a date column.

:required => defines whether this attribute is required or not. True
            by default.

The fact SimpleForm is built in components allow the interface to be unified. So, for instance, if you need to disable :hint for a given input, you can pass :hint => false. The same works for :error, :label and :wrapper.

Besides the html for any component can be changed. So, if you want to change the label html you just need to give a hash to :label_html. To configure the input html, supply :input_html instead and so on.

Options

Some inputs, as datetime, time and select allow you to give extra options, like prompt and/or include blank. Such options are given in plainly:

f.input :created_at, :include_blank => true

Collection

When playing with collections (:radio and :select inputs), you have three extra options:

:collection => use to determine the collection to generate the radio or select

:label_method => the method to apply on the array collection to get the label

:value_method => the method to apply on the array collection to get the value

Priority

Some inputs, as :time_zone and :country accepts a :priority option. If none is given SimpleForm.time_zone_priority and SimpleForm.country_priority are used respectivelly.

# File lib/simple_form/form_builder.rb, line 82
def input(attribute_name, options={}, &block)
  define_simple_form_attributes(attribute_name, options)

  if block_given?
    SimpleForm::Inputs::BlockInput.new(self, block).render
  else
    klass = self.class.mappings[input_type] ||
      self.class.const_get(:"#{input_type.to_s.camelize}Input")
    klass.new(self).render
  end
end

Creates a default label tag for the given attribute. You can give a label through the :label option or using i18n. All the given options are sent as :label_html.

Examples

f.label :name                     # Do I18n lookup
f.label :name, "Name"             # Same behavior as Rails, do not add required tag
f.label :name, :label => "Name"   # Same as above, but adds required tag

f.label :name, :required => false
f.label :name, :id => "cool_label"

# File lib/simple_form/form_builder.rb, line 211
def label(attribute_name, *args)
  return super if args.first.is_a?(String)
  options = args.extract_options!
  define_simple_form_attributes(attribute_name, :label => options.delete(:label),
    :label_html => options, :required => options.delete(:required))
  SimpleForm::Inputs::Base.new(self).label
end