a_b_split 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b16414fe4467a730169a19275bc259e77ab4c17
-  data.tar.gz: 4397d8407e13272f1558322192a92cd96229185e
+  metadata.gz: 28166486a6f870f7b67355794008e620971f416b
+  data.tar.gz: 457b3a539da94205f8533849721d323f114e7b2a
 SHA512:
-  metadata.gz: 946b6bd531d8e4e1575a63fbe2a3b7dd7abf88ed2f4b41c02e477ea922e90b08513f356be24ba9115114b891de5a92ee06e1b471177b0ead4c53a6710510ff88
-  data.tar.gz: 730f33d4df3c5f0abb27e3c0b2e05f7ddc6f314d6b760e822210ebe4f23dcd9412a9ffa04527c3412f2bdb4680958f0bab9cbc9918a7ceb1e556e54d7854a845
+  metadata.gz: e615da6bbd04d68255074bca677c818933444b7ecabf966cd7fee20f3b339d465939f53f9f7ab7d6880ff912290df54eb832e9f4df600cbe78c5ab6458deaf99
+  data.tar.gz: ba65a2075286ef08e830e6eaa238c9af6b1d8c1c5cb5d8a984251300a54673bd22217d762ac8f25c0c4da124f498c597ee73526b35affe193366ec1a6ca7b97a

data/lib/a_b_split.rb

@@ -1,4 +1,5 @@
-$:.unshift File.expand_path('..', __FILE__)
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
 
 require 'a_b_split/functions'
 require 'a_b_split/configuration'
@@ -7,16 +8,20 @@ require 'yaml'
 
 module ABSplit
   class NoValidExperiment < RuntimeError; end
-end
 
-module ABSplit
-  extend self
+  def configuration
+    @configuration
+  end
 
-  attr_accessor :configuration
+  def configuration=(config)
+    @configuration = config
+  end
 
   def configure
     yield(configuration) if block_given?
   end
+
+  module_function :configure, :configuration, :configuration=
 end
 
 ABSplit.configuration = ABSplit::Configuration.new

data/lib/a_b_split/configuration.rb

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 module ABSplit
+  # This class represents the configurations used in ABSplit. Every time
+  # that is instanciated contains the following:
+  #   - An empty list of experiments to use
   class Configuration
     attr_accessor :experiments
 
     def initialize
-      @experiments = Hash.new
+      @experiments = {}
     end
   end
 end

data/lib/a_b_split/functions.rb

@@ -1,3 +1,4 @@
-Dir[File.join(File.dirname(__FILE__), *%w(functions *))].each do |function|
+# frozen_string_literal: true
+Dir[File.join(File.dirname(__FILE__), 'functions', '*')].each do |function|
   require function
 end

data/lib/a_b_split/functions/heaviside_weighted_split.rb

@@ -1,13 +1,22 @@
+# frozen_string_literal: true
 require 'bigdecimal'
 require_relative 'weighted_split'
 
 module ABSplit
   module Functions
+    # Weighted split based on a modified Heaviside function. In case a numeric value
+    # is passed, it uses a sigmoid function applying a modified Heaviside to choose
+    # the experiment. In case a none numeric value is passed it uses SHA2 algorithm
+    # to get a value from the object, and after decide based on weights.
+    #
+    # Persistent - Supports 256 bits as input
+    #
+    # No collisions are possible
     class HeavisideWeightedSplit < WeightedSplit
       MAX_HASH_VALUE = ('f' * 64).to_i(16)
-      
+
       class << self
-        protected 
+        protected
 
         def select_experiment_for(value, experiments)
           x = value.is_a?(Numeric) ? value : hash(value)
@@ -32,16 +41,16 @@ module ABSplit
           experiments.each do |experiment|
             accumulated_percentages += percentage(experiment)
 
-            return experiment['name'] if x < accumulated_percentages
+            return experiment['name'] if x <= accumulated_percentages
           end
         end
 
         def percentage(experiment)
           experiment['weight'].to_f / 100
         end
-        
+
         def sigmoid(x)
-          BigDecimal.new("#{1.0/(1 + Math.exp(-2 * x))}")
+          BigDecimal.new((1.0 / (1 + Math.exp(-2 * x))).to_s)
         end
       end
     end

data/lib/a_b_split/functions/md5_weighted_split.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
 require 'digest'
 require_relative 'weighted_split'
 
 module ABSplit
   module Functions
+    # Weighted split based on MD5 digest of value.
+    #
+    # Persistent - Collisions are possible
+    #
+    # Supports 128 bits as input
     class Md5WeightedSplit < WeightedSplit
-
       MAX_HASH_VALUE = ('f' * 32).to_i(16)
 
       class << self
         protected
+
         def select_experiment_for(value, experiments)
           weight = weight(value)
           experiments = calculate_markers experiments
@@ -33,7 +39,6 @@ module ABSplit
             { marker: cumulative }.merge(experiment)
           end
         end
