formtastic 1.2.5 → 2.0.0.rc1

data/lib/formtastic/inputs/range_input.rb

@@ -0,0 +1,119 @@
+module Formtastic
+  module Inputs
+    
+    # Outputs a simple `<label>` with a HTML5 `<input type="range">` wrapped in the standard
+    # `<li>` wrapper. This is an alternative input choice to a number input.
+    #
+    # Sensible default for the `min`, `max` and `step` attributes are found by reflecting on 
+    # the model's validations. When validations are not provided, the `min` and `step` default to
+    # `1` and the `max` default to `100`. 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 => :range %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="numeric">
+    #           <label for="user_shoe_size">Shoe size</label>
+    #           <input type="range" id="user_shoe_size" name="user[shoe_size]" min="1" max="100" step="1">
+    #         </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="range" 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 => :range, :input_html => { :min => 3, :max => 15, :step => 1, :class => "special" } %>
+    #
+    # @example Min/max/step also work as options
+    #  <%= f.input :shoe_size, :as => :range, :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 => :range, :in => 3..15, :step => 1 %>
+    #  <%= f.input :shoe_size, :as => :range, :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
+    #
+    # @todo Is it still correct for this to be Stringish?
+    class RangeInput
+      include Base
+      include Base::Stringish
+
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.range_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 || 1
+      end
+      
+      def max_option
+        return options[:max] if options.key?(:max)
+        validation_max || 100
+      end
+      
+      def in_option
+        options[:in]
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/search_input.rb

