Bugfix/fix return type of latlng (#12)

* bump a version to test npm build

* update the output for accuracy test

* remove peer dependencies and update readme

* change returning lat/lng to number instead of string

Author: nandiheath

README.md

@@ -2,13 +2,10 @@
 
 ## Installation
 
-You are required to install these two dependencies yourself if they are not already in your project:
-```bash
-npm i @turf/turf proj4
-```
-Then install the address parser:
+Install library from npm directly
+
 ```bash
-npm i hk-address-parser
+npm i hk-address-parser-lib
 ```
 
 ## Usage

accuracy_test/full_test.js

@@ -47,7 +47,7 @@ function toRad(Value) {
 
 /**
  * Load the test cases from file
- * @param {string} filePath 
+ * @param {string} filePath
  */
 async function readTestCases(filePath) {
   return new Promise((resolve, reject) => {
@@ -141,12 +141,27 @@ function loadFromCache(url) {
 
 // Replace the fetch function
 const nodeFetch = global.fetch;
+const metrics = {
+  loadedFromCache: 0,
+  totalRequest: 0,
+  repeatedRequest: 0,
+  uriHash: {},
+}
+
 global.fetch = function (...args) {
   const url = args[0];
 
+  metrics.totalRequest += 1;
+  if (metrics.uriHash[url] === undefined) {
+    metrics.uriHash[url] = 1;
+  } else {
+    metrics.uriHash[url] += 1;
+  }
+
   // try to load the cached files
   const cache = loadFromCache(url);
   if (cache) {
+    metrics.loadedFromCache += 1;
     return new Promise((resolve) => {
       resolve({
         json: () => JSON.parse(cache)
@@ -169,11 +184,11 @@ global.fetch = function (...args) {
   }
 }
 
-async function main({ limit = Infinity, outputFile }) {
+async function main({ limit = Infinity, outputFile, verbose = false }) {
   return new Promise(async (resolve, reject) => {
     const startTime = moment();
     const allTestData = await readTestCases(__dirname + '/test_cases/testcases_ogcio_searchable.csv');
-    const result ={ 
+    const result ={
       total: 0
     }
 
@@ -182,15 +197,15 @@ async function main({ limit = Infinity, outputFile }) {
     if (typeof(tag) === 'string' && tag.length > 0) {
       result.tag = tag;
     }
-    
+
     result.success = 0;
     result.failed = [];
 
     async.eachOfLimit(allTestData.slice(0, limit), 2000, async (testData) => {
       result.total += 1;
       try {
         const [address, lat, lng] = testData;
-        const jsResult = await runTest(address);      
+        const jsResult = await runTest(address);
         if (checkResult(jsResult, lat, lng)) {
           result.success += 1;
         } else {
@@ -202,20 +217,25 @@ async function main({ limit = Infinity, outputFile }) {
       }
     }, // callback
       () => {
-        log(`Finished! Total ${result.total} tests executed .`);
+        // output the result
         const timeElapsed = moment().diff(startTime, 'ms');
+        log(`Finished! Total ${result.total} tests executed .`);
         log(`Time elapsed: ${timeElapsed}ms`);
+        log(`========================================`);
+        log(`Total Request fired: ${metrics.totalRequest}`);
+        log(`Request cached: ${metrics.loadedFromCache}`);
+        log(`Repeated request: ${metrics.repeatedRequest}`);
+        log(`Average request per query: ${Math.round(metrics.totalRequest * 100/result.total) / 100}`);
         // Write to file
-        
+
         result.success_rate = `${result.success / result.total}`;
 
         if (outputFile) {
           outputResultTofile(result, outputFile);
-        } else {
+        }
+        if (verbose) {
           log(result);
         }
-        
-        
         resolve();
       })
   });
@@ -244,19 +264,18 @@ program
 program
   .description('Run the test cases')
   .option('-o, --output [file]', 'Output the test result to the file, default output to console')
-  .option('-l, --limit [n]', 'Limit the number of test cases to run')  
+  .option('-l, --limit [n]', 'Limit the number of test cases to run')
+  .option('-v, --verbose', 'Show verbose log including the failed cases')
   .parse(process.argv);
 
 
 const outputFile = program.output;
-const tag = program.tag;
-
+const verbose = program.verbose;
 // bitwise flag: | python | node |
 const limit = program.limit || Infinity;
 
-main({ limit, outputFile })
+main({ limit, outputFile, verbose })
   .then((end) => {
-    log('Done');
   })
   .catch((err) => {
     error(err);

package-lock.json

@@ -15,7 +15,9 @@
     "module": "dist/hk-address-parser.esm.js",
     "browser": "dist/hk-address-parser.min.js",
     "dependencies": {
-        "cross-fetch": "^3.0.1"
+        "cross-fetch": "^3.0.1",
+        "@turf/turf": "^5.1.6",
+        "proj4": "^2.5.0"
     },
     "devDependencies": {
         "@babel/core": "^7.3.4",
@@ -42,11 +44,6 @@
         "semver": ">=4.3.2",
         "sinon": "^7.2.7"
     },
-    "peerDependencies": {
-        "@turf/turf": "^5.1.6",
-        "bluebird": "^3.5.3",
-        "proj4": "^2.5.0"
-    },
     "scripts": {
         "build": "rollup -c",
         "dev": "rollup -c -w",

package.json

@@ -1,4 +1,5 @@
 import Address from './address';
+import { toFloat } from './../utils/util';
 
 export default class LandAddress extends Address{
   constructor(landRecord) {
@@ -41,15 +42,15 @@ export default class LandAddress extends Address{
 
   coordinate() {
     return {
-      lat: this.record.lat,
-      lng: this.record.lng,
+      lat: toFloat(this.record.lat),
+      lng: toFloat(this.record.lng),
     }
   }
 
   coordinates() {
     return [{
-      lat: this.record.lat,
-      lng: this.record.lng,
+      lat: toFloat(this.record.lat),
+      lng: toFloat(this.record.lng),
     }];
   }
 

src/models/land-address.js

@@ -1,5 +1,6 @@
 import Address from './address';
 import ogcioHelper from "../utils/ogcio-helper.js";
+import { toFloat } from './../utils/util';
 
 export default class OGCIOAddress extends Address {
     constructor(ogcioRecord) {
@@ -52,17 +53,17 @@ export default class OGCIOAddress extends Address {
             lng: 0,
         };
         if (this.record.geo !== undefined && this.record.geo.length > 0) {
-            geo.lat = this.record.geo[0].Latitude;
-            geo.lng = this.record.geo[0].Longitude;
+            geo.lat = toFloat(this.record.geo[0].Latitude);
+            geo.lng = toFloat(this.record.geo[0].Longitude);
         }
         return geo;
     }
 
     coordinates() {
         if (this.record.geo !== undefined && this.record.geo.length > 0) {
             return this.record.geo.map(geo => ({
-                lat: geo.Latitude,
-                lng: geo.Longitude
+                lat: toFloat(geo.Latitude),
+                lng: toFloat(geo.Longitude)
             }));
         }
         return [];

src/models/ogcio-address.js

@@ -0,0 +1,10 @@
+export const toFloat = (value) => {
+  if (typeof value === 'number') {
+    return value;
+  }
+  let val = parseFloat(value);
+  if (isNaN(val)) {
+    return 0;
+  }
+  return val;
+}