Merge branch 'range-input'

README.textile

@@ -313,6 +313,7 @@ The Formtastic input types:
 * @:phone@ - a text field (just like string). Default for columns with name matching @"phone"@ or @"fax"@. New in HTML5.
 * @:search@ - a text field (just like string). Default for columns with name matching @"search"@. New in HTML5. Works on Safari.
 * @:hidden@ - a hidden field. Creates a hidden field (added for compatibility).
+* @:range@ - a slider field.
 
 The comments in the code are pretty good for each of these (what it does, what the output is, what the options are, etc.) so go check it out.
 

lib/formtastic/form_builder.rb

@@ -30,7 +30,7 @@ def self.configure(name, value = nil)
     configure :default_hint_class, 'inline-hints'
 
     attr_reader :template
-    
+
     attr_reader :auto_index
 
     include Formtastic::HtmlAttributes
@@ -74,4 +74,5 @@ def semantic_fields_for(record_or_name_or_array, *args, &block)
 
   end
 
-end
+end
+

lib/formtastic/helpers.rb

@@ -13,3 +13,4 @@ module Helpers
     autoload :Reflection, 'formtastic/helpers/reflection'
   end
 end
+

lib/formtastic/inputs.rb

@@ -17,6 +17,7 @@ module Inputs
     autoload :PasswordInput
     autoload :PhoneInput
     autoload :RadioInput
+    autoload :RangeInput
     autoload :SearchInput
     autoload :SelectInput
     autoload :StringInput
@@ -27,3 +28,4 @@ module Inputs
     autoload :UrlInput
   end
 end
+

lib/formtastic/inputs/base/validations.rb

@@ -3,6 +3,24 @@ module Inputs
     module Base
       module Validations
 
+        class IndeterminableMinimumAttributeError < ArgumentError
+          def message
+            [
+              "A minimum value can not be determined when the validation uses :greater_than on a :decimal or :float column type.",
+              "Please alter the validation to use :greater_than_or_equal_to, or provide a value for this attribute explicitly with the :min option on input()."
+            ].join("\n")
+          end
+        end
+
+        class IndeterminableMaximumAttributeError < ArgumentError
+          def message
+            [
+              "A maximum value can not be determined when the validation uses :less_than on a :decimal or :float column type.",
+              "Please alter the validation to use :less_than_or_equal_to, or provide a value for this attribute explicitly with the :max option on input()."
+            ].join("\n")
+          end
+        end
+
         def validations
           @validations ||= if object && object.class.respond_to?(:validators_on) 
             object.class.validators_on(attributized_method_name).select do |validator|
@@ -47,11 +65,13 @@ def validation_min
           validation = validations? && validations.find do |validation|
             validation.kind == :numericality
           end
-          if validation
+
+          if validation 
+            # We can't determine an appropriate value for :greater_than with a float/decimal column
+            raise IndeterminableMinimumAttributeError if validation.options[:greater_than] && column? && [:float, :decimal].include?(column.type)
+
             return validation.options[:greater_than_or_equal_to] if validation.options[:greater_than_or_equal_to]
-            return (validation.options[:greater_than] + 1) if validation.options[:greater_than]
-          else
-            nil
+            return (validation.options[:greater_than] + 1)       if validation.options[:greater_than]
           end
         end
 
@@ -61,8 +81,20 @@ def validation_max
             validation.kind == :numericality
           end
           if validation
+            # We can't determine an appropriate value for :greater_than with a float/decimal column
+            raise IndeterminableMaximumAttributeError if validation.options[:less_than] && column? && [:float, :decimal].include?(column.type)
+
             return validation.options[:less_than_or_equal_to] if validation.options[:less_than_or_equal_to]
-            return (validation.options[:less_than] - 1) if validation.options[:less_than]
+            return (validation.options[:less_than] - 1)       if validation.options[:less_than]
+          end
+        end
+
+        def validation_step
+          validation = validations? && validations.find do |validation|
+            validation.kind == :numericality
+          end
+          if validation
+            validation.options[:step]
           else
             nil
           end

lib/formtastic/inputs/number_input.rb

@@ -6,6 +6,20 @@ module Inputs
     # 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| %>
@@ -29,25 +43,30 @@ module Inputs
     #
     #   class Person < ActiveRecord::Base
     #     validates_numericality_of :age, 
-    #       :less_than => 100, 
-    #       :greater_than => 17, 
+    #       :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="99" step="1">
+    #     <input type="number" id="person_age" name="person[age]" min="18" max="100" step="1">
     #   </li>
     #
-    # @example Pass attributes down to the `<input>` tag
+    # @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
-    #
-    # @todo Rename/Alias to NumberInput
     class NumberInput 
       include Base
       include Base::Stringish
@@ -60,11 +79,38 @@ def to_html
       end
 
       def input_html_options
-        {
-          :min => validation_min,
-          :max => validation_max,
-          :step => validation_integer_only? ? 1 : nil 
-        }.merge(super)
+        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

lib/formtastic/inputs/numeric_input.rb

@@ -17,4 +17,5 @@ def initialize(builder, template, object, object_name, method, options)
 
     end
   end
-end
+end
+

lib/formtastic/inputs/range_input.rb

@@ -0,0 +1,117 @@
+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
+    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