dl_experiment 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f959d8602ba46ba1ebd32da595018a01b78a096865c9a8f6af1e4535965b9ae8
+  data.tar.gz: 443240e50b6d2c06d7bd4cebf74711b73729bb1e9d1cafba36b2b00abb741d6b
+SHA512:
+  metadata.gz: c54557eddb3a13195b894dfc5387879d34012cfc6d01edcaf5d6f9c93c312933bb44d2c102688fcc71f9600a676430ee735152c5298c45ac0ced8f38b800ade0
+  data.tar.gz: 5cc327f74240af73e07b3fff02f034f9158c3e2c0d4249fd9305f06e33742278a63f9fee5a76393b3270d9d4a6912f41c7a314328c088cea4a40631df3640933

data/lib/dl_experiment.rb

@@ -0,0 +1,2 @@
+require 'experiment'
+

data/lib/experiment.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+class Experiment
+  class << self
+    def protocol(name)
+      name = String(name)
+      raise('Please provide an experiment name') if name.empty?
+      experiment = Experiment.new(name)
+      yield(experiment)
+      experiment.raise_on_diff! if rails_test_mode?
+      experiment.result
+    end
+
+    def rails_test_mode?
+      defined?(Rails) && Rails.env.test?
+    end
+  end
+
+  class Result
+    attr_accessor :value, :error
+    def initialize(value: nil, error: nil)
+      self.value = value
+      self.error = error
+    end
+  end
+
+  DEFAULT_COMPARISON = ->(legacy, experiment) { legacy == experiment }
+  DEFAULT_ENABLER = -> { true }
+
+  def initialize(name)
+    @name = name
+    @compare_with = DEFAULT_COMPARISON
+    @enable = DEFAULT_ENABLER
+  end
+
+  def legacy(&block)
+    raise 'Missing block' unless block
+    @legacy = block
+    self
+  end
+
+  def experiment(&block)
+    raise 'Missing block' unless block
+    @experiment = block
+    self
+  end
+
+  def compare_with(&block)
+    raise 'Missing block' unless block
+    @compare_with = block
+    self
+  end
+
+  def enable(&block)
+    raise 'Missing block' unless block
+    @enable = block
+    self
+  end
+
+  def on_diff(&block)
+    raise 'Missing block' unless block
+    @on_diff = block
+    self
+  end
+
+  def result
+    raise 'Please call the legacy helper in your protocol block' unless @legacy
+    raise 'Please call the experiment helper in your protocol block' unless @experiment
+    legacy_result = exec(@legacy)
+    return forward(legacy_result) unless self.class.rails_test_mode? || @enable.call
+    experiment_result = exec(@experiment)
+    if @on_diff
+      if legacy_result.error.class != experiment_result.error.class ||
+          legacy_result.error&.message != experiment_result.error&.message ||
+          !@compare_with.call(legacy_result.value, experiment_result.value)
+        @on_diff.call(legacy_result, experiment_result)
+      end
+    end
+    forward(legacy_result)
+  end
+
+  def raise_on_diff!
+    on_diff do |legacy_result, experiment_result|
+      raise ExperimentError,
+        "Experiment: #{@name}; "\
+        "Legacy result: #{legacy_result.inspect}; "\
+        "Experiment result: #{experiment_result.inspect}"
+    end
+  end
+
+  private
+
+  def forward(result)
+    raise result.error if result.error
+    result.value
+  end
+
+  def exec(block)
+    Result.new(value: block.call)
+  rescue StandardError => error
+    Result.new(error: error)
+  end
+
+  class ExperimentError < StandardError; end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: dl_experiment
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexandre Ignjatovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-11 00:00:00.000000000 Z
+dependencies: []
+description: A framework meant to help you test (in production or in tests) the impact
+  of an iso functional change
+email: alexandre.ignjatovic@doctolib.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dl_experiment.rb
+- lib/experiment.rb
+homepage: https://rubygems.org/gems/hola
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A mini scientist-like framework
+test_files: []