Made JS invocation tag part of the build process (snowplow#158)

Author: fblundun

.gitignore

@@ -21,6 +21,7 @@ node_modules
 lib_managed
 dist
 tests/pages/*.js
+tags/tag.min.js
 
 # creds for Grunt
 aws.json

CHANGELOG

@@ -26,6 +26,7 @@ Fixed link to code climate button in README.md (#149)
 Added examples of tracker namespacing (#159)
 Split async.html into async-small.html, async-medium.html (#160)
 Linked the Technical Docs and Setup Guide images to the appropriate pages (#164)
+Made JS invocation tag part of the build process (#158)
 
 Version 1.0.3 (2014-06-27)
 --------------------------

Gruntfile.js

@@ -110,8 +110,14 @@ module.exports = function(grunt) {
           'process': true
         },
         src: ['dist/bundle.js'],
-
         dest: 'dist/snowplow.js'
+      },
+      tag: {
+        options: {
+          banner: ';'
+        },
+        src: ['tags/tag.min.js'],
+        dest: 'tags/tag.min.js'
       }
     },
 
@@ -123,8 +129,19 @@ module.exports = function(grunt) {
         },
         files: [
           {
-          src: 'dist/snowplow.js',
-          dest: 'dist/sp.js'
+            src: 'dist/snowplow.js',
+            dest: 'dist/sp.js'
+          }
+        ]
+      },
+      tag: {
+        options: {
+          linebreak: 50
+        },
+        files: [
+          {
+            src: 'tags/tag.js',
+            dest: 'tags/tag.min.js'
           }
         ]
       }
@@ -226,9 +243,10 @@ module.exports = function(grunt) {
     });
   });
 
-  grunt.registerTask('default', 'Build lodash, Browserify, add banner, and minify', ['lodash', 'browserify:main', 'concat', 'min']);
-  grunt.registerTask('publish', 'Upload to S3 and invalidate Cloudfront (full semantic version only)', ['upload_setup', 'concat', 'min', 's3:not_pinned', 'invalidate_cloudfront:not_pinned']);
-  grunt.registerTask('publish-pinned', 'Upload to S3 and invalidate Cloudfront (full semantic version and semantic major version)', ['upload_setup', 'concat', 'min', 's3', 'invalidate_cloudfront']);
+  grunt.registerTask('default', 'Build lodash, Browserify, add banner, and minify', ['lodash', 'browserify:main', 'concat:dist', 'min:dist']);
+  grunt.registerTask('publish', 'Upload to S3 and invalidate Cloudfront (full semantic version only)', ['upload_setup', 'concat:dist', 'min:dist', 's3:not_pinned', 'invalidate_cloudfront:not_pinned']);
+  grunt.registerTask('publish-pinned', 'Upload to S3 and invalidate Cloudfront (full semantic version and semantic major version)', ['upload_setup', 'concat:dist', 'min:dist', 's3', 'invalidate_cloudfront']);
   grunt.registerTask('test', 'Intern tests', ['browserify:test', 'intern']);
   grunt.registerTask('travis', 'Intern tests for Travis CI',  ['lodash','browserify:test','intern']);
+  grunt.registerTask('tags', 'Minifiy the Snowplow invocation tag', ['min:tag', 'concat:tag']);
 }

examples/web/async-medium.html

@@ -20,19 +20,11 @@
     <!-- Snowplow starts plowing -->
     <script type="text/javascript">
 
-        ;(function(p,l,o,w,i,n,g) {
-          p['GlobalSnowplowNamespace'] = p['GlobalSnowplowNamespace']||[];
-          p['GlobalSnowplowNamespace'].push(i);
-          p[i] = p[i] || function() {
-            (p[i].q = p[i].q||[]).push(arguments);
-          };
-          p[i].q = p[i].q || [];
-          n = l.createElement(o);
-          g = l.getElementsByTagName(o)[0];
-          n.async = 1;
-          n.src = w;
-          g.parentNode.insertBefore(n,g);
-        }(window, document, 'script', '../../dist/snowplow.js', 'new_name_here'));
+        // Load sp.js
+        ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
+        p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
+        };n=l.createElement(o);g=l.getElementsByTagName(o)[0];
+        n.async=1;n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","../../dist/snowplow.js","new_name_here"));
 
         window.new_name_here('newTracker', 'cf', 'd3rkrsqld9gmqf.cloudfront.net', {
           encodeBase64: false,

examples/web/async-small.html

@@ -20,19 +20,11 @@
     <!-- Snowplow starts plowing -->
     <script type="text/javascript">
 
-        ;(function(p,l,o,w,i,n,g) {
-          p['GlobalSnowplowNamespace'] = p['GlobalSnowplowNamespace']||[];
-          p['GlobalSnowplowNamespace'].push(i);
-          p[i] = p[i] || function() {
-            (p[i].q = p[i].q||[]).push(arguments);
-          };
-          p[i].q = p[i].q || [];
-          n = l.createElement(o);
-          g = l.getElementsByTagName(o)[0];
-          n.async = 1;
-          n.src = w;
-          g.parentNode.insertBefore(n,g);
-        }(window, document, 'script', '../../dist/snowplow.js', 'snowplow'));
+        // Load sp.js
+        ;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
+        p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
+        };n=l.createElement(o);g=l.getElementsByTagName(o)[0];
+        n.async=1;n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","../../dist/snowplow.js","snowplow"));
 
         window.snowplow('newTracker', 'cf', 'd3rkrsqld9gmqf.cloudfront.net', { // Initialise a tracker
           encodeBase64: false, // Default is true

tags/tag.js

@@ -0,0 +1,78 @@
+/*
+ * JavaScript tracker for Snowplow: tag.js
+ * 
+ * Significant portions copyright 2010 Anthon Pang. Remainder copyright 
+ * 2012-2014 Snowplow Analytics Ltd. All rights reserved. 
+ * 
+ * Redistribution and use in source and binary forms, with or without 
+ * modification, are permitted provided that the following conditions are 
+ * met: 
+ *
+ * * Redistributions of source code must retain the above copyright 
+ *   notice, this list of conditions and the following disclaimer. 
+ *
+ * * Redistributions in binary form must reproduce the above copyright 
+ *   notice, this list of conditions and the following disclaimer in the 
+ *   documentation and/or other materials provided with the distribution. 
+ *
+ * * Neither the name of Anthon Pang nor Snowplow Analytics Ltd nor the
+ *   names of their contributors may be used to endorse or promote products
+ *   derived from this software without specific prior written permission. 
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * Use this function to load Snowplow
+ *
+ * @param p The window
+ * @param l The document
+ * @param o "script", the tag name of script elements
+ * @param w string The source of the Snowplow script. Make sure you get the latest version.
+ * @param i string The Snowplow namespace. The Snowplow user should set this.
+ * @param n The new script (to be created inside the function)
+ * @param g The first script on the page (to be found inside the function)
+ */
+;(function(p,l,o,w,i,n,g) {
+	"p:nomunge, l:nomunge, o:nomunge, w:nomunge, i:nomunge, n:nomunge, g:nomunge";
+
+	// Stop if the Snowplow namespace i already exists
+	if (!p[i]) { 
+	
+		// Initialise the 'GlobalSnowplowNamespace' array
+		p['GlobalSnowplowNamespace'] = p['GlobalSnowplowNamespace'] || [];
+	
+		// Add the new Snowplow namespace to the global array so sp.js can find it
+		p['GlobalSnowplowNamespace'].push(i);
+	
+		// Create the asynchronous queue
+		p[i] = function() {
+			(p[i].q = p[i].q || []).push(arguments);
+		};
+	
+		// Create a new script element
+		n = l.createElement(o);
+	
+		// Get the first script on the page
+		g = l.getElementsByTagName(o)[0];
+	
+		// The new script should load asynchronously
+		n.async = 1;
+	
+		// Load Snowplow
+		n.src = w;
+	
+		// Insert the Snowplow script before every other script so it executes as soon as possible
+		g.parentNode.insertBefore(n,g);
+	}
+} (window, document, 'script', '../../dist/snowplow.js', 'new_name_here'));