require 'securerandom' module Padrino module Helpers ## # Helpers related to producing form related tags and inputs into templates. # module FormHelpers ## # 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 def form_for(object, url, settings={}, &block) instance = builder_instance(object, settings) html = capture_html(instance, &block) form_tag(url, settings) { html } 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 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_safe_content fields_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 def form_tag(url, options={}, &block) desired_method = options[:method].to_s options.delete(:method) unless desired_method =~ /get|post/i options.reverse_merge!(:method => 'post', :action => url) options[:enctype] = 'multipart/form-data' if options.delete(:multipart) options['accept-charset'] ||= 'UTF-8' inner_form_html = hidden_form_method_field(desired_method) inner_form_html << csrf_token_field inner_form_html << mark_safe(capture_html(&block)) concat_content content_tag(:form, inner_form_html, options) end ## # Returns the hidden method field for 'put' and 'delete' forms # Only 'get' and 'post' are allowed within browsers; # 'put' and 'delete' are just specified using hidden fields with form action still 'put'. # # @param [String] desired_method # The method this hidden field represents (i.e put or delete)) # # @return [String] The hidden field representing the +desired_method+ for the form. # # @example # # Generate: # hidden_form_method_field('delete') # # @api semipublic def hidden_form_method_field(desired_method) return ActiveSupport::SafeBuffer.new if desired_method.blank? || desired_method.to_s =~ /get|post/i hidden_field_tag(:_method, :value => desired_method) 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 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? ? ActiveSupport::SafeBuffer.new : content_tag(:legend, legend_text) field_set_content = legend_html + mark_safe(capture_html(&block)) concat_content content_tag(:fieldset, field_set_content, options) end ## # Constructs list html for the errors for a given symbol # # @overload error_messages_for(*objects, options = {}) # @param [Array] 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 ("field-errors") # The id of the error div. # @option options [String] :class ("field-errors") # The class of the error div. # @option options [Array] :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 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.count } 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 = ActiveSupport::SafeBuffer.new contents << content_tag(options[:header_tag] || :h2, header_message) unless header_message.blank? contents << content_tag(:p, message) unless message.blank? contents << safe_content_tag(:ul, error_messages) content_tag(:div, contents, html) end else '' end 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 ("span") # 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 # # => can't be blank # error_message_on :post, :title # error_message_on @post, :title # # # =>
can't be blank
# error_message_on :post, :title, :tag => :id, :class => :custom, :style => "border:1px solid red" # # # =>
This title can't be blank (or it won't work)
# 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 def error_message_on(object, field, options={}) object = object.is_a?(Symbol) ? instance_variable_get("@#{object}") : object error = object.errors[field] rescue nil error = if defined?(Ohm::Model) && object.is_a?(Ohm::Model) I18n.t("ohm.errors.messages.#{error[0]}", :default => error[0].to_s) else # Array(error).first is necessary because some ORMs # give us an array others directly a value Array(error)[0] end if error = Array(error)[0] options.reverse_merge!(:tag => :span, :class => :error) tag = options.delete(:tag) error = [options.delete(:prepend), error, options.delete(:append)].compact.join(" ") content_tag(tag, error, options) else '' end 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 def label_tag(name, options={}, &block) options.reverse_merge!(:caption => "#{name.to_s.humanize}: ", :for => name) caption_text = options.delete(:caption).html_safe caption_text.safe_concat "* " if options.delete(:required) if block_given? # label with inner content label_content = caption_text.concat capture_html(&block) concat_content(content_tag(:label, label_content, options)) else # regular label content_tag(:label, caption_text, options) end end ## # Creates a text field input with the given name and options # # @macro [new] text_field # @param [Symbol] name # The name of the input to create. # @param [Hash] options # The HTML options to include in this field. # # @option options [String] :id # Specifies a unique identifier for the field. # @option options [String] :class # Specifies the stylesheet class of the field. # @option options [String] :name # Specifies the name of the field. # @option options [String] :accesskey # Specifies a shortcut key to access the field. # @option options [Integer] :tabindex # Specifies the tab order of the field. # @option options [Integer] :maxlength # Specifies the maximum length, in characters, of the field. # @option options [Integer] :size # Specifies the width, in characters, of the field. # @option options [String] :placeholder # Specifies a short hint that describes the expected value of the field. # @option options [Boolean] :hidden # Specifies whether or not the field is hidden from view. # @option options [Boolean] :spellcheck # Specifies whether or not the field should have it's spelling and grammar checked for errors. # @option options [Boolean] :draggable # Specifies whether or not the field is draggable. (true, false, :auto) # @option options [String] :pattern # Specifies the regular expression pattern that the field's value is checked against. # @option options [Symbol] :autocomplete # Specifies whether or not the field should have autocomplete enabled. (:on, :off) # @option options [Boolean] :autofocus # Specifies whether or not the field should automatically get focus when the page loads. # @option options [Boolean] :required # Specifies whether or not the field is required to be completeled before the form is submitted. # @option options [Boolean] :readonly # Specifies whether or not the field is read only. # @option options [Boolean] :disabled # Specifies whether or not the field is disabled. # # @return [String] # Generated HTML with specified +options+ # # @example # text_field_tag :first_name, :maxlength => 40, :required => true # # => # # text_field_tag :last_name, :class => 'string', :size => 40 # # => # # text_field_tag :username, :placeholder => 'Your Username' # # => # # @api public def text_field_tag(name, options={}) input_tag(:text, options.reverse_merge!(:name => name)) end ## # Creates a number field input with the given name and options # # @macro [new] number_field # @param [Symbol] name # The name of the input to create. # @param [Hash] options # The HTML options to include in this field. # # @option options [String] :id # Specifies a unique identifier for the field. # @option options [String] :class # Specifies the stylesheet class of the field. # @option options [String] :name # Specifies the name of the field. # @option options [String] :accesskey # Specifies a shortcut key to access the field. # @option options [Integer] :tabindex # Specifies the tab order of the field. # @option options [Integer] :min # Specifies the minimum value of the field. # @option options [Integer] :max # Specifies the maximum value of the field. # @option options [Integer] :step # Specifies the legal number intervals of the field. # @option options [Boolean] :hidden # Specifies whether or not the field is hidden from view. # @option options [Boolean] :spellcheck # Specifies whether or not the field should have it's spelling and grammar checked for errors. # @option options [Boolean] :draggable # Specifies whether or not the field is draggable. (true, false, :auto) # @option options [String] :pattern # Specifies the regular expression pattern that the field's value is checked against. # @option options [Symbol] :autocomplete # Specifies whether or not the field should have autocomplete enabled. (:on, :off) # @option options [Boolean] :autofocus # Specifies whether or not the field should automatically get focus when the page loads. # @option options [Boolean] :required # Specifies whether or not the field is required to be completeled before the form is submitted. # @option options [Boolean] :readonly # Specifies whether or not the field is read only. # @option options [Boolean] :disabled # Specifies whether or not the field is disabled. # # @return [String] # Generated HTML with specified +options+ # # @example # number_field_tag :quanity, :class => 'numeric' # # => # # number_field_tag :zip_code, :pattern => /[0-9]{5}/ # # => # # number_field_tag :credit_card, :autocomplete => :off # # => # # number_field_tag :age, :min => 18, :max => 120, :step => 1 # # => # # @api public def number_field_tag(name, options={}) input_tag(:number, options.reverse_merge(:name => name)) end ## # Creates a telephone field input with the given name and options # # @macro text_field # # @example # telephone_field_tag :phone_number, :class => 'string' # # => # # telephone_field_tag :cell_phone, :tabindex => 1 # telephone_field_tag :work_phone, :tabindex => 2 # telephone_field_tag :home_phone, :tabindex => 3 # # # => # # => # # => # # @api public def telephone_field_tag(name, options={}) input_tag(:tel, options.reverse_merge(:name => name)) end alias_method :phone_field_tag, :telephone_field_tag ## # Creates an email field input with the given name and options # # @macro text_field # # @example # email_field_tag :email, :placeholder => 'you@example.com' # # => # # email_field_tag :email, :value => 'padrinorb@gmail.com', :readonly => true # # => # # @api public def email_field_tag(name, options={}) input_tag(:email, options.reverse_merge(:name => name)) end ## # Creates a search field input with the given name and options # # @macro text_field # # @example # search_field_tag :search, :placeholder => 'Search this website...' # # => # # search_field_tag :search, :maxlength => 15, :class => ['search', 'string'] # # => # # search_field_tag :search, :id => 'search' # # => # # search_field_tag :search, :autofocus => true # # => # # @api public def search_field_tag(name, options={}) input_tag(:search, options.reverse_merge(:name => name)) end ## # Creates a url field input with the given name and options # # @macro text_field # # @example # url_field_tag :favorite_website, :placeholder => 'http://padrinorb.com' # # # url_field_tag :home_page, :class => 'string url' # # # @api public def url_field_tag(name, options={}) input_tag(:url, options.reverse_merge(:name => name)) end ## # Constructs a hidden field input from the given options # # @macro text_field # # @example # hidden_field_tag :session_key, :value => "__secret__" # # @api public def hidden_field_tag(name, options={}) options.reverse_merge!(:name => name) input_tag(:hidden, options) end ## # Constructs a text area input from the given options # # @macro text_field # # @example # text_area_tag :username, :class => 'long', :value => "Demo?" # # @api public 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 password field input from the given options # # @macro text_field # # @example # password_field_tag :password, :class => 'long' # # @api public def password_field_tag(name, options={}) options.reverse_merge!(:name => name) input_tag(:password, options) end ## # Constructs a check_box from the given options # # @macro text_field # # @example # check_box_tag :remember_me, :value => 'Yes' # # @api public def check_box_tag(name, options={}) options.reverse_merge!(:name => name, :value => '1') input_tag(:checkbox, options) end ## # Constructs a radio_button from the given options # # @macro text_field # # @example # radio_button_tag :remember_me, :value => 'true' # # @api public def radio_button_tag(name, options={}) options.reverse_merge!(:name => name) input_tag(:radio, options) end ## # Constructs a file field input from the given options # # @macro text_field # # @example # file_field_tag :photo, :class => 'long' # # @api public def file_field_tag(name, options={}) name = "#{name}[]" if options[:multiple] options.reverse_merge!(:name => name) input_tag(:file, 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] :options # Explicit options to display in the select. Can be strings or string tuples. # @option options [Array] :grouped_options # List of options for each group in the select. See examples for details. # @option options [Array] :collection # Collection of objects used as options in the select. # @option options [Array] :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 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] safe_content_tag(:select, select_options_html, options) end ## # Constructs a button input from the given options # # @param [String] caption # The caption for the button. # @param [Hash] options # The html options for the input field. # # @return [String] The html button based on the +options+ specified. # # @example # button_tag "Cancel", :class => 'clear' # # @api public def button_tag(caption, options = {}) options.reverse_merge!(:value => caption) input_tag(:button, 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 def submit_tag(caption="Submit", options={}) options.reverse_merge!(:value => caption) input_tag(:submit, 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 def image_submit_tag(source, options={}) options.reverse_merge!(:src => image_path(source)) input_tag(:image, options) end # Constructs a hidden field containing a CSRF token. # # @param [String] token # The token to use. Will be read from the session by default. # # @return [String] The hidden field with CSRF token as value. # # @example # csrf_token_field # # @api public def csrf_token_field(token = nil) if defined? session token ||= (session[:csrf] ||= SecureRandom.hex(32)) end hidden_field_tag :authenticity_token, :value => token end ## # Creates a form containing a single button that submits to the url. # # @overload button_to(name, url, options={}) # @param [String] caption The text caption. # @param [String] url The url href. # @param [Hash] options The html options. # @overload button_to(name, options={}, &block) # @param [String] url The url href. # @param [Hash] options The html options. # @param [Proc] block The button content. # # @option options [Boolean] :multipart # If true, this form will support multipart encoding. # @option options [String] :remote # Instructs ujs handler to handle the submit as ajax. # @option options [Symbol] :method # Instructs ujs handler to use different http method (i.e :post, :delete). # # @return [String] Form and button html with specified +options+. # # @example # button_to 'Delete', url(:accounts_destroy, :id => account), :method => :delete, :class => :form # # Generates: # #
# # # # # #
# # @api public def button_to(*args, &block) name, url = args[0], args[1] options = args.extract_options! options['data-remote'] = 'true' if options.delete(:remote) if block_given? form_tag(url, options, &block) else form_tag(url, options) do submit_tag(name) end end end protected ## # 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 # def options_from_collection(collection, fields) collection.map { |item| [ item.send(fields.first), item.send(fields.last) ] } end # # Returns the options tags for a select based on the given option items # 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 the optgroups with options tags for a select based on the given :grouped_options items # 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 blank option serving as a prompt if passed # 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 private ## # Returns the FormBuilder class to use based on all available setting sources # If explicitly defined, returns that, otherwise returns defaults. # # @example # configured_form_builder_class(nil) => StandardFormBuilder # # @api private def configured_form_builder_class(explicit_builder=nil) default_builder = self.respond_to?(:settings) && self.settings.default_builder configured_builder = explicit_builder || default_builder || 'StandardFormBuilder' configured_builder = "Padrino::Helpers::FormBuilder::#{configured_builder}".constantize if configured_builder.is_a?(String) configured_builder end ## # Returns an initialized builder instance for the given object and settings # # @example # builder_instance(@account, :nested => { ... }) => # # @api private def builder_instance(object, settings={}) builder_class = configured_form_builder_class(settings.delete(:builder)) builder_class.new(self, object, settings) end ## # Returns whether the option should be selected or not # # @example # option_is_selected?("red", "Red", ["red", "blue"]) => true # option_is_selected?("red", "Red", ["green", "blue"]) => false # # @api private def option_is_selected?(value, caption, selected_values) Array(selected_values).any? do |selected| [value.to_s, caption.to_s].include?(selected.to_s) end end end # FormHelpers end # Helpers end # Padrino