Merge branch 'master' into reorg-src

Author: etpinard

.gitignore

@@ -3,4 +3,7 @@ node_modules
 build/*
 !build/README.md
 
+dist/*
+!dist/README.md
+
 npm-debug.log

CONTRIBUTING.md

@@ -0,0 +1 @@
+yolos!

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Plotly, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,3 +1,92 @@
-# plotly.js
+# [plotly.js](https://plot.ly/javascript/getting-started/)
 
-The premier high-level javascript graphing library
+[![npm version](https://img.shields.io/npm/v/plotly.svg)](https://www.npmjs.com/package/plotly)
+
+To get started, check out <https://plot.ly/javascript/getting-started/>!
+
+## Table of contents
+
+* [Quick start](#quick-start)
+* [Bugs and feature requests](#bugs-and-feature-requests)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [Community](#community)
+* [Clients for R, Python, and MATLAB](#clients-for-r-python-and-matlab)
+* [Creators](#creators)
+* [Copyright and license](#copyright-and-license)
+
+
+## Quick start
+
+Several quick start options are available:
+
+* [Download the latest release](https://github.com/plotly/plotly.js/releases/v1.0.0/plotly.js.zip).
+* Clone the repo: `git clone https://github.com/plotly/plotly.js.git`.
+* Install with [npm](https://www.npmjs.com): `npm install plotly`.
+* Use the plotly.js CDN hosted by Fastly:
+
+```html
+<!-- Latest compiled and minified plotly.js JavaScript -->
+<script type="text/javascript" src="https://cdn.plot.ly/plotly-latest.min.js">
+```
+
+Read the [Getting started page](https://plot.ly/javascript/getting-started/) for examples.
+
+## Bugs and feature requests
+
+Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new).
+
+## Documentation
+
+Plotly.js documentation, in the repo documentation, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <https://plot.ly/javascript/getting-started/>. The docs may also be run locally.
+
+You can also suggest new documentation examples by submitting a [Codepen](http://codepen.io/tag/plotly/) on community.plot.ly (tagged [`plotly-js`](community.plot.ly/c/plotly-js).
+
+## Contributing
+
+Please read through our [contributing guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
+
+## Community
+
+Get updates on plotly.js's development and chat with the project maintainers and community members.
+
+* Follow [@plotlygraphs on Twitter](https://twitter.com/plotlygraphs).
+* Implementation help may be found at Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js).
+* Developers should use the keyword `plotly` on packages which modify or add to the functionality of plotly.js when distributing through [npm](https://www.npmjs.com/browse/keyword/plotly) or similar delivery mechanisms for maximum discoverability.
+* Direct developer email support can be purchased through a [Plotly Pro](https://plot.ly/products/cloud/) plan.
+
+## Versioning
+
+For transparency into our release cycle and in striving to maintain backward compatibility, plotly.js is maintained under [the Semantic Versioning guidelines](http://semver.org/). 
+
+See [the Releases section of our GitHub project](https://github.com/plotly/plotly.js/releases) for changelogs for each release version of plotly.js.
+
+## Clients for R, Python, and MATLAB
+
+Open-source clients to the plotly.js APIs are available at these links:
+
+|   | GitHub repo | Getting started |
+|---|--------|---------|
+|**R / RStudio**| [ropensci/plotly](https://github.com/ropensci/plotly) | [plot.ly/r/getting-started](https://plot.ly/r/getting-started) |
+|**Python / Pandas / IPython notebook**| [plotly/plotly.py](https://github.com/plotly/plotly.py) | [plot.ly/python/getting-started](https://plot.ly/python/getting-started) |
+|**MATLAB**| [plotly/matlab-api](https://github.com/plotly/matlab-api) | [plot.ly/matlab/getting-started](https://plot.ly/matlab/getting-started) |
+|**node.js**| [plotly/plotly-nodejs](https://github.com/plotly/plotly-nodejs) | [plot.ly/nodejs/getting-started/](https://plot.ly/nodejs/getting-started/) |
+|**Julia**| [plotly/Plotly.jl](https://github.com/plotly/Plotly.jl) | [plot.ly/julia/getting-started/](https://plot.ly/julia/getting-started/) |
+
+plotly.js charts can also be created and saved online for free at [plot.ly/plot](https://plot.ly/plot).
+
+## Creators
+
+|   | Github | Twitter |
+|---|--------|---------|
+|**Alex C. Johnson**| [@alexcjohnson](https://github.com/alexcjohnson) | |
+|**Étienne Tétreault-Pinard**| [@etpinard](https://github.com/etpinard) | [@etpinard](https://twitter.com/etpinard) |
+|**Mikola Lysenko**| [@mikolalysenko](https://github.com/mikolalysenko) | [@MikolaLysenko](https://twitter.com/MikolaLysenko) |
+|**Ben Postlethwaite**| [@bpostlethwaite](https://github.com/bpostlethwaite) | |
+|**Chris Parmer**| [@chriddyp](https://github.com/chriddyp) | |
+
+## Copyright and license
+
+Code and documentation copyright 2015 Plotly, Inc. 
+Code released under [the MIT license](https://github.com/plotly/plotly.js/blob/master/LICENSE). 
+Docs released under [Creative Commons](https://github.com/plotly/documentation/blob/source/LICENSE).

devtools/test_dashboard/server.js

@@ -6,7 +6,7 @@ var browserify = require('browserify');
 var ecstatic = require('ecstatic');
 var _open = require('open');
 
-var makeWatchifiedBundle = require('../../tasks/watch_plotly');
+var makeWatchifiedBundle = require('../../tasks/util/make_watchified_bundle');
 var shortcutPaths = require('../../tasks/util/shortcut_paths');
 var constants = require('../../tasks/util/constants');
 

tasks/bench.js

@@ -4,6 +4,7 @@ var browserify = require('browserify');
 var UglifyJS = require('uglify-js');
 
 var compressAttributes = require('./util/compress_attributes');
+var appendVersion = require('./util/append_version');
 var constants = require('./util/constants');
 
 /*
@@ -24,7 +25,10 @@ try {
     fs.statSync(constants.pathToFontSVGBuild).isFile();
 }
 catch(e) {
-    throw new Error('Please run `npm run preprocess` first');
+    throw new Error([
+        'build/ is missing a or more files',
+        'Please run `npm run preprocess` first'
+    ].join('\n'));
 }
 
 
@@ -41,30 +45,43 @@ browserify(constants.pathToPlotlySrc, {
     if(!DEV) {
         fs.writeFile(
             constants.pathToPlotlyDistMin,
-            UglifyJS.minify(buf.toString(), constants.uglifyOptions).code
+            UglifyJS.minify(buf.toString(), constants.uglifyOptions).code,
+            function() {
+                appendVersion(
+                    constants.pathToPlotlyDistMin, {object: 'Plotly'}
+                );
+            }
         );
     }
 })
-.pipe(fs.createWriteStream(constants.pathToPlotlyDist));
+.pipe(fs.createWriteStream(constants.pathToPlotlyDist))
+.on('finish', function() {
+    appendVersion(constants.pathToPlotlyDist, {object: 'Plotly', DEV: DEV});
+});
 
 
 // Browserify the geo assets
 browserify(constants.pathToPlotlyGeoAssetsSrc, {
     standalone: 'PlotlyGeoAssets'
 })
-.bundle(function(err, buf) {
+.bundle(function(err) {
     if(err) throw err;
 })
-.pipe(fs.createWriteStream(constants.pathToPlotlyGeoAssetsDist));
-
+.pipe(fs.createWriteStream(constants.pathToPlotlyGeoAssetsDist))
+.on('finish', function() {
+    appendVersion(constants.pathToPlotlyGeoAssetsDist, {object: 'PlotlyGeoAssets'});
+});
 
 
 // Browserify the plotly.js with meta
 browserify(constants.pathToPlotlySrc, {
     debug: DEV,
     standalone: 'Plotly'
 })
-.bundle(function(err, buf) {
+.bundle(function(err) {
     if(err) throw err;
 })
-.pipe(fs.createWriteStream(constants.pathToPlotlyDistWithMeta));
+.pipe(fs.createWriteStream(constants.pathToPlotlyDistWithMeta))
+.on('finish', function() {
+    appendVersion(constants.pathToPlotlyDistWithMeta, {object: 'Plotly', DEV: DEV});
+});

tasks/bundle.js

@@ -0,0 +1,24 @@
+var fs = require('fs');
+
+var pkg = require('../../package.json');
+
+/**
+ * Append package version to bundle
+ *
+ * @param {string} path path to bundle
+ * @param {object} opts
+ *   - object {string} the standalone object in the bundle
+ *   - DEV {boolean} is this a DEV build?
+ */
+module.exports = function appendVersion(path, opts) {
+    var txt = [
+        opts.object,
+        '.version=', '\'',
+        pkg.version, opts.DEV ? '-dev' : '',
+        '\'', ';'
+    ].join('');
+
+    fs.appendFile(path, txt, function(err) {
+        if(err) throw err;
+    }) ;
+};

