abtest 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cec62b482674e24404cf39a8d5f0e7603a28fc16
-  data.tar.gz: 48b6d4fbe6e12b4f871e476d8a08535718868a8d
+  metadata.gz: 0852f46342eab358cfacc8f07a5d1db0a7ed3b99
+  data.tar.gz: 4d431be07850f6a8ab6f034f66959083aa435b40
 SHA512:
-  metadata.gz: 1788c07944936edf716f55f91a35d766a96f2bfd1113ea53d5ee1d04a92bde119d2db14254f9b3f46c4788d4a6877fb025497683e77ff6d08f2455cfd857b967
-  data.tar.gz: 5944e39d2d7ddb12d8a13b41e87bb7b34e10391855853742fd46b998d75d236d15bfb9af151e22305c73fbee3a62a23fb850627d352fff49a8ce94b27c45b97d
+  metadata.gz: 364fc08b9a2f310a91962c183500501e61e50996ae566fbfc0854b2215ff43cbcb8675cf106a57a6663ba37a36dac665b51e57bb382ffef29ef5f0f35dc6acfa
+  data.tar.gz: 1b66303675bf12aabc23e13adc702bf9e61e217f14b474e7aea5adcaca480e5cea26115e1d5c591305c7b1a6d368b3011a53c282b9e4454e5da1ed3f73618165

data/README.md

@@ -1,6 +1,10 @@
 # Abtest
 
-TODO: Write a gem description
+A-B testing framework and manager for Rails.  This gem allows the addition of experiments that change view code and assets
+based on the results of a simple test proc.
+
+This gem modifies ActionView::Base as well as the global assets environment to enable overrides in the experiments directory to 
+take effect.
 
 ## Installation
 
@@ -18,7 +22,13 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Once the gem is installed in your Rails application, rou can run the following command to set up an experiment:
+
+    $ bundle exec rake abtest:add_experiment[experiment_name]
+
+To remove all experiments, run the following command:
+
+    $ bundle exec rake abtest:delete_experiments
 
 ## Contributing
 

data/abtest.gemspec

@@ -6,10 +6,10 @@ require 'abtest/version'
 Gem::Specification.new do |spec|
   spec.name          = "abtest"
   spec.version       = Abtest::VERSION
-  spec.authors       = ["Steve Saarinen"]
-  spec.email         = ["ssaarinen@whitepages.com"]
-  spec.description   = %q{Railtie base to enable engine baset AB test modules}
-  spec.summary       = %q{Manages registered AB test engines and provides before_filter to dynamically add load paths for enabled tests}
+  spec.authors       = ["Steve Saarinen", "Keatton Lee"]
+  spec.email         = ["ssaarinen@whitepages.com", "klee@whitepages.com"]
+  spec.description   = %q{Rails based AB test framework}
+  spec.summary       = %q{Manages AB experiments and allows for view and asset context switching for experiments.}
   spec.homepage      = "http://www.whitepages.com"
   spec.license       = "MIT"
 

data/lib/abtest.rb

@@ -3,6 +3,70 @@ require "abtest/railtie"
 require "abtest/processor"
 require "abtest/registry"
 require "abtest/filters"
+require "abtest/asset"
+require 'rails'
 
 module Abtest
+  class ManifestManager
+    include Singleton
+    attr_accessor :manifests
+
+    def initialize
+      @manifests = {}
+    end
+
+    def retrieve_manifest name
+      manifests[name] ||= create_manifest(name)
+    end
+
+    def create_manifest name
+      app                   = Rails.application
+      experiment_path       = File.join(app.root, 'abtest', 'experiments', name)
+      application_css_path  = File.join(experiment_path, app.config.assets.prefix, 'stylesheets')
+      images_path           = File.join(experiment_path, app.config.assets.prefix, 'images')
+      javascript_path       = File.join(experiment_path, app.config.assets.prefix, 'javascript')
+
+      # Create a custom sprockets environment
+      experiment_environment = Sprockets::Environment.new(Rails.root.to_s) do |env|
+        env.context_class.class_eval do
+          include ::Sprockets::Rails::Helper
+        end
+      end
+
+      # Monkey patch class in-place with sass_config accessor
+      experiment_environment.context_class.extend(Sass::Rails::Railtie::SassContext)
+
+      # Always calculate digests and compile files
+      app.config.assets.digest      = true
+      app.config.assets.compile     = true
+      experiment_environment.cache  = :null_store  # Disables the Asset cache
+
+      experiment_environment.prepend_path("#{application_css_path}")
+      experiment_environment.prepend_path("#{images_path}")
+      experiment_environment.prepend_path("#{javascript_path}")
+
+      # Copy config.assets.paths to Sprockets
+      app.config.assets.paths.each do |path|
+        experiment_environment.append_path path
+      end
+
+      experiment_environment.js_compressor  = app.config.assets.js_compressor
+      experiment_environment.css_compressor = app.config.assets.css_compressor
+
+      if app.config.logger
+        experiment_environment.logger = app.config.logger
+      else
+        experiment_environment.logger       = Logger.new($stdout)
+        experiment_environment.logger.level = Logger::INFO
+      end
+
+      output_file                                         = File.join(app.root, 'public', app.config.assets.prefix, 'experiments', name)
+      experiment_environment.context_class.assets_prefix  = "#{app.config.assets.prefix}/experiments/#{name}"
+      experiment_environment.context_class.digest_assets  = app.config.assets.digest
+      experiment_environment.context_class.config         = app.config.action_controller
+      experiment_environment.context_class.sass_config    = app.config.sass
+
+      manifests[name] = Sprockets::Manifest.new(experiment_environment, output_file)
+    end
+  end
 end

