phony_rails 0.14.9 → 0.15.0

data/lib/phony_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhonyRails
-  VERSION = '0.14.9'
+  VERSION = '0.15.0'
 end

data/lib/validators/phony_validator.rb

@@ -4,6 +4,7 @@
 # Usage:
 #   validate :phone_number, :phony_plausible => true
 require 'active_model'
+
 class PhonyPlausibleValidator < ActiveModel::EachValidator
   # Validates a String using Phony.plausible? method.
   def validate_each(record, attribute, value)
@@ -13,6 +14,8 @@ class PhonyPlausibleValidator < ActiveModel::EachValidator
     value = PhonyRails.normalize_number(value.dup, default_country_code: normalized_country_code) if normalized_country_code
     value = PhonyRails.extract_extension(value).first
     @record.errors.add(attribute, error_message) unless Phony.plausible?(value, cc: country_number)
+    @record.public_send("#{attribute}=", @record.public_send("#{attribute}_original")) if @record.respond_to?("#{attribute}_original") &&
+                                                                                          !Phony.plausible?(value, cc: country_number)
   end
 
   private

data/phony_rails.gemspec

@@ -16,12 +16,14 @@ Gem::Specification.new do |gem|
   gem.name          = 'phony_rails'
   gem.require_paths = ['lib']
   gem.version       = PhonyRails::VERSION
+  gem.required_ruby_version = '>= 2.4'
 
-  gem.post_install_message = 'PhonyRails v0.10.0 changes the way numbers are stored!'
-  gem.post_install_message = "It now adds a '+' to the normalized number when it starts with a country number!"
+  gem.post_install_message = "PhonyRails v0.10.0 changes the way numbers are stored!\nIt now adds a ' + ' to the normalized number when it starts with a country number!"
 
   gem.add_runtime_dependency 'activesupport', '>= 3.0'
-  gem.add_runtime_dependency 'phony', '> 2.15'
+  gem.add_runtime_dependency 'phony', '>= 2.18.12'
   gem.add_development_dependency 'activerecord', '>= 3.0'
-  gem.add_development_dependency 'mongoid', '>= 3.0'
+
+  # For testing
+  gem.add_development_dependency 'sqlite3', '>= 1.4.0'
 end

data/spec/lib/phony_rails_spec.rb

@@ -2,9 +2,8 @@
 
 require 'spec_helper'
 
