validates_telephone 0.1.0 → 0.2.0

data/README.rdoc

@@ -8,21 +8,36 @@ gem install validates_telephone
 
 == Usage
 
-Lets say you have a model with "telephone" string column that you want to be a valid telephone. Just add this to your model:
+Lets say you have a model with "telephone" string column that you want to be a valid telephone for Brazil. Just add this to your model:
 
 class User < ActiveRecord::Base
     validates :telephone, :telephone => true
 end
 
+In case you want it to be a valid telephone for United States, just pass the locale as en:
+
+class User < ActiveRecord::Base
+    validates :telephone, :telephone => { :locale => :usa }
+end
+
 == Test
 
 This gem has matchers for shoulda-matchers and remarkable.
 
-If you are using shoulda-matchers, add this line to your spec_helper.rb :
-    require "validates_telephone/shoulda-matchers/validate_as_telephone_matcher"
-If you are using remarkable, add this line to your spec_helper.rb :
-    require "validates_telephone/remarkable/validate_as_telephone_matcher"
+If you want the matchers for Brazil and you are using shoulda-matchers, add this line to your spec_helper.rb :
+    require "validates_telephone/shoulda-matchers/validate_as_br_telephone_matcher"
+If you want the matchers for Brazil and you are using remarkable, add this line to your spec_helper.rb :
+    require "validates_telephone/remarkable/validate_as_br_telephone_matcher"
+
+If you want the matchers for United States and you are using shoulda-matchers, add this line to your spec_helper.rb :
+    require "validates_telephone/shoulda-matchers/validate_as_usa_telephone_matcher"
+If you want the matchers for United States and you are using remarkable, add this line to your spec_helper.rb :
+    require "validates_telephone/remarkable/validate_as_usa_telephone_matcher"
+
+=== How?
+
+You should use validates_as_telephone(:attribute) just like any other shoulda or remarkable matcher.
 
 == Future
 
-Add Support for other countries. For now it only supports Brazil telephones.
+Add Support for other countries. For now it only supports Brazil and United States telephones.

data/lib/validates_telephone.rb

@@ -3,6 +3,10 @@ require "validates_telephone/telephone"
 
 class TelephoneValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    record.errors[attribute] << I18n.t("errors.messages.invalid") unless Telephone.new(value).valid?
+    if options[:locale].nil?
+      record.errors[attribute] << I18n.t("errors.messages.invalid") unless Telephone.new(value, :br).valid?
+    else
+      record.errors[attribute] << I18n.t("errors.messages.invalid") unless Telephone.new(value, options[:location]).valid?
+    end
   end
 end

data/lib/validates_telephone/remarkable/{validate_as_telephone_matcher.rb → validate_as_br_telephone_matcher.rb}

@@ -3,7 +3,7 @@ require 'remarkable/active_record'
 module Remarkable
   module ActiveRecord
     module Matchers
-      class ValidateAsTelephoneMatcher < Remarkable::ActiveRecord::Base
+      class ValidateAsBrTelephoneMatcher < Remarkable::ActiveRecord::Base
         arguments :telephone
 
         collection_assertions :telephone_valid?, :allow_nil?, :formatted_number?
@@ -26,8 +26,8 @@ module Remarkable
         end
       end
 
-      def validate_as_telephone(*args, &block)
-        ValidateAsTelephoneMatcher.new(*args, &block).spec(self)
+      def validate_as_br_telephone(*args, &block)
+        ValidateAsBrTelephoneMatcher.new(*args, &block).spec(self)
       end
     end
   end

data/lib/validates_telephone/remarkable/validate_as_usa_telephone_matcher.rb

@@ -0,0 +1,34 @@
+require 'remarkable/active_record'
+
+module Remarkable
+  module ActiveRecord
+    module Matchers
+      class ValidateAsUsaTelephoneMatcher < Remarkable::ActiveRecord::Base
+        arguments :telephone
+
+        collection_assertions :telephone_valid?, :allow_nil?, :formatted_number?
+
+        protected
+
+        def telephone_valid?
+          @subject.telephone = '123456'
+          @subject.valid?.errors[:telephone].should == ['is invalid']
+        end
+
+        def allow_nil?
+          @subject.telephone = nil
+          @subject.valid?.errors[:telephone].should == []
+        end
+
+        def formatted_number?
+          @subject.telephone = '1112223333'
+          @subject.valid?.telephone.should == '(111)222-3333'
+        end
+      end
+
+      def validate_as_usa_telephone(*args, &block)
+        ValidateAsUsaTelephoneMatcher.new(*args, &block).spec(self)
+      end
+    end
+  end
+end

