unders-validates_as_hostname_label 1.1.0

data/CHANGELOG

@@ -0,0 +1,17 @@
+2009-06-02 - Anders Törnqvist (anders@elabs.se)
+ * Added i18n
+ * Added a default reserved list
+
+2009-01-17 - Sean Huber (shuber@huberry.com)
+ * Bump version number so github will rebuild the gem
+
+2009-01-14 - Sean Huber (shuber@huberry.com)
+  * Allow all other validation options like :allow_nil, :if, :unless, etc
+  * Add support for the :reserved option to exclude certain values
+
+2009-01-13 - Sean Huber (shuber@huberry.com)
+  * Initial commit
+  * Add logic
+  * Add tests
+  * Add gemspec
+  * Update README

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.markdown

@@ -0,0 +1,51 @@
+# validates\_as\_hostname\_label #
+
+Checks for valid hostname labels by looking 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 labels
+
+See [http://en.wikipedia.org/wiki/Hostname#Restrictions\_on\_valid\_host\_names](http://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_host_names)
+
+
+## Installation ##
+
+    gem install shuber-validates_as_hostname_label --source http://gems.github.com
+    OR
+    script/plugin install git://github.com/shuber/validates_as_hostname_label.git
+
+
+## Usage ##
+
+    class Account < ActiveRecord::Base
+      validates_as_hostname_label :subdomain
+    end
+
+You may optionally pass a `:reserved` option which should be an array of hostname labels to exclude,
+otherwise Huberry::ValidatesAsHostnameLabel::RESERVED_HOSTNAMES 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 `:allow_underscores` option which defaults to `false`
+
+    class Account < ActiveRecord::Base
+      validates_as_hostname_label :subdomain, :allow_underscores => true
+    end
+
+    @account = Account.new :subdomain => 'test_ing'
+    @account.save # true
+
+The usual validation options (like `:if`, `:unless`, `:allow_nil`, etc) work as well
+
+
+## Contact ##
+
+Problems, comments, and suggestions all welcome: [shuber@huberry.com](mailto: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.markdown')
+  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,40 @@
+module Huberry
+  module ValidatesAsHostnameLabel
+    
+    RESERVED_HOSTNAMES = %w(www blog dev stage stats status admin ftp sftp mail pop pop3 imap smtp)
+    
+    # Checks 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 labels
+    #
+    # Accepts an :allow_underscores option which defaults to false
+    def validates_as_hostname_label(*attrs)
+      options = { :allow_underscores => false, :reserved => RESERVED_HOSTNAMES }.merge(attrs.last.is_a?(Hash) ? attrs.pop : {})
+      
+      format = 'a-z0-9\-'
+      format << '_' if options.delete(:allow_underscores)
+      
+      validates_length_of *attrs + [{
+        :in => 1..63,
+        :message => I18n.t('validates_as_hostname_label.invalid_length', :default => 'must be between 1 and 63 characters long')
+      }.merge(options)]
+
+      validates_exclusion_of *attrs + [{
+        :in => options.delete(:reserved),
+        :message => I18n.t('validates_as_hostname_label.reserved', :default => 'is reserved')
+      }.merge(options)]
+
+      validates_format_of *attrs + [{ :with => /^[#{format}]*$/i }.merge(options)]
+
+      validates_format_of *attrs + [{
+        :with => /^[^-_].*[^-_]$/i,
+        :message => I18n.t('validates_as_hostname_label.invalid_first_character', :default => "can't start or end with a hyphen or underscore")
+      }.merge(options)]
+    end
+  end
+end
+
+ActiveRecord::Base.extend Huberry::ValidatesAsHostnameLabel

data/test/validates_as_hostname_label_test.rb

@@ -0,0 +1,123 @@
+require 'rubygems'
+gem 'activerecord'
+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
+    Huberry::ValidatesAsHostnameLabel::RESERVED_HOSTNAMES.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,58 @@
+--- !ruby/object:Gem::Specification 
+name: unders-validates_as_hostname_label
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Checks for valid hostname labels
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- init.rb
+- lib/validates_as_hostname_label.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+has_rdoc: false
+homepage: http://github.com/shuber/validates_as_hostname_label
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Checks for valid hostname labels
+test_files: 
+- test/validates_as_hostname_label_test.rb