formtastic 1.2.5 → 2.0.0.rc1

data/lib/formtastic/inputs/file_input.rb

@@ -0,0 +1,42 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a `<input type="file">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for objects with attributes that appear
+    # to be for file uploads, by detecting some common method names used by popular file upload
+    # libraries such as Paperclip and CarrierWave. You can add to or alter these method names
+    # through the `file_methods` config, but can be applied to any input with `:as => :file`.
+    #
+    # Don't forget to set the multipart attribute in your `<form>` tag!
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user, :html => { :multipart => true }) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :email_address, :as => :email %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="email">
+    #           <label for="user_email_address">Email address</label>
+    #           <input type="email" id="user_email_address" name="user[email_address]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class FileInput 
+      include Base
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.file_field(method, input_html_options)
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/hidden_input.rb

@@ -0,0 +1,66 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<input type="hidden">` wrapped in the standard `<li>` wrapper. This is
+    # provided for situations where a hidden field needs to be rendered in the flow of a form with
+    # many inputs that form an `<ol>`. Wrapping the hidden input inside the `<li>` maintains the
+    # HTML validity. The `<li>` is marked with a `class` of `hidden` so that stylesheet authors can
+    # hide these list items with CSS (formtastic.css does this out of the box).
+    #
+    # @example Full form context, output and CSS
+    #
+    #   <%= semantic_form_for(@something) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :secret, :as => :hidden %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="hidden">
+    #           <input type="hidden" id="something_secret" name="something[secret]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    #   form.formtastic li.hidden { display:none; }
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class HiddenInput 
+      include Base
+      
+      # Override to include :value set directly from options hash. The :value set in :input_html 
+      # hash will be preferred over :value set directly in the options.
+      #
+      # @todo this is inconsistent with all other inputs, deprecate and remove
+      def input_html_options
+        options.slice(:value).merge(super).merge(:required => nil).merge(:autofocus => nil)
+      end
+      
+      def to_html
+        input_wrapping do
+          builder.hidden_field(method, input_html_options)
+        end
+      end
+      
+      def error_html
+        ""
+      end
+      
+      def errors?
+        false
+      end
+      
+      def hint_html
+        ""
+      end
+      
+      def hint?
+        false
+      end
+
+    end
+  end
+end

data/lib/formtastic/inputs/number_input.rb

