simple_form 1.2.0 → 1.4.0

data/lib/generators/simple_form/USAGE

@@ -1,3 +1,3 @@
 To copy a SimpleForm initializer to your Rails App, with some configuration values, just do:
 
-    script/generate simple_form_install
+    rails generate simple_form:install

data/lib/generators/simple_form/install_generator.rb

@@ -2,10 +2,8 @@ module SimpleForm
   module Generators
     class InstallGenerator < Rails::Generators::Base
       desc "Copy SimpleForm default files"
-
-      def self.source_root
-        @_source_root = File.expand_path('../templates', __FILE__)
-      end
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :template_engine
 
       def copy_initializers
         copy_file 'simple_form.rb', 'config/initializers/simple_form.rb'
@@ -16,8 +14,9 @@ module SimpleForm
       end
 
       def copy_scaffold_template
-        copy_file '_form.html.erb', 'lib/templates/erb/scaffold/_form.html.erb'
+        engine = options[:template_engine]
+        copy_file "_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
       end
     end
   end
-end
+end

data/lib/generators/simple_form/templates/_form.html.erb

@@ -1,15 +1,5 @@
-<%%= simple_form_for(@<%= singular_name %>) do |f| %>
-  <%% if @<%= singular_name %>.errors.any? %>
-    <div id="error_explanation">
-      <h2><%%= pluralize(@<%= singular_name %>.errors.count, "error") %> prohibited this <%= singular_name %> from being saved:</h2>
-
-      <ul>
-      <%% @<%= singular_name %>.errors.full_messages.each do |msg| %>
-        <li><%%= msg %></li>
-      <%% end %>
-      </ul>
-    </div>
-  <%% end %>
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
 
   <div class="inputs">
   <%- attributes.each do |attribute| -%>

data/lib/generators/simple_form/templates/_form.html.haml

@@ -0,0 +1,10 @@
+= simple_form_for(@<%= singular_table_name %>) do |f|
+  = f.error_notification
+
+  .inputs
+  <%- attributes.each do |attribute| -%>
+    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
+  <%- end -%>
+
+  .actions
+    = f.button :submit

data/lib/generators/simple_form/templates/_form.html.slim

@@ -0,0 +1,10 @@
+= simple_form_for(@<%= singular_table_name %>) do |f|
+  = f.error_notification
+
+  .inputs
+  | <%- attributes.each do |attribute| -%>
+    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
+  | <%- end -%>
+
+  .actions
+    = f.button :submit

data/lib/generators/simple_form/templates/en.yml

@@ -8,3 +8,17 @@ en:
       # You can uncomment the line below if you need to overwrite the whole required html.
       # When using html, text and mark won't be used.
       # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Some errors were found, please take a look:"
+    # Labels and hints examples
+    # labels:
+    #   password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail para efetuar o sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   username: 'User name to sign in.'
+    #   password: 'No special characters, please.'
+

data/lib/generators/simple_form/templates/simple_form.rb

@@ -1,32 +1,83 @@
 # Use this setup block to configure all options available in SimpleForm.
 SimpleForm.setup do |config|
-
-  # Components used by the form builder to generate a complete input. You can
-  # remove any of them, change the order, or even add your own components in the
-  # stack. By inheriting your component from SimpleForm::Components::Base you'll
-  # have some extra helpers for free.
-  # config.components = [ :label, :input, :hint, :error ]
+  # Components used by the form builder to generate a complete input. You can remove
+  # any of them, change the order, or even add your own components to the stack.
+  # config.components = [ :placeholder, :label_input, :hint, :error ]
 
   # Default tag used on hints.
   # config.hint_tag = :span
 
+  # CSS class to add to all hint tags.
+  # config.hint_class = :hint
+
+  # CSS class used on errors.
+  # config.error_class = :error
+
   # Default tag used on errors.
   # config.error_tag = :span
 
+  # Method used to tidy up errors.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  # config.error_notification_tag = :p
+
+  # CSS class to add for error notification helper.
+  # config.error_notification_class = :error_notification
+
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+
   # You can wrap all inputs in a pre-defined tag.
   # config.wrapper_tag = :div
 
-  # How the label text should be generated altogether with the required text.
-  # config.label_text = lambda { |label, required| "#{required} #{label}" }
+  # CSS class to add to all wrapper tags.
+  # config.wrapper_class = :input
+
+  # CSS class to add to the wrapper if the field has errors.
+  # config.wrapper_error_class = :field_with_errors
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
 
-  # Series of attemps to detect a default label method for collection
+  # 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.
   # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
 
-  # Series of attemps to detect a default value method for collection
+  # Series of attemps 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.
+  # config.label_text = lambda { |label, required| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the class to use on all forms. Default is simple_form.
+  # config.form_class = :simple_form
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use default HTML5 validations (novalidate option).
+  # Default is enabled.
+  # config.browser_validations = true
+
+  # Determines whether HTML5 types (:email, :url, :search, :tel) and attributes
+  # (e.g. required) are used or not. True by default.
+  # Having this on in non-HTML5 compliant sites can cause odd behavior in
+  # HTML5-aware browsers such as Chrome.
+  # config.html5 = true
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
   # Collection of methods to detect if a file type was given.
-  # config.file_methods = [ :file?, :public_filename ]
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
 
   # Default priority for time_zone inputs.
   # config.time_zone_priority = nil
@@ -34,6 +85,9 @@ SimpleForm.setup do |config|
   # Default priority for country inputs.
   # config.country_priority = nil
 
-  # Default size for text inputs
+  # Default size for text inputs.
   # config.default_input_size = 50
+
+  # When false, do not use translations for labels, hints or placeholders.
+  # config.translate = true
 end

data/lib/simple_form/action_view_extensions/builder.rb

@@ -7,7 +7,9 @@ module SimpleForm
       # Create a collection of radio inputs for the attribute. Basically this
       # helper will create a radio input associated with a label for each
       # text/value option in the collection, using value_method and text_method
-      # to convert these text/value. Based on collection_select.
+      # to convert these text/value. You can give a symbol or a proc to both
+      # value_method and text_method, that will be evaluated for each item in
+      # the collection.
       #
       # == Examples
       #
@@ -29,34 +31,37 @@ module SimpleForm
       #   * disabled => the value or values that should be disabled. Accepts a single
       #                 item or an array of items.
       #
+      #   * collection_wrapper_tag => the tag to wrap the entire collection.
+      #
+      #   * item_wrapper_tag       => the tag to wrap each item in the collection.
+      #
       def collection_radio(attribute, collection, value_method, text_method, options={}, html_options={})
-        collection.map do |item|
-          value = item.send value_method
-          text  = item.send text_method
-
-          default_html_options = default_html_options_for_collection(item, value, options, html_options)
-
-          radio_button(attribute, value, default_html_options) <<
-            label("#{attribute}_#{value}", text, :class => "collection_radio")
-        end.join.html_safe
+        render_collection(
+          attribute, collection, value_method, text_method, options, html_options
+        ) do |value, text, default_html_options|
+          radio_button(attribute, value, default_html_options) +
+            label(sanitize_attribute_name(attribute, value), text, :class => "collection_radio")
+        end
       end
 
-      # Creates a collection of check boxes for each item in the collection, associated
-      # with a clickable label. Use value_method and text_method to convert items in
-      # the collection for use as text/value in check boxes.
+      # Creates a collection of check boxes for each item in the collection,
+      # associated with a clickable label. Use value_method and text_method to
+      # convert items in the collection for use as text/value in check boxes.
+      # You can give a symbol or a proc to both value_method and text_method,
+      # that will be evaluated for each item in the collection.
       #
       # == Examples
       #
       #   form_for @user do |f|
-      #     f.collection_check_box :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
+      #     f.collection_check_boxes :options, [[true, 'Yes'] ,[false, 'No']], :first, :last
       #   end
       #
       #   <input name="user[options][]" type="hidden" value="" />
       #   <input id="user_options_true" name="user[options][]" type="checkbox" value="true" />
-      #   <label class="collection_check_box" for="user_options_true">Yes</label>
+      #   <label class="collection_check_boxes" for="user_options_true">Yes</label>
       #   <input name="user[options][]" type="hidden" value="" />
       #   <input id="user_options_false" name="user[options][]" type="checkbox" value="false" />
-      #   <label class="collection_check_box" for="user_options_false">No</label>
+      #   <label class="collection_check_boxes" for="user_options_false">No</label>
       #
       # == Options
       #
@@ -68,17 +73,19 @@ module SimpleForm
       #   * disabled => the value or values that should be disabled. Accepts a single
       #                 item or an array of items.
       #
+      #   * collection_wrapper_tag => the tag to wrap the entire collection.
+      #
+      #   * item_wrapper_tag       => the tag to wrap each item in the collection.
+      #
       def collection_check_boxes(attribute, collection, value_method, text_method, options={}, html_options={})
-        collection.map do |item|
-          value = item.send value_method
-          text  = item.send text_method
-
-          default_html_options = default_html_options_for_collection(item, value, options, html_options)
+        render_collection(
+          attribute, collection, value_method, text_method, options, html_options
+        ) do |value, text, default_html_options|
           default_html_options[:multiple] = true
 
-          check_box(attribute, default_html_options, value, '') <<
-            label("#{attribute}_#{value}", text, :class => "collection_check_boxes")
-        end.join.html_safe
+          check_box(attribute, default_html_options, value, '') +
+            label(sanitize_attribute_name(attribute, value), text, :class => "collection_check_boxes")
+        end
       end
 
       # Wrapper for using simple form inside a default rails form.
@@ -92,31 +99,83 @@ module SimpleForm
       #   end
       def simple_fields_for(*args, &block)
         options = args.extract_options!
-        options[:builder] = SimpleForm::FormBuilder
+        if self.class < ActionView::Helpers::FormBuilder
+          options[:builder] ||= self.class
+        else
+          options[:builder] ||= SimpleForm::FormBuilder
+        end
         fields_for(*(args << options), &block)
       end
 
-      private
+    private
 
-        # Generate default options for collection helpers, such as :checked and
-        # :disabled.
-        def default_html_options_for_collection(item, value, options, html_options) #:nodoc:
-          returning(html_options.dup) do |default_html_options|
-            [:checked, :disabled].each do |option|
-              next unless options[option]
+      # Generate default options for collection helpers, such as :checked and
+      # :disabled.
+      def default_html_options_for_collection(item, value, options, html_options) #:nodoc:
+        html_options = html_options.dup
 
-              accept = if options[option].is_a?(Proc)
-                options[option].call(item)
-              else
-                Array(options[option]).include?(value)
-              end
+        [:checked, :disabled].each do |option|
+          next unless options[option]
 
-              default_html_options[option] = true if accept
-            end
+          accept = if options[option].is_a?(Proc)
+            options[option].call(item)
+          else
+            Array(options[option]).include?(value)
           end
+
+          html_options[option] = true if accept
         end
+
+        html_options
+      end
+
+      def sanitize_attribute_name(attribute, value)
+        "#{attribute}_#{value.to_s.gsub(/\s/, "_").gsub(/[^-\w]/, "").downcase}"
+      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
+
+        rendered_collection = collection.map do |item|
+          value = value_for_collection(item, value_method)
+          text  = value_for_collection(item, text_method)
+          default_html_options = default_html_options_for_collection(item, value, options, html_options)
+
+          rendered_item = yield value, text, default_html_options
+
+          item_wrapper_tag ? @template.content_tag(item_wrapper_tag, rendered_item) : rendered_item
+        end.join.html_safe
+
+        collection_wrapper_tag ? @template.content_tag(collection_wrapper_tag, rendered_collection) : rendered_collection
+      end
+
+      def value_for_collection(item, value) #:nodoc:
+        value.respond_to?(:call) ? value.call(item) : item.send(value)
+      end
     end
   end
 end
 
-ActionView::Helpers::FormBuilder.send :include, SimpleForm::ActionViewExtensions::Builder
+class ActionView::Helpers::FormBuilder
+  include SimpleForm::ActionViewExtensions::Builder
+
+  # Override default Rails collection_select helper to handle lambdas/procs in
+  # text and value methods, so it works the same way as collection_radio and
+  # collection_check_boxes in SimpleForm. If none of text/value methods is a
+  # callable object, then it just delegates back to original collection select.
+  #
+  alias :original_collection_select :collection_select
+  def collection_select(attribute, collection, value_method, text_method, options={}, html_options={})
+    if value_method.respond_to?(:call) || text_method.respond_to?(:call)
+      collection = collection.map do |item|
+        value = value_for_collection(item, value_method)
+        text  = value_for_collection(item, text_method)
+        [value, text]
+      end
+      value_method, text_method = :first, :last
+    end
+
+    original_collection_select(attribute, collection, value_method, text_method, options, html_options)
+  end
+end

data/lib/simple_form/action_view_extensions/form_helper.rb

@@ -1,7 +1,6 @@
 module SimpleForm
   module ActionViewExtensions
-    # This modules create simple form wrappers around default form_for,
-    # fields_for and remote_form_for.
+    # This module creates simple form wrappers around default form_for and fields_for.
     #
     # Example:
     #
@@ -10,19 +9,43 @@ module SimpleForm
     #   end
     #
     module FormHelper
-      [:form_for, :fields_for, :remote_form_for].each do |helper|
+      # based on what is done in formtastic
+      # http://github.com/justinfrench/formtastic/blob/master/lib/formtastic.rb#L1706
+      @@default_field_error_proc = nil
+
+      # Override the default ActiveRecordHelper behaviour of wrapping the input.
+      # This gets taken care of semantically by adding an error class to the wrapper tag
+      # containing the input.
+      #
+      FIELD_ERROR_PROC = proc do |html_tag, instance_tag|
+        html_tag
+      end
+
+      def with_custom_field_error_proc(&block)
+        @@default_field_error_proc = ::ActionView::Base.field_error_proc
+        ::ActionView::Base.field_error_proc = FIELD_ERROR_PROC
+        result = yield
+        ::ActionView::Base.field_error_proc = @@default_field_error_proc
+        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
+            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][:class] = "simple_form \#{css_class} \#{options[:html][:class]}".strip
-            #{helper}(record_or_name_or_array, *(args << options), &block)
+            options[:html][:novalidate] = !SimpleForm.browser_validations
+            options[:html][:class] = "\#{SimpleForm.form_class} \#{css_class} \#{options[:html][:class]}".strip
+
+            with_custom_field_error_proc do
+              #{helper}(record_or_name_or_array, *(args << options), &block)
+            end
           end
         METHOD
       end

data/lib/simple_form/components/errors.rb

@@ -1,8 +1,10 @@
 module SimpleForm
   module Components
     module Errors
+      include SimpleForm::HasErrors
+
       def error
-        template.content_tag(error_tag, error_text, error_html_options) if object && errors.present?
+        template.content_tag(error_tag, error_text, error_html_options) if has_errors?
       end
 
       def error_tag
@@ -10,11 +12,19 @@ module SimpleForm
       end
 
       def error_text
-        errors.to_sentence
+        if options[:error_prefix]
+          options[:error_prefix] + " " + errors.send(error_method)
+        else
+          errors.send(error_method)
+        end
+      end
+
+      def error_method
+        options[:error_method] || SimpleForm.error_method
       end
 
       def error_html_options
-        html_options_for(:error, :error)
+        html_options_for(:error, [SimpleForm.error_class])
       end
 
     protected
@@ -24,12 +34,12 @@ module SimpleForm
       end
 
       def errors_on_attribute
-        Array(object.errors[attribute_name])
+        object.errors[attribute_name]
       end
 
       def errors_on_association
-        reflection ? Array(object.errors[reflection.name]) : []
+        reflection ? object.errors[reflection.name] : []
       end
     end
   end
-end
+end

data/lib/simple_form/components/hints.rb

@@ -14,8 +14,8 @@ module SimpleForm
       end
 
       def hint_html_options
-        html_options_for(:hint, :hint)
+        html_options_for(:hint, [SimpleForm.hint_class])
       end
     end
   end
-end
+end

data/lib/simple_form/components/label_input.rb

@@ -0,0 +1,13 @@
+module SimpleForm
+  module Components
+    module LabelInput
+      def self.included(base)
+        base.send :include, SimpleForm::Components::Labels
+      end
+
+      def label_input
+        (options[:label] == false ? "" : label) + input
+      end
+    end
+  end
+end

data/lib/simple_form/components/labels.rb

@@ -36,8 +36,8 @@ module SimpleForm
       end
 
       def label_html_options