tasks/citest.js

@@ -0,0 +1,58 @@
+var fs = require('fs');
+
+var browserify = require('browserify');
+var watchify = require('watchify');
+
+var compressAttributes = require('./compress_attributes');
+var appendVersion = require('./append_version');
+var formatBundleMsg = require('./format_bundle_msg');
+var constants = require('./constants');
+
+/**
+ * Make a plotly.js browserify bundle function watched by watchify.
+ *
+ * @param {function} onFirstBundleCallback executed when first bundle is completed
+ *
+ */
+module.exports = function makeWatchifiedBundle(onFirstBundleCallback) {
+    var b = browserify(constants.pathToPlotlySrc, {
+        debug: true,
+        standalone: 'Plotly',
+        transform: [compressAttributes],
+        cache: {},
+        packageCache: {},
+        plugin: [watchify]
+    });
+
+    var firstBundle = true;
+
+    if(firstBundle) {
+        console.log([
+            '***',
+            'Building the first bundle, this should take ~10 seconds',
+            '***\n'
+        ].join(' '));
+    }
+
+    b.on('update', bundle);
+    formatBundleMsg(b, 'plotly.js');
+
+    function bundle() {
+        b.bundle(function(err) {
+            if(err) console.error(JSON.stringify(String(err)));
+
+            if(firstBundle) {
+                onFirstBundleCallback();
+                firstBundle = false;
+            }
+        })
+        .pipe(
+            fs.createWriteStream(constants.pathToPlotlyDist)
+        )
+        .on('finish', function() {
+            appendVersion(constants.pathToPlotlyDist, {object: 'Plotly', DEV: true});
+        });
+    }
+
+    return bundle;
+};

