abtest 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7003e71f137f358d4486677ee30d33f1b52ec8b7
-  data.tar.gz: e65200ded12e11fcc0b9edd18fd56c702e376dd4
+  metadata.gz: 4158fd4b6a530de6b5e353dd69aa61ef04c2f19c
+  data.tar.gz: 6bce19ab1385172c96192d408c3f85cd498a11ca
 SHA512:
-  metadata.gz: c9791117e91b7a670b98586c2c11dd86c573fac5566a514ae36422119ab71542fedd39b1cf1e2a067a02eb899c67315aea63bc0befe0ecb6656bf80e6e9d2b75
-  data.tar.gz: 6eff296817cf5694fd8d06518311b7198c2ecfb4c7b6f657d503cc6156e064250cd1de060f26980cdea5747a1ad0cf9762d27b42fc234c04a707ad74d135b87a
+  metadata.gz: 1299386c8972fc29df0e07c42041354eecc14399eb211683de867051cb11ae65ad0604b8f1a522ae6c1c3c274f2ac0c414e2088116e3fa7cc33e91feb10f8e58
+  data.tar.gz: 75847dd2c20be03b18ba16e8f8f051b0b32b58325c2d430d0d49422669d61225047274ea223cde38f0a63702982bbae6b8481dc446215215139c6564623b03c1

data/README.md

@@ -3,7 +3,7 @@
 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 
+This gem modifies ActionView::Base as well as the global assets environment to enable overrides in the experiments directory to
 take effect.
 
 ## Installation
@@ -22,10 +22,14 @@ Or install it yourself as:
 
 ## Usage
 
-Once the gem is installed in your Rails application, rou can run the following command to set up an experiment:
+Once the gem is installed in your Rails application, you can run the following command to set up an experiment:
 
     $ bundle exec rake abtest:add_experiment[experiment_name]
 
+To delete an experiment, run the following command:
+
+    $ bundle exec rake abtest:delete_experiment[experiment_name]
+
 To remove all experiments, run the following command:
 
     $ bundle exec rake abtest:delete_experiments

data/lib/abtest.rb

@@ -1,6 +1,5 @@
 require "abtest/version"
 require "abtest/railtie"
-require "abtest/processor"
 require "abtest/registry"
 require "abtest/filters"
 require "abtest/asset"

data/lib/abtest/filters.rb

@@ -7,7 +7,49 @@ module Abtest
     end
 
     def process_abtests
