validators 2.3.0 → 2.4.0

data/lib/validators.rb

@@ -1,14 +1,14 @@
-require "validators/constants"
-require "validators/ip"
-require "validators/validates_datetime"
-require "validators/validates_ip_address"
-require "validators/validates_email_format_of"
-require "validators/validates_url_format_of"
-require "validators/validates_ownership_of"
-require "validators/validates_cpf_format_of"
-require "validators/validates_cnpj_format_of"
-require "validators/validates_ssh_private_key"
-require "validators/validates_ssh_public_key"
-
 module Validators
+  require "validators/constants"
+  require "validators/ip"
+  require "validators/validates_datetime"
+  require "validators/validates_ip_address"
+  require "validators/validates_email_format_of"
+  require "validators/validates_url_format_of"
+  require "validators/validates_ownership_of"
+  require "validators/validates_cpf_format_of"
+  require "validators/validates_cnpj_format_of"
+  require "validators/validates_ssh_private_key"
+  require "validators/validates_ssh_public_key"
+  require "validators/validates_hostname_format_of"
 end

data/lib/validators/constants.rb

@@ -14,4 +14,15 @@ module Validators
     ([/?]\S*)?                                                   # optional /whatever or ?whatever
     \z
   ]ixs
+
+  URL_FORMAT_WITHOUT_TLD_VALIDATION = %r[
+    \A
+    https?://                                                    # http:// or https://
+    ([^\s:@]+:[^\s:@]*@)?                                        # optional username:pw@
+    ( (([^\W_]+\.)*xn--)?[^\W_]+([-.][^\W_]+)*\..{2,}\.? |       # domain (including Punycode/IDN)...
+        #{IPv4_PART}(\.#{IPv4_PART}){3} )                        # or IPv4
+    (:\d{1,5})?                                                  # optional port
+    ([/?]\S*)?                                                   # optional /whatever or ?whatever
+    \z
+  ]ixs
 end

data/lib/validators/validates_hostname_format_of.rb

@@ -0,0 +1,62 @@
+module ActiveModel
+  module Validations
+    class HostnameValidator < EachValidator
+      # Rules taken from http://www.zytrax.com/books/dns/apa/names.html
+      def validate_each(record, attribute, value)
+        return if valid_hostname?(value.to_s)
+
+        record.errors.add(attribute, :invalid_hostname,
+          :message => options[:message],
+          :value => value
+        )
+      end
+
+      def valid_hostname?(host)
+        host = host.to_s
+        uri = URI(host)
+
+        uri.host.nil? &&
+        uri.scheme.nil? &&
+        uri.fragment.nil? &&
+        uri.query.nil? &&
+        uri.path == host &&
+        host.split('.').all? {|label| valid_label?(label) } &&
+        host.size <= 255 &&
+        valid_tld?(host)
+      rescue URI::InvalidURIError
+        false
+      end
+
+      def valid_label?(label)
+        !label.start_with?('-') &&
+        !label.match(/\A\d+\z/) &&
+        label.match(/\A[a-z0-9-]{1,63}\z/i)
+      end
+
+      def valid_tld?(host)
+        return true unless options[:tld]
+        return false if host.split('.').size == 1
+
+        tld = host[/\.(.*?)$/, 1].to_s.downcase
+        UrlValidator.tlds.include?(tld)
+      end
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified URL is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_hostname_format_of :site
+      #
+      #     # Validates against a list of valid TLD.
+      #     validates_hostname_format_of :site, tld: true
+      #   end
+      #
+      def validates_hostname_format_of(*attr_names)
+        validates_with HostnameValidator, _merge_attributes(attr_names)
+      end
+
+      alias_method :validates_hostname, :validates_hostname_format_of
+    end
+  end
+end

data/lib/validators/validates_url_format_of.rb

@@ -1,13 +1,38 @@
 module ActiveModel
   module Validations
     class UrlValidator < EachValidator
+      TLD_FILE_PATH = File.expand_path('../../../data/tld.txt', __FILE__)
+
+      def self.tlds
+        @tld ||= File.read(TLD_FILE_PATH).lines.map(&:chomp)
+      end
+
       def validate_each(record, attribute, value)
-        if value.to_s !~ Validators::URL_FORMAT
-          record.errors.add(
-            attribute, :invalid_url,
-            :message => options[:message], :value => value
-          )
-        end
+        return if url?(value.to_s)
+
+        record.errors.add(attribute, :invalid_url,
+          :message => options[:message],
+          :value => value
+        )
+      end
+
+      def url?(url)
+        uri = URI(url)
+        regex = options[:tld] ? Validators::URL_FORMAT_WITHOUT_TLD_VALIDATION :
+                                Validators::URL_FORMAT
+
+        uri.kind_of?(URI::HTTP) &&
+        url.match(regex) &&
+        valid_tld?(uri.host)
+      rescue URI::InvalidURIError
+        false
+      end
+
+      def valid_tld?(host)
+        return true unless options[:tld]
+        tld = host[/\.(.*?)$/, 1].to_s.downcase
+
+        self.class.tlds.include?(tld)
       end
     end
 
@@ -16,6 +41,9 @@ module ActiveModel
       #
       #   class User < ActiveRecord::Base
       #     validates_url_format_of :site
+      #
+      #     # Validates against a list of valid TLD.
+      #     validates_url_format_of :site, tld: true
       #   end
       #
       def validates_url_format_of(*attr_names)

data/lib/validators/version.rb

@@ -1,7 +1,7 @@
 module Validators
   module Version
     MAJOR = 2
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end

data/spec/spec_helper.rb

@@ -1,10 +1,13 @@
-require "bundler/setup"
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 
+require "bundler/setup"
 require "active_record"
 require "validators"
 require "active_support/all"
 
 Time.zone = "America/Sao_Paulo"
+TLDs = ActiveModel::Validations::UrlValidator.tlds.sample(100)
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 

data/spec/support/hostnames.rb

@@ -0,0 +1,26 @@
+VALID_HOSTNAMES = %W[
+  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.com
+  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.com
+  a-b.com
+  a-b-.com
+  a123.com
+  123a.com
+  ABC123.com
+  123ABC.com
+]
+
+INVALID_HOSTNAMES = %W[
+  192.168.42.42
+  a..com
+  #{'a'*64}.com
+  http://example.com
+  https://example.com
+  example.com?a=1
+  example.com#fragment
+  -example.com
+  1234
+  example.-test.com
+  example.1234.com
+  example_domain.com
+  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.com
+]

data/spec/support/models.rb

@@ -20,3 +20,40 @@ end
 class Person < ActiveRecord::Base
   self.table_name = :users
 end
+
+class UserWithTLD
+  include ActiveModel::Validations
+  attr_accessor :url
+
+  validates_url_format_of :url, tld: true
+
+  def self.name
+    'User'
+  end
+
+  def initialize(url)
+    @url = url
+  end
+end
+
+class ServerWithoutTLD
+  include ActiveModel::Validations
+  attr_accessor :host
+
+  validates_hostname :host
+
+  def initialize(host)
+    @host = host
+  end
+end
+
+class ServerWithTLD
+  include ActiveModel::Validations
+  attr_accessor :host
+
+  validates_hostname :host, tld: true
+
+  def initialize(host)
+    @host = host
+  end
+end

data/spec/support/urls.rb

@@ -12,7 +12,6 @@ VALID_URLS = [
   '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',
@@ -22,6 +21,7 @@ VALID_URLS = [
   'http://xn--rksmrgs-5wao1o.nu',  # Punycode
   'http://www.xn--rksmrgs-5wao1o.nu',
   'http://foo.bar.xn--rksmrgs-5wao1o.nu',
+  'http://example.xy',  # Only valid TLD
   'http://example.com.',  # Explicit TLD root period
   'http://example.com./foo'
 ]

data/spec/validators/validates_hostname_format_of_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe ".validates_hostname_format_of" do
+  context "with TLD validation" do
+    it 'rejects invalid TLD' do
+      server = ServerWithTLD.new('example.xy')
+      expect(server).not_to be_valid
+    end
+
+    it 'rejects only host label' do
+      server = ServerWithTLD.new('com')
+      expect(server).not_to be_valid
+    end
+
+    TLDs.each do |tld|
+      it "accepts #{tld} as TLD" do
+        server = ServerWithTLD.new("example.#{tld}")
+        expect(server).to be_valid
+      end
+    end
+  end
+
+  context "without TLD validation" do
+    VALID_HOSTNAMES.each do |host|
+      it "accepts #{host}" do
+        server = ServerWithoutTLD.new(host)
+        expect(server).to be_valid
+      end
+    end
+
+    INVALID_HOSTNAMES.each do |host|
+      it "rejects #{host}" do
+        server = ServerWithoutTLD.new(host)
+        expect(server).not_to be_valid
+      end
+    end
+  end
+end

data/spec/validators/validates_url_format_of_spec.rb

@@ -2,38 +2,54 @@
 require "spec_helper"
 
 describe ".validates_url_format_of" do
-  before do
-    User.validates_url_format_of :url, :allow_blank => false
-  end
+  context "validating TLD" do
+    it "rejects invalid TLD" do
+      user = UserWithTLD.new('http://example.xy')
+      expect(user).not_to be_valid
+    end
 
-  VALID_URLS.each do |url|
-    it "accepts #{url.inspect} as a valid url" do
-      user = User.new(:url => url)
-      expect(user).to be_valid
+    TLDs.each do |tld|
+      it "accepts #{tld} as TLD" do
+        user = UserWithTLD.new("http://example.#{tld}")
+        expect(user).to be_valid
+      end
     end
   end
 
-  INVALID_URLS.each do |url|
-    it "rejects #{url.inspect} as a valid url" do
-      user = User.new(:url => url)
-      expect(user).not_to be_valid
+  context "without validating TLD" do
+    before do
+      User.validates_url_format_of :url, :allow_blank => false
     end
-  end
 
-  it "defines alias method" do
-    expect(User).to respond_to(:validates_url)
-  end
+    VALID_URLS.each do |url|
+      it "accepts #{url.inspect} as a valid url" do
+        user = User.new(:url => url)
+        expect(user).to be_valid
+      end
+    end
 
-  it "uses default error message" do
-    user = User.new(:url => "invalid")
-    expect(user).not_to be_valid
-    expect(user.errors[:url]).to eq(["is not a valid address"])
-  end
+    INVALID_URLS.each do |url|
+      it "rejects #{url.inspect} as a valid url" do
+        user = User.new(:url => url)
+        expect(user).not_to be_valid
+      end
+    end
+
+    it "defines alias method" do
+      expect(User).to respond_to(:validates_url)
+    end
+
+    it "uses default error message" do
+      user = User.new(:url => "invalid")
+      expect(user).not_to be_valid
+      expect(user.errors[:url]).to eq(["is not a valid address"])
+    end
 
-  it "uses I18n string as error message [pt-BR]" do
-    I18n.locale = :'pt-BR'
-    user = User.new(:url => "invalid")
-    expect(user).not_to be_valid
-    expect(user.errors[:url]).to eq(["não parece ser uma URL válida"])
+    it "uses I18n string as error message [pt-BR]" do
+      I18n.locale = :'pt-BR'
+      user = User.new(:url => "invalid")
+      expect(user).not_to be_valid
+      expect(user.errors[:url]).to eq(["não parece ser uma URL válida"])
+    end
   end
 end

data/validators.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "activerecord", ">= 3.0"
-  s.add_development_dependency "rspec", "3.0.0.beta2"
+  s.add_development_dependency "rspec"
   s.add_development_dependency "sqlite3-ruby"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry-meta"
   s.add_development_dependency "cpf_cnpj"
   s.add_development_dependency "sshkey"
+  s.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validators
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add some nice ActiveRecord validators.
 email:
 - fnando.vieira@gmail.com
@@ -117,10 +131,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
+- data/tld.txt
 - lib/validators.rb
 - lib/validators/constants.rb
 - lib/validators/ip.rb
@@ -128,6 +144,7 @@ files:
 - lib/validators/validates_cpf_format_of.rb
 - lib/validators/validates_datetime.rb
 - lib/validators/validates_email_format_of.rb
+- lib/validators/validates_hostname_format_of.rb
 - lib/validators/validates_ip_address.rb
 - lib/validators/validates_ownership_of.rb
 - lib/validators/validates_ssh_private_key.rb
@@ -138,6 +155,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/dates.rb
 - spec/support/emails.rb
+- spec/support/hostnames.rb
 - spec/support/ips.rb
 - spec/support/models.rb
 - spec/support/translations.yml
@@ -147,6 +165,7 @@ files:
 - spec/validators/validates_cpf_format_of_spec.rb
 - spec/validators/validates_datetime_spec.rb
 - spec/validators/validates_email_format_of_spec.rb
+- spec/validators/validates_hostname_format_of_spec.rb
 - spec/validators/validates_ip_address_spec.rb
 - spec/validators/validates_ownership_of_spec.rb
 - spec/validators/validates_ssh_private_key_spec.rb
@@ -172,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Add some nice ActiveRecord validators.
@@ -181,6 +200,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/dates.rb
 - spec/support/emails.rb
+- spec/support/hostnames.rb
 - spec/support/ips.rb
 - spec/support/models.rb
 - spec/support/translations.yml
@@ -190,6 +210,7 @@ test_files:
 - spec/validators/validates_cpf_format_of_spec.rb
 - spec/validators/validates_datetime_spec.rb
 - spec/validators/validates_email_format_of_spec.rb
+- spec/validators/validates_hostname_format_of_spec.rb
 - spec/validators/validates_ip_address_spec.rb
 - spec/validators/validates_ownership_of_spec.rb
 - spec/validators/validates_ssh_private_key_spec.rb