data/lib/validates_telephone/shoulda-matchers/{validate_as_telephone_matcher.rb → validate_as_br_telephone_matcher.rb}

@@ -3,21 +3,21 @@ require "shoulda-matchers"
 module Shoulda
   module Matchers
     module ActiveModel
-      def validate_as_telephone(attr)
-        ValidateAsTelephoneMatcher.new(attr)
+      def validate_as_br_telephone(attr)
+        ValidateAsBrTelephoneMatcher.new(attr)
       end
 
-      class ValidateAsTelephoneMatcher < ValidationMatcher
+      class ValidateAsBrTelephoneMatcher < ValidationMatcher
         def initialize(attribute)
           @attribute = attribute
         end
 
         def description
-          "validate #{@attribute} as a valid Telephone number"
+          "validate #{@attribute} as a valid Telephone number for Brazil"
         end
 
         def failure_message
-          "expected #{@attribute} to be validated as a valid Telephone number"
+          "expected #{@attribute} to be validated as a valid Telephone number for Brazil"
         end
 
         def matches?(subject)

data/lib/validates_telephone/shoulda-matchers/validate_as_usa_telephone_matcher.rb

@@ -0,0 +1,45 @@
+require "shoulda-matchers"
+
+module Shoulda
+  module Matchers
+    module ActiveModel
+      def validate_as_usa_telephone(attr)
+        ValidateAsUsaTelephoneMatcher.new(attr)
+      end
+
+      class ValidateAsUsaTelephoneMatcher < ValidationMatcher
+        def initialize(attribute)
+          @attribute = attribute
+        end
+
+        def description
+          "validate #{@attribute} as a valid Telephone number for United States"
+        end
+
+        def failure_message
+          "expected #{@attribute} to be validated as a valid Telephone number for United States"
+        end
+
+        def matches?(subject)
+          super(subject)
+
+          disallows_invalid_value and allows_valid_value and allows_nil_value
+        end
+
+        private
+
+        def disallows_invalid_value
+          disallows_value_of("123456")
+        end
+
+        def allows_valid_value
+          allows_value_of("(111)222-3333")
+        end
+
+        def allows_nil_value
+          allows_value_of(nil)
+        end
+      end
+    end
+  end
+end

data/lib/validates_telephone/telephone.rb

@@ -1,7 +1,12 @@
 class Telephone
-  def initialize(number)
-    @match = number =~ /^(\(?\d{2}\)?)(\d{4})-?(\d{4})$/
+  def initialize(number, locale)
     @number = number
+    @locale = locale
+    if @locale == :br
+      @match = number =~ /^(\(?\d{2}\)?)(\d{4})-?(\d{4})$/
+    else
+      @match = number =~ /^(\(?[^2-9]\d{2}\)?)(\d{3})-?(\d{4})$/
+    end
     @cleaned_number = $1.nil? ? nil : @number.gsub(/[\(\)-]/, "")
     format_number! if @cleaned_number
   end
@@ -18,7 +23,12 @@ class Telephone
   private
 
   def format_number!
-    @cleaned_number =~ /^(\d{2})(\d{4})(\d{4})$/
-    @number = "(#{$1})#{$2}-#{$3}"
+    if @locale == :br
+      @cleaned_number =~ /^(\d{2})(\d{4})(\d{4})$/
+      @number = "(#{$1})#{$2}-#{$3}"
+    else
+      @cleaned_number =~ /^(\d{3})(\d{3})(\d{4})$/
+      @number = "(#{$1})#{$2}-#{$3}"
+    end
   end
 end

data/lib/validates_telephone/version.rb

@@ -1,3 +1,3 @@
 module ValidatesTelephone
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/fake_app/db/create_users.rb

@@ -1,11 +1,15 @@
 class CreateUsers < ActiveRecord::Migration
   def self.up
-    create_table :users do |u|
+    create_table :br_users do |u|
+      u.string :telephone
+    end
+    create_table :en_users do |u|
       u.string :telephone
     end
   end
 
   def self.down
-    drop_table :users
+    drop_table :br_users
+    drop_table :en_users
   end
 end

data/spec/fake_app/user.rb

@@ -1,3 +1,7 @@
-class User < ActiveRecord::Base
+class BrUser < ActiveRecord::Base
   validates :telephone, :telephone => true
+end
+
+class EnUser < ActiveRecord::Base
+  validates :telephone, :telephone => { :locale => :usa }
 end

