mail_form 1.3.0 → 1.4.0

data/CHANGELOG

@@ -1,7 +1,12 @@
+# Version 1.4
+
+* Fixed bug that was causing all activerecord attributes be saved as nil
+* Avoid symbol injection on forms
+
 # Version 1.3
 
-* Removed deprecated methods in version 1.2.
-* Added persisted? header and a generator.
+* Removed deprecated methods in version 1.2
+* Added persisted? header and a generator
 
 # Version 1.2
 

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Plataforma Tec http://blog.plataformatec.com.br/
+Copyright (c) 2009-2012 Plataformatec http://plataformatec.com.br/
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,226 @@
+## MailForm
+[![Build Status](https://secure.travis-ci.org/plataformatec/mail_form.png)](http://travis-ci.org/plataformatec/mail_form)
+
+### Rails 3
+
+This gem was built on top of `ActiveModel` to showcase how you can pull in validations, naming
+and `i18n` from Rails to your models without the need to implement it all by yourself.
+
+In other words, this README refers to the **MailForm** gem to be used in Rails 3. For instructions
+on how to use MailForm in Rails 2.x, please check the v1.0 branch:
+
+http://github.com/plataformatec/mail_form/tree/v1.0
+
+### Description
+
+**MailForm** allows you to send an e-mail straight from a form. For instance,
+if you want to make a contact form just the following lines are needed (including the e-mail):
+
+```ruby
+class ContactForm < MailForm::Base
+  attribute :name,      :validate => true
+  attribute :email,     :validate => /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
+  attribute :file,      :attachment => true
+
+  attribute :message
+  attribute :nickname,  :captcha  => true
+
+  # Declare the e-mail headers. It accepts anything the mail method
+  # in ActionMailer accepts.
+  def headers
+    {
+      :subject => "My Contact Form",
+      :to => "your.email@your.domain.com",
+      :from => %("#{name}" <#{email}>)
+    }
+  end
+end
+```
+
+Then you start a console with `rails console` and type:
+
+```ruby
+>> 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 (assuming that
+you configured your mailer delivery method properly).
+
+### MailForm::Base
+
+When you inherit from `MailForm::Base`, it pulls down a set of stuff from `ActiveModel`,
+as `ActiveModel::Validation`, `ActiveModel::Translation` and `ActiveModel::Naming`.
+
+This bring `I18n`, error messages, validations and attributes handling like in
+`ActiveRecord` to **MailForm**, so **MailForm** can be used in your controllers and form builders without extra tweaks. This also means that instead of the following:
+
+```ruby
+attribute :email, :validate => /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
+```
+
+You could actually do this:
+
+```ruby
+attribute :email
+validates_format_of :email, :with => /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
+```
+
+Choose the one which pleases you the most. For more information on the API, please
+continue reading below.
+
+### Playing together ORMs
+
+**MailForm** plays nice with ORMs as well. You just need to include `MailForm::Delivery`
+in your model and declare which attributes should be sent:
+
+```ruby
+class User < ActiveRecord::Base
+  include MailForm::Delivery
+
+  append :remote_ip, :user_agent, :session
+  attributes :name, :email, :created_at
+
+  def headers
+    {
+      :to => "your.email@your.domain.com",
+      :subject => "User created an account"
+    }
+  end
+end
+```
+
+The delivery will be triggered in an `after_create` hook.
+
+## Installation
+
+Install **MailForm** is very easy. Just edit your Gemfile adding the following:
+
+```ruby
+gem 'mail_form'
+```
+Then run `bundle install` to install **MailForm**.
+
+If you want it as plugin, just do:
+
+`script/plugin install git://github.com/plataformatec/mail_form.git`
+
+## API Overview
+
+### attributes(*attributes)
+
+Declare your form attributes. All attributes declared here will be appended
+to the e-mail, except the ones :captcha is true.
+
+Options:
+
+* :validate - A hook to validates_*_of. When true is given, validates the
+  presence of the attribute. When a regexp, validates format. When array,
+  validates the inclusion of the attribute in the array.
+
+  Whenever :validate is given, the presence is automatically checked. Give
+  :allow_blank => true to override.
+
+  Finally, when :validate is a symbol, the method given as symbol will be
+  called. Then you can 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.
+
+* :captcha - When true, validates the attributes must be blank.
+  This is a simple way to avoid spam and the input should be hidden with CSS.
+
+Examples:
+
+```ruby
+class ContactForm < MailForm::Base
+  attributes :name,  :validate => true
+  attributes :email, :validate => /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
+  attributes :type,  :validate => ["General", "Interface bug"]
+  attributes :message
+  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 on interface bugs")
+    end
+  end
+end
+
+c = ContactForm.new(:nickname => 'not_blank', :email => 'your@email.com', :name => 'José')
+c.valid?  #=> true
+c.spam?   #=> true  (raises an error in development, to remember you to hide it)
+c.deliver  #=> false (just delivers if is not a spam and is valid, raises an error in development)
+
+c = ContactForm.new(:email => 'invalid')
+c.valid?               #=> false
+c.errors.inspect       #=> { :name => :blank, :email => :invalid }
+c.errors.full_messages #=> [ "Name can't be blank", "Email is invalid" ]
+
+c = ContactForm.new(:name => 'José', :email => 'your@email.com')
+c.deliver
+```
+
+### append(*methods)
+
+**MailForm** also makes easy to append request information from client to the sent
+mail. You just have to do:
+
+```ruby
+class ContactForm < MailForm::Base
+  append :remote_ip, :user_agent, :session
+  # ...
+end
+```
+
+And in your controller:
+
+```ruby
+@contact_form = ContactForm.new(params[:contact_form])
+@contact_form.request = request
+```
+
+The remote ip, user agent and session will be sent in the e-mail in a
+request information session. You can give to append any method that the
+request object responds to.
+
+## I18n
+
+I18n in **MailForm** works like in ActiveRecord, so all models, attributes and messages
+can be used with localized. Below is an I18n file example file:
+
+```ruby
+mail_form:
+  models:
+    contact_form: "Your site contact form"
+  attributes:
+    contact_form:
+      email: "E-mail"
+      telephone: "Telephone number"
+      message: "Sent message"
+  request:
+    title: "Technical information about the user"
+    remote_ip: "IP Address"
+    user_agent: "Browser"
+```
+
+## Custom e-mail template
+
+To customize the e-mail template that is used create a file called contact.erb in app/views/mail_form.
+Take a look at lib/mail_form/views/mail_form/contact.erb in this repo to see how the default template works.
+
+## Maintainers
+
+* José Valim - http://github.com/josevalim
+* Carlos Antonio - http://github.com/carlosantoniodasilva
+
+## Contributors
+
+* Andrew Timberlake - http://github.com/andrewtimberlake
+
+## Bugs and Feedback
+
+If you discover any bug, please use github issues tracker.
+
+Copyright (c) 2009-2012 Plataformatec http://plataformatec.com.br/

data/lib/mail_form.rb

@@ -1,7 +1,6 @@
 module MailForm
   autoload :Base,      'mail_form/base'
-  autoload :Callbacks, 'mail_form/callbacks'
   autoload :Delivery,  'mail_form/delivery'
   autoload :Notifier,  'mail_form/notifier'
   autoload :Shim,      'mail_form/shim'
-end
+end

data/lib/mail_form/delivery.rb

@@ -36,10 +36,10 @@ module MailForm
       # * :validate - A hook to validates_*_of. When true is given, validates the
       #       presence of the attribute. When a regexp, validates format. When array,
       #       validates the inclusion of the attribute in the array.
-      # 
+      #
       #       Whenever :validate is given, the presence is automatically checked. Give
       #       :allow_blank => true to override.
-      # 
+      #
       #       Finally, when :validate is a symbol, the method given as symbol will be
       #       called. Then you can add validations as you do in ActiveRecord (errors.add).
       #
@@ -68,7 +68,10 @@ module MailForm
       #
       def attribute(*accessors)
         options = accessors.extract_options!
-        attr_accessor *(accessors - instance_methods.map(&:to_sym))
+
+        # TODO: make this not depend on column_names
+        columns_methods = self.respond_to?(:column_names) ? column_names.map(&:to_sym) : []
+        attr_accessor(*(accessors - instance_methods.map(&:to_sym) - columns_methods))
 
         if options[:attachment]
           self.mail_attachments += accessors
@@ -147,5 +150,13 @@ module MailForm
     def deliver!
       MailForm::Notifier.contact(self).deliver
     end
+
+    # Returns a hash of attributes, according to the attributes existent in
+    # self.class.mail_attributes.
+    def mail_form_attributes
+      self.class.mail_attributes.each_with_object({}) do |attr, hash|
+        hash[attr.to_s] = send(attr)
+      end
+    end
   end
-end
+end

data/lib/mail_form/shim.rb

@@ -25,19 +25,10 @@ module MailForm
     # Initialize assigning the parameters given as hash.
     def initialize(params={})
       params.each_pair do |attr, value|
-        self.send(:"#{attr}=", value)
+        send("#{attr}=", value) if respond_to?("#{attr}=", true)
       end unless params.blank?
     end
 
-    # Returns a hash of attributes, according to the attributes existent in
-    # self.class.mail_attributes.
-    def attributes
-      self.class.mail_attributes.inject({}) do |hash, attr|
-        hash[attr.to_s] = send(attr)
-        hash
-      end
-    end
-
     # Always return true so when using form_for, the default method will be post.
     def new_record?
       true
@@ -62,4 +53,4 @@ module MailForm
     end
     alias :save :deliver
   end
-end
+end

data/lib/mail_form/version.rb

@@ -1,3 +1,3 @@
 module MailForm
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/mail_form/views/mail_form/contact.erb

@@ -1,6 +1,6 @@
 <h4 style="text-decoration:underline"><%= message.subject %></h4>
 
-<% @resource.attributes.each do |attribute, value|
+<% @resource.mail_form_attributes.each do |attribute, value|
   next if value.blank? %>
 
   <p><b><%= @resource.class.human_attribute_name(attribute) %>:</b>

data/test/mail_form_test.rb

@@ -30,85 +30,85 @@ class MailFormNotifierTest < ActiveSupport::TestCase
 
   def test_body_contains_subject
     @form.deliver
-    assert_match /Contact form/, first_delivery.body.to_s
+    assert_match %r[Contact form], first_delivery.body.to_s
   end
 
   def test_body_contains_attributes_values
     @form.deliver
-    assert_match /José/, first_delivery.body.to_s
-    assert_match /my.email@my.domain.com/, first_delivery.body.to_s
-    assert_match /Cool/, first_delivery.body.to_s
+    assert_match %r[José], first_delivery.body.to_s
+    assert_match %r[my.email@my.domain.com], first_delivery.body.to_s
+    assert_match %r[Cool], first_delivery.body.to_s
   end
 
   def test_body_contains_attributes_names
     @form.deliver
-    assert_match /Name:/, first_delivery.body.to_s
-    assert_match /Email:/, first_delivery.body.to_s
-    assert_match /Message:/, first_delivery.body.to_s
+    assert_match %r[Name:], first_delivery.body.to_s
+    assert_match %r[Email:], first_delivery.body.to_s
+    assert_match %r[Message:], first_delivery.body.to_s
   end
 
   def test_body_contains_localized_attributes_names
     I18n.backend.store_translations(:en, :mail_form => { :attributes => { :contact_form => { :message => 'Sent message' } } })
     @form.deliver
-    assert_match /Sent message:/, first_delivery.body.to_s
-    assert_no_match /Message:/, first_delivery.body.to_s
+    assert_match %r[Sent message:], first_delivery.body.to_s
+    assert_no_match %r[Message:], first_delivery.body.to_s
   end
 
   def test_body_mail_format_messages_with_break_line
     @form.deliver
-    assert_no_match /<p>Cool/, first_delivery.body.to_s
+    assert_no_match %r[<p>Cool], first_delivery.body.to_s
 
     @advanced.deliver
-    assert_match /<p>Cool/, last_delivery.body.to_s
+    assert_match %r[<p>Cool], last_delivery.body.to_s
   end
 
   def test_body_mail_format_dates_with_i18n
     @form.deliver
-    assert_no_match /I18n.l(Date.today)/, first_delivery.body.to_s
+    assert_no_match %r[I18n.l(Date.today)], first_delivery.body.to_s
   end
 
   def test_body_does_not_append_request_if_append_is_not_called
     @form.deliver
-    assert_no_match /Request information/, first_delivery.body.to_s
+    assert_no_match %r[Request information], first_delivery.body.to_s
   end
 
   def test_body_does_append_request_if_append_is_called
     @advanced.deliver
-    assert_match /Request information/, last_delivery.body.to_s
+    assert_match %r[Request information], last_delivery.body.to_s
   end
 
   def test_request_title_is_localized
     I18n.backend.store_translations(:en, :mail_form => { :request => { :title => 'Information about the request' } })
     @advanced.deliver
-    assert_no_match /Request information/, last_delivery.body.to_s
-    assert_match /Information about the request/, last_delivery.body.to_s
+    assert_no_match %r[Request information], last_delivery.body.to_s
+    assert_match %r[Information about the request], last_delivery.body.to_s
   end
 
   def test_request_info_attributes_are_printed
     @advanced.deliver
-    assert_match /Remote ip/, last_delivery.body.to_s
-    assert_match /User agent/, last_delivery.body.to_s
+    assert_match %r[Remote ip], last_delivery.body.to_s
+    assert_match %r[User agent], last_delivery.body.to_s
   end
 
   def test_request_info_attributes_are_localized
     I18n.backend.store_translations(:en, :mail_form => { :request => { :remote_ip => 'IP Address' } })
     @advanced.deliver
-    assert_match /IP Address/, last_delivery.body.to_s
-    assert_no_match /Remote ip/, last_delivery.body.to_s
+    assert_match %r[IP Address], last_delivery.body.to_s
+    assert_no_match %r[Remote ip], last_delivery.body.to_s
   end
 
   def test_request_info_values_are_printed
     @advanced.deliver
-    assert_match /0\.0\.0\.0/, last_delivery.body.to_s
-    assert_match /Rails Testing/, last_delivery.body.to_s
+    assert_match %r[0\.0\.0\.0], last_delivery.body.to_s
+    assert_match %r[Rails Testing], last_delivery.body.to_s
   end
 
   def test_request_info_hashes_are_print_inside_lis
     @request.session = { :my => :session, :user => "data" }
     @advanced.deliver
-    assert_match /<ul/, last_delivery.body.to_s
-    assert_match /<li>my: :session<\/li>/, last_delivery.body.to_s
-    assert_match /<li>user: &quot;data&quot;<\/li>/, last_delivery.body.to_s
+    assert_match %r[<ul], last_delivery.body.to_s
+    assert_match %r[<li>my: :session<\/li>], last_delivery.body.to_s
+    assert_match %r[<li>user: &quot;data&quot;<\/li>], last_delivery.body.to_s
   end
 
   def test_error_is_raised_when_append_is_given_but_no_request_is_given
@@ -125,7 +125,7 @@ class MailFormNotifierTest < ActiveSupport::TestCase
 
   def test_form_with_file_does_not_output_attachment_as_attribute
     @with_file.deliver
-    assert_no_match /File:/, first_delivery.body.to_s
+    assert_no_match %r[File:], first_delivery.body.to_s
   end
 
   protected
@@ -137,8 +137,8 @@ class MailFormNotifierTest < ActiveSupport::TestCase
     def last_delivery
       ActionMailer::Base.deliveries.last
     end
-  
+
     def teardown
       I18n.reload!
     end
-end
+end

data/test/resource_test.rb

@@ -61,9 +61,9 @@ class MailFormBaseTest < ActiveSupport::TestCase
 
   def test_symbols_given_to_validate_are_called
     form = ContactForm.new
-    assert form.instance_variable_get('@_callback_run').nil?
+    assert !form.callback_run?
     form.valid?
-    assert form.instance_variable_get('@_callback_run')
+    assert form.callback_run?
   end
 
   def test_deliver_is_false_when_is_a_spam

data/test/test_file.txt

@@ -0,0 +1 @@
+A test file

data/test/test_helper.rb

@@ -26,19 +26,22 @@ class ContactForm < MailForm::Base
 
   attributes :created_at, :message, :validate => :callback
 
-  before_deliver :set_created_at
-
   def headers
     { :to => 'my.email@my.domain.com' }
   end
 
-  def set_created_at
-    created_at = Date.today
+  def initialize(*)
+    super
+    @_callback_run = false
   end
 
   def callback
     @_callback_run = true
   end
+
+  def callback_run?
+    @_callback_run
+  end
 end
 
 class AdvancedForm < ContactForm

data/test/views/mail_form/custom_template.erb

@@ -0,0 +1 @@
+Hello from my custom template!

metadata

@@ -1,77 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mail_form
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 3
-  - 0
-  version: 1.3.0
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 1.4.0
 platform: ruby
-authors: 
-- "Jos\xC3\xA9 Valim"
-- "Carlos Ant\xC3\xB4nio"
+authors:
+- José Valim
+- Carlos Antônio
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-26 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: Send e-mail straight from forms in Rails with I18n, validations, attachments and request information.
+date: 2012-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
+  name: actionmailer
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
+description: ! '{Send e-mail straight from forms in Rails with I18n, validations,
+  attachments and request information.'
 email: contact@plataformatec.com.br
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - CHANGELOG
 - MIT-LICENSE
-- README.rdoc
-- Rakefile
+- README.md
 - lib/generators/rails/mail_form_generator.rb
 - lib/generators/rails/templates/model.rb
-- lib/mail_form.rb
 - lib/mail_form/base.rb
 - lib/mail_form/delivery.rb
 - lib/mail_form/notifier.rb
 - lib/mail_form/shim.rb
 - lib/mail_form/version.rb
 - lib/mail_form/views/mail_form/contact.erb
-has_rdoc: true
-homepage: http://github.com/plataformatec/mail_form
+- lib/mail_form.rb
+- test/mail_form_test.rb
+- test/resource_test.rb
+- test/test_file.txt
+- test/test_helper.rb
+- test/views/mail_form/custom_template.erb
+homepage: https://github.com/plataformatec/mail_form
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.6
+rubyforge_project: mail_form
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Send e-mail straight from forms in Rails with I18n, validations, attachments and request information.
-test_files: 
+summary: Send e-mail straight from forms in Rails with I18n, validations, attachments
+  and request information.
+test_files:
 - test/mail_form_test.rb
 - test/resource_test.rb
+- test/test_file.txt
 - test/test_helper.rb
+- test/views/mail_form/custom_template.erb

data/README.rdoc

@@ -1,199 +0,0 @@
-== MailForm
-
-=== Rails 3
-
-This gem was built on top of ActiveModel to showcase how you can pull in validations, naming
-and i18n from Rails to your models without the need to implement it all by yourself.
-
-In other words, this README refers to the MailForm gem to be used in Rails 3. For instructions
-on how to use MailForm in Rails 2.x, please check the v1.0 branch:
-
-  http://github.com/plataformatec/mail_form/tree/v1.0
-
-=== Description
-
-MailForm allows you to send an e-mail straight from a form. For instance,
-if you want to make a contact form just the following lines are needed (including the e-mail):
-
-  class ContactForm < MailForm::Base
-    attribute :name,      :validate => true
-    attribute :email,     :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
-    attribute :file,      :attachment => true
-
-    attribute :message
-    attribute :nickname,  :captcha  => true
-
-    # Declare the e-mail headers. It accepts anything the mail method
-    # in ActionMailer accepts.
-    def headers
-      {
-        :subject => "My Contact Form",
-        :to => "your.email@your.domain.com",
-        :from => %("#{name}" <#{email}>)
-      }
-    end
-  end
-
-Then you start a script/console and type:
-
-  c = ContactForm.new(:name => 'José', :email => 'jose@email.com', :message => 'Cool!')
-  c.create
-
-Check your inbox and the e-mail will be there, with the sent fields (assuming that
-you configured your mailer delivery method properly).
-
-=== MailForm::Base
-
-When you inherit from MailForm::Base, it pulls down a set of stuff from ActiveModel,
-as ActiveModel::Validation, ActiveModel::Translation and ActiveModel::Naming.
-
-This bring I18n, error messages, validations and attributes handling like in
-ActiveRecord to MailForm, so MailForm can be used in your controllers and form builders without extra tweaks. This also means that instead of the following:
-
-  attribute :email, :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
-
-You could actually do this:
-
-  attribute :email
-  validates_format_of :email, :with => /[^@]+@[^\.]+\.[\w\.\-]+/
-
-Choose the one which pleases you the most. For more information on the API, please
-continue reading below.
-
-=== Playing together ORMs
-
-MailForm plays nice with ORMs as well. You just need to include MailForm::Delivery
-in your model and declare which attributes should be sent:
-
-  class User < ActiveRecord::Base
-    include MailForm::Delivery
-
-    append :remote_ip, :user_agent, :session
-    attributes :name, :email, :created_at
-
-    def headers
-      {
-        :to => "your.email@your.domain.com",
-        :subject => "User created an account"
-      }
-    end
-  end
-
-The delivery will be triggered in an after_create hook.
-
-== Installation
-
-Install MailForm is very easy. It is stored in Gemcutter, so just run the following:
-
-   sudo gem install mail_form
-
-If you want it as plugin, just do:
-
-   script/plugin install git://github.com/plataformatec/mail_form.git
-
-== API Overview
-
-=== attributes(*attributes)
-
-Declare your form attributes. All attributes declared here will be appended
-to the e-mail, except the ones :captcha is true.
-
-Options:
-
-* :validate - A hook to validates_*_of. When true is given, validates the
-  presence of the attribute. When a regexp, validates format. When array,
-  validates the inclusion of the attribute in the array.
-
-  Whenever :validate is given, the presence is automatically checked. Give
-  :allow_blank => true to override.
-
-  Finally, when :validate is a symbol, the method given as symbol will be
-  called. Then you can 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.
-
-* :captcha - When true, validates the attributes must be blank.
-  This is a simple way to avoid spam and the input should be hidden with CSS.
-
-Examples:
-
-   class ContactForm < MailForm::Base
-     attributes :name,  :validate => true
-     attributes :email, :validate => /[^@]+@[^\.]+\.[\w\.\-]+/
-     attributes :type,  :validate => ["General", "Interface bug"]
-     attributes :message
-     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 on interface bugs")
-       end
-     end
-   end
-
-   c = ContactForm.new(:nickname => 'not_blank', :email => 'your@email.com', :name => 'José')
-   c.valid?  #=> true
-   c.spam?   #=> true  (raises an error in development, to remember you to hide it)
-   c.deliver #=> false (just delivers if is not a spam and is valid)
-
-   c = ContactForm.new(:email => 'invalid')
-   c.valid?               #=> false
-   c.errors.inspect       #=> { :name => :blank, :email => :invalid }
-   c.errors.full_messages #=> [ "Name can't be blank", "Email is invalid" ]
-
-   c = ContactForm.new(:name => 'José', :email => 'your@email.com')
-   c.deliver #=> true
-
-=== append(*methods)
-
-MailForm also makes easy to append request information from client to the sent
-mail. You just have to do:
-
-  class ContactForm < MailForm::Base
-    append :remote_ip, :user_agent, :session
-    # ...
-  end
-
-And in your controller:
-
-  @contact_form = ContactForm.new(params[:contact_form])
-  @contact_form.request = request
-
-The remote ip, user agent and session will be sent in the e-mail in a
-request information session. You can give to append any method that the
-request object responds to.
-
-== I18n
-
-I18n in MailForm works like in ActiveRecord, so all models, attributes and messages
-can be used with localized. Below is an I18n file example file:
-
-  mail_form:
-    models:
-      contact_form: "Your site contact form"
-    attributes:
-      contact_form:
-        email: "E-mail"
-        telephone: "Telephone number"
-        message: "Sent message"
-    request:
-      title: "Technical information about the user"
-      remote_ip: "IP Address"
-      user_agent: "Browser"
-
-== Maintainers
-
-* José Valim - http://github.com/josevalim
-* Carlos Antonio - http://github.com/carlosantoniodasilva
-
-== Contributors
-
-* Andrew Timberlake - http://github.com/andrewtimberlake
-
-== Bugs and Feedback
-
-If you discover any bug, please use github issues tracker.
-
-Copyright (c) 2010 Plataforma Tec http://blog.plataformatec.com.br/

data/Rakefile

@@ -1,41 +0,0 @@
-# coding: utf-8
-
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require File.join(File.dirname(__FILE__), "lib", "mail_form", "version")
-
-desc 'Run tests for MailForm.'
-Rake::TestTask.new(:test) do |t|
-  t.libs   << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for MailForm.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'MailForm'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('MIT-LICENSE')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "mail_form"
-    s.version = MailForm::VERSION
-    s.summary = "Send e-mail straight from forms in Rails with I18n, validations, attachments and request information."
-    s.email = "contact@plataformatec.com.br"
-    s.homepage = "http://github.com/plataformatec/mail_form"
-    s.description = "Send e-mail straight from forms in Rails with I18n, validations, attachments and request information."
-    s.authors = ['José Valim', 'Carlos Antônio']
-    s.files =  FileList["[A-Z]*", "{lib,views}/**/*"]
-  end
-
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
-end