josevalim-simple_form 0.2.0 → 0.2.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+# Version 0.2
+
+* Added support to symbols on :validate
+* Added support to request objects and append DSL
 * Added support to :attachments (thanks to @andrewtimberlake)
 
 # Version 0.1

data/README

@@ -1,6 +1,6 @@
 Simple Form
 License: MIT
-Version: 0.1
+Version: 0.2.1
 
 You can also read this README in pretty html at the GitHub project Wiki page:
 
@@ -30,7 +30,8 @@ Then you start a script/console and type:
   c = ContactForm.new(:name => 'José', :email => 'jose@email.com', :message => 'Cool!')
   c.deliver
 
-Check your inbox and the e-mail will be there, with the sent fields.
+Check your inbox and the e-mail will be there, with the sent fields (assuming
+that you configured your smtp properly).
 
 SimpleForm also support attachments, I18n, error messages like in ActiveRecord 
 (so it works with custom FormBuilders) and can also send the user request information
@@ -66,7 +67,7 @@ And in your controller:
   @contact_form = ContactForm.new(params[:contact_form], request)
 
 And the remote ip, user agent and session will be sent in the e-mail in a
-request information session. You can send to append any method that the
+request information session. You can give to append any method that the
 request object responds to.
 
 API Overview
@@ -83,6 +84,9 @@ Options:
   When a regexp is given, check if the attribute matches is not blank and
   then if it matches the regexp.
 
+  Whenever :validate is a symbol, the method given as symbol will be
+  called. You can then add validations as you do in ActiveRecord (errors.add).
+
 * :attachment - When given, expects a file to be sent and attaches
   it to the e-mail. Don't forget to set your form to multitype.
 
@@ -95,7 +99,12 @@ Examples:
      attributes :name,  :validate => true
      attributes :email, :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
      attributes :message
+     attributes :screenshot, :attachment => true, :validate => :screenshot_required?
      attributes :nickname, :captcha => true
+
+     def screenshot_required?
+       # ...
+     end
    end
 
    c = ContactForm.new(:nickname => 'not_blank', :email => 'your@email.com', :name => 'José')

data/lib/simple_form/base.rb

@@ -38,19 +38,27 @@ class SimpleForm
     !spam?
   end
 
-  # The form is valid if all elements marked to be validated are not blank
-  # and elements given with a regexp match the regexp.
+  # To check if the form is valid, we run the validations.
+  #
+  # If the validation is true, we just check if the field is not blank. If it's
+  # a regexp, we check if it is not blank AND if the Regexp matches.
+  #
+  # You can have totally custom validations by sending a symbol. Then the method
+  # given as symbol will be called and then you cann hook your validations there.
   #
   def valid?
     return false unless errors.empty?
 
     form_validatable.each_pair do |field, validation|
-      if send(field).blank?
+      next unless validation
+
+      if validation.is_a?(Symbol)
+        send(validation)
+      elsif send(field).blank?
         errors.add(field, :blank)
-        next
+      elsif validation.is_a?(Regexp)
+        errors.add(field, :invalid) unless send(field) =~ validation
       end
-
-      errors.add(field, :invalid) if validation.is_a?(Regexp) && send(field) !~ validation
     end
 
     errors.empty?

data/lib/simple_form/dsl.rb

@@ -12,6 +12,9 @@ class SimpleForm
       #   When a regexp is given, check if the attribute matches is not blank and
       #   then if it matches the regexp.
       #
+      #   Whenever :validate is a symbol, the method given as symbol will be
+      #   called. You can then add validations as you do in ActiveRecord (errors.add).
+      #
       # * <tt>:attachment</tt> - When given, expects a file to be sent and attaches
       #   it to the e-mail. Don't forget to set your form to multitype.
       #
@@ -24,8 +27,15 @@ class SimpleForm
       #     attributes :name,  :validate => true
       #     attributes :email, :validate => /^([^@]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
       #     attributes :message
-      #     attributes :file, :attachment => true
+      #     attributes :type
+      #     attributes :screenshot, :attachment => true, :validate => :interface_bug?
       #     attributes :nickname, :captcha => true
+      #
+      #     def interface_bug?
+      #       if type == 'Interface bug' && screenshot.nil?
+      #         self.errors.add(:screenshot, "can't be blank when you are reporting an interface bug")
+      #       end
+      #     end
       #   end
       #
       def attribute(*accessors)

data/test/base_test.rb

@@ -56,6 +56,13 @@ class SimpleFormBaseTest < ActiveSupport::TestCase
     assert !form.invalid?
   end
 
+  def test_symbols_given_to_validate_are_called
+    form = ContactForm.new
+    assert form.instance_variable_get('@_callback_run').nil?
+    form.valid?
+    assert form.instance_variable_get('@_callback_run')
+  end
+
   def test_deliver_is_false_when_is_a_spam
     form = ContactForm.new(:name => 'Jose', :email => 'is.valid@email.com', :nickname => 'not_blank')
     assert form.valid?

data/test/notifier_test.rb

@@ -127,10 +127,10 @@ class SimpleFormNotifierTest < ActiveSupport::TestCase
   end
 
   def test_request_info_hashes_are_print_inside_lis
-    @request.session = { :my => :session, :user => :data }
+    @request.session = { :my => :session, :user => "data" }
     @advanced.deliver
-    assert_match /<li>my: session<\/li>/, ActionMailer::Base.deliveries.last.body
-    assert_match /<li>user: data<\/li>/, ActionMailer::Base.deliveries.last.body
+    assert_match /<li>my: :session<\/li>/, ActionMailer::Base.deliveries.last.body
+    assert_match /<li>user: &quot;data&quot;<\/li>/, ActionMailer::Base.deliveries.last.body
   end
 
   def test_error_is_raised_when_append_is_given_but_no_request_is_given

data/test/test_helper.rb

@@ -19,7 +19,11 @@ class ContactForm < SimpleForm
   attribute :name,     :validate => true
   attribute :email,    :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
   attribute :nickname, :captcha => true
-  attributes :tellphone, :message
+  attributes :tellphone, :message, :validate => :callback
+
+  def callback
+    @_callback_run = true
+  end
 end
 
 class AdvancedForm < ContactForm

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-simple_form
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-03 00:00:00 -07:00
+date: 2009-04-15 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Simple easy contact form for Rails.
+description: Simple easy contact form for Rails with I18n, validations, attachments and request information.
 email: jose.valim@gmail.com
 executables: []
 
@@ -59,7 +59,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Simple easy contact form for Rails.
+summary: Simple easy contact form for Rails with I18n, validations, attachments and request information.
 test_files: 
 - test/base_test.rb
 - test/errors_test.rb