-
       end
     end
   end

data/lib/a_b_split/functions/weighted_split.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
 module ABSplit
   module Functions
+    # Weighted split based on hash value.
+    #
+    # Non persistent - No collisions are possible
+    #
+    # Based on memory position
     class WeightedSplit
-      MAX_POSITIONS = (9999999999999999999 * 2) + 1 #capacity of Fixnum
-
-      class << self 
+      MAX_POSITIONS = (9_999_999_999_999_999_999 * 2) + 1 # capacity of Fixnum
 
+      class << self
         def value_for(x, *params)
           given_weights = validate(params)
 
@@ -16,8 +21,8 @@ module ABSplit
         protected
 
         def validate(experiments)
-          given_weights = experiments.each_with_object([]) do |param, memo| 
-            memo << param['weight'] if param.has_key?('weight')
+          given_weights = experiments.each_with_object([]) do |param, memo|
+            memo << param['weight'] if param.key?('weight')
           end
 
           unless experiments.any? && experiments.size > 1 && given_weights.reduce(0, &:+) <= 100
@@ -33,24 +38,22 @@ module ABSplit
           missing_weights = parts - given_percentage.size
           missing_percentage = 100 - given_percentage.reduce(0, &:+)
 
-          experiments.map do |experiment| 
-            if experiment['weight']
-              experiment['weight'] = experiment['weight'].to_f
-            else
-              experiment['weight'] = missing_percentage.to_f / missing_weights.to_f
-            end
+          experiments.map do |experiment|
+            experiment['weight'] = if experiment['weight']
+                                     experiment['weight'].to_f
+                                   else
+                                     missing_percentage.to_f / missing_weights.to_f
+                                   end
 
             experiment
           end
         end
-        
+
         def select_experiment_for(x, experiments)
           x_position = x.hash
 
           markers(experiments).each_with_index do |limit, i|
-            if x_position <= limit
-              return experiments[i]['name']
-            end
+            return experiments[i]['name'] if x_position <= limit
           end
 
           experiments.last['name']
@@ -59,7 +62,7 @@ module ABSplit
         private
 
         def markers(experiments)
-          experiments.map do |experiment| 
+          experiments.map do |experiment|
             (self::MAX_POSITIONS * (experiment['weight'] / 100)) - (self::MAX_POSITIONS / 2)
           end
         end

data/lib/a_b_split/test.rb

@@ -1,41 +1,47 @@
+# frozen_string_literal: true
 module ABSplit
-  module Test
-    extend self
+  # This class is responsible for spliting the population using the experiment
+  # name passed as a parameter. It will always return an experiment name or a
+  # NoValidExperiment error in case is chosen any unknown experiment.
+  class Test
+    include ABSplit
 
-    def split(name, x)
-      self.experiment = find(name)
+    class << self
+      def split(name, x)
+        self.experiment = find(name)
 
-      raise ABSplit::NoValidExperiment unless experiment
+        raise ABSplit::NoValidExperiment unless experiment
 
-      function.value_for(x,*options)
-    end
+        function.value_for(x, *options)
+      end
 
-    private
+      private
 
-    attr_accessor :experiment
+      attr_accessor :experiment
 
-    def find(experiment)
-      ABSplit.configuration.experiments[experiment]
-    end
+      def find(experiment)
+        ABSplit.configuration.experiments[experiment]
+      end
 
-    def function
-      function = 'WeightedSplit'
+      def function
+        function = 'WeightedSplit'
 
-      unless experiment.is_a?(Array)
-        function = experiment['algorithm'] if experiment['algorithm']
+        unless experiment.is_a?(Array)
+          function = experiment['algorithm'] if experiment['algorithm']
 
-        begin
-          ABSplit::Functions.const_get(function)
-        rescue NameError
-          raise ABSplit::NoValidExperiment
+          begin
+            ABSplit::Functions.const_get(function)
+          rescue NameError
+            raise ABSplit::NoValidExperiment
+          end
         end
-      end
 
-      ABSplit::Functions.const_get(function)
-    end
+        ABSplit::Functions.const_get(function)
+      end
 
-    def options
-      experiment.is_a?(Array) ? experiment : experiment['options']
+      def options
+        experiment.is_a?(Array) ? experiment : experiment['options']
+      end
     end
   end
 end

data/lib/a_b_split/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ABSplit
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a_b_split
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Enrique Figuerola
+- Enrique M Figuerola Gomez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-12 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,44 +16,58 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
 description: 
-email: hard_rock15@msn.com
+email: me@emfigo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -66,7 +80,7 @@ files:
 - lib/a_b_split/functions/weighted_split.rb
 - lib/a_b_split/test.rb
 - lib/a_b_split/version.rb
-homepage: https://github.com/emfigo/absplit
+homepage: https://emfigo.com/portfolio.html
 licenses:
 - MIT
 metadata: {}
@@ -78,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -86,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Splits experiment cohorts for A/B testing