+EXT_PREFIXES = %w[ext ex x xt # :].freeze
 describe PhonyRails do
-  EXT_PREFIXES = %w[ext ex x xt # :].freeze
-
   it 'should not pollute the global namespace with a Country class' do
     should_not be_const_defined 'Country'
   end
@@ -200,17 +199,20 @@ describe PhonyRails do
             end
           end
 
+          # rubocop:disable Lint/ConstantDefinitionInBlock
           class NormalHome < ActiveRecord::Base
             attr_accessor :phone_number
+
             phony_normalize :phone_number, default_country_code: 'US'
             validates :phone_number, phony_plausible: true
           end
+          # rubocop:enable Lint/ConstantDefinitionInBlock
 
           normal = NormalHome.new
           normal.phone_number = 'HAHA'
           expect(normal).to_not be_valid
           expect(normal.phone_number).to eq('HAHA')
-          expect(normal.errors.messages).to include(phone_number: ['is an invalid number'])
+          expect(normal.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
         end
 
         it 'should pass Github issue #170' do
@@ -224,6 +226,36 @@ describe PhonyRails do
           phone = PhonyRails.normalize_number(phone, default_country_code: 'DE')
           expect(phone).to eq('+491751234567')
         end
+
+        it 'should pass Github issue #175' do
+          phone = '0041 23456789'
+          phone = PhonyRails.normalize_number(phone, default_country_code: 'DE')
+          expect(phone).to eq('+4123456789')
+        end
+
+        it 'should pass Github issue #175' do
+          phone = '+1 260-437-9123'
+          phone = PhonyRails.normalize_number(phone, default_country_code: 'DE')
+          expect(phone).to eq('+12604379123')
+        end
+
+        it 'should pass Github issue #187' do
+          phone1 = '0037253400030'
+          phone1 = PhonyRails.normalize_number(phone1, default_country_code: 'EE')
+          expect(phone1).to eq('+37253400030')
+
+          phone2 = '0037275016183'
+          phone2 = PhonyRails.normalize_number(phone2, default_country_code: 'EE')
+          expect(phone2).to eq('+37275016183')
+        end
+
+        it 'should pass Github issue #180' do
+          phone = '5555555555'
+          phone = PhonyRails.normalize_number(phone, default_country_code: 'AU')
+          expect(phone).to eq('+615555555555')
+          phone = PhonyRails.normalize_number(phone, default_country_code: 'AU')
+          expect(phone).to eq('+615555555555')
+        end
       end
 
       it 'should not change original String' do
@@ -409,6 +441,7 @@ describe PhonyRails do
     subject { described_class }
     let(:valid_number) { '1 555 555 5555' }
     let(:invalid_number) { '123456789 123456789 123456789 123456789' }
+    let(:another_invalid_number) { '441212' }
     let(:normalizable_number) { '555 555 5555' }
     let(:formatted_french_number_with_country_code) { '+33 627899541' }
     let(:empty_number) { '' }
@@ -418,8 +451,11 @@ describe PhonyRails do
       is_expected.to be_plausible_number valid_number, country_code: 'US'
     end
 
-    it 'returns false for an invalid number' do
+    it 'returns false for an invalid numbers' do
+      is_expected.not_to be_plausible_number invalid_number
       is_expected.not_to be_plausible_number invalid_number, country_code: 'US'
+      is_expected.not_to be_plausible_number another_invalid_number
+      is_expected.not_to be_plausible_number another_invalid_number, country_code: 'US'
     end
 
     it 'returns true for a normalizable number' do
@@ -451,6 +487,10 @@ describe PhonyRails do
       is_expected.not_to be_plausible_number normalizable_number, country_code: 'US'
     end
 
+    it 'should pass Github issue #95' do
+      is_expected.to be_plausible_number '+358414955444', default_country_code: :de
+    end
+
     context 'with default_country_code set' do
       before { PhonyRails.default_country_code = 'FR' }
       after { PhonyRails.default_country_code = nil }
@@ -472,7 +512,7 @@ describe PhonyRails do
     after { PhonyRails.default_country_code = nil }
 
     it 'can set a global default country code' do
-      expect(PhonyRails.default_country_code). to eq 'US'
+      expect(PhonyRails.default_country_code).to eq 'US'
     end
 
     it 'can set a global default country code' do
@@ -501,6 +541,12 @@ describe PhonyRails do
     end
   end
 
+  describe 'PhonyRails.country_code_from_number' do
+    it 'returns the code of the plausible phone number' do
+      expect(PhonyRails.country_code_from_number('+32475000000')).to eq '32'
+    end
+  end
+
   describe 'PhonyRails.country_from_number' do
     it 'returns the country of the plausible phone number' do
       expect(PhonyRails.country_from_number('+32475000000')).to eq 'BE'
@@ -879,9 +925,9 @@ describe PhonyRails do
     end
   end
 
-  describe 'Mongoid' do
-    let(:model_klass) { MongoidModel }
-    let(:dummy_klass) { MongoidDummy }
-    it_behaves_like 'model with PhonyRails'
-  end
+  # describe 'Mongoid' do
+  #   let(:model_klass) { MongoidModel }
+  #   let(:dummy_klass) { MongoidDummy }
+  #   it_behaves_like 'model with PhonyRails'
+  # end
 end

data/spec/lib/validators/phony_validator_spec.rb

@@ -60,71 +60,86 @@ ActiveRecord::Schema.define do
     table.column :phone_number, :string
     table.column :phone_number_country_code, :string
   end
+
+  create_table :normalizabled_phone_homes do |table|
+    table.column :phone_number, :string
+  end
 end
 
 #--------------------
 class SimpleHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates :phone_number, phony_plausible: true
 end
 
 #--------------------
 class HelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number
 end
 
 #--------------------
 class RequiredHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, presence: true
 end
 
 #--------------------
 class OptionalHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, presence: false
 end
 
 #--------------------
 class FormattedHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, with: /\A\+\d+/
 end
 
 #--------------------
 class NotFormattedHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, without: /\A\+\d+/
 end
 
 #--------------------
 class NormalizableHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, normalized_country_code: 'US'
 end
 
 #--------------------
 class AustralianHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, country_number: '61'
 end
 
 #--------------------
 class PolishHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, country_code: 'PL'
 end
 
 #--------------------
 class BigHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, presence: true, with: /\A\+\d+/, country_number: '33'
 end
 
 #--------------------
 class MismatchedHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number, :country_code
+
   validates :phone_number, phony_plausible: { ignore_record_country_code: true }
 end
 
@@ -132,6 +147,7 @@ end
 
 class InvalidCountryCodeHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number
 
   def country_code
@@ -142,30 +158,45 @@ end
 #--------------------
 class SymbolizableHelpfulHome < ActiveRecord::Base
   attr_accessor :phone_number, :phone_number_country_code
+
   validates_plausible_phone :phone_number, country_code: :phone_number_country_code
 end
 
 #--------------------
 class NoModelMethod < HelpfulHome
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, country_code: :nonexistent_method
 end
 
 #--------------------
 class MessageOptionUndefinedInModel < HelpfulHome
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, message: :email
 end
 
 #--------------------
 class MessageOptionSameAsModelMethod < HelpfulHome
   attr_accessor :phone_number
+
   validates_plausible_phone :phone_number, message: :email
 
   def email
     'user@example.com'
   end
 end
+
+#--------------------
+class NormalizabledPhoneHome < ActiveRecord::Base
+  attr_accessor :phone_number, :phone_number2, :country_code
+
+  validates_plausible_phone :phone_number
+  validates_plausible_phone :phone_number2
+  phony_normalize :phone_number, country_code: 'PL', normalize_when_valid: true
+  phony_normalize :phone_number2, country_code: 'PL', normalize_when_valid: true
+end
+
 #-----------------------------------------------------------------------------------------------------------------------
 # Tests
 #-----------------------------------------------------------------------------------------------------------------------
@@ -180,6 +211,7 @@ POLISH_NUMBER_WITH_COUNTRY_CODE = '48600600600'
 FORMATTED_AUSTRALIAN_NUMBER_WITH_COUNTRY_CODE = '+61 390133997'
 FRENCH_NUMBER_WITH_COUNTRY_CODE = '33627899541'
 FORMATTED_FRENCH_NUMBER_WITH_COUNTRY_CODE = '+33 627899541'
+CROATIA_NUMBER_WITH_COUNTRY_CODE = '385 98 352 085'
 INVALID_NUMBER = '123456789 123456789 123456789 123456789'
 NOT_A_NUMBER = 'HAHA'
 JAPAN_COUNTRY = 'jp'
@@ -209,26 +241,26 @@ describe PhonyPlausibleValidator do
     it 'should invalidate an invalid number' do
       @home.phone_number = INVALID_NUMBER
       expect(@home).to_not be_valid
-      expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+      expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
     end
 
     it 'should invalidate an valid number with invalid extension' do
       @home.phone_number = VALID_NUMBER_WITH_INVALID_EXTENSION
       expect(@home).to_not be_valid
-      expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+      expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
     end
 
     it 'should invalidate not a number' do
       @home.phone_number = NOT_A_NUMBER
       expect(@home).to_not be_valid
-      expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+      expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
     end
 
     it 'should translate the error message in Dutch' do
       I18n.with_locale(:nl) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['is geen geldig nummer'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is geen geldig nummer'])
       end
     end
 
@@ -236,7 +268,7 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:en) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -244,7 +276,7 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:es) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['es un número inválido'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['es un número inválido'])
       end
     end
 
@@ -252,7 +284,7 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:fr) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['est un numéro invalide'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['est un numéro invalide'])
       end
     end
 
@@ -260,7 +292,7 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:ja) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['は正しい電話番号ではありません'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['は正しい電話番号ではありません'])
       end
     end
 
