Merge 80018e5 into ec426f0

DrHyde · Jan 13, 2023 · 622c7a4 · 622c7a4
2 parents ec426f0 + 80018e5
commit 622c7a4
Show file tree

Hide file tree

Showing 22 changed files with 238 additions and 74 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,7 @@ blib/
 lib/Number/Phone/NANP/Data.pm
 share/
 lib/Number/Phone/Country/
-lib/Number/Phone/StubCountry/
+lib/Number/Phone/StubCountry/*.pm
 libphonenumber/
 data-files/
 pm_to_blib

diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,8 @@
-X.XXXX    XXXX-XX-XX
+3.8099_01  2023-01-12
+
+- Add validation using libphonenumber's data for non-geographic country
+  codes like +800 (International free phone) and +870 (Inmarsat). See
+  https://github.com/DrHyde/perl-modules-Number-Phone/issues/17
 
 - Bug fix: NANP toll-free numbers corrected. 833 area code now supported,
   and regex fixed to only match when the B and C digits are the same, so

diff --git a/MANIFEST b/MANIFEST
@@ -97,6 +97,13 @@ t/manifest-contains-all-modules.t
 t/only-use-blib-under-make-test.t
 t/deprecations.t
 t/constructor.t
+lib/Number/Phone/StubCountry/GMSS/Globalstar.pm
+lib/Number/Phone/StubCountry/GMSS/ICO.pm
+lib/Number/Phone/StubCountry/GMSS/Iridium.pm
+lib/Number/Phone/StubCountry/InternationalNetworks882/Telespazio.pm
+lib/Number/Phone/StubCountry/InternationalNetworks882/Thuraya.pm
+lib/Number/Phone/StubCountry/InternationalNetworks883/MTTGlobalNetworks.pm
+lib/Number/Phone/StubCountry/InternationalNetworks883/Mobistar.pm
 lib/Number/Phone/StubCountry/AC.pm
 lib/Number/Phone/StubCountry/AD.pm
 lib/Number/Phone/StubCountry/AE.pm
@@ -342,3 +349,12 @@ lib/Number/Phone/StubCountry/YT.pm
 lib/Number/Phone/StubCountry/ZA.pm
 lib/Number/Phone/StubCountry/ZM.pm
 lib/Number/Phone/StubCountry/ZW.pm
+lib/Number/Phone/StubCountry/InternationalFreephone.pm
+lib/Number/Phone/StubCountry/SharedCostServices.pm
+lib/Number/Phone/StubCountry/Inmarsat.pm
+lib/Number/Phone/StubCountry/UniversalPersonalTelecoms.pm
+lib/Number/Phone/StubCountry/GMSS.pm
+lib/Number/Phone/StubCountry/InternationalNetworks882.pm
+lib/Number/Phone/StubCountry/InternationalNetworks883.pm
+lib/Number/Phone/StubCountry/TelecomsForDisasterRelief.pm
+lib/Number/Phone/StubCountry/InternationalPremiumRate.pm
diff --git a/build-data.country-mapping b/build-data.country-mapping
@@ -12,6 +12,8 @@ use warnings;
 use lib 'buildtools';
 use Number::Phone::BuildHelpers;
 
+my %known_non_country_codes = known_non_country_codes();
+
 $| = 1;
 
 use XML::XPath;
@@ -243,7 +245,6 @@ foreach my $tuple (
     # [ 38649   => 'XK' ],
 
     do {
-        my %known_non_country_codes = known_non_country_codes();
         map {
             [ $_ => $known_non_country_codes{$_} ]
         } keys %known_non_country_codes
@@ -260,6 +261,13 @@ foreach my $tuple (
         ";\n";
 }
 
+foreach my $IDD (keys %known_non_country_codes) {
+    my $name = $known_non_country_codes{$IDD};
+    print $module_fh qq{
+        \$Number::Phone::Country::prefix_codes{'$name'} = ['$IDD'];
+    };
+}
+
 # countries that don't exist in libphonenumber
 # FIXME unchecked
 print $module_fh q{

diff --git a/build-data.sh b/build-data.sh
@@ -161,6 +161,7 @@ fi
 # if share/Number-Phone-UK-Data.db doesn't exist, or OFCOM's stuff or
 # libphonenumber's list of area codes is newer ...
 if test ! -e share/Number-Phone-UK-Data.db -o \
+  buildtools/Number/Phone/BuildHelpers.pm      -nt share/Number-Phone-UK-Data.db -o \
   libphonenumber/resources/geocoding/en/44.txt -nt share/Number-Phone-UK-Data.db -o \
   data-files/sabcde11_12.xlsx -nt share/Number-Phone-UK-Data.db -o \
   data-files/sabcde13.xlsx    -nt share/Number-Phone-UK-Data.db -o \
@@ -189,6 +190,7 @@ fi
 
 # lib/Number/Phone/Country/Data.pm doesn't exist, or if libphonenumber/resources/PhoneNumberMetadata.xml is newer ...
 if test ! -e lib/Number/Phone/Country/Data.pm -o \
+  buildtools/Number/Phone/BuildHelpers.pm          -nt lib/Number/Phone/Country/Data.pm -o \
   build-data.country-mapping                       -nt lib/Number/Phone/Country/Data.pm -o \
   libphonenumber/resources/PhoneNumberMetadata.xml -nt lib/Number/Phone/Country/Data.pm;
 then
@@ -204,6 +206,7 @@ fi
 # lib/Number/Phone/NANP/Data.pm doesn't exist, or if libphonenumber/resources/geocoding/en/1.txt or PhoneNumberMetadata.xml is newer ...
 if test ! -e lib/Number/Phone/NANP/Data.pm -o \
   ! -e share/Number-Phone-NANP-Data.db -o \
+  buildtools/Number/Phone/BuildHelpers.pm          -nt lib/Number/Phone/NANP/Data.pm -o \
   build-data.nanp                                  -nt lib/Number/Phone/NANP/Data.pm -o \
   libphonenumber/resources/geocoding/en/1.txt      -nt lib/Number/Phone/NANP/Data.pm -o \
   libphonenumber/resources/PhoneNumberMetadata.xml -nt lib/Number/Phone/NANP/Data.pm -o \
@@ -227,6 +230,7 @@ NANPDATETIME=$(perl -e 'print +(stat(shift))[9]' $(ls -rt data-files/[0-9][0-9][
 # lib/Number/Phone/StubCountry/KZ.pm doesn't exist, or if libphonenumber/resources/PhoneNumberMetadata.xml is newer,
 # or if lib/Number/Phone/NANP/Data.pm is newer ...
 if test ! -e lib/Number/Phone/StubCountry/KZ.pm -o \
+  buildtools/Number/Phone/BuildHelpers.pm          -nt lib/Number/Phone/StubCountry/KZ.pm -o \
   build-data.stubs                                 -nt lib/Number/Phone/StubCountry/KZ.pm -o \
   libphonenumber/resources/geocoding/en/1.txt      -nt lib/Number/Phone/StubCountry/KZ.pm -o \
   libphonenumber/resources/PhoneNumberMetadata.xml -nt lib/Number/Phone/StubCountry/KZ.pm -o \
@@ -243,6 +247,7 @@ fi
 
 # t/example-phone-numbers.t doesn't exist, or if libphonenumber/resources/PhoneNumberMetadata.xml is newer
 if test ! -e t/example-phone-numbers.t -o \
+  buildtools/Number/Phone/BuildHelpers.pm          -nt t/example-phone-numbers.t -o \
   build-tests.pl                                   -nt t/example-phone-numbers.t -o \
   libphonenumber/resources/PhoneNumberMetadata.xml -nt t/example-phone-numbers.t;
 then

diff --git a/build-data.stubs b/build-data.stubs
@@ -28,7 +28,7 @@ open(my $manifest_fh, 'MANIFEST') || die("Can't read MANIFEST\n");
 my @manifest_files = grep { /./ } <$manifest_fh>;
 close($manifest_fh);
 open($manifest_fh, '>', 'MANIFEST') || die("Can't write MANIFEST\n");
-print $manifest_fh "$_" foreach( grep { $_ !~ m{^lib/Number/Phone/StubCountry/} } @manifest_files);
+print $manifest_fh "$_" foreach( grep { $_ !~ m{^lib/Number/Phone/StubCountry/\w+\.pm} } @manifest_files);
 
 mkdir('lib/Number/Phone/StubCountry');
 mkdir('t/lib');
@@ -44,6 +44,8 @@ my @gb_formats = formats_for($xml->find(
     '/phoneNumberMetadata/territories/territory[@id="GB"]')->get_node(1)
 );
 
+unlink(glob('lib/Number/Phone/StubCountry/*pm'));
+
 TERRITORY: foreach my $territory (@territories) {
   my $IDD_country_code = ''.$territory->find('@countryCode');
   my $national_code = ''.$territory->find('@nationalPrefixForParsing') || ''.$territory->find('@nationalPrefix');
@@ -58,12 +60,13 @@ TERRITORY: foreach my $territory (@territories) {
       next TERRITORY;
   }
 
-  unlink "$dir/$ISO_country_code.pm"; # to clear out countries that no longer exist
+  my $final_class_part = get_final_class_part($ISO_country_code, $IDD_country_code);
+  my $filename = "$dir/$final_class_part.pm";
 
-  open(my $module_fh, '>:encoding(UTF-8)', "$dir/$ISO_country_code.pm")
-    || die("Can't write $dir/$ISO_country_code.pm: $!\n");
-  print $manifest_fh "$dir/$ISO_country_code.pm\n";
-  print $module_fh preamble($ISO_country_code);
+  open(my $module_fh, '>:encoding(UTF-8)', $filename)
+    || die("Can't write $filename: $!\n");
+  print $manifest_fh "$filename\n";
+  print $module_fh preamble($final_class_part);
 
   my @formatters = formats_for($territory, $ISO_country_code);
   print $module_fh 'my '.Data::Dumper->new([\@formatters], [qw(formatters)])->Dump()."\n";
@@ -143,7 +146,7 @@ TERRITORY: foreach my $territory (@territories) {
       my \$class = shift;
       my \$number = shift;
       \$number =~ s/(^\\+$IDD_country_code|\\D)//g;
-      my \$self = bless({ number => \$number, formatters => \$formatters, validators => \$validators, ".
+      my \$self = bless({ country_code => '$IDD_country_code', number => \$number, formatters => \$formatters, validators => \$validators, ".
       (($IDD_country_code != 1 && $got_area_names) ? 'areanames => \\%areanames' : '')
       ."}, \$class);
   ";
@@ -179,7 +182,7 @@ TERRITORY: foreach my $territory (@territories) {
     }
 
     push @code,
-      "  \$self = bless({ number => \$number, formatters => \$formatters, validators => \$validators, ".
+      "  \$self = bless({ country_code => '$IDD_country_code', number => \$number, formatters => \$formatters, validators => \$validators, ".
       (($IDD_country_code != 1 && $got_area_names) ? 'areanames => \\%areanames' : '')
       ."}, \$class);";
 
@@ -192,7 +195,7 @@ TERRITORY: foreach my $territory (@territories) {
 }
 
 sub preamble {
-  my $iso_code = shift;
+  my $final_class_part = shift;
   "# automatically generated file, don't edit\n\n".
   q{
 
@@ -210,7 +213,7 @@ sub preamble {
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-package Number::Phone::StubCountry::}.$iso_code.q{;
+package Number::Phone::StubCountry::}.$final_class_part.q{;
 use base qw(Number::Phone::StubCountry);
 
 use strict;

diff --git a/build-tests.pl b/build-tests.pl
@@ -29,6 +29,9 @@
       warn("skipping 'country' $ISO_country_code (+$IDD_country_code)\n");
       next TERRITORY;
   }
+
+  my $final_class_part = get_final_class_part($ISO_country_code, $IDD_country_code);
+
   my @example_numbers = $territory->find('*/exampleNumber')->get_nodelist();
   NUMBER: foreach my $example_number (@example_numbers) {
       my $number = $example_number->string_value();
@@ -44,7 +47,7 @@
           ($_->[0] eq 'GB') ? ($_, ['UK', $_->[1]]) : $_
       } (
           [$ISO_country_code, "+$IDD_country_code$number"],
-          [$ISO_country_code, $number],
+          [$ISO_country_code, "$number"],
           [                   "+$IDD_country_code$number"]
       );
       TUPLE: foreach my $test_tuple (@test_tuples) {
@@ -108,6 +111,9 @@
               warnonce("$ISO_country_code number +$IDD_country_code $number in libphonenumber's example data needs to be treated as IT");
               $test_tuple->[0] = 'IT';
           }
