From 9d701f5d34b3aa1c666017874536b6feeff69838 Mon Sep 17 00:00:00 2001
From: Joost Cassee <joost@cassee.net>
Date: Thu, 6 Oct 2011 18:29:52 +0200
Subject: [PATCH] Cosmetic changes to site speed tracking

---
 analytical/templatetags/google_analytics.py   | 14 +++++---------
 analytical/tests/test_tag_google_analytics.py |  2 +-
 docs/services/google_analytics.rst            | 13 +++++++++++++
 3 files changed, 19 insertions(+), 10 deletions(-)

diff --git a/analytical/templatetags/google_analytics.py b/analytical/templatetags/google_analytics.py
index 4e4f530..375a4e8 100644
--- a/analytical/templatetags/google_analytics.py
+++ b/analytical/templatetags/google_analytics.py
@@ -28,8 +28,6 @@ SCOPE_VISITOR = 1
 SCOPE_SESSION = 2
 SCOPE_PAGE = 3
 
-PAGE_LOAD_TIME = False
-
 PROPERTY_ID_RE = re.compile(r'^UA-\d+-\d+$')
 SETUP_CODE = """
     <script type="text/javascript">
@@ -51,7 +49,7 @@ NO_ALLOW_HASH_CODE = "_gaq.push(['_setAllowHash', false]);"
 ALLOW_LINKER_CODE = "_gaq.push(['_setAllowLinker', true]);"
 CUSTOM_VAR_CODE = "_gaq.push(['_setCustomVar', %(index)s, '%(name)s', " \
         "'%(value)s', %(scope)s]);"
-PAGE_LOAD_TIME_CODE = "_gaq.push(['_trackPageLoadTime']);"
+SITE_SPEED_CODE = "_gaq.push(['_trackPageLoadTime']);"
 
 
 register = Library()
@@ -95,8 +93,8 @@ class GoogleAnalyticsNode(Node):
         else:
             domain = get_domain(context, 'google_analytics')
             if domain is None:
-                raise AnalyticalException("tracking multiple domains with Google"
-                        " Analytics requires a domain name")
+                raise AnalyticalException("tracking multiple domains with"
+                        " Google Analytics requires a domain name")
             commands.append(DOMAIN_CODE % domain)
             commands.append(NO_ALLOW_HASH_CODE)
             if tracking_type == TRACK_MULTIPLE_DOMAINS:
@@ -120,10 +118,8 @@ class GoogleAnalyticsNode(Node):
 
     def _get_other_commands(self, context):
         commands = []
-        page_load_time = getattr(settings, 'GOOGLE_ANALYTICS_PAGE_LOAD_TIME', 
-                                 PAGE_LOAD_TIME)
-        if page_load_time:
-            commands.append(PAGE_LOAD_TIME_CODE)
+        if getattr(settings, 'GOOGLE_ANALYTICS_SITE_SPEED', False):
+            commands.append(SITE_SPEED_CODE)
         return commands
 
 def contribute_to_analytical(add_node):
diff --git a/analytical/tests/test_tag_google_analytics.py b/analytical/tests/test_tag_google_analytics.py
index cadf6dd..c833bf3 100644
--- a/analytical/tests/test_tag_google_analytics.py
+++ b/analytical/tests/test_tag_google_analytics.py
@@ -71,7 +71,7 @@ class GoogleAnalyticsTagTestCase(TagTestCase):
         self.assertTrue("_gaq.push(['_setCustomVar', 5, 'test5', 'qux', 3]);"
                 in r, r)
 
-    @override_settings(GOOGLE_ANALYTICS_PAGE_LOAD_TIME=True)
+    @override_settings(GOOGLE_ANALYTICS_SITE_SPEED=True)
     def test_track_page_load_time(self):
         r = GoogleAnalyticsNode().render(Context())
         self.assertTrue("_gaq.push(['_trackPageLoadTime']);" in r, r)
diff --git a/docs/services/google_analytics.rst b/docs/services/google_analytics.rst
index 5b9b940..cfebdd0 100644
--- a/docs/services/google_analytics.rst
+++ b/docs/services/google_analytics.rst
@@ -99,6 +99,19 @@ or set it in the project :file:`settings.py` file using
 :const:`GOOGLE_ANALYTICS_DOMAIN` (fallback: :const:`ANALYTICAL_DOMAIN`).
 
 
+Tracking site speed
+-------------------
+
+You can view page load times in the `Site Speed report`_ by setting the
+:const:`GOOGLE_ANALYTICS_SITE_SPEED` configuration setting::
+
+    GOOGLE_ANALYTICS_SITE_SPEED = True
+
+By default, page load times are not tracked.
+
+.. _`Site Speed report`: http://www.google.com/support/analyticshelp/bin/answer.py?answer=1205784&topic=1282106
+
+
 .. _google-analytics-internal-ips:
 
 Internal IP addresses