experimental 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5971835dc6a436120c342849f251fd6833819f07
-  data.tar.gz: 1a0c5fe0f8465ebf62ad31bb1000e32952420488
+  metadata.gz: 4c3ca7d05e6f83ec23e057defc0da8e4d8b94b6f
+  data.tar.gz: 19dd91453b0154b0d8cbc4b7c03e02860ba796e4
 SHA512:
-  metadata.gz: 5a6fd63702f780be58b0c3582d7b66985fcce57643fec71f95df4800396d6c41f485d73a76aa5dc7cd7dad2f0bff60006cf9857a247999ead024326c78215a24
-  data.tar.gz: e7b1b7467c78ccc8fb77ac50c3d2f8551e1fce7887ffa2c56993d378db3784f8031f8b323176ed5c8aa3d7f7ca4019fbdb3fba75b1cee66337a84b59d3bca291
+  metadata.gz: 8f460e8ef869e751e103a936cf99c921293e700dd15387391ce4b84ed9207ecf49c472df59a02e29d38b471afa77ce708ff07d20722165585665e6a4d3dd6b79
+  data.tar.gz: 24eeb5bec5c23fcbb3354804368d21fbad288b278942c82b191ead834b2e61b59bf5116443d8e03d5416a86021c2a38dcad013a6a7b2ab45b8fcc81c71b8833a

data/README.markdown