+          if($test_tuple->[0] eq '001') {
+              $test_tuple->[0] = get_final_class_part($ISO_country_code, $IDD_country_code);
+          }
           if($IDD_country_code eq '44' && $number =~ /
               ^
               800   123 4567  |
@@ -122,13 +128,15 @@
               # warn("$ISO_country_code number +$IDD_country_code $number in libphonenumber's example data is wrong\n");
               next NUMBER;
           }
-          my $constructor_args = [map { "'$_'" } @{$test_tuple}];
+          my $constructor_args = [@{$test_tuple}];
           my @classes = $IDD_country_code eq '44' ? qw(Number::Phone Number::Phone::Lib) :
                         $IDD_country_code eq '1'  ? qw(Number::Phone Number::Phone::Lib) :
+                        $IDD_country_code =~ /$non_geo_IDD_codes_regex/
+                                                  ? qw(Number::Phone Number::Phone::Lib) :
                                                     qw(Number::Phone::Lib);
 
           if(!ref($test_method)) { $test_method = [$test_method] }
-          my $test_methods     = [map { "'$_'" } @{$test_method}];
+          my $test_methods     = [@{$test_method}];
 
           foreach my $class (@classes) {
               push @tests, {
@@ -141,9 +149,30 @@
   }
 }
 
+foreach my $class (qw(Number::Phone Number::Phone::Lib)) {
+    foreach my $test (
+        [qw(GMSS::Iridium    612345678 +881612345678)],
+        [qw(GMSS::ICO        012345678 +881012345678)],
+        [qw(GMSS::Globalstar 812345678 +881812345678)],
+        [qw(InternationalNetworks882::Telespazio        13201234 +88213201234)],
+        [qw(InternationalNetworks882::Thuraya           1610100  +8821610100 )],
+        [qw(InternationalNetworks883::MTTGlobalNetworks 14000000 +88314000000)],
+    ) {
+        push @tests, {
+            class   => $class,
+            args    => [$test->[0], $test->[$_]],
+            methods => [
+                $test->[0] =~ /^GMSS/                        ? 'is_mobile' :
+                $test->[0] =~ /^InternationalNetworks88[23]/ ? 'is_ipphone' :
+                                                               ()
+            ]
+        } foreach(1, 2);
+    }
+}
+
 print $testfh 'foreach my $test (';
 foreach my $test (@tests) {
-    print $testfh "{ class => '".$test->{class}."', args => [".join(',',@{$test->{args}})."], methods => [".join(',',@{$test->{methods}})."] },\n";
+    print $testfh "{ class => '".$test->{class}."', args => [".join(',', map { "'$_'" } @{$test->{args}})."], methods => [".join(',', map { "'$_'" } @{$test->{methods}})."] },\n";
 }
 print $testfh ') {
     my($class, $args, $methods) = map { $test->{$_} } qw(class args methods);