@@ -0,0 +1,118 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a HTML5 `<input type="number">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for all database columns of the type `:float`
+    # and `:decimal`, as well as `:integer` columns that aren't used for `belongs_to` associations,
+    # but can be applied to any text-like input with `:as => :number`.
+    #
+    # Sensible default values for the `min`, `max` and `step` attributes are found by reflecting on 
+    # the model's validations (when provided). An `IndeterminableMinimumAttributeError` exception 
+    # will be raised when the following conditions are all true:
+    #
+    # * you haven't specified a `:min` or `:max` for the input
+    # * the model's database column type is a `:float` or `:decimal`
+    # * the validation uses `:less_than` or `:greater_than`
+    #
+    # The solution is to either:
+    # 
+    # * manually specify the `:min` or `:max` for the input
+    # * change the database column type to an `:integer` (if appropriate)
+    # * change the validations to use `:less_than_or_equal_to` or `:greater_than_or_equal_to`
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :shoe_size, :as => :number %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="numeric">
+    #           <label for="user_shoe_size">Shoe size</label>
+    #           <input type="number" id="user_shoe_size" name="user[shoe_size]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @example Default HTML5 min/max/step attributes are detected from the numericality validations
+    #
+    #   class Person < ActiveRecord::Base
+    #     validates_numericality_of :age, 
+    #       :less_than_or_equal_to => 100, 
+    #       :greater_than_or_equal_to => 18, 
+    #       :only_integer => true
+    #   end
+    #
+    #   <%= f.input :age, :as => :number %>
+    #
+    #   <li class="numeric">
+    #     <label for="persom_age">Age</label>
+    #     <input type="number" id="person_age" name="person[age]" min="18" max="100" step="1">
+    #   </li>
+    #
+    # @example Pass attributes down to the `<input>` tag with :input_html
+    #  <%= f.input :shoe_size, :as => :number, :input_html => { :min => 3, :max => 15, :step => 1, :class => "special" } %>
+    #
+    # @example Min/max/step also work as options
+    #  <%= f.input :shoe_size, :as => :number, :min => 3, :max => 15, :step => 1, :input_html => { :class => "special" } %>
+    #
+    # @example Use :in with a Range as a shortcut for :min/:max
+    #  <%= f.input :shoe_size, :as => :number, :in => 3..15, :step => 1 %>
+    #  <%= f.input :shoe_size, :as => :number, :input_html => { :in => 3..15, :step => 1 } %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    # @see http://api.rubyonrails.org/classes/ActiveModel/Validations/HelperMethods.html#method-i-validates_numericality_of Rails' Numericality validation documentation
+    class NumberInput 
+      include Base
+      include Base::Stringish
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.number_field(method, input_html_options)
+        end
+      end
+      
+      def input_html_options
+        defaults = super
+        
+        if in_option
+          defaults[:min] = in_option.to_a.min
+          defaults[:max] = in_option.to_a.max
+        else
+          defaults[:min]  ||= min_option
+          defaults[:max]  ||= max_option
+        end
+        defaults[:step] ||= step_option
+        defaults
+      end
+      
+      def step_option
+        return options[:step] if options.key?(:step)
+        return validation_step if validation_step
+        return 1 if validation_integer_only?
+        1
+      end
+      
+      def min_option
+        return options[:min] if options.key?(:min)
+        validation_min
+      end
+      
+      def max_option
+        return options[:max] if options.key?(:max)
+        validation_max
+      end
+      
+      def in_option
+        options[:in]
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/numeric_input.rb

@@ -0,0 +1,21 @@
+module Formtastic
+  module Inputs
+    # Alias for NumberInput for backwards compatibility with 1.x.
+    # 
+    # @example:
+    #   f.input :age, :as => :numeric
+    #
+    # @deprecated Use :as => :number instead
+    #
+    # @todo Remove on or after 2.1
+    class NumericInput < NumberInput
+      
+      def initialize(builder, template, object, object_name, method, options)
+        ActiveSupport::Deprecation.warn(':as => :numeric has been deprecated in favor of :as => :number and will be removed on or after version 2.1', caller)
+        super
+      end
+      
+    end
+  end
+end
+

data/lib/formtastic/inputs/password_input.rb

@@ -0,0 +1,40 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a `<input type="password">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for all attributes matching `/password/`, but
+    # can be applied to any text-like input with `:as => :password`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :password, :as => :password %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="password">
+    #           <label for="user_password">Password</label>
+    #           <input type="password" id="user_password" name="user[password]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class PasswordInput 
+      include Base
+      include Base::Stringish
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.password_field(method, input_html_options)
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/phone_input.rb

