simple_form 1.4.0 → 1.5.0

data/.gitignore

@@ -1,2 +1,3 @@
 .bundle/
 pkg/
+Gemfile.lock

data/.travis.yml

@@ -1,6 +1,15 @@
-script: "git submodule update --init && rake test"
+script: "git submodule update --init && bundle exec rake test"
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
+  - ruby-head
   - ree
   - jruby
+  - rbx
+  - rbx-2.0
+notifications:
+  recipients:
+    - jose.valim@plataformatec.com.br
+    - carlos@plataformatec.com.br
+    - rafael.franca@plataformatec.com.br

data/CHANGELOG.rdoc

@@ -1,3 +1,39 @@
+== 1.5.0
+
+* enhancements
+  * Simplified generator by using directory action (by github.com/rupert654)
+  * Support for `maxlength` on string inputs inferred from validation (by github.com/srbartlett)
+  * Change form css class handling to only add the dom class when one is not given to the form call (by github.com/patrick99e99)
+  * Support for required attributes when action validations are present (by github.com/csegura)
+  * Don't generate `size` attribute for numeric input (by github.com/jasonmp85)
+  * Support for `maxlength` on text area inputs inferred from validation
+  * Support for `pattern` on text field inferred from validation when :pattern is true
+  * Break Text, Password and File into their own inputs
+  * Support easy enabling and disabling of components for specific inputs
+  * Add HTML5 range input
+
+* bug fix
+  * Fix bug when simple_fields_for is used with a hash like models and Rails 3.1
+  * Fix bug that doesn't remove the item_wrapper_tag or the collection_wrapper_tag on collection inputs when nil or false value is passed to these options (by gitbub.com/dw2)
+  * Fix bug that disable the entire select and wrapper when `disabled` option is a string or array
+  * Fix bug when using label/value methods as procs together with disabled/selected options as procs for select inputs
+
+== 1.4.2
+
+* enhancements
+  * Rails 3.1 support
+
+== 1.4.1
+
+* enhancements
+  * ignore required attribute when conditional validations are present
+
+* bug fix
+  * Do not use required='required' when browser validations are turned off
+  * Sanitize HMTL attributes in error and hint helpers when options are present
+  * Improve i18n lookup by ignoring explicit child index given to form builder (tests by github.com/rywall)
+  * Fixes the form specific validation option if specified on the form itself (by github.com/medihack)
+
 == 1.4.0
 
 * enhancements

data/Gemfile

@@ -1,8 +1,9 @@
 source "http://rubygems.org"
 
-gem "rails", "~> 3.0.7"
+gemspec
 
-group :test do
-  gem "mocha",      :require => false
-  gem "ruby-debug", :require => false, :platform => :ruby_18
-end
+gem "rake", '0.9.3.beta1'
+gem "rdoc"
+gem "mocha"
+gem "tzinfo"
+gem "ruby-debug", :platform => :mri_18

data/README.rdoc

@@ -158,7 +158,7 @@ Collection inputs accepts two other options beside collections:
 
 * value_method => the value method to be applied to the collection to retrieve the value
 
-Those methods are useful to manipulate the given collection. Both of these options also except lambda/procs in case you want to calculate the value or label in a special way eg. custom translation. All other options given are sent straight to the underlying helper. For example, you can give prompt as:
+Those methods are useful to manipulate the given collection. Both of these options also accept lambda/procs in case you want to calculate the value or label in a special way eg. custom translation. All other options given are sent straight to the underlying helper. For example, you can give prompt as:
 
   f.input :age, :collection => 18..60, :prompt => "Select your age"
 
@@ -232,6 +232,16 @@ All web forms need buttons, right? SimpleForm wraps them in the DSL, acting like
 
 The above will simply call submit. You choose to use it or not, it's just a question of taste.
 
+== Wrapping Rails Form Helpers
+
+Say you wanted to use a rails form helper but still wrap it in SimpleForm goodness? You can, by calling input with a block like so:
+
+  <%= f.input :role do %>
+    <%= f.select :role, Role.all.map { |r| [r.name, r.id, { :class => r.company.id }] }, :include_blank => true %>
+  <% end %>
+
+In the above example, we're taking advantage of Rails 3's select method that allows us to pass in a hash of additional attributes for each option.
+
 == Extra helpers
 
 SimpleForm also comes with some extra helpers you can use inside rails default forms without relying on simple_form_for helper. They are listed below.
