gitlab-experiment 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51c0f257bd0cea5fa7b970e764ac5cce9f24c5a844673f05579d1c902a46fc39
-  data.tar.gz: ddd93dc46cdde532f20edd5209651d511105157ee9dd13d58c5a60cb229cd3ca
+  metadata.gz: a26425622afb7aa3f341ff403192963e276876b65902237018f852117168a19a
+  data.tar.gz: 0a5238c73a4b0217810b4f8161df6452b683b21a6573f1b657517302cef9cef0
 SHA512:
-  metadata.gz: 243606b6b55ebe069296c564ad801a6b25075a85d2b2ca38eb47e836b75b655fa9472fbcf0a0cb01c83093b97d529f8b2aec04389d79119064b5021c975b0042
-  data.tar.gz: 1900d8b44458d2cf1e2086cc48d5e3ccc19160926c1dc9b827b7a93d042edf7354e1eeb35cae12e0c33f133aef39f605dbd5446edf987c1d99a38264d3b97d72
+  metadata.gz: 567ca93e3f931c167bc1766490b07e1535db72e3b5da5986715412746354945ed799dab4c075e91c5015aa922bf5d7e5a82bdc940808aa8100c8897d5ee623b7
+  data.tar.gz: 3f053ed2ad8bdfc2201aacaef9c723332fba260f4f4cb54c65a92539d74ec100297540c34c97579c99723f0d98e98dc57cbe383a0731128d623b0a58b4786d7c

data/README.md

@@ -15,7 +15,7 @@ When we discuss the behavior of this gem, we'll use terms like experiment, conte
 - `candidate` defines that there's one experimental code path.
 - `variant(s)` is used when more than one experimental code path exists.
 
-Candidate and variant are the same concept, but simplify how we speak about experimental paths.<br clear="all">
+Candidate and variant are the same concept, but simplify how we speak about experimental paths -- this concept is also widely referred to as the "experiment group".<br clear="all">
 
 [[_TOC_]]
 

data/lib/gitlab/experiment.rb

@@ -148,12 +148,6 @@ module Gitlab
       "Experiment;#{id}"
     end
 
-    def key_for(hash)
-      instance_exec(hash, &Configuration.context_hash_strategy)
-    end
-
-    protected
-
     def enabled?
       true
     end
@@ -167,6 +161,12 @@ module Gitlab
       enabled? && !excluded?
     end
 
+    def key_for(hash)
+      instance_exec(hash, &Configuration.context_hash_strategy)
+    end
+
+    protected
+
     def run_with_segmenting?
       !variant_assigned? && enabled? && !excluded?
     end

data/lib/gitlab/experiment/{rspec_matchers.rb → rspec.rb}

@@ -2,7 +2,26 @@
 
 module Gitlab
   class Experiment
-    module RspecMatchers
+    module RSpecHelpers
+      def stub_experiments(experiments)
+        experiments.each do |name, variant|
+          variant = :control if variant == false
+          raise ArgumentError, 'variant must be a symbol or false' unless variant.is_a?(Symbol)
+
+          klass = Gitlab::Experiment.send(:constantize, name) # rubocop:disable GitlabSecurity/PublicSend
+          allow(klass).to receive(:new).and_wrap_original do |new, *args, &block|
+            new.call(*args).tap do |instance|
+              allow(instance).to receive(:enabled?).and_return(true)
+              allow(instance).to receive(:resolve_variant_name).and_return(variant.to_s)
+
+              block.call(instance) if block.present?
+            end
+          end
+        end
+      end
+    end
+
+    module RSpecMatchers
       extend RSpec::Matchers::DSL
 
       matcher :exclude do |context|
@@ -83,9 +102,10 @@ module Gitlab
 end
 
 RSpec.configure do |config|
-  config.define_derived_metadata(file_path: Regexp.new('/spec/experiments/')) do |metadata|
+  config.include Gitlab::Experiment::RSpecHelpers
+
+  config.include Gitlab::Experiment::RSpecMatchers, :experiment
+  config.define_derived_metadata(file_path: %r{/spec/experiments/}) do |metadata|
     metadata[:type] = :experiment
   end
-
-  config.include Gitlab::Experiment::RspecMatchers, :experiment
 end

data/lib/gitlab/experiment/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   class Experiment
-    VERSION = '0.4.6'
+    VERSION = '0.4.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-experiment
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,7 +72,7 @@ files:
 - lib/gitlab/experiment/cookies.rb
 - lib/gitlab/experiment/dsl.rb
 - lib/gitlab/experiment/engine.rb
-- lib/gitlab/experiment/rspec_matchers.rb
+- lib/gitlab/experiment/rspec.rb
 - lib/gitlab/experiment/variant.rb
 - lib/gitlab/experiment/version.rb
 homepage: https://gitlab.com/gitlab-org/gitlab-experiment