Merge branch 'master' into updated-docs

packages/turf-bearing/README.md

@@ -2,7 +2,8 @@
 
 # bearing
 
-Takes two [points](http://geojson.org/geojson-spec.html#point) and finds the geographic bearing between them.
+Takes two [points](http://geojson.org/geojson-spec.html#point) and finds the geographic bearing between them,
+i.e. the angle measured in degrees from the north line (0 degrees)
 
 **Parameters**
 
@@ -39,7 +40,7 @@ point1.properties.bearing = bearing
 //=bearing
 ```
 
-Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** bearing in decimal degrees
+Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** bearing in decimal degrees, between -180 and 180 degrees (positive clockwise)
 
 <!-- This file is automatically generated. Please don't edit it directly:
 if you find an error, edit the source file (likely index.js), and re-run

packages/turf-bearing/index.js

@@ -3,13 +3,14 @@ var getCoord = require('@turf/invariant').getCoord;
 //http://www.movable-type.co.uk/scripts/latlong.html
 
 /**
- * Takes two {@link Point|points} and finds the geographic bearing between them.
+ * Takes two {@link Point|points} and finds the geographic bearing between them,
+ * i.e. the angle measured in degrees from the north line (0 degrees)
  *
  * @name bearing
  * @param {Feature<Point>} start starting Point
  * @param {Feature<Point>} end ending Point
  * @param {boolean} [final=false] calculates the final bearing if true
- * @returns {number} bearing in decimal degrees
+ * @returns {number} bearing in decimal degrees, between -180 and 180 degrees (positive clockwise)
  * @example
  * var point1 = {
  *   "type": "Feature",

packages/turf-circle/index.js

@@ -1,6 +1,5 @@
 var destination = require('@turf/destination');
-var helpers = require('@turf/helpers');
-var polygon = helpers.polygon;
+var polygon = require('@turf/helpers').polygon;
 
 /**
  * Takes a {@link Point} and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
@@ -19,10 +18,18 @@ var polygon = helpers.polygon;
  *
  * var circle = turf.circle(center, radius, steps, units);
  *
- * //=circle
+ * //addToMap
+ * var addToMap = [center, circle]
  */
 module.exports = function (center, radius, steps, units) {
+    // validation
+    if (!center) throw new Error('center is required');
+    if (!radius) throw new Error('radius is required');
+
+    // default params
     steps = steps || 64;
+
+    var properties = center.properties;
     var coordinates = [];
 
     for (var i = 0; i < steps; i++) {
@@ -31,5 +38,5 @@ module.exports = function (center, radius, steps, units) {
 
     coordinates.push(coordinates[0]);
 
-    return polygon([coordinates]);
+    return polygon([coordinates], properties);
 };

packages/turf-circle/package.json

@@ -31,10 +31,11 @@
   },
   "homepage": "https://github.com/Turfjs/turf",
   "devDependencies": {
-    "benchmark": "^1.0.0",
-    "tape": "^3.5.0",
-    "@turf/distance": "^4.1.0",
-    "@turf/inside": "^4.1.0"
+    "@turf/truncate": "^4.1.0",
+    "benchmark": "^2.1.4",
+    "load-json-file": "^2.0.0",
+    "tape": "^4.6.3",
+    "write-json-file": "^2.0.0"
   },
   "dependencies": {
     "@turf/destination": "^4.1.0",

packages/turf-circle/test.js

@@ -1,21 +1,33 @@
-var test = require('tape');
-var destination = require('@turf/destination');
-var inside = require('@turf/inside');
-var circle = require('./');
+const test = require('tape');
+const fs = require('fs');
+const path = require('path');
+const load = require('load-json-file');
+const write = require('write-json-file');
+const truncate = require('@turf/truncate');
+const featureCollection = require('@turf/helpers').featureCollection;
+const circle = require('./');
 
-test('circle', function(t){
-    var center = {
-        type: "Feature",
-        geometry: {type: "Point", coordinates: [-75.343, 39.984]}
+const directories = {
+    in: path.join(__dirname, 'test', 'in') + path.sep,
+    out: path.join(__dirname, 'test', 'out') + path.sep
+};
+
+const fixtures = fs.readdirSync(directories.in).map(filename => {
+    return {
+        filename,
+        name: path.parse(filename).name,
+        geojson: load.sync(directories.in + filename)
     };
-    var radius = 5;
-    var steps = 10;
+});
 
-    var polygon = circle(center, radius, steps, 'kilometers');
-    var point1 = destination(center, radius - 1, 45, 'kilometers');
-    var point2 = destination(center, radius + 1, 135, 'kilometers');
+test('turf-circle', t => {
+    for (const {filename, name, geojson}  of fixtures) {
+        const {radius, steps, units} = geojson.properties;
+        const C = truncate(circle(geojson, radius, steps, units));
+        const results = featureCollection([geojson, C]);
 
-    t.equal(inside(point1, polygon), true, 'point is inside the polygon');
-    t.equal(inside(point2, polygon), false, 'point is outside the polygon');
+        if (process.env.REGEN) write.sync(directories.out + filename, results);
+        t.deepEquals(results, load.sync(directories.out + filename), name);
+    }
     t.end();
 });

packages/turf-circle/test/in/circle1.geojson

@@ -0,0 +1,13 @@
+{
+  "type": "Feature",
+  "properties": {
+    "radius": 5
+  },
+  "geometry": {
+    "type": "Point",
+    "coordinates": [
+      -75.343,
+      39.984
+    ]
+  }
+}