validates_as_hostname_label 1.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean Huber (shuber@huberry.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,77 @@
+= validates_as_hostname_label
+
+Checks for valid hostname labels by looking for:
+
+* Length between 1 and 63 characters long
+* Alphanumeric, hyphen, and (optionally) underscore characters
+* Labels that don't begin or end with a hyphen or underscore
+* Reserved labels
+
+See http://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_host_names
+
+
+== Installation
+
+  gem install validates_as_hostname_label
+  OR
+  script/plugin install git://github.com/shuber/validates_as_hostname_label.git
+
+
+== Usage
+
+  class Account < ActiveRecord::Base
+    validates_as_hostname_label :subdomain
+  end
+  
+  @account = Account.new
+  @account.save # false
+  @account.errors # { :subdomain => 'is required' }
+
+You may optionally pass a <tt>:reserved</tt> option which should be an array of hostname labels to exclude,
+otherwise <tt>ValidatesAsHostnameLabel.default_options[:reserved]</tt> will be used.
+
+  class Account < ActiveRecord::Base
+    validates_as_hostname_label :subdomain, :reserved => ['www', 'ftp', 'mail', 'pop']
+  end
+  
+  @account = Account.new :subdomain => 'www'
+  @account.save # false
+  @account.errors # { :subdomain => 'is reserved' }
+
+Also accepts an <tt>:allow_underscores</tt> option which defaults to <tt>false</tt>.
+
+  class Account < ActiveRecord::Base
+    validates_as_hostname_label :subdomain, :allow_underscores => true
+  end
+  
+  @account = Account.new :subdomain => 'test_ing'
+  @account.save # true
+
+The standard validation options <tt>:if</tt>, <tt>:unless</tt>, and <tt>:allow_blank</tt> work as well.
+
+
+== Internationalization
+
+Uses the following <tt>I18n</tt> 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
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Contact
+
+Problems, comments, and suggestions all welcome: shuber@huberry.com

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run the validates_as_hostname_label tests'
+task :default => :test
+
+desc 'Test the validates_as_hostname_label gem/plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validates_as_hostname_label gem/plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'validates_as_hostname_label'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'validates_as_hostname_label'

data/lib/validates_as_hostname_label.rb

@@ -0,0 +1,75 @@
+# Adds ActiveRecord validation for hostname labels
+module ValidatesAsHostnameLabel
+
+  # A hash of default options to use when calling <tt>validates_as_hostname_label</tt>.
+  #
+  # 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)
+  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
+  
+  # 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
+  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 => /^[#{format}]*$/i,
+        :message => i18n.t('invalid_format', :default => "may only contain #{characters.to_sentence} characters"),
+        :allow_blank => true
+      }.merge(options)]
+
+      validates_format_of *attrs + [{
+        :with => /^[^-_].*[^-_]$/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
+end
+
+ActiveRecord::Base.extend ValidatesAsHostnameLabel

data/test/validates_as_hostname_label_test.rb

@@ -0,0 +1,122 @@
+require 'rubygems'
+require 'active_record'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/validates_as_hostname_label'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+class Account < ActiveRecord::Base
+  validates_as_hostname_label :subdomain
+  validates_as_hostname_label :subdomain_with_underscores, :allow_underscores => true
+  validates_as_hostname_label :subdomain_with_blank, :allow_blank => true
+  validates_as_hostname_label :subdomain_with_nil, :allow_nil => true
+  validates_as_hostname_label :subdomain_with_reserved, :reserved => ['funky']
+end
+
+class ValidatesAsHostnameLabelTest < Test::Unit::TestCase
+
+  def setup
+    ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
+    silence_stream(STDOUT) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :accounts do |t|
+          t.string   :subdomain
+          t.string   :subdomain_with_underscores
+          t.string   :subdomain_with_blank
+          t.string   :subdomain_with_nil
+          t.string   :subdomain_with_reserved
+        end
+      end
+    end
+  end
+
+  def test_should_save_with_valid_subdomains
+    @account = Account.new :subdomain => 'testing', :subdomain_with_underscores => 'testing', :subdomain_with_nil => 'testing', :subdomain_with_blank => 'testing', :subdomain_with_reserved => 'testing'
+    assert @account.save
+  end
+
+  def test_should_save_subdomains_with_hyphens
+    @account = Account.new :subdomain => 'test-ing', :subdomain_with_underscores => 'test-ing', :subdomain_with_nil => 'test-ing', :subdomain_with_blank => 'test-ing', :subdomain_with_reserved => 'test-ing'
+    assert @account.save
+  end
+
+  def test_should_not_save_with_blank_subdomain_if_allow_option_is_not_specified
+    @account = Account.new :subdomain => nil
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+
+    @account.subdomain = ''
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+  end
+
+  def test_should_save_with_blank_subdomain
+    @account = Account.new :subdomain => 'testing', :subdomain_with_underscores => 'testing', :subdomain_with_nil => 'testing', :subdomain_with_blank => '', :subdomain_with_reserved => 'testing'
+    assert @account.save
+  end
+
+  def test_should_save_with_nil_subdomain
+    @account = Account.new :subdomain => 'testing', :subdomain_with_underscores => 'testing', :subdomain_with_nil => nil, :subdomain_with_blank => 'testing', :subdomain_with_reserved => 'testing'
+    assert @account.save
+  end
+
+  def test_should_not_save_with_too_long_of_a_subdomain
+    @account = Account.new :subdomain => ('t' * 64)
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+  end
+
+  def test_should_not_save_with_invalid_characters
+    @account = Account.new :subdomain => '!@#$%^&*'
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+  end
+
+  def test_should_not_save_with_subdomains_beginning_with_a_hyphen_or_underscore
+    @account = Account.new :subdomain => '-testing'
+    @account.subdomain_with_underscores = '_testing'
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+    assert @account.errors.on(:subdomain_with_underscores)
+  end
+
+  def test_should_not_save_with_subdomains_ending_with_a_hyphen_or_underscore
+    @account = Account.new :subdomain => 'testing-'
+    @account.subdomain_with_underscores = 'testing_'
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+    assert @account.errors.on(:subdomain_with_underscores)
+  end
+
+  def test_should_not_save_subdomains_with_an_underscore_if_allow_underscores_option_is_false
+    @account = Account.new :subdomain => 'test_ing'
+    assert !@account.save
+    assert @account.errors.on(:subdomain)
+  end
+
+  def test_should_save_subdomains_with_an_underscore_if_allow_underscores_option_is_true
+    @account = Account.new :subdomain => 'testing', :subdomain_with_underscores => 'test_ing', :subdomain_with_nil => 'testing', :subdomain_with_blank => 'testing', :subdomain_with_reserved => 'testing'
+    assert @account.save
+  end
+
+  def test_should_not_save_with_a_reserved_subdomain_from_the_default_list
+    ValidatesAsHostnameLabel::default_options[:reserved].each do |hostname|
+      @account = Account.new :subdomain => hostname
+      assert !@account.save
+      assert @account.errors.on(:subdomain)
+    end
+  end
+
+  def test_should_not_save_with_a_reserved_subdomain_from_a_list
+    @account = Account.new :subdomain_with_reserved => 'funky'
+    assert !@account.save
+    assert @account.errors.on(:subdomain_with_reserved)
+  end
+
+  def test_should_not_be_valid_with_a_subdomain_not_from_the_list
+    @account = Account.new :subdomain_with_reserved => 'qqqfds'
+    assert !@account.save
+    assert !@account.errors.on(:subdomain_with_reserved)
+  end
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: validates_as_hostname_label
+version: !ruby/object:Gem::Version 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Checks for valid hostname labels
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- lib/validates_as_hostname_label.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/validates_as_hostname_label_test.rb
+has_rdoc: true
+homepage: http://github.com/shuber/validates_as_hostname_label
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Checks for valid hostname labels
+test_files: 
+- test/validates_as_hostname_label_test.rb