tasks/postpublish.js

@@ -1,63 +1,5 @@
-var fs = require('fs');
+var makeWatchifiedBundle = require('./util/make_watchified_bundle');
 
-var browserify = require('browserify');
-var watchify = require('watchify');
-
-var compressAttributes = require('./util/compress_attributes');
-var formatBundleMsg = require('./util/format_bundle_msg');
-var constants = require('./util/constants');
-
-/**
- * Make a browserify bundle function watched by watchify.
- *
- * @param {function} onFirstBundleCallback executed when first bundle is completed
- *
- */
-function makeWatchifiedBundle(onFirstBundleCallback) {
-    var b = browserify(constants.pathToPlotlySrc, {
-        debug: true,
-        standalone: 'Plotly',
-        transform: [compressAttributes],
-        cache: {},
-        packageCache: {},
-        plugin: [watchify]
-    });
-
-    var firstBundle = true;
-
-    if(firstBundle) {
-        console.log([
-            '***',
-            'Building the first bundle, this should take ~10 seconds',
-            '***\n'
-        ].join(' '));
-    }
-
-    b.on('update', bundle);
-    formatBundleMsg(b, 'plotly.js');
-
-    function bundle() {
-        b.bundle(function(err) {
-            if(err) console.error(JSON.stringify(String(err)));
-
-            if(firstBundle) {
-                onFirstBundleCallback();
-                firstBundle = false;
-            }
-        })
-        .pipe(
-            fs.createWriteStream(constants.pathToPlotlyDist)
-        );
-    }
-
-    return bundle;
-}
-
-// call watchifiedBundle if ran in CLI
-if(process.argv[1] === __filename) {
-    var watchifiedBundle = makeWatchifiedBundle(function() {});
-    watchifiedBundle();
-}
-
-// export if required in
-module.exports = makeWatchifiedBundle;
+// make watchified bundle and run it!
+var watchifiedBundle = makeWatchifiedBundle(function() {});
+watchifiedBundle();