moviepilot-gwo 0.1

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,120 @@
+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@bornkessel.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
+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('UA-23902382-1', '1909920434')
+
+... erb:
+  <%= gwo_conversion('UA-23902382-1', '1909920434') %>
+
+
+Copyright (c) 2009 Made by Many, released under the MIT license

data/lib/gwo.rb

@@ -0,0 +1,203 @@
+# 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'
+module GWO
+  module Helper
+
+    include ::ActionView::Helpers::CaptureHelper
+     
+    # 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>:ga_tracking</b> executes a <tt>trackPageView(...)</tt> for google analytics tracking. It adds parameters to the URL, so you can identify which variant (or combination) the user saw (handy if you want to check on the exit rate with GA)
+    #   * <b>:ga_base_url</b> set a static base URL for google analytics: Say your variant is in a 'show' view, GA would track a lot of different URLs (as the show view url contains the ID). If you are just interested about the variants in GA, set a static URL here (i.e. hbp://<your domain>/ab-testing ) and GA tracking will always be that static domain + parameters with information about the variant the user saw.
+    def gwo_experiment(id, uacct, sections = [], options = {}, &block)
+      options = {
+        :conditions => true,
+        :ga_tracking => false,
+        :ga_base_url => nil
+      }.update(options)
+
+      src  = gwo_start(id, sections, options)
+      src += capture(&block) 
+      src += gwo_end(id, uacct, options)
+      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 => 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 pageTracker=_gat._getTracker("#{uacct}");
+      pageTracker._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 => 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 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 += \"&GWO_#{section}_name=\" + GWO_#{section}_name;" if options[:ga_tracking]
+      end
+
+      if options[:ga_tracking]
+        base_url = options[:ga_base_url] ? "\"#{options[:ga_base_url]}\"" : "document.location"
+        variable_assignments += %{\
+           window.onload = function(){ \
+            var google_analytics_info = ''; #{google_analytics_info}; if(typeof(trackPageView) == 'function') {\
+              trackPageView(#{base_url} + "?ab_test=true" + google_analytics_info);\
+              #{js_logger("#{base_url} + \"?ab_test=true\" + google_analytics_info")}\
+            }\
+          }\
+        }
+      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 pageTracker=_gat._getTracker("#{uacct}");
+      pageTracker._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,203 @@
+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 \+= \"&GWO_section_name_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name").should_not =~ /trackPageView\(document.location \+ \"\?ab_test=true\" \+ google_analytics_info\)/
+    end
+    it "should not create google analytics stuff if option is disabled" do
+      gwo_start("gwo_id", "section_name", :ga_tracking => false).should_not =~ /google_analytics_info \+= \"&GWO_section_name_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name", :ga_tracking => false).should_not =~ /trackPageView\(document.location \+ \"\?ab_test=true\" \+ google_analytics_info\)/
+    end
+
+    it "should create correct google analytics stuff for default urls" do
+      gwo_start("gwo_id", "section_name", :ga_tracking => true).should =~ /google_analytics_info \+= \"&GWO_section_name_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name", :ga_tracking => true).should =~ /trackPageView\(document.location \+ \"\?ab_test=true\" \+ google_analytics_info\)/
+    end
+
+    it "should create correct google analytics stuff for static urls" do
+      gwo_start("gwo_id", "section_name", :ga_tracking => true, :ga_base_url => "http://example.com").should =~ /google_analytics_info \+= \"&GWO_section_name_name=\" \+ GWO_section_name_name;/
+      gwo_start("gwo_id", "section_name", :ga_tracking => true, :ga_base_url => "http://example.com").should =~ /trackPageView\(\"http:\/\/example\.com\" \+ \"\?ab_test=true\" \+ 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"], :ga_tracking => true).should =~ /google_analytics_info \+= \"&GWO_section_name1_name=\" \+ GWO_section_name1_name;/
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :ga_tracking => true).should =~ /google_analytics_info \+= \"&GWO_section_name2_name=\" \+ GWO_section_name2_name;/
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :ga_tracking => true).should =~ /google_analytics_info \+= \"&GWO_section_name3_name=\" \+ GWO_section_name3_name;/
+      gwo_start("gwo_id", ["section_name1", "section_name2", "section_name3"], :ga_tracking => true).should =~ /trackPageView\(document.location \+ \"\?ab_test=true\" \+ 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 "gwo_section method with named sections" do
+      
+    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
+      
+    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
+  
+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,63 @@
+--- !ruby/object:Gem::Specification 
+name: moviepilot-gwo
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Alex MacCaw
+- Daniel Bornkessel
+- Johannes Mentz
+- Yan Minagawa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: daniel@bornkessel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/gwo.rb
+- MIT-LICENSE
+- README.markdown
+- spec/lib/gwo_spec.rb
+- spec/spec_helper.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/kesselborn/gwo
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Plugin to easily make use of Server-Side Dynamic Section Variations with Google Web Optimizer
+test_files: []
+