phony_rails 0.14.11 → 0.14.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: bb21cdef27d6696f003b5d1b60a5c6df7365845366eb36769ee17b11d809e277
-  data.tar.gz: 35e3206fe90042f14332eac06e3e27060ed8cd6fda339863009d55c0f7962291
+SHA1:
+  metadata.gz: f5bc5fd8efabff8b0607fe060f2d27b11ddbd948
+  data.tar.gz: 68add4fb0fc07c768ecafdd390e1ce471940eb07
 SHA512:
-  metadata.gz: 23cee7e1e1d089117a4519c45fd52c456786d92a783f85acc45be269917008b9b50985767fcc630fba544e1a806622e3a37297fad2ed3499a2ab08d5495a36cc
-  data.tar.gz: 6badf776d61071abf152dfe03ff90a585bbc1c13ae83c2cabf6d2c93ea76ee7773455ffe0a03c8615a9865b23cff001b3b56018d8a50c6f95d59ce7ab0423fc0
+  metadata.gz: d61d5e02e7e61a8b15088a09d1ae8cc5db8ce5eb38c388ff2845e27a508a2fde4e12e6780042cec5832992610d54908456423a639671c0a6eb128cb45f24a1ce
+  data.tar.gz: 3e61051454973a4ca74a0e863a500f53dfd49bebf26d7e19d311332d8fc701a20dfe55a2ef035cb1184811fcd14809225629023b15e525dce61167a18637456c

data/.gitignore

