markcatley-google_analytics 1.0.20080717 → 1.0.20080720

data/README

@@ -51,6 +51,13 @@ link_to_tracked_if(condition, name, track_path = "/", options = {}, html_options
 link_to_tracked_unless(condition, name, track_path = "/", options = {}, html_options = {}, &block)
 link_to_tracked_unless_current(name, track_path = "/", options = {}, html_options = {}, &block)
 
+To track outbound links, you should set
+
+	Rubaidh::GoogleAnalytics.defer_load = false
+	
+This will move the tracking javascript to the top of your page.
+(see http://www.google.com/support/googleanalytics/bin/answer.py?answer=55527&topic=11006)
+
 Tracked links respect the legacy_mode flag.
 
 Note: Link-tracking works by inserting onclick() code in the HTML. Because of this, it will overwrite

data/lib/rubaidh/google_analytics.rb

@@ -60,7 +60,7 @@ module Rubaidh # :nodoc:
     # Set this to true if you want to load the Analytics javascript at the bottom of
     # each page rather than at the top. This may result in faster page render times, 
     # but may break link_to_tracked functionality.
-    @@defer_load = false
+    @@defer_load = true
     cattr_accessor :defer_load
     
     # Set this to true to use a local copy of the ga.js (or urchin.js) file.

data/lib/rubaidh/view_helpers.rb

@@ -1,22 +1,25 @@
 module Rubaidh
   module GoogleAnalyticsViewHelper #:nodoc:
     def link_to_tracked(name, track_path = "/", options = {}, html_options = {})
-      
+      raise AnalyticsError.new("You must set Rubaidh::GoogleAnalytics.defer_load = false to use outbound link tracking") if GoogleAnalytics.defer_load == true
       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)
+      raise AnalyticsError.new("You must set Rubaidh::GoogleAnalytics.defer_load = false to use outbound link tracking") if GoogleAnalytics.defer_load == true
       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)
+      raise AnalyticsError.new("You must set Rubaidh::GoogleAnalytics.defer_load = false to use outbound link tracking") if GoogleAnalytics.defer_load == true
       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)
+      raise AnalyticsError.new("You must set Rubaidh::GoogleAnalytics.defer_load = false to use outbound link tracking") if GoogleAnalytics.defer_load == true
       html_options.merge!({:onclick =>tracking_call(track_path)})
       link_to_unless current_page?(options), name, options, html_options, &block
     end
@@ -32,5 +35,13 @@ private
     end
     
   end
+  
+  class AnalyticsError < StandardError
+    attr_reader :message
+    
+    def initialize(message)
+      @message = message
+    end
+  end
 end
 

data/test/view_helpers_test.rb

@@ -4,6 +4,11 @@ include ActionView::Helpers::UrlHelper
 include ActionView::Helpers::TagHelper
 
 class ViewHelpersTest < Test::Unit::TestCase
+  
+  def setup
+    Rubaidh::GoogleAnalytics.defer_load = false
+  end
+  
   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
@@ -13,6 +18,11 @@ class ViewHelpersTest < Test::Unit::TestCase
     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_should_error_if_defer_load
+    Rubaidh::GoogleAnalytics.defer_load = true
+    assert_raise(Rubaidh::AnalyticsError) { 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
@@ -21,6 +31,11 @@ class ViewHelpersTest < Test::Unit::TestCase
     assert_equal "Link", link_to_tracked_if(false, 'Link', '/sites/linked', "http://www.example.com" )
   end
   
+  def test_link_to_tracked_if_should_error_if_defer_load
+    Rubaidh::GoogleAnalytics.defer_load = true
+    assert_raise(Rubaidh::AnalyticsError) { 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
@@ -29,4 +44,13 @@ class ViewHelpersTest < Test::Unit::TestCase
     assert_equal "Link", link_to_tracked_unless(true, 'Link', '/sites/linked', "http://www.example.com" )
   end
   
+  def test_link_to_tracked_unless_should_error_if_defer_load
+    Rubaidh::GoogleAnalytics.defer_load = true
+    assert_raise(Rubaidh::AnalyticsError) { link_to_tracked_unless(false, 'Link', '/sites/linked', "http://www.example.com" ) }
+  end
+
+  def test_link_to_tracked_unless_current
+    #postponed
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: markcatley-google_analytics
 version: !ruby/object:Gem::Version 
-  version: 1.0.20080717
+  version: 1.0.20080720
 platform: ruby
 authors: 
 - Graeme Mathieson