@@ -1,4 +1,5 @@
-# Experimental
+# Experimental [![Build Status](https://travis-ci.org/howaboutwe/experimental.png?branch=master)](https://travis-ci.org/howaboutwe/experimental)
+
 Experimental is an Split testing framework for Rails.  
 It was written with a few goals in mind:
 * Split the users in a non-predictable pattern (i.e. half of the users won't always
@@ -14,136 +15,6 @@ be removed make the site explode
 
 `rails g experimental`
 
-### Routes
-
-```ruby
-resources :experiments, only: [:index, :new, :create] do
-  collection do
-    get :inactive
-      post :set_winner
-    end
-  end
-
-  namespace :singles_admin do
-    resources :experiments, only: [:index, :new, :create] do
-      collection do
-        get :inactive
-        post :set_winner
-      end
-    end
-  end
-end
-```
-
-### Admin Frontend
-
-#### Create your own admin controller:
-```ruby
-class Admin::ExperimentsController < ApplicationController
-  include Experimental::ControllerActions
-
-  alias_method :index, :experiments_index
-  alias_method :new, :experiments_new
-  alias_method :set_winner, :experiments_set_winner
-
-  def create
-    if experiments_create
-      redirect_to admin_experiments_path
-    else
-      render :new
-    end
-  end
-
-  def base_resource_name
-    "singles_admin_experiment"
-  end
-end
-```
-
-#### Using ActiveAdmin:
-
-`rails g active_admin:resource Experiment`
-
-```ruby
-require 'experimental/controller_actions'
-
-ActiveAdmin.register Experimental::Experiment, as: "Experiment" do
-  actions :index, :new, :create
-  filter :name
-
-  controller do
-    class_eval do
-      include Experimental::ControllerActions
-    end
-
-    def base_resource_name
-      "admin_experiment"
-    end
-
-    def create
-      if experiments_create
-        redirect_to admin_experiments_path
-      else
-        render :new
-      end
-    end
-
-    def new
-      experiments_new
-    end
-  end
-
-  # collection_actions force active_admin to create a route
-  collection_action :set_winner, method: :post do
-    experiments_set_winner
-  end
-
-  # can do this instead of the ended_or_removed scope below
-  # you will need to add a link to inactive_admins_experiments_path
-  #  in your view
-  collection_action :inactive do
-    experiments_inactive
-    render template: 'admin/experiments/index'
-  end
-
-  scope :in_progress, :default => true do |experiments|
-    experiments.in_progress
-  end
-
-  scope :ended_or_removed do |experiments|
-    @include_inactive = true
-    experiments.ended_or_removed
-  end
-
-  index do
-    render template: 'admin/experiments/index'
-  end
-
-  form partial: 'new'
-end
-```
-
-#### Views
-
-create an index and new view in appropriate view folder, i.e.
-
-`app/views/admin/experiments/index.html.erb`
-
-```erb
-<%= render partial: 'experimental/links' %>
-<%= render partial: 'experimental/index' %>
-```
-
-`app/views/admin/experiments/new.html.erb`
-
-```erb
-<%= render partial: 'experimental/links' %>
-<%= render partial: 'experimental/new' %>
-```
-
-*Note: ActiveAdmin users will not need to include the links
-  partials*
-
 ### Subject
 
 For the class you'd like to be the subject of experiments, include the
@@ -276,29 +147,15 @@ You will likely want to automate the running of `rake
 experimental:sync` by adding to your deploy file.
 
 ### Capistrano
-In `config/deploy.rb`:
 
-Create a namespace to run the task:
-```ruby
-namespace :database do
-  desc "Sync experiments"
-  task :sync_from_app, roles: :db, only: { primary: true } do
-    run "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec rake experimental:sync"
-  end
-end
-```
+When you deploy, simply invoke the experimental:sync Rake task to update the
+experiments in your database from the configuration file:
 
-Include that in the deploy:default task:
 ```ruby
-namespace :deploy do
-  #...
-  task :default do
-    begin
-      update_code
-      migrate
-      database.sync_from_app
-      restart
-    #...
+after 'deploy:updated', 'experimental:sync' do
+  on primary :worker do
+    within release_path do
+      rake experimental:sync
     end
   end
 end

data/Rakefile

@@ -1,19 +1 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'spec'
-  t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = false
-end
-
-
-task :default => :test
+require 'ritual'

data/lib/experimental.rb

@@ -2,12 +2,14 @@ require 'rails'
 require 'experimental/engine'
 
 module Experimental
-  autoload :VERSION, 'experimental/version'
-  autoload :ControllerActions, 'experimental/controller_actions'
+  autoload :Experiment, 'experimental/experiment'
   autoload :Loader, 'experimental/loader'
   autoload :Overrides, 'experimental/overrides'
+  autoload :Population, 'experimental/population'
   autoload :Source, 'experimental/source'
+  autoload :Subject, 'experimental/subject'
   autoload :Test, 'experimental/test'
+  autoload :VERSION, 'experimental/version'
 
   class << self
     def configure(configuration)

data/{app/models → lib}/experimental/experiment.rb

@@ -2,8 +2,9 @@ module Experimental
   class Experiment < ActiveRecord::Base
     extend Population::Filter
 
-    attr_accessible :name, :num_buckets, :notes, :population
-
+    if ActiveRecord::VERSION::MAJOR < 4 || defined?(ProtectedAttributes)
+      attr_accessible :name, :num_buckets, :notes, :population
+    end
 
     validates_presence_of :name, :num_buckets
     validates_numericality_of :num_buckets, :greater_than_or_equal_to => 1
@@ -11,7 +12,7 @@ module Experimental
       :greater_than_or_equal_to => 0,
       :less_than => :num_buckets,
       :if => :ended?
-    validate :has_valid_dates
+    validate :validate_dates
 
     def self.in_code
       where(:removed_at => nil)
@@ -86,9 +87,7 @@ module Experimental
       result = false
 
       unless removed?
-        result = update_attributes(
-          { removed_at: Time.now }, without_protection: true
-        )
+        result = update_attribute(:removed_at, Time.now)
       end
 
       result
@@ -130,15 +129,19 @@ module Experimental
 
     private
 
-    def has_valid_dates
-      %w(start_date end_date).each do |attribute|
+    def validate_dates
+      validate_date 'start_date'
+      validate_date 'end_date'
+    end
+
+    def validate_date(attribute)
         value = read_attribute_before_type_cast(attribute)
+        return if value.blank?
         begin
-          value.try(:to_time)
+          return if value.to_time
         rescue ArgumentError
-          errors.add(attribute, "is not a valid date")
         end
-      end
+        errors.add(attribute, "is not a valid date")
     end
 
     def population_filter

data/lib/experimental/loader.rb

@@ -13,7 +13,7 @@ module Experimental
 
       Experimental::Experiment.transaction do
         active = Experimental.experiment_data.map do |name, attributes|
-          experiment = Experimental::Experiment.find_or_initialize_by_name(name)
+          experiment = Experimental::Experiment.where(name: name).first_or_initialize
 
           unstarted = attributes.delete('unstarted')
           defaults = {'num_buckets' => nil, 'notes' => nil, 'population' => nil}

data/lib/experimental/population.rb

@@ -0,0 +1,7 @@
+module Experimental
+  module Population
+    autoload :Default, 'experimental/population/default'
+    autoload :Filter, 'experimental/population/filter'
+    autoload :NewUsers, 'experimental/population/new_users'
+  end
+end

data/lib/experimental/version.rb

@@ -1,5 +1,5 @@
 module Experimental
-  VERSION = [0, 4, 0]
+  VERSION = [0, 5, 0]
 
   class << VERSION
     include Comparable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: experimental
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - HowAboutWe.com
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,22 +52,16 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- app/models/experimental/experiment.rb
-- app/models/experimental/population/default.rb
-- app/models/experimental/population/filter.rb
-- app/models/experimental/population/new_users.rb
-- app/models/experimental/subject.rb
-- app/views/experimental/_experiment.html.erb
-- app/views/experimental/_index.html.erb
-- app/views/experimental/_links.html.erb
-- app/views/experimental/_new.html.erb
 - config/routes.rb
 - lib/experimental.rb
-- lib/experimental/controller_actions.rb
 - lib/experimental/engine.rb
+- lib/experimental/experiment.rb
 - lib/experimental/loader.rb
-- lib/experimental/middleware.rb
 - lib/experimental/overrides.rb
+- lib/experimental/population.rb
+- lib/experimental/population/default.rb
+- lib/experimental/population/filter.rb
+- lib/experimental/population/new_users.rb
 - lib/experimental/railtie.rb
 - lib/experimental/rspec_helpers.rb
 - lib/experimental/source.rb
@@ -75,6 +69,7 @@ files:
 - lib/experimental/source/base.rb
 - lib/experimental/source/cache.rb
 - lib/experimental/source/configuration.rb
+- lib/experimental/subject.rb
 - lib/experimental/test.rb
 - lib/experimental/test/cucumber.rb
 - lib/experimental/test/rspec.rb
@@ -110,4 +105,3 @@ signing_key:
 specification_version: 4
 summary: Adds support for database-backed AB tests in Rails apps
 test_files: []
-has_rdoc: 

data/app/views/experimental/_experiment.html.erb

@@ -1,16 +0,0 @@
-<tr>
-  <td><%= experiment.name.humanize %></td>
-  <td><%= "#{experiment.num_buckets} (0-#{experiment.num_buckets-1})" %></td>
-  <td><%= experiment.population || "default" %></td>
-  <td><%= experiment.notes.try(:gsub, "\n", '<br>').try(:html_safe) %></td>
-  <td><%= experiment.start_date.try(:in_time_zone).try(:strftime, "%D %r %Z") %></td>
-  <% if @include_inactive %>
-    <td><%= experiment.winning_bucket %></td>
-    <td><%= experiment.end_date.try(:in_time_zone).try(:strftime, "%D %r %Z") %></td>
-    <td><%= experiment.removed_at.try(:in_time_zone).try(:strftime, "%D %r %Z") %></td>
-  <% else %>
-    <td>
-      <%= hidden_field_tag "exp-#{experiment.id}", experiment.id %>
-      <%= select_tag "exp-#{experiment.id}-buckets", options_for_select((0..experiment.num_buckets-1).to_a.insert(0, ['-- select --', -1])), class: 'set_winner' %>
-    </td>
-  <% end %>

data/app/views/experimental/_index.html.erb

@@ -1,50 +0,0 @@
-<h1><%= @h1 %></h1>
-
-<table>
-  <thead>
-    <tr>
-      <th scope="col"> Name </th>
-      <th scope="col"> Buckets </th>
-      <th scope="col"> Population </th>
-      <th scope="col"> Notes </th>
-      <th scope="col"> Start </th>
-      <th scope="col"> Winner </th>
-      <% if @include_inactive %>
-        <th scope="col"> End </th>
-        <th scope="col"> Removed </th>
-      <% end %>
-    </tr>
-  </thead>
-  <tbody>
-  <%= render partial: 'experimental/experiment', collection: @experiments %>
-  </tbody>
-</table>
-
-<script type="text/javascript">
-  $(function(){
-    $(".set_winner").change(function(){
-      var bucket_id = $(this).val();
-      var msg = "Are you sure you want to end this experiment and set the winning bucket to " + bucket_id;
-
-      if( bucket_id > -1 && confirm(msg) ){
-        var exp_id = $(this).siblings().val(); 
-
-        $.ajax({
-          type: "POST",
-          data: {id:exp_id, bucket_id:bucket_id},
-          url: '<%= @experimental_path_names.set_winner %>',
-          success: function(resp){
-            window.location.reload();
-          },
-          error: function(){
-            alert("WE BLEW UP!");
-            $(this).val(-1);
-          }
-        });
-      }
-      else{
-        $(this).val(-1);
-      }
-    });
-  });
-</script>

data/app/views/experimental/_links.html.erb

@@ -1,7 +0,0 @@
-<div class="experiment_links">
-  <%= link_to "In-progress", @experimental_path_names.index %>
-  |
-  <%= link_to "Ended or Removed", @experimental_path_names.inactive %>
-  |
-  <%= link_to "Create New Experiment", @experimental_path_names.new %>
-</div>

data/app/views/experimental/_new.html.erb

@@ -1,37 +0,0 @@
-<h1> New Experiment</h1>
-<br />
-<%= form_for(@experiment, url: @experimental_path_names.index) do |f| %>
-  <% if @experiment.errors.any? %>
-    <div id="error_explanation">
-      <h2>
-        <%= pluralize(@experiment.errors.count, "error") %>
-        probited this experiment from being saved:
-      </h2>
-      <ul>
-        <% @experiment.errors.full_messages.each do |msg| %>
-          <li><%= msg %></li>
-        <% end %>
-      </ul>
-    </div>
-  <% end %>
-
-  <p class="field">
-    <%= f.label :name %>
-    <br />
-    <%= f.text_field :name %>
-  </p>
-  <p class="field">
-    <%= f.label :num_buckets %>
-    <br />
-    <%= f.text_field :num_buckets %>
-  </p>
-  <p class="field">
-    <%= f.label :notes %>
-    <br />
-    <%= f.text_area :notes, cols: "30", rows: "5" %>
-  </p>
-
-  <p class="actions" >
-    <%= f.submit %>
-  </p>
-<% end %>

data/lib/experimental/controller_actions.rb

@@ -1,90 +0,0 @@
-require 'ostruct'
-
-module Experimental
-  module ControllerActions
-    extend ActiveSupport::Concern
-
-    included do
-      class_eval do
-        attr_writer :base_resource_name
-
-        respond_to :json, :only => [:set_winner]
-
-        before_filter :set_experimental_path_names
-      end
-    end
-
-    def base_resource_name
-      @base_resource_name ||= "experiment"
-    end
-
-    def set_experimental_path_names
-      @experimental_path_names = OpenStruct.new
-      plural_path = "#{base_resource_name.pluralize}_path"
-
-      @experimental_path_names.index = self.send(plural_path.to_sym)
-      if self.respond_to?("inactive_#{plural_path}".to_sym)
-        @experimental_path_names.inactive = self.send("inactive_#{plural_path}".to_sym)
-      end
-      @experimental_path_names.new = self.send("new_#{base_resource_name}_path".to_sym)
-      @experimental_path_names.set_winner = self.send("set_winner_#{plural_path}".to_sym)
-    end
-
-    def experimental_path_names
-      set_experimental_path_names if @experimental_path_names.nil?
-      @experimental_path_names
-    end
-
-    def experiments_index
-      @h1 = "In-progress Experiments"
-      @include_inactive = false
-      @experiments = Experiment.in_progress
-    end
-
-    def experiments_new
-      @experiment = Experiment.new
-    end
-
-    def experiments_create
-      @experiment = Experiment.new(params[:experimental_experiment])
-      @experiment.admin = true
-      @experiment.start_date = Time.now
-
-      if @experiment.save
-        flash[:notice] = "Experiment was successfully created."
-        return true
-      else
-        flash.now[:error] = "There was an error!"
-        return false
-      end
-    end
-
-    def experiments_inactive
-      @h1 = "Ended or Removed Experiments"
-      @include_inactive = true
-      @experiments = Experiment.ended_or_removed
-    end
-
-    def create
-      if experiments_create
-        redirect_to experimental_path_names.index
-      else
-        render :new
-      end
-    end
-
-    def inactive
-      experiments_inactive
-      render :index
-    end
-
-    def experiments_set_winner
-      exp = Experiment.find params[:id]
-      if exp.end(params[:bucket_id])
-        render json: nil, status: :ok
-      else
-        render json: nil, status: :error
-      end
-    end
-  end
-end

data/lib/experimental/middleware.rb

@@ -1,11 +0,0 @@
-module Experimental
-  class Middleware
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      @app.call(env)
-    end
-  end
-end