-      Abtest::Processor.process_tests(self)
+      experiment_activated  = false
+
+      Abtest.abtest_config.registered_tests.each do |test_hash|
+        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(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
+          view_context_class.assets_prefix       = File.join(app_config.assets.prefix, 'experiments', experiment_name)
+          view_context_class.assets_environment  = manifest.environment
+          view_context_class.assets_manifest     = manifest
+
+          # Prepend the lookup paths for our views
+          prepend_view_path(File.join(experiment_path, 'views'))
+
+          test_hash[:process].call(binding) 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
+
+      unless experiment_activated
+        # Use default manifest
+        manifest = Abtest::ManifestManager.instance.retrieve_manifest('default')
+
+        # Set view context for asset path
+        view_context_class.assets_prefix       = File.join(Rails.application.config.assets.prefix)
+        view_context_class.assets_environment  = manifest.environment
+        view_context_class.assets_manifest     = manifest
+      end
     end
   end
 end

data/lib/abtest/railtie.rb

@@ -23,15 +23,15 @@ module Abtest
       end
 
       module ActionView
-  module Rendering
-    module ClassMethods
-      def view_context
-        view_context_class.new(view_renderer, view_assigns, self)
+        module Rendering
+          module ClassMethods
+            def view_context
+              view_context_class.new(view_renderer, view_assigns, self)
+            end
+          end
+        end
       end
     end
   end
 end
-    end
-  end
-end
 

data/lib/abtest/tasks/experiments.rake

@@ -16,11 +16,13 @@ namespace :abtest do
     images_path           = File.join(experiment_path, app_config.assets.prefix, 'images')
     javascript_path       = File.join(experiment_path, app_config.assets.prefix, 'javascripts')
     view_path             = File.join(experiment_path, 'views')
+    experiment_init_path  = File.join(Rails.root, 'config', 'initializers', 'abtest')
 
     FileUtils.mkdir_p(view_path)
     FileUtils.mkdir_p(application_css_path)
     FileUtils.mkdir_p(images_path)
     FileUtils.mkdir_p(javascript_path)
+    FileUtils.mkdir_p(experiment_init_path)
 
     # Create a new initializer file if it doesn't exist already
     initializer_path = File.join(Rails.root, 'config', 'initializers', 'abtest.rb')
@@ -36,20 +38,46 @@ namespace :abtest do
     renderer = ERB.new(template)
     result = renderer.result(binding)
 
-    # Append initializer code to end of file
-    File.open(initializer_path, 'a') { |f| f.write(result) }
+    # Create new initializer file
+    init_file_path = File.join(experiment_init_path, "#{name}.rb")
+    File.open(init_file_path, 'a') { |f| f.write(result) }
 
-    puts "Please edit #{initializer_path} to configure experiment."
+    puts "Please edit #{init_file_path} to configure experiment."
   end
 
   desc "Delete all experiments"
   task :delete_experiments => :environment do
     # Remove experiments directory
     FileUtils.rm_rf(File.join(Rails.root, 'abtest'))
+    FileUtils.rm_rf(File.join(Rails.root, 'config', 'initializers', 'abtest'))
 
     # Remove initializer
     FileUtils.rm_f(File.join(Rails.root, 'config', 'initializers', 'abtest.rb'))
 
     puts "All tests removed"
   end
+
+  desc "Delete experiment. Experiment name is a required arg. (rake abtest:delete_experiment[name])"
+  task :delete_experiment, [:name] => :environment do |t, args|
+    name = args[:name]
+
+    if (name.nil? || name.blank?)
+      puts "Experiment name is required.  Usage: rake abtest:add_experiment[name]"
+      next
+    end
+
+    test_root             = File.join(Rails.root, 'abtest')
+    experiment_path       = File.join(test_root, 'experiments', name)
+    experiment_init_path  = File.join(Rails.root, 'config', 'initializers', 'abtest')
+    init_file_path        = File.join(experiment_init_path, "#{name}.rb")
+
+    # Remove experiments directory
+    FileUtils.rm_rf(experiment_path)
+
+    # Remove initializer
+    FileUtils.rm_f(init_file_path)
+
+    puts "Experiment #{name} removed."
+  end
+
 end

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

@@ -1,25 +1,31 @@
 
-################################################
+##########################################################
 #
-# Begin configuration for <%= name %> experiment
+# Configuration for <%= name %> experiment.
 #
-################################################
+# The <%= name %>_test lambda is used to determine
+# whether or not to activate this experiment.  It
+# is passed the current request.
+#
+# You can optionally add any controller processing
+# that would be acceptable in a before filter by
+# using the <%= name %>_process lambda. The processor
+# is passed a binding of the context within a controller
+# before_filter.
+#
+###########################################################
 
-<%= name %>_test = lambda { |request| 
-  false 
+<%= name %>_test = lambda { |request|
+  false
 }
 
-<%= name %>_process = lambda { |controller| 
-   
+# The processor is passed a binding of the context within a controller
+# before_filter.
+<%= name %>_process = lambda { |controller_context_binding|
+
 }
 
 Abtest.register_test("<%= name %>", <%= name %>_test, <%= name %>_process)
 
 # Add additional files to precompile here
-Rails.application.config.abtest.precompile_assets = []
-
-################################################
-#
-# End configuration for <%= name %> experiment
-#
-################################################
+Rails.application.config.abtest.precompile_assets += []

data/lib/abtest/version.rb

@@ -1,3 +1,3 @@
 module Abtest
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abtest
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Steve Saarinen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,7 +86,6 @@ files:
 - 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/asset_precompile.rake
@@ -114,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Manages AB experiments and allows for view and asset context switching for

data/lib/abtest/processor.rb

@@ -1,52 +0,0 @@
-require 'rails'
-
-module Abtest
-  class Processor
-    def self.process_tests controller
-
-      experiment_activated  = false
-
-      Abtest.abtest_config.registered_tests.each do |test_hash|
-        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
-
-      unless experiment_activated
-        # Use default manifest
-        manifest = Abtest::ManifestManager.instance.retrieve_manifest('default')
-
-        # Set view context for asset path
-        controller.view_context_class.assets_prefix       = File.join(Rails.application.config.assets.prefix)
-        controller.view_context_class.assets_environment  = manifest.environment
-        controller.view_context_class.assets_manifest     = manifest
-      end
-    end
-  end
-end