laboratory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fddd4e5310fe374f6dce5c3662d4e171987a3aa1cd180fca0f4123890c74ff74
-  data.tar.gz: 22957e0e5595b93d4005dac1329f87ccc78428576a1b4519e7634edcb405eac3
+  metadata.gz: '028eeacc314798c88a5a6b5b3db37754751dbe90e18907c130ff2f517685f09e'
+  data.tar.gz: 526145857a0786d662f06b8204c6854c5618f3150286eb19e8ae1e2022e1b17e
 SHA512:
-  metadata.gz: 9ed204a1530ce008417f27407188a102982d77ec175f62fd0f117b9035c8f091f08700572798f9071ac2c352e5f199e8e6a53f114864005622e054beb69073a6
-  data.tar.gz: b0fbec760e8b1187ed5917b4d9e7ddd936e9b7caebc2f89738ed4d09fe6688a9343394eb2fac7e18f13b6ef0821226f6cfc4d4e6be39ccf3d4e12afe628dfdfd
+  metadata.gz: 5b7942166dc0dca4cc5c900ddde6c98dc9734eb390c776e309a24598eb10b7e1f07f518d941b4b47aeea81928ffb925176bb199d804cdc5ad061661c8bb6e98f
+  data.tar.gz: f08de0e7e5d841cb6d6be5cc3be9de9c34f9f1f85c0173e95f76a786c4a2eefebb05322b3a2e6b65a4643dd5ae9c8ff7ead830e98573f38b5edb8cafca170365

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    laboratory (0.1.0)
+    laboratory (0.1.1)
       redis (>= 2.1)