@@ -275,6 +285,13 @@ Creates a collection of check boxes with labels associated (same API as collecti
   <input id="user_options_false" name="user[options][]" type="checkbox" value="false" />
   <label class="collection_check_box" for="user_options_false">No</label>
 
+To use this with associations in your model, you can do the following:
+
+  form_for @user do |f|
+    f.collection_check_boxes :role_ids, Role.all, :id, :name # using :roles here is not going to work.
+  end
+
+
 == Mappings/Inputs available
 
 SimpleForm comes with a lot of default mappings:
@@ -294,6 +311,7 @@ SimpleForm comes with a lot of default mappings:
   integer               number field            integer
   float                 number field            float
   decimal               number field            decimal
+  range                 range field             -
   datetime              datetime select         datetime/timestamp
   date                  date select             date
   time                  time select             time
@@ -308,9 +326,9 @@ SimpleForm comes with a lot of default mappings:
 It is very easy to add custom inputs to SimpleForm. For instance, if you want to add a custom input that extends the string one, you just need to add this file:
 
     # app/inputs/currency_input.rb
-    class CurrencyInput < SimpleForm::Inputs::StringInput
+    class CurrencyInput < SimpleForm::Inputs::Base
       def input
-        "$ #{super}".html_safe
+        "$ #{@builder.text_field(attribute_name, input_html_options)}".html_safe
       end
     end
 
@@ -425,6 +443,10 @@ If you want to have all other HTML 5 features, such as the new field types, you
 
 This option adds a new `novalidate` property to the form, instructing it to skip all HTML 5 validation. The inputs will still be generated with the required and other attributes, that might help you to use some generic javascript validation.
 
+You can also add `novalidate` to a specific form by setting the option on the form itself:
+
+  <%= simple_form_for(resource, :html => {:novalidate => true}) do |form| %>
+
 Please notice that any of the configurations above will disable the `placeholder` component, which is an HTML 5 feature. We believe most of the newest browsers are handling this attribute fine, and if they aren't, any plugin you use would take of using the placeholder attribute to do it. However, you can disable it if you want, by removing the placeholder component from the components list in SimpleForm configuration file.
 
 == Configuration
@@ -435,7 +457,6 @@ SimpleForm has several configuration values. You can read and change them in the
 
 == Maintainers
 
-* José Valim (https://github.com/josevalim)
 * Carlos Antonio da Silva (https://github.com/carlosantoniodasilva)
 * Rafael Mendonça França (https://github.com/rafaelfranca)
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task :default => :test

data/lib/generators/simple_form/install_generator.rb

@@ -5,12 +5,8 @@ module SimpleForm
       source_root File.expand_path('../templates', __FILE__)
       class_option :template_engine
 
-      def copy_initializers
-        copy_file 'simple_form.rb', 'config/initializers/simple_form.rb'
-      end
-
-      def copy_locale_file
-        copy_file 'en.yml', 'config/locales/simple_form.en.yml'
+      def copy_config
+        directory 'config'
       end
 
       def copy_scaffold_template

data/lib/generators/simple_form/templates/{simple_form.rb → config/initializers/simple_form.rb}

@@ -43,10 +43,10 @@ SimpleForm.setup do |config|
   # You can wrap each item in a collection of radio/check boxes with a tag, defaulting to span.
   # config.item_wrapper_tag = :span
 
-  # Series of attemps to detect a default label method for collection.
+  # Series of attempts to detect a default label method for collection.
   # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
 
-  # Series of attemps to detect a default value method for collection.
+  # Series of attempts to detect a default value method for collection.
   # config.collection_value_methods = [ :id, :to_s ]
 
   # How the label text should be generated altogether with the required text.

data/lib/simple_form/action_view_extensions/builder.rb

@@ -114,10 +114,10 @@ module SimpleForm
       def default_html_options_for_collection(item, value, options, html_options) #:nodoc:
         html_options = html_options.dup
 
-        [:checked, :disabled].each do |option|
+        [:checked, :selected, :disabled].each do |option|
           next unless options[option]
 
-          accept = if options[option].is_a?(Proc)
+          accept = if options[option].respond_to?(:call)
             options[option].call(item)
           else
             Array(options[option]).include?(value)
@@ -134,8 +134,8 @@ module SimpleForm
       end
 
       def render_collection(attribute, collection, value_method, text_method, options={}, html_options={}) #:nodoc:
-        collection_wrapper_tag = options[:collection_wrapper_tag] || SimpleForm.collection_wrapper_tag
-        item_wrapper_tag       = options[:item_wrapper_tag] || SimpleForm.item_wrapper_tag
+        collection_wrapper_tag = options.has_key?(:collection_wrapper_tag) ? options[:collection_wrapper_tag] : SimpleForm.collection_wrapper_tag
+        item_wrapper_tag = options.has_key?(:item_wrapper_tag) ? options[:item_wrapper_tag] : SimpleForm.item_wrapper_tag
 
         rendered_collection = collection.map do |item|
           value = value_for_collection(item, value_method)
@@ -171,8 +171,15 @@ class ActionView::Helpers::FormBuilder
       collection = collection.map do |item|
         value = value_for_collection(item, value_method)
         text  = value_for_collection(item, text_method)
-        [value, text]
+
+        default_html_options = default_html_options_for_collection(item, value, options, html_options)
+        disabled = value if default_html_options[:disabled]
+        selected = value if default_html_options[:selected]
+
+        [value, text, selected, disabled]
       end
+      options[:disabled] = collection.map(&:pop).compact
+      options[:selected] = collection.map(&:pop).compact
       value_method, text_method = :first, :last
     end
 

data/lib/simple_form/action_view_extensions/form_helper.rb

@@ -29,25 +29,36 @@ module SimpleForm
         result
       end
 
-      [:form_for, :fields_for].each do |helper|
-        class_eval <<-METHOD, __FILE__, __LINE__
-          def simple_#{helper}(record_or_name_or_array, *args, &block)
-            options = args.extract_options!
-            options[:builder] ||= SimpleForm::FormBuilder
-            css_class = case record_or_name_or_array
-              when String, Symbol then record_or_name_or_array.to_s
-              when Array then dom_class(record_or_name_or_array.last)
-              else dom_class(record_or_name_or_array)
-            end
-            options[:html] ||= {}
-            options[:html][:novalidate] = !SimpleForm.browser_validations
-            options[:html][:class] = "\#{SimpleForm.form_class} \#{css_class} \#{options[:html][:class]}".strip
+      def simple_form_for(record, options={}, &block)
+        options[:builder] ||= SimpleForm::FormBuilder
+        options[:html] ||= {}
+        unless options[:html].key?(:novalidate)
+          options[:html][:novalidate] = !SimpleForm.browser_validations
+        end
+        options[:html][:class] = [SimpleForm.form_class, css_class(record, options[:html])].compact.join(" ")
+        with_custom_field_error_proc do
+          form_for(record, options, &block)
+        end
+      end
+
+      def css_class(record, html_options)
+        if html_options.key?(:class)
+          html_options[:class]
+        elsif record.is_a?(String) || record.is_a?(Symbol)
+          record
+        else
+          record = record.last if record.is_a?(Array)
+          dom_class(record)
+        end
+      end
+
+      def simple_fields_for(record_name, record_object = nil, options = {}, &block)
+        options, record_object = record_object, nil if record_object.is_a?(Hash) && record_object.extractable_options?
+        options[:builder] ||= SimpleForm::FormBuilder
 
-            with_custom_field_error_proc do
-              #{helper}(record_or_name_or_array, *(args << options), &block)
-            end
-          end
-        METHOD
+        with_custom_field_error_proc do
+          fields_for(record_name, record_object, options, &block)
+        end
       end
     end
   end

data/lib/simple_form/components/errors.rb

@@ -1,10 +1,10 @@
 module SimpleForm
   module Components
     module Errors
-      include SimpleForm::HasErrors
+      include SimpleForm::Helpers::HasErrors
 
       def error
-        template.content_tag(error_tag, error_text, error_html_options) if has_errors?
+        enabled_error
       end
 
       def error_tag
@@ -29,6 +29,14 @@ module SimpleForm
 
     protected
 
+      def enabled_error
+        template.content_tag(error_tag, error_text, error_html_options) if has_errors?
+      end
+
+      def disabled_error
+        nil
+      end
+
       def errors
         @errors ||= (errors_on_attribute + errors_on_association).compact
       end

data/lib/simple_form/components/hints.rb

@@ -2,9 +2,19 @@ module SimpleForm
   module Components
     module Hints
       def hint
+        enabled_hint
+      end
+
+      private
+
+      def enabled_hint
         template.content_tag(hint_tag, hint_text, hint_html_options) unless hint_text.blank?
       end
 
+      def disabled_hint
+        nil
+      end
+
       def hint_tag
         options[:hint_tag] || SimpleForm.hint_tag
       end

data/lib/simple_form/components/label_input.rb

@@ -1,8 +1,10 @@
 module SimpleForm
   module Components
     module LabelInput
-      def self.included(base)
-        base.send :include, SimpleForm::Components::Labels
+      extend ActiveSupport::Concern
+
+      included do
+        include SimpleForm::Components::Labels
       end
 
       def label_input
@@ -10,4 +12,4 @@ module SimpleForm
       end
     end
   end
-end
+end

data/lib/simple_form/components/labels.rb

@@ -1,9 +1,7 @@
 module SimpleForm
   module Components
     module Labels
-      def self.included(base)
-        base.extend ClassMethods
-      end
+      extend ActiveSupport::Concern
 
       module ClassMethods #:nodoc:
         def translate_required_html
@@ -24,7 +22,7 @@ module SimpleForm
       end
 
       def label
-        @builder.label(label_target, label_text, label_html_options)
+        enabled_label
       end
 
       def label_text
@@ -43,6 +41,14 @@ module SimpleForm
 
     protected
 
+      def enabled_label
+        @builder.label(label_target, label_text, label_html_options)
+      end
+
+      def disabled_label
+        ""
+      end
+
       def raw_label_text #:nodoc:
         options[:label] || label_translation
       end

data/lib/simple_form/components/placeholders.rb

@@ -2,12 +2,18 @@ module SimpleForm
   module Components
     module Placeholders
       def placeholder
-        input_html_options[:placeholder] ||= placeholder_text if has_placeholder?
+        disabled_placeholder
+      end
+
+      private
+
+      def enabled_placeholder
+        input_html_options[:placeholder] ||= placeholder_text if placeholder_present?
         nil
       end
 
-      def has_placeholder?
-        false
+      def disabled_placeholder
+        nil
       end
 
       def placeholder_present?
@@ -15,7 +21,7 @@ module SimpleForm
       end
 
       def placeholder_text
-        @placeholder ||= options[:placeholder] || translate(:placeholders)
+        @placeholder_text ||= options[:placeholder] || translate(:placeholders)
       end
     end
   end

data/lib/simple_form/components.rb

@@ -7,4 +7,4 @@ module SimpleForm
     autoload :Placeholders, 'simple_form/components/placeholders'
     autoload :Wrapper,      'simple_form/components/wrapper'
   end
-end
+end

data/lib/simple_form/error_notification.rb

@@ -1,7 +1,7 @@
 module SimpleForm
   class ErrorNotification
     delegate :object, :object_name, :template, :to => :@builder
-    include SimpleForm::HasErrors
+    include SimpleForm::Helpers::HasErrors
 
     def initialize(builder, options)
       @builder = builder

data/lib/simple_form/form_builder.rb

@@ -5,13 +5,16 @@ module SimpleForm
     extend MapType
     include SimpleForm::Inputs
 
-    map_type :text, :file,                                    :to => SimpleForm::Inputs::MappingInput
-    map_type :string, :password, :email, :search, :tel, :url, :to => SimpleForm::Inputs::StringInput
-    map_type :integer, :decimal, :float,                      :to => SimpleForm::Inputs::NumericInput
-    map_type :select, :radio, :check_boxes,                   :to => SimpleForm::Inputs::CollectionInput
-    map_type :date, :time, :datetime,                         :to => SimpleForm::Inputs::DateTimeInput
-    map_type :country, :time_zone,                            :to => SimpleForm::Inputs::PriorityInput
-    map_type :boolean,                                        :to => SimpleForm::Inputs::BooleanInput
+    map_type :text,                                :to => SimpleForm::Inputs::TextInput
+    map_type :file,                                :to => SimpleForm::Inputs::FileInput
+    map_type :string, :email, :search, :tel, :url, :to => SimpleForm::Inputs::StringInput
+    map_type :password,                            :to => SimpleForm::Inputs::PasswordInput
+    map_type :integer, :decimal, :float,           :to => SimpleForm::Inputs::NumericInput
+    map_type :range,                               :to => SimpleForm::Inputs::RangeInput
+    map_type :select, :radio, :check_boxes,        :to => SimpleForm::Inputs::CollectionInput
+    map_type :date, :time, :datetime,              :to => SimpleForm::Inputs::DateTimeInput
+    map_type :country, :time_zone,                 :to => SimpleForm::Inputs::PriorityInput
+    map_type :boolean,                             :to => SimpleForm::Inputs::BooleanInput
 
     def self.discovery_cache
       @discovery_cache ||= {}
@@ -109,7 +112,7 @@ module SimpleForm
     #        name="user[name]" size="100" type="text" value="Carlos" />
     #
     def input_field(attribute_name, options={})
-      options[:input_html] = options.except(:as)
+      options[:input_html] = options.except(:as, :collection, :label_method, :value_method)
       options.merge!(:components => [:input], :wrapper => false)
       input(attribute_name, options)
     end
@@ -204,7 +207,7 @@ module SimpleForm
     #    f.error :name, :id => "cool_error"
     #
     def error(attribute_name, options={})
-      options[:error_html] = options.dup
+      options[:error_html] = options.except(:error_tag, :error_prefix, :error_method)
       column      = find_attribute_column(attribute_name)
       input_type  = default_input_type(attribute_name, column, options)
       SimpleForm::Inputs::Base.new(self, attribute_name, column, input_type, options).error
@@ -238,7 +241,7 @@ module SimpleForm
     #    f.hint "Don't forget to accept this"
     #
     def hint(attribute_name, options={})
-      options[:hint_html] = options.dup
+      options[:hint_html] = options.except(:hint_tag)
       if attribute_name.is_a?(String)
         options[:hint] = attribute_name
         attribute_name, column, input_type = nil, nil, nil

data/lib/simple_form/helpers/has_errors.rb

@@ -0,0 +1,15 @@
+module SimpleForm
+  module Helpers
+    module HasErrors
+      private
+
+      def errors
+        object.errors
+      end
+
+      def has_errors?
+        object && object.respond_to?(:errors) && errors.present?
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/maxlength.rb

@@ -0,0 +1,24 @@
+module SimpleForm
+  module Helpers
+    # Helper methods for maxlength.
+    module Maxlength #:nodoc:
+
+      private
+
+      def add_maxlength!
+        input_html_options[:maxlength] ||= maximum_length_from_validation || limit if SimpleForm.html5
+      end
+
+      def maximum_length_from_validation
+        return unless has_validators?
+
+        length_validator = find_length_validator or return
+        length_validator.options[:maximum]
+      end
+
+      def find_length_validator
+        find_validator(ActiveModel::Validations::LengthValidator)
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/pattern.rb

@@ -0,0 +1,28 @@
+module SimpleForm
+  module Helpers
+    # Helper methods for pattern.
+    module Pattern #:nodoc:
+      private
+
+      def add_pattern!
+        input_html_options[:pattern] ||= pattern_source if options[:pattern]
+      end
+
+      def pattern_source
+        if options[:pattern] == true
+          if has_validators? && pattern_validator
+            pattern_validator.options[:with].source
+          else
+            raise "Could not find format validator for #{attribute_name}"
+          end
+        else
+          options[:pattern]
+        end
+      end
+
+      def pattern_validator
+        @pattern_validator ||= find_validator(ActiveModel::Validations::FormatValidator)
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/required.rb

@@ -0,0 +1,36 @@
+module SimpleForm
+  module Helpers
+    module Required
+      private
+
+      def attribute_required?
+        @required
+      end
+
+      def calculate_required
+        if !options[:required].nil?
+          options[:required]
+        elsif has_validators?
+          (attribute_validators + reflection_validators).any? do |v|
+            v.kind == :presence && valid_validator?(v)
+          end
+        else
+          attribute_required_by_default?
+        end
+      end
+
+      # Whether this input is valid for HTML 5 required attribute.
+      def has_required?
+        attribute_required? && SimpleForm.html5 && SimpleForm.browser_validations
+      end
+
+      def attribute_required_by_default?
+        SimpleForm.required_by_default
+      end
+
+      def required_class
+        attribute_required? ? :required : :optional
+      end
+    end
+  end
+end

data/lib/simple_form/helpers/validators.rb

@@ -0,0 +1,44 @@
+module SimpleForm
+  module Helpers
+    module Validators
+      private
+
+      def has_validators?
+        attribute_name && object.class.respond_to?(:validators_on)
+      end
+
+      def attribute_validators
+        object.class.validators_on(attribute_name)
+      end
+
+      def reflection_validators
+        reflection ? object.class.validators_on(reflection.name) : []
+      end
+
+      def valid_validator?(validator)
+        !conditional_validators?(validator) && action_validator_match?(validator)
+      end
+
+      def conditional_validators?(validator)
+        validator.options.include?(:if) || validator.options.include?(:unless)
+      end
+
+      def action_validator_match?(validator)
+        return true if !validator.options.include?(:on)
+
+        case validator.options[:on]
+        when :save
+          true
+        when :create
+          !object.persisted?
+        when :update
+          object.persisted?
+        end
+      end
+
+      def find_validator(validator)
+        attribute_validators.find { |v| validator === v }
+      end
+    end
+  end
+end

data/lib/simple_form/helpers.rb

@@ -0,0 +1,9 @@
+module SimpleForm
+  module Helpers
+    autoload :HasErrors,    'simple_form/helpers/has_errors'
+    autoload :Maxlength,    'simple_form/helpers/maxlength'
+    autoload :Pattern,      'simple_form/helpers/pattern'
+    autoload :Validators,   'simple_form/helpers/validators'
+    autoload :Required,     'simple_form/helpers/required'
+  end
+end