@@ -0,0 +1,40 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a HTML5 `<input type="search">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for attributes with a name matching
+    # `/^search$/`, but can be applied to any text-like input with `:as => :search`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@search, :html => { :method => :get }) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :q, :as => :search, :label => false, :input_html => { :name => "q" } %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="search">
+    #           <input type="search" id="search_q" name="q">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class SearchInput 
+      include Base
+      include Base::Stringish
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.search_field(method, input_html_options)
+        end
+      end
+    end
+
+  end
+end

data/lib/formtastic/inputs/select_input.rb

@@ -0,0 +1,210 @@
+module Formtastic
+  module Inputs
+    # A select input is used to render a `<select>` tag with a series of options to choose from.
+    # It works for both single selections (like a `belongs_to` relationship, or "yes/no" boolean),
+    # as well as multiple selections (like a `has_and_belongs_to_many`/`has_many` relationship,
+    # for assigning many genres to a song, for example).
+    #
+    # This is the default input choice when:
+    #
+    # * the database column type is an `:integer` and there is an association (`belongs_to`)
+    # * the database column type is a `:string` and the `:collection` option is used
+    # * there an object with an association, but no database column on the object (`has_many`, etc)
+    # * there is no object and the `:collection` option is used
+    #
+    # The flexibility of the `:collection` option (see examples) makes the :select 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 pre-selected dates)
+    # * a `:number` input (where the user could choose from a set of pre-defined numbers)
+    # * a `:time_zone` input (where you want to provide your own set of choices instead of relying on Rails)
+    # * a `:country` input (no need for a plugin really)
+    #
+    # Within the standard `<li>` wrapper, the output is a `<label>` tag followed by a `<select>`
+    # tag containing `<option>` tags.
+    #
+    # For 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
+    # `Tag.all` for a `Post` form with an input for a `has_and_belongs_to_many :tags` association.
+    # You can override or customise this collection and the `<option>` tags it will render through
+    # the `:collection` option (see examples).
+    #
+    # The way on which Formtastic renders the `value` attribute and content of each `<option>` tag
+    # is customisable through the `:member_label` and `:member_value` options. 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` (see examples below).
+    #
+    # @example Basic `belongs_to` example with full form context
+    #
+    #     <%= semantic_form_for @post do |f| %>
+    #       <%= f.inputs do %>
+    #         <%= f.input :author, :as => :select %>
+    #       <% end %>
+    #     <% end %>
+    #
+    #     <form...>
+    #       <fieldset>
+    #         <ol>
+    #           <li class='select'>
+    #             <label for="post_author_id">Author</label>
+    #             <select id="post_author_id" name="post[post_author_id]">
+    #               <option value=""></option>
+    #               <option value="1">Justin</option>
+    #               <option value="3">Kate</option>
+    #               <option value="2">Amelia</option>
+    #             </select>
+    #           </li>
+    #         </ol>
+    #       </fieldset>
+    #     </form>
+    #
+    # @example Basic `has_many` or `has_and_belongs_to_many` example with full form context
+    #
+    #     <%= semantic_form_for @post do |f| %>
+    #       <%= f.inputs do %>
+    #         <%= f.input :tags, :as => :select %>
+    #       <% end %>
+    #     <% end %>
+    #
+    #     <form...>
+    #       <fieldset>
+    #         <ol>
+    #           <li class='select'>
+    #             <label for="post_tag_ids">Author</label>
+    #             <select id="post_tag_ids" name="post[tag_ids]" multiple="true">
+    #               <option value="1">Ruby</option>
+    #               <option value="6">Rails</option>
+    #               <option value="3">Forms</option>
+    #               <option value="4">Awesome</option>
+    #             </select>
+    #           </li>
+    #         </ol>
+    #       </fieldset>
+    #     </form>
+    #
+    # @example Override Formtastic's assumption on when you need a multi select
+    #   <%= f.input :authors, :as => :select, :input_html => { :multiple => true } %>
+    #   <%= f.input :authors, :as => :select, :input_html => { :multiple => false } %>
+    #
+    # @example The `:collection` option can be used to customize the choices
+    #   <%= f.input :author, :as => :select, :collection => @authors %>
+    #   <%= f.input :author, :as => :select, :collection => Author.all %>
+    #   <%= f.input :author, :as => :select, :collection => Author.some_named_scope %>
+    #   <%= f.input :author, :as => :select, :collection => [Author.find_by_login("justin"), Category.find_by_name("kate")] %>
+    #   <%= f.input :author, :as => :select, :collection => ["Justin", "Kate"] %>
+    #   <%= f.input :author, :as => :select, :collection => [["Justin", "justin"], ["Kate", "kate"]] %>
+    #   <%= f.input :author, :as => :select, :collection => [["Justin", "1"], ["Kate", "3"]] %>
+    #   <%= f.input :author, :as => :select, :collection => [["Justin", 1], ["Kate", 3]] %>
+    #   <%= f.input :author, :as => :select, :collection => 1..5 %>
+    #   <%= f.input :author, :as => :select, :collection => "<option>your own options HTML string</option>" %>
+    #   <%= f.input :author, :as => :select, :collection => options_for_select(...) %>
+    #   <%= f.input :author, :as => :select, :collection => options_from_collection_for_select(...) %>
+    #   <%= f.input :author, :as => :select, :collection => grouped_options_for_select(...) %>
+    #   <%= f.input :author, :as => :select, :collection => time_zone_options_for_select(...) %>
+    #
+    # @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 => :select, :member_label => :name %>
+    #   <%= f.input :author, :as => :select, :member_label => :name_with_post_count
+    #   <%= f.input :author, :as => :select, :member_label => Proc.new { |a| "#{c.name} (#{pluralize("post", a.posts.count)})" }
+    #
+    # @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 => :select, :member_value => :login %>
+    #   <%= f.input :author, :as => :select, :member_value => Proc.new { |c| c.full_name.downcase.underscore }
+    #
+    # @example Set HTML attributes on the `<select>` tag with `:input_html`
+    #   <%= f.input :authors, :as => :select, :input_html => { :size => 20, :multiple => true, :class => "special" } %>
+    #
+    # @example Set HTML attributes on the `<li>` wrapper with `:wrapper_html`
+    #   <%= f.input :authors, :as => :select, :wrapper_html => { :class => "special" } %>
+    #
+    # @example Exclude or include the blank option at the top of the select, or change the prompt
+    #   <%= f.input :author, :as => :select, :input_html => { :include_blank => false } %>
+    #   <%= f.input :author, :as => :select, :input_html => { :include_blank => true } %>
+    #   <%= f.input :author, :as => :select, :input_html => { :prompt => "Please select an Author..." } %>
+    #
+    # @example Group options an `<optgroup>` with the `:group_by` and `:group_label` options (`belongs_to` associations only)
+    #   <%= f.input :author, :as => :select, :group_by => :continent %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    # @see Formtastic::Inputs::CheckBoxesInput CheckBoxesInput as an alternative for `has_many` and `has_and_belongs_to_many` associations
+    # @see Formtastic::Inputs::RadioInput RadioInput as an alternative for `belongs_to` associations
+    #
+    # @todo Do/can we support the per-item HTML options like RadioInput?
+    class SelectInput
+      include Base
+      include Base::Collections
+      include Base::GroupedCollections
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          (options[:group_by] ? grouped_select_html : select_html)
+        end
+      end
+      
+      def select_html
+        builder.select(input_name, collection, input_options, input_html_options)
+      end
+      
+      def grouped_select_html
+        builder.grouped_collection_select(
+          input_name, 
+          grouped_collection,
+          group_association, 
+          group_label_method,
+          value_method, 
+          label_method,
+          input_options, 
+          input_html_options
+        )
+      end
+      
+      def include_blank?
+        return options[:prompt] if options.key?(:prompt)
+        return options[:include_blank] if options.key?(:include_blank)
+        return true if (single? && builder.include_blank_for_select_by_default)
+        false
+      end
+
+      def label_html_options
+        super.merge(:for => input_html_options[:id])
+      end
+      
+      def input_options
+        {:include_blank => include_blank?}.merge(super)
+      end
+      
+      def input_html_options
+        extra_input_html_options.merge(super)
+      end
+      
+      def extra_input_html_options
+        {
+          :multiple => multiple_by_association?,
+          :name => "#{object_name}[#{association_primary_key}]#{'[]' if multiple?}"
+        }
+      end
+      
+      def multiple_by_association?
+        reflection && [ :has_many, :has_and_belongs_to_many ].include?(reflection.macro)
+      end
+      
+      def multiple_by_options?
+        options[:multiple]
+      end
+      
+      def multiple?
+        multiple_by_options? || multiple_by_association? 
+      end
+      
+      def single?
+        !multiple?
+      end
+
+    end
+  end
+end

data/lib/formtastic/inputs/string_input.rb

@@ -0,0 +1,34 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a `<input type="text">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for database columns of the `:string` type,
+    # and is the default choice for all inputs when no other logical input type can be inferred.
+    # You can force any input to be a string input with `:as => :string`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :first_name, :as => :string %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="string">
+    #           <label for="user_first_name">First name</label>
+    #           <input type="text" id="user_first_name" name="user[first_name]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class StringInput 
+      include Base
+      include Base::Stringish
+    end
+  end
+end

data/lib/formtastic/inputs/text_input.rb

@@ -0,0 +1,47 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a `<textarea>` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for database columns of the `:text` type,
+    # but can forced on any text-like input with `:as => :text`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :first_name, :as => :string %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="string">
+    #           <label for="user_first_name">First name</label>
+    #           <input type="text" id="user_first_name" name="user[first_name]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documetation of all possible options.
+    class TextInput 
+      include Base
+      
+      def input_html_options
+        { 
+          :cols => builder.default_text_area_width,
+          :rows => builder.default_text_area_height
+        }.merge(super)
+      end
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.text_area(method, input_html_options)
+        end
+      end
+    
+    end
+  end
+end