abanalyzer 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f300363efbaf45233112dd30f6092192dcda30d9
-  data.tar.gz: 3ac739cdcac5e47cc38a1a1009591f023c95a36b
+  metadata.gz: 9cbf5e6bc121a608cab28ea506580a3cbae02998
+  data.tar.gz: f897ff9d1f557e831d779d7ee6f87937dc414ec3
 SHA512:
-  metadata.gz: e5d78e898a261f4cb50a3db03431fc262428718e17e2b6922b9fecd71fbed9ed38b6be7a8ec307c831a7930fd2bb5ac3d4620f0fa8779257860ade9aa1fb2965
-  data.tar.gz: e8daaacde12cdc610de4726889678f077527ee73d9f0137fcb8aa359d91915b65d9bf86203baf267c51bfe40dfe0de368feb43511b1905fa0b29013eedff5d2f
+  metadata.gz: f78dfa9350b44b072a34c4d6d230dd415d3b84eb53a9e0d5b1f1e7bf7f5bf146858a2e03ecabe528a26bb52f4f7a80c0458c82948f830454cddc93c050069ef7
+  data.tar.gz: 5d54f21901a039d64e8aec4d1c3c32b56e8edd2b29e7a7fbeb54c258ca3b6f8ed5afa1546a8a7a8338f99acc182ad2176deb806ce5d5a23855304013ddb591d8

data/.gitignore

@@ -1,3 +1,4 @@
+.bundle
 docs
 pkg
 Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 140
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 19
+
+Metrics/AbcSize:
+  Max: 43

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2

data/Gemfile

@@ -1,4 +1,3 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-# Specify your gem's dependencies in bandit.gemspec
 gemspec

data/README.rdoc

@@ -55,7 +55,7 @@ You can additionally get the actual score for either a Chi-Square test for indep
 
 
 == Sample Size Calculations
