phoney 0.0.4 → 0.1.0

data/README.rdoc

@@ -78,7 +78,6 @@ When given a symbol you can let the parser guess the best format and pass in one
 == TODOs
 
 - More test specs for different countries
-- Correctly handle numbers that have some digits BEFORE the area_code!
 
 == Licence
 

data/lib/phoney/base.rb

@@ -1,5 +1,5 @@
 class PhoneNumber
-  attr_accessor :country_code, :area_code, :number
+  attr_accessor :country_code, :prefix_code, :area_code, :number
   
   class << self
     def default_region
@@ -44,10 +44,12 @@ class PhoneNumber
     end 
 
     self.number = params[:number].to_s
+    # The rare case when some digits are in front of the area code
+    self.prefix_code = params[:prefix_code].to_s
     # Can be empty, because some special numbers just don't have an area code (e.g. 911)
     self.area_code = params[:area_code].to_s || self.class.default_area_code
     self.country_code = params[:country_code].to_s || country_code || self.class.default_country_code
-
+    
     raise "Must enter number" if(self.number.nil? || self.number.empty?)
     raise "Must enter country code or set default country code" if(self.country_code.nil? || self.country_code.empty?)
   end
@@ -74,7 +76,7 @@ class PhoneNumber
     if fmt.is_a?(Symbol)
       case fmt
       when :default
-        Parser::parse("+#{country_code} #{area_code} #{number}", country_code)
+        Parser::parse("+#{country_code} #{prefix_code}#{area_code} #{number}", country_code)
       when :national
         Parser::parse("#{area_code} #{number}", country_code)
       when :local

data/lib/phoney/parser.rb

@@ -20,6 +20,7 @@ class PhoneNumber
 
         region          = Region.find(region_code) || PhoneNumber.default_region
         country_code    = region.country_code.to_s
+        prefix_code     = nil
         area_code       = nil
 
         dialout_prefix  = get_dialout_prefix(phone_number, region)
@@ -69,6 +70,9 @@ class PhoneNumber
         
         # now that know how to format the number, do the formatting work...
         if(matching_rule)
+          if(matching_rule[:areacode_offset] > 0)
+            prefix_code = phone_number[0, matching_rule[:areacode_offset]]
+          end
           area_code     = phone_number[matching_rule[:areacode_offset], matching_rule[:areacode_length]]
           number        = phone_number[matching_rule[:areacode_offset]+matching_rule[:areacode_length]..-1]
           phone_number  = format(phone_number, matching_rule[:format].to_s)
@@ -115,10 +119,16 @@ class PhoneNumber
         number.gsub!(/[^0-9]/,'') if number
         
         # Finally...we can output our parts as a hash
-        { :formatted_number => phone_number, :area_code => area_code, :country_code => country_code, :number => number }
+        { :formatted_number => phone_number,
+          :prefix_code => prefix_code,
+          :area_code => area_code,
+          :country_code => country_code,
+          :number => number }
       end
       
-      # private
+      private
+      # Returns the rule sets that we need to check for a given number and region.
+      # The rule_sets are filtered by the length of the number!
       def get_rule_sets_for_region(string, region)
         rule_sets = []
         
@@ -131,6 +141,8 @@ class PhoneNumber
         rule_sets
       end
       
+      # Given any number, find the rule in rule_sets that applies.
+      # Returns nil if no matching rule was found!
       def find_matching_rule(number, rule_sets)
         return nil if !number.match(/\A[0-9]+\Z/)
         match = nil
@@ -154,11 +166,14 @@ class PhoneNumber
         match
       end
       
+      # According to the region, is this number input trying to dial out?
       def dialing_out?(string, region=nil)
         region ||= PhoneNumber.default_region
         !get_dialout_prefix(string, region).empty?
       end
-            
+      
+      # Get the dialout prefix from the given string.
+      # Returns an empty string if no dialout prefix was found.
       def get_dialout_prefix(string, region=nil)
         region ||= PhoneNumber.default_region
         prefixes = region.dialout_prefixes
@@ -189,6 +204,8 @@ class PhoneNumber
         dialout_prefix
       end
       
+      # Get the national prefix from the given string.
+      # Returns an empty string if no national prefix was found.
       def get_national_prefix(string, region=nil)
         region ||= PhoneNumber.default_region
         prefix = region.national_prefix
@@ -202,6 +219,9 @@ class PhoneNumber
         national_prefix
       end
       
+      # Get the dialout region by looking at the string.
+      # Returns a Region object if we're dialing outside a region that is supported.
+      # Otherwise returns nil.
       def get_dialout_region(string, region)
         region ||= PhoneNumber.default_region
         dialout_prefix = get_dialout_prefix(string, region)

data/lib/phoney/utils.rb

@@ -44,7 +44,7 @@ class PhoneNumber
     # Strips all non-numberpad characters from a string
     # => For example: "+45 (123) 023 1.1.1" -> "+45123023111"
     def normalize(string_with_number)
-      string_with_number.scan(/[0-9+*#]/).to_s unless string_with_number.nil?
+      string_with_number.gsub(/[^0-9+*#]/,'') unless string_with_number.nil?
     end
     
   end

data/lib/phoney/version.rb

@@ -2,8 +2,8 @@ class PhoneNumber
   
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 4
+    MINOR = 1
+    TINY  = 0
     
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/phoney.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{phoney}
-  s.version = "0.0.4"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Habermann"]

data/spec/phone_number_spec.rb

@@ -12,210 +12,29 @@ describe PhoneNumber do
       pn.to_s.should == "+1 (704) 123-4567"
     end
     
+    it "should extract the country, area, and number correctly" do
+      pn = PhoneNumber.new '7041234567'
+      
+      pn.country_code.should == "1"
+      pn.area_code.should == "704"
+      pn.number.should == "1234567"
+    end
   end
   
-end
-
+  describe "using a number that has a prefix_code before the area code" do
+    before(:each) do
+      @pn = PhoneNumber.new("+55 12 34 5678-9012")
+    end
+    
+    it "should have the correct prefix/area code assigned" do
+      @pn.prefix_code.should == "12"
+      @pn.area_code.should == "34"
+      @pn.number == "56789012"
+    end
+    
+    it "should output the correct canonical format" do
+      @pn.to_s.should == "+55 (12 34) 5678-9012"
+    end
+  end
   
-  # def test_number_without_country_code_initialize
-  #     PhoneNumber.default_country_code = nil
-  #     
-  #     assert_raise RuntimeError do
-  #       pn = PhoneNumber.new '5125486', '91'
-  #     end
-  #   end
-  #   
-  #   def test_number_without_country_and_area_code_initialize
-  #     PhoneNumber.default_country_code = nil
-  #     PhoneNumber.default_area_code = nil
-  #     
-  #     assert_raise RuntimeError do
-  #       pn = PhoneNumber.new '451588'
-  #     end
-  #   end
-  #   
-  #   def test_number_with_default_area_code_initialize
-  #     PhoneNumber.default_country_code = '385'
-  #     PhoneNumber.default_area_code = '47'
-  #     
-  #     pn = PhoneNumber.new '451588'
-  #     assert pn.number == '451588'
-  #     assert pn.area_code == '47'
-  #     assert pn.country_code == '385'
-  #   end
-  #   
-  #   def test_number_with_default_country_code_initialize
-  #     PhoneNumber.default_country_code = '386'
-  #     
-  #     pn = PhoneNumber.new '5125486', '91'
-  #     assert pn.number == '5125486'
-  #     assert pn.area_code == '91'
-  #     assert pn.country_code == '386'
-  #   end
-  #   
-  #   def test_number_with_country_code_initialize
-  #     PhoneNumber.default_country_code = '387'
-  #     
-  #     pn = PhoneNumber.new '5125486', '91', '385'
-  #     assert pn.number == '5125486'
-  #     assert pn.area_code == '91'
-  #     assert pn.country_code == '385'
-  #   end
-  #   
-  #   def test_parse_empty
-  #     assert_equal PhoneNumber.parse(''), nil
-  #     assert_equal PhoneNumber.parse(nil), nil
-  #   end
-  #   
-  #   def test_parse_long_without_special_characters
-  #     pn = PhoneNumber.parse "+385915125486"
-  #     
-  #     assert_equal pn.number, '5125486'
-  #     assert_equal pn.area_code, '91'
-  #     assert_equal pn.country_code, '385'
-  #   end
-  #   
-  #   def test_parse_zagreb_long_without_special_characters
-  #     pn = PhoneNumber.parse "+38513668734"
-  #     
-  #     assert_equal pn.number, '3668734'
-  #     assert_equal pn.area_code, '1'
-  #     assert_equal pn.country_code, '385'
-  #   end
-  #   
-  #   def test_parse_long_with_special_characters
-  #     pn = PhoneNumber.parse "+ 385 (91) 512 / 5486 "
-  #     
-  #     assert pn.number == '5125486'
-  #     assert pn.area_code == '91'
-  #     assert pn.country_code == '385'
-  #   end
-  #   
-  #   def test_parse_long_with_leading_zeros
-  #     pn = PhoneNumber.parse "00385915125486"
-  #     
-  #     assert pn.number == '5125486'
-  #     assert pn.area_code == '91'
-  #     assert pn.country_code == '385'
-  #   end
-  #   
-  #   def test_parse_zagreb_long_with_leading_zeros
-  #     pn = PhoneNumber.parse "0038513668734"
-  #     
-  #     assert pn.number == '3668734'
-  #     assert pn.area_code == '1'
-  #     assert pn.country_code == '385'
-  #   end
-  #   
-  #   def test_parse_short_without_special_characters_without_country
-  #     PhoneNumber.default_country_code = nil
-  #      
-  #     assert_raise RuntimeError do
-  #       pn = PhoneNumber.parse "0915125486"
-  #     end
-  #   end
-  #   
-  #   def test_parse_short_without_special_characters_with_country
-  #     PhoneNumber.default_country_code = '385'
-  #         
-  #     pn = PhoneNumber.parse "044885047"
-  #     
-  #     assert_equal pn.number, '885047'
-  #     assert_equal pn.area_code, '44'
-  #     assert pn.country_code == '385'
-  #   end
-  #   
-  #   def test_parse_zagreb_short_without_special_characters_with_country
-  #     PhoneNumber.default_country_code = '385'
-  #         
-  #     pn = PhoneNumber.parse "013668734"
-  #     
-  #     assert_equal pn.number, '3668734'
-  #     assert_equal pn.area_code, '1'
-  #     assert_equal pn.country_code, '385'
-  #   end
-  #   
-  #   def test_parse_short_with_special_characters_without_country
-  #     PhoneNumber.default_country_code = nil
-  #         
-  #     assert_raise RuntimeError do
-  #       pn = PhoneNumber.parse "091/512-5486"
-  #     end
-  #   end
-  #   
-  #   def test_parse_long_with_zero_in_brackets
-  #     PhoneNumber.default_country_code = nil
-  #     
-  #     pn = PhoneNumber.parse '+385 (0)1 366 8111'
-  #     assert_equal pn.country_code, '385'
-  #     assert_equal pn.area_code, '1'
-  #     assert_equal pn.number, '3668111'
-  #   end
-  #   
-  #   
-  #   
-  #   def test_to_s
-  #     PhoneNumber.default_country_code = nil
-  #     pn = PhoneNumber.new '5125486', '91', '385'
-  #     assert pn.to_s == '+385915125486'
-  #   end
-  #   
-  #   def test_to_s_without_country_code
-  #     PhoneNumber.default_country_code = '385'
-  #     pn = PhoneNumber.new '5125486', '91'
-  #     assert pn.format("0%a%n") == '0915125486'
-  #   end
-  #   
-  #   def test_format_special_with_country_code
-  #     PhoneNumber.default_country_code = nil
-  #     pn = PhoneNumber.new '5125486', '91', '385'
-  #     assert pn.format("+ %c (%a) %n") == '+ 385 (91) 5125486'
-  #   end
-  #   
-  #   def test_format_special_without_country_code
-  #     PhoneNumber.default_country_code = '385'
-  #     pn = PhoneNumber.new '5125486', '91'
-  #     assert_equal pn.format("%A/%f-%l"), '091/512-5486'
-  #   end
-  #   
-  #   def test_format_with_symbol_specifier
-  #     PhoneNumber.default_country_code = nil
-  #     pn = PhoneNumber.new '5125486', '91', '385'
-  #     assert_equal pn.format(:europe), '+385 (0) 91 512 5486'
-  #   end
-  #   
-  #   def test_doesnt_validate
-  #     assert_equal PhoneNumber.valid?('asdas'), false
-  #     assert_equal PhoneNumber.valid?('385915125486'), false
-  #   end
-  #   
-  #   def test_validates
-  #     PhoneNumber.default_country_code = nil
-  #     assert_equal PhoneNumber.valid?('00385915125486'), true
-  #     assert_equal PhoneNumber.valid?('+385915125486'), true
-  #     assert_equal PhoneNumber.valid?('+385 (91) 512 5486'), true
-  #     assert_equal PhoneNumber.valid?('+38547451588'), true
-  #  
-  #     PhoneNumber.default_country_code = '385'
-  #     assert_equal PhoneNumber.valid?('0915125486'), true
-  #     assert_equal PhoneNumber.valid?('091/512-5486'), true
-  #     assert_equal PhoneNumber.valid?('091/512-5486'), true
-  #     assert_equal PhoneNumber.valid?('091 512 54 86'), true
-  #     assert_equal PhoneNumber.valid?('091-512-54-86'), true
-  #     assert_equal PhoneNumber.valid?('047/451-588'), true
-  #   end
-  #   
-  #   def test_has_default_country_code
-  #     PhoneNumber.default_country_code = '385'
-  #     
-  #     assert_equal PhoneNumber.parse('+38547451588').has_default_country_code?, true
-  #     assert_equal PhoneNumber.parse('+38647451588').has_default_country_code?, false
-  #   end
-  #   
-  #   def test_has_default_area_code
-  #     PhoneNumber.default_country_code = '385'
-  #     PhoneNumber.default_area_code = '47'
-  #     
-  #     assert_equal PhoneNumber.parse('047/451-588').has_default_area_code?, true
-  #     assert_equal PhoneNumber.parse('032/336-1456').has_default_area_code?, false
-  #   end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: phoney
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jan Habermann