russian_phone 0.1.1 → 0.2.4

data/README.md

@@ -4,8 +4,6 @@
 
 Гем для разбора и нормализации русских телефонных номеров
 
-## Внимание: гем находится в разработке и пока не готов для использования
-
 ## Альтернативные решения
 
 https://github.com/floere/phony
@@ -14,10 +12,13 @@ https://github.com/joost/phony_rails
 
 https://github.com/carr/phone
 
-Эти решения поддерживают несколько стран
+Указанные решения поддерживают несколько стран
 
 russian_phone поддерживает и будет поддерживать только российские телефонные номера
 
+Целью данного гема было скорее получение номера в чистом виде (10 значного) из введенных пользователем данных, и
+возможный минимум отбраковки верных номеров, которые сможет разобрать человек, чем 100% отбраковка неверных номеров.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,7 +35,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Использованиие для разбора телефонных номеров:
+
+    # phone = RussianPhone::Number.new('(906) 111-11-11', default_country: 7)
+    => "+7 (906) 111-11-11"
+    # phone.country
+    => "7"
+    # phone.city
+    => "906"
+    # phone.subscriber
+    => "1111111"
+    # phone.full
+    => "+7 (906) 111-11-11"
+    # phone.cell?
+    => true
+    # phone.free?
+    => false
+    # phone.valid?
+    => true
+
+Использование с Mongoid:
+
+    class User
+        include Mongoid::Document
+        field :phone, type: RussianPhone.field(default_country: 7, allowed_cities: [495]), validate: true
+    end
+
+    # u = User.new(phone: '495 1111111')
+    # u.phone
+    => '+7 (495) 111-11-11'
+    # u.phone.valid?
+    => true
+
+Обратите внимание, по умолчанию *валидация телефонного номера выключена*, это значит что номер будет
+сохраняться в базу даже если гем не смог его разобрать. Включите валидацию, установив validate:true.
+
+В базе телефоны храняться в виде строки в полном виде, если телефон удалось разобрать, и в том виде как
+введено пользователем, если не удалось разобрать и validate == false
 
 ## Contributing
 

data/lib/russian_phone/field.rb

@@ -10,7 +10,7 @@ module RussianPhone
 
     ::Mongoid::Fields.option :validate do |model, field, value|
       if value
-        model.validates_with RussianPhone::Validator, fields: [field.name]
+        model.validates_with(RussianPhone::Validator, fields: [field.name])
       end
     end
 

data/lib/russian_phone/number.rb

@@ -34,6 +34,7 @@ module RussianPhone
         @subscriber = data[:subscriber].to_s
         @city = data[:city].to_s
         @country = data[:country].to_s
+        @extra = data[:extra].to_s
       end
 
       data.has_key?(field) ? data[field] : nil
@@ -59,6 +60,10 @@ module RussianPhone
       @country ||= parse(:country)
     end
 
+    def extra
+      @extra ||= parse(:extra)
+    end
+
     def split(format, number)
       number = number.dup
       format.inject([]) do |result, size|
@@ -82,10 +87,10 @@ module RussianPhone
 
     def full
       if valid?
-        if free?
+        if free? && extra == ''
         "8-#{city}-#{format.join('-')}"
         else
-        "+#{country} (#{city}) #{format.join('-')}"
+        "+#{country} (#{city}) #{format.join('-')}#{extra == '' ? '' : ' ' + extra}"
         end
       else
         ''
@@ -118,8 +123,11 @@ module RussianPhone
     end
 
     #def mongoize
-    #  valid? ? full : @phone
+    #  @phone
     #end
+    # alias_method(:as_json, :mongoize)
+
+    alias_method(:as_json, :to_s)
     alias_method(:mongoize, :to_s)
 
     class << self
@@ -127,14 +135,36 @@ module RussianPhone
         string.tr('^0-9', '')
       end
 
+      #def _extract(string, subscriber_digits, code_digits)
+      #  [string[-(subscriber_digits + code_digits), code_digits], string[-subscriber_digits,subscriber_digits]]
+      #end
+
       def _extract(string, subscriber_digits, code_digits)
