formtastic 2.3.0.rc2 → 2.3.0.rc3

data/.travis.yml

@@ -1,4 +1,4 @@
-before_install: 
+before_install:
   - gem update --system
   - gem update bundler
 rvm:
@@ -6,6 +6,8 @@ rvm:
   - ree
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0
 gemfile:
   - gemfiles/rails_3.0.gemfile
   - gemfiles/rails_3.1.gemfile
@@ -21,6 +23,24 @@ matrix:
     - rvm: 2.0.0
       gemfile: gemfiles/rails_4.gemfile
       env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 2.1.0
+      gemfile: gemfiles/rails_4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.0.4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_4.0.4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_edge.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_edge.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 2.1.0
+      gemfile: gemfiles/rails_edge.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
   allow_failures:
     - rvm: 1.9.3
       gemfile: gemfiles/rails_edge.gemfile
@@ -28,3 +48,9 @@ matrix:
     - rvm: 2.0.0
       gemfile: gemfiles/rails_edge.gemfile
       env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 2.1.0
+      gemfile: gemfiles/rails_4.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true
+    - rvm: 2.1.0
+      gemfile: gemfiles/rails_edge.gemfile
+      env: DEFER_GC=false RAILS_EDGE=true

data/Appraisals

@@ -14,6 +14,11 @@ appraise 'rails-4' do
   gem 'rails', '~> 4.0.0'
 end
 
+# Special case for a change in I18n
+appraise 'rails-4.0.4' do
+  gem 'rails', '4.0.4'
+end
+
 if ENV["RAILS_EDGE"] == "true"
   appraise 'rails-edge' do
     gem 'rails', :git => 'git://github.com/rails/rails.git'

data/CHANGELOG

@@ -1,6 +1,7 @@
 2.3.0.rc2
 
 * deprecate support for Rails < 3.2
+* avoid clobbering `ActionView::Base.field_error_proc=` by using a custom class attribute: `Formtastic::Helpers::FormHelper.formtastic_field_error_proc=`.
 
 2.3.0.rc
 

data/README.textile

@@ -1,8 +1,12 @@
 h1. Formtastic
 
-Formtastic is a Rails FormBuilder DSL (with some other goodies) to make it far easier to create beautiful, semantically rich, syntactically awesome, readily stylable and wonderfully accessible HTML forms in your Rails applications.
+!https://travis-ci.org/justinfrench/formtastic.png?branch=master!:https://travis-ci.org/justinfrench/formtastic
+!http://inch-pages.github.io/github/justinfrench/formtastic.png!:http://inch-pages.github.io/github/justinfrench/formtastic
+!https://codeclimate.com/github/justinfrench/formtastic.png!:https://codeclimate.com/github/justinfrench/formtastic
+!https://badge.fury.io/rb/formtastic.png!:http://badge.fury.io/rb/formtastic
+!https://gemnasium.com/justinfrench/formtastic.png!:https://gemnasium.com/justinfrench/formtastic
 
-<a href='http://www.pledgie.com/campaigns/2178'><img alt='Click here to lend your support to: formtastic and make a donation at www.pledgie.com !' src='http://pledgie.com/campaigns/2178.png?skin_name=chrome' border='0' /></a>
+Formtastic is a Rails FormBuilder DSL (with some other goodies) to make it far easier to create beautiful, semantically rich, syntactically awesome, readily stylable and wonderfully accessible HTML forms in your Rails applications.
 
 
 h2. Documentation & Support
@@ -20,7 +24,7 @@ h2. Compatibility
 * Formtastic 2.3 is Rails 3 and Rails 4 compatible (Rails < 3.2 is deprecated)
 * Formtastic 2.1 & 2.2 is Rails 3 and Rails 4 compatible
 * Formtastic, much like Rails, is very ActiveRecord-centric. Many are successfully using other ActiveModel-like ORMs and objects (DataMapper, MongoMapper, Mongoid, Authlogic, Devise...) but we're not guaranteeing full compatibility at this stage. Patches are welcome!
- 
+
 
 h2. The Story
 
@@ -95,7 +99,7 @@ Simply add Formtastic to your Gemfile and bundle it up:
 Run the installation generator:
 
 <pre>
-  $ rails generate formtastic:install 
+  $ rails generate formtastic:install
 </pre>
 
 
@@ -106,7 +110,7 @@ A proof-of-concept set of stylesheets are provided which you can include in your
 h3. Stylesheet usage in Rails < 3.1:
 
 <pre>
-  $ rails generate formtastic:install 
+  $ rails generate formtastic:install
 </pre>
 
 <pre>
@@ -131,7 +135,7 @@ Conditional stylesheets need to be compiled separately to prevent them being bun
 <pre>
   # app/assets/stylesheets/ie6.css
   *= require formtastic_ie6
-  
+
   # app/assets/stylesheets/ie7.css
   *= require formtastic_ie7
 </pre>
@@ -145,7 +149,7 @@ Conditional stylesheets need to be compiled separately to prevent them being bun
 
 <pre>
   # config/environments/production.rb
-  config.assets.precompile += %w( ie6.css ie7.css )  
+  config.assets.precompile += %w( ie6.css ie7.css )
 </pre>
 
 h2. Usage
@@ -365,7 +369,7 @@ Formtastic decides which label to use in the following order:
   1. :label             # :label => "Choose Title"
   2. Formtastic i18n    # if either :label => true || i18n_lookups_by_default = true (see Internationalization)
   3. Activerecord i18n  # if localization file found for the given attribute
-  4. label_str_method   # if nothing provided this defaults to :humanize but can be set to a custom method 
+  4. label_str_method   # if nothing provided this defaults to :humanize but can be set to a custom method
 </pre>
 
 h2. Internationalization (I18n)
@@ -398,7 +402,7 @@ Formtastic supports localized *labels*, *hints*, *legends*, *actions* using the
   Formtastic::FormBuilder.i18n_lookups_by_default = true
 </pre>
 
-*2. Add some cool label-translations/variants (@config/locale/en.yml@):*
+*2. Add some label-translations/variants (@config/locales/en.yml@):*
 
 <pre>
   en:
@@ -593,39 +597,28 @@ To create a custom @DatePickerInput@ from scratch, put the following in @app/inp
 
 You can use your new input with @:as => :date_picker@.
 
-h3. Don't subclass Formtastic::FormBuilder anymore
-
-It was previously recommended in Formtastic 1.x to subclass Formtastic::FormBuilder to add your own inputs. This is no longer recommended in Formtastic 2, and will not work as expected.
-
-
-h2. Security
-
-By default, Formtastic escapes HTML entities in both labels and hints unless a string is marked as html_safe. If you are using an older rails version which doesn't know html_safe, or you want to globally turn this feature off, you can set the following in your initializer:
-
-Formtastic::FormBuilder.escape_html_entities_in_hints_and_labels = false
-
 
 h2. Dependencies
 
 There are none other than Rails itself, but...
 
-* If you want to use the @:country@ input, you'll need to install the "country-select plugin":https://github.com/chrislerum/country_select (or any other country_select plugin with the same API).
-* There are a bunch of development dependencies
+* If you want to use the @:country@ input, you'll need to install the "country-select plugin":https://github.com/stefanpenner/country_select (or any other country_select plugin with the same API).
+* There are a bunch of development dependencies if you plan to contribute to Formtastic
 
 
 h2. How to contribute
 
 * Fork the project on Github
 * Create a topic branch for your changes
-* Ensure that you provide test coverage for your changes
+* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
 * Ensure that all tests pass (`bundle exec rake`)
-* Create a pull request on Github
+* Create a pull request on Github (these are also a great place to start a conversation around a patch as early as possible)
 
 
 h2. Project Info
 
-Formtastic was created by "Justin French":http://www.justinfrench.com with contributions from around 150 awesome developers. Run @git shortlog -n -s@ to see the awesome.
+Formtastic was created by "Justin French":http://www.justinfrench.com with contributions from around 180 awesome developers. Run @git shortlog -n -s@ to see the awesome.
 
 The project is hosted on Github: "http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic, where your contributions, forkings, comments, issues and feedback are greatly welcomed.
 
-Copyright (c) 2007-2012 Justin French, released under the MIT license.
+Copyright (c) 2007-2014 Justin French, released under the MIT license.

data/formtastic.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = %q{http://github.com/justinfrench/formtastic}
   s.summary     = %q{A Rails form builder plugin/gem with semantically rich and accessible markup}
   s.description = %q{A Rails form builder plugin/gem with semantically rich and accessible markup}
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -26,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_dependency(%q<actionpack>, [">= 3.0"])
 
   s.add_development_dependency(%q<nokogiri>, ["< 1.6.0"]) # 1.6 requires Ruby 1.9.2, drop in v3.0
-  s.add_development_dependency(%q<rspec-rails>, ["~> 2.12.0"])
+  s.add_development_dependency(%q<rspec-rails>, ["~> 2.14.0"])
   s.add_development_dependency(%q<rspec_tag_matchers>, [">= 1.0.0"])
   s.add_development_dependency(%q<hpricot>, ["~> 0.8.3"])
   s.add_development_dependency(%q<BlueCloth>) # for YARD
@@ -34,7 +35,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<colored>)
   s.add_development_dependency(%q<tzinfo>)
   s.add_development_dependency(%q<ammeter>, ["0.2.5"])