@@ -6,3 +6,4 @@
 coverage/*
 /.bundle
 /vendor
+Gemfile.lock

data/.travis.yml

@@ -2,7 +2,8 @@ language: ruby
 rvm:
 - 2.3.7
 - 2.4.4
-- 2.5.1
+- 2.5.5
+- 2.6.2
 script:
 - bundle exec rspec spec
 - bundle exec rubocop

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [v0.14.11](https://github.com/joost/phony_rails/tree/v0.14.11) (2018-10-11)
+[Full Changelog](https://github.com/joost/phony_rails/compare/v0.14.10...v0.14.11)
+
+**Closed issues:**
+
+- Problem with normalizing Estonian number [\#187](https://github.com/joost/phony_rails/issues/187)
+
+**Merged pull requests:**
+
+- Add Korean translation\(including spec\) [\#186](https://github.com/joost/phony_rails/pull/186) ([freelyageha](https://github.com/freelyageha))
+
 ## [v0.14.10](https://github.com/joost/phony_rails/tree/v0.14.10) (2018-10-11)
 [Full Changelog](https://github.com/joost/phony_rails/compare/v0.14.9...v0.14.10)
 

data/Gemfile

@@ -11,6 +11,3 @@ gem 'guard-rspec' # ,    '~> 4.2.0'
 gem 'rake'
 gem 'rspec' # ,          '~> 2.14.0'
 gem 'rubocop'
-
-# For testing
-gem 'sqlite3'

data/README.md

@@ -156,6 +156,22 @@ validates_plausible_phone :phone_number_normalized, presence: true, if: :phone_n
 
 Validation supports phone numbers with extension, such as `+18181231234 x1234` or `'+1 (818)151-5483 #4312'` out-of-the-box.
 
+Return original value after validation:
+
+The flag normalize_when_valid (disabled by default), allows to return the original phone_number when is the object is not valid. When phone validation fails, normalization is not triggered at all. It could prevent a situation where user fills in the phone number and after validation, he gets back different, already normalized phone number value, even if phone number was wrong.
+
+Example usage:
+
+```ruby
+validates_plausible_phone :phone_number
+phony_normalize :phone_number, country_code: :country_code, normalize_when_valid: true
+```
+
+Filling in the number will result with following:
+
+When the number is incorrect (e.g. phone_number: `+44 888 888 888` for country_code 'PL'), the original validation behavior is preserved, but if the number is still invalid, the original value is returned.
+When number is valid, it will save the normalized number (e.g. `+48 888 888 888` will be saved as `+48888888888`).
+
 #### Allowing records country codes to not match phone number country codes
 
 You may have a record specifying one country (via a `country_code` attribute) but using a phone number from another country.  For example, your record may be from Japan but have a phone number from the Philippines. By default, `phony_rails` will consider your record's `country_code` as part of the validation.  If that country doesn't match the country code in the phone number, validation will fail.

data/lib/data/country_codes.yaml

@@ -463,6 +463,8 @@ UA:
   country_code: '380'
 UG:
   country_code: '256'
+UK:
+  country_code: '44'
 UM:
   country_code: ''
 US:

data/lib/phony_rails.rb

@@ -46,18 +46,18 @@ module PhonyRails
   #   http://www.redguava.com.au/2011/06/rails-convert-phone-numbers-to-international-format-for-sms/
   def self.normalize_number(number, options = {}, current_instance = nil)
     return if number.nil?
+
     original_number = number
     number = number.dup # Just to be sure, we don't want to change the original.
     number, ext = extract_extension(number)
     number.gsub!(/[^\(\)\d\+]/, '') # Strips weird stuff from the number
     return if number.blank?
+
     if _country_number = options[:country_number] || country_number_for(options[:country_code])
       options[:add_plus] = true if options[:add_plus].nil?
       # (Force) add country_number if missing
       # NOTE: do we need to force adding country code? Otherwise we can share logic with next block
-      if !Phony.plausible?(number) || _country_number != country_code_from_number(number)
-        number = "#{_country_number}#{number}"
-      end
+      number = "#{_country_number}#{number}" if !Phony.plausible?(number) || _country_number != country_code_from_number(number)
     elsif _default_country_number = extract_default_country_number(options, current_instance)
       options[:add_plus] = true if options[:add_plus].nil?
       number = normalize_number_default_country(number, _default_country_number)
@@ -101,12 +101,14 @@ module PhonyRails
   # Should probably be named 'country_number_from_number'.
   def self.country_code_from_number(number)
     return nil unless Phony.plausible?(number)
+
     Phony.split(Phony.normalize(number)).first
   end
 
   # Returns the country (eg. 'NL') for a number (eg. +31612341234).
   def self.country_from_number(number)
     return nil unless Phony.plausible?(number)
+
     country_codes_hash.select { |_country, hash| hash['country_code'] == country_code_from_number(number) }.keys[0]
   end
 
@@ -115,6 +117,7 @@ module PhonyRails
   # It uses the 'cc' option for Phony. This was a required param before?
   def self.plausible_number?(number, options = {})
     return false if number.blank?
+
     number = extract_extension(number).first
     number = normalize_number(number, options)
     country_number = options[:country_number] || country_number_for(options[:country_code]) ||
@@ -126,10 +129,11 @@ module PhonyRails
     false
   end
 
-  COMMON_EXTENSIONS = /[ ]*(ext|ex|x|xt|#|:)+[^0-9]*\(?([-0-9]{1,})\)?#?$/i
+  COMMON_EXTENSIONS = /[ ]*(ext|ex|x|xt|#|:)+[^0-9]*\(?([-0-9]{1,})\)?#?$/i.freeze
 
   def self.extract_extension(number_and_ext)
     return [nil, nil] if number_and_ext.nil?
+
     subbed = number_and_ext.sub(COMMON_EXTENSIONS, '')
     [subbed, Regexp.last_match(2)]
   end
@@ -156,8 +160,10 @@ module PhonyRails
         attributes.each do |attribute|
           attribute_name = options[:as] || attribute
           raise("No attribute #{attribute_name} found on #{self.class.name} (PhonyRails)") unless self.class.attribute_method?(attribute_name)
+
+          cache_original_attribute(current_instance, attribute) if options[:normalize_when_valid]
           new_value = PhonyRails.normalize_number(send(attribute), options, current_instance)
-          send("#{attribute_name}=", new_value) if new_value || attribute_name != attribute
+          current_instance.public_send("#{attribute_name}=", new_value) if new_value || attribute_name != attribute
         end
       end
 
@@ -169,7 +175,25 @@ module PhonyRails
       end
     end
 
+    def cache_original_attribute(current_instance, attribute)
+      current_instance.define_singleton_method("#{attribute}_original=")  { |value| @original = value }
+      current_instance.define_singleton_method("#{attribute}_original") { @original }
+      current_instance.public_send("#{attribute}_original=", current_instance.public_send(attribute.to_s))
+    end
+
     module ClassMethods
+      PHONY_RAILS_COLLECTION_VALID_KEYS = %i[
+        add_plus
+        as
+        country_code
+        country_number
+        default_country_code
+        default_country_number
+        enforce_record_country
+        if
+        normalize_when_valid
+        unless
+      ].freeze
       # Use this method on the class level like:
       #   phony_normalize :phone_number, :fax_number, :default_country_code => 'NL'
       #
@@ -177,7 +201,7 @@ module PhonyRails
       # you've geocoded before calling this method!
       def phony_normalize(*attributes)
         options = attributes.last.is_a?(Hash) ? attributes.pop : {}
-        options.assert_valid_keys :country_number, :default_country_number, :country_code, :default_country_code, :add_plus, :as, :enforce_record_country, :if, :unless
+        options.assert_valid_keys(*PHONY_RAILS_COLLECTION_VALID_KEYS)
         if options[:as].present?
           raise ArgumentError, ':as option can not be used on phony_normalize with multiple attribute names! (PhonyRails)' if attributes.size > 1
         end
@@ -200,10 +224,12 @@ module PhonyRails
         main_options.assert_valid_keys :country_code, :default_country_code
         attributes.each do |attribute|
           raise(StandardError, "Instance method normalized_#{attribute} already exists on #{name} (PhonyRails)") if method_defined?(:"normalized_#{attribute}")
+
           define_method :"normalized_#{attribute}" do |*args|
             options = main_options.merge(args.first || {})
             assign_values_for_phony_symbol_options(options)
             raise(ArgumentError, "No attribute/method #{attribute} found on #{self.class.name} (PhonyRails)") unless respond_to?(attribute)
+
             options[:country_code] ||= country_code if respond_to?(:country_code)
             PhonyRails.normalize_number(send(attribute), options)
           end

data/lib/phony_rails/string_extensions.rb

@@ -7,6 +7,7 @@ class String
   #   "(0)30 1234 123".phony_normalized(country_code: 'NL') # => '301234123'
   def phony_normalized(options = {})
     raise ArgumentError, "Expected options to be a Hash, got #{options.inspect}" unless options.is_a?(Hash)
+
     options = options.dup
     PhonyRails.normalize_number(self, options)
   end
@@ -24,21 +25,25 @@ class String
   #   "somestring".phone_formatted(raise: true)
   def phony_formatted(options = {})
     raise ArgumentError, "Expected options to be a Hash, got #{options.inspect}" unless options.is_a?(Hash)
+
     options = options.dup
     normalize_country_code = options.delete(:normalize)
     s, ext = PhonyRails.extract_extension(self)
     s = (normalize_country_code ? PhonyRails.normalize_number(s, default_country_code: normalize_country_code.to_s, add_plus: false) : s.gsub(/\D/, ''))
     return if s.blank?
     return if options[:strict] && !Phony.plausible?(s)
+
     PhonyRails.format_extension(Phony.format(s, options.reverse_merge(format: :national)), ext)
   rescue StandardError
     raise if options[:raise]
+
     s
   end
 
   # The bang method
   def phony_formatted!(options = {})
     raise ArgumentError, 'The :strict options is only supported in the phony_formatted (non bang) method.' if options[:strict]
+
     replace(phony_formatted(options))
   end
 end

data/lib/phony_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PhonyRails
-  VERSION = '0.14.11'
+  VERSION = '0.14.12'
 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

@@ -17,11 +17,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = PhonyRails::VERSION
 
-  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_development_dependency 'activerecord', '>= 3.0'
   gem.add_development_dependency 'mongoid', '>= 3.0'
+
+  # For testing
+  gem.add_development_dependency 'sqlite3', '~> 1.3.6'
 end

data/spec/lib/phony_rails_spec.rb

@@ -246,6 +246,14 @@ describe PhonyRails do
           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

data/spec/lib/validators/phony_validator_spec.rb

@@ -60,6 +60,10 @@ 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
 
 #--------------------
@@ -166,6 +170,13 @@ class MessageOptionSameAsModelMethod < HelpfulHome
     'user@example.com'
   end
 end
+#--------------------
+class NormalizabledPhoneHome < ActiveRecord::Base
+  attr_accessor :phone_number, :country_code
+  validates_plausible_phone :phone_number
+  phony_normalize :phone_number, country_code: 'PL', normalize_when_valid: true
+end
+
 #-----------------------------------------------------------------------------------------------------------------------
 # Tests
 #-----------------------------------------------------------------------------------------------------------------------
@@ -641,5 +652,21 @@ 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
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phony_rails
 version: !ruby/object:Gem::Version
-  version: 0.14.11
+  version: 0.14.12
 platform: ruby
 authors:
 - Joost Hietbrink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 description: This Gem adds useful methods to your Rails app to validate, display and
   save phone numbers.
 email:
@@ -81,7 +95,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -112,8 +125,9 @@ homepage: https://github.com/joost/phony_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: It now adds a '+' to the normalized number when it starts with
-  a country number!
+post_install_message: |-
+  PhonyRails v0.10.0 changes the way numbers are stored!
+  It now adds a ' + ' to the normalized number when it starts with a country number!
 rdoc_options: []
 require_paths:
 - lib
@@ -129,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This Gem adds useful methods to your Rails app to validate, display and save

data/Gemfile.lock

@@ -1,143 +0,0 @@
-PATH
-  remote: .
-  specs:
-    phony_rails (0.14.11)
-      activesupport (>= 3.0)
-      phony (> 2.15)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (8.0.0)
-    ast (2.3.0)
-    bson (4.2.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    coveralls (0.8.21)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
-      tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    ffi (1.9.25)
-    formatador (0.2.5)
-    guard (2.14.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-bundler (2.1.0)
-      bundler (~> 1.0)
-      guard (~> 2.2)
-      guard-compat (~> 1.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    i18n (0.9.1)
-      concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
-    method_source (0.9.0)
-    minitest (5.10.3)
-    mongo (2.4.3)
-      bson (>= 4.2.1, < 5.0.0)
-    mongoid (6.2.1)
-      activemodel (~> 5.1)
-      mongo (>= 2.4.1, < 3.0.0)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.12.0)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    phony (2.16.5)
-    powerpack (0.1.1)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (2.2.2)
-      rake
-    rake (12.3.0)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rubocop (0.51.0)
-      parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sqlite3 (1.3.13)
-    term-ansicolor (1.6.0)
-      tins (~> 1.0)
-    thor (0.19.4)
-    thread_safe (0.3.6)
-    tins (1.15.1)
-    tzinfo (1.2.4)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (>= 3.0)
-  coveralls
-  guard
-  guard-bundler
-  guard-rspec
-  mongoid (>= 3.0)
-  phony_rails!
-  rake
-  rspec
-  rubocop
-  sqlite3
-
-BUNDLED WITH
-   1.16.4