split-export 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eb50c9d3b73cdee33dbc24f31fd16ffed14db47
-  data.tar.gz: 992e61be20fe22fbe0d66c498acd666c489f1e14
+  metadata.gz: 5a3924dc7806addaed71fd465447688c864c6c19
+  data.tar.gz: d58689307780d65717c55729771986f78a942a4a
 SHA512:
-  metadata.gz: c6040350a4a1faa7c022e7ad81c01bc0804abc46540f3da7aaf239df0aeadfc32391dad5d6a99a0ee9e92c6340e978ad0e60417d9edbd27695ba79972e5054cc
-  data.tar.gz: 184e50d61b67432c132eb54e5e6c36e4de2f0dea93f822451a3a731d77678fd462b6c7fd1fd07534d45561aed51644500d7d0a5164e236b0fde68f426cae3ce0
+  metadata.gz: fafaabcf0f9e880e6954a99782fa2fdec20f11e84741a375c563a021a4d56345b50778f1099659300c62c6b0279bdefea03351a4bbaefeb1ef9e8a4b717b9963
+  data.tar.gz: 8cec501deac0ebced73ea509ce4afcb89ccecde1c776ff9e0cddfbe3abe591c60313965b4b93f184042fb8f45ae5c2122cac00efd4ecdffb9427ed600557e26a

data/Readme.mdown

@@ -26,10 +26,18 @@ and require it in your project:
 
 ## Usage
 
+This exports data for all experiments. This data set does not break down conversions by goals:
+
     require 'split/export'
     csv_data = Split::Export.to_csv
     File.open('path/to/my.csv', 'w') {|f| f.write(csv_data) }
 
