markcatley-google_analytics 1.0.20080710 → 1.0.20080714

data/README

@@ -19,9 +19,39 @@ If you want to disable the code insertion for particular pages, add the followin
 If you are running rails 2.1 or above add install this by adding:
     
     config.gem 'markcatley-google_analytics', :lib => 'rubaidh/google_analytics', :source => 'http://gems.github.com'
-
+    
 and run:
 
     rake gems:install
 
-Simple. :-)
+Simple. :-)
+
+
+NOTE
+
+This version of the plugin uses the new Google Analytics code (ga.js) by
+default.  To use the legacy tracking code add the following line to your
+`config/environment.rb`:
+
+    Rubaidh::GoogleAnalytics.legacy_mode = true
+
+TRACKING OUTBOUND LINKS
+
+Google Analytics only tracks intra-site links by default. To create an outbound link that is tracked use
+the link_to_tracked helper:
+
+link_to_tracked(name, track_path = "/", options = {}, html_options = {})
+
+You can use the track_path parameter to group your outbound links into logical folders inside of
+Google Analytics.
+
+The other forms of link_to are also supported:
+
+link_to_tracked_if(condition, name, track_path = "/", options = {}, html_options = {}, &block)
+link_to_tracked_unless(condition, name, track_path = "/", options = {}, html_options = {}, &block)
+link_to_tracked_unless_current(name, track_path = "/", options = {}, html_options = {}, &block)
+
+Tracked links respect the legacy_mode flag.
+
+Note: Link-tracking works by inserting onclick() code in the HTML. Because of this, it will overwrite
+any onclick that you insert in the html_options hash.

data/lib/rubaidh/google_analytics.rb

@@ -1,18 +1,19 @@
 module Rubaidh # :nodoc:
   module GoogleAnalyticsMixin
-    def google_analytics_code(request = nil)
-      return unless GoogleAnalytics.enabled?
-      GoogleAnalytics.google_analytics_code(request)
+    def google_analytics_code
+      GoogleAnalytics.google_analytics_code(request.ssl?) if GoogleAnalytics.enabled?(request.format)
     end
     
     # An after_filter to automatically add the analytics code.
+    # Add the code at the top of the page to support calls to _trackPageView 
+    #   (see http://www.google.com/support/googleanalytics/bin/answer.py?answer=55527&topic=11006)
     def add_google_analytics_code
-      code = google_analytics_code(request)
-      return if code.blank?
-      response.body.gsub! '</body>', code + '</body>' if response.body.respond_to?(:gsub!)
+      response.body.sub! '</body>', "#{google_analytics_code}</body>" if response.body.respond_to?(:sub!)
     end
   end
 
+  class GoogleAnalyticsConfigurationError < StandardError; end
+
   class GoogleAnalytics
     # Specify the Google Analytics ID for this web site.  This can be found
     # as the value of +_uacct+ in the Javascript excerpt
@@ -25,14 +26,18 @@ module Rubaidh # :nodoc:
     # information.
     @@domain_name = nil
     cattr_accessor :domain_name
+
+    # Specify whether the legacy Google Analytics code should be used.
+    @@legacy_mode = false
+    cattr_accessor :legacy_mode
     
     # I can't see why you'd want to do this, but you can always change the
-    # analytics URL.
+    # analytics URL.  This is only applicable in legacy mode.
     @@analytics_url = 'http://www.google-analytics.com/urchin.js'
     cattr_accessor :analytics_url
 
     # I can't see why you'd want to do this, but you can always change the
-    # analytics URL (ssl version).
+    # analytics URL (ssl version).  This is only applicable in legacy mode.
     @@analytics_ssl_url = 'https://ssl.google-analytics.com/urchin.js'
     cattr_accessor :analytics_ssl_url
 
@@ -40,21 +45,45 @@ module Rubaidh # :nodoc:
     # to 'production' only.
     @@environments = ['production']
     cattr_accessor :environments
+    
+    # The formats for which to add.  Defaults
+    # to :html only.
+    @@formats = [:html]
+    cattr_accessor :formats
 
     # Return true if the Google Analytics system is enabled and configured
-    # correctly.
-    def self.enabled?
-      (environments.include?(RAILS_ENV) and
-        not tracker_id.blank? and
-        not analytics_url.blank?)
+    # correctly for the specified format
+    def self.enabled?(format)
+      raise Rubaidh::GoogleAnalyticsConfigurationError if tracker_id.blank? || analytics_url.blank?
+      environments.include?(RAILS_ENV) && formats.include?(format.to_sym)
     end
     
-    def self.google_analytics_code(request = nil)
+    def self.google_analytics_code(ssl = false)
+      return legacy_google_analytics_code(ssl) if legacy_mode
+
+      extra_code = domain_name.blank? ? nil : "pageTracker._setDomainName(\"#{domain_name}\");"
+
+      code = <<-HTML
+      <script type="text/javascript">
+      var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+      document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+      </script>
+      <script type="text/javascript">
+      <!--//--><![CDATA[//><!--
+      var pageTracker = _gat._getTracker('#{tracker_id}');
+      #{extra_code}
+      pageTracker._initData();
+      pageTracker._trackPageview();
+      //--><!]]>
+      </script>
+      HTML
+    end
+
+    # Run the legacy version of the Google Analytics code.
+    def self.legacy_google_analytics_code(ssl = false)
       extra_code = domain_name.blank? ? nil : "_udn = \"#{domain_name}\";"
