simple_form 1.2.0 → 1.2.1

data/README.rdoc

@@ -2,13 +2,13 @@
 
 Forms made easy (for Rails)!
 
-SimpleForm aims to be as flexible as possible while helping you with powerful components to create your forms. The basic goal of simple form is to not touch your way of defining the layout, this way letting you find how you find the better design for your eyes. Good part of the DSL was inherited from Formtastic, which we are thankful for and should make you feel right at home.
+SimpleForm aims to be as flexible as possible while helping you with powerful components to create your forms. The basic goal of simple form is to not touch your way of defining the layout, letting you find the better design for your eyes. Good part of the DSL was inherited from Formtastic, which we are thankful for and should make you feel right at home.
 
 == Installation
 
 Install the gem:
 
-  sudo gem install simple_form
+  gem install simple_form
 
 Add it to your Gemfile:
 
@@ -18,7 +18,7 @@ Run the generator:
 
   rails generate simple_form:install
 
-And you are ready to go. Since this branch is aims Rails 3 support,
+And you are ready to go. Since this branch aims Rails 3 support,
 if you want to use it with Rails 2.3 you should check this branch:
 
   http://github.com/plataformatec/simple_form/tree/v1.0
@@ -29,61 +29,61 @@ SimpleForm was designed to be customized as you need to. Basically it's a stack
 
 To start using SimpleForm you just have to use the helper it provides:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :username %>
     <%= f.input :password %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 This will generate an entire form with labels for user name and password as well, and render errors by default when you render the form with invalid data (after submitting for example).
 
 You can overwrite the default label by passing it to the input method, or even add a hint:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :username, :label => 'Your username please' %>
     <%= f.input :password, :hint => 'No special characters.' %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 You can also disable labels, hints or error or configure the html of any of them:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :username, :label_html => { :class => 'my_class' } %>
     <%= f.input :password, :hint => false, :error_html => { :id => "password_error"} %>
     <%= f.input :password_confirmation, :label => false %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 By default all inputs are required, which means an * is prepended to the label, but you can disable it in any input you want:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :name, :required => false %>
     <%= f.input :username %>
     <%= f.input :password %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 SimpleForm also lets you overwrite the default input type it creates:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :username %>
     <%= f.input :password %>
     <%= f.input :description, :as => :text %>
     <%= f.input :accepts,     :as => :radio %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 So instead of a checkbox for the :accepts attribute, you'll have a pair of radio buttons with yes/no labels and a text area instead of a text field for the description. You can also render boolean attributes using :as => :select to show a dropdown.
 
 SimpleForm also allows you using label, hint and error helpers it provides:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.label :username %>
     <%= f.text_field :username %>
     <%= f.error :username, :id => 'user_name_error' %>
     <%= f.hint 'No special characters, please!' %>
     <%= f.submit 'Save' %>
-  <% end -%>
+  <% end %>
 
 Any extra option passed to label, hint or error will be rendered as html option.
 
@@ -91,11 +91,11 @@ Any extra option passed to label, hint or error will be rendered as html option.
 
 And what if you want to create a select containing the age from 18 to 60 in your form? You can do it overriding the :collection option:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :user %>
     <%= f.input :age, :collection => 18..60 %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 Collections can be arrays or ranges, and when a :collection is given the :select input will be rendered by default, so we don't need to pass the :as => :select option. Other types of collection are :radio and :check_boxes. Those are added by SimpleForm to Rails set of form helpers (read Extra Helpers session below for more information).
 
@@ -125,17 +125,17 @@ The first step is to configure a wrapper tag:
 
   SimpleForm.wrapper_tag = :p
 
-And now, you don't need to wrap your f.input calls with  anymore:
+And now, you don't need to wrap your f.input calls anymore:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :username %>
     <%= f.input :password %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 == Associations
 
-To deal with associations, SimpleForm can generate select inputs or a series of radios or check boxes. Lets see how it works: imagine you have the user model that belongs to a company and has_and_belongs_to_many roles. The structure should be something like:
+To deal with associations, SimpleForm can generate select inputs, a series of radios or check boxes. Lets see how it works: imagine you have a user model that belongs to a company and has_and_belongs_to_many roles. The structure would be something like:
 
   class User < ActiveRecord::Base
     belongs_to :company
@@ -152,17 +152,17 @@ To deal with associations, SimpleForm can generate select inputs or a series of
 
 Now we have the user form:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :name %>
     <%= f.association :company %>
     <%= f.association :roles %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 Simple enough right? This is going to render a :select input for choosing the :company, and another :select input with :multiple option for the :roles. You can of course change it, to use radios and check boxes as well:
 
   f.association :company, :as => :radio
-  f.association :roles, :as => :check_boxes
+  f.association :roles,   :as => :check_boxes
 
 The association helper just invokes input under the hood, so all options available to :select, :radio and :check_boxes are also available to association. Additionally, you can specify the collection by hand, all together with the prompt:
 
@@ -172,10 +172,10 @@ The association helper just invokes input under the hood, so all options availab
 
 All web forms need buttons, right? SimpleForm wraps them in the DSL, acting like a proxy:
 
-  <% simple_form_for @user do |f| -%>
+  <%= simple_form_for @user do |f| %>
     <%= f.input :name %>
     <%= f.button :submit %>
-  <% end -%>
+  <% end %>
 
 The above will simply call submit. You choose to use it or not, it's just a question of taste.
 
@@ -236,9 +236,9 @@ SimpleForm comes with a lot of default mappings:
   text                  text area               text
   file                  file field              string, responding to file methods
   hidden                hidden field            -
-  integer               text field              integer
-  float                 text field              float
-  decimal               text field              decimal
+  integer               number field            integer
+  float                 number field            float
+  decimal               number field            decimal
   datetime              datetime select         datetime/timestamp
   date                  date select             date
   time                  time select             time
@@ -292,7 +292,7 @@ SimpleForm will always look for a default attribute translation if no specific i
 
 Finally, you can also overwrite labels and hints inside your view, just by passing the label/hint manually. This way the I18n lookup will be skipped.
 
-There are other options that can be configured through I18n API, such as required text, boolean and button texts. Be sure to check our locale file or the one copied to your application after you run "script/generate simple_form_install".
+There are other options that can be configured through I18n API, such as required text, boolean and button texts. Be sure to check our locale file or the one copied to your application after you run "rails generate simple_form:install".
 
 == Configuration
 

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.haml

@@ -0,0 +1,18 @@
+= simple_form_for(@<%= singular_name %>) do |f|
+  - if @<%= singular_name %>.errors.any?
+    #error_explanation
+      %h2
+        = pluralize(@<%= singular_name %>.errors.count, "error")
+        prohibited this <%= singular_name %> from being saved:
+
+      %ul
+      - @<%= singular_name %>.errors.full_messages.each do |msg|
+        %li= msg
+
+  .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,11 +1,9 @@
 # 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 = [ :label_input, :hint, :error ]
 
   # Default tag used on hints.
   # config.hint_tag = :span
@@ -13,16 +11,31 @@ SimpleForm.setup do |config|
   # 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
+
   # You can wrap all inputs in a pre-defined tag.
   # config.wrapper_tag = :div
 
+  # 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
+
   # How the label text should be generated altogether with the required text.
   # config.label_text = lambda { |label, required| "#{required} #{label}" }
 
-  # Series of attemps to detect a default label method for collection
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # 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 ]
 
   # Collection of methods to detect if a file type was given.
@@ -34,6 +47,6 @@ 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
 end

data/lib/simple_form.rb

@@ -3,11 +3,12 @@ require 'simple_form/action_view_extensions/form_helper'
 require 'simple_form/action_view_extensions/builder'
 
 module SimpleForm
-  autoload :Components,  'simple_form/components'
-  autoload :FormBuilder, 'simple_form/form_builder'
-  autoload :I18nCache,   'simple_form/i18n_cache'
-  autoload :Inputs,      'simple_form/inputs'
-  autoload :MapType,     'simple_form/map_type'
+  autoload :Components,        'simple_form/components'
+  autoload :ErrorNotification, 'simple_form/error_notification'
+  autoload :FormBuilder,       'simple_form/form_builder'
+  autoload :I18nCache,         'simple_form/i18n_cache'
+  autoload :Inputs,            'simple_form/inputs'
+  autoload :MapType,           'simple_form/map_type'
 
   # Default tag used on hints.
   mattr_accessor :hint_tag
