formtastic 2.1.1 → 2.2.0.rc

data/.gitignore

@@ -8,6 +8,7 @@ pkg
 *watchr.rb
 log/*
 .rvmrc
+.ruby-version
 .bundle
 Gemfile.lock
 .yardoc

data/.travis.yml

@@ -4,5 +4,23 @@ rvm:
   - ree
   - 1.9.2
   - 1.9.3
+gemfile:
+  - gemfiles/rails-3.0.gemfile
+  - gemfiles/rails-3.1.gemfile
+  - gemfiles/rails-3.2.gemfile
+  - gemfiles/rails-4.gemfile
 env:
-  - DEFER_GC=false
+  - DEFER_GC=false RAILS_EDGE=true
+script: "rake spec"
+matrix:
+  exclude:
+    - rvm: 1.8.7
+      gemfile: gemfiles/rails-4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: ree
+      gemfile: gemfiles/rails-4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails-4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+      

data/Appraisals

@@ -9,3 +9,10 @@ end
 appraise 'rails-3.2' do
   gem 'rails',      '~> 3.2.0'
 end
+
+if ENV["RAILS_EDGE"] == "true"
+  appraise 'rails-4' do
+    gem 'rails', :git => 'git://github.com/rails/rails.git'
+    gem 'sprockets-rails', :git => 'https://github.com/rails/sprockets-rails.git'  
+  end
+end

data/CHANGELOG

@@ -1,3 +1,21 @@
+2.2.0.rc
+
+* removed deprecated buttons DSL, ButtonHelper and commit_button helper
+* deprecated the top-level :value option that is only used by HiddenInput
+* deprecated :hint_class option (use global configuration)
+* deprecated :error_class option (use global configuration)
+* deprecated :group_by and :group_label (use :collection option with a HTML string generated by Rails' grouped_options_for_select())
+* deprecated :find_options
+* renamed TimeInput (:as => :time) to TimeSelectInput (:as => :time_select), aliased and deprecated TimeInput
+* renamed DatetimeInput (:as => :datetime) to DatetimeSelectInput (:as => :datetime_select), aliased and deprecated DatetimeInput
+* renamed DateInput (:as => :date) to TimeSelectInput (:as => :date_select), aliased and deprecated DateInput
+* added DatePickerInput (:as => :date_picker) for HTML5 date inputs
+* added TimePickerInput (:as => :time_picker) for HTML5 time inputs
+* added DateTimePickerInput (:as => :datetime_picker) for HTML5 datetime and datetime-local inputs
+* added support for Rails 4 (edge)
+* improved error message on Formtastic::UnknownInputError
+* improved documentation for asset pipeline and condition stylesheets (IE)
+
 2.1.1
 
 * Documentation improvements and updates

data/README.textile

@@ -114,13 +114,17 @@ h3. Stylesheet usage in Rails < 3.1:
 
 h3. Stylesheet usage in Rails >= 3.1:
 
-Rails 3.1 introduces an asset pipeline that allows plugins like Formtastic to serve their own Stylesheets, Javascripts, etc without having to run generators that copy them accross to the host application. Formtastic makes three stylesheets available as an Engine, you just need to require them in your global stylesheets.
+Rails 3.1 introduces an asset pipeline that allows plugins like Formtastic to serve their own Stylesheets, Javascripts, etc without having to run generators that copy them across to the host application. Formtastic makes three stylesheets available as an Engine, you just need to require them in your global stylesheets.
 
 <pre>
   # app/assets/stylesheets/application.css
   *= require formtastic
   *= require my_formtastic_changes
-  
+</pre>
+
+Conditional stylesheets need to be compiled separately to prevent them being bundled and included with other application styles.  Remove @require_tree .@ from application.css and specify required stylesheets individually.
+
+<pre>
   # app/assets/stylesheets/ie6.css
   *= require formtastic_ie6
   
@@ -135,7 +139,10 @@ Rails 3.1 introduces an asset pipeline that allows plugins like Formtastic to se
   <!--[if IE 7]><%= stylesheet_link_tag 'ie7' %><![endif]-->
 </pre>
 
-
+<pre>
+  # config/environments/production.rb
+  config.assets.precompile += %w( ie6.css ie7.css )  
+</pre>
 
 h2. Usage
 
@@ -304,16 +311,6 @@ Customize the HTML attributes for the @<li>@ wrapper around every input with the
   <% end %>
 </pre>
 
-Customize the default class used for hints on each attribute or globally in the @config/initializers/formtastic.rb@ file. Similarly, you can customize the error classes on an attribute level or globally.
-
-<pre>
-  <%= semantic_form_for @post do |f| %>
-    <%= f.inputs do %>
-      <%= f.input :title, :hint_class => 'custom-html-class', :error_class => 'custom-error-class' %>
-    <% end %>
-  <% end %>
-</pre>
-
 Many inputs provide a collection of options to choose from (like @:select@, @:radio@, @:check_boxes@, @:boolean@). In many cases, Formtastic can find choices through the model associations, but if you want to use your own set of choices, the @:collection@ option is what you want.  You can pass in an Array of objects, an array of Strings, a Hash... Throw almost anything at it! Examples:
 
 <pre>
@@ -329,6 +326,7 @@ Many inputs provide a collection of options to choose from (like @:select@, @:ra
   f.input :author,  :as => :radio,       :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
   f.input :author,  :as => :radio,       :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
   f.input :admin,   :as => :radio,       :collection => ["Yes!", "No"]
+  f.input :book_id, :as => :select,      :collection => Hash[Book.all.map{|b| [b.name,b.id]}]
 </pre>
 
 
@@ -342,9 +340,9 @@ The Formtastic input types:
 * @:time_zone@ - a select input. Default for column types: @:string@ with name matching @"time_zone"@.
 * @:password@ - a password input. Default for column types: @:string@ with name matching @"password"@.
 * @:text@ - a textarea. Default for column types: @:text@.
-* @:date@ - a date select. Default for column types: @:date@.
-* @:datetime@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
-* @:time@ - a time select. Default for column types: @:time@.
+* @:date_select@ - a date select. Default for column types: @:date@.
+* @:datetime_select@ - a date and time select. Default for column types: @:datetime@ and @:timestamp@.
+* @:time_select@ - a time select. Default for column types: @:time@.
 * @:boolean@ - a checkbox. Default for column types: @:boolean@.
 * @:string@ - a text field. Default for column types: @:string@.
 * @:number@ - a text field (just like string). Default for  column types: @:integer@, @:float@, and @:decimal@.

data/formtastic.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = %q{1.3.6}
 
-  s.add_dependency(%q<actionpack>, ["~> 3.0"])
+  s.add_dependency(%q<actionpack>, [">= 3.0"])
 
   s.add_development_dependency(%q<rspec-rails>, ["~> 2.8.0"])
   s.add_development_dependency(%q<rspec_tag_matchers>, [">= 1.0.0"])

data/gemfiles/rails-4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rails", :git=>"git://github.com/rails/rails.git"
+gem "sprockets-rails", :git=>"https://github.com/rails/sprockets-rails.git"
+
+gemspec :path=>"../"

data/lib/formtastic/form_builder.rb

@@ -41,7 +41,6 @@ module Formtastic
 
     include Formtastic::Helpers::InputHelper
     include Formtastic::Helpers::InputsHelper
-    include Formtastic::Helpers::ButtonsHelper
     include Formtastic::Helpers::ActionHelper
     include Formtastic::Helpers::ActionsHelper
     include Formtastic::Helpers::ErrorsHelper

data/lib/formtastic/helpers/input_helper.rb

@@ -89,8 +89,8 @@ module Formtastic
       # * `:boolean`      (see {Inputs::BooleanInput})
       # * `:check_boxes`  (see {Inputs::CheckBoxesInput})
       # * `:country`      (see {Inputs::CountryInput})
-      # * `:datetime`     (see {Inputs::DatetimeInput})
-      # * `:date`         (see {Inputs::DateInput})
+      # * `:datetime_select` (see {Inputs::DatetimeSelectInput})
+      # * `:date_select` (see {Inputs::DateSelectInput})
       # * `:email`        (see {Inputs::EmailInput})
       # * `:file`         (see {Inputs::FileInput})
       # * `:hidden`       (see {Inputs::HiddenInput})
@@ -103,7 +103,7 @@ module Formtastic
       # * `:string`       (see {Inputs::StringInput})
       # * `:text`         (see {Inputs::TextInput})
       # * `:time_zone`    (see {Inputs::TimeZoneInput})
-      # * `:time`         (see {Inputs::TimeInput})
+      # * `:time_select`  (see {Inputs::TimeSelectInput})
       # * `:url`          (see {Inputs::UrlInput})
       #
       # Calling `:as => :string` (for example) will call `#to_html` on a new instance of
@@ -143,34 +143,16 @@ module Formtastic
       # @option options :member_value [Symbol, Proc, Method]
       #   Override the method called on each object in the `:collection` for use as the `value` attribute in the `<input>` (`:check_boxes` & `:radio` inputs) or `<option>` (`:select` inputs)
       #
-      # @option options :hint_class [String]
-      #   Override the `class` attribute applied to the `<p>` tag used when a `:hint` is rendered for an input
-      #
-      # @option options :error_class [String]
-      #   Override the `class` attribute applied to the `<p>` or `<ol>` tag used when inline errors are rendered for an input
-      #
       # @option options :multiple [Boolean]
       #   Specify if the `:select` input should allow multiple selections or not (defaults to `belongs_to` associations, and `true` for `has_many` and `has_and_belongs_to_many` associations)
       #
-      # @option options :group_by [Symbol]
-      #   TODO will probably be deprecated
-      #
-      # @option options :find_options [Symbol]
-      #   TODO will probably be deprecated
-      #
-      # @option options :group_label [Symbol]
-      #   TODO will probably be deprecated
-      #
       # @option options :include_blank [Boolean]
       #   Specify if a `:select` input should include a blank option or not (defaults to `include_blank_for_select_by_default` configuration)
       #
       # @option options :prompt [String]
       #   Specify the text in the first ('blank') `:select` input `<option>` to prompt a user to make a selection (implicitly sets `:include_blank` to `true`)
       #
-      # @todo Can we kill `:hint_class` & `:error_class`? What's the use case for input-by-input? Shift to config or burn!
-      # @todo Can we kill `:group_by` & `:group_label`? Should be done with :collection => grouped_options_for_select(...)
-      # @todo Can we kill `:find_options`? Should be done with MyModel.some_scope.where(...).order(...).whatever_scope
-      # @todo Can we kill `:label`, `:hint` & `:prompt`? All strings could be shifted to i18n!
+      # @todo Can we deprecate & kill `:label`, `:hint` & `:prompt`? All strings could be shifted to i18n!
       #
       # @example Accept all default options
       #   <%= f.input :title %>
@@ -293,8 +275,12 @@ module Formtastic
             return :number
           when :float, :decimal
             return :number
-          when :timestamp
-            return :datetime
+          when :datetime, :timestamp
+            return :datetime_select
+          when :time
+            return :time_select
+          when :date
+            return :date_select
           end
 
           # Try look for hints in options hash. Quite common senario: Enum keys stored as string in the database.
@@ -347,7 +333,7 @@ module Formtastic
         elsif Formtastic::Inputs.const_defined?(input_class_name)
           standard_input_class_name(as).constantize 
         else
-          raise Formtastic::UnknownInputError
+          raise Formtastic::UnknownInputError, "Unable to find input class #{input_class_name}"
         end
       end
       
@@ -359,7 +345,7 @@ module Formtastic
           standard_input_class_name(as).constantize
         end
       rescue NameError
-        raise Formtastic::UnknownInputError
+        raise Formtastic::UnknownInputError, "Unable to find input class for #{as}"
       end
 
       # :as => :string # => StringInput

data/lib/formtastic/inputs.rb

@@ -8,7 +8,11 @@ module Formtastic
     autoload :CheckBoxesInput
     autoload :CountryInput
     autoload :DateInput
+    autoload :DatePickerInput
+    autoload :DatetimePickerInput
+    autoload :DateSelectInput
     autoload :DatetimeInput
+    autoload :DatetimeSelectInput
     autoload :EmailInput
     autoload :FileInput
     autoload :HiddenInput
@@ -23,6 +27,8 @@ module Formtastic
     autoload :StringInput
     autoload :TextInput
     autoload :TimeInput
+    autoload :TimePickerInput
+    autoload :TimeSelectInput
     autoload :TimeZoneInput
     autoload :Timeish
     autoload :UrlInput

data/lib/formtastic/inputs/base.rb

@@ -12,19 +12,29 @@ module Formtastic
         @method = method
         @options = options.dup
         
-        removed_option!(:label_method)
-        removed_option!(:value_method)
-        removed_option!(:group_label_method)
+        warn_deprecated_option!(:value, ":input_html => { :value => '...'}")
+        warn_deprecated_option!(:hint_class, "default_hint_class configuration")
+        warn_deprecated_option!(:error_class, "default_error_class configuration")
+        warn_deprecated_option!(:group_by, ":collection option with a HTML string generated by Rails' grouped_options_for_select()")
+        warn_deprecated_option!(:group_label, ":collection option with a HTML string generated by Rails' grouped_options_for_select()")
+        warn_deprecated_option!(:find_options, "YourModel.find(...)")
       end
       
       # Usefull for deprecating options.
       def warn_and_correct_option!(old_option_name, new_option_name)
         if options.key?(old_option_name)
-          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of :#{new_option_name} and will be removed from Formtastic after 2.0")
+          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of :#{new_option_name} and will be removed from Formtastic in the next version")
           options[new_option_name] = options.delete(old_option_name)
         end
       end
       
+      # Usefull for deprecating options.
+      def warn_deprecated_option!(old_option_name, instructions)
+        if options.key?(old_option_name)
+          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}` and will be removed in the next version")
+        end
+      end
+      
       # Usefull for raising an error on previously supported option.
       def removed_option!(old_option_name)
         raise ArgumentError, ":#{old_option_name} is no longer available" if options.key?(old_option_name)
@@ -32,6 +42,7 @@ module Formtastic
       
       extend ActiveSupport::Autoload
       
+      autoload :DatetimePickerish
       autoload :Associations
       autoload :Collections
       autoload :Choices
@@ -54,6 +65,7 @@ module Formtastic
       include Html
       include Options
       include Database
+      include Database
       include Errors
       include Hints
       include Naming

data/lib/formtastic/inputs/base/datetime_pickerish.rb

@@ -0,0 +1,85 @@
+module Formtastic
+  module Inputs
+    module Base
+      module DatetimePickerish
+        include Base::Placeholder
+      
+        def html_input_type
+          raise NotImplementedError
+        end
+      
+        def default_size
+          raise NotImplementedError
+        end
+        
+        def value
+          raise NotImplementedError
+        end
+      
+        def input_html_options
+          super.merge(extra_input_html_options)
+        end
+      
+        def extra_input_html_options
+          {
+            :type => html_input_type, 
+            :size => size, 
+            :maxlength => maxlength, 
+            :step => step,
+            :value => value
+          }
+        end
+      
+        def size
+          return options[:size] if options.key?(:size)
+          return options[:input_html][:size] if options[:input_html] && options[:input_html].key?(:size)
+          default_size
+        end
+      
+        def step
+          return step_from_macro(options[:input_html][:step]) if options[:input_html] && options[:input_html][:step] && options[:input_html][:step].is_a?(Symbol)
+          return options[:input_html][:step] if options[:input_html] && options[:input_html].key?(:step)
+          default_step
+        end
+      
+        def maxlength
+          return options[:maxlength] if options.key?(:maxlength)
+          return options[:input_html][:maxlength] if options[:input_html] && options[:input_html].key?(:maxlength)
+          default_size
+        end
+      
+        def default_maxlength
+          default_size
+        end
+      
+        def default_step
+          1
+        end
+        
+        protected
+        
+        def step_from_macro(sym)
+          case sym
+
+            # date
+            when :day then "1"
+            when :seven_days, :week then "7"
+            when :two_weeks, :fortnight then "14"
+            when :four_weeks then "28"
+            when :thirty_days then "30"
+
+            # time
+            when :second then "1"
+            when :minute then "60"
+            when :fifteen_minutes, :quarter_hour then "900"
+            when :thirty_minutes, :half_hour then "1800"
+            when :sixty_minutes, :hour then "3600"            
+
+            else sym
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/base/stringish.rb

@@ -14,11 +14,19 @@ module Formtastic
         # Overrides standard `input_html_options` to provide a `maxlength` and `size` attribute.
         def input_html_options
           {
-            :maxlength => options[:input_html].try(:[], :maxlength) || limit,
-            :size => builder.default_text_field_size
+            :maxlength => maxlength,
+            :size => size
           }.merge(super)
         end
         
+        def size
+          builder.default_text_field_size
+        end
+        
+        def maxlength
+          options[:input_html].try(:[], :maxlength) || limit
+        end
+        
         def wrapper_html_options
           new_class = [super[:class], "stringish"].compact.join(" ")
           super.merge(:class => new_class)

data/lib/formtastic/inputs/base/timeish.rb

@@ -1,7 +1,7 @@
 module Formtastic
   module Inputs
     module Base
-      # Timeish inputs (`:date`, `:datetime`, `:time`) are similar to the Rails date and time 
+      # Timeish inputs (`:date_select`, `:datetime_select`, `:time_select`) are similar to the Rails date and time 
       # helpers (`date_select`, `datetime_select`, `time_select`), rendering a series of `<select>`
       # tags for each fragment (year, month, day, hour, minute, seconds). The fragments are then 
       # re-combined to a date by ActiveRecord through multi-parameter assignment.
@@ -21,12 +21,12 @@ module Formtastic
       # * floating the `<li>` fragments against each other as a single line
       # * hiding the `<label>` of each fragment with `display:none`
       #
-      # @example `:date` input with full form context and sample HTMl output
+      # @example `:date_select` input with full form context and sample HTMl output
       #
       #   <%= semantic_form_for(@post) do |f| %>
       #     <%= f.inputs do %>
       #       ...
-      #       <%= f.input :publish_at, :as => :date %>
+      #       <%= f.input :publish_at, :as => :date_select %>
       #     <% end %>
       #   <% end %>
       #
@@ -56,31 +56,31 @@ module Formtastic
       #   </form>
       #       
       #
-      # @example `:time` input
-      #   <%= f.input :publish_at, :as => :time %>
+      # @example `:time_select` input
+      #   <%= f.input :publish_at, :as => :time_select %>
       #
-      # @example `:datetime` input
-      #   <%= f.input :publish_at, :as => :datetime %>
+      # @example `:datetime_select` input
+      #   <%= f.input :publish_at, :as => :datetime_select %>
       #
       # @example Change the labels for each fragment
-      #   <%= f.input :publish_at, :as => :date, :labels => { :year => "Y", :month => "M", :day => "D" }  %>
+      #   <%= f.input :publish_at, :as => :date_select, :labels => { :year => "Y", :month => "M", :day => "D" }  %>
       #
       # @example Skip a fragment (defaults to 1, skips all following fragments)
-      #   <%= f.input :publish_at, :as => :datetime, :discard_minute => true  %>
-      #   <%= f.input :publish_at, :as => :datetime, :discard_hour => true  %>
-      #   <%= f.input :publish_at, :as => :datetime, :discard_day => true  %>
-      #   <%= f.input :publish_at, :as => :datetime, :discard_month => true  %>
-      #   <%= f.input :publish_at, :as => :datetime, :discard_year => true  %>
+      #   <%= f.input :publish_at, :as => :datetime_select, :discard_minute => true  %>
+      #   <%= f.input :publish_at, :as => :datetime_select, :discard_hour => true  %>
+      #   <%= f.input :publish_at, :as => :datetime_select, :discard_day => true  %>
+      #   <%= f.input :publish_at, :as => :datetime_select, :discard_month => true  %>
+      #   <%= f.input :publish_at, :as => :datetime_select, :discard_year => true  %>
       #
       # @example Change the order
-      #   <%= f.input :publish_at, :as => :date, :order => [:month, :day, :year]  %>
+      #   <%= f.input :publish_at, :as => :date_select, :order => [:month, :day, :year]  %>
       #
       # @example Include seconds with times (excluded by default)
-      #   <%= f.input :publish_at, :as => :time, :include_seconds => true %>
+      #   <%= f.input :publish_at, :as => :time_select, :include_seconds => true %>
       #
       # @example Specify if there should be a blank option at the start of each select or not. Note that, unlike select inputs, :include_blank does not accept a string value.
-      #   <%= f.input :publish_at, :as => :time, :include_blank => true %>
-      #   <%= f.input :publish_at, :as => :time, :include_blank => false %>
+      #   <%= f.input :publish_at, :as => :time_select, :include_blank => true %>
+      #   <%= f.input :publish_at, :as => :time_select, :include_blank => false %>
       #
       # @todo Document i18n
       # @todo Check what other Rails options are supported (`start_year`, `end_year`, `use_month_numbers`, `use_short_month`, `add_month_numbers`, `prompt`), write tests for them, and otherwise support them