data/lib/abtest/asset.rb

@@ -0,0 +1,44 @@
+module Sprockets
+  class Base
+    def find_asset(path, options = {})
+      logical_path = path
+      pathname     = Pathname.new(path)
+
+      if pathname.absolute?
+        return unless stat(pathname)
+        logical_path = attributes_for(pathname).logical_path
+      else
+        begin
+          pathname = resolve(logical_path)
+
+          # If logical path is missing a mime type extension, append
+          # the absolute path extname so it has one.
+          #
+          # Ensures some consistency between finding "foo/bar" vs
+          # "foo/bar.js".
+          if File.extname(logical_path) == ""
+            expanded_logical_path = attributes_for(pathname).logical_path
+            logical_path += File.extname(expanded_logical_path)
+          end
+        rescue FileNotFound
+          # Check to see if we are in an experiment
+          if (path.starts_with?("experiments"))
+            Abtest.abtest_config.registered_tests.each do |test_hash|
+              if (path.starts_with?("experiments/#{test_hash[:name]}"))
+                # Strip experiment path
+                experiment_path = path.sub("experiments/#{test_hash[:name]}/", '')
+
+                # Grab experiment manifest
+                manifest        = Abtest::ManifestManager.instance.retrieve_manifest(test_hash[:name])
+                return manifest.environment.index.find_asset(experiment_path, options)
+              end
+            end
+          end
+          return nil
+        end
+      end
+
+      build_asset(logical_path, pathname, options)
+    end
+  end
+end

data/lib/abtest/asset_task.rb

@@ -0,0 +1,34 @@
+require 'sprockets/rails'
+
+module Abtest
+  class AssetTask < Sprockets::Rails::Task
+    attr_accessor :app
+
+    def initialize(app = nil)
+      self.app = app
+      super(app)
+    end
+
+    def define
+      namespace :abtest do
+        desc "Compile all the assets named in config.assets.precompile"
+        task :precompile => :environment do
+          configured_experiments = app.config.abtest.registered_tests
+
+          # Precompile assets for each experiment
+          configured_experiments.each do |experiment|
+            name      = experiment[:name]
+            manifest  = Abtest::ManifestManager.instance.retrieve_manifest(name)
+
+            # Add our experiments asset path
+            assets << lambda {|filename, path| path =~ /#{name}\/assets/ && !%w(.js .css).include?(File.extname(filename))}
+
+            with_logger do
+              manifest.compile(assets)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abtest/filters.rb

@@ -10,4 +10,4 @@ module Abtest
       Abtest::Processor.process_tests(self)
     end
   end
-end
+end

data/lib/abtest/processor.rb

@@ -3,12 +3,40 @@ require 'rails'
 module Abtest
   class Processor
     def self.process_tests controller
+
+      experiment_activated  = false
+
       Abtest.abtest_config.registered_tests.each do |test_hash|
-        if (test_hash[:check].call(controller.request))
-          controller.prepend_view_path(test_hash[:prefix])
+        app_config      = Rails.application.config
+        environment     = Rails.application.assets
+        experiment_name = test_hash[:name]
+        experiment_path = Rails.root.join('abtest', 'experiments', experiment_name)
+
+        if (test_hash[:check].call(controller.request)  && !experiment_activated)
+          # ensure experimental translations are loaded
+          unless (I18n.load_path || []).last.include?(experiment_name)
+            I18n.load_path = app_config.i18n.load_path + Dir[Rails.root.join('abtest', 'experiments', experiment_name, 'config', 'locales', '*.{rb,yml}').to_s]
+            I18n.reload!
+          end
+
+          manifest = Abtest::ManifestManager.instance.retrieve_manifest(experiment_name)
+
+          # Set view context for asset path
+          controller.view_context_class.assets_prefix       = File.join(app_config.assets.prefix, 'experiments', experiment_name)
+          controller.view_context_class.assets_environment  = manifest.environment
+          controller.view_context_class.assets_manifest     = manifest
+
+          # Prepend the lookup paths for our views
+          controller.prepend_view_path(File.join(experiment_path, 'views'))
+
           test_hash[:process].call(controller) unless test_hash[:process].nil?
+
+          experiment_activated = true
+        elsif (!experiment_activated)
+          # ensure experimental translations are removed
+          I18n.reload! if I18n.load_path.reject! { |path| path.include?(experiment_name) }
         end
       end
     end
   end
-end
+end

data/lib/abtest/railtie.rb

@@ -2,19 +2,35 @@ require 'rails'
 
 module Abtest
   class Railtie < ::Rails::Railtie
+    rake_tasks do |app|
+      require 'abtest/asset_task'
+      Abtest::AssetTask.new(app)
+    end
+
     rake_tasks do
       Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
     end
-  
+
     initializer "abtest.set_config", :after => 'bootstrap_hook' do
-      config.abtest = ActiveSupport::OrderedOptions.new
-      config.abtest.registered_tests = Set.new
+      config.abtest                   = ActiveSupport::OrderedOptions.new
+      config.abtest.registered_tests  = Set.new
+      config.abtest.precompile_assets = Array.new
     end
 
     initializer "abtest.set_filter" do
       ActiveSupport.on_load(:action_controller) do
         ActionController::Base.send(:include, Abtest::Filters)
       end
+
+      module ActionView
+  module Rendering
+    module ClassMethods
+      def view_context
+        view_context_class.new(view_renderer, view_assigns, self)
+      end
+    end
+  end
+end
     end
   end
 end

data/lib/abtest/registry.rb

@@ -2,15 +2,12 @@ require "rails"
 
 module Abtest
   # Register a test.  This method takes the following parameters:
-  # view_path:          View prefix of the directory where your view overrides are located 
+  # name:               Name of the experiment.
   # test:               A lambda used to determine whether or not to activate this test.  The provided
   #                     lambda must return a truthy value for the test to be activated and accept a request object.
   # process (optional): Lambda to run in the case of a test being activated.  Will be passed the controller object.
-  def self.register_test(view_path, test, process = nil)
-    # If this path is already in the configured paths, remove it.
-    # This is used mainly for engine based tests.
-    ActionController::Base.view_paths = ActionController::Base.view_paths.reject {|path| path.to_path == view_path }
-    abtest_config.registered_tests.add({prefix: view_path, check: test, process: process})
+  def self.register_test(name, test, process = nil)
+    abtest_config.registered_tests.add({name: name, check: test, process: process})
   end
 
   def self.abtest_config

data/lib/abtest/tasks/experiments.rake

@@ -2,39 +2,37 @@ namespace :abtest do
   desc "Create a new experiment scaffold. Experiment name is a required arg. (rake abtest:add_experiment[name])"
   task :add_experiment, [:name] => :environment do |t, args|
     name = args[:name]
-    puts "Experiment name is required" and return if name.nil?
 
-    # Check to see if we have a experiments directory
-    FileUtils.mkdir_p("#{Rails.root}/experiments")
+    if (name.nil? || name.blank?)
+      puts "Experiment name is required.  Usage: rake abtest:add_experiment[name]"
+      next
+    end
 
     # Add directories for views and assets
-    experiment_path       = "#{Rails.root}/experiments/#{args[:name]}"
-    application_css_path  = "#{experiment_path}/assets/#{name}/stylesheets"
-    image_path            = "#{experiment_path}/assets/#{name}/images"
-    view_path             = "#{experiment_path}/views"
+    app_config            = Rails.application.config
+    test_root             = File.join(Rails.root, 'abtest')
+    experiment_path       = File.join(test_root, 'experiments', name)
+    application_css_path  = File.join(experiment_path, app_config.assets.prefix, 'stylesheets')
+    images_path           = File.join(experiment_path, app_config.assets.prefix, 'images')
+    javascript_path       = File.join(experiment_path, app_config.assets.prefix, 'javascript')
+    view_path             = File.join(experiment_path, 'views')
+
     FileUtils.mkdir_p(view_path)
     FileUtils.mkdir_p(application_css_path)
-    FileUtils.mkdir_p(image_path)
-
-    # Add template stylesheet
-    css_template = File.read("#{File.dirname(__FILE__)}/templates/application.scss.erb")
-    renderer = ERB.new(css_template)
-    css_result = renderer.result(binding)
-
-    File.open("#{application_css_path}/application.scss", 'w') {|f| f.write(css_result) }
+    FileUtils.mkdir_p(images_path)
+    FileUtils.mkdir_p(javascript_path)
 
     # Create a new initializer file if it doesn't exist already
-    initializer_path = "#{Rails.root}/config/initializers/abtest.rb"
+    initializer_path = File.join(Rails.root, 'config', 'initializers', 'abtest.rb')
     unless File.exists?(initializer_path)
-      initializer_template = File.read("#{File.dirname(__FILE__)}/templates/precompile_config.erb")
-      renderer = ERB.new(initializer_template)
-      result = renderer.result(binding)
-
-      File.open(initializer_path, 'a') { |f| f.write(result) }
+      ab_template = File.read(File.join(File.dirname(__FILE__), 'templates', 'abtest.erb'))
+      renderer    = ERB.new(ab_template)
+      result      = renderer.result(binding)
+      File.open(initializer_path, 'w') {|f| f.write(result) }
     end
 
     # Add template initializer
-    template = File.read("#{File.dirname(__FILE__)}/templates/initializer.erb")
+    template = File.read(File.join(File.dirname(__FILE__), 'templates', 'initializer.erb'))
     renderer = ERB.new(template)
     result = renderer.result(binding)
 
@@ -47,10 +45,10 @@ namespace :abtest do
   desc "Delete all experiments"
   task :delete_experiments => :environment do
     # Remove experiments directory
-    FileUtils.rm_rf("#{Rails.root}/experiments")
+    FileUtils.rm_rf(File.join(Rails.root, 'abtest'))
 
     # Remove initializer
-    FileUtils.rm_f("#{Rails.root}/config/initializers/abtest.rb")
+    FileUtils.rm_f(File.join(Rails.root, 'config', 'initializers', 'abtest.rb'))
 
     puts "All tests removed"
   end

data/lib/abtest/tasks/templates/abtest.erb

@@ -0,0 +1,2 @@
+# Add Root for locating experimental assets
+Rails.application.config.assets.paths << "<%= test_root %>"

data/lib/abtest/tasks/templates/initializer.erb

@@ -13,9 +13,10 @@
    
 }
 
