phone 1.2.3 → 1.3.0.beta0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f34c77402ea12b6fafbda205f46bb897b0996c66
-  data.tar.gz: f29f3fd69c0f6415ba76d1d16da01279cdc76b8e
+  metadata.gz: 968e42477f674e7f318948884bc9af50d369e934
+  data.tar.gz: fd0e865669d8ba5c3031be42f5bb8b0af92c11f3
 SHA512:
-  metadata.gz: c94ec8394ccd7a4485d56caa2e701d147f241745909622b59a08c05e4d91733f01b21088e7c81d53cdb1a55efb5d73926c46f3abe9bf3496ae8d4a8bc9fa1087
-  data.tar.gz: 23f8e3d274b53614a54964c87bd7cc09a7ef103d47eccf1d53db75a444a986e6e40d8cf80dc657ed0febb7a0a48ec2a631fab8197b0e7f7a5c9bf6016685235c
+  metadata.gz: 920a4b87ec5e07f39d87141d51e9cf916ff20ea833e0d26e2ae98ff267a54d6505acda34b1f5db3750dc60bd2c3756b9c9dfdd7f53664bcabb876805ea2d0d21
+  data.tar.gz: 6dd4129fbd34830c5ca6ce4728ebaf1584878660bf8d8e80a627ceb369aec1d0bf28dddcb76770d0ddb191ca49ce8fa606a74960954a60c4cd889982a18c3386

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+doc/
+pkg/
+tmp/
+vendor/cache/*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+bundler_args: --without doc
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx
+notifications:
+  email:
+    - github@elskwid.net

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "phone Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,50 @@
+# 1.3.0 / (unreleased)
+
+* Update README for yaml name and location (pepe)
+* Relocate / rename `data/phone_countries.yml` to `data/phone/countries.yml` (elskwid)
+* [improvement] Add modern gem infrastructure - add bundler, update gemspec, convert to minitest, locate gem files in proper directories, add .ruby-version, update README, update LICENSE.txt, add Changelog.md. (elskwid)
+* [improvement] Memoize country code regex. (tiegz)
+* [improvement] Update regex for: ZA, UY, NL, BE, FR, HU, PT, UA, RS, HR, SE, SI, and BA. (g1smd)
+* [improvement] Add IE support. (dramalho)
+* [improvement] Update #split_to_parts to provide a format override and handle nil parts. (dramalho)
+* [improvement] Add NZ support. (jurgens)
+* [improvement] Add options support to `#valid?`. (soulcutter)
+* [improvement] Remove need for `cattr_accessor`. (elskwid)
+* [fix] Incorrect error raised when missing phone number and add missing test. (elskwid)
+* [fix] Fix extension handling in `::parse`. (elskwid)
+* [improvement] Remove need for ActiveSupport detection. (elskwid)
+* [improvement] Remove monkeypatching support library. (elskwid)
+* [improvement] Add support for Travis CI. (elskwid)
+
+# 1.2.3 / 2013-11-16
+
+* [fix] Bring changes from v1.1 that were mysteriously missing from repo. (elskwid)
+  - README updates
+  - Spain area code updates
+  - Support 3 character codes for countries
+  - Update default area code
+  - Update `::normalize`
+
+# 1.2.2 / 2013-11-15
+
+* Add license to gemspec. (bf4)
+
+# 1.2.1 / 2013-10-24
+
+* Add errors.rb to gemspec to fix gem. (mtarnovan)
+
+#  1.2 / 2013-10-23 (yanked)
+
+* Released to capture updates made after version 1.1. (elskwid)
+* Add specific exception classes. (miloshadzic)
+
+# 1.1 / 2011-06-23
+
+* Implement `==`. (haxney and carr)
+* Update Uraguay area codes and tests. (tiegz)
+
+# 1.0 / 2011-04-04
+
+* Namespaced library as `Phoner::Phone` (carr)
+
+# Previous versions ...

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :doc do
+  gem "redcarpet"
+end
+
+group :test do
+  gem "rake"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2010-2013 Tomislav Car
+Modifications copyright (c) 2010 Todd Eichel for Fooala, Inc.
+Copyright (c) 2013 Don Morrison
+
+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.md

@@ -0,0 +1,183 @@
+# phone
+
+Parsing, validating and creating phone numbers
+
+* [Homepage](https://github.com/carr/phone#readme)
+* [Issues](https://github.com/carr/phone/issues)
+* [Documentation](http://rubydoc.info/gems/phone/frames)
+* [Email](mailto:don at elskwid.net)
+
+## Version
+
+This documentation is for the unreleased development branch. The current stable version is [1.2.3](https://github.com/carr/phone/tree/v1.2.3)
+
+## Description
+
+TODO: Description
+
+## Features
+
+### Automatic country and area code detection
+
+Phone does its best to automatically detect the country and area code while parsing. To do this, phone uses data stored in `data/phone/countries.yml`.
+
+Each country code can have a regular expression named `area_code` that describes what the area code for that particular country looks like.
+
+If an `area_code` regular expression isn't specified, the default, `Phoner::Phone::DEFAULT_AREA_CODE` (correct for the US) is used.
+
+### Validating
+
+Validating is very relaxed, basically it strips out everything that's not a number or '+' character:
+
+```ruby
+Phoner::Phone.valid? 'blabla 091/512-5486 blabla'
+```
+
+### Formatting
+
+Formating is done via the `#format` method. The method accepts a `Symbol` or a `String`.
+
+When given a string, it interpolates the string with the following fields:
+
+* %c - country_code (385)
+* %a - area_code (91)
+* %A - area_code with leading zero (091)
+* %n - number (5125486)
+* %f - first @@n1_length characters of number (configured through Phoner::Phone.n1_length), default is 3 (512)
+* %l - last characters of number (5486)
+* %x - the extension number
+
+```ruby
+pn = Phoner::Phone.parse('+385915125486')
+pn.to_s # => "+385915125486"
+pn.format("%A/%f-%l") # => "091/512-5486"
+pn.format("+ %c (%a) %n") # => "+ 385 (91) 5125486"
+```
+
+When given a symbol it is used as a lookup for the format in the <tt>Phoner::Phone.named_formats</tt> hash.
+
+```ruby
+pn.format(:europe) # => "+385 (0) 91 512 5486"
+pn.format(:us) # => "(234) 123 4567"
+pn.format(:default_with_extension) # => "+3851234567x143"
+```
+
+You can add your own custom named formats like so:
+
+```ruby
+Phoner::Phone.named_formats[:short] = '%A/%n1-%n2'
+pn.format(:short) # => 091/512-5486
+```
+
+### Finding countries by their isocode
+
+If you don't have the country code, but you know from other sources what country a phone is from, you can retrieve the country using the country isocode (such as 'de', 'es', 'us', ...). Remember to call `Phoner::Country.load` before using this lookup.
+
+```ruby
+if country = Phoner::Country.find_by_country_isocode(user_country_isocode)
+  phone_number = Phoner::Phone.parse(user_input, :country_code => country.country_code)
+end
+```
+
+## Examples
+
+```ruby
+require 'phone'
+```
+
+### Initializing
+
+Initialize a new phone object with the number, area code, country code and extension number:
+
+```ruby
+Phoner::Phone.new('5125486', '91', '385')
+```
+
+```ruby
+Phoner::Phone.new(:number => '5125486', :area_code => '91', :country_code => '385', :extension => '143')
+```
+
+### Parsing
+
+Create a new phone object by parsing from a string. Phoner::Phone does it's best to detect the country and area codes:
+
+```ruby
+Phoner::Phone.parse '+385915125486'
+Phoner::Phone.parse '00385915125486'
+```
+
+If the country or area code isn't given in the string, you must set it, otherwise it doesn't work:
+
+```ruby
+Phoner::Phone.parse '091/512-5486', :country_code => '385'
+Phoner::Phone.parse '(091) 512 5486', :country_code => '385'
+```
+
+If you feel that it's tedious, set the default country code once:
+
+```ruby
+Phoner::Phone.default_country_code = '385'
+Phoner::Phone.parse '091/512-5486'
+Phoner::Phone.parse '(091) 512 5486'
+```
+
+Same goes for the area code:
+
+```ruby
+Phoner::Phone.parse '451-588', :country_code => '385', :area_code => '47'
+```
+or
+
+```ruby
+Phoner::Phone.default_country_code = '385'
+Phoner::Phone.default_area_code = '47'
+
+Phoner::Phone.parse '451-588'
+```
+
+## Test Countries
+
+* [AU] Australia
+* [BA] Bosnia and Herzegovina
+* [BE] Belgium
+* [DE] Germany
+* [ES] Spain
+* [FR] France
+* [GB] United Kingdom
+* [HR] Croatia
+* [HU] Hungary
+* [IE] Ireland
+* [NL] Netherlands
+* [NZ] New Zealand
+* [RS] Serbia
+* [SE] Sweden
+* [SI] Slovenia
+* [UA] Ukraine
+* [US] United States
+* [ZA] South Africa
+
+## Known issues
+
+There's an issue with Germany and Spanish area codes.
+
+## Requirements
+
+
+## Install
+
+    $ gem install phone
+
+Or as a Rails plugin
+
+    $ script/plugin install git://github.com/carr/phone.git
+
+## Copyright
+
+Copyright (c) 2010-2013 Tomislav Car, [Infinum](http://www.infinumdigital.com)
+Copyright (c) 2013 Don Morrison
+
+See {file:LICENSE.txt} for details.
+
+## Contributors
+
+Don Morrison, Michael Squires, Todd Eichel (Fooala, Inc.), chipiga, Etienne Samson, Luke Randall, Jakob Hilden, Tieg Zaharia

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require "rubygems"
+
+begin
+  require "bundler"
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require "rake"
+
+require "rubygems/tasks"
+Gem::Tasks.new
+
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+require "yard"
+YARD::Rake::YardocTask.new
+task :doc => :yard
+
+task :default => :test

data/data/{phone_countries.yml → phone/countries.yml}

@@ -118,7 +118,7 @@
   :char_3_code: ZA
   :name: South Africa
   :international_dialing_prefix: "0"
-  :area_code: "800|860|861|[1-5,7-8][0-9]"
+  :area_code: "800|86[01]|[1-57-8]\\d"
 "508": 
   :country_code: "508"
   :national_dialing_prefix: "0"
@@ -357,7 +357,7 @@
   :char_3_code: UY
   :name: Uruguay
   :international_dialing_prefix: "0"
-  :area_code: "2|42|43[34567]|4364|44[3457]|4452|4542|4544|456[7]?|4586|46[234]|4675|47[237]|4779|9[13456789]"
+  :area_code: "2|42|4364|43[34567]|4452|44[3457]|454[24]|4567?|4586|46[234]|4675|47[237]|4779|9[13456789]"
 "992": 
   :country_code: "992"
   :national_dialing_prefix: "8"
@@ -372,7 +372,7 @@
   :char_3_code: NL
   :name: Netherlands
   :international_dialing_prefix: "0"
-  :area_code: "6760|66|6|800|878|8[4578]|90[069]|1[035]|2[0346]|3[03568]|4[0356]|5[0358]|7[0-9]|11[134578]|16[124-8]|17[24]|18[0-467]|22[2-46-9]|25[125]|29[479]|31[3-8]|32[01]|34[1-8]|41[12368]|47[58]|48[15-8]|49[23579]|5[129][1-9]|54[134-8]|56[126]|57[0-3578]"
+  :area_code: "6760|66|6|800|878|8[4578]|90[069]|1[035]|2[0346]|3[03568]|4[0356]|5[0358]|7\\d|11[134578]|16[124-8]|17[24]|18[0-467]|22[2-46-9]|25[125]|29[479]|31[3-8]|32[01]|34[1-8]|41[12368]|47[58]|48[15-8]|49[23579]|5[129][1-9]|54[134-8]|56[126]|57[0-3578]"
 "850": 
   :country_code: "850"
   :national_dialing_prefix: "0"
@@ -415,7 +415,7 @@
   :char_3_code: BE
   :name: Belgium
   :international_dialing_prefix: "0"
-  :area_code: "800|90[0-9]|2|3|4|9|1[0-69]|5[0-9]|6[013-9]|7[01]|8[1-9]"
+  :area_code: "800|90\\d|2|3|4|9|1[0-69]|5\\d|6[013-9]|7[01]|8[1-9]"
 "965": 
   :country_code: "965"
   :national_dialing_prefix: None
@@ -529,7 +529,7 @@
   :char_3_code: FR
   :name: France
   :international_dialing_prefix: "0"
-  :area_code: "[1-7,8-9]"
+  :area_code: "[1-9]"
 "995": 
   :country_code: "995"
   :national_dialing_prefix: 8*
@@ -572,7 +572,7 @@
   :char_3_code: ES
   :name: Spain
   :international_dialing_prefix: "0"
-  :area_code: "6[0-9][0-9]|7[1-9][0-9]|9[0-9][0-9]"
+  :area_code: "6[0-9][0-9]|7[1-9][0-9]|9[0-9][0-9]"  
 "232": 
   :country_code: "232"
   :national_dialing_prefix: "0"
@@ -636,6 +636,7 @@
   :char_3_code: NZ
   :name: New Zealand
   :international_dialing_prefix: "0"
+  :area_code: "[1-9]"
 "855": 
   :country_code: "855"
   :national_dialing_prefix: "0"
@@ -748,7 +749,7 @@
   :char_3_code: HU
   :name: Hungary
   :international_dialing_prefix: "0"
-  :area_code: "1|[2-9][0-9]"
+  :area_code: "1|[2-9]\\d"
 "263": 
   :country_code: "263"
   :national_dialing_prefix: "0"
@@ -959,7 +960,7 @@
   :char_3_code: PT
   :name: Portugal
   :international_dialing_prefix: "0"
-  :area_code: "21|22|2[3-9][1-9]|70[78]|80[089]|9[136]|92[1-9]"
+  :area_code: "2[12]|2[3-9][1-9]|70[78]|80[089]|9[136]|92[1-9]"
 "973": 
   :country_code: "973"
   :national_dialing_prefix: None
@@ -974,7 +975,7 @@
   :char_3_code: UA
   :name: Ukraine
   :international_dialing_prefix: "00"
-  :area_code: "[1-9][0-9]"
+  :area_code: "[1-9]\\d"
 "41": 
   :country_code: "41"
   :national_dialing_prefix: "0"
@@ -1024,7 +1025,7 @@
   :char_3_code: RS
   :name: Serbia
   :international_dialing_prefix: "99"
-  :area_code: "[1-9][0-9]"
+  :area_code: "[1-9]\\d"
 "975": 
   :country_code: "975"
   :national_dialing_prefix: None
@@ -1046,6 +1047,7 @@
   :char_3_code: IE
   :name: Ireland
   :international_dialing_prefix: "0"
+  :area_code: "1|[2,4-7,9][0-9]|8[0,3-9]|822|818"  
 "692": 
   :country_code: "692"
   :national_dialing_prefix: "1"
@@ -1173,7 +1175,7 @@
   :char_3_code: HR
   :name: Croatia
   :international_dialing_prefix: "0"
-  :area_code: "1|[2-9][0-9]"
+  :area_code: "1|[2-9]\\d"
 "243": 
   :country_code: "243"
   :national_dialing_prefix: None
@@ -1195,7 +1197,7 @@
   :char_3_code: SE
   :name: Sweden
   :international_dialing_prefix: "0"
-  :area_code: "900|1[013689]|2[0136]|3[1356]|4[0246]|54|6[03]|7[01236]|8|9[09]|1[2457][0-9]|2[2457-9][0-9]|3[0247-9][0-9]|4[1357-9][0-9]|5[0-35-9][0-9]|6[124-9][0-9]|74[0-9]|9[1-8][0-9]"
+  :area_code: "900|1[013689]|2[0136]|3[1356]|4[0246]|54|6[03]|7[01236]|8|9[09]|1[2457]\\d|2[2457-9]\\d|3[0247-9]\\d|4[1357-9]\\d|5[0-35-9]\\d|6[124-9]\\d|74\\d|9[1-8]\\d"
 "386": 
   :country_code: "386"
   :national_dialing_prefix: "0"
@@ -1203,7 +1205,7 @@
   :char_3_code: SI
   :name: Slovenia
   :international_dialing_prefix: "0"
-  :area_code: "30|40|31|41|51|71|70|64|59|1|2|3|4|5|6|7"
+  :area_code: "3[01]|4[01]|51|7[01]|64|59|1|2|3|4|5|6|7"
 "358": 
   :country_code: "358"
   :national_dialing_prefix: "0"
@@ -1239,7 +1241,7 @@
   :char_3_code: BA
   :name: Bosnia and Herzegovina
   :international_dialing_prefix: "0"
-  :area_code: "[0-9][0-9]"
+  :area_code: "6|[0-57-9]\\d"
 "245": 
   :country_code: "245"
   :national_dialing_prefix: None