data/spec/remarkable/{validate_as_telephone_matcher_spec.rb → validate_as_br_telephone_matcher_spec.rb}

@@ -1,16 +1,16 @@
 require 'spec_helper'
 require 'remarkable/active_record'
 
-describe Remarkable::ActiveRecord::Matchers::ValidateAsTelephoneMatcher do
+describe Remarkable::ActiveRecord::Matchers::ValidateAsBrTelephoneMatcher do
   context "on a attribute which validates telephone" do
     it "should require a valid telephone" do
-      @user = User.new(:telephone => '123456')
-      @user.should validate_as_telephone(:telephone)
+      @user = BrUser.new(:telephone => '123456')
+      @user.should validate_as_br_telephone(:telephone)
     end
 
     it "should allow a nil value" do
-      @user = User.new(:telephone => nil)
-      @user.should validate_as_telephone(:telephone)
+      @user = BrUser.new(:telephone => nil)
+      @user.should validate_as_br_telephone(:telephone)
     end
   end
 
@@ -20,7 +20,7 @@ describe Remarkable::ActiveRecord::Matchers::ValidateAsTelephoneMatcher do
     end
 
     it "should not require a valid telephone" do
-      @user.should_not validate_as_telephone(:telephone)
+      @user.should_not validate_as_br_telephone(:telephone)
     end
   end
 end

data/spec/remarkable/validate_as_usa_telephone_matcher_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'remarkable/active_record'
+
+describe Remarkable::ActiveRecord::Matchers::ValidateAsUsaTelephoneMatcher do
+  context "on a attribute which validates telephone" do
+    it "should require a valid telephone" do
+      @user = EnUser.new(:telephone => '123456')
+      @user.should validate_as_usa_telephone(:telephone)
+    end
+
+    it "should allow a nil value" do
+      @user = EnUser.new(:telephone => nil)
+      @user.should validate_as_usa_telephone(:telephone)
+    end
+  end
+
+  context "on a attribute which not validates telephone" do
+    before do
+      @user = Admin.new(:telephone => '123456')
+    end
+
+    it "should not require a valid telephone" do
+      @user.should_not validate_as_usa_telephone(:telephone)
+    end
+  end
+end

data/spec/shoulda-matchers/{validate_as_telephone_matcher_spec.rb → validate_as_br_telephone_matcher_spec.rb}

@@ -1,16 +1,16 @@
 require 'spec_helper'
 require 'shoulda-matchers'
 
-describe Shoulda::Matchers::ActiveModel::ValidateAsTelephoneMatcher do
+describe Shoulda::Matchers::ActiveModel::ValidateAsBrTelephoneMatcher do
   context "on a attribute which validates telephone" do
     it "should require a valid telephone" do
-      @user = User.new(:telephone => '123456')
-      @user.should validate_as_telephone(:telephone)
+      @user = BrUser.new(:telephone => '123456')
+      @user.should validate_as_br_telephone(:telephone)
     end
 
     it "should allow a nil value" do
-      @user = User.new(:telephone => nil)
-      @user.should validate_as_telephone(:telephone)
+      @user = BrUser.new(:telephone => nil)
+      @user.should validate_as_br_telephone(:telephone)
     end
   end
 
@@ -20,7 +20,7 @@ describe Shoulda::Matchers::ActiveModel::ValidateAsTelephoneMatcher do
     end
 
     it "should not require a valid telephone" do
-      @user.should_not validate_as_telephone(:telephone)
+      @user.should_not validate_as_br_telephone(:telephone)
     end
   end
 end

data/spec/shoulda-matchers/validate_as_usa_telephone_matcher_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'shoulda-matchers'
+
+describe Shoulda::Matchers::ActiveModel::ValidateAsUsaTelephoneMatcher do
+  context "on a attribute which validates telephone" do
+    it "should require a valid telephone" do
+      @user = EnUser.new(:telephone => '123456')
+      @user.should validate_as_usa_telephone(:telephone)
+    end
+
+    it "should allow a nil value" do
+      @user = EnUser.new(:telephone => nil)
+      @user.should validate_as_usa_telephone(:telephone)
+    end
+  end
+
+  context "on a attribute which not validates telephone" do
+    before do
+      @user = Admin.new(:telephone => '123456')
+    end
+
+    it "should not require a valid telephone" do
+      @user.should_not validate_as_usa_telephone(:telephone)
+    end
+  end
+end

data/spec/validates_telephone/telephone_spec.rb

@@ -1,51 +1,103 @@
 require 'spec_helper'
 
 describe Telephone do
-  context "should be invalid with" do
-    it "blank number" do
-      Telephone.new('').should_not be_valid
-    end
+  context "with br as locale" do
+    context "should be invalid with" do
+      it "blank number" do
+        Telephone.new('', :br).should_not be_valid
+      end
 
-    it "123456 as number" do
-      Telephone.new('123456').should_not be_valid
-    end
+      it "123456 as number" do
+        Telephone.new('123456', :br).should_not be_valid
+      end
 
-    it "12345678910 as number" do
-      Telephone.new('12345678910').should_not be_valid
+      it "12345678910 as number" do
+        Telephone.new('12345678910', :br).should_not be_valid
+      end
     end
-  end
 
-  context "should be valid with" do
-    it "nil as number" do
-      Telephone.new(nil).should be_valid
+    context "should be valid with" do
+      it "nil as number" do
+        Telephone.new(nil, :br).should be_valid
+      end
+
+      it "1111111111 as number" do
+        Telephone.new('1111111111', :br).should be_valid
+      end
+
+      it "(11)11111111 as number" do
+        Telephone.new('(11)11111111', :br).should be_valid
+      end
+
+      it "111111-1111 as number" do
+        Telephone.new('111111-1111', :br).should be_valid
+      end
+
+      it "(11)1111-1111 as number" do
+        Telephone.new('(11)1111-1111', :br).should be_valid
+      end
     end
 
-    it "1111111111 as number" do
-      Telephone.new('1111111111').should be_valid
+    context "with a valid value" do
+      it "should return it formatted" do
+        Telephone.new('1111111111', :br).number.should == '(11)1111-1111'
+      end
     end
 
-    it "(11)11111111 as number" do
-      Telephone.new('(11)11111111').should be_valid
+    context "with an invalid value" do
+      it "should return as it was" do
+        Telephone.new('123456', :br).number.should == '123456'
+      end
     end
+  end
 
-    it "111111-1111 as number" do
-      Telephone.new('111111-1111').should be_valid
+  context "with usa as locale" do
+    context "should be invalid with" do
+      it "blank number" do
+        Telephone.new('', :en).should_not be_valid
+      end
+
+      it "123456 as number" do
+        Telephone.new('123456', :en).should_not be_valid
+      end
+
+      it "12345678910 as number" do
+        Telephone.new('12345678910', :en).should_not be_valid
+      end
     end
 
-    it "(11)1111-1111 as number" do
-      Telephone.new('(11)1111-1111').should be_valid
+    context "should be valid with" do
+      it "nil as number" do
+        Telephone.new(nil, :en).should be_valid
+      end
+
+      it "1111111111 as number" do
+        Telephone.new('1111111111', :en).should be_valid
+      end
+
+      it "(11)11111111 as number" do
+        Telephone.new('(111)1111111', :en).should be_valid
+      end
+
+      it "111111-1111 as number" do
+        Telephone.new('111111-1111', :en).should be_valid
+      end
+
+      it "(11)1111-1111 as number" do
+        Telephone.new('(111)111-1111', :en).should be_valid
+      end
     end
-  end
 
-  context "with a valid value" do
-    it "should return it formatted" do
-      Telephone.new('1111111111').number.should == '(11)1111-1111'
+    context "with a valid value" do
+      it "should return it formatted" do
+        Telephone.new('1111111111', :en).number.should == '(111)111-1111'
+      end
     end
-  end
 
-  context "with an invalid value" do
-    it "should return as it was" do
-      Telephone.new('123456').number.should == '123456'
+    context "with an invalid value" do
+      it "should return as it was" do
+        Telephone.new('123456', :en).number.should == '123456'
+      end
     end
   end
 end

data/spec/validates_telephone_spec.rb

@@ -1,38 +1,78 @@
 require 'spec_helper'
 
 describe TelephoneValidator do
-  context "when telephone is invalid" do
-    before :each do
-      @user = User.new(:telephone => "12345")
+  context "with br as locale" do
+    context "when telephone is invalid" do
+      before :each do
+        @user = BrUser.new(:telephone => "12345")
+      end
+
+      it "should set object as invalid" do
+        @user.valid?.should be_false
+      end
+
+      it "should set an error on attribute" do
+        @user.valid?
+        @user.errors[:telephone].should == ['is invalid']
+      end
     end
 