-  s.add_development_dependency(%q<appraisal>)
-  s.add_development_dependency(%q<rake>)
+  s.add_development_dependency(%q<appraisal>, ["1.0.0.beta3"])
+  s.add_development_dependency(%q<rake>, ["<= 10.1.1"]) # Anything higher requires Ruby 1.9, drop in v3.0
   s.add_development_dependency(%q<activemodel>)
 end

data/gemfiles/rails_3.0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 3.0.0"
 
-gemspec :path=>"../"
+gemspec :path=>".././"

data/gemfiles/rails_3.1.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 3.1.0"
 
-gemspec :path=>"../"
+gemspec :path=>".././"

data/gemfiles/rails_3.2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 3.2.0"
 
-gemspec :path=>"../"
+gemspec :path=>".././"

data/gemfiles/rails_4.0.4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0.4"
+
+gemspec :path=>".././"

data/gemfiles/rails_4.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 4.0.0"
 
-gemspec :path=>"../"
+gemspec :path=>".././"

data/lib/formtastic/form_builder.rb

@@ -82,7 +82,15 @@ module Formtastic
     end
     
     def initialize(object_name, object, template, options, block=nil)
-      super
+      # rails 3 supported passing in the block parameter to FormBuilder
+      # rails 4.0 deprecated the block parameter and does nothing with it
+      # rails 4.1 removes the parameter completely
+      if Util.rails3? || Util.rails4_0?
+        super
+      else # Must be rails4_1 or greater
+        super object_name, object, template, options
+      end
+      
       if respond_to?('multipart=') && options.is_a?(Hash) && options[:html]
         self.multipart = options[:html][:multipart]
       end

data/lib/formtastic/helpers/form_helper.rb

@@ -58,11 +58,16 @@ module Formtastic
       @@default_form_class = 'formtastic'
       mattr_accessor :default_form_class
 
+      # Allows to set a custom proc to handle the class infered from the model's name. By default it
+      # will infer the name from the class name (eg. Post will be "post").
+      @@default_form_model_class_proc = proc { |model_class_name| model_class_name }
+      mattr_accessor :default_form_model_class_proc
+
       # Allows to set a custom field_error_proc wrapper. By default this wrapper
       # is disabled since `formtastic` already adds an error class to the LI tag
       # containing the input. Change this from `config/initializers/formtastic.rb`.
-      @@field_error_proc = proc { |html_tag, instance_tag| html_tag }
-      mattr_accessor :field_error_proc
+      @@formtastic_field_error_proc = proc { |html_tag, instance_tag| html_tag }
+      mattr_accessor :formtastic_field_error_proc
 
       # Wrapper around Rails' own `form_for` helper to set the `:builder` option to
       # `Formtastic::FormBuilder` and to set some class names on the `<form>` tag such as
@@ -156,11 +161,13 @@ module Formtastic
 
         class_names = options[:html][:class] ? options[:html][:class].split(" ") : []
         class_names << @@default_form_class
-        class_names << case record_or_name_or_array
+        model_class_name = case record_or_name_or_array
           when String, Symbol then record_or_name_or_array.to_s                                  # :post => "post"
           when Array then options[:as] || singularizer.call(record_or_name_or_array.last.class)  # [@post, @comment] # => "comment"
           else options[:as] || singularizer.call(record_or_name_or_array.class)                  # @post => "post"
         end
+        class_names << @@default_form_model_class_proc.call(model_class_name)
+
         options[:html][:class] = class_names.compact.join(" ")
 
         with_custom_field_error_proc do
@@ -186,13 +193,11 @@ module Formtastic
 
       def with_custom_field_error_proc(&block)
         default_field_error_proc = ::ActionView::Base.field_error_proc
-        ::ActionView::Base.field_error_proc = @@field_error_proc
+        ::ActionView::Base.field_error_proc = @@formtastic_field_error_proc
         yield
       ensure
         ::ActionView::Base.field_error_proc = default_field_error_proc
       end
-
-
     end
   end
 end

data/lib/formtastic/helpers/inputs_helper.rb

@@ -182,6 +182,10 @@ module Formtastic
       #     <%= f.inputs %>
       #   <% end %>
       #
+      # @example Quick form: Skip one or more fields
+      #   <%= f.inputs, :except => [:featured, :something_for_admin_only] %>
+      #   <%= f.inputs, :except => :featured %>
+      #
       # @example Short hand: Render inputs for a named set of attributes and simple associations on the model, with all default arguments and options
       #   <% semantic_form_for @post do |form| %>
       #     <%= f.inputs, :title, :body, :user, :categories %>
