experimental 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 1c78c9b7d6c365503d9c865f63b3e24f7abbdec5
-  data.tar.gz: adc2a47c070863a3a87432d4eca968614155d3a9
-SHA512:
-  metadata.gz: 9eee13366381e3d96a44abc8da8b003c405850a140f96091ec7d8410dad321d3501b4ac3577976217d5a46b279b6cdbc7704cd219dedf6ab1633a05431b480b8
-  data.tar.gz: 755c66a9193290985db2a6852a68c01edd3780fc94672d9691743fc6b02b3407051242ef30c8882b6753e98184e1f9a94850913976b878ba7a3b6cd76541b36d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2Y3MWRjY2E3ZThhNzZhNjFhNWJjMmVhYjA2YTlhNzA3NWUwYzljNQ==
+  data.tar.gz: !binary |-
+    ZDRmMjU5MTg5MDMwMmI4MjM5Y2IwMmU4M2ZmZDY1ZmIyYzZkODliOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDVhMDA3ZDg3YzI1ZjY5ZGI3ZjMzYzU5YWViYWIwZTVhMzg5Mjg2ZTMxMzAy
+    YjIwYzllY2E3OWMyZTI3NmUwM2JlZGM3ZWU3N2UxOTFjMDU5Yzc1YmJjNGJh
+    NTY0ODhlMWQwMjgzYTRlNGE0YzMwMmUyMWEyYzAzZmFmNzkyYmQ=
+  data.tar.gz: !binary |-
+    ZWNiMzRkYzhmMzU2MmQ3NTA3YjVmOGVjOGZiODI2OTFiNmMwOWIzZDdkMmE2
+    YWQ4MDE2OGIyYjQ4MTU3MzE2NmEyMDcwYmI1NjgxYWJmZjE4ODkwOTVmZTA2
+    YTk0YzM4N2UxZjliMTM5MDdjM2MxODc5YTc1NzBkYzA5MmExZDc=

data/README.markdown

@@ -185,6 +185,12 @@ user.in_bucket?(:my_experiment, 0)
 To see if a user is in the experiment population **ONLY**
 ```ruby
 user.in_experiment?(:my_experiment)
+user.not_in_experiment?(:my_experiment) # inverse
+```
+
+To see which bucket of an experiment a user is in:
+```ruby
+user.experiment_bucket(:my_experiment)
 ```
 
 ### Ending an experiment
@@ -214,72 +220,49 @@ Then run `rake experimental:sync`
 
 ## Testing
 
-### Setup
-in `spec_helper.rb` (after inclusion of ActiveSupport)
+In your test suite, you typically want to have an neutral starting state across
+all your tests. For experiments, this means all subjects are out of all
+experiments. You then opt a particular subject into a particular bucket for any
+experiment as your test requires.
 
-```ruby
-require 'experimental/rspec_helpers'
-```
+Experimental ships with support to do this in a number of popular test
+frameworks. Setup instructions for each framework are in the following sections.
 
-*You may want to force experiments off for all tests by default*
-```ruby
-config.before(:each) do
-  User.any_instance.stub(:in_experiment?).and_return(false)
-end
-```
+Once set up, you can then force a subject into a bucket for an experiment as
+follows:
 
-### Testing experiments
-
-Include the Rspec helpers in your spec class or spec_helper
 ```ruby
-include Experimental::RspecHelpers
+set_experimental_bucket(subject, :my_experiment, 1)
 ```
 
-Shared contexts are available for in_experiment? and in_bucket?
+If you set the bucket (1 in the above example) to `nil`, this means set the
+subject to be out of the experiment (the default state).
+
+### Minitest
 ```ruby
-include_context "in experiment"
-include_context "not in experiment"
+require 'experimental/test/unit'
 
-include_context "in experiment bucket 0"
-include_context "in experiment bucket 1"
+class MyTest < Test::Unit::TestCase
+  include Experimental::Test::Unit
+  ...
+end
 ```
 
-Helper methods are also available:
+Note that if you define a `setup` method, then you must remember to call
+`super` (always good practice in general).
 
-**is_in_experiment**
+### RSpec
 ```ruby
-# first param is true for in experiment, false for not in experiment
-# second param is the experiment name
-# third param is the subject object
-is_in_experiment(true, :my_experiment, my_subject)
-
-# if user and experiment_name are defined, you can do
-let(:experiment_name) { :my_experiment }
-let(:user) { User.new }
-is_in_experiment # true if in experiment
-is_in_experiment(false) # true if NOT in experiment
-```
+require 'experimental/test/rspec'
 
-**is_not_in_experiment**
-```ruby
-# first param is name of experiment
-# second param is subject object
-is_not_in_experiment(:my_experiment, my_subject)
-
-# if user and experiment_name are defined, you can do
-let(:experiment_name) { :my_experiment }
-let(:user) { User.new }
-is_not_in_experiment
+RSpec.configure do |config|
+  config.include Experimental::Test::RSpec
+end
 ```
 
