Helpers related to producing form related tags and inputs into templates.
Constructs a check_box from the given options
@macro input_field_doc
@example
check_box_tag :remember_me, :value => 'Yes'
@api public
# File lib/padrino-helpers/form_helpers.rb, line 362 def check_box_tag(name, options={}) options.reverse_merge!(:name => name, :value => '1') input_tag(:checkbox, options) end
Returns a string containing the error message attached to the method on the object if one exists.
@param [Object] object
The object to display the error for.
@param [Symbol] field
The field on the +object+ to display the error for.
@param [Hash] options
The options to control the error display.
@option options [String] :tag (“div”)
The tag that encloses the error.
@option options [String] :prepend (“”)
The text to prepend before the field error.
@option options [String] :append (“”)
The text to append after the field error.
@example
# => <span class="error">can't be blank</div> error_message_on :post, :title error_message_on @post, :title # => <div class="custom" style="border:1px solid red">can't be blank</div> error_message_on :post, :title, :tag => :id, :class => :custom, :style => "border:1px solid red" # => <div class="error">This title can't be blank (or it won't work)</div> error_message_on :post, :title, :prepend => "This title", :append => "(or it won't work)"
@return [String] The html display of an error for a particular object and field.
@api public
# File lib/padrino-helpers/form_helpers.rb, line 246 def error_message_on(object, field, options={}) object = object.is_a?(Symbol) ? instance_variable_get("@#{object}") : object error = object.errors[field] rescue nil if error options.reverse_merge!(:tag => :span, :class => :error) tag = options.delete(:tag) # Array(error).first is necessary because some orm give us an array others directly a value error = [options.delete(:prepend), Array(error).first, options.delete(:append)].compact.join(" ") content_tag(tag, error, options) else '' end end
Constructs list html for the errors for a given symbol
@overload error_messages_for(*objects, options = {})
@param [Array<Object>] object Splat of objects to display errors for. @param [Hash] options Error message display options. @option options [String] :header_tag ("h2") Used for the header of the error div @option options [String] :id ("errorExplanation") The id of the error div. @option options [String] :class ("errorExplanation") The class of the error div. @option options [Array<Object>] :object The object (or array of objects) for which to display errors, if you need to escape the instance variable convention. @option options [String] :object_name The object name to use in the header, or any text that you prefer. If +:object_name+ is not set, the name of the first object will be used. @option options [String] :header_message ("X errors prohibited this object from being saved") The message in the header of the error div. Pass +nil+ or an empty string to avoid the header message altogether. @option options [String] :message ("There were problems with the following fields:") The explanation message after the header message and before the error list. Pass +nil+ or an empty string to avoid the explanation message altogether.
@return [String] The html section with all errors for the specified objects
@example
error_messages_for :user
@api public
# File lib/padrino-helpers/form_helpers.rb, line 167 def error_messages_for(*objects) options = objects.extract_options!.symbolize_keys objects = objects.map { |object_name| object_name.is_a?(Symbol) ? instance_variable_get("@#{object_name}") : object_name }.compact count = objects.inject(0) { |sum, object| sum + object.errors.size } unless count.zero? html = {} [:id, :class, :style].each do |key| if options.include?(key) value = options[key] html[key] = value unless value.blank? else html[key] = 'field-errors' unless key == :style end end options[:object_name] ||= objects.first.class I18n.with_options :locale => options[:locale], :scope => [:models, :errors, :template] do |locale| header_message = if options.include?(:header_message) options[:header_message] else object_name = options[:object_name].to_s.underscore.gsub(/\//, ' ') object_name = I18n.t(:name, :default => object_name.humanize, :scope => [:models, object_name], :count => 1) locale.t :header, :count => count, :model => object_name end message = options.include?(:message) ? options[:message] : locale.t(:body) error_messages = objects.map { |object| object_name = options[:object_name].to_s.underscore.gsub(/\//, ' ') object.errors.map { |f, msg| field = I18n.t(f, :default => f.to_s.humanize, :scope => [:models, object_name, :attributes]) content_tag(:li, "%s %s" % [field, msg]) } }.join contents = '' contents << content_tag(options[:header_tag] || :h2, header_message) unless header_message.blank? contents << content_tag(:p, message) unless message.blank? contents << content_tag(:ul, error_messages) content_tag(:div, contents, html) end else '' end end
Constructs a field_set to group fields with given options
@overload field_set_tag(legend=nil, options={}, &block)
@param [String] legend The legend caption for the fieldset @param [Hash] options The html options for the fieldset. @param [Proc] block The content inside the fieldset.
@overload field_set_tag(options={}, &block)
@param [Hash] options The html options for the fieldset. @param [Proc] block The content inside the fieldset.
@return [String] The html for the fieldset tag based on given options.
@example
field_set_tag(:class => "office-set") { } field_set_tag("Office", :class => 'office-set') { }
@api public
# File lib/padrino-helpers/form_helpers.rb, line 127 def field_set_tag(*args, &block) options = args.extract_options! legend_text = args[0].is_a?(String) ? args.first : nil legend_html = legend_text.blank? ? '' : content_tag(:legend, legend_text) field_set_content = legend_html + capture_html(&block) concat_content content_tag(:fieldset, field_set_content, options) end
Constructs form fields for an object using given or default form_builder Used within an existing form to allow alternate objects within one form
@param [Object] object
The object for which the fields are being built.
@param [Hash] settings
The settings associated with these fields. Accepts html options.
@param [Proc] block
The content inside this set of fields.
@return [String] The html fields with the specified options.
@example
fields_for @user.assignment do |assignment| ... end fields_for :assignment do |assigment| ... end
@api public
# File lib/padrino-helpers/form_helpers.rb, line 53 def fields_for(object, settings={}, &block) instance = builder_instance(object, settings) fields_html = capture_html(instance, &block) fields_html << instance.hidden_field(:id) if instance.send(:nested_object_id) concat_content fields_html end
Constructs a file field input from the given options
@macro input_field_doc
@example
file_field_tag :photo, :class => 'long'
@api public
# File lib/padrino-helpers/form_helpers.rb, line 390 def file_field_tag(name, options={}) options.reverse_merge!(:name => name) input_tag(:file, options) end
Constructs a form for object using given or default form_builder
@param [Object] object
The object for which the form is being built.
@param [String] url
The url this form will submit to.
@param [Hash] settings
The settings associated with this form. Accepts html options.
@option settings [String] :builder (“StandardFormBuilder”)
The FormBuilder class to use such as StandardFormBuilder.
@param [Proc] block
The fields and content inside this form.
@yield [AbstractFormBuilder] The form builder used to compose fields.
@return [String] The html object-backed form with the specified options and input fields.
@example
form_for :user, '/register' do |f| ... end form_for @user, '/register', :id => 'register' do |f| ... end
@api public
# File lib/padrino-helpers/form_helpers.rb, line 30 def form_for(object, url, settings={}, &block) form_html = capture_html(builder_instance(object, settings), &block) form_tag(url, settings) { form_html } end
Constructs a form without object based on options
@param [String] url
The url this form will submit to.
@param [Hash] options
The html options associated with this form.
@param [Proc] block
The fields and content inside this form.
@return [String] The html form with the specified options and input fields.
@example
form_tag '/register', :class => "registration_form" do ... end
@api public
# File lib/padrino-helpers/form_helpers.rb, line 76 def form_tag(url, options={}, &block) desired_method = options[:method] data_method = options.delete(:method) if options[:method].to_s !~ /get|post/ options.reverse_merge!(:method => "post", :action => url) options[:enctype] = "multipart/form-data" if options.delete(:multipart) options["data-remote"] = "true" if options.delete(:remote) options["data-method"] = data_method if data_method options["accept-charset"] ||= "UTF-8" inner_form_html = hidden_form_method_field(desired_method) inner_form_html += capture_html(&block) concat_content content_tag(:form, inner_form_html, options) end
Constructs a submit button from the given options
@param [String] source
The source image path for the button.
@param [Hash] options
The html options for the input field.
@return [String] The html image button based on the options specified.
@example
submit_tag "Create", :class => 'success'
@api public
# File lib/padrino-helpers/form_helpers.rb, line 502 def image_submit_tag(source, options={}) options.reverse_merge!(:src => image_path(source)) input_tag(:image, options) end
Constructs a label tag from the given options
@param [String] name
The name of the field to label.
@param [Hash] options
The html options for this label.
@option options :caption
The caption for this label.
@param [Proc] block
The content to be inserted into the label.
@return [String] The html for this label with the given options.
@example
label_tag :username, :class => 'long-label' label_tag :username, :class => 'long-label' do ... end
@api public
# File lib/padrino-helpers/form_helpers.rb, line 279 def label_tag(name, options={}, &block) options.reverse_merge!(:caption => "#{name.to_s.humanize}: ", :for => name) caption_text = options.delete(:caption) caption_text << "<span class='required'>*</span> " if options.delete(:required) if block_given? # label with inner content label_content = caption_text + capture_html(&block) concat_content(content_tag(:label, label_content, options)) else # regular label content_tag(:label, caption_text, options) end end
Constructs a password field input from the given options
@macro input_field_doc
@example
password_field_tag :password, :class => 'long'
@api public
# File lib/padrino-helpers/form_helpers.rb, line 348 def password_field_tag(name, options={}) options.reverse_merge!(:name => name) input_tag(:password, options) end
Constructs a select from the given options
@example
options = [['caption', 'value'], ['Green', 'green1'], ['Blue', 'blue1'], ['Black', "black1"]] options = ['option', 'red', 'yellow' ] select_tag(:favorite_color, :options => ['red', 'yellow'], :selected => 'green1') select_tag(:country, :collection => @countries, :fields => [:name, :code], :include_blank => 'None') # Optgroups can be generated using :grouped_options => (Hash or nested Array) grouped_options = [['Friends',['Yoda',['Obiwan',1]]],['Enemies',['Palpatine',['Darth Vader',3]]]] grouped_options = {'Friends' => ['Yoda',['Obiwan',1]],'Enemies' => ['Palpatine',['Darth Vader',3]]} select_tag(:color, :grouped_options => [['warm',['red','yellow']],['cool',['blue', 'purple']]]) # Optgroups can be generated using :grouped_options => (Hash or nested Array) grouped_options = [['Friends',['Yoda',['Obiwan',1]]],['Enemies',['Palpatine',['Darth Vader',3]]]] grouped_options = {'Friends' => ['Yoda',['Obiwan',1]],'Enemies' => ['Palpatine',['Darth Vader',3]]} select_tag(:color, :grouped_options => [['warm',['red','yellow']],['cool',['blue', 'purple']]])
@param [String] name
The name of the input field.
@param [Hash] options
The html options for the input field.
@option options [Array<String, Array>] :options
Explicit options to display in the select. Can be strings or string tuples.
@option options [Array<Array>] :grouped_options
List of options for each group in the select. See examples for details.
@option options [Array<Object>] :collection
Collection of objects used as options in the select.
@option options [Array<Symbol>] :fields
The attributes used as "label" and "value" for each +collection+ object.
@option options [String] :selected (nil)
The option value initially selected.
@option options [Boolean] :include_blank (false)
Include a blank option in the select.
@option options [Boolean] :multiple (false)
Allow multiple options to be selected at once.
@return [String] The html input field based on the options specified
@api public
# File lib/padrino-helpers/form_helpers.rb, line 436 def select_tag(name, options={}) options.reverse_merge!(:name => name) collection, fields = options.delete(:collection), options.delete(:fields) options[:options] = options_from_collection(collection, fields) if collection prompt = options.delete(:include_blank) select_options_html = if options[:options] options_for_select(options.delete(:options), options.delete(:selected)) elsif options[:grouped_options] grouped_options_for_select(options.delete(:grouped_options), options.delete(:selected), prompt) end select_options_html = select_options_html.unshift(blank_option(prompt)) if select_options_html.is_a?(Array) options.merge!(:name => "#{options[:name]}[]") if options[:multiple] content_tag(:select, select_options_html, options) end
Constructs a submit button from the given options
@param [String] caption
The caption for the submit button.
@param [Hash] options
The html options for the input field.
@return [String] The html submit button based on the options specified.
@example
submit_tag "Create", :class => 'success'
@api public
# File lib/padrino-helpers/form_helpers.rb, line 484 def submit_tag(caption="Submit", options={}) options.reverse_merge!(:value => caption) input_tag(:submit, options) end
Constructs a text area input from the given options
@macro input_field_doc
@example
text_area_tag :username, :class => 'long', :value => "Demo?"
@api public
# File lib/padrino-helpers/form_helpers.rb, line 334 def text_area_tag(name, options={}) options.reverse_merge!(:name => name, :rows => "", :cols => "") content_tag(:textarea, options.delete(:value).to_s, options) end
Constructs a text field input from the given options
@macro [new] input_field_doc
@param [String] name The name of the input field. @param [Hash] options The html options for the input field. @return [String] The html input field based on the +options+ specified
@example
text_field_tag :username, :class => 'long'
@api public
# File lib/padrino-helpers/form_helpers.rb, line 306 def text_field_tag(name, options={}) options.reverse_merge!(:name => name) input_tag(:text, options) end
Returns the blank option serving as a prompt if passed
# File lib/padrino-helpers/form_helpers.rb, line 550 def blank_option(prompt) return unless prompt case prompt when String then content_tag(:option, prompt, :value => '') when Array then content_tag(:option, prompt.first, :value => prompt.last) else content_tag(:option, '', :value => '') end end
Returns the optgroups with options tags for a select based on the given :grouped_options items
# File lib/padrino-helpers/form_helpers.rb, line 531 def grouped_options_for_select(collection, selected=nil, prompt=false) if collection.is_a?(Hash) collection.map do |key, value| content_tag :optgroup, :label => key do options_for_select(value, selected) end end elsif collection.is_a?(Array) collection.map do |optgroup| content_tag :optgroup, :label => optgroup.first do options_for_select(optgroup.last, selected) end end end end
Returns the options tags for a select based on the given option items
# File lib/padrino-helpers/form_helpers.rb, line 520 def options_for_select(option_items, selected_value=nil) return '' if option_items.blank? option_items.map do |caption, value| value ||= caption content_tag(:option, caption, :value => value, :selected => option_is_selected?(value, caption, selected_value)) end end
Returns an array of option items for a select field based on the given collection fields is an array containing the fields to display from each item in the collection
# File lib/padrino-helpers/form_helpers.rb, line 513 def options_from_collection(collection, fields) collection.map { |item| [ item.send(fields.first), item.send(fields.last) ] } end
Generated with the Darkfish Rdoc Generator 2.