Added Google Analytics

Google Analytics helps keep track of how the package is used.
This gives valuable information on what parts of the package
to focus efforts on.

All collected data is fully anonymous. It can also be opted out
of if desired.

Author: noseglid

.jshintrc

@@ -20,6 +20,8 @@
   "devel":      true,       // Define globals that are usually used for debugging: console, alert, etc.
   "globals": {              // Define globals that are not defined per default
     "window":          false,
+    "navigator":       false,
+    "XMLHttpRequest":  false,
     "document":        false,
     "atom":            false,
     "module":          false,

README.md

@@ -117,3 +117,20 @@ to cycle through the errors (in the order they appear, first on stderr then on s
 
 Often, the first error is the most interesting since other errors tend to be secondary faults caused by that first one.
 To jump to the first error you can use `cmd-alt-h` (OS X) or `ctrl-alt-h` (Linux/Windows) at any point to go to the first error.
+
+## Analytics
+
+The `atom-build` package uses google analytics to keep track of which features are in use
+and at what frequency. This gives the maintainers a sense of what parts of the
+package is most important and what parts can be removed.
+
+The data is fully anonymous and can not be tracked back to you in any way.
+This is what is collected
+
+  * Build triggered, succeeded or failed.
+  * Which build tool was used.
+  * Visibility of UI components.
+
+If you really do not want to share this information, you can opt out by disabling
+the [metrics package](https://atom.io/packages/metrics). This will disable all analytics
+collection, including the one from `atom-build`.

lib/GoogleAnalytics.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var _ = require('lodash');
+var querystring = require('querystring');
+var cid = require('node-uuid').v4();
+
+module.exports = (function () {
+  function GoogleAnalytics () {}
+
+  GoogleAnalytics.sendEvent = function(category, action, label, value) {
+    var params = {
+      t: 'event',
+      ec: category,
+      ea: action
+    };
+    if (label) {
+      params.el = label;
+    }
+    if (value) {
+      params.ev = value;
+    }
+
+    GoogleAnalytics.send(params);
+  };
+
+  GoogleAnalytics.send = function (params) {
+    if (!atom.packages.getActivePackage('metrics')) {
+      // If the metrics package is disabled, then user has opted out.
+      return;
+    }
+
+    _.extend(params, GoogleAnalytics.defaultParams());
+    GoogleAnalytics.request('https://www.google-analytics.com/collect?' + querystring.stringify(params));
+  };
+
+  GoogleAnalytics.request = function (url) {
+    if (!navigator.onLine) {
+      return;
+    }
+    GoogleAnalytics.post(url);
+  };
+
+  GoogleAnalytics.post = function (url) {
+    var xhr = new XMLHttpRequest();
+    xhr.open('POST', url);
+    xhr.send(null);
+  };
+
+  GoogleAnalytics.defaultParams = function () {
+    // https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
+    return {
+      v: 1,
+      tid: 'UA-47615700-5',
+      cid: cid
+    };
+  };
+
+  return GoogleAnalytics;
+})();

lib/build-view.js

@@ -3,6 +3,7 @@
 var _ = require('lodash');
 var View = require('atom-space-pen-views').View;
 var cscompatability = require('./cscompatability');
+var GoogleAnalytics = require('./GoogleAnalytics');
 var Convert = require('ansi-to-html');
 
 module.exports = (function() {
@@ -117,6 +118,7 @@ module.exports = (function() {
   };
 
   BuildView.prototype.toggle = function(event, element) {
+    GoogleAnalytics.sendEvent('view', 'panel toggled');
     this.isAttached() ?  this.detach(true) : this.attach(true);
   };
 
@@ -135,6 +137,7 @@ module.exports = (function() {
   };
 
   BuildView.prototype.toggleMonocle = function(event, element) {
+    GoogleAnalytics.sendEvent('view', 'monocle toggled');
     if (!this.monocle) {
       this.setHeightPercent(atom.config.get('build.monocleHeight'));
       this.monocleButton.removeClass('icon-chevron-up').addClass('icon-chevron-down');

lib/build.js

@@ -8,6 +8,7 @@ var XRegExp = require('xregexp').XRegExp;
 
 var SaveConfirmView = require('./save-confirm-view');
 var BuildView = require('./build-view');
+var GoogleAnalytics = require('./GoogleAnalytics');
 var tools = require('./tools');
 
 module.exports = {
@@ -76,9 +77,11 @@ module.exports = {
     atom.commands.add('atom-workspace', 'build:error-match-first', this.errorMatchFirst.bind(this));
     atom.commands.add('atom-workspace', 'build:stop', this.stop.bind(this));
     atom.commands.add('atom-workspace', 'build:confirm', function() {
+      GoogleAnalytics.sendEvent('build', 'confirmed');
       document.activeElement.click();
     });
     atom.commands.add('atom-workspace', 'build:no-confirm', function() {
+      GoogleAnalytics.sendEvent('build', 'not confirmed');
       this.saveConfirmView.cancel();
     }.bind(this));
 
@@ -90,9 +93,12 @@ module.exports = {
         }
       });
     });
+
+    GoogleAnalytics.sendEvent('core', 'activated');
   },
 
   deactivate: function() {
+    GoogleAnalytics.sendEvent('core', 'deactivated');
     if (this.child) {
       this.child.kill('SIGKILL');
     }
@@ -124,6 +130,7 @@ module.exports = {
       if (!tool.isEligable(path)) {
         return;
       }
+      GoogleAnalytics.sendEvent('build', 'tool selected', tool.niceName);
       cmd = _.defaults(tool.settings(path), cmd);
       return true;
     });
@@ -174,6 +181,7 @@ module.exports = {
 
   },
   errorMatch: function() {
+    GoogleAnalytics.sendEvent('errorMatch', 'match');
     if (!this.cmd.errorMatch) {
       return;
     }
@@ -190,6 +198,7 @@ module.exports = {
   },
 
   errorMatchFirst: function() {
+    GoogleAnalytics.sendEvent('errorMatch', 'first');
     if (!this.cmd.errorMatch) {
       return;
     }
@@ -214,6 +223,8 @@ module.exports = {
       return;
     }
 
+    GoogleAnalytics.sendEvent('build', 'triggered');
+
     if (!this.cmd.exec) {
       return;
     }
@@ -253,9 +264,12 @@ module.exports = {
     this.child.on('close', function(exitCode) {
       this.buildView.buildFinished(0 === exitCode);
       if (0 === exitCode) {
+        GoogleAnalytics.sendEvent('build', 'succeeded');
         this.finishedTimer = setTimeout(function() {
           this.buildView.detach();
         }.bind(this), 1000);
+      } else {
+        GoogleAnalytics.sendEvent('build', 'failed');
       }
       this.child = null;
     }.bind(this));

lib/tools/Cargo.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'Cargo';
+
 module.exports.isEligable = function (path) {
   return fs.existsSync(path + '/Cargo.toml');
 };

lib/tools/Elixir.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'Elixir';
+
 module.exports.isEligable = function (path) {
   return fs.existsSync(path + '/mix.exs');
 };

lib/tools/Grunt.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'Grunt';
+
 module.exports.isEligable = function (path) {
   return fs.existsSync(path + '/Gruntfile.js');
 };

lib/tools/atom-build.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'Custom file (.atom-build.json)';
+
 module.exports.isEligable = function (path) {
   return fs.existsSync(path + '/.atom-build.json');
 };

lib/tools/gulp.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'gulp';
+
 module.exports.isEligable = function (path) {
   return fs.existsSync(path + '/gulpfile.js');
 };

lib/tools/make.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'GNU Make';
+
 module.exports.isEligable = function (path) {
   return fs.existsSync(path + '/Makefile');
 };

lib/tools/npm_apm.js

@@ -2,6 +2,8 @@
 
 var fs = require('fs');
 
+module.exports.niceName = 'npm or apm';
+
 module.exports.isEligable = function (path) {
   if (!fs.existsSync(path + '/package.json')) {
     return false;

package.json

@@ -14,7 +14,8 @@
     "temp": "^0.8.1",
     "fs-plus": "^2.4.0",
     "atom-space-pen-views": "^2.0.3",
-    "xregexp": "^2.0.0"
+    "xregexp": "^2.0.0",
+    "node-uuid": "^1.4.3"
   },
   "devDependencies": {
     "jshint": "^2.5.11",