activeexperiment 0.1.0.alpha → 0.1.1.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5809078002c2de223c3c7f1017304defd4a1c7aaa3f9ac53fc7446980657ef14
-  data.tar.gz: 0c954cec3f8bd0af0c399ec4e3af1f2e63a4e7841df961a2df37f761bedaa682
+  metadata.gz: dbb349cf57adaf426eb37b7e2ed5124bf321e674ef0116ab6e7ff6a5cf65fbae
+  data.tar.gz: a7f74b8b717b4c34712a09e8792745333fc2b4ee3616202555857f87f8651010
 SHA512:
-  metadata.gz: b05783407e7c4bda3a6833154949250a654ccfcaec30a25330bf9407d89cd613986fbe80660913c704b266329a756626ba09b5d065826cc7d3968f594b0a32e6
-  data.tar.gz: 649646685dcf34cc67fc8c7de2a02dd9067778382e3266ff87f25c69a4f0256eca210d0c3d1f039b5491fbab07122070338f9de89bcf5cd70b6b55e4d4ecde95
+  metadata.gz: 3477a95ecb87731bef45429864595b1428c8c6b576f47a4911158272e582f558420b6757992a8f0f86b3678bbbe0fda9ff091387ae312d770bfacf4857f76224
+  data.tar.gz: 483970d7592e90564bf48f38a8504d6d6ac10d633eb2687617cc26ea77c38b8def22a46c58194ed8dfa2b52334a127c69b4239189b93dab0dd1c9ea704f033de

data/README.md

