geo-coordinates-parser 1.5.5 → 1.5.8

package/README.md

@@ -71,9 +71,10 @@ Formats used for testing can be be accessed with:
 convert.formats
 ```
 
-**<span style="color:red">Please add coordinate formats that throw an error in the Github Issues.</span>**
+**Please add coordinate formats that throw an error in the Github Issues.**
 
-**<span style="color:red">Note that formats like 24.56S 26.48E are treated as degrees and minutes! And 24.0, 26.0 is treated as an error. If you don't want this behaviour you need to catch these cases with your own code before you use convert.</span>**
+**CAUTION!!!**
+**Coordinates like '24.56S 26.48E' are treated as degrees and minutes and '24, 26' or '24.0, 26.0' will throw an error. If you don't want this behaviour you need to catch these cases with your own code before you use convert.* *
 
 ### Want to use it in the browser?
 Add ```<script src="https://cdn.jsdelivr.net/npm/geo-coordinates-parser/bundle/geocoordsparser.js"></script>```

package/converter.js

@@ -1,4 +1,7 @@
 //function for converting coordinates from a string to decimal and verbatim
+//this is just a comment
+
+const { dd_re, dms_periods, dms_abbr, coords_other } = require('./regex.js')
 
 const toCoordinateFormat = require('./toCoordinateFormat.js')
 
@@ -15,7 +18,7 @@ function converter(coordsString, decimalPlaces) {
     decimalPlaces = 5
   }
 
-  coordsString = coordsString.replace(/\s\s+/g, ' ').trim(); //just to tidy up whitespaces
+  coordsString = coordsString.replace(/\s+/g, ' ').trim(); //just to tidy up whitespaces
 
   var ddLat = null;
   var ddLng = null; 
@@ -43,11 +46,11 @@ function converter(coordsString, decimalPlaces) {
 
       //some more validation: no zero coords or degrees only
       if (Number(Math.round(ddLat)) == Number(ddLat)) {
-        throw new Error('degree only coordinate provided')
+        throw new Error('integer only coordinate provided')
       }
 
       if (Number(Math.round(ddLng)) == Number(ddLng)) {
-        throw new Error('degree only coordinate provided')
+        throw new Error('integer only coordinate provided')
       }
       
       //get directions
@@ -78,7 +81,7 @@ function converter(coordsString, decimalPlaces) {
       }
         
       if (match[6]){
-        ddLat += match[6]/3600;
+        ddLat += match[6].replace(',', '.')/3600;
       }
   
       if (parseInt(match[2]) < 0) {
@@ -92,7 +95,7 @@ function converter(coordsString, decimalPlaces) {
       }
         
       if (match[13]) {
-        ddLng += match[13]/3600;
+        ddLng += match[13].replace(',', '.')/3600;
       }
         
       if (parseInt(match[9]) < 0) {
@@ -107,19 +110,10 @@ function converter(coordsString, decimalPlaces) {
       else if (match[7]) {
         latdir = match[7];
         lngdir = match[14];
-      }
-      else { //we have to catch an edge case where we have no direction indicators
-        throw new Error("invalid DMS coordinates format")	
-      }
-
-      //we have to catch another edge case here, same or missing direction indicators
-      if(!latdir || !lngdir) {
-        throw new Error("invalid DMS coordinates format")	
-      }
-
+      }  
     }
     else {
-      throw new Error("invalid DMS coordinates format")				
+      throw new Error("invalid DMS coordinates format")
     }
   }
   else if (dms_abbr.test(coordsString)) {
@@ -130,16 +124,10 @@ function converter(coordsString, decimalPlaces) {
       ddLat = Math.abs(parseInt(match[2]));
       if (match[4]) {
         ddLat += match[4]/60;
-        if(!match[3]) {
-          match[3] = ' ';
-        }
       }
 
       if (match[6]) {
         ddLat += match[6]/3600;
-        if(!match[5]) {
-          match[5] = ' ';
-        }
       }
 
       if (parseInt(match[2]) < 0) {
@@ -150,16 +138,10 @@ function converter(coordsString, decimalPlaces) {
 
       if (match[12]) {
         ddLng += match[12]/60;
-        if(!match[11]) {
-          match[11] = ' ';
-        }
       }
 
       if (match[14]) {
         ddLng += match[14]/3600;
-        if(!match[13]) {
-          match[13] = ' ';
-        }
       }
 
       if (parseInt(match[10]) < 0) {
@@ -188,16 +170,10 @@ function converter(coordsString, decimalPlaces) {
       ddLat = Math.abs(parseInt(match[2]));
       if (match[4]){
         ddLat += match[4]/60;
-        if(!match[3]) {
-          match[3] = ' ';
-        }
       }
 
       if (match[6]) {
         ddLat += match[6]/3600;
-        if(!match[5]) {
-          match[5] = ' ';
-        }
       }
 
       if (parseInt(match[2]) < 0) {
@@ -207,16 +183,10 @@ function converter(coordsString, decimalPlaces) {
       ddLng = Math.abs(parseInt(match[10]));
       if (match[12]) {
         ddLng += match[12]/60;
-        if(!match[11]) {
-          match[11] = ' ';
-        }
       }
 
       if (match[14]) {
         ddLng += match[14]/3600;
-        if(!match[13]) {
-          match[13] = ' ';
-        }
       }
 
       if (parseInt(match[10]) < 0) {
@@ -230,25 +200,37 @@ function converter(coordsString, decimalPlaces) {
         latdir = match[8];
         lngdir = match[16];
       }
-
+      
     }
     else {
       throw new Error("invalid coordinates format")				
     }
   }
 
-  //check longitude value - it can be wrong!
-  if (Math.abs(ddLng) >= 180) {
-    throw new Error("invalid longitude value")				
-  }
-
-  //just to be safe check latitude also...
-  if (Math.abs(ddLat) >= 90) {
-    throw new Error("invalid latitude value")				
-  }
-  
   if (matchSuccess){
-    
+
+    //more validation....
+
+      //check longitude value - it can be wrong!
+      if (Math.abs(ddLng) >= 180) {
+        throw new Error("invalid longitude value")				
+      }
+
+      //just to be safe check latitude also...
+      if (Math.abs(ddLat) >= 90) {
+        throw new Error("invalid latitude value")				
+      }
+
+    //if we have one direction we must have the other
+    if((latdir || lngdir) && (!latdir || !lngdir)) {
+      throw new Error("invalid coordinates format")	
+    }
+
+    //the directions can't be the same
+    if(latdir && latdir == lngdir) {
+      throw new Error("invalid coordinates format")	
+    }
+
     //make sure the signs and cardinal directions match
     var patt = /S|SOUTH/i;
     if (patt.test(latdir)) {
@@ -264,7 +246,6 @@ function converter(coordsString, decimalPlaces) {
       }
     }
 
-
     //we need to get the verbatim coords from the string
     //we can't split down the middle because if there are decimals they may have different numbers on each side
     //so we need to find the separating character, or if none, use the match values to split down the middle
@@ -317,7 +298,32 @@ function converter(coordsString, decimalPlaces) {
       }
 
     }
+
+    //validation again...
+
+    //we only allow zeros after the period if its DM
+    const splitLat = verbatimLat.split('.')
+    if(splitLat.length == 2) {
+      if(splitLat[1] == 0 && splitLat[1].length != 2){
+        throw new Error('invalid coordinates format')
+      }
+    }
+
+    const splitLon = verbatimLng.split('.')
+    if(splitLon.length == 2) {
+      if(splitLon[1] == 0 && splitLon[1].length != 2){
+        throw new Error('invalid coordinates format')
+      }
+    }
+
+    //no integer coords allowed
+    //validation -- no integer coords
+    if(/^\d+$/.test(verbatimLat) || /^\d+$/.test(verbatimLng)) {
+      throw new Error('degree only coordinate/s provided')
+    }
     
+
+    //some tidying up...
     if(isNaN(ddLat) && ddLat.includes(',')) {
       ddLat = ddLat.replace(',', '.')
     }
@@ -356,7 +362,8 @@ function checkMatch(match) { //test if the matched groups arrays are 'balanced'.
   }
 
   //first remove the empty values from the array
-  var filteredMatch = match.filter(x=>x);
+  //var filteredMatch = match.filter(x=>x);
+  var filteredMatch = [...match]
   
   //we need to shift the array because it contains the whole coordinates string in the first item
   filteredMatch.shift();
@@ -367,7 +374,7 @@ function checkMatch(match) { //test if the matched groups arrays are 'balanced'.
   }
 
   //regex for testing corresponding values match
-  var numerictest = /^[-+]?\d+([\.,]{1}\d+)?$/; //for testing numeric values
+  var numerictest = /^[-+]?\d+([\.,]\d+)?$/; //for testing numeric values
   var stringtest = /[eastsouthnorthwest]+/i; //for testing string values (north, south, etc)
   
   
@@ -375,7 +382,16 @@ function checkMatch(match) { //test if the matched groups arrays are 'balanced'.
   for (var i = 0; i < halflen; i++) {
     const leftside = filteredMatch[i]
     const rightside = filteredMatch[i + halflen]
-    if ((numerictest.test(leftside) && numerictest.test(rightside)) || (stringtest.test(leftside) && stringtest.test(rightside)) || leftside == rightside) {
+    const bothAreNumbers = numerictest.test(leftside) && numerictest.test(rightside)
+    const bothAreStrings = stringtest.test(leftside) && stringtest.test(rightside)
+    const valuesAreEqual = leftside == rightside
+    if (leftside == undefined && rightside == undefined) { //we have to handle undefined because regex converts it to string 'undefined'!!
+      continue
+    }
+    else if (leftside == undefined || rightside == undefined) { //no we need to handle the case where one is and the other not...
+      return false
+    }
+    else if (bothAreNumbers || bothAreStrings || valuesAreEqual) {
       continue;
     }
     else {
@@ -416,19 +432,6 @@ function coordsCloseEnough(coordsToTest) {
   }
 }
 
-//Coordinates pattern matching regex
-
-//decimal degrees
-var dd_re = /(NORTH|SOUTH|[NS])?[\s]*([+-]?[0-8]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(NORTH|SOUTH|[NS])?[\s]*[,/;]?[\s]*(EAST|WEST|[EW])?[\s]*([+-]?[0-1]?[0-9]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(EAST|WEST|[EW])?/i;
-
-//degrees minutes seconds with '.' as separator - gives array with 15 values
-var dms_periods = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*(\.)\s*([0-5]?[0-9])\s*(\.)?\s*((?:[0-5]?[0-9])(?:\.\d{1,3})?)?\s*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?\s*([+-]?[0-1]?[0-9]?[0-9])\s*(\.)\s*([0-5]?[0-9])\s*(\.)?\s*((?:[0-5]?[0-9])(?:\.\d{1,3})?)?\s*(EAST|WEST|[EW])?/i;
-
-//degrees minutes seconds with words 'degrees, minutes, seconds' as separators (needed because the s of seconds messes with the S of SOUTH) - gives array of 17 values
-var dms_abbr = /(NORTH|SOUTH|[NS])?[\ \t]*([+-]?[0-8]?[0-9])[\ \t]*(D(?:EG)?(?:REES)?)[\ \t]*([0-5]?[0-9])[\ \t]*(M(?:IN)?(?:UTES)?)[\ \t]*((?:[0-5]?[0-9])(?:\.\d{1,3})?)?(S(?:EC)?(?:ONDS)?)?[\ \t]*(NORTH|SOUTH|[NS])?(?:[\ \t]*[,/;][\ \t]*|[\ \t]*)(EAST|WEST|[EW])?[\ \t]*([+-]?[0-1]?[0-9]?[0-9])[\ \t]*(D(?:EG)?(?:REES)?)[\ \t]*([0-5]?[0-9])[\ \t]*(M(?:IN)?(?:UTES)?)[\ \t]*((?:[0-5]?[0-9])(?:\.\d{1,3})?)?(S(?:EC)?(?:ONDS)?)[\ \t]*(EAST|WEST|[EW])?/i;
-
-//everything else - gives array of 17 values 
-var coords_other = /(NORTH|SOUTH|[NS])?[\ \t]*([+-]?[0-8]?[0-9])[\ \t]*([•º°\.:]|D(?:EG)?(?:REES)?)?[\ \t]*,?([0-5]?[0-9](?:\.\d{1,})?)?[\ \t]*(['′´’\.:]|M(?:IN)?(?:UTES)?)?[\ \t]*,?((?:[0-5]?[0-9])(?:\.\d{1,3})?)?[\ \t]*(''|′′|’’|´´|["″”\.])?[\ \t]*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?[\ \t]*([+-]?[0-1]?[0-9]?[0-9])[\ \t]*([•º°\.:]|D(?:EG)?(?:REES)?)?[\ \t]*,?([0-5]?[0-9](?:\.\d{1,})?)?[\ \t]*(['′´’\.:]|M(?:IN)?(?:UTES)?)?[\ \t]*,?((?:[0-5]?[0-9])(?:\.\d{1,3})?)?[\ \t]*(''|′′|´´|’’|["″”\.])?[\ \t]*(EAST|WEST|[EW])?/i;
 
 const to = Object.freeze({
   DMS: 'DMS',

package/failFormats.js

@@ -1,6 +1,13 @@
 //TODO These formats should throw...
 
 const failingFormats = [
+  '10,10',
+  '46,8',
+  '12.12323, 123',
+  '24.0, 26.0',
+  '27.0 23.0', //same as above but different values
+  '10.00000S 10.000000E', //integer values only
+  '00.00 01.00', //DM, but no directions
   '50°4\'17.698"south, 24.34532', //different formats on each side
   '90°4\'17.698"south, 23°4\'17.698"east', //latitude out of bounds
   '89°4\'17.698"south, 183°4\'17.698"east', //longitude out of bounds
@@ -11,6 +18,7 @@ const failingFormats = [
   'S 27.45.34 S 23.23.23', //invalid direction on right side
   'S 90°4\'17.698" S 23°4\'17.698"',
   '27.45.34 S S 23.23.23', //invalid direction on right side
+  '27.45.34  23.23.23 E' //no dir on one side
 ]
 
 module.exports = failingFormats

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geo-coordinates-parser",
-  "version": "1.5.5",
+  "version": "1.5.8",
   "description": "A Javascript function for reading a variety of coordinate formats and converting to decimal numbers. Builds on other efforts by returning the verbatim coordinates and the decimal coordinates all in one object.",
   "main": "merge.js",
   "scripts": {

package/regex.js

@@ -0,0 +1,20 @@
+//Coordinates pattern matching regex
+
+//decimal degrees
+var dd_re = /(NORTH|SOUTH|[NS])?[\s]*([+-]?[0-8]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(NORTH|SOUTH|[NS])?[\s]*[,/;]?[\s]*(EAST|WEST|[EW])?[\s]*([+-]?[0-1]?[0-9]?[0-9](?:[\.,]\d{3,}))[\s]*([•º°]?)[\s]*(EAST|WEST|[EW])?/i;
+
+//degrees minutes seconds with '.' as separator - gives array with 15 values
+var dms_periods = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*(\.)\s*([0-5]?[0-9])\s*(\.)\s*((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?\s*([+-]?[0-1]?[0-9]?[0-9])\s*(\.)\s*([0-5]?[0-9])\s*(\.)\s*((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(EAST|WEST|[EW])?/i;
+
+//degrees minutes seconds with words 'degrees, minutes, seconds' as separators (needed because the s of seconds messes with the S of SOUTH) - gives array of 17 values
+var dms_abbr = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*(D(?:EG)?(?:REES)?)\s*([0-5]?[0-9])\s*(M(?:IN)?(?:UTES)?)\s*((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(S(?:EC)?(?:ONDS)?)?\s*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?\s*([+-]?[0-1]?[0-9]?[0-9])\s*(D(?:EG)?(?:REES)?)\s*([0-5]?[0-9])\s*(M(?:IN)?(?:UTES)?)\s*((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(S(?:EC)?(?:ONDS)?)\s*(EAST|WEST|[EW])?/i;
+
+//everything else - gives array of 17 values 
+var coords_other = /(NORTH|SOUTH|[NS])?\s*([+-]?[0-8]?[0-9])\s*([•º°\.:]|D(?:EG)?(?:REES)?)?\s*,?([0-5]?[0-9](?:[\.,]\d{1,})?)?\s*(['′´’\.:]|M(?:IN)?(?:UTES)?)?\s*,?((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(''|′′|’’|´´|["″”\.])?\s*(NORTH|SOUTH|[NS])?(?:\s*[,/;]\s*|\s*)(EAST|WEST|[EW])?\s*([+-]?[0-1]?[0-9]?[0-9])\s*([•º°\.:]|D(?:EG)?(?:REES)?)?\s*,?([0-5]?[0-9](?:[\.,]\d{1,})?)?\s*(['′´’\.:]|M(?:IN)?(?:UTES)?)?\s*,?((?:[0-5]?[0-9])(?:[\.,]\d{1,3})?)?\s*(''|′′|´´|’’|["″”\.])?\s*(EAST|WEST|[EW])?/i;
+
+module.exports = {
+  dd_re, 
+  dms_periods,
+  dms_abbr,
+  coords_other
+}

package/testFormats.json

@@ -132,6 +132,13 @@
     "decimalLatitude": 40.1230555555,
     "decimalLongitude": -74.12305555555555
   },
+  {
+    "verbatimCoordinates": "40°7’23\"S 74°7’23\"E",
+    "verbatimLatitude": "40°7’23\"S",
+    "verbatimLongitude": "74°7’23\"E",
+    "decimalLatitude": -40.1230555555,
+    "decimalLongitude": 74.12305555555555
+  },
   {
     "verbatimCoordinates": "40°7’23\" -74°7’23\"",
     "verbatimLatitude": "40°7’23\"",
@@ -293,6 +300,27 @@
     "decimalLatitude": -27.2625,
     "decimalLongitude": 18.548055
   },
+  {
+    "verbatimCoordinates": "-27.15.45 18.32.53",
+    "verbatimLatitude": "-27.15.45",
+    "verbatimLongitude": "18.32.53",
+    "decimalLatitude": -27.2625,
+    "decimalLongitude": 18.548055
+  },
+  {
+    "verbatimCoordinates": "27.15.45.2S 18.32.53.4E",
+    "verbatimLatitude": "27.15.45.2S",
+    "verbatimLongitude": "18.32.53.4E",
+    "decimalLatitude": -27.262556,
+    "decimalLongitude": 18.548167
+  },
+  {
+    "verbatimCoordinates": "27.15.45,2S 18.32.53,4E",
+    "verbatimLatitude": "27.15.45,2S",
+    "verbatimLongitude": "18.32.53,4E",
+    "decimalLatitude": -27.262556,
+    "decimalLongitude": 18.548167
+  },
   {
     "verbatimCoordinates": "S23.43563 °  E22.45634 °",
     "verbatimLatitude": "S23.43563 °",
@@ -313,5 +341,12 @@
     "verbatimLongitude": "23.23.23 E",
     "decimalLatitude": -27.759444,
     "decimalLongitude": 23.38972222
+  },
+  {
+    "verbatimCoordinates": "S 27.45.34 E 23.23.23",
+    "verbatimLatitude": "S 27.45.34",
+    "verbatimLongitude": "E 23.23.23",
+    "decimalLatitude": -27.759444,
+    "decimalLongitude": 23.38972222
   }
 ]

package/testIndividual.js

@@ -1,5 +1,6 @@
 const convert = require('./converter')
-const test = 'S 27.45.34 S 23.23.23'
+const test = '10,11'
+//const test = '00.00, 01.00'
 
 try{
   let converted = convert(test)

package/testformats.js

@@ -103,6 +103,13 @@ var coordsParserFormats = [
     decimalLatitude: 40.1230555555,
     decimalLongitude: -74.12305555555555
   },
+  {
+    verbatimCoordinates: '40°7’23"S 74°7’23"E',
+    verbatimLatitude: '40°7’23"S', 
+    verbatimLongitude: '74°7’23"E',
+    decimalLatitude: -40.1230555555,
+    decimalLongitude: 74.12305555555555
+  },
   {
     verbatimCoordinates: '40°7’23" -74°7’23"',
     verbatimLatitude: '40°7’23"', 
@@ -237,6 +244,27 @@ var coordsRegexFormats = [
 
 var otherFormats = [
   // additional formats we've encountered
+  {
+    verbatimCoordinates: '10.432342S 10.6345345E', //this is read as degrees and minutes
+    verbatimLatitude: '10.432342S', 
+    verbatimLongitude: '10.6345345E', 
+    decimalLatitude: -10.432342,
+    decimalLongitude: 10.6345345
+  },
+  {
+    verbatimCoordinates: '10.00S 10.00E', //this is read as degrees and minutes
+    verbatimLatitude: '10.00S', 
+    verbatimLongitude: '10.00E', 
+    decimalLatitude: -10.00000,
+    decimalLongitude: 10.00000
+  },
+  {
+    verbatimCoordinates: '00.00S 01.00E', //this is read as degrees and minutes
+    verbatimLatitude: '00.00S', 
+    verbatimLongitude: '01.00E', 
+    decimalLatitude: 0.00000,
+    decimalLongitude: 1.00000
+  },
   {
     verbatimCoordinates: '18.24S 22.45E', //this is read as degrees and minutes
     verbatimLatitude: '18.24S', 
@@ -272,6 +300,27 @@ var otherFormats = [
     verbatimLongitude: '18.32.53E',
     decimalLatitude: -27.2625,
     decimalLongitude: 18.548055
+  },
+  {
+    verbatimCoordinates: '-27.15.45 18.32.53',
+    verbatimLatitude: '-27.15.45', 
+    verbatimLongitude: '18.32.53',
+    decimalLatitude: -27.2625,
+    decimalLongitude: 18.548055
+  }, 
+  {
+    verbatimCoordinates: '27.15.45.2S 18.32.53.4E',
+    verbatimLatitude: '27.15.45.2S', 
+    verbatimLongitude: '18.32.53.4E',
+    decimalLatitude: -27.262556,
+    decimalLongitude: 18.548167
+  }, 
+  {
+    verbatimCoordinates: '27.15.45,2S 18.32.53,4E',
+    verbatimLatitude: '27.15.45,2S', 
+    verbatimLongitude: '18.32.53,4E',
+    decimalLatitude: -27.262556,
+    decimalLongitude: 18.548167
   }, 
   {
     verbatimCoordinates: 'S23.43563 °  E22.45634 °', //decimals with spaces before the symbol!!