+This exports data for a single experiment, and breaks it down by group and goal:
+
+    require 'split/export'
+    csv_data = Split::Export.experiment_to_csv("my_experiment")
+    File.open('path/to/my.csv', 'w') {|f| f.write(csv_data) }
+
 ## Development
 
 Source hosted at [GitHub](http://github.com/splitrb/split-export).

data/lib/split/export.rb

@@ -10,17 +10,61 @@ module Split
       BigDecimal.new(number.to_s).round(precision).to_f
     end
 
+    # this method calculates the z_score for an alternative including all goals. This behavior should
+    # be added to Alternative#z_score but until then, this method will do. I lifted most of the code from that method.
+    def z_score_all_goals(alternative) 
+      goals = alternative.goals + [nil]
+      control = alternative.experiment.control
+
+      return 'N/A' if control.name == alternative.name
+
+      p_a = goals.inject(0) { |sum, g| sum + alternative.conversion_rate(g) }
+      p_c = goals.inject(0) { |sum, g| sum + control.conversion_rate(g) }
+
+      n_a = alternative.participant_count
+      n_c = control.participant_count
+
+      z_score = Split::Zscore.calculate(p_a, n_a, p_c, n_c)
+    end
+
     def to_csv
       csv = CSV.generate do |csv|
         csv << ['Experiment', 'Alternative', 'Participants', 'Completed', 'Conversion Rate', 'Z score', 'Control', 'Winner']
         Split::ExperimentCatalog.all.each do |experiment|
+          goals = experiment.goals + [nil] # nil corresponds to conversions without any goals.
+
           experiment.alternatives.each do |alternative|
             csv << [experiment.name,
                     alternative.name,
                     alternative.participant_count,
-                    alternative.completed_count,
-                    round(alternative.conversion_rate, 3),
-                    round(alternative.z_score, 3),
+                    goals.inject(0) { |sum, g| sum + alternative.completed_count(g) },
+                    round(goals.inject(0) { |sum, g| sum + alternative.conversion_rate(g) }, 3),
+                    round(z_score_all_goals(alternative), 3),
+                    alternative.control?,
+                    alternative.to_s == experiment.winner.to_s]
+          end
+        end
+      end
+    end
+
+    def experiment_to_csv(experiment)
+      csv = CSV.generate do |csv|
+        csv << ["Alternative", "Goal", "Participants", "Completed", "Conversion Rate", "Z Score", "Control", "Winner"]
+
+        experiment = Split::ExperimentCatalog.find(experiment)
+
+        break if !experiment
+
+        goals = [nil] + experiment.goals # nil corresponds to conversions without any goals.
+
+        experiment.alternatives.each do |alternative|
+          goals.each do |goal|
+            csv << [alternative.name,
+                    goal,
+                    alternative.participant_count,
+                    alternative.completed_count(goal),
+                    round(alternative.conversion_rate(goal), 3),
+                    round(alternative.z_score(goal), 3),
                     alternative.control?,
                     alternative.to_s == experiment.winner.to_s]
           end

data/lib/split/export/version.rb

@@ -1,5 +1,5 @@
 module Split
   module Export
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

data/spec/export_spec.rb

@@ -2,18 +2,28 @@ require 'spec_helper'
 
 describe Split::Export do
   before :each do
-    experiment = Split::ExperimentCatalog.find_or_create('link_color', 'blue', 'red', 'green')
+    experiment = Split::ExperimentCatalog.find_or_create({'link_color': ["control", "goal"]}, 'blue', 'red', 'green')
     blue = Split::Alternative.new('blue', 'link_color')
-    blue.participant_count = 5
-    blue.set_completed_count(3)
+    blue.participant_count = 50
+    blue.set_completed_count(20, "control")
+    blue.set_completed_count(10, "goal")
     blue.save
     red = Split::Alternative.new('red', 'link_color')
-    red.participant_count = 6
-    red.set_completed_count(4)
+    red.participant_count = 60
+    red.set_completed_count(10, "control")
+    red.set_completed_count(30, "goal")
     red.save
   end
 
   it "should generate a csv of split data" do
-    Split::Export.to_csv.should eql("Experiment,Alternative,Participants,Completed,Conversion Rate,Z score,Control,Winner\nlink_color,blue,5,3,0.6,0.0,true,false\nlink_color,red,6,4,0.667,0.0,false,false\nlink_color,green,0,0,0.0,0.0,false,false\n")
+    Split::Export.to_csv.should eql("Experiment,Alternative,Participants,Completed,Conversion Rate,Z score,Control,Winner\nlink_color,blue,50,30,0.6,0.0,true,false\nlink_color,red,60,40,0.667,0.724,false,false\nlink_color,green,0,0,0.0,0.0,false,false\n")
+  end
+
+  it "should generate a detailed csv of split data for a single table" do
+    Split::Export.experiment_to_csv("link_color").should eql("Alternative,Goal,Participants,Completed,Conversion Rate,Z Score,Control,Winner\nblue,,50,0,0.0,0.0,true,false\nblue,control,50,20,0.4,0.0,true,false\nblue,goal,50,10,0.2,0.0,true,false\nred,,60,0,0.0,0.0,false,false\nred,control,60,10,0.167,-2.736,false,false\nred,goal,60,30,0.5,3.257,false,false\ngreen,,0,0,0.0,0.0,false,false\ngreen,control,0,0,0.0,0.0,false,false\ngreen,goal,0,0,0.0,0.0,false,false\n")
+  end
+
+  it "should quietly return nil if a bad experiment name is passed in" do
+    Split::Export.experiment_to_csv("incorrect_name").should be_nil
   end
 end

data/split-export.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   # Development Dependencies
   s.add_development_dependency "rspec", "~>  2.6"
   s.add_development_dependency "rake", "~> 11.1"
-  s.add_development_dependency 'fakeredis', '~> 0.5.0'
+  s.add_development_dependency 'fakeredis', '~> 0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split-export
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: split
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 description: 
 email:
 - andrewnez@gmail.com
@@ -111,4 +111,3 @@ summary: Split extension to export your data
 test_files:
 - spec/export_spec.rb
 - spec/spec_helper.rb
-has_rdoc: