rails_apps_pages 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 411a616d74ea7b99e02125bb75a26957a8416546
-  data.tar.gz: 9f138530b4f0e14f3245bd86af8c119788325d9c
+  metadata.gz: ac955e637bfab4fc99212eecbc77ee7f023259fe
+  data.tar.gz: 7c9c85e7ad13f9e704fecb946017ddeae7c584ec
 SHA512:
-  metadata.gz: 52cf84181e1006582ca95ba56e95a2a6166beec4d7954499cfb5c41c42e656b5e7a81cfaae662ceb5f85edfa77445de39dc48dea587e1f13e3b334944a787b61
-  data.tar.gz: 591a92b991e7a6bef8779b0121fb61764e0893000a28c44bc86f63983e25bd38a967dc217fa0ea2ed0d2d619430e8b6f95bc5298ce06e8d2f1db304b39f9b00b
+  metadata.gz: 1bc31829fc1aa05646134672e903ff2cb8d0a35927819fb9a22661e8d426b5590f6ef1b211491f4d3c435f1ea030b8ed8111e8c09f2df440ce77fdb6cdc8a8d6
+  data.tar.gz: 3a77c433b7720495cb919dbebfd465502821ed193f11ad730d0331bb721903dcd5fb7d5d126a98786069f70a859636ff2a83b81cc3a71f2dc9e61e56d7a1b67c

data/CHANGELOG.textile

@@ -1,5 +1,9 @@
 h1. CHANGELOG
 
+h3. 0.5.11 July 13, 2014
+
+* generate JavaScript for analytics
+
 h3. 0.5.10 July 2, 2014
 
 * don't generate a home page if it already exists

data/README.textile

@@ -131,6 +131,20 @@ Remove commented lines and multiple blank lines from the file *config/routes.rb*
 $ rails generate clean:routes
 </pre>
 
+h2. Generate Analytics Files
+
+Add a file containing JavaScript code to set up page-view tracking with "Google Analytics":http://www.google.com/analytics/:
+
+<pre>
+$ rails generate analytics:google
+</pre>
+
+Add a file containing JavaScript code to set up page-view tracking with "Segment.io":https://segment.io/:
+
+<pre>
+$ rails generate analytics:segmentio
+</pre>
+
 h2. Issues
 
 Any issues? Please create an "issue":http://github.com/RailsApps/rails_apps_pages/issues on GitHub. Reporting issues (and patching!) helps everyone.

data/lib/generators/analytics/google_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module Analytics
+  module Generators
+    class GoogleGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "add Google Analytics to a Rails application"
+
+      def add_google_analytics
+        copy_file 'google_analytics.js.coffee', 'app/assets/javascripts/google_analytics.js.coffee'
+      end
+
+    end
+  end
+end

data/lib/generators/analytics/segmentio_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module Analytics
+  module Generators
+    class SegmentioGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "add Segment.io tracking to a Rails application"
+
+      def add_segmentio
+        copy_file 'segmentio.js', 'app/assets/javascripts/segmentio.js'
+      end
+
+    end
+  end
+end

data/lib/generators/analytics/templates/google_analytics.js.coffee

@@ -0,0 +1,44 @@
+# thanks to Jonathon Wolfe at http://reed.github.io/turbolinks-compatibility/google_analytics.html
+
+class @GoogleAnalytics
+
+  @load: ->
+    # Google Analytics depends on a global _gaq array. window is the global scope.
+    window._gaq = []
+    window._gaq.push ["_setAccount", GoogleAnalytics.analyticsId()]
+
+    # Create a script element and insert it in the DOM
+    ga = document.createElement("script")
+    ga.type = "text/javascript"
+    ga.async = true
+    ga.src = ((if "https:" is document.location.protocol then "https://ssl" else "http://www")) + ".google-analytics.com/ga.js"
+    firstScript = document.getElementsByTagName("script")[0]
+    firstScript.parentNode.insertBefore ga, firstScript
+
+    # If Turbolinks is supported, set up a callback to track pageviews on page:change.
+    # If it isn't supported, just track the pageview now.
+    if typeof Turbolinks isnt 'undefined' and Turbolinks.supported
+      document.addEventListener "page:change", (->
+        GoogleAnalytics.trackPageview()
+      ), true
+    else
+      GoogleAnalytics.trackPageview()
+
+  @trackPageview: (url) ->
+    unless GoogleAnalytics.isLocalRequest()
+      if url
+        window._gaq.push ["_trackPageview", url]
+      else
+        window._gaq.push ["_trackPageview"]
+      window._gaq.push ["_trackPageLoadTime"]
+
+  @isLocalRequest: ->
+    GoogleAnalytics.documentDomainIncludes "local"
+
+  @documentDomainIncludes: (str) ->
+    document.domain.indexOf(str) isnt -1
+
+  @analyticsId: ->
+    'UA-XXXXXXX-XX'
+
+GoogleAnalytics.load()

data/lib/generators/analytics/templates/segmentio.js

@@ -0,0 +1,58 @@
+// Create a queue, but don't obliterate an existing one!
+window.analytics = window.analytics || [];
+
+// A list of the methods in Analytics.js to stub.
+window.analytics.methods = ['identify', 'group', 'track',
+  'page', 'pageview', 'alias', 'ready', 'on', 'once', 'off',
+  'trackLink', 'trackForm', 'trackClick', 'trackSubmit'];
+
+// Define a factory to create stubs. These are placeholders
+// for methods in Analytics.js so that you never have to wait
+// for it to load to actually record data. The `method` is
+// stored as the first argument, so we can replay the data.
+window.analytics.factory = function(method){
+  return function(){
+    var args = Array.prototype.slice.call(arguments);
+    args.unshift(method);
+    window.analytics.push(args);
+    return window.analytics;
+  };
+};
+
+// For each of our methods, generate a queueing stub.
+for (var i = 0; i < window.analytics.methods.length; i++) {
+  var key = window.analytics.methods[i];
+  window.analytics[key] = window.analytics.factory(key);
+}
+
+// Define a method to load Analytics.js from our CDN,
+// and that will be sure to only ever load it once.
+window.analytics.load = function(key){
+  if (document.getElementById('analytics-js')) return;
+
+  // Create an async script element based on your key.
+  var script = document.createElement('script');
+  script.type = 'text/javascript';
+  script.id = 'analytics-js';
+  script.async = true;
+  script.src = ('https:' === document.location.protocol
+    ? 'https://' : 'http://')
+    + 'cdn.segment.io/analytics.js/v1/'
+    + key + '/analytics.min.js';
+
+  // Insert our script next to the first script element.
+  var first = document.getElementsByTagName('script')[0];
+  first.parentNode.insertBefore(script, first);
+};
+
+// Add a version to keep track of what's in the wild.
+window.analytics.SNIPPET_VERSION = '2.0.9';
+
+// Load Analytics.js with your key, which will automatically
+// load the tools you've enabled for your account. Boosh!
+window.analytics.load('SEGMENTIO_API_KEY');
+
+// accommodate Turbolinks and make the first page call to load the integrations.
+$(document).on('ready page:change', function() {
+  window.analytics.page();
+})

data/lib/rails_apps_pages/version.rb

@@ -1,3 +1,3 @@
 module RailsAppsPages
-  VERSION = "0.5.10"
+  VERSION = "0.5.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_apps_pages
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Daniel Kehoe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,6 +54,10 @@ files:
 - LICENSE.txt
 - README.textile
 - Rakefile
+- lib/generators/analytics/google_generator.rb
+- lib/generators/analytics/segmentio_generator.rb
+- lib/generators/analytics/templates/google_analytics.js.coffee
+- lib/generators/analytics/templates/segmentio.js
 - lib/generators/clean/gemfile_generator.rb
 - lib/generators/clean/routes_generator.rb
 - lib/generators/pages/about/about_generator.rb