-Abtest.register_test("<%= experiment_path %>", <%= name %>_test, <%= name %>_process)
-Rails.application.config.assets.paths << "<%= experiment_path %>/assets/"
-Rails.application.config.assets.precompile += ['<%= experiment_path %>/assets/<%= name %>/stylesheets/application.scss']
+Abtest.register_test("<%= name %>", <%= name %>_test, <%= name %>_process)
+
+# Add additional files to precompile here
+Rails.application.config.abtest.precompile_assets = []
 
 ################################################
 #

data/lib/abtest/version.rb

@@ -1,3 +1,3 @@
 module Abtest
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: abtest
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Steve Saarinen
+- Keatton Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,9 +53,10 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Railtie base to enable engine baset AB test modules
+description: Rails based AB test framework
 email:
 - ssaarinen@whitepages.com
+- klee@whitepages.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -67,14 +69,15 @@ files:
 - Rakefile
 - abtest.gemspec
 - lib/abtest.rb
+- lib/abtest/asset.rb
+- lib/abtest/asset_task.rb
 - lib/abtest/filters.rb
 - lib/abtest/processor.rb
 - lib/abtest/railtie.rb
 - lib/abtest/registry.rb
 - lib/abtest/tasks/experiments.rake
-- lib/abtest/tasks/templates/application.scss.erb
+- lib/abtest/tasks/templates/abtest.erb
 - lib/abtest/tasks/templates/initializer.erb
-- lib/abtest/tasks/templates/precompile_config.erb
 - lib/abtest/version.rb
 homepage: http://www.whitepages.com
 licenses:
@@ -99,6 +102,6 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Manages registered AB test engines and provides before_filter to dynamically
-  add load paths for enabled tests
+summary: Manages AB experiments and allows for view and asset context switching for
+  experiments.
 test_files: []

data/lib/abtest/tasks/templates/application.scss.erb

@@ -1,3 +0,0 @@
-@import "<%= "#{Rails.root}/app/assets/stylesheets/application" %>";
-
-/* IMPORT YOUR OVERRIDES HERE */

data/lib/abtest/tasks/templates/precompile_config.erb

@@ -1,13 +0,0 @@
-Rails.application.config.assets.precompile << Proc.new do |path|
-  unless path =~ /\.(css|js)\z/
-    full_path = Rails.application.assets.resolve(path).to_path
-    app_assets_path = "<%= experiment_path %>/assets/"
-    if full_path.starts_with? app_assets_path
-      true
-    else
-      false
-    end
-  else
-    false
-  end
-end