Module: ValidatesAsHostnameLabel

Defined in:
lib/validates_as_hostname_label.rb

Overview

Adds ActiveRecord validation for hostname labels

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.default_options ⇒ Object

A hash of default options to use when calling validates_as_hostname_label.

Defaults:

:allow_blank        =>  false
:allow_underscores  =>  false
:reserved           =>  %w(admin blog dev development ftp help imap mail pop pop3 sftp smtp staging stats status support www)



13
14
15
16
17
18
19
 
# File 'lib/validates_as_hostname_label.rb', line 13

def self.default_options
  @default_options ||= {
    :allow_blank => false,
    :allow_underscores => false,
    :reserved => %w(admin blog dev development ftp help imap mail pop pop3 sftp smtp staging stats status support www)
  }
end

Instance Method Details

#validates_as_hostname_label(*attrs) ⇒ Object

Validates hostname labels by checking for:

* Length between 1 and 63 characters long
* Letters 'a' through 'z' (case-insensitive), the digits '0' through '9', and the hyphen (and optionally the underscore)
* Labels that don't begin or end with a hyphen or underscore
* Reserved hostname labels

Options:

:allow_blank        -  Skip validation of the attribute is blank. Defaults to false.
:allow_underscores  -  Allows underscores in hostname labels. Defaults to false.
:reserved           -  Contains an array of reserved hostname labels to validate exclusion of.
                       Defaults to ValidatesAsHostnameLabel.default_options[:reserved].

I18n keys:

* validates_as_hostname_label.invalid_format
* validates_as_hostname_label.invalid_length
* validates_as_hostname_label.invalid_prefix_or_suffix
* validates_as_hostname_label.reserved



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/validates_as_hostname_label.rb', line 41

def validates_as_hostname_label(*attrs)
  options = ValidatesAsHostnameLabel.default_options.merge(attrs.extract_options!)

  format, characters = 'a-z0-9\-', %w(alphanumeric hyphen)
  format << '_' and characters << 'underscore' if options.delete(:allow_underscores)

  I18n.with_options :scope => 'validates_as_hostname_label' do |i18n|
    validates_presence_of *attrs + [options] unless options.delete(:allow_blank) || options.delete(:allow_nil)

    validates_exclusion_of *attrs + [{
      :in => options.delete(:reserved),
      :message => i18n.t('reserved', :default => 'is reserved'),
      :allow_blank => true
    }.merge(options)]

    validates_format_of *attrs + [{
      :with => /\A[#{format}]*\z/i,
      :message => i18n.t('invalid_format', :default => "may only contain #{characters.to_sentence} characters"),
      :allow_blank => true
    }.merge(options)]

    validates_format_of *attrs + [{
      :with => /\A[^-_].*[^-_]\z/i,
      :message => i18n.t('invalid_prefix_or_suffix', :default => 'may not start or end with a hyphen or underscore'),
      :allow_blank => true
    }.merge(options)]

    validates_length_of *attrs + [{
      :in => 1..63,
      :message => i18n.t('invalid_length', :default => 'must be between 1 and 63 characters long'),
      :allow_blank => true
    }.merge(options)]
  end
end