@@ -268,7 +300,15 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:km) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['គឺជាលេខមិនត្រឹមត្រូវ'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['គឺជាលេខមិនត្រឹមត្រូវ'])
+      end
+    end
+
+    it 'should translate the error message in Korean' do
+      I18n.with_locale(:ko) do
+        @home.phone_number = INVALID_NUMBER
+        @home.valid?
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['는 올바른 전화번호가 아닙니다'])
       end
     end
 
@@ -276,7 +316,7 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:uk) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['є недійсним номером'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['є недійсним номером'])
       end
     end
 
@@ -284,7 +324,7 @@ describe PhonyPlausibleValidator do
       I18n.with_locale(:ru) do
         @home.phone_number = INVALID_NUMBER
         @home.valid?
-        expect(@home.errors.messages).to include(phone_number: ['является недействительным номером'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['является недействительным номером'])
       end
     end
   end
@@ -312,7 +352,7 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate an invalid number' do
         @home.phone_number = INVALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -324,7 +364,7 @@ describe ActiveModel::Validations::HelperMethods do
 
       it 'should invalidate an empty number' do
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ["can't be blank"])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ["can't be blank"])
       end
 
       it 'should validate a valid number' do
@@ -335,7 +375,7 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate an invalid number' do
         @home.phone_number = INVALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -363,7 +403,7 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate an invalid number' do
         @home.phone_number = INVALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -375,7 +415,7 @@ describe ActiveModel::Validations::HelperMethods do
 
       it 'should invalidate an empty number' do
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is invalid'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is invalid'])
       end
 
       it 'should validate a well formatted valid number' do