@@ -0,0 +1,41 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a HTML5 `<input type="phone">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for attributes with a name matching
+    # `/(phone|fax)/`, but can be applied to any text-like input with `:as => :phone`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :mobile, :as => :phone %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="phone">
+    #           <label for="user_mobile">Mobile</label>
+    #           <input type="phone" id="user_mobile" name="user[mobile]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class PhoneInput 
+      include Base
+      include Base::Stringish
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.phone_field(method, input_html_options)
+        end
+      end
+    end
+    
+  end
+end

data/lib/formtastic/inputs/radio_input.rb

@@ -0,0 +1,157 @@
+module Formtastic
+  module Inputs
+
+    # A radio input is used to render a series of radio inputs. This is an alternative input choice
+    # for `belongs_to` associations like a `Post` belonging to a `Section` or an `Author`, or any
+    # case where the user needs to make a single selection from a pre-defined collectioon of choices.
+    #
+    # Within the standard `<li>` wrapper, the output is a `<fieldset>` with a `<legend>` to
+    # represent the "label" for the input, and an `<ol>` containing `<li>`s for each choice in
+    # the association. Each `<li>` choice has a `<label>` containing an `<input type="radio">` and
+    # the label text to describe each choice.
+    #
+    # Radio inputs can be considered as an alternative where a (non-multi) select input is used,
+    # especially in cases where there are only a few choices, however they are not used by default
+    # for any type of association or model attribute. You can choose to use a radio input instead of
+    # a select with `:as => :radio`.
+    #
+    # Like a select input, the flexibility of the `:collection` option (see examples) makes the
+    # :radio input viable as an alternative for many other input types. For example, instead of...
+    #
+    # * a `:string` input (where you want to force the user to choose from a few specific strings rather than entering anything)
+    # * a `:boolean` checkbox input (where the user could choose yes or no, rather than checking a box)
+    # * a `:date`, `:time` or `:datetime` input (where the user could choose from a small set of pre-determined dates)
+    # * a `:number` input (where the user could choose from a small set of pre-defined numbers)
+    # * a `:time_zone` input (where you want to provide your own small set of choices instead of relying on Rails)
+    # * a `:country` input (where you want to provide a small set of choices, no need for a plugin really)
+    #
+    # For radio inputs that map to associations on the object model, Formtastic will automatically
+    # load in a collection of objects on the association as options to choose from. This might be an
+    # `Author.all` on a `Post` form with an input for a `belongs_to :user` association, or a
+    # `Section.all` for a `Post` form with an input for a `belongs_to :section` association.
+    # You can override or customise this collection through the `:collection` option (see examples).
+    #
+    # The way on which Formtastic renders the `value` attribute and label for each choice is
+    # customisable through the `:member_label` and `:member_value` options (see examples below).
+    # When not provided, we fall back to a list of methods to try on each object such as
+    # `:to_label`, `:name` and `:to_s`, which are defined in the configurations
+    # `collection_label_methods` and `collection_value_methods`.
+    #
+    # @example Basic `belongs_to` example with full form context
+    #
+    #     <%= semantic_form_for @post do |f| %>
+    #       <%= f.inputs do %>
+    #         <%= f.input :author, :as => :radio %>
+    #       <% end %>
+    #     <% end %>
+    #
+    #     <form...>
+    #       <fieldset>
+    #         <ol>
+    #           <li class='radio'>
+    #             <fieldset>
+    #               <legend class="label"><label>Categories</label></legend>
+    #               <ol>
+    #                 <li>
+    #                   <label for="post_author_id_1">
+    #                     <input type="radio" id="post_author_id_1" value="1"> Justin
+    #                   </label>
+    #                 </li>
+    #                 <li>
+    #                   <label for="post_author_id_3">
+    #                     <input type="radio" id="post_author_id_3" value="3"> Kate
+    #                   </label>
+    #                 </li>
+    #                 <li>
+    #                   <label for="post_author_id_2">
+    #                     <input type="radio" id="post_author_id_2" value="2"> Amelia
+    #                   </label>
+    #                 </li>
+    #               </ol>
+    #             </fieldset>
+    #           </li>
+    #         </ol>
+    #       </fieldset>
+    #     </form>
+    #
+    # @example The `:collection` option can be used to customize the choices
+    #   <%= f.input :author, :as => :radio, :collection => @authors %>
+    #   <%= f.input :author, :as => :radio, :collection => Author.all %>
+    #   <%= f.input :author, :as => :radio, :collection => Author.some_named_scope %>
+    #   <%= f.input :author, :as => :radio, :collection => [Author.find_by_login("justin"), Category.find_by_name("kate")] %>
+    #   <%= f.input :author, :as => :radio, :collection => ["Justin", "Kate"] %>
+    #   <%= f.input :author, :as => :radio, :collection => [["Justin", "justin"], ["Kate", "kate"]] %>
+    #   <%= f.input :author, :as => :radio, :collection => [["Justin", "1"], ["Kate", "3"]] %>
+    #   <%= f.input :author, :as => :radio, :collection => [["Justin", 1], ["Kate", 3]] %>
+    #   <%= f.input :author, :as => :radio, :collection => 1..5 %>
+    #
+    # @example The `:member_label` can be used to call a different method (or a Proc) on each object in the collection for rendering the label text (it'll try the methods like `to_s` in `collection_label_methods` config by default)
+    #   <%= f.input :author, :as => :radio, :member_label => :name %>
+    #   <%= f.input :author, :as => :radio, :member_label => :name_with_post_count
+    #   <%= f.input :author, :as => :radio, :member_label => Proc.new { |a| "#{c.name} (#{pluralize("post", a.posts.count)})" }
+    #
+    # @example `:member_label` can be used with a helper method (both examples have the same result)
+    #   <%= f.input :author, :as => :radio, :member_label => method(:fancy_label)
+    #   <%= f.input :author, :as => :radio, :member_label => Proc.new { |author| fancy_label(author) }
+    #
+    # @example The `:member_value` can be used to call a different method (or a Proc) on each object in the collection for rendering the value for each checkbox (it'll try the methods like `id` in `collection_value_methods` config by default)
+    #   <%= f.input :author, :as => :radio, :member_value => :login %>
+    #   <%= f.input :author, :as => :radio, :member_value => Proc.new { |c| c.full_name.downcase.underscore }
+    #
+    # @example `:member_value` can be used with a helper method (both examples have the same result)
+    #   <%= f.input :author, :as => :radio, :member_value => method(:some_helper)
+    #   <%= f.input :author, :as => :radio, :member_value => Proc.new { |author| some_helper(author) }
+    #
+    # @example Set HTML attributes on each `<input type="radio">` tag with `:input_html`
+    #   <%= f.input :author, :as => :radio, :input_html => { :size => 20, :multiple => true, :class => "special" } %>
+    #
+    # @example Set HTML attributes on the `<li>` wrapper with `:wrapper_html`
+    #   <%= f.input :author, :as => :radio, :wrapper_html => { :class => "special" } %>
+    #
+    # @example `:value_as_class` can be used to add a class to the `<li>` wrapped around each choice using the radio value for custom styling of each choice
+    #   <%= f.input :author, :as => :radio, :value_as_class => true %>
+    #
+    # @example Set HTML options on a specific radio input option with a 3rd element in the array for a collection member
+    #   <%= f.input :author, :as => :radio, :collection => [["Test", 'test'], ["Try", "try", {:disabled => true}]]
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    # @see Formtastic::Inputs::RadioInput as an alternative for `belongs_to` associations
+    #
+    # @todo :disabled like CheckBoxes?
+    class RadioInput
+      include Base
+      include Base::Collections
+      include Base::Choices
+      
+      def to_html
+        input_wrapping do
+          choices_wrapping do
+            legend_html <<
+            choices_group_wrapping do
+              collection.map { |choice| 
+                choice_wrapping(choice_wrapping_html_options(choice)) do
+                  choice_html(choice)
+                end
+              }.join("\n").html_safe
+            end
+          end
+        end
+      end
+
+      def choice_html(choice)        
+        template.content_tag(:label,
+          builder.radio_button(input_name, choice_value(choice), input_html_options.merge(choice_html_options(choice))) << 
+          choice_label(choice),
+          label_html_options.merge(:for => choice_input_dom_id(choice))
+        )
+      end
+      
+      # Override to remove the for attribute since this isn't associated with any element, as it's
+      # nested inside the legend.
+      def label_html_options
+        super.merge(:for => nil)
+      end
+
+    end
+  end
+end