-      url = (not request.blank? and request.ssl?) ? analytics_ssl_url : analytics_url
+      url = ssl ? analytics_ssl_url : analytics_url
 
-      # OK, I'm not very bright -- I tried to turn this into a partial and
-      # failed miserably!  So it'll have to live here for now.
       code = <<-HTML
       <script src="#{url}" type="text/javascript">
       </script>
@@ -64,7 +93,6 @@ module Rubaidh # :nodoc:
       urchinTracker();
       </script>
       HTML
-      code
     end
   end
-end
+end

data/lib/rubaidh/view_helpers.rb

@@ -0,0 +1,36 @@
+module Rubaidh
+  module GoogleAnalyticsViewHelper #:nodoc:
+    def link_to_tracked(name, track_path = "/", options = {}, html_options = {})
+      
+      html_options.merge!({:onclick => tracking_call(track_path)})
+      link_to name, options, html_options
+    end
+    
+    def link_to_tracked_if(condition, name, track_path = "/", options = {}, html_options = {}, &block)
+      html_options.merge!({:onclick => tracking_call(track_path)})
+      link_to_unless !condition, name, options, html_options, &block
+    end
+    
+    def link_to_tracked_unless(condition, name, track_path = "/", options = {}, html_options = {}, &block)
+      html_options.merge!({:onclick => tracking_call(track_path)})
+      link_to_unless condition, name, options, html_options, &block
+    end
+    
+    def link_to_tracked_unless_current(name, track_path = "/", options = {}, html_options = {}, &block)
+      html_options.merge!({:onclick =>tracking_call(track_path)})
+      link_to_unless current_page?(options), name, options, html_options, &block
+    end
+    
+private
+
+    def tracking_call(track_path)
+      if GoogleAnalytics.legacy_mode
+        "javascript:urchinTracker('#{track_path}');"
+      else
+        "javascript:pageTracker._trackPageview('#{track_path}');"
+      end
+    end
+    
+  end
+end
+

data/rails/init.rb

@@ -1,3 +1,5 @@
 require 'rubaidh/google_analytics'
+require 'rubaidh/view_helpers'
 ActionController::Base.send :include, Rubaidh::GoogleAnalyticsMixin
-ActionController::Base.send :after_filter, :add_google_analytics_code
+ActionController::Base.send :after_filter, :add_google_analytics_code
+ActionView::Base.send :include, Rubaidh::GoogleAnalyticsViewHelper

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+#config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+db_adapter = ENV['DB']

data/test/view_helpers_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+include Rubaidh::GoogleAnalyticsViewHelper
+include ActionView::Helpers::UrlHelper
+include ActionView::Helpers::TagHelper
+
+class ViewHelpersTest < Test::Unit::TestCase
+  def test_link_to_tracked_should_return_a_tracked_link
+    assert_equal "<a href=\"http://www.example.com\" onclick=\"javascript:pageTracker._trackPageview('/sites/linked');\">Link</a>", link_to_tracked('Link', '/sites/linked', "http://www.example.com" )
+  end
+  
+  def test_link_to_tracked_with_legacy_should_return_a_tracked_link
+    Rubaidh::GoogleAnalytics.legacy_mode = true
+    assert_equal "<a href=\"http://www.example.com\" onclick=\"javascript:urchinTracker('/sites/linked');\">Link</a>", link_to_tracked('Link', '/sites/linked', "http://www.example.com" )
+  end
+  
+  def test_link_to_tracked_if_with_true_should_return_a_tracked_link
+    assert_equal "<a href=\"http://www.example.com\" onclick=\"javascript:pageTracker._trackPageview('/sites/linked');\">Link</a>", link_to_tracked_if(true, 'Link', '/sites/linked', "http://www.example.com" )
+  end
+  
+  def test_link_to_tracked_if_with_false_should_return_unlinked_text
+    assert_equal "Link", link_to_tracked_if(false, 'Link', '/sites/linked', "http://www.example.com" )
+  end
+  
+  def test_link_to_tracked_unless_with_false_should_return_a_tracked_link
+    assert_equal "<a href=\"http://www.example.com\" onclick=\"javascript:pageTracker._trackPageview('/sites/linked');\">Link</a>", link_to_tracked_unless(false, 'Link', '/sites/linked', "http://www.example.com" )
+  end
+  
+  def test_link_to_tracked_unless_with_true_should_return_unlinked_text
+    assert_equal "Link", link_to_tracked_unless(true, 'Link', '/sites/linked', "http://www.example.com" )
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: markcatley-google_analytics
 version: !ruby/object:Gem::Version 
-  version: 1.0.20080710
+  version: 1.0.20080714
 platform: ruby
 authors: 
 - Graeme Mathieson
@@ -34,7 +34,10 @@ files:
 - Rakefile
 - rails/init.rb
 - test/google_analytics_test.rb
+- test/test_helper.rb
+- test/view_helpers_test.rb
 - lib/rubaidh/google_analytics.rb
+- lib/rubaidh/view_helpers.rb
 has_rdoc: false
 homepage: http://github.com/rubaidh/google_analytics/tree/master
 post_install_message: