trailguide 0.2.1 → 0.3.0

data/lib/trail_guide/helper.rb

@@ -1,3 +1,6 @@
+require 'trail_guide/helper/helper_proxy'
+require 'trail_guide/helper/experiment_proxy'
+
 module TrailGuide
   module Helper
     def trailguide(key=nil, **opts, &block)
@@ -13,6 +16,7 @@ module TrailGuide
       @trailguide_participant
     end
 
+    # TODO maybe move this to the experiment proxy so it can be configured per-experiment
     def trailguide_excluded_request?
       @trailguide_excluded_request ||= instance_exec(self, &TrailGuide.configuration.request_filter)
     end
@@ -61,221 +65,5 @@ module TrailGuide
         instance_exec(&@ip_address_filter_proc)
       end
     end
-
-    class HelperProxy
-      attr_reader :context
-
-      def initialize(context, participant: nil)
-        @context = context
-        @participant = participant
-      end
-
-      def new(key)
-        ExperimentProxy.new(context, key, participant: participant)
-      end
-
-      def choose!(key, **opts, &block)
-        new(key).choose!(**opts, &block)
-      end
-      alias_method :enroll!, :choose!
-
-      def choose(key, **opts, &block)
-        new(key).choose(**opts, &block)
-      end
-      alias_method :enroll, :choose
-
-      def run!(key, **opts)
-        new(key).run!(**opts)
-      end
-
-      def run(key, **opts)
-        new(key).run(**opts)
-      end
-
-      def render!(key, **opts)
-        new(key).render!(**opts)
-      end
-
-      def render(key, **opts)
-        new(key).render(**opts)
-      end
-
-      def convert!(key, checkpoint=nil, **opts, &block)
-        new(key).convert!(checkpoint, **opts, &block)
-      end
-
-      def convert(key, checkpoint=nil, **opts, &block)
-        new(key).convert(checkpoint, **opts, &block)
-      end
-
-      def participant
-        @participant ||= context.send(:trailguide_participant)
-      end
-
-      def context_type
-        if context.is_a?(ActionView::Context)
-          :template
-        elsif context.is_a?(ActionController::Base)
-          :controller
-        end
-      end
-    end
-
-    class ExperimentProxy < HelperProxy
-      attr_reader :key
-
-      def initialize(context, key, **opts)
-        super(context, **opts)
-        @key = key.to_s.underscore.to_sym
-      end
-
-      def choose!(**opts, &block)
-        raise NoExperimentsError, key if experiments.empty?
-        raise TooManyExperimentsError, "Selecting a variant requires a single experiment, but `#{key}` matches more than one experiment." if experiments.length > 1
-        raise TooManyExperimentsError, "Selecting a variant requires a single experiment, but `#{key}` refers to a combined experiment." if experiment.combined?
-        opts = {override: override_variant, excluded: exclude_visitor?}.merge(opts)
-        variant = experiment.choose!(**opts)
-        if block_given?
-          yield variant, opts[:metadata]
-        else
-          variant
-        end
-      end
-      alias_method :enroll!, :choose!
-
-      def choose(**opts, &block)
-        choose!(**opts, &block)
-      rescue NoExperimentsError => e
-        raise e
-      rescue => e
-        TrailGuide.logger.error e
-        experiment.control
-      end
-      alias_method :enroll, :choose
-
-      def run!(methods: nil, **opts)
-        choose!(**opts) do |variant, metadata|
-          varmeth = methods[variant.name] if methods
-          varmeth ||= variant.name
-
-          unless context.respond_to?(varmeth, true)
-            if context_type == :controller
-              raise NoVariantMethodError,
-                "Undefined local method `#{varmeth}`. You must define a controller method matching the variant `#{variant.name}` in your experiment `#{key}`. In this case it looks like you need to define #{context.class.name}##{varmeth}(metadata={})"
-            elsif context_type == :template
-              raise NoVariantMethodError,
-                "Undefined local method `#{varmeth}`. You must define a helper method matching the variant `#{variant.name}` in your experiment `#{key}`. In this case it looks like you need to define ApplicationHelper##{varmeth}(metadata={})"
-            else
-              raise NoVariantMethodError,
-                "Undefined local method `#{varmeth}`. You must define a method matching the variant `#{variant.name}` in your experiment `#{key}`. In this case it looks like you need to define #{context.class.name}##{varmeth}(metadata={})"
-            end
-          end
-
-          arguments = context.method(varmeth).parameters
-          if arguments.empty?
-            context.send(varmeth)
-          elsif arguments.length > 1 || arguments[0][0] == :rest
-            context.send(varmeth, variant, **variant.metadata)
-          elsif arguments.length == 1
-            context.send(varmeth, **variant.metadata)
-          end
-        end
-      end
-
-      def run(methods: nil, **opts)
-        run!(methods: methods, **opts)
-      rescue NoExperimentsError => e
-        raise e
-      rescue => e
-        TrailGuide.logger.error e
-        false
-      end
-
-      def render!(prefix: nil, templates: nil, locals: {}, **opts)
-        raise UnsupportedContextError, "The current context (#{context}) does not support rendering. Rendering is only available in controllers and views." unless context.respond_to?(:render, true)
-        choose!(**opts) do |variant, metadata|
-          locals = { variant: variant, metadata: variant.metadata }.merge(locals)
-          locals = { locals: locals } if context_type == :controller
-
-          template = templates[variant.name] if templates
-          prefix ||= (context.try(:view_context) || context).lookup_context.prefixes.first + '/'
-          template ||= "#{prefix.to_s}#{variant.experiment.experiment_name.to_s.underscore}/#{variant.name.to_s.underscore}"
-
-          context.send(:render, template.to_s, **locals)
-        end
-      end
-
-      def render(prefix: nil, templates: nil, locals: {}, **opts)
-        render!(prefix: prefix, templates: templates, locals: locals, **opts)
-      rescue NoExperimentsError => e
-        raise e
-      rescue => e
-        TrailGuide.logger.error e
-        false
-      end
-
-      def convert!(checkpoint=nil, **opts, &block)
-        raise NoExperimentsError, key if experiments.empty?
-        checkpoints = experiments.map do |experiment|
-          ckpt = checkpoint || experiment.goals.find { |g| g == key }
-          if experiment.combined?
-            experiment.combined_experiments.map do |combo|
-              combo.convert!(ckpt, **opts)
-            end
-          else
-            experiment.convert!(ckpt, **opts)
-          end
-        end.flatten
-
-        return false unless checkpoints.any?
-
-        if block_given?
-          yield checkpoints, opts[:metadata]
-        else
-          checkpoints
-        end
-      rescue NoExperimentsError => e
-        unless TrailGuide.configuration.ignore_orphaned_groups?
-          trace = e.backtrace.find { |t| !t.match?(Regexp.new(__FILE__)) }
-            .to_s.split(Rails.root.to_s).last
-            .split(':').first(2).join(':')
-          TrailGuide.catalog.orphaned(key, trace)
-        end
-        false
-      end
-
-      def convert(checkpoint=nil, **opts, &block)
-        convert!(checkpoint, **opts, &block)
-      rescue => e
-        TrailGuide.logger.error e
-        false
-      end
-
-      def experiments
-        @experiments ||= TrailGuide.catalog.select(key).map do |experiment|
-          experiment.new(participant)
-        end
-      end
-
-      def experiment
-        @experiment ||= experiments.first
-      end
-
-      def override_variant
-        return unless context.respond_to?(:params, true)
-        params = context.send(:params)
-        return unless params.key?(TrailGuide.configuration.override_parameter)
-        experiment_params = params[TrailGuide.configuration.override_parameter]
-        return unless experiment_params.key?(experiment.experiment_name.to_s)
-        varname = experiment_params[experiment.experiment_name.to_s]
-        variant = experiment.variants.find { |var| var == varname }
-        variant.try(:name)
-      end
-
-      def exclude_visitor?
-        return false if experiment.configuration.skip_request_filter?
-        context.send(:trailguide_excluded_request?)
-      end
-    end
   end
 end

