validates_url_format_of 0.1.1

data/README.markdown

@@ -0,0 +1,49 @@
+# validates\_url\_format\_of
+
+Rails plugin that provides a `validates_url_format_of` method to `ActiveRecord` models. URLs are validated by regexp.
+
+## Usage
+
+After installing the plugin, it's used like
+
+    class User < ActiveRecord::Base
+      validates_url_format_of :url,
+                              :allow_nil => true,
+                              :message => 'is completely unacceptable'
+    end
+    
+Takes the same arguments as [`validates_format_of`](http://api.rubyonrails.org/classes/ActiveRecord/Validations/ClassMethods.html#M001052) except for the `:with` regexp.
+
+The default `:message` is different depending on whether the attribute name contains the word "URL". So you will get "Homepage URL does not appear to be valid" but "Homepage does not appear to be a valid URL" without having to customize the `:message`.
+
+Please note that the regexp used to validate URLs is not perfect, but hopefully good enough. See the test suite. Patches are very welcome.
+
+## Limitations and design choices
+
+Does not handle IPv6.
+
+By design, the plugin does not allow e.g. "http://localhost" or "http://my.localurl", which are valid URLs but not suitable in most web apps. It also requires a "http://" or "https://" prefix, so just "example.com" is not valid. Fix that in the setter.
+  
+## Credits and license
+
+By [Henrik Nyh](http://henrik.nyh.se/) under the MIT license:
+
+>  Copyright (c) 2008 Henrik Nyh
+>
+>  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/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "validates_url_format_of"
+    gem.summary = %Q{ActiveRecord URL Validation}
+    gem.description = %Q{Rails plugin that provides a validates_url_format_of method to ActiveRecord models. URLs are validated by regexp.}
+    gem.email = "conickal@gmail.com"
+    gem.homepage = "http://github.com/conickal/validates_url_format_of"
+    gem.authors = ["Henrik Nyh", "Josh Nichols", "Nicholas Silva"]
+    gem.add_dependency('activerecord', '~> 2.3.4')
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"    
+  end
+  Jeweler::GemcutterTasks.new  
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "validates_url_format_of #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/init.rb

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

data/lib/validates_url_format_of.rb

@@ -0,0 +1,30 @@
+module ValidatesUrlFormatOf
+  IPv4_PART = /\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]/  # 0-255
+  REGEXP = %r{
+    \A
+    https?://                                        # http:// or https://
+    ([^\s:@]+:[^\s:@]*@)?                            # optional username:pw@
+    ( (xn--)?[^\W_]+([-.][^\W_]+)*\.[a-z]{2,6}\.? |  # domain (including Punycode/IDN)...
+        #{IPv4_PART}(\.#{IPv4_PART}){3} )            # or IPv4
+    (:\d{1,5})?                                      # optional port
+    ([/?]\S*)?                                       # optional /whatever or ?whatever
+    \Z
+  }iux
+
+  DEFAULT_MESSAGE     = 'does not appear to be a valid URL'
+  DEFAULT_MESSAGE_URL = 'does not appear to be valid'
+  
+  def validates_url_format_of(*attr_names)
+    options = { :allow_nil => false,
+                :allow_blank => false,
+                :with => REGEXP }                
+    options = options.merge(attr_names.pop) if attr_names.last.is_a?(Hash)
+
+    attr_names.each do |attr_name|
+      message = attr_name.to_s.match(/(_|\b)URL(_|\b)/i) ? DEFAULT_MESSAGE_URL : DEFAULT_MESSAGE
+      validates_format_of(attr_name, { :message => message }.merge(options))
+    end
+  end
+end
+
+ActiveRecord::Base.extend(ValidatesUrlFormatOf)

data/shoulda_macros/validates_url_format_of_macros.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+class Test::Unit::TestCase
+  def self.should_validate_url_format_of(attribute, options = {})
+    should_allow_values_for attribute, 
+      'http://example.com',
+      'http://example.com/',
+      'http://www.example.com/',
+      'http://sub.domain.example.com/',
+      'http://bbc.co.uk',
+      'http://example.com?foo',
+      'http://example.com?url=http://example.com',
+      'http://example.com:8000',
+      'http://www.sub.example.com/page.html?foo=bar&baz=%23#anchor',
+      'http://user:pass@example.com',
+      'http://user:@example.com',
+      'http://example.com/~user',
+      'http://example.xy', # Not a real TLD, but we're fine with anything of 2-6 chars
+      'http://example.museum',
+      'http://1.0.255.249',
+      'http://1.2.3.4:80',
+      'HttP://example.com',
+      'https://example.com',
+      'http://räksmörgås.nu', # IDN
+      'http://xn--rksmrgs-5wao1o.nu', # Punycode
+      'http://example.com.', # Explicit TLD root period
+      'http://example.com./foo'
+
+    should_not_allow_values_for attribute,
+      "www.example.com",
+      "http://ex ample.com",
+      "http://example.com/foo bar",
+      'http://256.0.0.1',
+      'http://u:u:u@example.com',
+      'http://r?ksmorgas.com'
+  end
+end

data/test/validates_url_format_of_test.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require "#{File.dirname(__FILE__)}/../init"
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:')
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :models, :force => true do |t|
+    t.string :homepage
+    t.string :my_UrL_hooray
+    t.string :custom_url
+  end
+end
+
+class Model < ActiveRecord::Base
+  validates_url_format_of :homepage
+  validates_url_format_of :my_UrL_hooray
+  validates_url_format_of :custom_url, :message => 'custom message'
+end
+
+class ValidatesUrlFormatOfTest < Test::Unit::TestCase
+  
+  def setup
+    @model = Model.new
+  end
+  
+  def test_should_allow_valid_urls
+    [
+      'http://example.com',
+      'http://example.com/',
+      'http://www.example.com/',
+      'http://sub.domain.example.com/',
+      'http://bbc.co.uk',
+      'http://example.com?foo',
+      'http://example.com?url=http://example.com',
+      'http://example.com:8000',
+      'http://www.sub.example.com/page.html?foo=bar&baz=%23#anchor',
+      'http://user:pass@example.com',
+      'http://user:@example.com',
+      'http://example.com/~user',
+      'http://example.xy',  # Not a real TLD, but we're fine with anything of 2-6 chars
+      'http://example.museum',
+      'http://1.0.255.249',
+      'http://1.2.3.4:80',
+      'HttP://example.com',
+      'https://example.com',
+      'http://räksmörgås.nu',  # IDN
+      'http://xn--rksmrgs-5wao1o.nu',  # Punycode
+      'http://example.com.',  # Explicit TLD root period
+      'http://example.com./foo'
+    ].each do |url|
+      @model.homepage = url
+      @model.save
+      assert !@model.errors.on(:homepage), "#{url.inspect} should have been accepted"
+    end
+  end
+  
+  def test_should_reject_invalid_urls
+    [
+      nil, 1, "", " ", "url",
+      "www.example.com",
+      "http://ex ample.com",
+      "http://example.com/foo bar",
+      'http://256.0.0.1',
+      'http://u:u:u@example.com',
+      'http://r?ksmorgas.com',
+      
+      # These can all be valid local URLs, but should not be considered valid
+      # for public consumption.
+      "http://example",
+      "http://example.c",
+      'http://example.toolongtld'
+    ].each do |url|
+      @model.homepage = url
+      @model.save
+      assert @model.errors.on(:homepage), "#{url.inspect} should have been rejected"
+    end
+  end
+  
+  def test_different_defaults_based_on_attribute_name
+    @model.homepage = 'x'
+    @model.my_UrL_hooray = 'x'
+    @model.save
+    assert_not_equal ValidatesUrlFormatOf::DEFAULT_MESSAGE, ValidatesUrlFormatOf::DEFAULT_MESSAGE_URL
+    assert_equal ValidatesUrlFormatOf::DEFAULT_MESSAGE, @model.errors.on(:homepage)
+    assert_equal ValidatesUrlFormatOf::DEFAULT_MESSAGE_URL, @model.errors.on(:my_UrL_hooray)
+  end
+  
+  def test_can_override_defaults
+    @model.custom_url = 'x'
+    @model.save
+    assert_equal 'custom message', @model.errors.on(:custom_url)
+  end
+  
+end

data/validates_url_format_of.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validates_url_format_of}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Henrik Nyh", "Josh Nichols", "Nicholas Silva"]
+  s.date = %q{2011-01-31}
+  s.description = %q{Rails plugin that provides a validates_url_format_of method to ActiveRecord models. URLs are validated by regexp.}
+  s.email = %q{conickal@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/validates_url_format_of.rb",
+    "shoulda_macros/validates_url_format_of_macros.rb",
+    "test/validates_url_format_of_test.rb",
+    "validates_url_format_of.gemspec"
+  ]
+  s.homepage = %q{http://github.com/conickal/validates_url_format_of}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{ActiveRecord URL Validation}
+  s.test_files = [
+    "test/validates_url_format_of_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 2.3.4"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 2.3.4"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 2.3.4"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: validates_url_format_of
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Henrik Nyh
+- Josh Nichols
+- Nicholas Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 3
+        - 4
+        version: 2.3.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Rails plugin that provides a validates_url_format_of method to ActiveRecord models. URLs are validated by regexp.
+email: conickal@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/validates_url_format_of.rb
+- shoulda_macros/validates_url_format_of_macros.rb
+- test/validates_url_format_of_test.rb
+- validates_url_format_of.gemspec
+has_rdoc: true
+homepage: http://github.com/conickal/validates_url_format_of
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord URL Validation
+test_files: 
+- test/validates_url_format_of_test.rb