mp-gwo 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Made by Many
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,127 @@
+NOTE: CURRENTLY THIS WORKS ONLY WITH HAML ... I HAVE TO FIX IT IN ORDER TO GET IT RUNNING WITH ERB
+
+
+This is a Ruby on Rails plugin (gem) which simplifies Server-Side Dynamic Section Variations with 
+[Google Website Optimizer](http://www.google.com/websiteoptimizer) as described in the article
+[Server-Side Dynamic Section Variations on gwotricks.com](http://www.gwotricks.com/2009/05/server-side-dynamic-section-variations.html)
+
+== Features: 
+------------
+
+* very good Ruby on Rails integration
+* very simple to use
+* support for several sections that should have different variants
+* support for named and numbered sections
+* include part of a page in more than one variant
+* support for google analytics tracking
+* kill-switch
+* well tested
+
+
+The 'Usage' may look long - but it's fairly straightforward and shouldn't take 5 mins.
+
+Daniel Bornkessel gwo@moviepilot.com & Alex MacCaw - alex@madebymany.co.uk (original author)
+
+== Usage
+--------
+
+To use GWO, you need two pages:
+* A test page containing the multi variant sections
+* A page that signifies conversion (i.e. account creation page)
+
+[Signup for Google Website Optimizer and](http://www.google.com/websiteoptimizer):
+
+ 1.  Click create another experiment
+ 2.  Click multivariate experiment
+ 3.  Name it and enter the test/conversion urls (if the test will be included on multiple pages (/movies/:id), just choose one of the urls) ... actually the urls you type in don't really matter)
+ 4.  Select 'You will install and validate the JavaScript tags'
+ 5.  Ignore the scripts that are offered, but strip out your account id (uacct) and test id (both to be found in the Tracking Script).
+     They look like as follows:
+         var pageTracker=_gat._getTracker("UI-6882082-1");
+         pageTracker._trackPageview("/1662461989/test");
+     So, in this example the uacct is 'UA-6882082-1' and the test id is 1662461989.
+ 6.  Leave google and prepare your source code
+ 7.  Add the gwo_experiment tag around the code that is supposed to contain the variants (see the gwo_experiment documentation for
+     possible options)
+ 8.  in the gwo_experiment you can specify one or more sections your side can contain. Each section can have several 
+     variants. So if you have for example 2 sections with each having 3 variants you would have 6 different possible
+     combinations on your page.
+ 9.  Create your gwo_sections, as in the example. The first parameter is the name of the section,
+     the second the name of the variant(s) in which the following code should be shown (see example code).
+     You can mix variants by just passing in more than one identifier. The 
+     original variant has the reserved identifier :original (or 0 if you use numbers)
+ 10. The variants can either be identified by numbers (starting at 0 for the original variant) or be named (see below how to 
+     assign the names in the google web interface).
+ 11. Add a gwo_conversion helper tag on your conversion page passing in your uacct and test id.
+ 12. In order to validate the pages in the goole web interface, start rails, surf to the pages (variant and conversion page) you 
+     just created and save each one locally.
+ 13. back in the google web interface, validate your pages by using the 'offline validation' link and upload the two 
+     pages you just saved
+ 14. as a next step, define the sections. If you used named identifiers in you rails source code, put the the identifiers
+     name as the content of the variations in the web interface (i.e. the example below would have two variants (+ the original
+     variant); one variation would have the CONTENT (subject & name of the variants are not important) 'minimalistic' and the other
+     'with_sidebar_and_top_signup_box' (without the quotes)). If you use numbered identifiers, just create new variations and leave the 
+     content empty.
+ 15. finish up and start the experiment
+ 16. lean back and let google collect data for you for the next few days ... go back an be shocked about the little number of
+     conversions you will probably get ;)
+ 
+
+== Example
+----------
+... in haml:
+
+    = gwo_experiment("1662461989", "UA-6882082-1", :signup_box_test, :conditions => (signed_up? && country == "de")) do
+      = gwo_section(:signup_box_test, [:with_sidebar_and_top_signup_box, :minimalistic], :ga_tracking => true, :conditions => (signed_up? && country == "de")) do
+        = render :partial => 'gossib/signup'
+        %span I am only visible in the variants :with_sidebar_and_top_signup_box and :minimalistic
+
+      = gwo_section(:signup_box_test, [:original, :with_sidebar_and_top_signup_box], :conditions => (signed_up? && country == "de")) do
+        = render :partial => 'gossib/bookmark_menu'
+        = render :partial => 'gossip/pics', :locals => {:images       => @article.images}
+        .box#
+          %span Hi hi ... I am not visible in :minimalistic
+    
+      %span I am visible in every variation
+    
+      = gwo_section(:signup_box_test, :original, :conditions => (signed_up? && country == "de")) do
+        %span I am only in the original page
+  
+... or in erb:
+
+    <% gwo_experiment("1662461989", "UA-6882082-1", :signup_box_test, :conditions => (signed_up? && country == "de")) do %>
+      <% render :partial => 'gossip/article.html.haml',  :object => @article %>
+    
+      <% gwo_section(:signup_box_test, [:with_sidebar_and_top_signup_box, :minimalistic], :conditions => (signed_up? && country == "de")) do %> 
+        <%= render :partial => 'gossib/signup' %>
+        <span> I am only visible in the variants :with_sidebar_and_top_signup_box and :minimalistic</span>
+      <% end %>
+
+      <% gwo_section(:signup_box_test, [:original, :with_sidebar_and_top_signup_box], :conditions => (signed_up? && country == "de")) do %>
+        <%= render :partial => 'gossib/bookmark_menu' %>
+        <%= render :partial => 'gossip/pics', :locals => {:images       => @article.images} %>
+        <div class="box">
+          <span> Hi hi ... I am not visible in :minimalistic</span>
+      <% end %>
+    
+      <span> I am visible in every variation</span>
+    
+      <% gwo_section(:signup_box_test, :original, :conditions => (signed_up? && country == "de")) do %>
+        <span> I am only in the original page</span>
+      <% end %>
+    <% end %>
+
+
+== Conversion page:
+------------------
+... haml:
+
+    = gwo_conversion('1909920434', 'UA-23902382-1')
+
+... erb:
+
+    <%= gwo_conversion('1909920434', 'UA-23902382-1') %>
+
+
+
+Copyright (c) 2009 Made by Many, Moviepilot, released under the MIT license

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'bundler'
+
+desc 'Default: run unit tests.'
+task :default => :rspec
+
+# ... we are too stupid to get this running 
+#desc "Run all examples"
+#Spec::Rake::SpecTask.new('rspec') do |t|
+#    t.spec_files = FileList['spec/**/*_spec.rb']
+#end
+
+desc "Run rspec tests"
+task :rspec do
+  system "spec spec"
+end
+
+desc 'Generate documentation for the gwo plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Gwo'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Install latest gem'
+task :install_only do
+  system "gem install $( ls -t -1 *.gem | head -n 1 )"
+end
+
+desc 'Build and install gem' 
+task :install do
+  system "gem build gwo.gemspec"
+  system "gem install $( ls -t -1 *.gem | head -n 1 )"
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mp-gwo"
+  gem.homepage = "http://github.com/moviepilot/gwo"
+  gem.license = "MIT"
+  gem.summary = %Q{Google Website Optimizer Helper}
+  gem.description = %Q{Google Website Optimizer Helper}
+  gem.email = "github@moviepilot.com"
+  gem.authors = ["Alex MacCaw", "Daniel Bornkessel", "Johannes Mentz", "Yan Minagawa", "Benjamin Krause"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/gwo.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "gwo"
+  s.version = "0.1.4"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex MacCaw", "Daniel Bornkessel", "Johannes Mentz", "Yan Minagawa"] 
+  s.date = "2009-09-11"
+  s.email = "daniel@bornkessel.com"
+  s.extra_rdoc_files = %w{ README.markdown }
+  s.files = %w{ lib/gwo.rb MIT-LICENSE README.markdown spec/lib/gwo_spec.rb spec/spec_helper.rb rails/init.rb}
+  s.has_rdoc = true
+  s.rdoc_options = ["--line-numbers", "--inline-source"]
+  s.homepage = "http://github.com/kesselborn/gwo"
+  s.require_paths = %w{ lib }
+  s.rubygems_version = "1.3.1"
+  s.summary = "Plugin to easily make use of Server-Side Dynamic Section Variations with Google Web Optimizer"
+end

data/lib/gwo.rb

@@ -0,0 +1,235 @@
+# Author::    Alex MacCaw - alex AT madebymany DOT co DOT uk (original), Daniel Bornkessel - daniel AT bornkessel DOT com
+# License::   MIT
+# :include:README.markdown
+#
+#
+
+require 'action_view/helpers/capture_helper'
+require 'action_view/helpers/tag_helper'
+module GWO
+  module Helper
+
+    include ::ActionView::Helpers::CaptureHelper
+    include ::ActionView::Helpers::TagHelper
+     
+    # start a gwo_experiment 
+    #
+    # Params: 
+    # * <b>id</b>       the id of the experiment (in the google Tracking Script look for something like <tt>pageTracker._trackPageview("/<ID>/test");</tt> )
+    # * <b>uacct</b>    account number (in the google Tracking Script look for something like <tt>var pageTracker=_gat._getTracker("<UACCT>");</tt> )
+    # * <b>sections</b> name of the section(s) your page will include; pass in one symbol/string or an array of symbols/strings here
+    # * <b>options</b>  hash of possible options:
+    #   * <b>:conditions</b>  if set to false, the experiment won't be executed -- only the source code of the :original (or 0) variants would be shown. No JavaScript code will be produced. It serves as a kill switch for the gwo experiment. If, for example, you only want to execute an experiment for users that are not logged in, you could pass <tt>:conditions => !logged_in?</tt> here.
+    #   * <b>:google_analytics</b> a hash for google analytics tracking: it will call the google analytics script with either the document.location or a virtual url if you provide it. At the end of the url, gwo appends information about which a/b test was executed and which section was the user had in the form of url parameters (s.th. like <tt> http://&lt;url&gt;?ab_test=&lt;id&gt;&section=&lt;section name &gt; </tt>)
+    #     * <b>:account_number</b> the google analytics account id where the tracking should take place
+    #     * <b>:virtual_url</b> if you want to choose a different tracking url then the document.location for tracking
+    #     * <b>:goal_is_bounce_rate</b> if true, every click on a link on the current view is counted as a goal (NOTE: this includes external links as well)
+    def gwo_experiment(id, uacct, sections = [], options = {}, &block)
+      options = {
+        :conditions => (ENV['RAILS_ENV'] == 'test' ? false : true),
+        :goal_is_bounce_rate => false
+      }.update(options)
+
+      src  = gwo_start(id, sections, options)
+      src += capture(&block) if block
+      src += gwo_end(id, uacct, options)
+
+      if options[:goal_is_bounce_rate]
+        src +=<<JS
+<script type="text/javascript"><!--
+    function addEvent( obj, type, fn ) {
+       if (obj.addEventListener) {
+          obj.addEventListener( type, fn, false );
+       } else if (obj.attachEvent) {
+          obj["e"+type+fn] = fn;
+          obj[type+fn] = function() { obj["e"+type+fn]( window.event ); }
+          obj.attachEvent( "on"+type, obj[type+fn] );
+       }
+    }
+
+    
+    addEvent(document, "click", function(event) { 
+      if( event.target.nodeName === "A" ) {
+        #{js_logger("'bounce rate goal reached'")}
+        try {
+          var gwoPageTracker=_gat._getTracker("#{uacct}");
+          gwoPageTracker._trackPageview("/#{id}/goal");
+        }catch(err){}
+      }
+    });
+    #{js_logger("'set goal to bounce rate minimization'")}
+  //-->
+</script>
+JS
+      end
+
+      src
+    end
+
+
+    # to be included on the conversion page. 
+    #
+    # Params: 
+    # * <b>id</b> & <b>uacct</b> see gwo_experiment
+    # * <b>options</b>
+    #   * :conditions as in gwo_experiment
+    def gwo_conversion(id, uacct, options = {})  
+      options = {
+        :conditions => (ENV['RAILS_ENV'] == 'test' ? false : true)
+      }.update(options)
+
+      return js_logger("skipping conversion snippet: a/b variation test switched off", true) if options[:conditions] == false
+
+      %{
+      <script type="text/javascript">
+      #{ js_logger("'conversion for test with id #{id} and uacct #{uacct}'") }
+      if(typeof(_gat)!='object')document.write('<sc'+'ript src="http'+
+      (document.location.protocol=='https:'?'s://ssl':'://www')+
+      '.google-analytics.com/ga.js"></sc'+'ript>')</script>
+      <script type="text/javascript">
+      try {
+      var gwoPageTracker=_gat._getTracker("#{uacct}");
+      gwoPageTracker._trackPageview("/#{id}/goal");
+      }catch(err){}</script>
+      }
+
+    end
+
+
+    # identify a section which is only visible in certain variants
+    #
+    # Params:
+    # * <b>section</b> name of the section
+    # * <b>variation_ids</b> identifiers of the variants in which this content is to be shown. Can be either a name of the variant (== the <b><i>content</i></b> of a variant in the GWO web interface) or a number. The original content has the reserved name <tt>:original</tt> or the number <tt>0</tt> respectivly. If the content should be shown in more than one variant, pass in an array of identifiers. Mixing numbered and named variant ids will result in an exception.
+    # * <b>options</b>
+    #   * :conditions as in gwo_experiment
+    def gwo_section(section = "gwo_section", variation_ids = nil, options = {}, &block)
+      options = {
+        :conditions => (ENV['RAILS_ENV'] == 'test' ? false : true)
+      }.update(options)
+
+      variation_ids = [*variation_ids].compact
+      src = ""
+      if is_default_section?(variation_ids)
+        if options[:conditions] == false
+          src += capture(&block)
+        else
+          conditions = (named_variations?(variation_ids) ? variation_ids.map{|x| "GWO_#{section}_name != \"#{x}\""} : variation_ids.map{|x| "GWO_#{section}_number != #{x}"}).join(" && ")
+
+          src += %{ <script>
+          if ( #{ conditions } ) document.write('<no' + 'script>');
+          </script>
+            #{capture(&block) if block_given?}
+          </noscript>
+          }
+        end
+      elsif options[:conditions] == true
+        if !variation_ids.empty?
+          conditions = (named_variations?(variation_ids) ? variation_ids.map{|x| "GWO_#{section}_name == \"#{x}\""} : variation_ids.map{|x| "GWO_#{section}_number == #{x}"}).join(" || ") 
+             
+          src += %{<script>
+          if ( #{ conditions } ) document.write('</noscript a="');
+          </script><!--">
+            #{capture(&block) if block_given?}
+          <script>document.write('<'+'!'+'-'+'-')</script>-->
+          }
+        end
+      else
+        src =  js_logger("skipping snippet for #{variation_ids.join(", ")} variations: a/b variation test switched off", true) 
+      end
+      src
+    end
+
+    private
+    def js_logger(text, with_js_tag = false)
+      return "if(typeof(console.log) == 'function') console.log(#{text});" if RAILS_ENV != "test" && RAILS_ENV != "production" && !with_js_tag
+      return "<script type='text/javascript'>if(typeof(console.log) == 'function') console.log(\"#{text}\");</script>" if RAILS_ENV != "test" && RAILS_ENV != "production" && with_js_tag
+      return ""
+    end
+
+    def gwo_start(id, sections  = [], options = {})
+
+      return js_logger("skipping start snippet: a/b variation test switched off", true) if options[:conditions] == false
+
+
+      sections = [*sections].compact.empty? ? ["gwo_section"] : [*sections]
+      src = %{
+        <script type='text/javascript'>
+        function utmx_section(){}function utmx(){}
+        (function(){var k='#{id}',d=document,l=d.location,c=d.cookie;function f(n){
+        if(c){var i=c.indexOf(n+'=');if(i>-1){var j=c.indexOf(';',i);return escape(c.substring(i+n.
+        length+1,j<0?c.length:j))}}}var x=f('__utmx'),xx=f('__utmxx'),h=l.hash;
+        d.write('<sc'+'ript src="'+
+        'http'+(l.protocol=='https:'?'s://ssl':'://www')+'.google-analytics.com'
+        +'/siteopt.js?v=1&utmxkey='+k+'&utmx='+(x?x:'')+'&utmxx='+(xx?xx:'')+'&utmxtime='
+        +new Date().valueOf()+(h?'&utmxhash='+escape(h.substr(1)):'')+
+        '" type="text/javascript" charset="utf-8"></sc'+'ript>')})();
+        </script>
+      }
+
+      google_analytics_info = "";
+      section_definitions = "";
+      variable_assignments = "";
+
+      sections.each do |section|
+        section_definitions += "<!-- utmx section name='#{section}' -->\n"
+
+        variable_assignments += %{
+            var GWO_#{section}_name = utmx("variation_content", "#{section}");if( GWO_#{section}_name == undefined) GWO_#{section}_name = 'original';
+            var GWO_#{section}_number = utmx("variation_number", "#{section}");if( GWO_#{section}_number == undefined) GWO_#{section}_number = 0;
+            #{ js_logger("'variant: ' + GWO_#{section}_name") }
+        }
+        google_analytics_info += "google_analytics_info += \"&#{section}=\" + GWO_#{section}_name;" if options[:google_analytics]
+      end
+
+      # GOOGLE TRACKER:
+      if options[:google_analytics]
+        base_url = options[:google_analytics][:virtual_url] ? "\"#{options[:google_analytics][:virtual_url]}\"" : "document.location"
+        variable_assignments += %{
+          window.onload = function(){ 
+            var google_analytics_info = ''; #{google_analytics_info};
+            try{
+              var gwoGaPageTracker=_gat._getTracker("#{options[:google_analytics][:account_id]}");
+              gwoGaPageTracker._trackPageview(#{base_url} + "?ab_test=#{id}" + google_analytics_info);
+            }catch(err){ #{js_logger("\"error executing google analytics request\"")} }
+            #{js_logger("\"tracking \" + #{base_url} + \"?ab_test=#{id}\" + google_analytics_info + \" to account #{options[:google_analytics][:account_id]}\"")}
+          }
+        }
+      end
+
+      variable_assignments = "<script type='text/javascript'>#{variable_assignments}</script>";
+
+      "#{src}#{section_definitions}#{variable_assignments}"
+    end
+    
+    def gwo_end(id, uacct, options)
+      return js_logger("skipping end snippet: a/b variation test switched off", true) if options[:conditions] == false
+
+      %{<script type="text/javascript">
+      if(typeof(_gat)!='object')document.write('<sc'+'ript src="http'+
+      (document.location.protocol=='https:'?'s://ssl':'://www')+
+      '.google-analytics.com/ga.js"></sc'+'ript>')</script>
+      <script type="text/javascript">
+      try {
+      var gwoPageTracker=_gat._getTracker("#{uacct}");
+      gwoPageTracker._trackPageview("/#{id}/test");
+      }catch(err){}</script>
+      }
+
+    end
+
+    def is_default_section?(variation_ids)
+      variation_ids.include?(:original) || variation_ids.include?(0)
+    end
+
+    def named_variations?(variation_ids)
+      raise RuntimeError.new("variation ids can only be either string, symbols or numbers") if [*variation_ids].compact.empty?   # catch empty hashes and nil
+
+      return false if [1, *variation_ids].map(&:class).uniq.length                 == 1  # all variation_ids are FixNums
+      return true  if ["string", :symbol, *variation_ids].map(&:class).uniq.length == 2  # all variation_ids are either string or symbol
+
+      raise RuntimeError.new("variation ids can only be either string, symbols or numbers")
+    end
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+ActionView::Base.send(:include, GWO::Helper)

data/spec/lib/gwo_spec.rb

@@ -0,0 +1,265 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'lib/gwo'
+
+describe GWO do
+  include GWO::Helper
+
+  describe "google analytics stuff" do
+    it "should not create any google analytics stuff by default" do
+      gwo_start("gwo_id", "section_name").should_not =~ /google_analytics_info \+= \"&section_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name").should_not =~ /gwoGaPageTracker\(document.location \+ \"\?ab_test=gwo_id\" \+ google_analytics_info\)/
+    end
+    it "should not create google analytics stuff if option is disabled" do
+      gwo_start("gwo_id", "section_name").should_not =~ /google_analytics_info \+= \"&section_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name").should_not =~ /gwoGaPageTracker\(document.location \+ \"\?ab_test=gwo_id\" \+ google_analytics_info\)/
+    end
+
+    it "should create correct google analytics stuff for default urls" do
+      gwo_start("gwo_id", "section_name", :google_analytics => {:account_id => "123456789"}).should =~ /google_analytics_info \+= \"&section_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name", :google_analytics => {:account_id => "123456789"}).should =~ /gwoGaPageTracker._trackPageview\(document.location \+ \"\?ab_test=gwo_id\" \+ google_analytics_info\)/
+    end
+
+    it "should create correct google analytics stuff for static urls" do
+      gwo_start("gwo_id", "section_name", :google_analytics => {:account_id => "123456789", :virtual_url => "http://example.com"}).should =~ 
+        /google_analytics_info \+= \"&section_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name", :google_analytics => {:account_id => "123456789", :virtual_url => "http://example.com"}).should =~ 
+         /var gwoGaPageTracker=_gat._getTracker\(\"123456789\"\);/
+      gwo_start("gwo_id", "section_name", :google_analytics => {:account_id => "123456789", :virtual_url => "http://example.com"}).should =~ 
+        /gwoGaPageTracker._trackPageview\(\"http:\/\/example\.com\" \+ \"\?ab_test=gwo_id\" \+ google_analytics_info\)/
+    end
+
+    it "should create correct google analytics stuff for several sections" do
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :google_analytics => {:account_id => "123456789"}).should =~ /google_analytics_info \+= \"&section_name1=\" \+ GWO_section_name1_name;/
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :google_analytics => {:account_id => "123456789"}).should =~ /google_analytics_info \+= \"&section_name2=\" \+ GWO_section_name2_name;/
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :google_analytics => {:account_id => "123456789"}).should =~ /google_analytics_info \+= \"&section_name3=\" \+ GWO_section_name3_name;/
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :google_analytics => {:account_id => "123456789"}).should =~ /gwoGaPageTracker._trackPageview\(document.location \+ \"\?ab_test=gwo_id\" \+ google_analytics_info\)/
+    end
+
+  end
+
+  describe "named_variations? method" do
+    it "should return false if one numbered variation is passed in" do
+      named_variations?(1).should == false
+    end
+    it "should return false if variations are numbered" do
+      named_variations?([1,2,3]).should == false
+    end
+
+    it "should return true if one string is passed in" do
+      named_variations?("string").should == true
+    end
+    it "should return true if one symbol is passed in" do
+      named_variations?(:symbol).should == true
+    end
+    it "should return true if symbols and strings are mixed" do
+      named_variations?([:symbol, "string", :symbol2]).should == true
+    end
+    it "should throw an exception if numbers and strings are mixed" do
+      lambda {named_variations?([1, :symbol])}.should           raise_error(RuntimeError)
+      lambda {named_variations?([1, "string"])}.should          raise_error(RuntimeError)
+      lambda {named_variations?([1, "string", :symbol])}.should raise_error(RuntimeError)
+    end
+    it "should throw an exception if one obscure object is passed in" do
+      lambda {named_variations?(Hash.new)}.should         raise_error(RuntimeError)
+      lambda {named_variations?(RuntimeError.new)}.should raise_error(RuntimeError)
+    end
+    it "should throw an exception if an array of obscure object is passed in" do
+      lambda {named_variations?([{}, {}])}.should raise_error(RuntimeError)
+    end
+  end
+
+  describe "gwo_start method" do
+    it "should produce correct output" do
+      gwo_start("gwo_id", "section_name").should =~ /utmx section name='section_name'/
+      gwo_start("gwo_id", "section_name").should =~ /utmx\(\"variation_content\", \"section_name\"\)/
+      gwo_start("gwo_id", "section_name").should =~ /utmx\(\"variation_number\", \"section_name\"\)/
+      gwo_start("gwo_id", "section_name").should =~ /k='gwo_id'/
+    end
+
+    it "should work with just the id parameter set" do
+      gwo_start("gwo_id").should =~ /k='gwo_id'/
+      gwo_start("gwo_id").should =~ /utmx section name='gwo_section'/
+      gwo_start("gwo_id").should =~ /utmx\(\"variation_content\", \"gwo_section\"\)/
+      gwo_start("gwo_id").should =~ /utmx\(\"variation_number\", \"gwo_section\"\)/
+      gwo_start("gwo_id", nil).should =~ /utmx section name='gwo_section'/
+    end
+
+    it "should work with one single section ... section is a symbol" do
+      gwo_start("gwo_id", :section_name).should =~ /utmx section name='section_name'/
+      gwo_start("gwo_id", :section_name).should =~ /utmx\(\"variation_content\", \"section_name\"\)/
+      gwo_start("gwo_id", :section_name).should =~ /utmx\(\"variation_number\", \"section_name\"\)/
+      gwo_start("gwo_id", :section_name).should =~ /k='gwo_id'/
+    end
+
+    it "should work with an array of section" do
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx section name='body'/
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx section name='content'/
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx section name='footer'/
+
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx\(\"variation_content\", \"body\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx\(\"variation_content\", \"content\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx\(\"variation_content\", \"footer\"\)/
+
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx\(\"variation_number\", \"body\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx\(\"variation_number\", \"content\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"]).should =~ /utmx\(\"variation_number\", \"footer\"\)/
+    end
+
+    it "should return nothing when conditions return false" do
+      gwo_start("id", [], {:conditions => false}).should == "" 
+      gwo_start("gwo_id", ["body",:content,"footer"], :conditions => false).should == ""
+
+      gwo_start("gwo_id", ["body",:content,"footer"], {:conditions => false}).should_not =~ /utmx\(\"variation_content\", \"body\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"], {:conditions => false}).should_not =~ /utmx\(\"variation_content\", \"content\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"], {:conditions => false}).should_not =~ /utmx\(\"variation_content\", \"footer\"\)/
+      
+      gwo_start("gwo_id", ["body",:content,"footer"], :conditions => false).should_not =~ /utmx\(\"variation_number\",  \"body\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"], :conditions => false).should_not =~ /utmx\(\"variation_number\",  \"content\"\)/
+      gwo_start("gwo_id", ["body",:content,"footer"], :conditions => false).should_not =~ /utmx\(\"variation_number\",  \"footer\"\)/
+    end
+  end
+
+  describe "gwo_end method" do
+    it "should produce correct output" do
+      gwo_end("gwo_id", "gwo_uacct", :conditions => true).should =~ /getTracker\(\"gwo_uacct\"\)/
+      gwo_end("gwo_id", "gwo_uacct", :conditions => true).should =~ /trackPageview\(\"\/gwo_id\/test\"\)/
+    end
+
+    it "should return nothing if conditions are not met" do
+      gwo_end("gwo_id", "gwo_uacct", {:conditions => false}).should_not =~ /getTracker\(\"gwo_uacct\"\)/
+      gwo_end("gwo_id", "gwo_uacct", :conditions => false).should == ""
+    end
+  end
+
+  describe "gw_conversion method" do
+    it "should produce correct output" do
+      gwo_conversion("gwo_id", "gwo_uacct").should =~ /getTracker\(\"gwo_uacct\"\)/
+      gwo_conversion("gwo_id", "gwo_uacct").should =~ /trackPageview\(\"\/gwo_id\/goal\"\)/
+    end
+
+    it "should return nothing when conditions are not met" do
+      gwo_conversion("gwo_id", "gwo_uacct", {:conditions => false}).should == ""
+    end
+  end
+
+  describe "goal is bounce rate" do
+    before(:each) do
+      stub!(:output_buffer=).and_return "foo"
+      stub!(:output_buffer).and_return "foo"
+    end
+
+    it "should create link bindings when goal is bounce rate" do
+      gwo_experiment("id", "uacct", sections = [:foo, :bar], :goal_is_bounce_rate => true).should =~ /addEventListener/
+    end
+
+    it "should not create link bindings when goal is not bounce rate" do
+      gwo_experiment("id", "uacct", sections = [:foo, :bar]).should_not =~ /addEventListener/
+    end
+  end
+
+  describe "gwo_section method with named sections" do
+    before(:each) do
+      stub!(:output_buffer=).and_return "foo"
+      stub!(:output_buffer).and_return "foo"
+    end
+      
+    it "should return nothing when conditions are not met and the variation is not the original" do
+      gwo_section("gwo_section", ["foo","bar"], {:conditions => false}).should == ""
+    end
+
+    it "should return original output without javascript if conditions are not met and original is the variation " do
+      gwo_section("gwo_section", :original, {:conditions => false}) { "this is the content" }.should == "this is the content"
+    end
+
+    it "should return original output with javascript if ignore is unset and original is the variation " do
+      gwo_section("gwo_section", :original) { "this is the content" }.should =~ /this is the content/
+      gwo_section("gwo_section", :original) { "this is the content" }.should =~ /( GWO_gwo_section_name != \"original\" )/
+    end
+
+    it "should only write one javascript block if the section is used for original and variations" do
+      gwo_section("section", [:original, :variation1, :variation2]) { "this is the content" }.should     =~ /this is the content/
+      gwo_section("section", [:original, :variation1, :variation2]) { "this is the content" }.should     =~ /( GWO_section_name != \"original\" && GWO_section_name != \"variation1\" && GWO_section_name != \"variation2\" )/
+    end
+
+    it "should write block for one variant" do
+      gwo_section("section",:testing) { "this is the content" }.should     =~ /this is the content/ 
+      gwo_section("section",:testing) { "this is the content" }.should     =~ /( GWO_section_name == \"testing\" )/
+    end
+
+    it "should write one block but enabled for all given variants " do
+      gwo_section("section",[:testing, :still_testing]) { "this is the content" }.should     =~ /this is the content/ 
+      gwo_section("section",[:testing, :still_testing]) { "this is the content" }.should     =~ /( GWO_section_name == \"testing\" || GWO_section_name == \"still_testing\" )/
+    end
+  end
+
+  describe "gwo_section method with numbered sections" do
+    before(:each) do
+      stub!(:output_buffer=).and_return "foo"
+      stub!(:output_buffer).and_return "foo"
+    end
+      
+      
+    it "should return nothing when conditions are not met and the variation is not the original" do
+      gwo_section("gwo_section", [1, 2], {:conditions => false}).should == ""
+    end
+
+    it "should return original output without javascript if conditions are not met and original is the variation " do
+      gwo_section("gwo_section", 0, {:conditions => false}) { "this is the content" }.should == "this is the content"
+    end
+
+    it "should return original output with javascript if ignore is unset and original is the variation " do
+      gwo_section("gwo_section", 0) { "this is the content" }.should =~ /this is the content/
+      gwo_section("gwo_section", 0) { "this is the content" }.should =~ /( GWO_gwo_section_number != 0 )/
+    end
+
+    it "should only write one javascript block if the section is used for original and variations" do
+      gwo_section("section", [0, 1, 2]) { "this is the content" }.should     =~ /this is the content/
+      gwo_section("section", [0, 1, 2]) { "this is the content" }.should     =~ /( GWO_section_number != 0 && GWO_section_number != 1 && GWO_section_number != 2 )/
+    end
+
+    it "should write block for one variant" do
+      gwo_section("section",1) { "this is the content" }.should     =~ /this is the content/ 
+      gwo_section("section",1) { "this is the content" }.should     =~ /( GWO_section_number == 1 )/
+    end
+
+    it "should write one block but enabled for all given variants " do
+      gwo_section("section",[1, 2]) { "this is the content" }.should     =~ /this is the content/ 
+      gwo_section("section",[1, 2]) { "this is the content" }.should     =~ /( GWO_section_number == 1 || GWO_section_number == 2 )/
+    end
+  end
+  
+  describe "gwo_methods in rails testing environment" do
+    before(:all) do
+      @stored_rails_env = ENV['RAILS_ENV']
+      ENV['RAILS_ENV'] = 'test'
+    end
+    
+    after(:all) do
+      @stored_rails_env.nil? ? ENV.delete('RAILS_ENV') : ENV['RAILS_ENV'] = @stored_rails_env
+    end
+    
+    before(:each) do
+      stub!(:output_buffer=).and_return "foo"
+      stub!(:output_buffer).and_return "foo"
+    end
+    
+    it "should not render javascript (:gwo_experiment)" do
+      result = gwo_experiment("id", "uacct", sections = [:foo, :bar])
+      result.should == ''
+      result.should_not =~ /<script type="text\/javascript">/
+    end
+
+    it "should not render javascript (:gwo_experiment)" do
+      result = gwo_conversion("gwo_id", "gwo_uacct")
+      result.should == ''
+      result.should_not =~ /<script type="text\/javascript">/
+    end
+    
+    it "should not render javascript (:gwo_section)" do
+      result = gwo_section("gwo_section", [1, 2])
+      result.should == ''
+      result.should_not =~ /<script>/
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+require 'spec' 
+RAILS_ENV="test"

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: mp-gwo
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex MacCaw
+- Daniel Bornkessel
+- Johannes Mentz
+- Yan Minagawa
+- Benjamin Krause
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  name: rspec
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  name: rspec-rails
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  name: rails
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id004
+  prerelease: false
+description: Google Website Optimizer Helper
+email: github@moviepilot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- gwo.gemspec
+- lib/gwo.rb
+- rails/init.rb
+- spec/lib/gwo_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/moviepilot/gwo
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Google Website Optimizer Helper
+test_files: 
+- spec/lib/gwo_spec.rb
+- spec/spec_helper.rb