phonie 1.0.4 → 2.0.0

data/lib/phonie/phone.rb

@@ -1,3 +1,7 @@
+require 'active_model/naming'
+require 'active_model/translation'
+require 'active_model/validations'
+
 # An object representing a phone number.
 #
 # The phone number is recorded in 3 separate parts:
@@ -11,6 +15,8 @@
 #
 module Phonie
   class Phone
+    EXTENSION = /[ ]*(ext|ex|x|xt|#|:)+[^0-9]*\(*([-0-9]{1,})\)*#?$/i
+
     attr_accessor :country_code, :area_code, :number, :extension, :country
 
     cattr_accessor :default_country_code
@@ -29,6 +35,11 @@ module Phonie
       :us => "(%a) %f-%l"
     }
 
+    include ActiveModel::Validations
+    validates :country_code, :presence => true
+    validates :area_code, :presence => true
+    validates :number, :presence => true
+
     def initialize(*hash_or_args)
       if hash_or_args.first.is_a?(Hash)
         hash_or_args = hash_or_args.first
@@ -37,103 +48,49 @@ module Phonie
         keys = {:number => 0, :area_code => 1, :country_code => 2, :extension => 3, :country => 4}
       end
 
-      self.number = hash_or_args[ keys[:number] ]
-      self.area_code = hash_or_args[ keys[:area_code] ] || self.default_area_code
+      self.number       = hash_or_args[ keys[:number] ]
+      self.area_code    = hash_or_args[ keys[:area_code] ] || self.default_area_code
       self.country_code = hash_or_args[ keys[:country_code] ] || self.default_country_code
-      self.extension = hash_or_args[ keys[:extension] ]
-      self.country = hash_or_args[ keys[:country] ]
-
-      # Santity checks
-      raise "Must enter number" if self.number.blank?
-      raise "Must enter area code or set default area code" if self.area_code.blank?
-      raise "Must enter country code or set default country code" if self.country_code.blank?
+      self.extension    = hash_or_args[ keys[:extension] ]
+      self.country      = hash_or_args[ keys[:country] ]
     end
 
-    def self.parse!(string, options={})
-        parse(string, options.merge(:raise_exception_on_error => true))
+    def self.parse!(string, options = {})
+      pn = parse(string, options)
+      raise ArgumentError.new("#{string} is not a valid phone number") unless pn && pn.valid?
+      pn
     end
 
     # create a new phone number by parsing a string
     # the format of the string is detect automatically (from FORMATS)
-    def self.parse(string, options={})
-      return nil unless string.present?
+    def self.parse(string, options = {})
+      return unless string.present?
 
-      Country.load
+      options[:country_code] ||= self.default_country_code
+      options[:area_code]    ||= self.default_area_code
 
       extension = extract_extension(string)
       normalized = normalize(string)
 
-      options[:country_code] ||= self.default_country_code
-      options[:area_code] ||= self.default_area_code
-
-      parts = split_to_parts(normalized, options)
-
-      pn = Phone.new(parts) if parts
-      if pn.present? and extension.present?
-        pn.extension = extension
-      end
-      pn
+      return unless country = Country.detect(normalized, options[:country_code], options[:area_code])
+      parts = country.parse(normalized, options[:area_code])
+      parts[:country] = country
+      parts[:country_code] = country.country_code
+      parts[:extension] = extension
+      new(parts)
     end
 
     # is this string a valid phone number?
     def self.valid?(string, options = {})
-      begin
-        parse(string, options).present?
-      rescue
-        false  # don't raise exceptions on parse errors
-      end
+      pn = parse(string, options)
+      pn && pn.valid?
     end
 
     def self.is_mobile?(string, options = {})
       pn = parse(string, options)
-      return false if pn.nil?
-      pn.is_mobile?
-    end
-
-    private
-    # split string into hash with keys :country_code, :area_code and :number
-    def self.split_to_parts(string, options = {})
-      country = Country.detect(string, options[:country_code], options[:area_code])
-
-      if country.nil?
-        raise "Could not determine country" if options[:raise_exception_on_error]
-        return nil
-      end
-
-      country.number_parts(string, options[:area_code])
+      pn && pn.is_mobile?
     end
 
-    # fix string so it's easier to parse, remove extra characters etc.
-    def self.normalize(string_with_number)
-      string_with_number.sub(extension_regex, '').gsub(/\(0\)|[^0-9+]/, '').gsub(/^00/, '+')
-    end
-
-    def self.extension_regex
-      /[ ]*(ext|ex|x|xt|#|:)+[^0-9]*\(*([-0-9]{1,})\)*#?$/i
-    end
-
-    # pull off anything that look like an extension
-    #
-    def self.extract_extension(string)
-      return nil if string.nil?
-      if string.match extension_regex
-        extension = $2
-        return extension
-      end
-      #
-      # We already returned any recognizable extension.
-      # However, we might still have extra junk to the right
-      # of the phone number proper, so just chop it off.
-      #
-      idx = string.rindex(/[0-9]/)
-      return nil if idx.nil?
-      return nil if idx == (string.length - 1)      # at the end
-      string.slice!((idx+1)..-1)                    # chop it
-      return nil
-    end
-
-    public # instance methods
-
     def area_code_long
       "0" + area_code if area_code
     end
@@ -157,7 +114,7 @@ module Phonie
 
     # Formats the phone number.
     #
-    # if the method argument is a String, it is used as a format string, with the following fields being interpolated:  
+    # if the method argument is a String, it is used as a format string, with the following fields being interpolated:
     #
     # * %c - country_code (385)
     # * %a - area_code (91)
@@ -171,7 +128,7 @@ module Phonie
     #   pn.format(:europe)
     def format(fmt)
       if fmt.is_a?(Symbol)
-        raise "The format #{fmt} doesn't exist'" unless named_formats.has_key?(fmt)
+        raise ArgumentError.new("The format #{fmt} doesn't exist") unless named_formats.has_key?(fmt)
         format_number named_formats[fmt]
       else
         format_number(fmt)
@@ -201,15 +158,31 @@ module Phonie
 
     private
 
+    # split string into hash with keys :country_code, :area_code and :number
+    def self.split_to_parts(string, options = {})
+      country = Country.detect(string, options[:country_code], options[:area_code])
+      country && country.parse(string, options[:area_code])
+    end
+
+    # fix string so it's easier to parse, remove extra characters etc.
+    def self.normalize(string_with_number)
+      string_with_number.sub(EXTENSION, '').gsub(/\(0\)|[^0-9+]/, '').gsub(/^00/, '+')
+    end
+
+    # pull off anything that look like an extension
+    def self.extract_extension(string)
+      return unless string && string.match(EXTENSION)
+      Regexp.last_match[2]
+    end
+
     def format_number(fmt)
-      result = fmt.gsub("%c", country_code || "").
-             gsub("%a", area_code || "").
-             gsub("%A", area_code_long || "").
-             gsub("%n", number || "").
-             gsub("%f", number1 || "").
-             gsub("%l", number2 || "").
-             gsub("%x", extension || "")
-      return result
+      fmt.gsub("%c", country_code || "").
+        gsub("%a", area_code || "").
+        gsub("%A", area_code_long || "").
+        gsub("%n", number || "").
+        gsub("%f", number1 || "").
+        gsub("%l", number2 || "").
+        gsub("%x", extension || "")
     end
   end
 end

data/lib/phonie/version.rb

@@ -1,3 +1,3 @@
 module Phonie
-  VERSION = '1.0.4'
+  VERSION = '2.0.0'
 end

data/phonie.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "phonie"
   s.version     = Phonie::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors  = ['Tomislav Car', 'Todd Eichel', 'Don Morrison', 'Wesley Moxam']
-  s.email    = ['tomislav@infinum.hr', 'todd@toddeichel.com', 'elskwid@gmail.com', 'wesley@wmoxam.com']
+  s.authors     = ['Tomislav Car', 'Todd Eichel', 'Don Morrison', 'Wesley Moxam', 'Lance Ivy']
+  s.email       = ['tomislav@infinum.hr', 'todd@toddeichel.com', 'elskwid@gmail.com', 'wesley@wmoxam.com', 'lance@kickstarter.com']
   s.homepage    = "http://github.com/wmoxam/phonie"
   s.summary     = %q{Phone number parsing, validation and formatting}
   s.description = %q{Phone number parsing, validation and formatting}
@@ -15,7 +15,9 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
+
+  s.add_dependency 'activemodel'
+
   s.add_development_dependency 'rake'
   s.add_development_dependency 'nokogiri'
-  s.add_development_dependency 'activemodel'
 end

data/test/countries/gr_test.rb

@@ -4,6 +4,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 class GRTest < Phonie::TestCase
 
   def test_local
-    parse_test('+302112345678', '30', '21', '12345678', 'Canada')
+    parse_test('+302112345678', '30', '21', '12345678', 'Greece')
   end
 end

data/test/countries/gu_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
 
 ## Guam
-class GRTest < Phonie::TestCase
+class GUTest < Phonie::TestCase
 
   def test_local
     parse_test('+16711234567', '1', '671', '1234567', 'Guam')

data/test/country_test.rb

@@ -3,10 +3,10 @@ require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 class CountryTest < Phonie::TestCase
   def test_find_by_country_name
     country = Phonie::Country.find_by_name('canada')
-    assert_equal country.name, "Canada"
+    assert_equal "Canada", country.name
 
     country = Phonie::Country.find_by_name('Canada')
-    assert_equal country.name, "Canada"
+    assert_equal "Canada", country.name
 
     assert_nil  Phonie::Country.find_by_name(nil)
     assert_nil  Phonie::Country.find_by_country_code(nil)
@@ -15,13 +15,13 @@ class CountryTest < Phonie::TestCase
 
   def test_find_by_country_code
     country = Phonie::Country.find_by_country_code('NO')
-    assert_equal country.name, "Norway"
+    assert_equal "Norway", country.name
   end
 
   def test_find_all_by_phone_code
     countries = Phonie::Country.find_all_by_phone_code('47')
-    assert_equal countries.length, 1
-    assert_equal countries.first.name, "Norway"
+    assert_equal 1, countries.length
+    assert_equal "Norway", countries.first.name
   end
 
 end

data/test/phone_test.rb

@@ -9,18 +9,18 @@ class PhoneTest < Phonie::TestCase
   def test_number_without_country_code_initialize
     Phonie::Phone.default_country_code = nil
 
-    assert_raise RuntimeError do
-      pn = Phonie::Phone.new '5125486', '91'
-    end
+    pn = Phonie::Phone.new '5125486', '91'
+    assert !pn.valid?
+    assert_equal ["can't be blank"], pn.errors[:country_code]
   end
 
-  def test_number_without_country_and_area_code_initialize
-    Phonie::Phone.default_country_code = nil
+  def test_number_without_area_code_initialize
+    Phonie::Phone.default_country_code = '1'
     Phonie::Phone.default_area_code = nil
 
-    assert_raise RuntimeError do
-      pn = Phonie::Phone.new '451588'
-    end
+    pn = Phonie::Phone.new '451588'
+    assert !pn.valid?
+    assert_equal ["can't be blank"], pn.errors[:area_code]
   end
 
   def test_number_with_default_area_code_initialize
@@ -52,8 +52,8 @@ class PhoneTest < Phonie::TestCase
   end
 
   def test_parse_empty
-    assert_equal Phonie::Phone.parse(''), nil
-    assert_equal Phonie::Phone.parse(nil), nil
+    assert_equal nil, Phonie::Phone.parse('')
+    assert_equal nil, Phonie::Phone.parse(nil)
   end
 
   def test_parse_short_without_special_characters_without_country
@@ -61,7 +61,7 @@ class PhoneTest < Phonie::TestCase
 
     assert_nil Phonie::Phone.parse "0915125486"
 
-    assert_raise RuntimeError do
+    assert_raise ArgumentError do
       Phonie::Phone.parse! "0915125486"
     end
   end
@@ -71,7 +71,7 @@ class PhoneTest < Phonie::TestCase
 
     assert_nil Phonie::Phone.parse "091/512-5486"
 
-    assert_raise RuntimeError do
+    assert_raise ArgumentError do
       Phonie::Phone.parse! "091/512-5486"
     end
   end
@@ -97,23 +97,23 @@ class PhoneTest < Phonie::TestCase
   def test_format_special_without_country_code
     Phonie::Phone.default_country_code = '385'
     pn = Phonie::Phone.new '5125486', '91'
-    assert_equal pn.format("%A/%f-%l"), '091/512-5486'
+    assert_equal '091/512-5486', pn.format("%A/%f-%l")
   end
 
   def test_format_with_symbol_specifier
     Phonie::Phone.default_country_code = nil
     pn = Phonie::Phone.new '5125486', '91', '385'
-    assert_equal pn.format(:europe), '+385 (0) 91 512 5486'
+    assert_equal '+385 (0) 91 512 5486', pn.format(:europe)
   end
 
   def test_valid
-    assert_equal Phonie::Phone.valid?('915125486', :country_code => '385'), true
-    assert_equal Phonie::Phone.valid?('385915125486'), true
+    assert Phonie::Phone.valid?('915125486', :country_code => '385')
+    assert Phonie::Phone.valid?('385915125486')
   end
 
   def test_doesnt_validate
-    assert_equal Phonie::Phone.valid?('asdas'), false
-    assert_equal Phonie::Phone.valid?('38591512548678'), false
+    assert !Phonie::Phone.valid?('asdas')
+    assert !Phonie::Phone.valid?('38591512548678')
   end
 
   def test_comparison_true
@@ -129,9 +129,9 @@ class PhoneTest < Phonie::TestCase
   end
 
   def test_parse_number_without_international_code
-    assert_equal (Phonie::Phone.parse "90123456"), nil
-    assert_equal (Phonie::Phone.parse "90123456", :country_code => '47').format(:default), "+4790123456"
-    assert_equal (Phonie::Phone.parse "90123456", :country_code => '47', :area_code => '').format(:default), "+4790123456"
+    assert_equal nil, Phonie::Phone.parse("90123456")
+    assert_equal "+4790123456", Phonie::Phone.parse("90123456", :country_code => '47').format(:default)
+    assert_equal "+4790123456", Phonie::Phone.parse("90123456", :country_code => '47', :area_code => '').format(:default)
   end
 
 end

data/tools/generate

@@ -23,15 +23,15 @@ def already_exists?
 end
 
 def get_country_code
-  YAML.load(File.read(@data_file)).each_pair do |key, c|
-    return c[:char_3_code].downcase if c[:name].downcase == @country.downcase
+  YAML.load(File.read(@data_file)).each do |c|
+    return c[:iso_3166_code].downcase if c[:name].downcase == @country.downcase
   end
   nil
 end
 
 def get_country_call_code
-  YAML.load(File.read(@data_file)).each_pair do |key, c|
-    return key if c[:name].downcase == @country.downcase
+  YAML.load(File.read(@data_file)).each do |c|
+    return c[:country_code] if c[:name].downcase == @country.downcase
   end
   nil
 end
@@ -48,24 +48,26 @@ class #{@country_code.upcase}Test < Phonie::TestCase
   def test_local
     parse_test('+#{country_call_code}',  '#{country_call_code}', '',  '', '#{@country}', false)
   end
-  
+
   def test_mobile
     parse_test('+#{country_call_code}', '#{country_call_code}', '', '', '#{@country}', true)
   end
-end 
+end
     eof
   end
    puts "Create: #{@test_filename}"
 end
 
 def add_missing_fields
-  hash = YAML.load(File.read(@data_file))
-  hash[get_country_call_code].merge!({:area_code => ' ', 
+  arr = YAML.load(File.read(@data_file))
+  arr.find{|c| c[:name].downcase == @country.downcase}.merge!(
+    :area_code => ' ',
     :local_number_format => ' ',
     :mobile_format => ' ',
-    :number_format => ' '})
+    :number_format => ' '
+  )
   File.open(@data_file, 'w') do |f|
-    f.puts hash.to_yaml
+    f.puts arr.to_yaml
   end
 
   puts "Modified: #{@data_file}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phonie
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,20 +9,21 @@ authors:
 - Todd Eichel
 - Don Morrison
 - Wesley Moxam
+- Lance Ivy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -31,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -47,7 +48,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -68,6 +69,7 @@ email:
 - todd@toddeichel.com
 - elskwid@gmail.com
 - wesley@wmoxam.com
+- lance@kickstarter.com
 executables: []
 extensions: []
 extra_rdoc_files: []