@@ -155,7 +184,7 @@
             );
         my $object = $class->new(@{$args});
         my $obj_class = $object ? blessed($object) : "[undef]";
-        ok(defined($object), "$class->new(".join(", ", @{$args}).") returns an object: $obj_class") && 
+        ok(defined($object), "$class->new(".join(", ", @{$args}).") returns an object: $obj_class") &&
         ok(
             # grep is because a number might need to be checked as is_geographic *or* is_fixed_line
             (grep { $class->new(@{$args})->$_() } @{$methods}),
@@ -191,7 +220,7 @@ sub preamble {
         # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
         # See the License for the specific language governing permissions and
         # limitations under the License.
-        
+
         use strict;
         use warnings;
         use lib 't/inc';

diff --git a/buildtools/Number/Phone/BuildHelpers.pm b/buildtools/Number/Phone/BuildHelpers.pm
@@ -6,14 +6,20 @@ use warnings;
 
 use Exporter qw(import);
 our @ISA = qw(Exporter);
-our @EXPORT = qw(is_dodgy_unknown_country known_non_country_codes);
+our @EXPORT = qw(
+    get_final_class_part
+    is_dodgy_unknown_country
+    known_non_country_codes
+    $non_geo_IDD_codes_regex
+);
 
+our $non_geo_IDD_codes_regex = qr/^(800|808|870|878|881|882|883|888|979)$/;
 # these are territories where libphonenumber has some data, but
 # for "ISO" country code "001"
 sub is_dodgy_unknown_country {
     my($ISO, $IDD) = @_;
 
-    $ISO !~ /^..$/ # && $IDD !~ /^(800|808|870|878|883|888|979)$/;
+    $ISO !~ /^..$/ && $IDD !~ /$non_geo_IDD_codes_regex/
 }
 
 # see https://en.wikipedia.org/wiki/Global_Mobile_Satellite_System
@@ -27,26 +33,27 @@ sub known_non_country_codes {
         808    => 'SharedCostServices',
         870    => 'Inmarsat',
         878    => 'UniversalPersonalTelecoms',
-        881    => 'GMSS',                          # \ Satphones
-        8810   => 'ICO',                           # |
-        8811   => 'ICO',                           # |
-        # 8812 is vacant (Ellipso never launched)  # |
-        # 8813 is vacant (Ellipso never launched)  # |
-        # 8814 is spare                            # |
-        # 8815 is spare                            # |
-        8816   => 'Iridium',                       # |
-        8817   => 'Iridium',                       # |
-        8818   => 'Globalstar',                    # |
-        8819   => 'Globalstar',                    # /
-        882    => 'InternationalNetworks',         # many allocations not listed as I don't know if they're diallable, see wtng.info
-        88213  => 'Telespazio',                    # Sat-phone
-        88216  => 'Thuraya',                       # Sat-phone
-        88220  => 'GarudaMobile',                  # Sat-phone
-        88234  => 'AQ',                            # Antarctica, via Global Networks Switzerland, http://wtng.info/wtng-spe.html#Networks
-        883    => 'InternationalNetworks',
-        883120 => 'Telenor',
-        883130 => 'Mobistar',
-        883140 => 'MTTGlobalNetworks',
+        # NB all the sub-ranges in 881, 882 and 883 except AQ need empty sub-classes in lib/Number/Phone/StubCountry/.../
+        # There's also logic for them in Number::Phone->_make_stub_object()
+        # and for AQ in Number::Phone->_new_args()
+        881    => 'GMSS',                                   # \ Satphones
+        8810   => 'GMSS::ICO',                              # |
+        8811   => 'GMSS::ICO',                              # |
+        # 8812 is vacant (Ellipso never launched)           # |
+        # 8813 is vacant (Ellipso never launched)           # |
+        # 8814 is spare                                     # |
+        # 8815 is spare                                     # |
+        8816   => 'GMSS::Iridium',                          # |
+        8817   => 'GMSS::Iridium',                          # |
+        8818   => 'GMSS::Globalstar',                       # |
+        8819   => 'GMSS::Globalstar',                       # /
+        882    => 'InternationalNetworks882',               # many allocations not listed as I don't know if they're diallable, see wtng.info
+        88213  => 'InternationalNetworks882::Telespazio',   # Sat-phone
+        88216  => 'InternationalNetworks882::Thuraya',      # Sat-phone
+        88234  => 'AQ',                                     # Antarctica, via Global Networks Switzerland, http://wtng.info/wtng-spe.html#Networks
+        883    => 'InternationalNetworks883',
+        883130 => 'InternationalNetworks883::Mobistar',
+        883140 => 'InternationalNetworks883::MTTGlobalNetworks',
         888    => 'TelecomsForDisasterRelief',
         # 979 is used for testing when we fail to load a module when we
         # know what 'country' it is
@@ -56,4 +63,11 @@ sub known_non_country_codes {
     )
 }
 
+sub get_final_class_part {
+    my($ISO_country_code, $IDD_country_code) = @_;
+    return length($ISO_country_code) == 2
+      ? $ISO_country_code
+      : { known_non_country_codes() }->{$IDD_country_code};
+}
+
 1;