-Let's say you want to determine how large your sample size needs to be for an A/B test.  Let's say your baseline is 10%, and you want to be able to determine if there's at least a 10% relative lift (1% absolute) to 11%.  Let's assume you want a power[http://en.wikipedia.org/wiki/Statistical_power] of 0.8 and a {significance level}[http://en.wikipedia.org/wiki/Statistical_significance] of 0.05 (that is, an 80% chance of that you'll fail to recognize a difference when there is one, and a 5% chance of a false negative).
+Let's say you want to determine how large your sample size needs to be for an A/B test.  Let's say your baseline is 10%, and you want to be able to determine if there's at least a 10% relative lift (1% absolute) to 11%.  Let's assume you want a power[http://en.wikipedia.org/wiki/Statistical_power] of 0.8 and a {significance level}[http://en.wikipedia.org/wiki/Statistical_significance] of 0.05 (that is, an 80% chance of that you'll succeed in recognizing a difference when there is one, and a 5% chance of a false negative).
 
   ...
   ABAnalyzer.calculate_size(0.1, 0.11, 0.05, 0.8)

data/Rakefile

@@ -1,18 +1,21 @@
+require 'rake/testtask'
 require 'bundler/gem_tasks'
 require 'rdoc/task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
-RDoc::Task.new("doc") { |rdoc|
-  rdoc.title = "ABAnalyzer - A/B test analysis library for Ruby"
+RDoc::Task.new('doc') do |rdoc|
+  rdoc.title = 'ABAnalyzer - A/B test analysis library for Ruby'
   rdoc.rdoc_dir = 'docs'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
-}
-
-require 'rake/testtask'
+end
 
 Rake::TestTask.new do |t|
+  t.libs << 'test'
   t.test_files = FileList['test/*_test.rb']
   t.verbose = true
 end
 
-task :default => :test
+task default: %i[rubocop test]

data/abanalyzer.gemspec

@@ -1,20 +1,21 @@
-$:.push File.expand_path("../lib", __FILE__)
-require "abanalyzer/version"
-require "date"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'abanalyzer/version'
+require 'date'
 
 Gem::Specification.new do |s|
-  s.name = "abanalyzer"
+  s.name = 'abanalyzer'
   s.version = ABAnalyzer::VERSION
-  s.authors = ["Brian Muller"]
+  s.authors = ['Brian Muller']
+  s.license = 'GPL-3.0'
   s.date = Date.today.to_s
-  s.description = "A/B test analysis library for Ruby"
-  s.summary = "A/B test analysis library for Ruby"
-  s.email = "bamuller@gmail.com"
-  s.files = `git ls-files`.split($/)
+  s.summary = 'A/B test analysis library for Ruby'
+  s.email = 'bamuller@gmail.com'
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
-  s.homepage = "https://github.com/bmuller/abanalyzer"
-  s.require_paths = ["lib"]
-  s.add_development_dependency("rake")
-  s.add_development_dependency("rdoc")
-  s.add_dependency('statistics2', '>= 0.54')
+  s.homepage = 'https://github.com/bmuller/abanalyzer'
+  s.require_paths = ['lib']
+  s.add_development_dependency('rake', '~> 12.1')
+  s.add_development_dependency('minitest', '~> 5.10')
+  s.add_development_dependency('rubocop', '~> 0.50')
+  s.add_dependency('statistics2', '= 0.54')
 end

data/lib/abanalyzer/abtest.rb

@@ -1,7 +1,6 @@
 require 'statistics2'
 
 module ABAnalyzer
-
   class ABTest
     # values should be hash of hashes, with top level hash the group names:
     # { :groupa => { :yes => 20, :no => 10 }, :groupb => { :yes => 18, :no => 8 } }
@@ -9,42 +8,43 @@ module ABAnalyzer
       @values = Matrix.new values
     end
 
-    def different?(sig=0.05)
+    def different?(sig = 0.05)
       gtest_p < sig
     end
-    
+
     def chisquare_score
-      sum=0
-      @values.each_cell { |colname, rowname, value|
+      sum = 0
+      @values.each_cell do |colname, rowname, value|
         ex = expected(colname, rowname)
         test_sufficient_data(colname, rowname, ex, value)
-        sum += ((value - ex) ** 2) / ex
-      }
-      return sum
+        sum += ((value - ex)**2) / ex
+      end
+      sum
     end
-    
+
     def gtest_score
-      sum=0
-      @values.each_cell { |colname, rowname, value|
+      sum = 0
+      @values.each_cell do |colname, rowname, value|
         ex = expected(colname, rowname)
         test_sufficient_data(colname, rowname, ex, value)
         sum += value * Math.log(value / ex)
-      }
-      return sum
+      end
+      sum
     end
 
     def chisquare_p
-      ABTest.chi2dist(df, self.chisquare_score)
+      1 - Statistics2.chi2dist(df, chisquare_score)
     end
 
     def gtest_p
-      ABTest.chi2dist(df, 2*self.gtest_score)
+      1 - Statistics2.chi2dist(df, 2 * gtest_score)
     end
-    
+
     private
+
     def test_sufficient_data(colname, rowname, expected, value)
       msg = "Insufficient data size for column #{colname} row #{rowname}.  Expected value must be >= 5, and value must be > 0."
-      raise InsufficientDataError, msg if expected < 5 or value <= 0
+      raise InsufficientDataError, msg if (expected < 5) || (value <= 0)
     end
 
     def expected(colname, rowname)
@@ -54,10 +54,5 @@ module ABAnalyzer
     def df
       (@values.columns.length - 1) * (@values.rows.length - 1)
     end
-
-    def self.chi2dist(degrees, score)
-      1 - Statistics2.chi2dist(degrees, score)
-    end
   end
-
 end

data/lib/abanalyzer/matrix.rb

@@ -1,5 +1,4 @@
 module ABAnalyzer
-
   class Matrix
     attr_reader :columns, :rows
     def initialize(values)
@@ -10,14 +9,14 @@ module ABAnalyzer
     end
 
     def validate
-      @values.each { |colname, column|
-        if column.keys.map { |s| s.to_s }.sort != @rows.map { |s| s.to_s }.sort
+      @values.each do |colname, column|
+        if column.keys.map(&:to_s).sort != @rows.map(&:to_s).sort
           raise MatrixFormatError, "Column #{colname} has row names that don't match the first column's."
         end
-      }
-      coltotal = @columns.map { |col| column_sum(col) }.inject { |a,b| a+b }
-      rowtotal = @rows.map { |col| row_sum(col) }.inject { |a,b| a+b }
-      raise MatrixFormatError, "Column sums do not equal row sums" if coltotal != rowtotal
+      end
+      coltotal = @columns.map { |col| column_sum(col) }.inject { |a, b| a + b }
+      rowtotal = @rows.map { |col| row_sum(col) }.inject { |a, b| a + b }
+      raise MatrixFormatError, 'Column sums do not equal row sums' if coltotal != rowtotal
     end
 
     def get_column(name)
@@ -25,17 +24,17 @@ module ABAnalyzer
     end
 
     def get_row(name)
-      @values.map { |colname, rows|
+      @values.map do |_colname, rows|
         rows[name]
-      }
+      end
     end
 
     def each_cell
-      @columns.each { |colname|
-        @rows.each { |rowname|
+      @columns.each do |colname|
+        @rows.each do |rowname|
           yield colname, rowname, get(colname, rowname)
-        }
-      }
+        end
+      end
     end
 
     def get(colname, rowname)
@@ -43,16 +42,15 @@ module ABAnalyzer
     end
 
     def column_sum(name)
-      get_column(name).inject { |a,b| a+b }
+      get_column(name).inject { |a, b| a + b }
     end
 
     def row_sum(name)
-      get_row(name).inject { |a,b| a+b }
+      get_row(name).inject { |a, b| a + b }
     end
 
     def total_sum
-      @columns.map { |col| column_sum(col) }.inject { |a,b| a+b }      
+      @columns.map { |col| column_sum(col) }.inject { |a, b| a + b }
     end
   end
-
 end

data/lib/abanalyzer/sample.rb

@@ -1,14 +1,13 @@
 require 'statistics2'
 
 module ABAnalyzer
-
   # Calculate the minimum sample size (per group) based on the desire to detect
   # a increase from proportion p1 to proportion p2.  Significance is generally
   # safe at 0.05 (why? just because) and a power of 0.8 (why? just because)
   def self.calculate_size(p1, p2, significance, power)
-    [ p1, p2, significance, power ].each { |a| 
-      raise "All arguments to calculate_size must be Floats" unless a.is_a?(Float)
-    }
+    [p1, p2, significance, power].each do |a|
+      raise 'All arguments to calculate_size must be Floats' unless a.is_a?(Float)
+    end
 
     pbar = (p1 + p2) / 2.0
     sides = 2.0
@@ -16,8 +15,8 @@ module ABAnalyzer
     zcrit = Statistics2.pnormaldist(1 - (significance / sides))
     zpow = Statistics2.pnormaldist(power)
 
-    numerator = (zcrit * Math.sqrt(2 * pbar * (1 - pbar)) + zpow * Math.sqrt(p2 * (1 - p2) + p1 * (1 - p1))) ** 2
-    denominator = (p2 - p1) ** 2
+    numerator = (zcrit * Math.sqrt(2 * pbar * (1 - pbar)) + zpow * Math.sqrt(p2 * (1 - p2) + p1 * (1 - p1)))**2
+    denominator = (p2 - p1)**2
     (numerator / denominator).ceil
   end
 
@@ -39,5 +38,4 @@ module ABAnalyzer
     ci = confidence_interval(successes, trials, confidence)
     [(ci.first - compared_proportion) / compared_proportion, (ci.last - compared_proportion) / compared_proportion]
   end
-  
 end

data/lib/abanalyzer/version.rb

@@ -1,3 +1,3 @@
 module ABAnalyzer
-  VERSION = "0.1.0"
+  VERSION = '1.0.0'.freeze
 end

data/test/abtest_test.rb

@@ -1,24 +1,25 @@
-require_relative 'helper'
+require 'minitest/autorun'
+require 'abanalyzer'
 
-class ABTestTest < Test::Unit::TestCase
+class ABTestTest < MiniTest::Test
   def setup
-    @values = { :rep => { :male => 200, :female => 250 }, :dem => { :male => 150, :female => 300}, :ind => { :male => 50, :female => 50 }}
+    @values = { rep: { male: 200, female: 250 }, dem: { male: 150, female: 300 }, ind: { male: 50, female: 50 } }
   end
 
   def test_test_creation
-    assert_raise ABAnalyzer::InsufficientDataError do 
-      m = ABAnalyzer::ABTest.new({ :one => { :a => 10, :b => 20 }, :two => { :a => 5, :b => 0 } })
-      p = m.gtest_p
+    assert_raises ABAnalyzer::InsufficientDataError do
+      m = ABAnalyzer::ABTest.new(one: { a: 10, b: 20 }, two: { a: 5, b: 0 })
+      m.gtest_p
     end
 
-    assert_raise ABAnalyzer::InsufficientDataError do 
-      m = ABAnalyzer::ABTest.new({ :one => { :a => 10, :b => 20 }, :two => { :a => 5, :b => -6 } })
-      p = m.gtest_p
+    assert_raises ABAnalyzer::InsufficientDataError do
+      m = ABAnalyzer::ABTest.new(one: { a: 10, b: 20 }, two: { a: 5, b: -6 })
+      m.gtest_p
     end
 
-    assert_raise ABAnalyzer::InsufficientDataError do 
-      m = ABAnalyzer::ABTest.new({ :one => { :a => 1, :b => 1 }, :two => { :a => 1, :b => 1 } })
-      p = m.gtest_p
+    assert_raises ABAnalyzer::InsufficientDataError do
+      m = ABAnalyzer::ABTest.new(one: { a: 1, b: 1 }, two: { a: 1, b: 1 })
+      m.gtest_p
     end
   end
 
@@ -28,7 +29,7 @@ class ABTestTest < Test::Unit::TestCase
     chisquare = 1 - Statistics2.chi2dist(2, 16.2037037037037)
     assert_equal abt.chisquare_p, chisquare
 
-    gtest = 1 - Statistics2.chi2dist(2, 2*8.13286375180066)
+    gtest = 1 - Statistics2.chi2dist(2, 2 * 8.13286375180066)
     assert_equal abt.gtest_p, gtest
   end
 end

data/test/matrix_test.rb

@@ -1,13 +1,14 @@
-require_relative 'helper'
+require 'minitest/autorun'
+require 'abanalyzer'
 
-class MatrixTest < Test::Unit::TestCase
+class TestMatrix < MiniTest::Test
   def setup
-    @values = { :rep => { :male => 200, :female => 250 }, :dem => { :male => 150, :female => 300}, :ind => { :male => 50, :female => 50 }}
+    @values = { rep: { male: 200, female: 250 }, dem: { male: 150, female: 300 }, ind: { male: 50, female: 50 } }
   end
 
   def test_matrix_creation
-    assert_raise ABAnalyzer::MatrixFormatError do 
-      ABAnalyzer::Matrix.new({ :one => { :a => 10, :b => 20 }, :two => { :a => 5 } })
+    assert_raises ABAnalyzer::MatrixFormatError do
+      ABAnalyzer::Matrix.new(one: { a: 10, b: 20 }, two: { a: 5 })
     end
   end
 

metadata

@@ -1,65 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: abanalyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Muller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-28 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: statistics2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.54'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.54'
-description: A/B test analysis library for Ruby
+description: 
 email: bamuller@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -72,10 +87,10 @@ files:
 - lib/abanalyzer/sample.rb
 - lib/abanalyzer/version.rb
 - test/abtest_test.rb
-- test/helper.rb
 - test/matrix_test.rb
 homepage: https://github.com/bmuller/abanalyzer
-licenses: []
+licenses:
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -83,21 +98,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A/B test analysis library for Ruby
 test_files:
 - test/abtest_test.rb
-- test/helper.rb
 - test/matrix_test.rb

data/test/helper.rb

@@ -1,6 +0,0 @@
-require 'rubygems'
-require 'statistics2'
-require 'test/unit'
-
-$:.unshift(File.join File.dirname(__FILE__), '..', 'lib')
-require 'abanalyzer'