validates_telephone 0.2.1 → 1.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/LICENSE

@@ -0,0 +1,20 @@
+(The MIT License)
+
+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.rdoc

@@ -2,42 +2,47 @@
 
 Rails gem to validate Telephone.
 
-== Install
+## Installation
 
-gem install validates_telephone
+Add this line to your application's Gemfile:
 
-== Usage
+    gem 'validates_telephone'
 
-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:
+And then execute:
 
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validates_telephone
+
+== Basic Usage
+
+It will accept a valid telephone from Brasil or United States by default:
+
+```ruby
 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:
+In case you want it to be a valid telephone for just one place at a time, pass the locale:
 
+```ruby
 class User < ActiveRecord::Base
-    validates :telephone, :telephone => { :locale => :usa }
+    validates :br_telephone, :telephone => { :locale => :br }
+    validates :usa_telephone, :telephone => { :locale => :usa }
 end
+```
 
 == Test
 
-This gem has matchers for shoulda-matchers and remarkable.
-
-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.
+This gem has builtin matchers for shoulda-matchers and remarkable.
 
-== Future
+== Contributing
 
-Add Support for other countries. For now it only supports Brazil and United States telephones.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/validates_telephone/formatter.rb

@@ -0,0 +1,21 @@
+module ValidatesTelephone
+  module Formatter
+    def self.br(number)
+      return nil if number.nil?
+      number.gsub(/[\(\)-]/, "") =~ /^(\d{2})(\d{4})(\d{4})$/
+      return number if $1.nil?
+      "(#{$1})#{$2}-#{$3}"
+    end
+
+    def self.usa(number)
+      return nil if number.nil?
+      number.gsub(/[\(\)-]/, "") =~ /^(\d{3})(\d{3})(\d{4})$/
+      return number if $1.nil?
+      "(#{$1})#{$2}-#{$3}"
+    end
+
+    def self.any(number)
+      number
+    end
+  end
+end

data/lib/validates_telephone/regex.rb

@@ -0,0 +1,15 @@
+module ValidatesTelephone
+  module Regex
+    def self.br(number)
+      number =~ /^(\(?\d{2}\)?)(\d{4})-?(\d{4})$/
+    end
+
+    def self.usa(number)
+      number =~ /^(\(?[^2-9]\d{2}\)?)(\d{3})-?(\d{4})$/
+    end
+
+    def self.any(number)
+      number =~ /^(\(\d{2}\))(\d{4})-(\d{4})|(\([^2-9]\d{2}\))(\d{3})-(\d{4})$/
+    end
+  end
+end

data/lib/validates_telephone/remarkable/require_a_valid_telephone_matcher.rb

@@ -0,0 +1,43 @@
+require 'remarkable/active_model'
+
+module Remarkable
+  module ActiveModel
+    module Matchers
+      class RequireAValidTelephoneMatcher < Remarkable::ActiveModel::Base
+        arguments :telephone
+
+        optional :locale
+
+        collection_assertions :telephone_valid?, :telephone_invalid?
+
+        protected
+
+        def telephone_valid?
+          return allows_value_of("(111)222-3333") if @options[:locale] == :usa
+          return allows_value_of("(11)2222-3333") if @options[:locale] == :br
+          allows_value_of("(111)222-3333") and allows_value_of("(11)2222-3333")
+        end
+
+        def telephone_invalid?
+          return (disallows_value_of("123456") and disallows_value_of("(11)2222-3333")) if @options[:locale] == :usa
+          return (disallows_value_of("123456") and disallows_value_of("(111)222-3333")) if @options[:locale] == :br
+          disallows_value_of("123456")
+        end
+
+        def allows_value_of(telephone)
+          @subject.telephone = telephone
+          @subject.valid?.errors[:telephone].should be_blank
+        end
+
+        def disallows_value_of(telephone)
+          @subject.telephone = telephone
+          @subject.valid?.errors[:telephone].should == ['is invalid']
+        end
+      end
+
+      def require_a_valid_telephone(*args, &block)
+        RequireAValidTelephoneMatcher.new(*args, &block).spec(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require "shoulda-matchers"
+
+module Shoulda
+  module Matchers
+    module ActiveModel
+      def require_a_valid_telephone(attr = :telephone)
+        RequireAValidTelephoneMatcher.new(attr)
+      end
+
+      class RequireAValidTelephoneMatcher< ValidationMatcher
+        def initialize(attribute)
+          @attribute = attribute
+          @options = {}
+        end
+
+        def from(locale)
+          @options[:locale] = locale
+          self
+        end
+
+        def description
+          "require #{@attribute} to be a valid telephone number"
+        end
+
+        def matches?(subject)
+          super(subject)
+
+          disallows_invalid_value and allows_valid_value
+        end
+
+        private
+
+        def disallows_invalid_value
+          return (disallows_value_of("123456") and disallows_value_of("(11)2222-3333")) if @options[:locale] == :usa
+          return (disallows_value_of("123456") and disallows_value_of("(111)222-3333")) if @options[:locale] == :br
+          disallows_value_of("123456")
+        end
+
+        def allows_valid_value
+          return allows_value_of("(111)222-3333") if @options[:locale] == :usa
+          return allows_value_of("(11)2222-3333") if @options[:locale] == :br
+          allows_value_of("(111)222-3333") and allows_value_of("(11)2222-3333")
+        end
+      end
+    end
+  end
+end

data/lib/validates_telephone/telephone_validator.rb

@@ -0,0 +1,7 @@
+class TelephoneValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    key = :"activerecord.errors.models.#{record.class.name.downcase}.attributes.#{attribute.to_s}.invalid"
+    locale = (options[:locale] or :any)
+    record.errors[attribute] << I18n.t(key, :default => :"activerecord.errors.messages.invalid") unless ValidatesTelephone::Validator.new(value, locale).valid?
+  end
+end

data/lib/validates_telephone/validator.rb

@@ -0,0 +1,18 @@
+module ValidatesTelephone
+  class Validator
+    def initialize(number, locale = :any)
+      @number = number
+      @match = ValidatesTelephone::Regex.send(locale, @number)
+      @number = ValidatesTelephone::Formatter.send(locale, @number)
+    end
+
+    def valid?
+      return true if @number.nil?
+      @match
+    end
+
+    def number
+      @number
+    end
+  end
+end

data/lib/validates_telephone/version.rb

@@ -1,3 +1,3 @@
 module ValidatesTelephone
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/lib/validates_telephone.rb

@@ -1,12 +1,12 @@
-require "active_model"
-require "validates_telephone/telephone"
+#Validator
+require "validates_telephone/telephone_validator"
 
-class TelephoneValidator < ActiveModel::EachValidator
-  def validate_each(record, attribute, value)
-    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
+#Rspec Matchers
+require "validates_telephone/shoulda-matchers/require_a_valid_telephone_matcher" if defined?(::Shoulda)
+require "validates_telephone/remarkable/require_a_valid_telephone_matcher" if defined?(::Remarkable)
+
+module ValidatesTelephone
+  autoload :Validator, "validates_telephone/validator"
+  autoload :Regex, "validates_telephone/regex"
+  autoload :Formatter, "validates_telephone/formatter"
 end

data/spec/fake_app/db/create_users.rb

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

data/spec/fake_app/user.rb

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

data/spec/spec_helper.rb

@@ -7,5 +7,4 @@ Dir.glob(File.dirname(__FILE__) + "/fake_app/**/*.rb").each { |file| require fil
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 
-CreateUsers.migrate(:up)
-CreateAdmins.migrate(:up)
+CreateUsers.migrate(:up)

data/spec/validates_telephone/formatter_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ValidatesTelephone::Formatter do
+  context "#br" do
+    context "with a nil value" do
+      it "should return nil" do
+        ValidatesTelephone::Formatter.br(nil).should be_nil
+      end
+    end
+
+    context "with a valid number" do
+      it "should return it formatted" do
+        ValidatesTelephone::Formatter.br("1111111111").should == "(11)1111-1111"
+      end
+    end
+
+    context "with an invalid number" do
+      it "should return as it was" do
+        ValidatesTelephone::Formatter.br("11111111").should == "11111111"
+      end
+    end
+  end
+
+  context "#usa" do
+    context "with a nil value" do
+      it "should return nil" do
+        ValidatesTelephone::Formatter.usa(nil).should be_nil
+      end
+    end
+
+    context "with a valid number" do
+      it "should return it formatted" do
+        ValidatesTelephone::Formatter.usa("1111111111").should == "(111)111-1111"
+      end
+    end
+
+    context "with an invalid number" do
+      it "should return as it was" do
+        ValidatesTelephone::Formatter.usa("11111111").should == "11111111"
+      end
+    end
+  end
+
+  context "#any" do
+    it "should always return the number as it was" do
+      ValidatesTelephone::Formatter.any("11111").should == "11111"
+    end
+  end
+end

data/spec/validates_telephone/regex_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe ValidatesTelephone::Regex do
+  context "#br" do
+    context "with a valid number" do
+      it "should return true" do
+        ValidatesTelephone::Regex.br("(11)1111-1111").should be_true
+      end
+    end
+
+    context "with an invalid number" do
+      it "should return false" do
+        ValidatesTelephone::Regex.br("11111111").should be_false
+      end
+    end
+  end
+
+  context "#usa" do
+    context "with a valid number" do
+      it "should return true" do
+        ValidatesTelephone::Regex.usa("(111)111-1111").should == be_true
+      end
+    end
+
+    context "with an invalid number" do
+      it "should return false" do
+        ValidatesTelephone::Regex.usa("11111111").should be_false
+      end
+    end
+  end
+
+  context "#any" do
+    context "with a valid number from United States" do
+      it "should return true" do
+        ValidatesTelephone::Regex.any("(111)111-1111").should == be_true
+      end
+    end
+
+    context "with a valid number from Brazil" do
+      it "should return true" do
+        ValidatesTelephone::Regex.any("(11)1111-1111").should == be_true
+      end
+    end
+
+    context "with an invalid number" do
+      it "should return nil" do
+        ValidatesTelephone::Regex.any("11111111").should be_false
+      end
+    end
+  end
+end

data/spec/validates_telephone/remarkable/require_a_valid_telephone_matcher_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'remarkable/active_model'
+
+describe Remarkable::ActiveModel::Matchers::RequireAValidTelephoneMatcher do
+  before :each do
+    @user = User.new
+  end
+
+  it "should accept on telephone" do
+    @user.should require_a_valid_telephone(:telephone)
+  end
+
+  it "should accept without a specified attribute" do
+    @user.should require_a_valid_telephone
+  end
+
+  it "should reject on br_telephone" do
+    @user.should_not require_a_valid_telephone(:br_telephone)
+  end
+
+  context "with :br as locale" do
+    it "should accept on br_telephone" do
+      @user.should require_a_valid_telephone(:br_telephone).from(:br)
+    end
+
+    it "should reject on usa_telephone" do
+      @user.should_not require_a_valid_telephone(:usa_telephone).from(:br)
+    end
+  end
+
+  context "with :usa as locale" do
+    it "should accept on usa_telephone" do
+      @user.should require_a_valid_telephone(:usa_telephone).from(:usa)
+    end
+
+    it "should reject on br_telephone" do
+      @user.should_not require_a_valid_telephone(:br_telephone).from(:usa)
+    end
+  end
+end

data/spec/validates_telephone/shoulda-matchers/require_a_valid_telephone_matcher_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'shoulda-matchers'
+
+describe Shoulda::Matchers::ActiveModel::RequireAValidTelephoneMatcher do
+  before :each do
+    @user = User.new
+  end
+
+  it "should accept on telephone" do
+    @user.should require_a_valid_telephone(:telephone)
+  end
+
+  it "should accept without a specified attribute" do
+    @user.should require_a_valid_telephone
+  end
+
+  it "should reject on br_telephone" do
+    @user.should_not require_a_valid_telephone(:br_telephone)
+  end
+
+  context "with :br as locale" do
+    it "should accept on br_telephone" do
+      @user.should require_a_valid_telephone(:br_telephone).from(:br)
+    end
+
+    it "should reject on usa_telephone" do
+      @user.should_not require_a_valid_telephone(:usa_telephone).from(:br)
+    end
+  end
+
+  context "with :usa as locale" do
+    it "should accept on usa_telephone" do
+      @user.should require_a_valid_telephone(:usa_telephone).from(:usa)
+    end
+
+    it "should reject on br_telephone" do
+      @user.should_not require_a_valid_telephone(:br_telephone).from(:usa)
+    end
+  end
+end

data/spec/validates_telephone/validator_spec.rb

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