global_phone 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fece23d3eace739f32573747853124109fc041e8
-  data.tar.gz: d826cae724c7d1e985a1202cfd1eb391a68a719e
+  metadata.gz: 22b1542e445e1f158ffaeb0115d0cdc5de251246
+  data.tar.gz: 69f61d4a5d562aeb508c75090d3cbb8af057da66
 SHA512:
-  metadata.gz: 9fa62cde3524560b518b052fc641e2630b946b53acb0edfda89394e2e5073430a420b11ec7892da19796414323cc7cf994810c7573a5c1bc36a419c8978b49d5
-  data.tar.gz: 4a74924a77e4c1560d1027825d65d5dd0f239fbb2b8f173f83c8157d7d934415db14a9f17cbecec034620ba763795982bfc8541b0d1fb22d8749b593115a70fd
+  metadata.gz: 80b970b279a2c53777b6e8dc58c18eff30e0a0e587f045b39587fe33383de8d39858b803951ff4c6b55dace57dcec1841506a9fcbb5572e36b611091b5c162a8
+  data.tar.gz: 29732d6e2760cbf943425355a304bdd45d28fd93cbc5ec2bb042d97104272de98eb4aaa7a96a7dca730605cd80c037981b79df0c932d207ba72546d81287de2d

data/README.md

@@ -2,7 +2,7 @@
 
 GlobalPhone parses, validates, and formats local and international phone numbers according to the [E.164 standard](http://en.wikipedia.org/wiki/E.164).
 
-**Store and display phone numbers in your app.** Accept phone number input in national or international format. Convert phone numbers to international format (`+13125551212`) for storage and retrieval. Present numbers in national format (`(312) 555-1212`) in your UI.
+**Store and display phone numbers in your app.** Accept phone number input in national or international format. Convert phone numbers to international strings (`+13125551212`) for storage and retrieval. Present numbers in national format (`(312) 555-1212`) in your UI.
 
 **Designed with the future in mind.** GlobalPhone uses format specifications from Google's open-source [libphonenumber](http://code.google.com/p/libphonenumber/) database. No need to upgrade the library when a new phone format is introduced—just generate a new copy of the database and check it into your app.
 
@@ -22,87 +22,109 @@ GlobalPhone parses, validates, and formats local and international phone numbers
 
 3. Tell GlobalPhone where to find the database. For example, in a Rails app, create an initializer in `config/initializers/global_phone.rb`:
 
-        require 'global_phone'
-        GlobalPhone.db_path = Rails.root.join('db/global_phone.json')
+    ```ruby
+    require 'global_phone'
+    GlobalPhone.db_path = Rails.root.join('db/global_phone.json')
+    ```
 
 ## Examples
 
 Parse an international number string into a `GlobalPhone::Number` object:
 
-    >> number = GlobalPhone.parse('+1-312-555-1212')
-    => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=1 name=US> national_string="3125551212">
+```ruby
+number = GlobalPhone.parse('+1-312-555-1212')
+# => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=1 name=US> national_string="3125551212">
+```
 
 Query the country code and likely territory name of the number:
 
-    >> number.country_code
-    => "1"
+```ruby
+number.country_code
+# => "1"
 
-    >> number.territory.name
-    => "US"
+number.territory.name
+# => "US"
+```
 
 Present the number in national and international formats:
 
-    >> number.national_format
-    => "(312) 555-1212"
+```ruby
+number.national_format
+# => "(312) 555-1212"
 
-    >> number.international_format
-    => "+1 312-555-1212"
+number.international_format
+# => "+1 312-555-1212"
+```
 
 Is the number valid? (Note: this is not definitive. For example, the number here is "valid" by format, but there are no US numbers that start with 555. The `valid?` method may return false positives, but *should not* return false negatives unless the database is out of date.)
 
-    >> number.valid?
-    true
+```ruby
+number.valid?
+# => true
+```
 
 Get the number's normalized E.164 international string:
 
-    >> number.international_string
-    => "+13125551212"
+```ruby
+number.international_string
+# => "+13125551212"
+```
 
 Parse a number in national format for a given territory:
 
-    >> number = GlobalPhone.parse("(0) 20-7031-3000", :gb)
-    => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=44 name=GB> national_string="2070313000">
+```ruby
+number = GlobalPhone.parse("(0) 20-7031-3000", :gb)
+# => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=44 name=GB> national_string="2070313000">
+```
 
 Parse an international number using a territory's international dialing prefix:
 
-    >> number = GlobalPhone.parse("00 1 3125551212", :gb)
-    => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=1 name=US> national_string="3125551212">
+```ruby
+number = GlobalPhone.parse("00 1 3125551212", :gb)
+# => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=1 name=US> national_string="3125551212">
+```
 
 Set the default territory to Great Britain (territory names are [ISO 3166-1 Alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes):
 
-    >> GlobalPhone.default_territory_name = :gb
-    => :gb
+```ruby
+GlobalPhone.default_territory_name = :gb
+# => :gb
 
-    >> GlobalPhone.parse("(0) 20-7031-3000")
-    => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=44 name=GB> national_string="2070313000">
+GlobalPhone.parse("(0) 20-7031-3000")
+# => #<GlobalPhone::Number territory=#<GlobalPhone::Territory country_code=44 name=GB> national_string="2070313000">
+```
 
 Shortcuts for validating a phone number:
 
-    >> GlobalPhone.validate("+1 312-555-1212")
-    => true
+```ruby
+GlobalPhone.validate("+1 312-555-1212")
+# => true
 
-    >> GlobalPhone.validate("+442070313000")
-    => true
+GlobalPhone.validate("+442070313000")
+# => true
 
-    >> GlobalPhone.validate("(0) 20-7031-3000")
-    => false
+GlobalPhone.validate("(0) 20-7031-3000")
+# => false
 
-    >> GlobalPhone.validate("(0) 20-7031-3000", :gb)
-    => true
+GlobalPhone.validate("(0) 20-7031-3000", :gb)
+# => true
+```
 
 Shortcuts for normalizing a phone number in E.164 format:
 
-    >> GlobalPhone.normalize("(312) 555-1212")
-    => "+13125551212"
+```ruby
+GlobalPhone.normalize("(312) 555-1212")
+# => "+13125551212"
 
-    >> GlobalPhone.normalize("+442070313000")
-    => "+442070313000"
+GlobalPhone.normalize("+442070313000")
+# => "+442070313000"
 
-    >> GlobalPhone.normalize("(0) 20-7031-3000")
-    => nil
+GlobalPhone.normalize("(0) 20-7031-3000")
+# => nil
 
-    >> GlobalPhone.normalize("(0) 20-7031-3000", :gb)
-    => "+442070313000"
+GlobalPhone.normalize("(0) 20-7031-3000", :gb)
+# => "+442070313000"
+```
 
 ## Caveats
 
@@ -124,6 +146,12 @@ GlobalPhone is heavily inspired by Andreas Gal's [PhoneNumber.js](https://github
 
 ### Version History
 
+**1.0.1** (May 29, 2013)
+
+* GlobalPhone::Number#to_s returns the E.164 international string.
+* Ensure GlobalPhone::Number always returns strings for #national_format, #international_format, and #international_string, regardless of validity.
+* Relax format restrictions to more loosely match available national number patterns.
+
 **1.0.0** (May 28, 2013)
 
 * Initial public release.

data/lib/global_phone.rb

@@ -1,7 +1,7 @@
 require 'global_phone/context'
 
 module GlobalPhone
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 
   class Error < ::StandardError; end
   class NoDatabaseError < Error; end

data/lib/global_phone/format.rb

@@ -8,14 +8,14 @@ module GlobalPhone
     field 3, :national_prefix_formatting_rule
     field 4, :international_format_rule, :fallback => :national_format_rule
 
-    def match(national_string)
-      return false if leading_digits && national_string !~ leading_digits
+    def match(national_string, match_leading_digits = true)
+      return false if match_leading_digits && leading_digits && national_string !~ leading_digits
       national_string =~ pattern
     end
 
     def format_replacement_string(type)
       format_rule = send(:"#{type}_format_rule")
-      format_rule.gsub("$", "\\") if format_rule && format_rule != "NA"
+      format_rule.to_s.gsub("$", "\\") unless format_rule == "NA"
     end
 
     def apply(national_string, type)

data/lib/global_phone/number.rb

@@ -33,22 +33,22 @@ module GlobalPhone
       @national_format ||= begin
         if format && result = format.apply(national_string, :national)
           apply_national_prefix_format(result)
+        else
+          national_string
         end
       end
     end
 
     def international_string
-      @international_string ||= begin
-        if international_format
-          international_format.gsub(NON_DIALABLE_CHARS, "")
-        end
-      end
+      @international_string ||= international_format.gsub(NON_DIALABLE_CHARS, "")
     end
 
     def international_format
       @international_format ||= begin
         if format && formatted_number = format.apply(national_string, :international)
           "+#{country_code} #{formatted_number}"
+        else
+          "+#{country_code} #{national_string}"
         end
       end
     end
@@ -61,9 +61,18 @@ module GlobalPhone
       "#<#{self.class.name} territory=#{territory.inspect} national_string=#{national_string.inspect}>"
     end
 
+    def to_s
+      international_string
+    end
+
     protected
       def format
-        @format ||= region.formats.detect { |format| format.match(national_string) }
+        @format ||= find_format_for(national_string)
+      end
+
+      def find_format_for(string)
+        region.formats.detect { |format| format.match(string) } ||
+        region.formats.detect { |format| format.match(string, false) }
       end
 
       def apply_national_prefix_format(result)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global_phone
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sam Stephenson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies: []
 description: GlobalPhone parses, validates, and formats local and international phone
   numbers according to the E.164 standard using the rules specified in Google's libphonenumber