-        [string[-(subscriber_digits + code_digits), code_digits], string[-subscriber_digits,subscriber_digits]]
+        [string[0, code_digits], string[code_digits, subscriber_digits]]
       end
 
       def extract(string, subscriber_digits, code_digits)
         _extract(clean(string), subscriber_digits, code_digits)
       end
 
+      def _extra(string, position)
+        i = 0
+        digits = 0
+
+        string.each_char do |char|
+          if char.match(/[0-9]/)
+            digits += 1
+          end
+          i += 1
+          # puts "#{char} #{digits} #{i} #{position}"
+          if digits >= position
+            return string[i..-1].strip
+          end
+        end
+
+        ''
+      end
+
       def country_code(string)
         clean(string)[-10, 1]
       end
@@ -166,10 +196,6 @@ module RussianPhone
 
         clean_string = clean(string)
 
-        if clean_string.length > 11
-          return nil
-        end
-
         if clean_string.length < 10
           if opts[:default_city].nil?
             return nil
@@ -186,22 +212,65 @@ module RussianPhone
           end
         end
 
+        extra_after = 10
+
+        if clean_string.length > 10 && string.starts_with?('+7') || string.starts_with?('8 ') || string.starts_with?('8(') || string.starts_with?('8-')
+          clean_string[0] = ''
+          extra_after += 1
+        end
+
+        if clean_string.length == 11 && string.starts_with?('7')
+          clean_string[0] = ''
+          extra_after += 1
+        end
+
+        if clean_string.length == 11 && string.starts_with?('8')
+          clean_string[0] = ''
+          extra_after += 1
+        end
+
+        # handles stuff like 89061010101 д. 123
+        if string.split(' ').length > 1 && string.split(/\D/)[0].length > 10
+          if string.starts_with?('7')
+            clean_string[0] = ''
+            extra_after += 1
+          end
+
+          if string.starts_with?('8')
+            clean_string[0] = ''
+            extra_after += 1
+          end
+        end
+
+        # handle 7906123-12-12 доб 123
+        if clean_string.length > 10 && extra_after == 10 && (clean_string[0] == '7' || clean_string[0] == '8')
+          result = ''
+          string.split(/\D/).each do |segm|
+            result += segm
+            break if result.length >= 10
+          end
+          if result.length > 10
+            clean_string[0] = ''
+            extra_after += 1
+          end
+        end
+
         code_3_digit, phone_7_digit = _extract(clean_string, 7, 3)
         if code_3_digit == '800' || Codes.cell_codes.include?(code_3_digit) || Codes.ndcs_with_7_subscriber_digits.include?(code_3_digit)
-          return {country: opts[:default_country], city: code_3_digit, subscriber: phone_7_digit}
+          return {country: opts[:default_country], city: code_3_digit, subscriber: phone_7_digit, extra: _extra(string, extra_after)}
         end
 
         code_4_digit, phone_6_digit = _extract(clean_string, 6, 4)
         if Codes.ndcs_with_6_subscriber_digits.include? code_4_digit
-          return {country: opts[:default_country], city: code_4_digit, subscriber: phone_6_digit}
+          return {country: opts[:default_country], city: code_4_digit, subscriber: phone_6_digit, extra: _extra(string, extra_after)}
         end
 
         code_5_digit, phone_5_digit = _extract(clean_string, 5, 5)
         if Codes.ndcs_with_5_subscriber_digits.include? code_5_digit
-          return {country: opts[:default_country], city: code_5_digit, subscriber: phone_5_digit}
+          return {country: opts[:default_country], city: code_5_digit, subscriber: phone_5_digit, extra: _extra(string, extra_after)}
         end
 
-        nil
+        return {country: opts[:default_country], city: code_3_digit, subscriber: phone_7_digit, extra: _extra(string, extra_after)}
       end
     end
   end

data/lib/russian_phone/version.rb

@@ -1,3 +1,3 @@
 module RussianPhone
-  VERSION = "0.1.1"
+  VERSION = "0.2.4"
 end

data/spec/phone_spec.rb

@@ -121,7 +121,21 @@ describe RussianPhone do
       phone.full.should eq '+7 (4912) 12-34-56'
     end
 
-    it 'should parse  12-34-56 number whith default city' do
+    it 'should parse 2-34-56 number whith default city' do
+      phone = RussianPhone::Number.new('2-34-56', default_country: 7, default_city: 87252)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_false
+      phone.free?.should be_false
+
+      phone.city.should eq '87252'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '23456'
+      phone.full.should eq '+7 (87252) 2-34-56'
+    end
+
+    it 'should parse 12-34-56 number whith default city' do
       phone = RussianPhone::Number.new('12-34-56', default_country: 7, default_city: 4912)
       phone.should_not be_nil
       phone.valid?.should be_true
@@ -151,6 +165,92 @@ describe RussianPhone do
       phone.full.should eq '+7 (343) 565-67-89'
     end
 
+    it 'should parse  7 (906) 123-45-67 number correctly' do
+      # это номер в Екатеринбурге, с неправильно указанным кодом города
+
+      phone = RussianPhone::Number.new('7 (906) 123-45-67', default_country: 7)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_true
+      phone.free?.should be_false
+      phone.extra.should eq ''
+      phone.city.should eq '906'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '1234567'
+      phone.full.should eq '+7 (906) 123-45-67'
+    end
+
+    it 'should handle phones with extra stuff [8 (906) 111-11-11 доб. 123]' do
+      phone = RussianPhone::Number.new('8 (906) 111-11-11 доб. 123', default_country: 7)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_true
+      phone.free?.should be_false
+
+      phone.city.should eq '906'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '1111111'
+      phone.full.should eq '+7 (906) 111-11-11 доб. 123'
+    end
+
+    it 'should handle phones with extra stuff [8 (906) 111-11-11 д. 123]' do
+      phone = RussianPhone::Number.new('8 (906) 111-11-11 д. 123', default_country: 7)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_true
+      phone.free?.should be_false
+
+      phone.city.should eq '906'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '1111111'
+      phone.full.should eq '+7 (906) 111-11-11 д. 123'
+    end
+
+    it 'should handle phones with extra stuff [89061010101 д. 123]' do
+      phone = RussianPhone::Number.new('89061010101 д. 123', default_country: 7)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_true
+      phone.free?.should be_false
+
+      phone.city.should eq '906'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '1010101'
+      phone.full.should eq '+7 (906) 101-01-01 д. 123'
+    end
+
+    it 'should handle phones with extra stuff [89061010101-д. 123]' do
+      phone = RussianPhone::Number.new('89061010101-д. 123', default_country: 7)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_true
+      phone.free?.should be_false
+
+      phone.city.should eq '906'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '1010101'
+      phone.full.should eq '+7 (906) 101-01-01 -д. 123'
+    end
+
+    it 'should handle phones with unknown codes [8 (533) 111-11-11]' do
+      phone = RussianPhone::Number.new('8 (533) 111-11-11', default_country: 7)
+      phone.should_not be_nil
+      phone.valid?.should be_true
+
+      phone.cell?.should be_false
+      phone.free?.should be_false
+
+      phone.city.should eq '533'
+      phone.country.should eq '7'
+      phone.subscriber.should eq '1111111'
+      phone.full.should eq '+7 (533) 111-11-11'
+    end
+
     tests = {
         '+79261234567' => [7, 926, 1234567],
         '89261234567' => [7, 926, 1234567],
@@ -187,6 +287,8 @@ describe RussianPhone do
         '7 (927) 12 342 34' => [7, 927, 1234234],
         '7-(927)-12-342-34' => [7, 927, 1234234],
         '7 84543 123 12' => [7, 84543, 12312],
+        '78454312312' => [7, 84543, 12312],
+        '88454312312' => [7, 84543, 12312],
     }
 
     tests.each_pair do |str, result|
@@ -212,10 +314,10 @@ describe RussianPhone do
 
     bad_phones = [
         '123 123',
-        '11 11 11 11 11 11 11',
+        '000000',
         '123',
         'пыщ пыщ ололо я водитель НЛО',
-        '11 11 11 11 1'
+        '11 1 11 1'
     ]
 
     bad_phones.each do |phone|
@@ -228,8 +330,15 @@ describe RussianPhone do
 
   describe 'when using ::Field' do
     it 'should serialize and deserialize correctly' do
+      RussianPhone::Number.new('8 (906) 111-11-11 д. 123').mongoize.should eq '+7 (906) 111-11-11 д. 123'
+
       RussianPhone::Number.new('495 111 11 11').mongoize.should eq '+7 (495) 111-11-11'
