Merge pull request #6 from jpoday/add-tracker-object-methods

added tracker object methods

Author: andrew

Readme.mdown

@@ -48,6 +48,30 @@ haml example:
 = tracking_code(:account => 'UA-12345-6')
 ```
 
+### With Tracking Methods
+
+See [Google Analytics Tracking Methods](https://developers.google.com/analytics/devguides/collection/gajs/methods/) for available options.
+
+```
+tracker_methods = {
+  :setDomainName => "example.com", # String argument
+  :setAllowLinker => true, # Boolean argument
+  :clearOrganic => "" # No argument
+}
+```
+
+erb example:
+
+```erb
+<%= tracking_code(:account => 'UA-12345-6', :tracking_methods => tracking_methods) %>
+```
+
+haml example:
+
+```haml
+= tracking_code(:account => 'UA-12345-6', :tracking_methods => tracking_methods)
+```
+
 ## Development
 
 Source hosted at [GitHub](http://github.com/andrew/split-analytics).

lib/split/analytics.rb

@@ -5,15 +5,15 @@ module Analytics
     def tracking_code(options={})
       # needs more options: http://code.google.com/apis/analytics/docs/gaJS/gaJSApi.html
       account = options.delete(:account)
-
+      tracker_methods = options.delete(:tracker_methods)
+      
       code = <<-EOF
         <script type="text/javascript">
           var _gaq = _gaq || [];
           _gaq.push(['_setAccount', '#{account}']);
+          #{insert_tracker_methods(tracker_methods)}
           #{custom_variables}
           _gaq.push(['_trackPageview']);
-          _gaq.push(['_trackPageLoadTime']);
-
           (function() {
             var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
             ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
@@ -33,6 +33,32 @@ def custom_variables
       end
       arr.reverse[0..4].reverse.join("\n")
     end
+    
+    private
+    
+      def insert_tracker_methods(tracker_methods)
+        return nil if tracker_methods.nil?
+        arr = []
+        tracker_methods.each do |k,v|
+          if v.class == String && v.empty?
+            # No argument tracker method
+            arr << "_gaq.push(['" + "_" + "#{k}']);"
+          else
+            case v
+            when String
+              # String argument tracker method
+              arr << "_gaq.push(['" + "_" + "#{k}', '#{v}']);"
+            when TrueClass
+              # Boolean argument tracker method
+              arr << "_gaq.push(['" + "_" + "#{k}', #{v}]);"
+            when FalseClass
+              # Boolean argument tracker method
+              arr << "_gaq.push(['" + "_" + "#{k}', #{v}]);"
+            end
+          end
+        end
+        arr.join("\n")
+      end
   end
 end
 

spec/analytics_spec.rb

@@ -4,7 +4,17 @@
   include Split::Helper
   it "should generate valid analytics javascript" do
     tracking_code = tracking_code(:account => 'UA-12345-6')
-    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          \n          _gaq.push(['_trackPageview']);\n          _gaq.push(['_trackPageLoadTime']);\n\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          \n          \n          _gaq.push(['_trackPageview']);\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+  end
+  
+  it "should generate valid analytics javascript with arbitrary tracker object methods" do
+    tracker_methods = {
+      :setDomainName => "example.com", # String argument
+      :setAllowLinker => true, # Boolean argument
+      :clearOrganic => "" # No argument
+    }    
+    tracking_code = tracking_code(:account => 'UA-12345-6', :tracker_methods => tracker_methods)
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          _gaq.push(['_setDomainName', 'example.com']);\n_gaq.push(['_setAllowLinker', true]);\n_gaq.push(['_clearOrganic']);\n          \n          _gaq.push(['_trackPageview']);\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
   end
 
   it "should add custom variables for every test the user is involved in" do
@@ -14,6 +24,6 @@
     session[:split].should eql({'link_colour' => first_alt,'link_text' => second_alt})
 
     tracking_code = tracking_code(:account => 'UA-12345-6')
-    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          _gaq.push(['_setCustomVar', 1, 'link_colour', '#{first_alt}', 1]);\n_gaq.push(['_setCustomVar', 2, 'link_text', '#{second_alt}', 1]);\n          _gaq.push(['_trackPageview']);\n          _gaq.push(['_trackPageLoadTime']);\n\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
+    tracking_code.should eql("        <script type=\"text/javascript\">\n          var _gaq = _gaq || [];\n          _gaq.push(['_setAccount', 'UA-12345-6']);\n          _gaq.push(['_setCustomVar', 1, 'link_colour', '#{first_alt}', 1]);\n_gaq.push(['_setCustomVar', 2, 'link_text', '#{second_alt}', 1]);\n\n          (function() {\n            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n          })();\n        </script>\n")
   end
 end