-        label_options = html_options_for(:label, input_type, required_class)
-        label_options[:for] = options[:input_html][:id] if options.key?(:input_html)
+        label_options = html_options_for(:label, [input_type, required_class, SimpleForm.label_class])
+        label_options[:for] = options[:input_html][:id] if options.key?(:input_html) && options[:input_html].key?(:id)
         label_options
       end
 
@@ -52,16 +52,14 @@ module SimpleForm
         attribute_required? ? self.class.translate_required_html.dup : ''
       end
 
-      # First check human attribute name and then labels.
+      # First check labels translation and then human attribute name.
       def label_translation #:nodoc:
-        default = if object.class.respond_to?(:human_attribute_name)
+        translate(:labels) || if object.class.respond_to?(:human_attribute_name)
           object.class.human_attribute_name(reflection_or_attribute_name.to_s)
         else
           attribute_name.to_s.humanize
         end
-
-        translate(:labels, default)
       end
     end
   end
-end
+end

data/lib/simple_form/components/placeholders.rb

@@ -0,0 +1,22 @@
+module SimpleForm
+  module Components
+    module Placeholders
+      def placeholder
+        input_html_options[:placeholder] ||= placeholder_text if has_placeholder?
+        nil
+      end
+
+      def has_placeholder?
+        false
+      end
+
+      def placeholder_present?
+        options[:placeholder] != false && placeholder_text.present?
+      end
+
+      def placeholder_text
+        @placeholder ||= options[:placeholder] || translate(:placeholders)
+      end
+    end
+  end
+end

data/lib/simple_form/components/wrapper.rb

@@ -13,9 +13,26 @@ module SimpleForm
         options[:wrapper_tag] || SimpleForm.wrapper_tag
       end
 
+      def wrapper_class
+        options[:wrapper_class] || SimpleForm.wrapper_class
+      end
+
+      def wrapper_error_class
+        options[:wrapper_error_class] || SimpleForm.wrapper_error_class
+      end
+
       def wrapper_html_options
-        html_options_for(:wrapper, "input", input_type, required_class)
+        css_classes = input_html_classes.unshift(wrapper_class)
+        css_classes << wrapper_error_class if has_errors?
+        css_classes << disabled_class if disabled?
+        html_options_for(:wrapper, css_classes)
+      end
+
+    private
+
+      def disabled_class
+        'disabled'
       end
     end
   end
-end
+end

data/lib/simple_form/components.rb

@@ -1,8 +1,10 @@
 module SimpleForm
   module Components
-    autoload :Errors,  'simple_form/components/errors'
-    autoload :Hints,   'simple_form/components/hints'
-    autoload :Labels,  'simple_form/components/labels'
-    autoload :Wrapper, 'simple_form/components/wrapper'
+    autoload :Errors,       'simple_form/components/errors'
+    autoload :Hints,        'simple_form/components/hints'
+    autoload :LabelInput,   'simple_form/components/label_input'
+    autoload :Labels,       'simple_form/components/labels'
+    autoload :Placeholders, 'simple_form/components/placeholders'
+    autoload :Wrapper,      'simple_form/components/wrapper'
   end
 end

data/lib/simple_form/error_notification.rb

@@ -0,0 +1,42 @@
+module SimpleForm
+  class ErrorNotification
+    delegate :object, :object_name, :template, :to => :@builder
+    include SimpleForm::HasErrors
+
+    def initialize(builder, options)
+      @builder = builder
+      @message = options.delete(:message)
+      @options = options
+    end
+
+    def render
+      if has_errors?
+        template.content_tag(error_notification_tag, error_message, html_options)
+      end
+    end
+
+    protected
+
+    def error_message
+      @message || translate_error_notification
+    end
+
+    def error_notification_tag
+      SimpleForm.error_notification_tag
+    end
+
+    def html_options
+      @options[:class] = "#{SimpleForm.error_notification_class} #{@options[:class]}".strip
+      @options[:id] = SimpleForm.error_notification_id if SimpleForm.error_notification_id
+      @options
+    end
+
+    def translate_error_notification
+      lookups = []
+      lookups << :"#{object_name}"
+      lookups << :default_message
+      lookups << "Some errors were found, please take a look:"
+      I18n.t(lookups.shift, :scope => :"simple_form.error_notification", :default => lookups)
+    end
+  end
+end