@@ -284,6 +288,7 @@ module Formtastic
         html_options = args.extract_options!
         html_options[:class] ||= "inputs"
         html_options[:name] = title
+        skipped_args = Array.wrap html_options.delete(:except)
 
         out = begin
           if html_options[:for] # Nested form
@@ -292,7 +297,7 @@ module Formtastic
             field_set_and_list_wrapping(*(args << html_options), &block)
           else
             legend = args.shift if args.first.is_a?(::String)
-            args = default_columns_for_object if @object && args.empty?
+            args = default_columns_for_object - skipped_args if @object && args.empty?
             contents = fieldset_contents_from_column_list(args)
             args.unshift(legend) if legend.present?
             field_set_and_list_wrapping(*((args << html_options) << contents))

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

@@ -124,7 +124,7 @@ module Formtastic
         # Avoids an issue where `send_or_call` can be a String and duck can be something simple like
         # `:first`, which obviously String responds to.
         def send_or_call_or_object(duck, object)
-          return object if object.is_a?(String) || object.is_a?(Integer) # TODO what about other classes etc?
+          return object if object.is_a?(String) || object.is_a?(Integer) || object.is_a?(Symbol) # TODO what about other classes etc?
           send_or_call(duck, object)
         end
 

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

@@ -35,7 +35,7 @@ module Formtastic
           return true unless validator.options.key?(:if) || validator.options.key?(:unless)
           conditional = validator.options.key?(:if) ? validator.options[:if] : validator.options[:unless]
 
-          result = if conditional.respond_to?(:call)
+          result = if conditional.respond_to?(:call) && conditional.arity > 0
             conditional.call(object)
           elsif conditional.is_a?(::Symbol) && object.respond_to?(conditional)
             object.send(conditional)

data/lib/formtastic/inputs/boolean_input.rb

@@ -51,21 +51,11 @@ module Formtastic
         )
       end
       
-      # TODO: why are we merging `input_html_options` and then making some of the irrelevant ones `nil`?
-      # Seems like we should be selectively including from input_html_options (a whitelist) instead of 
-      # excluding (blacklist).
       def label_html_options
-        prev = super
-        prev[:class] = prev[:class] - ['label']
-        
-        input_html_options.merge(
-          prev.merge(
-            :id   => nil,
-            :name => nil,
-            :tabindex => nil,
-            :for  => input_html_options[:id]
-          )
-        )
+        {
+          :for => input_html_options[:id],
+          :class => super[:class] - ['label'] # remove 'label' class
+        }
       end
 
       def label_text_with_embedded_checkbox

data/lib/formtastic/inputs/check_boxes_input.rb

@@ -46,6 +46,9 @@ module Formtastic
     #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", 1], ["Rails", 2]] %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", 1, {'data-attr' => 'attr-value'}]] %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => 1..5 %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [:ruby, :rails] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", :ruby], ["Rails", :rails]] %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Set.new([:ruby, :rails]) %>
     #
     # @example `:hidden_fields` can be used to skip Rails' rendering of a hidden field before every checkbox
     #   <%= f.input :categories, :as => :check_boxes, :hidden_fields => false %>
@@ -182,7 +185,10 @@ module Formtastic
 
       def make_selected_values
         if object.respond_to?(method)
-          selected_items = [object.send(method)].compact.flatten
+          selected_items = object.send(method)
+
+          # Construct an array from the return value, regardless of the return type
+          selected_items = [*selected_items].compact.flatten
 
           [*selected_items.map { |o| send_or_call_or_object(value_method, o) }].compact
         else

data/lib/formtastic/inputs/radio_input.rb

@@ -83,6 +83,8 @@ module Formtastic
     #   <%= 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 => [["Justin", :justin], ["Kate", :kate]] %>
+    #   <%= f.input :author, :as => :radio, :collection => [:justin, :kate] %>
     #   <%= 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)

data/lib/formtastic/util.rb

@@ -24,9 +24,21 @@ module Formtastic
     def rails3?
       ::Rails::VERSION::MAJOR == 3
     end
+
+    def rails4?
+      ::Rails::VERSION::MAJOR == 4
+    end
+    
+    def rails4_0?
+      ::Rails::VERSION::MAJOR == 4 && ::Rails::VERSION::MINOR == 0
+    end
+
+    def rails4_1?
+      ::Rails::VERSION::MAJOR == 4 && ::Rails::VERSION::MINOR == 1
+    end
     
     def deprecated_version_of_rails?
-      const_defined?(:Rails) && ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR < 2
+      const_defined?(:Rails) && ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR < 2 && ::Rails::VERSION::PATCH < 13
     end
 
   end