simple_form 1.2.2 → 1.3.0

data/README.rdoc

@@ -4,6 +4,28 @@ 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, 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.
 
+== Information
+
+=== Google Group
+
+If you have any questions, comments, or concerns please use the Google Group instead of the GitHub Issues tracker:
+
+http://groups.google.com/group/plataformatec-simpleform
+
+=== RDocs
+
+You can view the SimpleForm documentation in RDoc format here:
+
+http://rubydoc.info/github/plataformatec/simple_form/master/frames
+
+If you need to use SimpleForm with Rails 2.3, you can always run `gem server` from the command line after you install the gem to access the old documentation.
+
+=== Bug reports
+
+If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug. We also encourage you to help even more by forking and sending us a pull request.
+
+http://github.com/plataformatec/simple_form/issues
+
 == Installation
 
 Install the gem:
@@ -18,6 +40,10 @@ Run the generator:
 
   rails generate simple_form:install
 
+Also, if you want to use the country select, you will need the country_select plugin, install with following command:
+
+  rails plugin install git://github.com/rails/country_select.git
+
 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:
 
@@ -37,11 +63,12 @@ To start using SimpleForm you just have to use the helper it provides:
 
 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:
+You can overwrite the default label by passing it to the input method, add a hint or even a placeholder:
 
   <%= simple_form_for @user do |f| %>
     <%= f.input :username, :label => 'Your username please' %>
     <%= f.input :password, :hint => 'No special characters.' %>
+    <%= f.input :email, :placeholder => 'user@domain.com' %>
     <%= f.button :submit %>
   <% end %>
 
@@ -54,6 +81,15 @@ You can also disable labels, hints or error or configure the html of any of them
     <%= f.button :submit %>
   <% end %>
 
+It is also possible to pass any html attribute straight to the input, by using the :input_html option, for instance:
+
+  <%= simple_form_for @user do |f| %>
+    <%= f.input :username, :input_html => { :class => 'special' } %>
+    <%= f.input :password, :input_html => { :maxlength => 20 } %>
+    <%= f.input :remember_me, :input_html => { :value => '1' } %>
+    <%= f.button :submit %>
+  <% 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| %>
@@ -75,6 +111,22 @@ SimpleForm also lets you overwrite the default input type it creates:
 
 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.
 
+It is also possible to give the :disabled option to SimpleForm, and it'll automatically mark the wrapper as disabled with a css class, so you can style labels, hints and other components inside the wrapper as well:
+
+  <%= simple_form_for @user do |f| %>
+    <%= f.input :username, :disabled => true, :hint => "You cannot change your username." %>
+    <%= f.button :submit %>
+  <% end %>
+
+SimpleForm accepts same options as their corresponding input type helper in Rails:
+
+  <%= simple_form_for @user do |f| %>
+    <%= f.input :date_of_birth, :as => :date, :start_year => Date.today.year - 90,
+                                :end_year => Date.today.year - 12, :discard_day => true,
+                                :order => [:month, :year] %>
+    <%= f.button :submit %>
+  <% end %>
+
 SimpleForm also allows you using label, hint and error helpers it provides:
 
   <%= simple_form_for @user do |f| %>
@@ -105,7 +157,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. 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 except lambda/procs incase 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"
 
@@ -212,7 +264,7 @@ Creates a collection of radio inputs with labels associated (same API as collect
 Creates a collection of check boxes with labels associated (same API as collection_select):
 
   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="" />
@@ -232,7 +284,9 @@ SimpleForm comes with a lot of default mappings:
   string                text field              string
   email                 email field             string with name matching "email"
   url                   url field               string with name matching "url"
+  tel                   tel field               string with name matching "phone"
   password              password field          string with name matching "password"
+  search                search                  -
   text                  text area               text
   file                  file field              string, responding to file methods
   hidden                hidden field            -
@@ -250,7 +304,7 @@ SimpleForm comes with a lot of default mappings:
 
 == I18n
 
-SimpleForm uses all power of I18n API to lookup labels and hints for you. To customize your forms you can create a locale file like this:
+SimpleForm uses all power of I18n API to lookup labels, hints and placeholders. To customize your forms you can create a locale file like this:
 
   en:
     simple_form:
@@ -262,10 +316,14 @@ SimpleForm uses all power of I18n API to lookup labels and hints for you. To cus
         user:
           username: 'User name to sign in.'
           password: 'No special characters, please.'
+      placeholders:
+        user:
+          username: 'Your username'
+          password: '****'
 
-And your forms will use this information to render labels and hints for you.
+And your forms will use this information to render the components for you.
 
-SimpleForm also lets you be more specific, separating lookups through actions for both hint and label. Let's say you want a different label for new and edit actions, the locale file would be something like:
+SimpleForm also lets you be more specific, separating lookups through actions for labels, hints and placeholders. Let's say you want a different label for new and edit actions, the locale file would be something like:
 
   en:
     simple_form:
@@ -287,12 +345,24 @@ This way SimpleForm will figure out the right translation for you, based on the
       hints:
         username: 'User name to sign in.'
         password: 'No special characters, please.'
+      placeholders:
+        username: 'Your username'
+        password: '****'
+
+SimpleForm will always look for a default attribute translation if no specific is found inside the model key. In addition, SimpleForm will fallback to default human_attribute_name from Rails when no other translation is found for labels.
 
-SimpleForm will always look for a default attribute translation if no specific is found inside the model key. In addition, SimpleForm will fallback to default human_attribute_name from Rails when no other translation is found.
+Finally, you can also overwrite any label, hint or placeholder inside your view, just by passing the option manually. This way the I18n lookup will be skipped.
 
-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.
+It's also possible to translate buttons, using Rails' built-in I18n support:
 
-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".
+  en:
+    helpers:
+      submit:
+        user:
+          create: "Add %{model}"
+          update: "Save Changes"
+
+There are other options that can be configured through I18n API, such as required text and boolean. Be sure to check our locale file or the one copied to your application after you run "rails generate simple_form:install".
 
 == Configuration
 
@@ -309,10 +379,6 @@ Please refer to TODO file.
 * José Valim (http://github.com/josevalim)
 * Carlos Antonio da Silva (http://github.com/carlosantoniodasilva)
 
-== Bugs and Feedback
-
-If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
-
-http://github.com/plataformatec/simple_form/issues
+== License
 
 MIT License. Copyright 2010 Plataforma Tecnologia. http://blog.plataformatec.com.br

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 %>
+  <%%= f.error_notification %>
 
   <div class="inputs">
   <%- attributes.each do |attribute| -%>

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

@@ -1,13 +1,18 @@
 # 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 to the stack.
-  # config.components = [ :label_input, :hint, :error ]
+  # 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
+
+  # Default tag used on errors.
+  # config.error_class = :error
+
   # Default tag used on errors.
   # config.error_tag = :span
 
@@ -17,6 +22,12 @@ SimpleForm.setup do |config|
   # 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
 
@@ -26,11 +37,11 @@ SimpleForm.setup do |config|
   # 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}" }
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
 
-  # Whether attributes are required by default (or not). Default is true.
-  # config.required_by_default = true
+  # You can wrap each item in a collection of radio/check boxes with a tag, defaulting to none.
+  # config.item_wrapper_tag = nil
 
   # Series of attemps to detect a default label method for collection.
   # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
@@ -38,6 +49,17 @@ SimpleForm.setup do |config|
   # 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}" }
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = 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 ]
 
@@ -49,4 +71,7 @@ SimpleForm.setup do |config|
 
   # 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.rb

@@ -6,6 +6,7 @@ module SimpleForm
   autoload :Components,        'simple_form/components'
   autoload :ErrorNotification, 'simple_form/error_notification'
   autoload :FormBuilder,       'simple_form/form_builder'
+  autoload :HasErrors,         'simple_form/has_errors'
   autoload :I18nCache,         'simple_form/i18n_cache'
   autoload :Inputs,            'simple_form/inputs'
   autoload :MapType,           'simple_form/map_type'
@@ -14,10 +15,18 @@ module SimpleForm
   mattr_accessor :hint_tag
   @@hint_tag = :span
 
+  # CSS class to add to all hint tags.
+  mattr_accessor :hint_class
+  @@hint_class = :hint
+
   # Default tag used on errors.
   mattr_accessor :error_tag
   @@error_tag = :span
 
+  # CSS class to add to all error tags.
+  mattr_accessor :error_class
+  @@error_class = :error
+
   # Method used to tidy up errors.
   mattr_accessor :error_method
   @@error_method = :first
@@ -26,9 +35,17 @@ module SimpleForm
   mattr_accessor :error_notification_tag
   @@error_notification_tag = :p
 
+  # CSS class to add for error notification helper.
+  mattr_accessor :error_notification_class
+  @@error_notification_class = :error_notification
+
+  # ID to add for error notification helper.
+  mattr_accessor :error_notification_id
+  @@error_notification_id = nil
+
   # Components used by the form builder.
   mattr_accessor :components
-  @@components = [ :label_input, :hint, :error ]
+  @@components = [ :placeholder, :label_input, :hint, :error ]
 
   # Series of attemps to detect a default label method for collection.
   mattr_accessor :collection_label_methods
@@ -38,6 +55,14 @@ module SimpleForm
   mattr_accessor :collection_value_methods
   @@collection_value_methods = [ :id, :to_s ]
 
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  mattr_accessor :collection_wrapper_tag
+  @@collection_wrapper_tag = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag, defaulting to none.
+  mattr_accessor :item_wrapper_tag
+  @@item_wrapper_tag = nil
+
   # You can wrap all inputs in a pre-defined tag. Default is a div.
   mattr_accessor :wrapper_tag
   @@wrapper_tag = :div
@@ -46,7 +71,7 @@ module SimpleForm
   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.
+  # You can define the class to add to the wrapper when the field has errors. Default is field_with_errors.
   mattr_accessor :wrapper_error_class
   @@wrapper_error_class = :field_with_errors
 
@@ -62,6 +87,12 @@ module SimpleForm
   mattr_accessor :file_methods
   @@file_methods = [ :mounted_as, :file?, :public_filename ]
 
+  # 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, such as { /count/ => :integer }.
+  mattr_accessor :input_mappings
+  @@input_mappings = nil
+
   # Default priority for time_zone inputs.
   mattr_accessor :time_zone_priority
   @@time_zone_priority = nil
@@ -74,6 +105,11 @@ module SimpleForm
   mattr_accessor :default_input_size
   @@default_input_size = 50
 
+  # When off, do not use translations in hint, labels and placeholders.
+  # It is a small performance improvement if you are not using such features.
+  mattr_accessor :translate
+  @@translate = true
+
   # Default way to setup SimpleForm. Run rails generate simple_form:install
   # to create a fresh initializer with all configuration values.
   def self.setup

data/lib/simple_form/action_view_extensions/builder.rb

@@ -29,16 +29,17 @@ 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 = radio_button(attribute, value, default_html_options)
+          collection_label(attribute, value, radio, text, :class => "collection_radio")
+        end
       end
 
       # Creates a collection of check boxes for each item in the collection, associated
@@ -48,15 +49,15 @@ module SimpleForm
       # == 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 +69,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 = check_box(attribute, default_html_options, value, '')
+          collection_label(attribute, value, check_box, text, :class => "collection_check_boxes")
+        end
       end
 
       # Wrapper for using simple form inside a default rails form.
@@ -98,6 +101,11 @@ module SimpleForm
 
     private
 
+      # Wraps the given component in a label, for better accessibility with collections.
+      def collection_label(attribute, value, component_tag, label_text, html_options) #:nodoc:
+        label(sanitize_attribute_name(attribute, value), component_tag << label_text.to_s, html_options)
+      end
+
       # Generate default options for collection helpers, such as :checked and
       # :disabled.
       def default_html_options_for_collection(item, value, options, html_options) #:nodoc:
@@ -117,6 +125,31 @@ module SimpleForm
 
         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