@@ -17,9 +18,17 @@ module SimpleForm
   mattr_accessor :error_tag
   @@error_tag = :span
 
+  # Method used to tidy up errors.
+  mattr_accessor :error_method
+  @@error_method = :first
+
+  # Default tag used for error notification helper.
+  mattr_accessor :error_notification_tag
+  @@error_notification_tag = :p
+
   # Components used by the form builder.
   mattr_accessor :components
-  @@components = [ :label, :input, :hint, :error ]
+  @@components = [ :label_input, :hint, :error ]
 
   # Series of attemps to detect a default label method for collection.
   mattr_accessor :collection_label_methods
@@ -29,14 +38,26 @@ module SimpleForm
   mattr_accessor :collection_value_methods
   @@collection_value_methods = [ :id, :to_s ]
 
-  # You can wrap all inputs in a pre-defined tag. By default is nil.
+  # You can wrap all inputs in a pre-defined tag. Default is a div.
   mattr_accessor :wrapper_tag
   @@wrapper_tag = :div
 
+  # You can define the class to use on all wrappers. Default is input.
+  mattr_accessor :wrapper_class
+  @@wrapper_class = :input
+
+  # You can define the class to add to the wrapper when the field has errors. Default is fieldWithErrors.
+  mattr_accessor :wrapper_error_class
+  @@wrapper_error_class = :field_with_errors
+
   # How the label text should be generated altogether with the required text.
   mattr_accessor :label_text
   @@label_text = lambda { |label, required| "#{required} #{label}" }
 
+  # Whether attributes are required by default (or not).
+  mattr_accessor :required_by_default
+  @@required_by_default = true
+
   # Collection of methods to detect if a file type was given.
   mattr_accessor :file_methods
   @@file_methods = [ :mounted_as, :file?, :public_filename ]
@@ -53,7 +74,7 @@ module SimpleForm
   mattr_accessor :default_input_size
   @@default_input_size = 50
 
-  # Default way to setup SimpleForm. Run script/generate simple_form_install
+  # Default way to setup SimpleForm. Run rails generate simple_form:install
   # to create a fresh initializer with all configuration values.
   def self.setup
     yield self

data/lib/simple_form/action_view_extensions/form_helper.rb

@@ -10,6 +10,26 @@ module SimpleForm
     #   end
     #
     module FormHelper
+      # 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, :remote_form_for].each do |helper|
         class_eval <<-METHOD, __FILE__, __LINE__
           def simple_#{helper}(record_or_name_or_array, *args, &block)
@@ -22,7 +42,10 @@ module SimpleForm
             end
             options[:html] ||= {}
             options[:html][:class] = "simple_form \#{css_class} \#{options[:html][:class]}".strip
-            #{helper}(record_or_name_or_array, *(args << options), &block)
+
+            with_custom_field_error_proc do
+              #{helper}(record_or_name_or_array, *(args << options), &block)
+            end
           end
         METHOD
       end

data/lib/simple_form/components.rb

@@ -1,8 +1,9 @@
 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 :Wrapper,    'simple_form/components/wrapper'
   end
 end

data/lib/simple_form/components/errors.rb

@@ -2,7 +2,7 @@ module SimpleForm
   module Components
     module Errors
       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,25 +10,33 @@ module SimpleForm
       end
 
       def error_text
-        errors.to_sentence
+        errors.send(error_method)
+      end
+
+      def error_method
+        options[:error_method] || SimpleForm.error_method
       end
 
       def error_html_options
-        html_options_for(:error, :error)
+        html_options_for(:error, [:error])
       end
 
     protected
 
+      def has_errors?
+        object && errors.present?
+      end
+
       def errors
         @errors ||= (errors_on_attribute + errors_on_association).compact
       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