split_cat 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4ac33764ebe4f87592a6751aacdd7db63eac155
-  data.tar.gz: 8537f5354b592c3c0bc9ae9ca4600b15dc41a1fc
+  metadata.gz: 4880681278c9fc6b8581039569aee279d717ca70
+  data.tar.gz: 4ec902b130f34eded678960ed766897ad2514726
 SHA512:
-  metadata.gz: 0ecb731b83eda634900c91d2580a45321e757bb1dafe525561b3ea495645f8147b15f80881118a474d09efa1163ec814704ffb0f84ff7627cbeffcacf9297a51
-  data.tar.gz: 59b40325906f5a2e75edf644df830877cef6aa02096f1fd157eb8597b12f8d99b776bf3cbc85dea37bc2de683ad63e030cee001abad1a17e3cb60d2ec4a86121
+  metadata.gz: fc167cf4abce19f129ff514b18faa9a3ba5d34ebcdf7ddf92b5ddfb855e7bbc716678901a791786a128d45790e7878f27c473402030848e95e7cd587ac652d7e
+  data.tar.gz: 73600eff04eeb93dc395332a2eff862fa6dbb43e82a5af05715e9c378b5c6c397149c4b43b8482b9571373891bccd2f20db94140e62d9e27cc8d4bb2bfcde4a0

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/split_cat.png)](http://badge.fury.io/rb/split_cat)
+[![Build Status](https://travis-ci.org/schrodingersbox/split_cat.png?branch=master)](https://travis-ci.org/schrodingersbox/split_cat)
+[![Dependency Status](https://gemnasium.com/schrodingersbox/split_cat.png)](https://gemnasium.com/schrodingersbox/split_cat)
+[![Code Climate](https://codeclimate.com/github/schrodingersbox/split_cat.png)](https://codeclimate.com/github/schrodingersbox/split_cat)
+[![Coverage Status](https://coveralls.io/repos/schrodingersbox/split_cat/badge.png)](https://coveralls.io/r/schrodingersbox/split_cat)
+
 # schrodingersbox/split_cat
 
 This Rails engine provides a framework for split testing.
@@ -43,6 +49,16 @@ See [The one line split-test, or how to A/B all the time](http://www.startupless
 
 ## How To
 
+### Apply Security To Reports
+
+Modify `config.application.rb` to inject your authorization filter into the controller:
+
+    config.after_initialize do
+      SplitCat::ExperimentsController.instance_eval do
+        before_filter :require_login
+      end
+    end
+
 ### Create A New Experiment
 
 Create or add to `config/initializers/split_cat.rb`:
@@ -67,7 +83,7 @@ Create partials for each hypothesis.  e.g. `button_a.html.erb` and `button_b.htm
 
 When rendering the partial, scope it with the experiment:
 
-  	render :partial => split_cat_scoped( :my_first_experiment, token, 'button' )
+  	render :partial => split_cat_scoped( 'button', :my_first_experiment, token  )
 
 This will cause the partial to use the hypothesis assigned for the user/token.
 
@@ -93,16 +109,6 @@ To use an externally defined token:
 
     split_cat_token( external_token )
 
-### Apply Security To Reports
-
-Modify `config.application.rb` to inject your authorization filter into the controller:
-
-    config.after_initialize do
-      SplitCat::ExperimentsController.instance_eval do
-        before_filter :require_login
-      end
-    end
-
 ## Best Practices
 
 ### Use A Constant Experiment ID
@@ -159,12 +165,16 @@ using multiple user accounts.
  * [FactoryGirl](https://github.com/thoughtbot/factory_girl)
  * [Shoulda](https://github.com/thoughtbot/shoulda-matchers)
  * [The one line split-test, or how to A/B all the time](http://www.startuplessonslearned.com/2008/09/one-line-split-test-or-how-to-ab-all.html)
+ * [Add Achievement Badges to Your Gem README](http://elgalu.github.io/2013/add-achievement-badges-to-your-gem-readme/)
 
 ## TODO
 
+  * Rework Experiment::factory to use template over DB, but fall back to DB
+
   * Spec rake tasks
 
   * As needed
+    * Add pagination to admin
     * Add a goals controller with action to record goal and redirect
     * Add split test probability calculator
       * hypo.control - boolean flag to determine which is baseline

data/app/controllers/split_cat/experiments_controller.rb

@@ -1,18 +1,17 @@
 module SplitCat
   class ExperimentsController < ApplicationController
+    before_action :set_experiment, only: [:show, :edit, :update, :destroy]
 
-    before_action :set_experiment, :only => [ :show ]
-
+    # GET /experiments
     def index
       @name = params[ :name ]
       @active = ( params[ :active ] == '1' )
 
       @experiments = Experiment.order( 'id desc' )
       @experiments = @experiments.where( 'name like ?', '%' + @name + '%') if @name
-
-      @experiments = @experiments.map { |e| e.active? ? e : nil }.compact if @active
     end
 
+    # GET /experiments/1
     def show
       respond_to do |format|
         format.html
@@ -20,11 +19,50 @@ module SplitCat
       end
     end
 
-  private
+    # GET /experiments/new
+    def new
+      @experiment = Experiment.new
+    end
+
+    # GET /experiments/1/edit
+    def edit
+    end
+
+    # POST /experiments
+    def create
+      @experiment = Experiment.new(experiment_params)
 
-    def set_experiment
-      @experiment = Experiment.includes( :goals, :hypotheses ).find( params[ :id ] )
+      if @experiment.save
+        redirect_to @experiment, notice: 'Experiment was successfully created.'
+      else
+        render action: 'new'
+      end
     end
 
+    # PATCH/PUT /experiments/1
+    def update
+      if @experiment.update(experiment_params)
+        redirect_to @experiment, notice: 'Experiment was successfully updated.'
+      else
+        render action: 'edit'
+      end
+    end
+
+    # DELETE /experiments/1
+    def destroy
+      @experiment.destroy
+      redirect_to experiments_url, notice: 'Experiment was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_experiment
+        @experiment = Experiment.includes( :goals, :hypotheses ).find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def experiment_params
+        params[:experiment].permit( Experiment.new.attributes.keys )
+      end
   end
 end

data/app/helpers/split_cat/experiments_helper.rb

@@ -60,7 +60,6 @@ module SplitCat
         concat experiment_info_row( :name, experiment.name )
         concat experiment_info_row( :description, experiment.description )
         concat experiment_info_row( :created, experiment.created_at )
-        concat experiment_info_row( :active, experiment.active? )
         concat experiment_info_row( :subjects, number_with_delimiter( experiment.total_subjects ) )
       end
     end
@@ -117,7 +116,7 @@ module SplitCat
     end
 
     def experiment_search_form( name, active)
-      render :partial => 'form', :locals => { :name => name, :active => active }
+      render :partial => 'search', :locals => { :name => name, :active => active }
     end
 
     def experiment_table( experiments )
@@ -125,7 +124,6 @@ module SplitCat
         output = content_tag( :tr ) do
           concat content_tag( :th, t( :id, :scope => :split_cat ) )
           concat content_tag( :th, t( :name, :scope => :split_cat ) )
-          concat content_tag( :th, t( :active, :scope => :split_cat ) )
         end
 
         show = t( :show, :scope => :split_cat )
@@ -134,7 +132,6 @@ module SplitCat
           output += content_tag( :tr ) do
            concat content_tag( :td, experiment.id )
            concat content_tag( :td, experiment.name )
-           concat content_tag( :td, experiment.active? )
            concat content_tag( :td, link_to( show, { :controller => :experiments, :action => :show, :id => experiment.id } ) )
           end
         end

data/app/models/split_cat/experiment.rb

@@ -12,13 +12,6 @@ module SplitCat
 
     belongs_to :winner, :class_name => Hypothesis
 
-    # An experiment is only valid if it matches the current configuration
-
-    def active?
-      return false unless template = SplitCat.config.template( name )
-      return !!same_structure?( template )
-    end
-
     # Returns a memoized array of goal name => hypothesis_name => subject counts
 
     def goal_counts
@@ -154,22 +147,11 @@ module SplitCat
         return experiment
       end
 
-      unless template = SplitCat.config.template( name )
-        Rails.logger.error( "Experiment.factory not configured for experiment: #{name}" )
-        return nil
-      end
-
+      template = SplitCat.config.template( name )
       if experiment = Experiment.includes( :goals, :hypotheses ).find_by_name( name )
-        unless experiment.same_structure?( template )
-          experiment = nil
-          Rails.logger.error( "Experiment.factory mismatched experiment: #{name}" )
-        end
+        return nil if template && !experiment.same_structure?( template )
       else
-        if template.save
-          experiment = template
-        else
-          Rails.logger.error( "Experiment.factory failed to save experiment: #{name}" )
-        end
+        experiment = template if template && template.save
       end
 
       @@cache[ name.to_sym ] = experiment

data/app/views/split_cat/experiments/_form.html.erb

@@ -1,13 +1,32 @@
-<%= form_tag( '', :method => :get ) do %>
-    <p>
-        <%= label_tag( :name, t( :name, :scope => :split_cat ) ) %>
-        <%= text_field_tag( :name, name ) %>
-    </p>
-
-    <p>
-      <%= check_box_tag( :active, 1, active )  %>
-        <%= label_tag( :active, t( :active_only, :scope => :split_cat ) ) %>
-    </p>
-
-      <%= submit_tag( t( :search, :scope => :split_cat ) ) %>
+<%= form_for(@experiment) do |f| %>
+  <% if @experiment.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@experiment.errors.count, "error") %> prohibited this experiment from being saved:</h2>
+
+      <ul>
+      <% @experiment.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+    <div class="form-group">
+      <%= f.label( :name ) %>
+      <%= f.text_field( :name, :size => 32 ) %>
+    </div>
+
+    <div class="form-group">
+      <%= f.label( :description ) %>
+      <%= f.text_area( :description, :size => "60x10" ) %>
+    </div>
+
+    <div class="form-group">
+      <%= f.label( :winner_id ) %>
+      <%= f.text_field( :winner_id, :size => 8 ) %>
+    </div>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
 <% end %>

data/app/views/split_cat/experiments/_search.html.erb

@@ -0,0 +1,8 @@
+<%= form_tag( '', :method => :get ) do %>
+    <p>
+        <%= label_tag( :name, t( :name, :scope => :split_cat ) ) %>
+        <%= text_field_tag( :name, name ) %>
+    </p>
+
+      <%= submit_tag( t( :search, :scope => :split_cat ) ) %>
+<% end %>

data/app/views/split_cat/experiments/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing experiment</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @experiment %> |
+<%= link_to 'Back', experiments_path %>

data/app/views/split_cat/experiments/index.html.erb

@@ -3,3 +3,7 @@
 
 <h2><%= t( :search, :scope => :split_cat ) %></h2>
 <%= experiment_search_form( @name, @active) %>
+
+<br>
+
+<%= link_to 'New Experiment', new_experiment_path %>

data/app/views/split_cat/experiments/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New experiment</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', experiments_path %>

data/config/locales/en.yml

@@ -1,7 +1,5 @@
 en:
   split_cat:
-    active: active
-    active_only: active only
     created: created
     description: description
     experiment: Experiment

data/config/routes.rb

@@ -2,6 +2,6 @@ SplitCat::Engine.routes.draw do
 
   root :to => 'experiments#index'
 
-  resources :experiments, :only => [ :index, :show ]
+  resources :experiments
 
 end

data/lib/split_cat/helpers.rb

@@ -45,6 +45,14 @@ module SplitCat
     # #set_split_cat_cookie
 
     def set_split_cat_cookie( options = {} )
+
+      # Create a Subject for the cookie token, if it doesn't exist
+
+     if cookies[ :split_cat_token ] && cookies[ :split_cat_token ][ :value ]  &&
+         !Subject.where( :token => cookies[ :split_cat_token ][ :value ] ).first
+       split_cat_token( cookies[ :split_cat_token ] )
+     end
+
      if options[ :force ] || !cookies[ :split_cat_token ]
        expires = SplitCat.config.cookie_expiration.from_now
        cookies[ :split_cat_token ] = { :value => split_cat_token, :expires => expires }

data/lib/split_cat/version.rb

@@ -1,3 +1,3 @@
 module SplitCat
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/controllers/split_cat/experiments_controller_spec.rb

@@ -1,80 +1,176 @@
 require 'spec_helper'
 
-describe SplitCat::ExperimentsController do
+module SplitCat
+  describe ExperimentsController do
 
-  routes { SplitCat::Engine.routes }
+    routes { SplitCat::Engine.routes }
 
-  it 'is a subclass of ApplicationController' do
-    @controller.should be_a_kind_of( ApplicationController )
-  end
-
-  before( :each ) do
-    @experiment = FactoryGirl.create( :experiment_full )
-    controller.stub( :require_login )
-  end
-
-  describe '/index' do
+    let( :experiment ) { FactoryGirl.create( :experiment_full ) }
+    let(:valid_attributes) { { :name => 'valid'  } }
+    let(:valid_session) { {} }
 
-    it 'gets successfully' do
-      get :index
-      response.should be_success
+    it 'is a subclass of ApplicationController' do
+      @controller.should be_a_kind_of( ApplicationController )
     end
 
-    it 'assigns experiments' do
-      get :index
-      response.should be_success
-      expect( assigns( :experiments ) ).to be_present
+    before( :each ) do
+      controller.stub( :require_login )
+      expect( experiment ).to be_present
     end
 
-    it 'accepts name and active params' do
-      name = @experiment.name
-      active = '1'
-      get :index, :name => name, :active => active
+    describe "GET index" do
+      it "assigns all experiments as @experiments" do
+        get :index, {}, valid_session
+        assigns(:experiments).should eq([experiment])
+      end
+
+      it 'accepts name and active params' do
+        name = experiment.name
+        active = '1'
+        get :index, :name => name, :active => active
 
-      expect( assigns( :name ) ).to be( name )
-      expect( assigns( :active ) ).to eql( active == '1' )
+        expect( assigns( :name ) ).to be( name )
+        expect( assigns( :active ) ).to eql( active == '1' )
+      end
     end
 
-  end
+    describe "GET show" do
+      it "assigns the requested experiment as @experiment" do
+        get :show, {:id => experiment.to_param}, valid_session
+        assigns(:experiment).should eq(experiment)
+      end
 
-  describe '/show' do
+      context 'formatting CSV' do
 
-    it 'gets successfully' do
-      get :show, :id => @experiment.id
-      response.should be_success
-    end
+        it 'renders CSV' do
+          get :show, :id => experiment.id, :format => 'csv'
+          response.should be_success
+          response.content_type.should eql( 'text/csv' )
+        end
+
+        it 'turns the requested experiment into CSV' do
+          get :show, :id => experiment.id, :format => 'csv'
+          response.body.should eql( experiment.to_csv )
+        end
+
+      end
 
-    it 'assigns experiments' do
-      get :show, :id => @experiment.id
-      response.should be_success
-      expect( assigns( :experiment ) ).to be_present
+      context 'formatting HTML' do
+
+        it 'renders HTML' do
+          get :show, :id => experiment.id, :format => 'html'
+          response.should be_success
+          response.content_type.should eql( 'text/html' )
+        end
+
+      end
     end
 
-    context 'formatting CSV' do
+    describe "GET new" do
+      it "assigns a new experiment as @experiment" do
+        get :new, {}, valid_session
+        assigns(:experiment).should be_a_new(Experiment)
+      end
+    end
 
-      it 'renders CSV' do
-        get :show, :id => @experiment.id, :format => 'csv'
-        response.should be_success
-        response.content_type.should eql( 'text/csv' )
+    describe "GET edit" do
+      it "assigns the requested experiment as @experiment" do
+        get :edit, {:id => experiment.to_param}, valid_session
+        assigns(:experiment).should eq(experiment)
       end
+    end
 
-      it 'turns the requested experiment into CSV' do
-        get :show, :id => @experiment.id, :format => 'csv'
-        response.body.should eql( @experiment.to_csv )
+    describe "POST create" do
+      describe "with valid params" do
+        it "creates a new Experiment" do
+          expect {
+            post :create, {:experiment => valid_attributes}, valid_session
+          }.to change(Experiment, :count).by(1)
+        end
+
+        it "assigns a newly created experiment as @experiment" do
+          post :create, {:experiment => valid_attributes}, valid_session
+          assigns(:experiment).should be_a(Experiment)
+          assigns(:experiment).should be_persisted
+        end
+
+        it "redirects to the created experiment" do
+          post :create, {:experiment => valid_attributes}, valid_session
+          response.should redirect_to(Experiment.last)
+        end
       end
 
+      describe "with invalid params" do
+        it "assigns a newly created but unsaved experiment as @experiment" do
+          # Trigger the behavior that occurs when invalid params are submitted
+          Experiment.any_instance.stub(:save).and_return(false)
+          post :create, {:experiment => {  }}, valid_session
+          assigns(:experiment).should be_a_new(Experiment)
+        end
+
+        it "re-renders the 'new' template" do
+          # Trigger the behavior that occurs when invalid params are submitted
+          Experiment.any_instance.stub(:save).and_return(false)
+          post :create, {:experiment => {  }}, valid_session
+          response.should render_template("new")
+        end
+      end
     end
 
-    context 'formatting HTML' do
+    describe "PUT update" do
+      describe "with valid params" do
+        it "updates the requested experiment" do
+          experiment = Experiment.create! valid_attributes
+          # Assuming there are no other experiments in the database, this
+          # specifies that the Experiment created on the previous line
+          # receives the :update_attributes message with whatever params are
+          # submitted in the request.
+          Experiment.any_instance.should_receive(:update).with({ "name" => "params" })
+          put :update, {:id => experiment.to_param, :experiment => { "name" => "params" }}, valid_session
+        end
+
+        it "assigns the requested experiment as @experiment" do
+          put :update, {:id => experiment.to_param, :experiment => valid_attributes}, valid_session
+          assigns(:experiment).should eq(experiment)
+        end
+
+        it "redirects to the experiment" do
+          put :update, {:id => experiment.to_param, :experiment => valid_attributes}, valid_session
+          response.should redirect_to(experiment)
+        end
+      end
+
+      describe "with invalid params" do
+        it "assigns the experiment as @experiment" do
+          experiment = Experiment.create! valid_attributes
+          # Trigger the behavior that occurs when invalid params are submitted
+          Experiment.any_instance.stub(:save).and_return(false)
+          put :update, {:id => experiment.to_param, :experiment => {  }}, valid_session
+          assigns(:experiment).should eq(experiment)
+        end
+
+        it "re-renders the 'edit' template" do
+          experiment = Experiment.create! valid_attributes
+          # Trigger the behavior that occurs when invalid params are submitted
+          Experiment.any_instance.stub(:save).and_return(false)
+          put :update, {:id => experiment.to_param, :experiment => {  }}, valid_session
+          response.should render_template("edit")
+        end
+      end
+    end
 
-      it 'renders HTML' do
-        get :show, :id => @experiment.id, :format => 'html'
-        response.should be_success
-        response.content_type.should eql( 'text/html' )
+    describe "DELETE destroy" do
+      it "destroys the requested experiment" do
+        expect {
+          delete :destroy, {:id => experiment.to_param}, valid_session
+        }.to change(Experiment, :count).by(-1)
       end
 
+      it "redirects to the experiments list" do
+        delete :destroy, {:id => experiment.to_param}, valid_session
+        response.should redirect_to(experiments_url)
+      end
     end
 
   end
-
-end
+end

data/spec/data/helpers/experiment_info.html

@@ -1 +1 @@
-<table><tr><th>id</th><td>1</td></tr><tr><th>name</th><td>test</td></tr><tr><th>description</th><td>this is only a test</td></tr><tr><th>created</th><td>2013-09-12 07:08:58 UTC</td></tr><tr><th>active</th><td>false</td></tr><tr><th>subjects</th><td>0</td></tr></table>
+<table><tr><th>id</th><td>1</td></tr><tr><th>name</th><td>test</td></tr><tr><th>description</th><td>this is only a test</td></tr><tr><th>created</th><td>2013-09-12 07:08:58 UTC</td></tr><tr><th>subjects</th><td>0</td></tr></table>

data/spec/data/helpers/experiment_info.html.tmp

@@ -1 +1 @@
-<table><tr><th>id</th><td>1</td></tr><tr><th>name</th><td>test</td></tr><tr><th>description</th><td>this is only a test</td></tr><tr><th>created</th><td>2013-09-12 07:08:58 UTC</td></tr><tr><th>active</th><td>false</td></tr><tr><th>subjects</th><td>0</td></tr></table>
+<table><tr><th>id</th><td>1</td></tr><tr><th>name</th><td>test</td></tr><tr><th>description</th><td>this is only a test</td></tr><tr><th>created</th><td>2013-09-12 07:08:58 UTC</td></tr><tr><th>subjects</th><td>0</td></tr></table>

data/spec/data/helpers/experiment_table.html

@@ -1 +1 @@
-<table border="1"><tr><th>id</th><th>name</th><th>active</th></tr><tr><td>1</td><td>test</td><td>false</td><td><a href="/experiments/show/1">Show</a></td></tr></table>
+<table border="1"><tr><th>id</th><th>name</th></tr><tr><td>1</td><td>test</td><td><a href="/experiments/show/1">Show</a></td></tr></table>

data/spec/data/helpers/experiment_table.html.tmp

@@ -1 +1 @@
-<table border="1"><tr><th>id</th><th>name</th><th>active</th></tr><tr><td>1</td><td>test</td><td>false</td><td><a href="/experiments/show/1">Show</a></td></tr></table>
+<table border="1"><tr><th>id</th><th>name</th></tr><tr><td>1</td><td>test</td><td><a href="/experiments/show/1">Show</a></td></tr></table>