data/lib/trail_guide/helper/experiment_proxy.rb

@@ -0,0 +1,160 @@
+module TrailGuide
+  module Helper
+    class ExperimentProxy < HelperProxy
+      attr_reader :key
+
+      def initialize(context, key, **opts)
+        super(context, **opts)
+        @key = key.to_s.underscore.to_sym
+      end
+
+      def choose!(**opts, &block)
+        raise NoExperimentsError, key if experiments.empty?
+        raise TooManyExperimentsError, "Selecting a variant requires a single experiment, but `#{key}` matches more than one experiment." if experiments.length > 1
+        raise TooManyExperimentsError, "Selecting a variant requires a single experiment, but `#{key}` refers to a combined experiment." if experiment.combined?
+        opts = {override: override_variant, excluded: exclude_visitor?}.merge(opts)
+        variant = experiment.choose!(**opts)
+        if block_given?
+          yield variant, opts[:metadata]
+        else
+          variant
+        end
+      end
+      alias_method :enroll!, :choose!
+
+      def choose(**opts, &block)
+        choose!(**opts, &block)
+      rescue NoExperimentsError => e
+        raise e
+      rescue => e
+        TrailGuide.logger.error e
+        experiment.control
+      end
+      alias_method :enroll, :choose
+
+      def run!(methods: nil, **opts)
+        choose!(**opts) do |variant, metadata|
+          varmeth = methods[variant.name] if methods
+          varmeth ||= variant.name
+
+          unless context.respond_to?(varmeth, true)
+            if context_type == :controller
+              raise NoVariantMethodError,
+                "Undefined local method `#{varmeth}`. You must define a controller method matching the variant `#{variant.name}` in your experiment `#{key}`. In this case it looks like you need to define #{context.class.name}##{varmeth}(metadata={})"
+            elsif context_type == :template
+              raise NoVariantMethodError,
+                "Undefined local method `#{varmeth}`. You must define a helper method matching the variant `#{variant.name}` in your experiment `#{key}`. In this case it looks like you need to define ApplicationHelper##{varmeth}(metadata={})"
+            else
+              raise NoVariantMethodError,
+                "Undefined local method `#{varmeth}`. You must define a method matching the variant `#{variant.name}` in your experiment `#{key}`. In this case it looks like you need to define #{context.class.name}##{varmeth}(metadata={})"
+            end
+          end
+
+          arguments = context.method(varmeth).parameters
+          if arguments.empty?
+            context.send(varmeth)
+          elsif arguments.length > 1 || arguments[0][0] == :rest
+            context.send(varmeth, variant, **variant.metadata)
+          elsif arguments.length == 1
+            context.send(varmeth, **variant.metadata)
+          end
+        end
+      end
+
+      def run(methods: nil, **opts)
+        run!(methods: methods, **opts)
+      rescue NoExperimentsError => e
+        raise e
+      rescue => e
+        TrailGuide.logger.error e
+        false
+      end
+
+      def render!(prefix: nil, templates: nil, locals: {}, **opts)
+        raise UnsupportedContextError, "The current context (#{context}) does not support rendering. Rendering is only available in controllers and views." unless context.respond_to?(:render, true)
+        choose!(**opts) do |variant, metadata|
+          locals = { variant: variant, metadata: variant.metadata }.merge(locals)
+          locals = { locals: locals } if context_type == :controller
+
+          template = templates[variant.name] if templates
+          prefix ||= (context.try(:view_context) || context).lookup_context.prefixes.first + '/' rescue ''
+          template ||= "#{prefix.to_s}#{variant.experiment.experiment_name.to_s.underscore}/#{variant.name.to_s.underscore}"
+
+          context.send(:render, template.to_s, **locals)
+        end
+      end
+
+      def render(prefix: nil, templates: nil, locals: {}, **opts)
+        render!(prefix: prefix, templates: templates, locals: locals, **opts)
+      rescue NoExperimentsError => e
+        raise e
+      rescue => e
+        TrailGuide.logger.error e
+        false
+      end
+
+      def convert!(checkpoint=nil, **opts, &block)
+        raise NoExperimentsError, key if experiments.empty?
+        checkpoints = experiments.map do |experiment|
+          ckpt = checkpoint || experiment.goals.find { |g| g == key }
+          if experiment.combined?
+            experiment.combined_experiments.map do |combo|
+              combo.convert!(ckpt, **opts)
+            end
+          else
+            experiment.convert!(ckpt, **opts)
+          end
+        end.flatten
+
+        return false unless checkpoints.any?
+
+        if block_given?
+          yield checkpoints, opts[:metadata]
+        else
+          checkpoints
+        end
+      rescue NoExperimentsError => e
+        unless TrailGuide.configuration.ignore_orphaned_groups?
+          trace = e.backtrace.find { |t| !t.match?(Regexp.new(__FILE__)) }
+            .to_s.split(Rails.root.to_s).last
+            .split(':').first(2).join(':')
+          TrailGuide.catalog.orphaned(key, trace)
+        end
+        false
+      end
+
+      def convert(checkpoint=nil, **opts, &block)
+        convert!(checkpoint, **opts, &block)
+      rescue => e
+        TrailGuide.logger.error e
+        false
+      end
+
+      def experiments
+        @experiments ||= TrailGuide.catalog.select(key).map do |experiment|
+          experiment.new(participant)
+        end
+      end
+
+      def experiment
+        @experiment ||= experiments.first
+      end
+
+      def override_variant
+        return unless context.respond_to?(:params, true)
+        params = context.send(:params)
+        return unless params.key?(TrailGuide.configuration.override_parameter)
+        experiment_params = params[TrailGuide.configuration.override_parameter]
+        return unless experiment_params.key?(experiment.experiment_name.to_s)
+        varname = experiment_params[experiment.experiment_name.to_s]
+        variant = experiment.variants.find { |var| var == varname }
+        variant.try(:name)
+      end
+
+      def exclude_visitor?
+        return false if experiment.configuration.skip_request_filter?
+        context.send(:trailguide_excluded_request?)
+      end
+    end
+  end
+end