-    it "should set object as invalid" do
-      @user.valid?.should be_false
+    context "when telephone is valid" do
+      before :each do
+        @user = BrUser.new(:telephone => "(11)1111-1111")
+      end
+
+      it "should set object as valid" do
+        @user.valid?.should be_true
+      end
+
+      it "should not set an error on attribute" do
+        @user.valid?
+        @user.errors[:telephone].should be_blank
+      end
     end
 
-    it "should set an error on attribute" do
-      @user.valid?
-      @user.errors[:telephone].should == ['is invalid']
+    it "should accept a nil value" do
+      @user = BrUser.new(:telephone => nil)
+      @user.valid?.should be_true
     end
   end
 
-  context "when telephone is valid" do
-    before :each do
-      @user = User.new(:telephone => "(11)1111-1111")
-    end
+  context "with usa as locale" do
+    context "when telephone is invalid" do
+      before :each do
+        @user = EnUser.new(:telephone => "12345")
+      end
 
-    it "should set object as valid" do
-      @user.valid?.should be_true
+      it "should set object as invalid" do
+        @user.valid?.should be_false
+      end
+
+      it "should set an error on attribute" do
+        @user.valid?
+        @user.errors[:telephone].should == ['is invalid']
+      end
     end
 
-    it "should not set an error on attribute" do
-      @user.valid?
-      @user.errors[:telephone].should be_blank
+    context "when telephone is valid" do
+      before :each do
+        @user = EnUser.new(:telephone => "(111)111-1111")
+        @user.valid?
+      end
+
+      it "should set object as valid" do
+        @user.valid?.should be_true
+      end
+
+      it "should not set an error on attribute" do
+        @user.valid?
+        @user.errors[:telephone].should be_blank
+      end
     end
-  end
 
-  it "should accept a nil value" do
-    @user = User.new(:telephone => nil)
-    @user.valid?.should be_true
+    it "should accept a nil value" do
+      @user = EnUser.new(:telephone => nil)
+      @user.valid?.should be_true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validates_telephone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &15519440 !ruby/object:Gem::Requirement
+  requirement: &16238060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *15519440
+  version_requirements: *16238060
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15517760 !ruby/object:Gem::Requirement
+  requirement: &16236300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15517760
+  version_requirements: *16236300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15517220 !ruby/object:Gem::Requirement
+  requirement: &16235760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *15517220
+  version_requirements: *16235760
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
-  requirement: &15516700 !ruby/object:Gem::Requirement
+  requirement: &16235240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *15516700
+  version_requirements: *16235240
 - !ruby/object:Gem::Dependency
   name: remarkable_activerecord
-  requirement: &15516120 !ruby/object:Gem::Requirement
+  requirement: &16234660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +65,10 @@ dependencies:
         version: 4.0.0.alpha4
   type: :development
   prerelease: false
-  version_requirements: *15516120
+  version_requirements: *16234660
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &15515680 !ruby/object:Gem::Requirement
+  requirement: &16234240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15515680
+  version_requirements: *16234240
 description: Validates Telephone and test it with macros in a simple way.
 email: plribeiro3000@gmail.com
 executables: []
@@ -90,16 +90,20 @@ files:
 - README.rdoc
 - Rakefile
 - lib/validates_telephone.rb
-- lib/validates_telephone/remarkable/validate_as_telephone_matcher.rb
-- lib/validates_telephone/shoulda-matchers/validate_as_telephone_matcher.rb
+- lib/validates_telephone/remarkable/validate_as_br_telephone_matcher.rb
+- lib/validates_telephone/remarkable/validate_as_usa_telephone_matcher.rb
+- lib/validates_telephone/shoulda-matchers/validate_as_br_telephone_matcher.rb
+- lib/validates_telephone/shoulda-matchers/validate_as_usa_telephone_matcher.rb
 - lib/validates_telephone/telephone.rb
 - lib/validates_telephone/version.rb
 - spec/fake_app/admin.rb
 - spec/fake_app/db/create_admins.rb
 - spec/fake_app/db/create_users.rb
 - spec/fake_app/user.rb
-- spec/remarkable/validate_as_telephone_matcher_spec.rb
-- spec/shoulda-matchers/validate_as_telephone_matcher_spec.rb
+- spec/remarkable/validate_as_br_telephone_matcher_spec.rb
+- spec/remarkable/validate_as_usa_telephone_matcher_spec.rb
+- spec/shoulda-matchers/validate_as_br_telephone_matcher_spec.rb
+- spec/shoulda-matchers/validate_as_usa_telephone_matcher_spec.rb
 - spec/spec_helper.rb
 - spec/validates_telephone/telephone_spec.rb
 - spec/validates_telephone_spec.rb