+
       RussianPhone::Number.demongoize('+7 (495) 111-11-11').mongoize.should eq '+7 (495) 111-11-11'
+
+      RussianPhone::Field.mongoize(RussianPhone::Number.new('495 111 11 11')).should eq '+7 (495) 111-11-11'
+      RussianPhone::Field.evolve(RussianPhone::Number.new('495 111 11 11')).should eq '+7 (495) 111-11-11'
+      RussianPhone::Field.evolve(RussianPhone::Number.new('495 111 11 11 доб 123')).should eq '+7 (495) 111-11-11 доб 123'
     end
   end
 
@@ -292,6 +401,81 @@ describe RussianPhone do
       u = UserWithValidation.new(phone: '495 121 11 11')
       u.valid?.should be_true
       u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '7495 121 11 11')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '7 495 121 11 11')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '8495 121 11 11')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '7495123-12-12 доб 123')
+
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 123-12-12 доб 123'
+      UserWithValidation.first.phone.should eq '+7 (495) 123-12-12 доб 123'
+    end
+
+    it 'should pass validation when phone is valid (unknown city code)' do
+      u = UserWithAnyCode.new(phone: '7701123-12-12 доб 123')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithAnyCode.first.read_attribute(:phone).should eq '+7 (701) 123-12-12 доб 123'
+      UserWithAnyCode.first.phone.should eq '+7 (701) 123-12-12 доб 123'
+    end
+
+    it 'should pass validation when validate is on and phone is valid (unknown city code)' do
+      u = UserWithAnyCode.new(phone: '701123-12-12 доб 123')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithAnyCode.first.read_attribute(:phone).should eq '+7 (701) 123-12-12 доб 123'
+      UserWithAnyCode.first.phone.should eq '+7 (701) 123-12-12 доб 123'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '8 495 121 11 11')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '+7 495 121 11 11')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11'
+    end
+
+    it 'should pass validation when validate is on and phone is valid' do
+      u = UserWithValidation.new(phone: '495 121 11 11 доб 123')
+      u.valid?.should be_true
+      u.save.should be_true
+      UserWithValidation.first.read_attribute(:phone).should eq '+7 (495) 121-11-11 доб 123'
+      UserWithValidation.first.phone.should eq '+7 (495) 121-11-11 доб 123'
     end
 
     it 'should fail validation when validate is on and city is not in allowed_cities' do

data/spec/support/user_with_any_code.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+class UserWithAnyCode
+  include Mongoid::Document
+
+  field :phone, type: RussianPhone.field(default_country: 7), validate: true
+end

data/validate.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+ 
+if ! which md5sum > /dev/null; then
+echo Install md5sum
+exit 1
+fi
+ 
+if ! which curl > /dev/null; then
+echo Install curl
+exit 1
+fi
+ 
+home=$(gem env GEM_HOME)
+cache=$home/cache
+ 
+echo This will take a while...
+ 
+for gem in $cache/*.gem; do
+gemfile=$(basename $gem)
+ 
+local=$(md5sum $gem | awk '{print $1}')
+remote=$(curl -s -D - -X HEAD -H 'Connection:close' http://production.cf.rubygems.org/gems/$gemfile | grep 'ETag' | cut -d '"' -f 2)
+
+# echo $gemfile local: $local, remote: $remote
+ 
+if [[ ! $local = $remote ]]; then
+echo $gemfile mismatch. local: $local, remote: $remote
+fi
+
+
+done
+ 
+echo All done.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: russian_phone
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -114,8 +114,10 @@ files:
 - spec/phone_spec.rb
 - spec/spec_helper.rb
 - spec/support/user.rb
+- spec/support/user_with_any_code.rb
 - spec/support/user_with_validation.rb
 - spec/support/user_without_validation.rb
+- validate.sh
 homepage: https://github.com/glebtv/russian_phone
 licenses: []
 post_install_message: 
@@ -136,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Поле для хранения Российских телефонных номеров в Mongoid
@@ -144,5 +146,6 @@ test_files:
 - spec/phone_spec.rb
 - spec/spec_helper.rb
 - spec/support/user.rb
+- spec/support/user_with_any_code.rb
 - spec/support/user_with_validation.rb
 - spec/support/user_without_validation.rb