-**has_experiment_bucket**
+### Cucumber
 ```ruby
-has_experiment_bucket(1, :my_experiment, my_subject)
-
-# if user and experiment_name are defined, you can do
-let(:experiment_name) { :my_experiment }
-let(:user) { User.new }
-has_experiment_bucket(1)
+require 'experimental/test/cucumber'
 ```
 
 ## Developer Workflow

data/app/models/experimental/experiment.rb

@@ -67,6 +67,7 @@ module Experimental
       self.winning_bucket = nil
       self.start_date = Time.now
       self.end_date = nil
+      self.removed_at = nil
 
       save
     end
@@ -95,8 +96,12 @@ module Experimental
       !removed? && !ended?
     end
 
+    def self.available
+      where(removed_at: nil)
+    end
+
     def self.active
-      where(['removed_at IS NULL AND (end_date IS NULL OR ? <= end_date)', Time.now])
+      available.where(['end_date IS NULL OR ? <= end_date', Time.now])
     end
 
     def to_sql_formula(subject_table = "users")

data/lib/experimental/source/active_record.rb

@@ -5,8 +5,8 @@ module Experimental
         Experiment.find_by_name(name)
       end
 
-      def active
-        Experiment.active.all
+      def available
+        Experiment.available.all
       end
     end
   end

data/lib/experimental/source/base.rb

@@ -6,8 +6,8 @@ module Experimental
         raise NotImplementedError, 'abstract'
       end
 
-      # Return all active experiments.
-      def active
+      # Return all non-removed experiments.
+      def available
         raise NotImplementedError, 'abstract'
       end
     end

data/lib/experimental/source/cache.rb

@@ -19,7 +19,7 @@ module Experimental
         cache[name.to_s]
       end
 
-      def active
+      def available
         refresh if dirty?
         cache.values
       end
@@ -35,7 +35,7 @@ module Experimental
 
       def refresh
         cache.clear
-        source.active.each do |experiment|
+        source.available.each do |experiment|
           cache[experiment.name] = experiment
         end
         self.last_update = Time.now.to_f

data/lib/experimental/source/configuration.rb

@@ -13,7 +13,7 @@ module Experimental
         @experiments[name.to_s]
       end
 
-      def active
+      def available
         @experiments.values
       end
     end

data/lib/experimental/test/cucumber.rb

@@ -0,0 +1,5 @@
+require 'experimental/test'
+
+Experimental::Test.initialize
+Before { Experimental::Test.setup }
+World(Experimental::Test)

data/lib/experimental/test/rspec.rb

@@ -0,0 +1,12 @@
+module Experimental
+  module Test
+    module RSpec
+      include Test
+
+      def self.included(base)
+        Test.initialize
+        base.before(:each) { Test.setup }
+      end
+    end
+  end
+end

data/lib/experimental/test/unit.rb

@@ -0,0 +1,16 @@
+module Experimental
+  module Test
+    module Unit
+      include Test
+
+      def self.included(base)
+        Test.initialize
+      end
+
+      def setup
+        Test.setup
+        super
+      end
+    end
+  end
+end

data/lib/experimental/test.rb

@@ -1,14 +1,22 @@
 module Experimental
+  # Test helpers for applications that use Experimental.
+  #
+  # For popular test frameworks, simply require the appropriate
+  # experimental/test/*.rb file. If those doesn't cover you, check one of those
+  # to see how to hook up your favorite framework.
   module Test
-    def self.included(base)
-      base.before do
-        Experimental.source = Experimental::Source::Configuration.new
-        Experimental.overrides.reset
-      end
+    # Call this once to initialize Experimental for your test suite.
+    #
+    # Calling it again isn't harmful, just unnecessary.
+    def self.initialize
+      return if @initialized
+      Experimental.source = Experimental::Source::Configuration.new
+      @initialized = true
+    end
 
-      base.after do
-        Experimental.overrides.reset
-      end
+    # Call this before each test.
+    def self.setup
+      Experimental.overrides.reset
     end
 
     # Force the given subject into the given +bucket+ of the given +experiment+.

data/lib/experimental/version.rb

@@ -1,5 +1,5 @@
 module Experimental
-  VERSION = [0, 2, 0]
+  VERSION = [0, 2, 1]
 
   class << VERSION
     include Comparable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: experimental
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - HowAboutWe.com
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,98 +30,98 @@ dependencies:
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activeadmin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: AB Test framework for Rails
@@ -152,6 +152,9 @@ files:
 - lib/experimental/source/cache.rb
 - lib/experimental/source/configuration.rb
 - lib/experimental/source.rb
+- lib/experimental/test/cucumber.rb
+- lib/experimental/test/rspec.rb
+- lib/experimental/test/unit.rb
 - lib/experimental/test.rb
 - lib/experimental/version.rb
 - lib/experimental.rb
@@ -173,17 +176,17 @@ 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.1.9
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Adds support for database-backed AB tests in Rails apps