ratel 0.0.3 → 0.0.4

data/README.md

@@ -4,6 +4,9 @@ A/B Testing on Rails
 
 Let's enjoy UX-driven development!
 
+## Supported
+- Google Analytics
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,6 +37,30 @@ Pattern A 50% / Pattern B 30% / Original 20%
     <a href="javascript: <%= screen_conversion :cassette, :click, g %>">Conversion!</a>
     <% end %>
 
+## Advanced Tips
+### Create your own Tracking System
+Define the tracking class (`Ratel::Tracking::MyTrackingSystem`) and `push` method.
+
+    $ vi lib/tracking/my_tracking_system.rb
+    module Ratel
+      module Tracking
+        module MyTrackingSystem
+    
+          # `args` equals screen_conversion's args
+          def push *args
+            # options = args.extract_options!
+            # ...
+          end
+          
+        end
+      end
+    end
+Rails Config
+    Ratel.configure do |config|
+      config.tracking = :my_tracking_system # snake_case symbol or string
+    end
+Execute your method (`Ratel::Tracking::MyTrackingSysmtem.push`) when `screen_conversion` method called.
+
 ## Contributing
 
 1. Fork it

data/app/views/ratel/button.html.erb

@@ -0,0 +1,17 @@
+<h1>What's the BEST color for high conversions?</h1>
+<% screen_changes at: :button, to: { red: 20, pink: 20, orange: 20, green: 20, blue: 20 }, with: :reset do |g| %>
+  <% case g %>
+  <% when :red %>
+    <a href="/done" onclick="<%= screen_conversion :button, :click, g %>" class="<%= g %>">Conversion!</a>
+  <% when :pink %>
+    <a href="/done" onclick="<%= screen_conversion :button, :click, g %>" class="<%= g %>">Conversion!</a>
+  <% when :orange %>
+    <a href="/done" onclick="<%= screen_conversion :button, :click, g %>" class="<%= g %>">Conversion!</a>
+  <% when :green %>
+    <a href="/done" onclick="<%= screen_conversion :button, :click, g %>" class="<%= g %>">Conversion!</a>
+  <% when :blue %>
+    <a href="/done" onclick="<%= screen_conversion :button, :click, g %>" class="<%= g %>">Conversion!</a>
+  <% else %>
+    <a href="/done" onclick="<%= screen_conversion :button, :click, g %>" class="<%= g %>">Conversion!</a>
+  <% end %>
+<% end %>

data/lib/ratel.rb

@@ -9,7 +9,6 @@ require 'ratel/config'
 require 'ratel/helper/action_view_extension'
 
 # Tracking
-require 'ratel/tracking/event'
 require 'ratel/tracking/google_analytics'
 
 if defined? Rails

data/lib/ratel/engine.rb

@@ -1,7 +1,34 @@
 module Ratel
   class Engine < ::Rails::Engine
     initializer :ratel do |app|
-      ActionView::Base.send :include, Ratel::ActionViewExtension
+      Ratel::Initializer.execute
+    end
+  end
+
+  class Initializer
+    class << self
+      def execute
+        # include helper methods
+        ActionView::Base.send :include, Ratel::ActionViewExtension
+
+        define_tracking_event
+      end
+
+
+      private
+
+      def define_tracking_event
+        # auot-define Ratel::Tracking::Event class
+        Ratel::Tracking.const_set :Event, Class.new unless Ratel::Tracking.const_defined? :Event
+        name = "#{Ratel.config.tracking}".camelize
+        
+        return if Ratel::Tracking::Event.method_defined? :push
+        raise NotImplementedError, "#{name} is invalid. Specify correct Ratel.config.tracking." unless Ratel::Tracking.const_defined? name
+
+        # define method that pushes conversion events
+        Ratel::Tracking::Event.extend Ratel::Tracking.const_get name
+      end
+
     end
   end
 end

data/lib/ratel/helper/action_view_extension.rb

@@ -4,15 +4,17 @@ module Ratel
     def screen_changes *args, &block
       options = args.extract_options!
       key = :"#{Ratel.config.screen_key}#{options[:at]}"
-      
+
+      ## TODO A/B テストの停止ロジック
+      # redis などのkey-value 対応 or 設定ファイルでの制御？      
       if options[:with] == :reset or cookies[key].nil?
-        selected = '_default'
+        selected = :default
         bar = 0
         num = Time.now.usec % 100
         options[:to].each do |k,v|
           bar += v
           if num < bar
-            selected = "_#{k}"
+            selected = k
             break
           end
         end
@@ -22,6 +24,7 @@ module Ratel
     end
 
     def screen_conversion category, action, label
+      # Ratel::Tracking::Event class is auto-defined
       Ratel::Tracking::Event.push category, action, label
     end
 

data/lib/ratel/tracking/google_analytics.rb

@@ -2,8 +2,9 @@ module Ratel
   module Tracking
     module GoogleAnalytics
 
-      def _push category, action, label, options = {}
-        s = "_gaq.push(['_trackEvent', '#{category}', '#{action}', '#{label}'"
+      def push *args
+        options = args.extract_options!
+        s = "_gaq.push(['_trackEvent', '#{options[:category]||args[0]}', '#{options[:action]||args[1]}', '#{options[:label]||args[2]}'"
         s << ", #{options[:value]}"          if options.key? :value
         s << ", #{options[:noninteraction]}" if options.key? :noninteraction
         s << "]);"

data/lib/ratel/version.rb

@@ -1,3 +1,3 @@
 module Ratel
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/rails_spec_app.rb

@@ -10,17 +10,22 @@ app.config.generators do |g|
 end
 app.initialize!
 
+ACTIONS = [:index, :button]
+
 # routing
 app.routes.draw do
-  get "/"  =>"ratel#index"  ,as: :index
+  ACTIONS.each do |e|
+    get "/#{e}"  =>"ratel##{e}"  ,as: e
+  end
 end
 
 # controllers
 class ApplicationController < ActionController::Base ; end
 
 class RatelController < ApplicationController
-  def index
-
+  ACTIONS.each do |e|
+    define_method e do
+    end
   end
 end
 

data/spec/ratel/engine_spec.rb

@@ -0,0 +1,29 @@
+# coding: UTF-8
+require 'spec_helper'
+
+# auto-define class
+describe Ratel::Initializer do
+
+  before do
+    Ratel.configure do |config|
+      config.tracking = tracking
+    end
+  end
+
+  context "implemented tracking system" do
+    let(:tracking) { :google_analytics }
+    before { Ratel::Initializer.execute }
+
+    it "expects to be called `push` method" do
+      expect(Ratel::Tracking::Event.methods.include? :push).to be_true
+    end
+  end
+
+  context "NOT implemented tracking system" do
+    let(:tracking) { :unknown }
+
+    it "expects to raise NotImplementedError" do
+      expect { Ratel::Initializer.execute }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/ratel/helper/action_view_extension_spec.rb

@@ -0,0 +1,21 @@
+# coding: UTF-8
+require 'spec_helper'
+
+describe Ratel::ActionViewExtension do
+
+  before do
+    Ratel.configure do |config|
+      config.tracking = tracking
+    end
+    Ratel::Initializer.execute
+  end
+
+  let(:tracking) { :google_analytics }
+
+  before do
+    visit "/index"
+  end
+
+  subject { page }
+  it { should have_content "TEST" }
+end

data/spec/ratel/tracking/google_analytics_spec.rb

@@ -0,0 +1,26 @@
+# coding: UTF-8
+require 'spec_helper'
+
+describe Ratel::Tracking::GoogleAnalytics do
+
+  let(:object) do
+    Class.new do
+      extend Ratel::Tracking::GoogleAnalytics
+    end
+  end
+
+  describe "conversion's method `push`" do
+    it "expects to be called" do
+      expect(object.methods.include? :push).to be_true
+    end
+
+    context "call `push` method" do
+      let(:result) { object.push category: "A/B Testing", action: "click", label: "button" }
+
+      it "expects to return same results" do
+        expect(object.push "A/B Testing", :click, :button).to eq(result) 
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -6,5 +6,8 @@ require 'ratel'
 require 'capybara/rails'
 RSpec.configure do |config|
   config.mock_with :rspec
+  config.expect_with :rspec do |c|
+    c.syntax = :expect    # disables `should`
+  end
   config.include Capybara::DSL
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratel
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -41,18 +41,20 @@ files:
 - README.md
 - Rakefile
 - app/views/layouts/application.html.erb
+- app/views/ratel/button.html.erb
 - app/views/ratel/index.html.erb
 - deploy_gem.sh
 - lib/ratel.rb
 - lib/ratel/config.rb
 - lib/ratel/engine.rb
 - lib/ratel/helper/action_view_extension.rb
-- lib/ratel/tracking/event.rb
 - lib/ratel/tracking/google_analytics.rb
 - lib/ratel/version.rb
 - ratel.gemspec
-- spec/helper/action_view_extension_spec.rb
 - spec/rails_spec_app.rb
+- spec/ratel/engine_spec.rb
+- spec/ratel/helper/action_view_extension_spec.rb
+- spec/ratel/tracking/google_analytics_spec.rb
 - spec/ratel_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/yulii/ratel
@@ -80,7 +82,9 @@ signing_key:
 specification_version: 3
 summary: a/b testing module
 test_files:
-- spec/helper/action_view_extension_spec.rb
 - spec/rails_spec_app.rb
+- spec/ratel/engine_spec.rb
+- spec/ratel/helper/action_view_extension_spec.rb
+- spec/ratel/tracking/google_analytics_spec.rb
 - spec/ratel_spec.rb
 - spec/spec_helper.rb

data/lib/ratel/tracking/event.rb

@@ -1,18 +0,0 @@
-module Ratel
-  module Tracking
-    class Event
-
-      class << self
-        def push category, action, label
-          case Ratel.config.tracking
-          when :google_analytics
-            self.extend Ratel::Tracking::GoogleAnalytics
-          else
-            raise NotImplementedError, "invalid Ratel.config.tracking"
-          end
-          _push category, action, label
-        end
-      end
-    end
-  end
-end

data/spec/helper/action_view_extension_spec.rb

@@ -1,14 +0,0 @@
-# coding: UTF-8
-require 'spec_helper'
-
-include Ratel::ActionViewExtension
-describe Ratel::ActionViewExtension do
-
-  before do
-    visit "/"
-    puts page.html
-  end
-
-  subject { page }
-  it { should have_content "TEST" }
-end