File: README.markdown

package info (click to toggle)
ruby-validate-email 0.1.6%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 160 kB
  • sloc: ruby: 229; makefile: 4
file content (60 lines) | stat: -rw-r--r-- 1,723 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# ValidateEmail

This gem adds the capability of validating email addresses to `ActiveModel`. 
The gem only supports Rails 3 (has dependencies in ActiveModel and ActiveSupport 3.0)

### Installation
    # add this to your Gemfile
    gem "validate_email"

    # and then run
    rake gems:install

    # or just run
    sudo gem install validate_email

### Usage

#### With ActiveRecord
    class Pony < ActiveRecord::Base
      # standard validation
      validates :email_address, :email => true

      # with allow_nil
      validates :email_address, :email => {:allow_nil => true}

      # with allow_blank
      validates :email_address, :email => {:allow_blank => true}
    end

#### With ActiveModel
    class Unicorn
      include ActiveModel::Validations

      attr_accessor :email_address

      # with legacy syntax (the syntax above works also)
      validates_email :email_address, :allow_blank => true
    end

#### I18n

The error message will be looked up according to the standard ActiveModel::Errors scheme.
For the above Unicorn class this would be:

 * activemodel.errors.models.unicorn.attributes.email_address.email
 * activemodel.errors.models.unicorn.email
 * activemodel.errors.messages.email
 * errors.attributes.email_address.email
 * errors.messages.email

A default errors.messages.email of `is not a valid email address` is provided.
You can also pass the `:message => "my custom error"` option to your validation to define your own custom message.

## Authors

**Tanel Suurhans** (<http://twitter.com/tanelsuurhans>)  
**Tarmo Lehtpuu** (<http://twitter.com/tarmolehtpuu>)

## License
Copyright 2010 by PerfectLine LLC (<http://www.perfectline.co.uk>) and is released under the MIT license.