experimental 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Zjc0ZjhjZGU1OTRjYzA0YjY2MjM2NDVhOTQ2NjY1MGJjNjFiZWUyYg==
-  data.tar.gz: !binary |-
-    N2Q1ZDM5OTk4NWYyMzNmYjY5OWNlOWVjNzFlMTUxYzZjMjRlZTUyNg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZGVmMGFjYWNkZWExMGJmNWRiNmVmMjRiZWQzMTUyNGFhZGRmNThiODI2MTg3
-    NTQzMjI4NzBmZGJkNmFlNDI5YTM2MThmMmJkY2JiZWVkODBhZTcyZmM0OWVm
-    NzQzNGUwOGMwMGVjZjhiM2QzM2NhNmQxYTAyMDJhNTI3NzIyNjE=
-  data.tar.gz: !binary |-
-    N2Q3ZjM1OWRjN2NiMzA4ZWExYWU5ODY0ZDcxMjA5NTgzOWI4OWE2OWIzNmJk
-    MjM1Njk1NTk4Mjc1NWRmNzM4N2YwM2M1YjViZmRlODFlMDIxOWRkM2I1NmU3
-    MWNiODNhMmEzOGZhMDBkM2JlMDY1MjRkN2Q5MTNjYWEyZDQ1ZmU=
+SHA1:
+  metadata.gz: 1c78c9b7d6c365503d9c865f63b3e24f7abbdec5
+  data.tar.gz: adc2a47c070863a3a87432d4eca968614155d3a9
+SHA512:
+  metadata.gz: 9eee13366381e3d96a44abc8da8b003c405850a140f96091ec7d8410dad321d3501b4ac3577976217d5a46b279b6cdbc7704cd219dedf6ab1633a05431b480b8
+  data.tar.gz: 755c66a9193290985db2a6852a68c01edd3780fc94672d9691743fc6b02b3407051242ef30c8882b6753e98184e1f9a94850913976b878ba7a3b6cd76541b36d

data/README.markdown

@@ -12,135 +12,134 @@ be removed make the site explode
 
 ## Installation
 
-```rails g experimental```
+`rails g experimental`
 
 ### Routes
 
-````
-    resources :experiments, :only => [:index, :new, :create] do
+```ruby
+resources :experiments, only: [:index, :new, :create] do
+  collection do
+    get :inactive
+      post :set_winner
+    end
+  end
+
+  namespace :singles_admin do
+    resources :experiments, only: [:index, :new, :create] do
       collection do
         get :inactive
         post :set_winner
       end
     end
-````
-
-````
-    namespace :singles_admin do
-      resources :experiments, :only => [:index, :new, :create] do
-        collection do
-          get :inactive
-          post :set_winner
-        end
-      end
-    end
-````
+  end
+end
+```
 
 ### Admin Frontend
 
 #### Create your own admin controller:
-````
-    class Admin::ExperimentsController < ApplicationController
-      include Experimental::ControllerActions
-
-      alias_method :index, :experiments_index
-      alias_method :new, :experiments_new
-      alias_method :set_winner, :experiments_set_winner
-
-      def create
-        if experiments_create
-          redirect_to admin_experiments_path
-        else
-          render :new
-        end
-      end
-
-      def base_resource_name
-        "singles_admin_experiment"
-      end
-
+```ruby
+class Admin::ExperimentsController < ApplicationController
+  include Experimental::ControllerActions
+
+  alias_method :index, :experiments_index
+  alias_method :new, :experiments_new
+  alias_method :set_winner, :experiments_set_winner
+
+  def create
+    if experiments_create
+      redirect_to admin_experiments_path
+    else
+      render :new
     end
-````
-
-#### Using ActiveAdmin:
-
-``` rails g active_admin:resource Experiment```
-
-````
-    require 'experimental/controller_actions'
+  end
 
-    ActiveAdmin.register Experimental::Experiment, as: "Experiment" do
-      actions :index, :new, :create
-      filter :name
-
-      controller do
-        class_eval do
-          include Experimental::ControllerActions
-        end
-
-        def base_resource_name
-          "admin_experiment"
-        end
+  def base_resource_name
+    "singles_admin_experiment"
+  end
+end
+```
 
-        def create
-          if experiments_create
-            redirect_to admin_experiments_path
-          else
-            render :new
-          end
-        end
+#### Using ActiveAdmin:
 
-        def new
-          experiments_new
-        end
-      end
+`rails g active_admin:resource Experiment`
 
-     # collection_actions force active_admin to create a route
-     collection_action :set_winner, method: :post do
-        experiments_set_winner
-      end
+```ruby
+require 'experimental/controller_actions'
 
-      # can do this instead of the ended_or_removed scope below
-      # you will need to add a link to inactive_admins_experiments_path
-      #  in your view
-      collection_action :inactive do
-        experiments_inactive
-        render template: 'admin/experiments/index'
-      end
+ActiveAdmin.register Experimental::Experiment, as: "Experiment" do
+  actions :index, :new, :create
+  filter :name
 
-      scope :in_progress, :default => true do |experiments|
-        experiments.in_progress
-      end
+  controller do
+    class_eval do
+      include Experimental::ControllerActions
+    end
 
-      scope :ended_or_removed do |experiments|
-        @include_inactive = true
-        experiments.ended_or_removed
-      end
+    def base_resource_name
+      "admin_experiment"
+    end
 
-      index do
-        render template: 'admin/experiments/index'
+    def create
+      if experiments_create
+        redirect_to admin_experiments_path
+      else
+        render :new
       end
-
-      form :partial => 'new'
     end
 
-````
+    def new
+      experiments_new
+    end
+  end
+
+  # collection_actions force active_admin to create a route
+  collection_action :set_winner, method: :post do
+    experiments_set_winner
+  end
+
+  # can do this instead of the ended_or_removed scope below
+  # you will need to add a link to inactive_admins_experiments_path
+  #  in your view
+  collection_action :inactive do
+    experiments_inactive
+    render template: 'admin/experiments/index'
+  end
+
+  scope :in_progress, :default => true do |experiments|
+    experiments.in_progress
+  end
+
+  scope :ended_or_removed do |experiments|
+    @include_inactive = true
+    experiments.ended_or_removed
+  end
+
+  index do
+    render template: 'admin/experiments/index'
+  end
+
+  form partial: 'new'
+end
+```
 
 #### Views
 
 create an index and new view in appropriate view folder, i.e.
 
-``` app/views/admin/experiments/index.html.erb ```
-````
-    <%= render partial: 'experimental/links' %>
-    <%= render partial: 'experimental/index' %>
-````
+`app/views/admin/experiments/index.html.erb`
 
-``` app/views/admin/experiments/new.html.erb ```
-````
-    <%= render partial: 'experimental/links' %>
-    <%= render partial: 'experimental/new' %>
-````
+```erb
+<%= render partial: 'experimental/links' %>
+<%= render partial: 'experimental/index' %>
+```
+
+`app/views/admin/experiments/new.html.erb`
+
+```erb
+<%= render partial: 'experimental/links' %>
+<%= render partial: 'experimental/new' %>
+```
 
 *Note: ActiveAdmin users will not need to include the links
   partials*
@@ -149,20 +148,20 @@ create an index and new view in appropriate view folder, i.e.
 
 For the class you'd like to be the subject of experiments, include the
 Experimental::Subject module in a model with an id and timestamps
-````
-    class User < ActiveRecord::Base
-        include Experimental::Subject
-        ...
-````
-
+```ruby
+class User < ActiveRecord::Base
+  include Experimental::Subject
+  # ...
+end
+```
 
 ## Usage
 
 ### Create an experiment
 
-In `config/experiments.yml`, add the name, num_buckets, and notes of the
+In `config/experimental.yml`, add the name, num_buckets, and notes of the
 experiment under in_code:
-````
+```yaml
 in_code:
 -
   name: :price_experiment
@@ -171,22 +170,22 @@ in_code:
     0: $22
     1: $19.99
 
-````
-Then run `rake experiments:sync`
+```
+Then run `rake experimental:sync`
 
 ### Using the experiment
 
 To see if a user is in the experiment population AND in a bucket:
-````
-    #checks if the user is in the my_experiment population
-    #  and if they are in bucket 0
-    user.in_bucket?(:my_experiment, 0)
-````
+```ruby
+# checks if the user is in the my_experiment population
+# and if they are in bucket 0
+user.in_bucket?(:my_experiment, 0)
+```
 
 To see if a user is in the experiment population **ONLY**
-````
-    user.in_experiment?(:my_experiment)
-````
+```ruby
+user.in_experiment?(:my_experiment)
+```
 
 ### Ending an experiment
 
@@ -203,128 +202,124 @@ A removed experiment is an experiment that is not referenced
 anywhere in code.  In fact, the framework will throw an exception
 if you reference an experiment that is not in code.
 
-Moving an experiment from the in_code to the removed section of
-`config/experiments.yml` and running `rake experiments:sync` will
-remove the experiment and expire the cache.
+Removing an experiment from `config/experimental.yml` and running `rake
+experimental:sync` will remove the experiment and expire the cache.
 
-````
+```yaml
 removed:
 -
   name: :price_experiment
-````
-Then run `rake experiments:sync`
-
-
+```
+Then run `rake experimental:sync`
 
 ## Testing
 
 ### Setup
-in ```spec_helper.rb``` (after inclusion of ActiveSupport)
+in `spec_helper.rb` (after inclusion of ActiveSupport)
 
-````
-    require 'experimental/rspec_helpers'
-````
+```ruby
+require 'experimental/rspec_helpers'
+```
 
 *You may want to force experiments off for all tests by default*
-````
-    config.before(:each) do
-      User.any_instance.stub(:in_experiment?).and_return(false)
-    end
-````
+```ruby
+config.before(:each) do
+  User.any_instance.stub(:in_experiment?).and_return(false)
+end
+```
 
 ### Testing experiments
 
 Include the Rspec helpers in your spec class or spec_helper
-````
-    include Experimental::RspecHelpers
-````
+```ruby
+include Experimental::RspecHelpers
+```
 
 Shared contexts are available for in_experiment? and in_bucket?
-````
-    include_context "in experiment"
-    include_context "not in experiment"
-    
-    include_context "in experiment bucket 0"
-    include_context "in experiment bucket 1"
+```ruby
+include_context "in experiment"
+include_context "not in experiment"
+
+include_context "in experiment bucket 0"
+include_context "in experiment bucket 1"
 ```
 
 Helper methods are also available:
 
 **is_in_experiment**
-````
-    # 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
-````
+```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
+```
 
 **is_not_in_experiment**
-````
-    # 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
-````
+```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
+```
 
 **has_experiment_bucket**
-````
-    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)
-
-````
-
+```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)
+```
 
 ## Developer Workflow
 
-Experiments *can* be defined in config/experiments.yml
-Running the rake task `rake experiments:sync` will load those
+Experiments *can* be defined in `config/experimental.yml`
+Running the rake task `rake experimental:sync` will load those
 experiments under 'in_code' into the database and set removed_at
 timestamp for those under 'removed'
 
 You will likely want to automate the running of `rake
-experiments:sync` by adding to your deploy file.
+experimental:sync` by adding to your deploy file.
 
 ### Capistrano
 In `config/deploy.rb`:
 
 Create a namespace to run the task:
-````
-    namespace :database do
-      desc "Sync experiments"
-      task :sync_from_app, roles: :db, only: { primary: true } do
-        run "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec rake experiments:sync"
-      end
-    end
-````
+```ruby
+namespace :database do
+  desc "Sync experiments"
+  task :sync_from_app, roles: :db, only: { primary: true } do
+    run "cd #{current_path} && RAILS_ENV=#{rails_env} bundle exec rake experimental:sync"
+  end
+end
+```
 
 Include that in the deploy:default task:
-````
-    namespace :deploy do
-      ...
-      task :default do
-        begin
-          update_code
-          migrate
-          database.sync_from_app
-          restart
-       ...
-````
+```ruby
+namespace :deploy do
+  #...
+  task :default do
+    begin
+      update_code
+      migrate
+      database.sync_from_app
+      restart
+    #...
+    end
+  end
+end
+```
 
 ### Admin created experiments
 
@@ -332,6 +327,5 @@ The purpose of Admin created experiments are for experiments
 that will flow through to another system, such as an email provider.
 They likely start with a known string and are dynamically sent in
 code.
-Otherwise, Admin created experiments will do nothing as their is no
+Otherwise, Admin created experiments will do nothing as there is no
 code attached to them. 
-

data/app/models/experimental/experiment.rb

@@ -2,10 +2,7 @@ module Experimental
   class Experiment < ActiveRecord::Base
     extend Population::Filter
 
-    cattr_accessor :use_cache
-    @@use_cache = true
-
-    attr_accessible :name, :num_buckets, :notes
+    attr_accessible :name, :num_buckets, :notes, :population
 
     validates_presence_of :name, :num_buckets
     validates_numericality_of :num_buckets, :greater_than_or_equal_to => 2
@@ -14,8 +11,6 @@ module Experimental
       :less_than => :num_buckets,
       :if => :ended?
 
-    after_create :expire_cache
-
     def self.in_code
       where(:removed_at => nil)
     end
@@ -37,38 +32,43 @@ module Experimental
     end
 
     def self.[](experiment_name)
-      if use_cache
-        Cache.get(experiment_name)
-      else
-        find_by_name(experiment_name.to_s)
-      end
-    end
-
-    def self.expire_cache
-      Cache.expire_last_updated if use_cache
-    end
-
-    def expire_cache
-      Experiment.expire_cache
+      Experimental.source[experiment_name.to_s]
     end
 
     def bucket(subject)
-      (ended? || removed?) ? winning_bucket : bucket_number(subject)
+      if ended? || removed?
+        winning_bucket
+      elsif Experimental.overrides.include?(subject, name)
+        Experimental.overrides[subject, name]
+      else
+        bucket_number(subject)
+      end
     end
 
     def in?(subject)
-      return false if removed?
-      population_filter.in?(subject, self)
+      if removed?
+        false
+      elsif Experimental.overrides.include?(subject, name)
+        !!Experimental.overrides[subject, name]
+      else
+        population_filter.in?(subject, self)
+      end
     end
 
     def end(winning_num)
       self.winning_bucket = winning_num
       self.end_date = Time.now
-      result = save
+      save
+    end
 
-      Experiment.expire_cache if result
+    def restart
+      return unless ended?
 
-      result
+      self.winning_bucket = nil
+      self.start_date = Time.now
+      self.end_date = nil
+
+      save
     end
 
     def remove
@@ -78,7 +78,6 @@ module Experimental
         result = update_attributes(
           { removed_at: Time.now }, without_protection: true
         )
-        expire_cache if result
       end
 
       result
@@ -96,6 +95,10 @@ module Experimental
       !removed? && !ended?
     end
 
+    def self.active
+      where(['removed_at IS NULL AND (end_date IS NULL OR ? <= end_date)', Time.now])
+    end
+
     def to_sql_formula(subject_table = "users")
       "CONV(SUBSTR(SHA1(CONCAT(\"#{name}\",#{subject_table}.id)),1,8),16,10) % #{num_buckets}"
     end

data/app/models/experimental/subject.rb

@@ -1,7 +1,7 @@
 module Experimental
   module Subject
     def in_experiment?(name)
-      Experiment[name].try { |e| e.in?(self) }
+      Experimental.source[name].try { |e| e.in?(self) }
     end
 
     def not_in_experiment?(name)
@@ -9,7 +9,7 @@ module Experimental
     end
 
     def experiment_bucket(name)
-      Experiment[name].try { |e| e.bucket(self) }
+      Experimental.source[name].try { |e| e.in?(self) ? e.bucket(self) : nil }
     end
 
     def in_bucket?(name, bucket)

data/lib/experimental/loader.rb

@@ -0,0 +1,34 @@
+require 'logger'
+
+module Experimental
+  class Loader
+    def initialize(options = {})
+      @logger = options[:logger] || Logger.new('/dev/null')
+    end
+
+    attr_reader :logger
+
+    def sync
+      logger.info "Synchronizing experiments..."
+
+      Experimental::Experiment.transaction do
+        active = Experimental.experiment_data.map do |name, attributes|
+          experiment = Experimental::Experiment.find_or_initialize_by_name(name)
+          logger.info "  * #{experiment.id ? 'updating' : 'creating'} #{name}"
+          experiment.assign_attributes(attributes)
+          experiment.start_date ||= Time.now
+          experiment.tap(&:save!)
+        end
+
+        scope = Experimental::Experiment.in_code
+        scope = scope.where('id NOT IN (?)', active.map(&:id)) unless active.empty?
+        scope.find_each do |experiment|
+          logger.info "  * removing #{experiment.name}"
+          experiment.remove
+        end
+      end
+
+      logger.info "Done."
+    end
+  end
+end

data/lib/experimental/overrides.rb

@@ -0,0 +1,28 @@
+module Experimental
+  class Overrides
+    def initialize
+      @overrides ||= Hash.new do |experiment_overrides, experiment_name|
+        experiment_overrides[experiment_name] = {}
+      end
+    end
+
+    def include?(subject, experiment_name)
+      experiment_name = experiment_name.to_s
+      @overrides.key?(experiment_name) && @overrides[experiment_name].key?(subject)
+    end
+
+    def [](subject, experiment_name)
+      experiment_name = experiment_name.to_s
+      @overrides[experiment_name][subject]
+    end
+
+    def []=(subject, experiment_name, bucket)
+      experiment_name = experiment_name.to_s
+      @overrides[experiment_name][subject] = bucket
+    end
+
+    def reset
+      @overrides.clear
+    end
+  end
+end

data/lib/experimental/railtie.rb

@@ -0,0 +1,13 @@
+module Experimental
+  class Railtie < Rails::Railtie
+    initializer "experimental.initialize" do
+      config_path = "#{Rails.root}/config/experimental.yml"
+      if File.exist?(config_path)
+        full = YAML.load_file(config_path)
+        configuration = full[Rails.env] || {}
+        configuration.update(full.slice('experiments'))
+        Experimental.configure(configuration)
+      end
+    end
+  end
+end

data/lib/experimental/source/active_record.rb

@@ -0,0 +1,13 @@
+module Experimental
+  module Source
+    class ActiveRecord < Base
+      def [](name)
+        Experiment.find_by_name(name)
+      end
+
+      def active
+        Experiment.active.all
+      end
+    end
+  end
+end

data/lib/experimental/source/base.rb

@@ -0,0 +1,15 @@
+module Experimental
+  module Source
+    class Base
+      # Return the experiment with the given name (Symbol or String)
+      def [](name)
+        raise NotImplementedError, 'abstract'
+      end
+
+      # Return all active experiments.
+      def active
+        raise NotImplementedError, 'abstract'
+      end
+    end
+  end
+end

data/lib/experimental/source/cache.rb

@@ -0,0 +1,45 @@
+module Experimental
+  module Source
+    class Cache < Base
+      # A cache source provides in memory caching around another source.
+      #
+      # If a +:ttl+ option is passed, experiments will only be cached for that
+      # many seconds, otherwise it is cached forever.
+      def initialize(source, options = {})
+        @source = source
+        @ttl = options[:ttl]
+        @last_update = nil
+        @cache = {}
+      end
+
+      attr_reader :source, :ttl
+
+      def [](name)
+        refresh if dirty?
+        cache[name.to_s]
+      end
+
+      def active
+        refresh if dirty?
+        cache.values
+      end
+
+      private
+
+      attr_accessor :cache, :last_update
+
+      def dirty?
+        return true if last_update.nil?
+        ttl ? (Time.now.to_f - last_update > ttl) : false
+      end
+
+      def refresh
+        cache.clear
+        source.active.each do |experiment|
+          cache[experiment.name] = experiment
+        end
+        self.last_update = Time.now.to_f
+      end
+    end
+  end
+end

data/lib/experimental/source/configuration.rb

@@ -0,0 +1,21 @@
+module Experimental
+  module Source
+    class Configuration < Base
+      def initialize
+        @experiments = {}
+        Experimental.experiment_data.each do |name, attributes|
+          experiment = Experiment.new(attributes) { |e| e.name = name }
+          @experiments[experiment.name] = experiment
+        end
+      end
+
+      def [](name)
+        @experiments[name.to_s]
+      end
+
+      def active
+        @experiments.values
+      end
+    end
+  end
+end

data/lib/experimental/source.rb

@@ -0,0 +1,8 @@
+module Experimental
+  module Source
+    autoload :ActiveRecord, 'experimental/source/active_record'
+    autoload :Base, 'experimental/source/base'
+    autoload :Cache, 'experimental/source/cache'
+    autoload :Configuration, 'experimental/source/configuration'
+  end
+end

data/lib/experimental/test.rb

@@ -0,0 +1,21 @@
+module Experimental
+  module Test
+    def self.included(base)
+      base.before do
+        Experimental.source = Experimental::Source::Configuration.new
+        Experimental.overrides.reset
+      end
+
+      base.after do
+        Experimental.overrides.reset
+      end
+    end
+
+    # Force the given subject into the given +bucket+ of the given +experiment+.
+    #
+    # If +bucket+ is nil, exclude the user from the experiment.
+    def set_experimental_bucket(subject, experiment_name, bucket)
+      Experimental.overrides[subject, experiment_name] = bucket
+    end
+  end
+end

data/lib/experimental/version.rb

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

data/lib/experimental.rb

@@ -4,8 +4,51 @@ require 'experimental/engine'
 module Experimental
   autoload :VERSION, 'experimental/version'
   autoload :ControllerActions, 'experimental/controller_actions'
+  autoload :Loader, 'experimental/loader'
+  autoload :Overrides, 'experimental/overrides'
+  autoload :Source, 'experimental/source'
+  autoload :Test, 'experimental/test'
 
-  def self.register_population_filter(name, filter_class)
-    Experiment.register_population_filter(name, filter_class)
+  class << self
+    def configure(configuration)
+      source = Source::ActiveRecord.new
+      if (ttl = configuration['cache_for'])
+        source = Source::Cache.new(source, ttl: ttl)
+      end
+      self.experiment_data = configuration['experiments']
+      self.source = source
+    end
+
+    def register_population_filter(name, filter_class)
+      Experiment.register_population_filter(name, filter_class)
+    end
+
+    def source=(source)
+      @experimental_source = source
+    end
+
+    def source
+      @experimental_source ||= Source::ActiveRecord.new
+    end
+
+    def experiment_data=(data)
+      @experimental_data = data
+    end
+
+    def experiment_data
+      @experimental_data ||= {}
+    end
+
+    def reset
+      self.source = nil
+      self.experiment_data = nil
+      Experiment.reset_population_filters
+    end
+  end
+
+  def self.overrides
+    Thread.current[:experimental_overrides] ||= Overrides.new
   end
 end
+
+require 'experimental/railtie' if defined?(Rails)

data/lib/tasks/{experiment.rake → experimental.rake}

@@ -1,6 +1,7 @@
-namespace :experiments do
+namespace :experimental do
   desc "sync experiments from config/experiment.yml into the database"
   task :sync => :environment do
-    Experimental::Experiment::Loader.sync(true)
+    logger = Logger.new(STDOUT)
+    Experimental::Loader.new(logger: logger).sync
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: experimental
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HowAboutWe.com
@@ -10,104 +10,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - <=
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - <=
       - !ruby/object:Gem::Version
-        version: 3.2.6
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   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
@@ -117,9 +131,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/models/experimental/cache.rb
 - app/models/experimental/experiment.rb
-- app/models/experimental/loader.rb
 - app/models/experimental/population/default.rb
 - app/models/experimental/population/filter.rb
 - app/models/experimental/population/new_users.rb
@@ -131,18 +143,27 @@ files:
 - config/routes.rb
 - lib/experimental/controller_actions.rb
 - lib/experimental/engine.rb
+- lib/experimental/loader.rb
+- lib/experimental/overrides.rb
+- lib/experimental/railtie.rb
 - lib/experimental/rspec_helpers.rb
+- lib/experimental/source/active_record.rb
+- lib/experimental/source/base.rb
+- lib/experimental/source/cache.rb
+- lib/experimental/source/configuration.rb
+- lib/experimental/source.rb
+- lib/experimental/test.rb
 - lib/experimental/version.rb
 - lib/experimental.rb
 - lib/generators/experimental/experimental_generator.rb
 - lib/generators/experimental/templates/create_experiments_table.rb
 - lib/generators/experimental/templates/experimental.rb
 - lib/generators/experimental/templates/experiments.yml
-- lib/tasks/experiment.rake
+- lib/tasks/experimental.rake
 - MIT-LICENSE
 - Rakefile
 - README.markdown
-homepage: http://wwww.github.com/howaboutwe/experimental
+homepage: https://github.com/howaboutwe/experimental
 licenses:
 - MIT
 metadata: {}
@@ -152,17 +173,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.0.3
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Adds support for database-backed AB tests in Rails apps

data/app/models/experimental/cache.rb

@@ -1,69 +0,0 @@
-module Experimental
-  class Cache
-    cattr_accessor :interval
-    cattr_reader :last_check
-    cattr_reader :last_update
-    cattr_reader :experiments
-    cattr_accessor :cache_race_condition_ttl
-    @@cache_race_condition_ttl = 10
-    cattr_accessor :cache_key
-
-    class << self
-      def get(name)
-        unless within_interval?
-          if need_update?(last_cached_update)
-            @@experiments = experiments_to_hash(Experiment.in_code)
-            @@last_update = Time.now
-          end
-        end
-        experiments[name.to_sym]
-      end
-
-      def [](name)
-        get(name)
-      end
-
-      def interval
-        @@interval ||= 5.minutes
-      end
-
-      def last_check
-        @@last_check ||=
-          Time.now - interval - 1.minute
-      end
-
-      def last_update
-        @@last_update ||= last_cached_update
-      end
-
-      def cache_key
-        @@cache_key ||= "experiments_last_update"
-      end
-
-      def within_interval?
-        (Time.now - last_check) < interval
-      end
-
-      def need_update?(last_cached_update_time)
-        experiments.nil? || last_update < last_cached_update_time
-      end
-
-      def experiments_to_hash(experiments)
-        HashWithIndifferentAccess.new.tap do |h|
-          experiments.each { |e| h[e.name.to_sym] = e }
-        end
-      end
-
-      def last_cached_update
-        # setting a default to 1 minute ago will force all servers to update
-        Rails.cache.fetch(cache_key, :race_condition_ttl => cache_race_condition_ttl ) do
-          Experiment.last_updated_at || 1.minute.ago
-        end
-      end
-
-      def expire_last_updated
-        Rails.cache.delete(cache_key)
-      end
-    end
-  end
-end

data/app/models/experimental/loader.rb

@@ -1,64 +0,0 @@
-module Experimental
-  class Loader
-    cattr_accessor :file_path
-    @@file_path = 'config/experiments.yml'
-
-    @@whitelisted_attributes = [:name, :num_buckets, :notes, :population]
-
-    class << self
-      def sync(verbose = false)
-        puts "Loading experiments ..." if verbose
-        experiments = load_experiments
-
-        #new/active
-        experiments.in_code.each do |exp|
-          name = exp.with_indifferent_access[:name]
-          puts "\tUpdating #{name} ..." if verbose
-
-          exp = whitelisted_attrs(exp)
-          e = Experimental::Experiment.find_by_name(name) || Experimental::Experiment.new
-
-          puts "\t\tcreating ..." if verbose && e.id.nil?
-          puts "\t\tupdating ..." if verbose && !e.id.nil?
-
-          exp.merge!({ start_date: Time.now }) if e.start_date.nil?
-          e.update_attributes!(exp, without_protection: true)
-        end unless experiments.in_code.nil?
-
-        #removed
-        experiments.removed.each do |exp|
-          name = exp.with_indifferent_access[:name]
-          puts "\tRemoving #{name} ..." if verbose
-
-          exp = whitelisted_attrs(exp)
-          e = Experimental::Experiment.find_by_name(name)
-
-          if e && e.removed_at.nil?
-            puts "\t\t#{name} exists, removing ..." if verbose
-            result = e.remove
-            puts "\t\t\t#{result}" if verbose
-          else
-            puts "\t\t#{name} doesn't exist!" if verbose
-          end
-        end unless experiments.removed.nil?
-
-        puts "Expiring cache ..." if verbose
-        Experimental::Experiment.expire_cache
-
-        puts "Done syncing experiments!" if verbose
-      end
-
-      private
-
-      def load_experiments
-        OpenStruct.new YAML.load_file(File.join(Rails.root, file_path))
-      end
-
-      def whitelisted_attrs(exp)
-        exp.
-          select { |k, v| @@whitelisted_attributes.include?(k.to_sym) }.
-          with_indifferent_access
-      end
-    end
-  end
-end