formtastic 1.2.4 → 3.1.5

data/lib/formtastic/inputs/datalist_input.rb

@@ -0,0 +1,41 @@
+module Formtastic
+  module Inputs
+    # Outputs a label and a text field, along with a datalist tag
+    # datalist tag provides a list of options which drives a simple autocomplete
+    # on the text field. This is a HTML5 feature, more info can be found at
+    # {https://developer.mozilla.org/en/docs/Web/HTML/Element/datalist <datalist> at MDN}
+    # This input accepts a :collection option which takes data in all the usual formats accepted by
+    # {http://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/options_for_select options_for_select}
+    #
+    # @example Input is used as follows
+    #   f.input :fav_book, :as => :datalist, :collection => Book.pluck(:name)
+    #
+    class DatalistInput
+      include Base
+      include Base::Stringish
+      include Base::Collections
+
+      def to_html
+        @name = input_html_options[:id].gsub(/_id$/, "")
+        input_wrapping do
+          label_html <<
+          builder.text_field(method, input_html_options) << # standard input
+          data_list_html # append new datalist element
+        end
+      end
+
+      def input_html_options
+        super.merge(:list => html_id_of_datalist)
+      end
+
+      def html_id_of_datalist
+        "#{@name}_datalist"
+      end
+
+      def data_list_html
+        html = builder.template.options_for_select(collection)
+        builder.template.content_tag(:datalist,html, { :id => html_id_of_datalist }, false)
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/date_picker_input.rb

@@ -0,0 +1,93 @@
+module Formtastic
+  module Inputs
+    
+    # Outputs a simple `<label>` with a HTML5 `<input type="date">` wrapped in the standard
+    # `<li>` wrapper. This is an alternative to `:date_select` for `:date`, `:time`, `:datetime` 
+    # database columns. You can use this input with `:as => :date_picker`.
+    #
+    # *Please note:* Formtastic only provides suitable markup for a date picker, but does not supply
+    # any additional CSS or Javascript to render calendar-style date pickers. Browsers that support
+    # this input type (such as Mobile Webkit and Opera on the desktop) will render a native widget.
+    # Browsers that don't will default to a plain text field`<input type="text">` and can be 
+    # poly-filled with some Javascript and a UI library of your choice.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@post) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :publish_at, :as => :date_picker %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="string">
+    #           <label for="post_publish_at">First name</label>
+    #           <input type="date" id="post_publish_at" name="post[publish_at]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @example Setting the size (defaults to 10 for YYYY-MM-DD)
+    #   <%= f.input :publish_at, :as => :date_picker, :size => 20 %>
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :size => 20 } %>
+    #
+    # @example Setting the maxlength (defaults to 10 for YYYY-MM-DD)
+    #   <%= f.input :publish_at, :as => :date_picker, :maxlength => 20 %>
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :maxlength => 20 } %>
+    #
+    # @example Setting the value (defaults to YYYY-MM-DD for Date and Time objects, otherwise renders string)
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :value => "1970-01-01" } %>
+    #
+    # @example Setting the step attribute (defaults to 1)
+    #   <%= f.input :publish_at, :as => :date_picker, :step => 7 %>
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :step => 7 } %>
+    #
+    # @example Setting the step attribute with a macro
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :day %>
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :week %>
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :seven_days %>
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :fortnight %>
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :two_weeks %>
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :four_weeks %>
+    #   <%= f.input :publish_at, :as => :date_picker, :step => :thirty_days %>
+    #
+    # @example Setting the min attribute
+    #   <%= f.input :publish_at, :as => :date_picker, :min => "2012-01-01" %>
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :min => "2012-01-01" } %>
+    #
+    # @example Setting the max attribute
+    #   <%= f.input :publish_at, :as => :date_picker, :max => "2012-12-31" %>
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :max => "2012-12-31" } %>
+    #
+    # @example Setting the placeholder attribute
+    #   <%= f.input :publish_at, :as => :date_picker, :placeholder => 20 %>
+    #   <%= f.input :publish_at, :as => :date_picker, :input_html => { :placeholder => "YYYY-MM-DD" } %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class DatePickerInput
+      include Base
+      include Base::Stringish
+      include Base::DatetimePickerish
+      
+      def html_input_type
+        "date"
+      end
+      
+      def default_size
+        10
+      end
+      
+      def value
+        return options[:input_html][:value] if options[:input_html] && options[:input_html].key?(:value)
+        val = object.send(method)
+        return Date.new(val.year, val.month, val.day).to_s if val.is_a?(Time)
+        return val if val.nil?
+        val.to_s
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/date_select_input.rb

@@ -0,0 +1,34 @@
+module Formtastic
+  module Inputs
+    # Outputs a series of select boxes for the fragments that make up a date (year, month, day).
+    #
+    # @see Formtastic::Inputs::Base::Timeish Timeish module for documentation of date, time and datetime input options.
+    class DateSelectInput 
+      include Base
+      include Base::Timeish
+      
+      # We don't want hour and minute fragments on a date input
+      def time_fragments
+        []
+      end
+      
+      def hidden_date_fragments
+        default_date_fragments - date_fragments
+      end
+
+      def hidden_fragments
+        hidden_date_fragments.map do |fragment|
+          template.hidden_field_tag(hidden_field_name(fragment), fragment_value(fragment), :id => fragment_id(fragment), :disabled => input_html_options[:disabled] )
+        end.join.html_safe
+      end
+
+      def fragment_value(fragment)
+        if fragment == :year
+          Time.now.year
+        else
+          '1'
+        end
+      end      
+    end
+  end
+end

data/lib/formtastic/inputs/datetime_picker_input.rb

@@ -0,0 +1,103 @@
+module Formtastic
+  module Inputs
+    
+    # Outputs a simple `<label>` with a HTML5 `<input type="datetime-local">` (or 
+    # `<input type="datetime">`) wrapped in the standard `<li>` wrapper. This is an alternative to 
+    # `:date_select` for `:date`, `:time`, `:datetime` database columns. You can use this input with
+    # `:as => :datetime_picker`.
+    #
+    # *Please note:* Formtastic only provides suitable markup for a date picker, but does not supply
+    # any additional CSS or Javascript to render calendar-style date pickers. Browsers that support
+    # this input type (such as Mobile Webkit and Opera on the desktop) will render a native widget.
+    # Browsers that don't will default to a plain text field`<input type="text">` and can be 
+    # poly-filled with some Javascript and a UI library of your choice.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@post) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :publish_at, :as => :datetime_picker %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="string">
+    #           <label for="post_publish_at">First name</label>
+    #           <input type="date" id="post_publish_at" name="post[publish_at]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @example Setting the size (defaults to 16 for YYYY-MM-DD HH:MM)
+    #   <%= f.input :publish_at, :as => :datetime_picker, :size => 20 %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :size => 20 } %>
+    #
+    # @example Setting the maxlength (defaults to 16 for YYYY-MM-DD HH:MM)
+    #   <%= f.input :publish_at, :as => :datetime_picker, :maxlength => 20 %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :maxlength => 20 } %>
+    #
+    # @example Setting the value (defaults to YYYY-MM-DD HH:MM for Date and Time objects, otherwise renders string)
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :value => "1970-01-01 00:00" } %>
+    #
+    # @example Setting the step attribute (defaults to 1)
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => 60 %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :step => 60 } %>
+    #
+    # @example Setting the step attribute with a macro
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :second %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :minute %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :quarter_hour %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :fifteen_minutes %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :half_hour %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :thirty_minutes %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :hour %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :step => :sixty_minutes %>
+    #
+    # @example Setting the min attribute
+    #   <%= f.input :publish_at, :as => :datetime_picker, :min => "2012-01-01 09:00" %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :min => "2012-01-01 09:00" } %>
+    #
+    # @example Setting the max attribute
+    #   <%= f.input :publish_at, :as => :datetime_picker, :max => "2012-12-31 16:00" %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :max => "2012-12-31 16:00" } %>
+    #
+    # @example Setting the placeholder attribute
+    #   <%= f.input :publish_at, :as => :datetime_picker, :placeholder => "YYYY-MM-DD HH:MM" %>
+    #   <%= f.input :publish_at, :as => :datetime_picker, :input_html => { :placeholder => "YYYY-MM-DD HH:MM" } %>
+    #
+    # @example Using `type=datetime-local` with `:local` option (this is the default, and recommended for browser support on iOS7 and Chrome)
+    #   <%= f.input :publish_at, :as => :datetime_picker, :local => true %>
+    #
+    # @example Using `type=datetime` with `:local` option (not recommended)
+    #   <%= f.input :publish_at, :as => :datetime_picker, :local => false %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class DatetimePickerInput
+      include Base
+      include Base::Stringish
+      include Base::DatetimePickerish
+      
+      def html_input_type
+        options[:local] = true unless options.key?(:local)
+        options[:local] ? "datetime-local" : "datetime"
+      end
+      
+      def default_size
+        16
+      end
+      
+      def value
+        return options[:input_html][:value] if options[:input_html] && options[:input_html].key?(:value)
+        val = object.send(method)
+        return val.strftime("%Y-%m-%dT%H:%M:%S") if val.is_a?(Time)
+        return "#{val.year}-#{val.month}-#{val.day}T00:00:00" if val.is_a?(Date)
+        return val if val.nil?
+        val.to_s
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/datetime_select_input.rb

@@ -0,0 +1,12 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a series of select boxes for the fragments that make up a date and time (year, month, day, hour, minute, second).
+    #
+    # @see Formtastic::Inputs::Base::Timeish Timeish module for documentation of date, time and datetime input options.
+    class DatetimeSelectInput 
+      include Base
+      include Base::Timeish
+    end
+  end
+end

data/lib/formtastic/inputs/email_input.rb

@@ -0,0 +1,41 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a HTML5 `<input type="email">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for attributes with a name matching
+    # `/email/`, but can be applied to any text-like input with `:as => :email`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) 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 documentation of all possible options.
+    class EmailInput 
+      include Base
+      include Base::Stringish
+      include Base::Placeholder
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.email_field(method, input_html_options)
+        end
+      end
+    end
+  end
+end

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 :avatar, :as => :file %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="file">
+    #           <label for="user_avatar">Avatar</label>
+    #           <input type="file" id="user_avatar" name="user[avatar]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation 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,62 @@
+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 documentation of all possible options.
+    class HiddenInput 
+      include Base
+      
+      def input_html_options
+        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,88 @@
+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 documentation 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::Numeric
+      include Base::Placeholder
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.number_field(method, input_html_options)
+        end
+      end
+
+      def step_option
+        super || "any"
+      end
+
+    end
+  end
+end