@@ -1,3 +1,8 @@
+[![Gem Version](https://badge.fury.io/rb/activeexperiment.svg)](https://badge.fury.io/rb/activeexperiment)
+[![Maintainability](https://api.codeclimate.com/v1/badges/551c00c66f8558c7a01b/maintainability)](https://codeclimate.com/github/jejacks0n/active_experiment/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/551c00c66f8558c7a01b/test_coverage)](https://codeclimate.com/github/jejacks0n/active_experiment/test_coverage)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+
 # Active Experiment – Decide what to do next
 
 Active Experiment is a framework for defining and running experiments. It supports using a variety of rollout and reporting strategies and/or services.
@@ -58,7 +63,11 @@ gem install activeexperiment
 
 Source code can be downloaded as part of the project on GitHub:
 
-* https://github.com/jejacks0n/activeexperiment
+* https://github.com/jejacks0n/active_experiment
+
+Adapters can be added to integrate with various services:
+
+- [Unleash adapter](https://github.com/jejacks0n/activeexperiment-unleash) 
 
 ## Advanced Experimentation
 
@@ -145,6 +154,8 @@ Project specific rollouts can be defined and registered too. To illustrate, here
 
 ```ruby
 class FeatureFlagRollout < ActiveExperiment::Rollouts::BaseRollout
+  register_as :feature_flag
+
   def skipped_for(experiment)
     !Feature.enabled?(@rollout_options[:flag_name] || experiment.name)
   end
@@ -153,8 +164,6 @@ class FeatureFlagRollout < ActiveExperiment::Rollouts::BaseRollout
     experiment.variant_names.sample
   end
 end
-
-ActiveExperiment::Rollouts.register(:feature_flag, FeatureRollout)
 ```
 
 This rollout can now be used the same way the built-in rollouts are:
@@ -165,7 +174,7 @@ class MyExperiment < ActiveExperiment::Base
   variant(:blue) { "blue" }
 
   # Using a custom rollout with options.
-  rollout :feature_flag, flag_name: "my_feature_flag"
+  use_rollout :feature_flag, flag_name: "my_feature_flag"
 end
 ```
 
@@ -206,7 +215,9 @@ Some simple reporting strategies might simply be added to `after_run` callbacks,
 A subscriber can be used to listen for experiment events and report them to a service. For example, here's a subscriber that reports to a fictional analytics service:
 
 ```ruby
-class MyAnalyticsSubscriber
+class MyAnalyticsSubscriber < ActiveSupport::Subscriber
+  attach_to :active_experiment
+
   def process_run(event)
     experiment = event.payload[:experiment]
     return if experiment.skipped?
@@ -217,8 +228,6 @@ class MyAnalyticsSubscriber
     )
   end
 end
-
-MyAnalyticsSubscriber.attach_to(:active_experiment)
 ```
 
 The following Active Experiment events are available for subscribers:
@@ -266,7 +275,7 @@ end
 <summary>Expand ERB example</summary>
 
 ```erb
-<%== MyExperiment.set(capture: self).run do |experiment| %>
+<%== MyExperiment.set(capture: self).run(current_user) do |experiment| %>
   <div class="container">
     <%= experiment.on(:red) do %>
       <button class="red-pill">Red</button>
@@ -279,6 +288,19 @@ end
 ```
 </details>
 
+If you don't need to capture the experiment, simply run like you would anywhere else:
+
+```erb
+<% MyExperiment.run(current_user) do |experiment| %>
+  <% experiment.on(:red) do %>
+    <button class="red-pill">Red</button>
+  <% end %>
+  <% experiment.on(:blue) do %>
+    <button class="blue-pill">Blue</button>
+  <% end %>
+<% end %>
+```
+
 ## Client Side Experimentation
 
 While Active Experiment doesn't include any specific tooling for client side experimentation at this time, it does provide the ability to surface experiments in the client layer.
@@ -297,7 +319,7 @@ In the layout, the experiment data can be rendered as JSON for instance:
 Or each experiment can be iterated over and rendered individually:
 
 ```erb
-<% ActiveExperiment::Executed.experiments.each do |experiment| %>
+<% ActiveExperiment::Executed.as_array.each do |experiment| %>
   <meta name="<%= experiment.name %>" content="<%== experiment.serialize.to_json %>">
 <% end %>
 ```
@@ -323,7 +345,7 @@ test "stubbing experiments" do
   end
 
   stub_experiment(MyExperiment, skip: true) do
-    # Now all MyExperiment experiments be skipped.
+    # Now all MyExperiment experiments will be skipped.
   end
 end
 ```
@@ -332,24 +354,24 @@ Assertion helpers are also available:
 
 ```ruby
 test "asserting experiments" do
-  # no experiments has been run
+  # Assert that no experiments have been run.
   assert_no_experiments
 
   MyExperiment.run(id: 1)
 
-  # 1 experiment has been run
+  # Assert that 1 experiment has been run.
   assert_experiments 1
 
-  # 2 experiments expected within the block.
+  # Assert that within the block, 2 experiments will be run.
   assert_experiments 2 do
     MyExperiment.run(id: 2)
     MyExperiment.run(id: 3)
   end
   
-  # assert an experiment has been run with context.
+  # Assert an experiment has been run with a given context.
   assert_experiment_with(MyExperiment, context: { id: 1 })
   
-  # experiment with context, and a variant assigned expected within the block.
+  # Assert that within the block, a matching experiment will be run.
   assert_experiment_with(MyExperiment, variant: :red, context: { id: 4 }) do
     MyExperiment.set(variant: :red).run(id: 4)
   end

data/lib/active_experiment/gem_version.rb

@@ -10,7 +10,7 @@ module ActiveExperiment
   module VERSION
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
     PRE   = "alpha"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/active_experiment/rollouts.rb

@@ -106,6 +106,11 @@ module ActiveExperiment
     # will assign the first defined variant unless the provided methods are
     # overridden.
     class BaseRollout
+      # Convenience method to register the rollout with Active Experiment.
+      def self.register_as(name)
+        Rollouts.register(name, self)
+      end
+
       def initialize(experiment_class, *args, **options, &block) # :nodoc:
         @experiment_class = experiment_class
         @rollout_args = args

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeexperiment
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha
+  version: 0.1.1.alpha
 platform: ruby
 authors:
 - Jeremy Jackson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-10 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport