validators 0.1.0 → 0.1.1

data/README.rdoc

@@ -22,6 +22,12 @@ Then add it to your Gemfile:
     validates :email, :email => true
   end
 
+=== validates_url_format_of
+
+  class User < ActiveRecord::Base
+    validates_url_format_of :site
+  end
+
 === validates_ownership_of
 
   class Task < ActiveRecord::Base
@@ -45,6 +51,14 @@ Then add it to your Gemfile:
   task.valid?
   #=> false
 
+=== validates_ip_address
+
+  class Server < ActiveRecord::Base
+    validates_ip_address :address
+    validates_ip_address :address, :only => :v4
+    validates_ip_address :address, :only => :v6
+  end
+
 == Maintainer
 
 * Nando Vieira - http://simplesideias.com.br

data/lib/validators/constants.rb

@@ -0,0 +1,30 @@
+module Validators
+  EMAIL_FORMAT = /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+
+  # Source: https://github.com/henrik/validates_url_format_of
+  IPv4_PART = /\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]/  # 0-255
+
+  if RUBY_VERSION >= "1.9"
+    URL_FORMAT = %r[
+      \A
+      https?://                                                    # http:// or https://
+      ([^\s:@]+:[^\s:@]*@)?                                        # optional username:pw@
+      ( (([^\W_]+\.)*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
+    ]ixs
+  else
+    URL_FORMAT = %r[
+      \A
+      https?://                                                    # http:// or https://
+      ([^\s:@]+:[^\s:@]*@)?                                        # optional username:pw@
+      ( (([^\W_]+\.)*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
+    ]ixu
+  end
+end

data/lib/validators/ip.rb

@@ -0,0 +1,29 @@
+module Validators
+  module Ip
+    extend self
+
+    # Extracted from Ruby 1.8.7
+    def v4?(addr)
+      matches = addr.match(/\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/)
+      matches && matches.captures.all? {|i| i.to_i < 256}
+    end
+
+    # Extracted from Ruby 1.8.7
+    def v6?(addr)
+      # IPv6 (normal)
+      return true if /\A[\da-f]{1,4}(:[\da-f]{1,4})*\Z/i =~ addr
+      return true if /\A[\da-f]{1,4}(:[\da-f]{1,4})*::([\da-f]{1,4}(:[\da-f]{1,4})*)?\Z/i =~ addr
+      return true if /\A::([\da-f]{1,4}(:[\da-f]{1,4})*)?\Z/i =~ addr
+      # IPv6 (IPv4 compat)
+      return true if /\A[\da-f]{1,4}(:[\da-f]{1,4})*:/i =~ addr && v4?($')
+      return true if /\A[\da-f]{1,4}(:[\da-f]{1,4})*::([\da-f]{1,4}(:[\da-f]{1,4})*:)?/i =~ addr && v4?($')
+      return true if /\A::([\da-f]{1,4}(:[\da-f]{1,4})*:)?/i =~ addr && v4?($')
+
+      false
+    end
+
+    def valid?(addr)
+      v4?(addr) || v6?(addr)
+    end
+  end
+end

data/lib/validators/validates_email_format_of.rb

@@ -21,6 +21,8 @@ module ActiveModel
       def validates_email_format_of(*attr_names)
         validates_with EmailValidator, _merge_attributes(attr_names)
       end
+
+      alias_method :validates_email, :validates_email_format_of
     end
   end
 end

data/lib/validators/validates_ip_address.rb

@@ -0,0 +1,47 @@
+module ActiveModel
+  module Validations
+    class IpAddressValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if value.nil? && options[:allow_nil]
+
+        valid = false
+
+        case options[:only]
+        when :v4
+          valid = Validators::Ip.v4?(value.to_s)
+          scope = :invalid_ipv4_address
+        when :v6
+          valid = Validators::Ip.v6?(value.to_s)
+          scope = :invalid_ipv6_address
+        else
+          valid = Validators::Ip.valid?(value.to_s)
+          scope = :invalid_ip_address
+        end
+
+        unless valid
+          record.errors.add(
+            attribute, scope,
+            :message => options[:message], :value => value
+          )
+        end
+      end
+
+      def check_validity!
+        raise ArgumentError, ":only accepts a symbol that can be either :v6 or :v4" if options.key?(:only) && ![:v4, :v6].include?(options[:only])
+      end
+    end
+
+    module ClassMethods
+      # Validates weather or not the specified URL is valid.
+      #
+      #   validates_ip_address :ip  #=> accepts both v4 and v6
+      #   validates_ip_address :ip, :only => :v4
+      #   validates_ip_address :ip, :only => :v6
+      #
+      def validates_ip_address(*attr_names)
+        validates_with IpAddressValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/validators/validates_url_format_of.rb

@@ -0,0 +1,28 @@
+module ActiveModel
+  module Validations
+    class UrlValidator < EachValidator
+      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
+      end
+    end
+
+    module ClassMethods
+      # Validates weather or not the specified URL is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_url_format_of :site
+      #   end
+      #
+      def validates_url_format_of(*attr_names)
+        validates_with UrlValidator, _merge_attributes(attr_names)
+      end
+
+      alias_method :validates_url, :validates_url_format_of
+    end
+  end
+end

data/lib/validators/version.rb

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

data/lib/validators.rb

@@ -1,7 +1,10 @@
 require "active_record"
+require "validators/constants"
+require "validators/validates_ip_address"
 require "validators/validates_email_format_of"
+require "validators/validates_url_format_of"
 require "validators/validates_ownership_of"
 
 module Validators
-  EMAIL_FORMAT = /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+  autoload :Ip, "validators/ip"
 end

data/spec/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema.define(:version => 0) do
   create_table :users do |t|
-    t.string :email, :corporate_email
+    t.string :email, :corporate_email, :url
   end
 
   create_table :categories do |t|

data/spec/support/ips.rb

@@ -0,0 +1,20 @@
+VALID_IPV4 = [
+  "192.168.1.1",
+  "64.233.163.104",
+  "127.0.0.1",
+  "0.0.0.0"
+]
+
+VALID_IPV6 = [
+  "FE80:0000:0000:0000:0202:B3FF:FE1E:8329",
+  "fe80:0000:0000:0000:0202:b3ff:fe1e:8329",
+  "FE80::0202:B3FF:FE1E:8329",
+  "1050:0000:0000:0000:0005:0600:300c:326b",
+  "1050:0:0:0:5:600:300c:326b",
+  "ff06:0:0:0:0:0:0:c3",
+  "ff06::c3",
+  "0:0:0:0:0:0:192.1.56.10",
+  "3ffe:1900:4545:3:200:f8ff:fe21:67cf",
+  "fe80:0:0:0:200:f8ff:fe21:67cf",
+  "fe80::200:f8ff:fe21:67cf"
+]

data/spec/support/translations.yml

@@ -4,6 +4,10 @@ en:
       messages:
         record_invalid: "Errors: %{errors}"
         invalid_email: "is not a valid address"
+        invalid_url: "is not a valid address"
+        invalid_ipv4_address: "is not a valid IPv4 address"
+        invalid_ipv6_address: "is not a valid IPv6 address"
+        invalid_address: "is not a valid IP address"
         invalid_owner: "is not associated with your user"
 
 pt-BR:
@@ -12,4 +16,5 @@ pt-BR:
       messages:
         record_invalid: "Erros: %{errors}"
         invalid_email: "não parece ser um e-mail válido"
+        invalid_url: "não parece ser uma URL válida"
         invalid_owner: "não está associado ao seu usuário"

data/spec/support/urls.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+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://www.xn--rksmrgs-5wao1o.nu',
+  'http://foo.bar.xn--rksmrgs-5wao1o.nu',
+  'http://example.com.',  # Explicit TLD root period
+  'http://example.com./foo'
+]
+
+INVALID_URLS = [
+  "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'
+]

data/spec/validators/ip_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Validators::Ip do
+  context "IPv4" do
+    VALID_IPV4.each do |ip|
+      it "should accept #{ip.inspect} as ip address" do
+        Validators::Ip.should be_v4(ip)
+      end
+    end
+  end
+
+  context "IPv6" do
+    VALID_IPV6.each do |ip|
+      it "should accept #{ip.inspect} as ip address" do
+        Validators::Ip.should be_v6(ip)
+      end
+    end
+  end
+
+  (VALID_IPV4 + VALID_IPV6).each do |ip|
+    it "should accept #{ip.inspect} as ip address" do
+      Validators::Ip.should be_valid(ip)
+    end
+  end
+end

data/spec/validators/validates_email_format_of_spec.rb

@@ -31,41 +31,41 @@ describe ".validates_email_format_of" do
   it "should use default error message" do
     user = User.new(:email => "invalid")
     user.should_not be_valid
-    errors_for(user, :email).should == ["is not a valid address"]
+    user.errors[:email].should == ["is not a valid address"]
   end
 
   it "should reject nil value" do
     user = User.new(:email => nil)
     user.should_not be_valid
-    errors_for(user, :email).should_not be_empty
+    user.errors[:email].should_not be_empty
   end
 
   it "should reject empty value" do
     user = User.new(:email => "")
     user.should_not be_valid
-    errors_for(user, :email).should_not be_empty
+    user.errors[:email].should_not be_empty
   end
 
   it "should validate multiple attributes" do
     user = User.new(:corporate_email => "invalid")
     user.should_not be_valid
-    errors_for(user, :corporate_email).should == ["is not a valid address"]
+    user.errors[:corporate_email].should == ["is not a valid address"]
   end
 
   it "should use custom error message as :message options" do
     buyer = Buyer.new(:email => "invalid")
     buyer.should_not be_valid
-    errors_for(buyer, :email).should == ["is not a valid e-mail"]
+    buyer.errors[:email].should == ["is not a valid e-mail"]
   end
 
   it "should use I18n string as error message [pt-BR]" do
     I18n.locale = :'pt-BR'
     user = User.new(:email => "invalid")
     user.should_not be_valid
-    errors_for(user, :email).should == ["não parece ser um e-mail válido"]
+    user.errors[:email].should == ["não parece ser um e-mail válido"]
   end
 
-  def errors_for(record, attr_name)
-    record.errors[attr_name]
+  it "should have alias method" do
+    User.should respond_to(:validates_email)
   end
 end

data/spec/validators/validates_ip_address_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe ".validates_ip_address" do
+  subject { User.new }
+
+  context "IPv4" do
+    it "should be valid" do
+      User.validates_ip_address :url, :only => :v4
+      subject.url = "192.168.1.2"
+      subject.should be_valid
+    end
+
+    it "should not be valid" do
+      User.validates_ip_address :url, :only => :v4
+      subject.url = "FE80:0000:0000:0000:0202:B3FF:FE1E:8329"
+      subject.should_not be_valid
+      subject.errors[:url].should == ["is not a valid IPv4 address"]
+    end
+  end
+
+  context "IPv6" do
+    it "should be valid" do
+      User.validates_ip_address :url, :only => :v6
+      subject.url = "FE80:0000:0000:0000:0202:B3FF:FE1E:8329"
+      subject.should be_valid
+    end
+
+    it "should not be valid" do
+      User.validates_ip_address :url, :only => :v6
+      subject.url = "192.168.1.2"
+      subject.should_not be_valid
+      subject.errors[:url].should == ["is not a valid IPv6 address"]
+    end
+  end
+
+  it "should be valid with IPv4" do
+    User.validates_ip_address :url
+    subject.url = "192.168.1.2"
+    subject.should be_valid
+  end
+
+  it "should be valid with IPv6" do
+    User.validates_ip_address :url
+    subject.url = "FE80:0000:0000:0000:0202:B3FF:FE1E:8329"
+    subject.should be_valid
+  end
+
+  it "should allow blank values" do
+    User.validates_ip_address :url, :allow_blank => true
+    subject.url = ""
+    subject.should be_valid
+  end
+
+  it "should allow nil values" do
+    User.validates_ip_address :url, :allow_nil => true
+    subject.url = nil
+    subject.should be_valid
+  end
+end

data/spec/validators/validates_url_format_of_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe ".validates_url_format_of" do
+  before do
+    User.validates_url_format_of :url, :allow_blank => false
+  end
+
+  VALID_URLS.each do |url|
+    it "should accept #{url.inspect} as a valid url" do
+      user = User.new(:url => url)
+      user.should be_valid
+    end
+  end
+
+  INVALID_URLS.each do |url|
+    it "should reject #{url.inspect} as a valid url" do
+      user = User.new(:url => url)
+      user.should_not be_valid
+    end
+  end
+
+  it "should have alias method" do
+    User.should respond_to(:validates_url)
+  end
+
+  it "should use default error message" do
+    user = User.new(:url => "invalid")
+    user.should_not be_valid
+    user.errors[:url].should == ["is not a valid address"]
+  end
+
+  it "should use I18n string as error message [pt-BR]" do
+    I18n.locale = :'pt-BR'
+    user = User.new(:url => "invalid")
+    user.should_not be_valid
+    user.errors[:url].should == ["não parece ser uma URL válida"]
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 -02:00
+date: 2010-11-11 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,16 +89,25 @@ files:
 - README.rdoc
 - Rakefile
 - lib/validators.rb
+- lib/validators/constants.rb
+- lib/validators/ip.rb
 - lib/validators/validates_email_format_of.rb
+- lib/validators/validates_ip_address.rb
 - lib/validators/validates_ownership_of.rb
+- lib/validators/validates_url_format_of.rb
 - lib/validators/version.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/support/emails.rb
+- spec/support/ips.rb
 - spec/support/models.rb
 - spec/support/translations.yml
+- spec/support/urls.rb
+- spec/validators/ip_spec.rb
 - spec/validators/validates_email_format_of_spec.rb
+- spec/validators/validates_ip_address_spec.rb
 - spec/validators/validates_ownership_of_spec.rb
+- spec/validators/validates_url_format_of_spec.rb
 - validators.gemspec
 has_rdoc: true
 homepage: http://rubygems.org/gems/validators
@@ -136,7 +145,12 @@ test_files:
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/support/emails.rb
+- spec/support/ips.rb
 - spec/support/models.rb
 - spec/support/translations.yml
+- spec/support/urls.rb
+- spec/validators/ip_spec.rb
 - spec/validators/validates_email_format_of_spec.rb
+- spec/validators/validates_ip_address_spec.rb
 - spec/validators/validates_ownership_of_spec.rb
+- spec/validators/validates_url_format_of_spec.rb