@@ -386,7 +426,7 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate a bad formatted valid number' do
         @home.phone_number = VALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is invalid'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is invalid'])
       end
     end
 
@@ -408,7 +448,7 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate a bad formatted valid number' do
         @home.phone_number =  "+#{VALID_NUMBER}"
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is invalid'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is invalid'])
       end
     end
 
@@ -430,13 +470,13 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate a valid number with the wrong country code' do
         @home.phone_number = FRENCH_NUMBER_WITH_COUNTRY_CODE
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
 
       it 'should invalidate a valid number without a country code' do
         @home.phone_number = VALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -463,7 +503,7 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate an invalid number' do
         @home.phone_number = INVALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -485,13 +525,13 @@ describe ActiveModel::Validations::HelperMethods do
       it 'should invalidate a valid number with the wrong country code' do
         @home.phone_number = FRENCH_NUMBER_WITH_COUNTRY_CODE
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
 
       it 'should invalidate a valid number without a country code' do
         @home.phone_number = VALID_NUMBER
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
     end
 
@@ -584,14 +624,20 @@ describe ActiveModel::Validations::HelperMethods do
         @home.phone_number = FRENCH_NUMBER_WITH_COUNTRY_CODE
         @home.phone_number_country_code = 'PL'
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
       end
 
       it 'should invalidate a valid number without a country code' do
         @home.phone_number = VALID_NUMBER
         @home.phone_number_country_code = 'PL'
         expect(@home).to_not be_valid
-        expect(@home.errors.messages).to include(phone_number: ['is an invalid number'])
+        expect(@home.errors.messages.to_hash).to include(phone_number: ['is an invalid number'])
+      end
+
+      it 'should pass Gitlab issue #165' do
+        @home.phone_number = CROATIA_NUMBER_WITH_COUNTRY_CODE
+        @home.phone_number_country_code = 'HR'
+        expect(@home).to be_valid
       end
     end
 
@@ -626,5 +672,38 @@ describe ActiveModel::Validations::HelperMethods do
         @home.save
       end
     end
+
+    context 'when a number has already code_number' do
+      it 'does not normalize code after validation' do
+        @home = NormalizabledPhoneHome.new
+        @home.phone_number = '+44 799 449 595'
+        @home.country_code = 'PL'
+
+        expect(@home).to_not be_valid
+        expect(@home.phone_number).to eql('+44 799 449 595')
+
+        @home.phone_number = '+48 799 449 595'
+
+        expect(@home).to be_valid
+        expect(@home.phone_number).to eql('+48799449595')
+      end
+
+      it 'does not normalize code after validation with multiple attributes' do
+        @home = NormalizabledPhoneHome.new
+        @home.phone_number = '+44 799 449 595'
+        @home.phone_number2 = '+44 222 111 333'
+        @home.country_code = 'PL'
+
+        expect(@home).to_not be_valid
+        expect(@home.phone_number).to eql('+44 799 449 595')
+        expect(@home.phone_number2).to eql('+44 222 111 333')
+
+        @home.phone_number = '+48 799 449 595'
+        @home.phone_number2 = '+48 222 111 333'
+        expect(@home).to be_valid
+        expect(@home.phone_number).to eql('+48799449595')
+        expect(@home.phone_number2).to eql('+48222111333')
+      end
+    end
   end
 end