better_form 0.5.1 → 0.6.1

data/README.md

@@ -0,0 +1,94 @@
+better_form Readme
+==================
+
+A Rails 3 gem to build DRY forms with Javascript validation.
+
+* Javascript validates form fields as they are completed, using your `ActiveModel` validators
+* Well-placed validation output
+* Automatic label generation
+* Form field descriptions
+
+Links
+=====
+
+* Online documentation: [http://rdoc.info/projects/2suggestions/better_form](http://rdoc.info/projects/2suggestions/better_form)
+* Source code: [http://github.com/2suggestions/better_form](http://github.com/2suggestions/better_form)
+* Bug/Feature tracking: [http://github.com/2suggestions/better_form/issues](http://github.com/2suggestions/better_form/issues)
+
+Installation and Usage
+======================
+
+Add `better_form` to your Gemfile:
+
+    gem 'better_form'
+
+And run the usual `bundle install`.
+
+Use the `better_form_for` method to create a better form:
+
+    = better_form_for @user do |f|
+
+Create fields using the usual Rails methods:
+
+    = f.text_field :name
+    = f.email_field :email
+    = f.password_field :password
+
+Labels
+------
+
+Fields will automatically have labels generated for them, with the label text defaulting to the attribute that the field is for:
+
+    = f.text_field :name
+
+    <label for='user_name'>Name</label>
+    <input type='text' id='user_name' name='user[name]' />
+
+To specify your own label text, pass a string as the `:label` option:
+
+    = f.text_field :name, :label => "What shall we call you?"
+
+    <label for='user_name'>What shall we call you?</label>
+    <input type='text' id='user_name' name='user[name]' />
+
+To skip label generation for a specific field, pass `false` as the `:label` option:
+
+    = f.text_field :name, :label => false
+
+    <input type='text' id='user_name' name='user[name]' />
+
+You can set the default for the entire form in the same way. Field-level `:label` options will override the default value. For example:
+
+    # Don't generate labels for this form, unless instructed to for a specific field
+    = better_form_for @user, :label => false do |f|
+      = f.text_field :name
+      = f.email_field :email, :label => true
+      = f.password_field :password, :label => 'Pick a strong password'
+
+    <input type='text' id='user_name' name='user[name]' />
+
+    <label for='user_email'>Email</label>
+    <input type='email' id='user_email' name='user[email]' />
+
+    <label for='user_password'>Pick a strong password</label>
+    <input type='password' id='user_password' name='user[password]' />
+
+Validations
+-----------
+
+Fields will automatically have validation data generated for them using the validations defined in your models:
+
+    class User < ActiveRecord::Base
+      validates :name, :presence => true
+    end
+
+    = f.text_field :name
+
+    <label for='user_name'>What shall we call you?</label>
+    <input type='text' id='user_name' name='user[name]' data-validates-presence="Name is required" />
+
+Setting a custom error message will be reflected in the validation that is generated:
+
+    validates :name, :presence => { :message => 'Please enter your full name' }
+
+    <input type='text' id='user_name' name='user[name]' data-validates-presence="Please enter your full name" />

data/lib/better_form/builder.rb

@@ -6,25 +6,47 @@ module BetterForm
     helpers.each do |field_type|
       define_method(field_type) do |field_name, *args|
         options = args.extract_options!
-        validations = generate_validations(@object, field_name)
-        options.merge!(validations)
+
+        # Extract the prefix and suffix (if any), and make them html_safe
+        prefix = (options.delete(:prefix) || '').html_safe
+        suffix = (options.delete(:suffix) || '').html_safe
+        description = (options.delete(:description) || '').html_safe
+
+        # Extract the label argument and validate argument
         label = options.delete(:label)
+        validate = options.delete(:validate)
+
+        error_message = ''.html_safe
 
-        unless @object.errors[field_name].blank?
-          css_classes = options.delete(:class)
-          options.merge!({ :class => "#{css_classes} invalid" })
-          error_message = generate_error(field_name)
+        # If this field is explicitly validated, or this field and the whole form aren't explicitly *not* validated
+        if validate or (validate != false and @template.validate_all? != false)
+          # Generate validations for the field
+          validations = generate_validations(@object, field_name)
+          options.merge!(validations)
+
+          # Add an 'invalid' class to it if it has errors
+          unless @object.errors[field_name].blank?
+            css_classes = options.delete(:class)
+            options.merge!({ :class => "#{css_classes} invalid" })
+            error_message = generate_error(field_name)
+          end
         end
 
-        if label == false
-          super(field_name, *(args << options)) + error_message
-        elsif label
-          generate_label(field_type, field_name, label) + super(field_name, *(args << options)) + error_message
-        elsif @template.label_all? == false
-          super(field_name, *(args << options)) + error_message
+        # Generate a label if necessary
+        if (label == false) or (label == nil and @template.label_all? == false)
+          label = ''.html_safe
         else
-          generate_label(field_type, field_name, label) + super(field_name, *(args << options)) + error_message
+          label = generate_label(field_type, field_name, label)
         end
+
+        # Generate the field itself
+        field = super(field_name, *(args << options))
+
+        # Generate the field description
+        description = generate_description(description)
+
+        # Join all the parts together to make a better form field!
+        return label + content_tag(:span, prefix + field + suffix + description) + error_message
       end
     end
 
@@ -50,6 +72,10 @@ module BetterForm
       label(method, label_text, options ||= {})
     end
 
+    def generate_description(description)
+      content_tag(:span, description, :class => 'field-desc') unless description.blank?
+    end
+
     def generate_error(field_name)
       content_tag(:span, @object.errors[field_name].join(tag(:br)).html_safe, :class => :error_message)
     end

data/lib/better_form/version.rb

@@ -1,3 +1,3 @@
 module BetterForm
-  VERSION = "0.5.1"
+  VERSION = "0.6.1"
 end

data/lib/better_form/view_helper.rb

@@ -2,18 +2,25 @@ module BetterForm
   module ViewHelper
     def better_form_for(record_or_name_or_array, *args, &proc)
       options = args.extract_options!.reverse_merge(:builder => BetterForm::Builder)
+      options[:class] = "#{options[:class]} better_form"
       @label_all = options[:label]
+      @validate_all = options[:validate]
       form_for(record_or_name_or_array, *(args << options), &proc)
     end
 
     def better_fields_for(record_or_name_or_array, *args, &proc)
       options = args.extract_options!.reverse_merge(:builder => BetterForm::Builder)
       @label_all = options[:label]
+      @validate_all = options[:validate]
       fields_for(record_or_name_or_array, *(args << options), &proc)
     end
 
     def label_all?
       @label_all
     end
+
+    def validate_all?
+      @validate_all
+    end
   end
 end

metadata

@@ -1,62 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: better_form
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.6.1
   prerelease: 
-  version: 0.5.1
 platform: ruby
-authors: 
+authors:
 - Nicholas Firth-McCoy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-28 00:00:00 +10:00
+date: 2011-05-31 00:00:00.000000000 +10:00
 default_executable: 
 dependencies: []
-
 description: 
-email: 
+email:
 - nicholas@2suggestions.com.au
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/better_form/version.rb
-- lib/better_form/view_helper.rb
-- lib/better_form/builder.rb
+files:
 - lib/better_form.rb
+- lib/better_form/builder.rb
+- lib/better_form/view_helper.rb
+- lib/better_form/version.rb
 - LICENSE
 - README.md
 has_rdoc: true
 homepage: http://github.com/2suggestions/better_form
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A Better Rails 3 FormBuilder
 test_files: []
-