data/lib/trail_guide/helper/helper_proxy.rb

@@ -0,0 +1,62 @@
+module TrailGuide
+  module Helper
+    class HelperProxy
+      attr_reader :context
+
+      def initialize(context, participant: nil)
+        @context = context
+        @participant = participant
+      end
+
+      def new(key)
+        ExperimentProxy.new(context, key, participant: participant)
+      end
+
+      def choose!(key, **opts, &block)
+        new(key).choose!(**opts, &block)
+      end
+      alias_method :enroll!, :choose!
+
+      def choose(key, **opts, &block)
+        new(key).choose(**opts, &block)
+      end
+      alias_method :enroll, :choose
+
+      def run!(key, **opts)
+        new(key).run!(**opts)
+      end
+
+      def run(key, **opts)
+        new(key).run(**opts)
+      end
+
+      def render!(key, **opts)
+        new(key).render!(**opts)
+      end
+
+      def render(key, **opts)
+        new(key).render(**opts)
+      end
+
+      def convert!(key, checkpoint=nil, **opts, &block)
+        new(key).convert!(checkpoint, **opts, &block)
+      end
+
+      def convert(key, checkpoint=nil, **opts, &block)
+        new(key).convert(checkpoint, **opts, &block)
+      end
+
+      def participant
+        @participant ||= context.send(:trailguide_participant)
+      end
+
+      def context_type
+        if context.is_a?(ActionView::Context)
+          :template
+        elsif context.is_a?(ActionController::Base)
+          :controller
+        end
+      end
+    end
+  end
+end