+      sinatra (>= 1.2.6)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +11,13 @@ GEM
     diff-lcs (1.3)
     fakeredis (0.8.0)
       redis (~> 4.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
     rake (12.3.3)
     redis (4.1.3)
     rspec (3.9.0)
@@ -25,6 +33,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    ruby2_keywords (0.0.2)
+    sinatra (2.0.8.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.8.1)
+      tilt (~> 2.0)
+    tilt (2.0.10)
 
 PLATFORMS
   ruby
@@ -32,6 +47,7 @@ PLATFORMS
 DEPENDENCIES
   fakeredis (~> 0.8)
   laboratory!
+  rack-test (~> 1.1)
   rake (~> 12.0)
   rspec (~> 3.8)
 

data/README.md

@@ -11,12 +11,14 @@ Laboratory is an A/B testing and Feature Flag framework for Rails. It's focused
 * Simplicity, while not being simplisitic
   * Laboratory comes with a single A/B test algorithm and single storage adapter built-in, which we think will cover 99% of use cases for A/B testing and Feature Flagging. If you're in that 1%, it's easy to extend Laboratory to add custom Algorithms and Storage mechanisms.
 
+Laboratory builds upon great work from other gems, in particular [Split](https://github.com/splitrb/split).
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'laboratory'
+gem 'laboratory', require: 'laboratory/ui'
 ```
 
 And then execute:
@@ -35,7 +37,7 @@ Or install it yourself as:
 In an initializer (`app/config/initializers/laboratory.rb`), define the adapter you are going to use with Laboratory. Laboratory supports Redis out of the box, as it the recommended adapter:
 
 ```ruby
-Laboratory::Config.adapter = Laboratory::Adapters::RedisAdapter.new(url: 'redis://localhost:6789') # Adjust to your redis URL.
+Laboratory.config.adapter = Laboratory::Adapters::RedisAdapter.new(url: 'redis://localhost:6789') # Adjust to your redis URL.
 ```
 
 ### Defining your current_user_id & actor
@@ -51,11 +53,11 @@ class ApplicationController
   before_action :set_laboratory_actor
 
   def set_laboratory_current_user_id
-    Laboratory::Config.current_user_id = your_current_user_id
+    Laboratory.config.current_user_id = your_current_user_id
   end
 
   def set_laboratory_actor
-    Laboratory::Config.actor = 'Tom Jones'
+    Laboratory.config.actor = 'Tom Jones'
   end
 ```
 
@@ -144,7 +146,7 @@ It's common to trigger analytics events upon common actions like a user being as
 **When a user gets assigned to a variant**:
 
 ```ruby
-Laboratory::Config.on_assignment_to_variant = -> (experiment, variant, user) {
+Laboratory.config.on_assignment_to_variant = -> (experiment, variant, user) {
   ...
 }
 ```
@@ -152,7 +154,7 @@ Laboratory::Config.on_assignment_to_variant = -> (experiment, variant, user) {
 **When an event is recorded**:
 
 ```ruby
-Laboratory::Config.on_event_recorded = -> (experiment, variant, user, event) {
+Laboratory.config.on_event_recorded = -> (experiment, variant, user, event) {
   ...
 }
 ```
@@ -210,18 +212,13 @@ Note: This would wipe all users from the experiment.
 
 ```ruby
 experiment = Laboratory::Experiment.find('blue_button_cta')
-variants = [
-  {
-    id: 'control',
-    percentage: 40
-  },
-  {
-    id: 'variant_a',
-    percentage: 60
-  }
-]
-
-experiment.update(variants: new_variants)
+control = experiment.variants.find { |variant| variant.id == 'control' }
+variant_a = experiment.variants.find { |variant| variant.id == 'variant_a' }
+
+control.percentage = 30
+variant_a.percentage = 70
+
+experiment.save
 ```
 
 **Finding the current user**:
@@ -229,7 +226,7 @@ experiment.update(variants: new_variants)
 The following will return a Laboratory::User object with the user id matching the current_user_id defined in the Laboratory configuration.
 
 ```ruby
-Laboratory::Config.current_user
+Laboratory.config.current_user
 ```
 
 

data/laboratory.gemspec

@@ -26,7 +26,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'redis', '>= 2.1'
+  spec.add_dependency 'sinatra', '>= 1.2.6'
 
+  spec.add_development_dependency 'rack-test',   '~> 1.1'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'fakeredis', '~> 0.8'
 end

data/lib/laboratory/adapters/redis_adapter.rb

@@ -15,7 +15,6 @@ module Laboratory
 
       def write(experiment)
         redis.set(redis_key(experiment_id: experiment.id), experiment_to_json(experiment))
-
         # Write to ALL_EXPERIMENTS_KEY_KEY if it isn't already there.
         experiment_ids = JSON.parse(redis.get(ALL_EXPERIMENTS_KEYS_KEY))
         experiment_ids << experiment.id unless experiment_ids.include?(experiment.id)
@@ -118,11 +117,10 @@ module Laboratory
 
       def parse_json_to_experiment_changelog_items(changelog_json)
         changelog_json.map do |json|
-          Experiment::ChangelogItems.new(
-            action: json[:action],
-            changes: json[:changes],
-            timestamp: json[:timestamp],
-            actor: json[:actor]
+          Experiment::ChangelogItem.new(
+            changes: json['changes'],
+            timestamp: json['timestamp'],
+            actor: json['actor']
           )
         end
       end

data/lib/laboratory/calculations/confidence_level.rb

@@ -0,0 +1,40 @@
+module Laboratory
+  module Calculations
+    module ConfidenceLevel
+      def self.calculate(n1:, p1:, n2:, p2:)
+        cvr1 = p1.fdiv(n1)
+        cvr2 = p2.fdiv(n2)
+
+        z = ZScore.calculate(
+          n1: n1,
+          p1: cvr1,
+          n2: n2,
+          p2: cvr2
+        )
+
+        percentage_from_z_score(-z).round(4)
+      end
+
+      def self.percentage_from_z_score(z)
+        return 0 if z < -6.5
+        return 1 if z > 6.5
+
+        factk = 1
+        sum = 0
+        term = 1
+        k = 0
+
+        loop_stop = Math.exp(-23)
+        while term.abs > loop_stop do
+          term = 0.3989422804 * ((-1)**k) * (z**k) / (2 * k + 1) / (2**k) * (z**(k + 1)) / factk
+          sum += term
+          k += 1
+          factk *= k
+        end
+
+        sum += 0.5
+        1 - sum
+      end
+    end
+  end
+end

data/lib/laboratory/calculations/z_score.rb

@@ -0,0 +1,41 @@
+module Laboratory
+  module Calculations
+    module ZScore
+      include Math
+
+      # n: Total population
+      # p: conversion percentage
+
+      def self.calculate(n1:, p1:, n2:, p2:)
+        p_1 = p1.to_f
+        p_2 = p2.to_f
+
+        n_1 = n1.to_f
+        n_2 = n2.to_f
+
+        # Formula for standard error: root(pq/n) = root(p(1-p)/n)
+        s_1 = Math.sqrt(p_1 * (1 - p_1) / n_1)
+        s_2 = Math.sqrt(p_2 * (1 - p_2) / n_2)
+
+        # Formula for pooled error of the difference of the means: root(π*(1-π)*(1/na+1/nc)
+        # π = (xa + xc) / (na + nc)
+        pi = (p_2 * n_2 + p_1 * n_1) / (n_2 + n_1)
+        s_p = Math.sqrt(pi * (1 - pi) * (1 / n_2 + 1 / n_1))
+
+        # Formula for unpooled error of the difference of the means: root(sa**2/na + sc**2/nc)
+        s_unp = Math.sqrt(s_2**2 + s_1**2)
+
+        # Boolean variable decides whether we can pool our variances
+        pooled = s_2 / s_1 < 2 && s_1 / s_2 < 2
+
+        # Assign standard error either the pooled or unpooled variance
+        se = pooled ? s_p : s_unp
+
+        # Calculate z-score
+        z_score = (p_2 - p_1) / (se)
+
+        z_score.round(4)
+      end
+    end
+  end
+end

data/lib/laboratory/experiment/analysis_summary.rb

@@ -0,0 +1,72 @@
+module Laboratory
+  class Experiment
+    class AnalysisSummary
+      attr_reader :experiment, :event_id
+
+      def initialize(experiment, event_id)
+        @experiment = experiment
+        @event_id = event_id
+      end
+
+      def highest_performing_variant
+        sorted_variants.first
+      end
+
+      def lowest_performing_variant
+        sorted_variants.last
+      end
+
+      def performance_delta_between_highest_and_lowest
+        numerator = (conversion_rate_for_variant(highest_performing_variant) -
+          conversion_rate_for_variant(lowest_performing_variant))
+        denominator = conversion_rate_for_variant(lowest_performing_variant)
+        numerator.fdiv(denominator).round(2)
+      end
+
+      def confidence_level_in_performance_delta
+        Laboratory::Calculations::ConfidenceLevel.calculate(
+          n1: participant_count_for_variant(lowest_performing_variant),
+          p1: event_total_count_for_variant(lowest_performing_variant),
+          n2: participant_count_for_variant(highest_performing_variant),
+          p2: event_total_count_for_variant(highest_performing_variant)
+        )
+      end
+
+      private
+
+      def participant_count_for_variant(variant)
+        variant.participant_ids.count
+      end
+
+      def event_total_count_for_variant(variant)
+        event = event_for_variant(variant)
+        event.event_recordings.count
+      end
+
+      def conversion_rate_for_variant(variant)
+        event_total_count_for_variant(variant)
+          .fdiv(participant_count_for_variant(variant))
+      end
+
+      def relevant_variants
+        experiment.variants.select do |variant|
+          variant.events.any? do |event|
+            event.id == event_id
+          end
+        end
+      end
+
+      def sorted_variants
+        relevant_variants.sort_by { |variant|
+          conversion_rate_for_variant(variant)
+        }.reverse
+      end
+
+      def event_for_variant(variant)
+        variant.events.find do |event|
+          event.id == event_id
+        end
+      end
+    end
+  end
+end

data/lib/laboratory/experiment/changelog_item.rb

@@ -1,10 +1,9 @@
 module Laboratory
   class Experiment
     class ChangelogItem
-      attr_reader :action, :changes, :timestamp, :actor
+      attr_reader :changes, :timestamp, :actor
 
-      def initialize(action:, changes: [], timestamp:, actor:)
-        @action = action
+      def initialize(changes:, timestamp:, actor:)
         @changes = changes
         @timestamp = timestamp
         @actor = actor

data/lib/laboratory/experiment/variant.rb

@@ -1,18 +1,34 @@
 module Laboratory
   class Experiment
     class Variant
-      attr_reader :id, :percentage, :participant_ids, :events
+      attr_accessor :id, :percentage
+      attr_reader(
+        :_original_id,
+        :_original_percentage,
+        :participant_ids,
+        :events
+      )
 
       def initialize(id:, percentage:, participant_ids: [], events: [])
         @id = id
         @percentage = percentage
         @participant_ids = participant_ids
         @events = events
+
+        @_original_id = id
+        @_original_percentage = percentage
       end
 
       def add_participant(user)
         participant_ids << user.id
       end
+
+      def changeset
+        set = {}
+        set[:id] = [_original_id, id] if _original_id != id
+        set[:percentage] = [_original_percentage, percentage] if _original_percentage != percentage
+        set
+      end
     end
   end
 end

data/lib/laboratory/experiment.rb

@@ -7,7 +7,13 @@ module Laboratory
     class InvalidExperimentVariantFormatError < StandardError; end
     class IncorrectPercentageTotalError < StandardError; end
 
-    attr_reader :id, :variants, :algorithm, :changelog
+    attr_accessor :id, :algorithm
+    attr_reader(
+      :_original_id,
+      :_original_algorithm,
+      :variants,
+      :changelog
+    )
 
     def initialize(id:, variants:, algorithm: Algorithms::Random, changelog: [])
       @id = id
@@ -30,6 +36,9 @@ module Laboratory
             )
           end
         end
+
+      @_original_id = id
+      @_original_algorithm = algorithm
     end
 
     def self.all
@@ -39,21 +48,13 @@ module Laboratory
     def self.create(id:, variants:, algorithm: Algorithms::Random)
       raise ClashingExperimentIdError if find(id)
 
-      changelog_item = Laboratory::Experiment::ChangelogItem.new(
-        action: :create,
-        changes: [],
-        timestamp: Time.now,
-        actor: Laboratory::Config.actor
-      )
-
       experiment = Experiment.new(
         id: id,
         variants: variants,
-        algorithm: algorithm,
-        changelog: [changelog_item]
+        algorithm: algorithm
       )
 
-      experiment.write!
+      experiment.save
       experiment
     end
 
@@ -65,62 +66,23 @@ module Laboratory
       find(id) || create(id: id, variants: variants, algorithm: algorithm)
     end
 
-    def update(attrs)
-      # delete previous key if valid? passes below.
-      old_id = id
-
-      # Diff changes
-
-      current_hash = {
-        id: id,
-        variants: variants.map { |variant|
-          {
-            id: variant.id,
-            percentage: variant.percentage
-          }
-        },
-        algorithm: algorithm
-      }
-
-      updated_variants_subhash = attrs[:variants]&.map do |variant|
-        {
-          id: variant[:id],
-          percentage: variant[:percentage]
-        }
-      end
-
-      updated_hash = {
-        id: attrs[:id] || id,
-        variants: updated_variants_subhash || current_hash[:variants],
-        algorithm: attrs[:algorithm] || algorithm
-      }
-
-      changes = current_hash.to_a - updated_hash.to_a
-      @id = attrs[:id] if !attrs[:id].nil?
-      @variants = attrs[:variants] if !attrs[:variants].nil?
-      @algorithm = attrs[:algorithm] if !attrs[:algorithm].nil?
-
-      raise errors.first unless valid?
-
-      changelog_item = Laboratory::Experiment::ChangelogItem.new(
-        action: :update,
-        changes: changes,
-        timestamp: Time.now,
-        actor: Laboratory.config.actor
-      )
-
-      @changelog << changelog_item
-
-      Laboratory.config.adapter.delete(old_id)
-      write!
-      self
-    end
-
     def delete
       Laboratory.config.adapter.delete(id)
       nil
     end
 
+    def reset
+      @variants = variants.map do |variant|
+        Variant.new(
+          id: variant.id,
+          percentage: variant.percentage,
+          participant_ids: [],
+          events: []
+        )
+      end
+      save
+    end
+
     def variant(user: Laboratory.config.current_user)
       selected_variant = variants.find { |variant| variant.participant_ids.include?(user.id)}
       return selected_variant if !selected_variant.nil?
@@ -130,7 +92,7 @@ module Laboratory
 
       Laboratory::Config.on_assignment_to_variant&.call(self, variant, user)
 
-      write!
+      save
       variant
     end
 
@@ -144,7 +106,7 @@ module Laboratory
 
       Laboratory::Config.on_assignment_to_variant&.call(self, variant, user)
 
-      write!
+      save
       variant
     end
 
@@ -154,7 +116,7 @@ module Laboratory
 
       maybe_event = variant.events.find { |event| event.id == event_id }
       event =
-        if maybe_event != nil
+        if !maybe_event.nil?
           maybe_event
         else
           e = Event.new(id: event_id)
@@ -167,12 +129,25 @@ module Laboratory
 
       Laboratory::Config.on_event_recorded&.call(self, variant, user, event)
 
-      write!
+      save
       event_recording
     end
 
-    def write!
+    def analysis_summary_for(event_id)
+      Experiment::AnalysisSummary.new(self, event_id)
+    end
+
+    def save
       raise errors.first unless valid?
+      unless changeset.empty?
+        changelog_item = Laboratory::Experiment::ChangelogItem.new(
+          changes: changeset,
+          timestamp: Time.now,
+          actor: Laboratory::Config.actor
+        )
+
+        @changelog << changelog_item
+      end
       Laboratory.config.adapter.write(self)
     end
 
@@ -188,6 +163,24 @@ module Laboratory
       !id.nil? && !algorithm.nil? && valid_variants && valid_percentage_amounts
     end
 
+    private
+
+    def changeset
+      set = {}
+      set[:id] = [_original_id, id] if _original_id != id
+      set[:algorithm] = [_original_algorithm, algorithm] if _original_algorithm != algorithm
+
+      variants_changeset = variants.map { |variant|
+        { variant.id => variant.changeset }
+      }
+      variants_changeset.reject! do |change|
+        change.values.all?(&:empty?)
+      end
+
+      set[:variants] = variants_changeset unless variants_changeset.empty?
+      set
+    end
+
     def errors
       errors = []
 

data/lib/laboratory/ui/helpers.rb

@@ -0,0 +1,34 @@
+module Laboratory
+  module UIHelpers
+    def url(*path_parts)
+      [ path_prefix, path_parts ].join("/").squeeze('/')
+    end
+
+    def path_prefix
+      request.env['SCRIPT_NAME']
+    end
+
+    def experiment_url(experiment)
+      url('experiments', experiment.id, 'edit')
+    end
+
+    def update_percentages_url(experiment)
+      url('experiments', experiment.id, 'update_percentages')
+    end
+
+    def assign_users_to_variant_url(experiment)
+      url('experiments', experiment.id, 'assign_users')
+    end
+
+    def reset_experiment_url(experiment)
+      url('experiments', experiment.id, 'reset')
+    end
+
+    def analysis_summary(experiment, event_id)
+      analysis = experiment.analysis_summary_for(event_id)
+      return if analysis.highest_performing_variant == analysis.lowest_performing_variant
+
+      "#{analysis.highest_performing_variant.id} is performing #{analysis.performance_delta_between_highest_and_lowest * 100}% better than #{analysis.lowest_performing_variant.id}. I'm #{analysis.confidence_level_in_performance_delta * 100}% certain of this."
+    end
+  end
+end

data/lib/laboratory/ui/public/reset.css

@@ -0,0 +1,48 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+dl, dt, dd, ul, li,
+form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  outline: 0;
+  font-weight: inherit;
+  font-style: normal;
+  font-size: 100%;
+  font-family: inherit;
+}
+
+:focus {
+  outline: 0;
+}
+
+body {
+  line-height: 1;
+}
+
+ul {
+  list-style: none;
+}
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+caption, th, td {
+  text-align: left;
+  font-weight: normal;
+}
+
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: "";
+}
+
+blockquote, q {
+  quotes: "" "";
+}

data/lib/laboratory/ui/public/style.css

@@ -0,0 +1,102 @@
+html, body {
+  height: 100%;
+  margin: 0;
+}
+
+body {
+  font-family: 'Verdana';
+  background-color: #EEEEEE;
+  color: #383B66;
+  line-height: 2rem;
+}
+
+h1 {
+  font-weight: bold;
+  font-size: 4rem;
+}
+
+h3 {
+  font-weight: bold;
+  font-size: 2rem;
+}
+
+h5 {
+  font-weight: bold;
+  font-size: 1rem;
+}
+
+.main {
+  min-height: 100%;
+  margin: 0 auto -30px;
+}
+
+.content {
+  padding: 40px;
+}
+
+.footer {
+  height: 30px;
+  padding-left: 40px;
+}
+
+.header {
+  margin-bottom: 2rem;
+}
+
+.experiment {
+  margin-bottom: 2rem;
+  padding: 1rem;
+  border: 0.1rem dashed #DDDDDD;
+  border-radius: 1rem;
+}
+
+.experiment-title {
+}
+
+.experiment-sections {
+  margin-top: 1rem;
+}
+
+.experiment-section:not(:last-child) {
+  margin-bottom: 1rem;
+}
+
+.experiment-section-title {
+  margin-bottom: 1rem;
+}
+
+.experiment-table {
+  display: flex;
+  flex-direction: column;
+}
+
+.experiment .row {
+  flex: 1;
+  display: flex;
+  flex-direction: row;
+  margin-bottom: 0.5rem;
+}
+
+.experiment .row.header {
+  padding-bottom: 0.3rem;
+  border-bottom: 0.05rem solid #CCCCCC
+}
+
+.experiment .row .column {
+  flex: 1;
+}
+
+.experiment .row .column:not(:last-child) {
+  flex-basis: 15rem;
+  flex-grow: 0;
+}
+
+.user-id-input-form {
+
+}
+
+.user-id-input-form label {
+  display: block
+}
+
+

data/lib/laboratory/ui/views/_experiment.erb

@@ -0,0 +1,86 @@
+<% all_experiment_event_ids = experiment.variants.flat_map(&:events).map(&:id).uniq %>
+
+<div class="experiment">
+  <h3 class='experiment-title'>Experiment: <%= experiment.id %></h3>
+  <div class='experiment-sections'>
+    <div class='experiment-section'>
+      <h5 class='experiment-section-title'>Summary</h5>
+      <div class='experiment-table'>
+        <div class="row header">
+          <div class='column'>
+            Variant
+          </div>
+          <div class='column'>
+            Percentage
+          </div>
+          <div class='column'>
+            Number of participants
+          </div>
+        </div>
+        <% experiment.variants.each do |variant| %>
+          <div class="row">
+            <div class='column'>
+              <%= variant.id %>
+            </div>
+            <div class='column'>
+              <%= variant.percentage %>%
+            </div>
+            <div class='column'>
+              <%= variant.participant_ids.count %>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    </div>
+
+    <% all_experiment_event_ids.each do |event_id| %>
+      <div class='experiment-section'>
+        <h5 class='experiment-section-title'>Event: <%= event_id %></h5>
+        <p><%= analysis_summary(experiment, event_id) %>
+        <div class='experiment-table'>
+          <div class="row header">
+            <div class='column'>
+              Variant
+            </div>
+            <div class='column'>
+              Number of participants
+            </div>
+            <div class="column">
+              Number of event instances
+            </div>
+            <div class='column'>
+              Conversion Rate
+            </div>
+          </div>
+          <% experiment.variants.each do |variant| %>
+            <div class="row">
+              <div class='column'>
+                <%= variant.id %>
+              </div>
+              <div class='column'>
+                <%= variant.participant_ids.count %>
+              </div>
+              <% if variant.events.map(&:id).include?(event_id) %>
+                <% event = variant.events.find { |event| event.id == event_id } %>
+                <div class="column">
+                  <%= event.event_recordings.count %>
+                </div>
+                <div class="column">
+                  <%= ((event.event_recordings.count.fdiv(variant.participant_ids.count)) * 100).round(2) %>%
+                </div>
+              <% else %>
+                <div class='column'>
+                  0
+                </div>
+                <div class='column'>
+                  N/A
+                </div>
+              <% end %>
+            </div>
+          <% end %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+  <a href="<%= experiment_url(experiment) %>">Edit Experiment</a>
+</div>

data/lib/laboratory/ui/views/edit.erb

@@ -0,0 +1,61 @@
+<div class="experiment">
+  <h3 class='experiment-title'>Experiment: <%= @experiment.id %></h3>
+  <div class='experiment-sections'>
+    <div class='experiment-section'>
+      <h5 class='experiment-section-title'>Proportions</h5>
+      <div class='experiment-table'>
+        <div class="row header">
+          <div class='column'>
+            Variant
+          </div>
+          <div class='column'>
+            Percentage
+          </div>
+        </div>
+        <form method='post' action="<%= update_percentages_url(@experiment) %>">
+          <% @experiment.variants.each do |variant| %>
+            <div class="row">
+              <div class='column'>
+                <%= variant.id %>
+              </div>
+              <div class='column'>
+                <input name="variants[<%= variant.id %>]" type="number" placeholder="percentage" value="<%= variant.percentage %>" />
+              </div>
+            </div>
+          <% end %>
+          <input type="submit" value='Save' />
+        </form>
+      </div>
+    </div>
+
+    <div class='experiment-section'>
+      <h5 class='experiment-section-title'>Assign users to variant</h5>
+      <form class='user-id-input-form' method='post' action="<%= assign_users_to_variant_url(@experiment) %>">
+        <div class='input-group'>
+          <label for='variant'>Variant:</label>
+          <select name='variant_id' id='variant'>
+            <% @experiment.variants.each do |variant| %>
+              <option value="<%= variant.id %>"><%= variant.id %></option>
+            <% end %>
+          </select>
+        </div>
+        <div class='input-group'>
+          <label for='user_ids'>User IDs:</label>
+          <textarea name='user_ids' class='user_ids' placeholder="one user id per line" cols='50' rows='10'></textarea>
+        </div>
+        <div class='input-group'>
+          <input type="submit" value='Assign users' />
+        </div>
+      </form>
+    </div>
+
+    <div class='experiment-section'>
+      <h5 class='experiment-section-title'>Reset experiment</h5>
+      <form class='user-id-input-form' method='post' action="<%= reset_experiment_url(@experiment) %>">
+        <div class='input-group'>
+          <input type="submit" value='Reset Experiment' onclick="return confirm('Are you sure you want to reset this experiment?');" />
+        </div>
+      </form>
+    </div>
+  </div>
+</div>

data/lib/laboratory/ui/views/index.erb

@@ -0,0 +1,8 @@
+<% if @experiments.any? %>
+  <% @experiments.each do |experiment| %>
+    <%= erb :_experiment, locals: { experiment: experiment } %>
+  <% end %>
+<% else %>
+  <p class="intro">No experiments have started yet, you need to define them in your code and introduce them to your users.</p>
+  <p class="intro">Check out the <a href='https://github.com/butternutbox/laboratory#readme'>Readme</a> for more help getting started.</p>
+<% end %>

data/lib/laboratory/ui/views/layout.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
+<link href="<%= url 'reset.css' %>" media="screen" rel="stylesheet" type="text/css">
+<link href="<%= url 'style.css' %>" media="screen" rel="stylesheet" type="text/css">
+<title>Laboratory</title>
+
+</head>
+<body>
+  <div class="main">
+    <div class='content'>
+      <div class="header">
+        <h1>Laboratory 🧪</h1>
+      </div>
+      <%= yield %>
+    </div>
+  </div>
+
+  <div class="footer">
+    <p>Powered by <a href="https://github.com/butternutbox/laboratory">Laboratory</a> 🧪. Handmade with love by your friends at <a href="https://github.com/butternutbox">Butternut Box</a> ❤️</p>
+  </div>
+</body>
+</html>

data/lib/laboratory/ui.rb

@@ -0,0 +1,59 @@
+require 'sinatra/base'
+require 'laboratory'
+require 'laboratory/ui/helpers'
+
+module Laboratory
+  class UI < Sinatra::Base
+    dir = File.dirname(File.expand_path(__FILE__))
+
+    set :views, "#{dir}/ui/views"
+    set :public_folder, "#{dir}/ui/public"
+    set :static, true
+    set :method_override, true
+
+    helpers Laboratory::UIHelpers
+
+    get '/' do
+      @experiments = Laboratory::Experiment.all
+      erb :index
+    end
+
+    get '/experiments/:id/edit' do
+      @experiment = Laboratory::Experiment.find(params[:id])
+      erb :edit
+    end
+
+    # params = {variants: { control => 40, variant_a => 60 }}
+    post '/experiments/:id/update_percentages' do
+      experiment = Laboratory::Experiment.find(params[:id])
+
+      params[:variants].each do |variant_id, percentage|
+        variant = experiment.variants.find { |v| v.id == variant_id }
+        variant.percentage = percentage.to_i
+      end
+
+      experiment.save
+      redirect experiment_url(experiment)
+    end
+
+    # params = {variant_id: 'control', user_ids: []}
+    post '/experiments/:id/assign_users' do
+      experiment = Laboratory::Experiment.find(params[:id])
+      variant = experiment.variants.find { |v| v.id == params[:variant_id] }
+      user_ids = params[:user_ids].split("\r\n")
+
+      user_ids.each do |user_id|
+        user = Laboratory::User.new(id: user_id)
+        experiment.assign_to_variant(variant.id, user: user)
+      end
+
+      redirect experiment_url(experiment)
+    end
+
+    post '/experiments/:id/reset' do
+      experiment = Laboratory::Experiment.find(params[:id])
+      experiment.reset
+      redirect experiment_url(experiment)
+    end
+  end
+end

data/lib/laboratory/version.rb

@@ -1,3 +1,3 @@
 module Laboratory
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/laboratory.rb

@@ -10,6 +10,9 @@ require 'laboratory/experiment/variant'
 require 'laboratory/experiment/changelog_item'
 require 'laboratory/experiment/event'
 require 'laboratory/experiment/event/recording'
+require 'laboratory/experiment/analysis_summary'
+require 'laboratory/calculations/z_score'
+require 'laboratory/calculations/confidence_level'
 
 module Laboratory
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: laboratory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Niall Paterson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -76,12 +104,23 @@ files:
 - lib/laboratory/adapters/redis_adapter.rb
 - lib/laboratory/algorithms.rb
 - lib/laboratory/algorithms/random.rb
+- lib/laboratory/calculations/confidence_level.rb
+- lib/laboratory/calculations/z_score.rb
 - lib/laboratory/config.rb
 - lib/laboratory/experiment.rb
+- lib/laboratory/experiment/analysis_summary.rb
 - lib/laboratory/experiment/changelog_item.rb
 - lib/laboratory/experiment/event.rb
 - lib/laboratory/experiment/event/recording.rb
 - lib/laboratory/experiment/variant.rb
+- lib/laboratory/ui.rb
+- lib/laboratory/ui/helpers.rb
+- lib/laboratory/ui/public/reset.css
+- lib/laboratory/ui/public/style.css
+- lib/laboratory/ui/views/_experiment.erb
+- lib/laboratory/ui/views/edit.erb
+- lib/laboratory/ui/views/index.erb
+- lib/laboratory/ui/views/layout.erb
 - lib/laboratory/user.rb
 - lib/laboratory/version.rb
 homepage: https://github.com/butternutbox/laboratory