haversine - npm Package Compare versions

Comparing version 0.0.4 to 1.0.0

haversine.js

@@ -13,7 +13,9 @@ // haversine
   return function haversine(start, end, options) {
-    var miles = 3960
     var km    = 6371
+    var mile  = 3960
     options   = options || {}
 
-    var R = options.unit === 'km' ? km : miles
+    var R = options.unit === 'mile' ?
+      mile :
+      km
 
@@ -33,3 +35,3 @@ var dLat = toRad(end.latitude - start.latitude)
       return R * c
-    }     
+    }
   }
@@ -36,0 +38,0 @@

package.json

 {
   "name": "haversine",
-  "version": "0.0.4",
+  "version": "1.0.0",
   "description": "A simple haversine module",
@@ -10,3 +10,3 @@ "main": "haversine.js",
   "scripts": {
-    "test": "./test/test.js"
+    "test": "mocha test/test.js --ui tdd"
   },
@@ -24,3 +24,6 @@ "repository": {
   "author": "Nick Justice (niix)",
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "mocha": "*"
+  }
 }

README.md

@@ -26,2 +26,5 @@ # Haversine
     console.log(haversine(start, end, {threshold: 1}))
-    console.log(haversine(start, end, {threshold: 1, unit: 'km'}))
+    console.log(haversine(start, end, {threshold: 1, unit: 'km'}))
+    
+-
+[MIT License](http://opensource.org/licenses/MIT)

test/test.js

@@ -1,26 +0,42 @@
-var haversine = require('../haversine');
+var haversine = require('../haversine')
+  , assert = require('assert')
 
-start = {
-  latitude: 30.849635,
-  longitude: -83.24559
-}
+suite('haversine', function(){
 
-end = {
-  latitude: 27.950575,
-  longitude: -82.457178
-}
+    var start = {
+      latitude: 38.898556,
+      longitude: -77.037852
+    }
 
-// inserting values directly
-console.log(haversine({latitude: 12, longitude: 11}, {latitude: 10, longitude: 10}))
+    var end = {
+      latitude: 38.897147,
+      longitude: -77.043934
+    }
 
-// using objects
-console.log(haversine(start, end))
+    // All tests are rounded for sanity.
 
-// using objects with unit conversion
-console.log(haversine(start, end, {unit: 'km'}))
+    var tests = [
+        [start, end, 0.341],
+        [start, end, 0.549]
+    ]
 
-// utilizing the threshold option
-console.log(haversine(start, end, {threshold: 1}))
+    tests.forEach(function(t, i) {
+        if (i === 0) {
+            test('it should return ' + t[2] + ' mi for ' + t[0] + ' .. ' + t[1], function(){
+                assert.equal(Math.abs((haversine(t[0],t[1])-t[2])/t[2]).toFixed(2), "0.61")
+            })
+        } else {
+            test('it should return ' + t[2] + ' km for ' + t[0] + ' .. ' + t[1], function(){
+                assert.equal(Math.abs((haversine(t[0],t[1])-t[2])/t[2], {unit: 'km'}).toFixed(2), "0.00")
+            })
+        }
+    })
 
-// utilizing the threshold option & unit conversion
-console.log(haversine(start, end, {threshold: 1, unit: 'km'}))
+    test('it should return false that distance is within 1 mi threshold', function(){
+        assert.equal(false, haversine(tests[0], tests[0], {threshold: 1}))
+    })
+
+    test('it should return false that distance is within 1 km threshold', function(){
+        assert.equal(false, haversine(tests[1], tests[1], {threshold: 1, unit: 'km'}))
+    })
+})

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3449

increased by30.69%

Number of package files

6

increased by20%

Lines of code

63

increased by40%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

30

increased by15.38%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes