gaq 0.2.0

data/spec/lib/gaq/dsl_target_factory_spec.rb

@@ -0,0 +1,163 @@
+require 'gaq/dsl_target_factory'
+
+require 'gaq/class_cache'
+
+module Gaq
+  describe DslTargetFactory do
+    let(:flash_commands_adapter) { Object.new }
+    let(:immediate_commands) { Object.new }
+    let(:new_command_proc) { Object.new }
+    let(:variables) { Object.new }
+    let(:tracker_names) { ["tracker name", "foo"] }
+
+    let(:class_cache) do
+      ClassCache.new
+    end
+
+    let(:target_base_class) do
+      Class.new do
+        attr_reader :target_factory, :factory_token, :new_command_proc, :commands, :tracker_name
+
+        def initialize(target_factory, factory_token, new_command_proc, commands, tracker_name)
+          @target_factory, @factory_token, @new_command_proc, @commands, @tracker_name =
+            target_factory, factory_token, new_command_proc, commands, tracker_name
+        end
+
+        class << self
+          def builds_variable_commands_module(&block)
+            @block = block
+          end
+
+          def variable_commands_module(*args)
+            @block.call(*args)
+          end
+        end
+
+        #default implementation for examples not concerned about variables
+        self.builds_variable_commands_module { Module.new }
+      end
+    end
+
+    subject do
+      result = described_class.new(class_cache, flash_commands_adapter, immediate_commands, new_command_proc, variables, tracker_names)
+      result.target_base_class = target_base_class
+      result
+    end
+
+    describe "targets" do
+      shared_context "common initalization of target" do
+        it "passes itself as target factory" do
+          target.target_factory.should be subject
+        end
+
+        it "passes the new_command_proc through" do
+          target.new_command_proc.should be new_command_proc
+        end
+      end
+
+      shared_context immediate_commands: true do
+        it "passes immediate_commands as commands" do
+          target.commands.should be immediate_commands
+        end
+      end
+
+      shared_context flash_commands: true do
+        it "passes flash_commands_adapter as commands" do
+          target.commands.should be flash_commands_adapter
+        end
+      end
+
+      shared_context default_tracker: true do
+        it "passes nil as the tracker name" do
+          target.tracker_name.should be_nil
+        end
+      end
+
+      shared_context custom_tracker: true do
+        it "passes nil as the tracker name" do
+          target.tracker_name.should be == "tracker name"
+        end
+      end
+
+      describe "#root_target", immediate_commands: true, default_tracker: true do
+        let(:target) { subject.root_target }
+
+        include_context "common initalization of target"
+      end
+
+      let(:root_token) do
+        subject.root_target.factory_token
+      end
+
+      describe "#target_with_tracker_name (unregistered name)" do
+        it "complains about the unknown name" do
+          expect {
+            subject.target_with_tracker_name("bogus", root_token)
+          }.to raise_exception
+        end
+      end
+
+      describe "#target_with_tracker_name" do
+        it "tolerates both strings and symbols as tracker names" do
+          subject.target_with_tracker_name("tracker name", root_token).tracker_name.should be ==
+            subject.target_with_tracker_name(:"tracker name", root_token).tracker_name
+        end
+      end
+
+      describe "#target_with_tracker_name (token is root token)", immediate_commands: true, custom_tracker: true do
+        let(:target) { subject.target_with_tracker_name("tracker name", root_token) }
+
+        include_context "common initalization of target"
+      end
+
+      describe "#target_for_next_request (token is root token)", flash_commands: true, default_tracker: true do
+        let(:target) { subject.target_for_next_request(root_token) }
+
+        include_context "common initalization of target"
+      end
+
+      describe "#target_with_tracker_name (token is from #target_for_next_request)", flash_commands: true, custom_tracker: true do
+        let(:target) do
+          token = subject.target_for_next_request(root_token).factory_token
+          subject.target_with_tracker_name("tracker name", token)
+        end
+
+        include_context "common initalization of target"
+      end
+
+      describe "#target_with_tracker_name (token is from #target_with_tracker_name)", custom_tracker: true, immediate_commands: true do
+        let(:target) do
+          token = subject.target_with_tracker_name("foo", root_token).factory_token
+          subject.target_with_tracker_name("tracker name", token)
+        end
+
+        include_context "common initalization of target"
+      end
+
+      describe "#target_for_next_request (token is from #target_with_tracker_name)", custom_tracker: true, flash_commands: true do
+        let(:target) do
+          token = subject.target_with_tracker_name("tracker name", root_token).factory_token
+          subject.target_for_next_request(token)
+        end
+
+        include_context "common initalization of target"
+      end
+    end
+
+    describe "variables" do
+      let(:variables_module) { Module.new }
+
+      before do
+        target_base_class.builds_variable_commands_module do |*args|
+          args.should have(1).argument
+          args.first.should be variables
+          variables_module
+        end
+      end
+
+      it "includes the variables module into the target's class" do
+        subject.root_target.should be_a_kind_of(variables_module)
+      end
+    end
+  end
+end

data/spec/lib/gaq/dsl_target_spec.rb

@@ -0,0 +1,87 @@
+require 'gaq/dsl_target'
+
+require 'gaq/configuration'
+require 'gaq/command_language'
+
+module Gaq
+  describe DslTarget do
+    let(:target_factory) { double "target factory" }
+    let(:factory_token) { Object.new }
+    let(:new_command_proc) { double "new_command_proc" }
+    let(:commands) { double "commands" }
+    let(:tracker_name) { "custom tracker name" }
+
+    shared_context with_instance_subject: true do
+      subject do
+        described_class.new(target_factory, factory_token, new_command_proc, commands, tracker_name)
+      end
+    end
+
+    def command_expecting_tracker_name
+      result = double
+      result.should_receive(:tracker_name=).with(tracker_name)
+      commands.should_receive(:<<).with(result).once
+      result
+    end
+
+    describe "#tracker", with_instance_subject: true do
+      it "delegates to target factory, passing token" do
+        tracker_name = "tracker name"
+
+        target_factory.should_receive(:target_with_tracker_name)
+          .with(tracker_name, factory_token)
+          .and_return(5)
+
+        subject.tracker(tracker_name).should be 5
+      end
+    end
+
+    describe "#next_request", with_instance_subject: true do
+      it "delegates to target factory, passing token" do
+        target_factory.should_receive(:target_for_next_request)
+          .with(factory_token)
+          .and_return(5)
+
+        subject.next_request.should be 5
+      end
+    end
+
+    describe "#track_event", with_instance_subject: true do
+      it "creates and pushes a new command" do
+        command = command_expecting_tracker_name
+
+        new_command_proc.should_receive(:call)
+          .with(:track_event, "3", "5")
+          .and_return(command)
+
+        subject.track_event("3", "5")
+      end
+    end
+
+    describe ".variable_commands_module" do
+      let(:variable) do
+        result = Configuration::Variable.new(4, "myvar", 2)
+        result.slot.should be == 4
+        result.name.should be == "myvar"
+        result.scope.should be == 2
+        result
+      end
+
+      subject do
+        cls = Class.new(described_class)
+        cls.send :include, described_class.variable_commands_module([variable])
+        cls.new(target_factory, factory_token, new_command_proc, commands, tracker_name)
+      end
+
+      it "creates a variable setter that pushes a set_custom_var command" do
+        command = command_expecting_tracker_name
+
+        new_command_proc.should_receive(:call)
+          .with(:set_custom_var, 4, "myvar", "value", 2)
+          .and_return(command)
+
+        subject.myvar = "value"
+      end
+    end
+  end
+end

data/spec/lib/gaq/flash_commands_adapter_spec.rb

@@ -0,0 +1,116 @@
+require 'gaq/flash_commands_adapter'
+
+module Gaq
+  describe FlashCommandsAdapter do
+    let(:flash) { {} }
+
+    let(:language) do
+      result = double "language"
+      if example.metadata[:null_conversion]
+        result.stub(:commands_to_flash_items) { |commands| commands }
+        result.stub(:commands_from_flash_items) { |commands| commands }
+      end
+      result
+    end
+    let(:controller_facade) do
+      result = double "controller facade"
+      result.stub(:flash) { flash }
+      result
+    end
+
+    subject do
+      described_class.new(language, controller_facade)
+    end
+
+    def commands_as_seen_in_flash
+      flash[described_class::FLASH_KEY].drop(1)
+    end
+
+    def version_as_seen_in_flash
+      flash[described_class::FLASH_KEY].first
+    end
+
+    def version_as_coded
+      described_class::FLASH_FORMAT_VERSION
+    end
+
+    describe "#<<" do
+      it "saves to flash with pushed command", null_conversion: true do
+        subject << 5
+        commands_as_seen_in_flash.should be == [5]
+      end
+
+      it "saves to flash with pushed commands", null_conversion: true do
+        subject << 5
+        subject << 17
+        commands_as_seen_in_flash.should be == [5, 17]
+      end
+
+      it "converts items using language.commands_to_flash_items" do
+        language.should_receive(:commands_to_flash_items).with([5]).and_return([:bogus])
+        language.should_receive(:commands_to_flash_items).with([5, 17]).and_return([:result_array])
+
+        subject << 5
+        subject << 17
+
+        commands_as_seen_in_flash.should be == [:result_array]
+      end
+
+      it "saves to flash including current format version", null_conversion: true do
+        subject << 5
+
+        version_as_seen_in_flash.should be == version_as_coded
+      end
+    end
+
+    describe "#commands_from_flash" do
+      context "with empty flash" do
+        it "returns something empty", null_conversion: true do
+          subject.commands_from_flash.should be_empty
+        end
+      end
+
+      context "with current data in flash" do
+        before do
+          flash[described_class::FLASH_KEY] = [
+            described_class::FLASH_FORMAT_VERSION,
+            2,
+            3
+          ]
+        end
+
+        it "passes flash items through language.commands_from_flash_items and returns result" do
+          language.should_receive(:commands_from_flash_items)
+            .with([2, 3]).and_return([:conversion, :result])
+          subject.commands_from_flash.should be == [:conversion, :result]
+        end
+      end
+
+      context "with stale data in flash" do
+        before do
+          flash[described_class::FLASH_KEY] = [
+            described_class::FLASH_FORMAT_VERSION - 1,
+            2,
+            3
+          ]
+        end
+
+        it "returns something empty", null_conversion: true do
+          subject.commands_from_flash.should be_empty
+        end
+      end
+
+      context "with ancient data in flash" do
+        before do
+          flash[described_class::FLASH_KEY] = [
+            ["_trackEvent", "foo", "bar", "baz"]
+          ]
+        end
+
+        it "returns something empty", null_conversion: true do
+          subject.commands_from_flash.should be_empty
+        end
+      end
+    end
+  end
+end

data/spec/lib/gaq/interprets_config_spec.rb

@@ -0,0 +1,37 @@
+require 'gaq/interprets_config'
+require 'gaq/controller_facade'
+
+require 'active_support/string_inquirer'
+
+module Gaq
+  describe InterpretsConfig do
+    subject do
+      Class.new do
+        include InterpretsConfig
+
+        public :interpret_config #make it accessible to tests
+      end.new
+    end
+
+    let(:controller) { Object.new }
+
+    let(:controller_facade) do
+      ControllerFacade.new(controller)
+    end
+
+    it "passes strings and numbers right through" do
+      subject.interpret_config(3, controller_facade).should be 3
+      subject.interpret_config("foo", controller_facade).should be == "foo"
+    end
+
+    it "uses controller_facade.evaluate_config_lambda for result when value is callable" do
+      value = double
+      value.stub(:call) do |arg|
+        arg.should be controller
+        :foo
+      end
+
+      subject.interpret_config(value, controller_facade).should be :foo
+    end
+  end
+end

data/spec/lib/gaq/snippet_renderer_spec.rb

@@ -0,0 +1,60 @@
+require 'gaq/snippet_renderer'
+
+module Gaq
+  describe SnippetRenderer do
+    let(:rendering_context) do
+      double("rendering context").tap do |context|
+        # no assertion?? XXX
+        context.stub(:javascript_tag) { |content| content }
+      end
+    end
+
+    let(:config) do
+      double "config"
+    end
+
+    let(:rails_env) do
+      double "rails env"
+    end
+
+    subject do
+      described_class.new(rendering_context, config, rails_env)
+    end
+
+    describe "#render" do
+      def pushed_arrays(rendered)
+        rendered = rendered.lines.drop_while { |line| !/^\s*_gaq.push/.match(line) }
+        rendered = rendered.take_while { |line| !line.empty? }
+
+        rendered = rendered.join('')[/\A\_gaq.push\((.*)\);\Z/m, 1]
+        rendered = rendered.split(/,\n\s*/)
+        rendered.map { |string| JSON.parse(string) }
+      end
+
+      it "renders commands segments" do
+        config.stub(:render_ga_js?) { false }
+
+        commands_as_segments = [
+          ["foo", "bar"],
+          ["baz", true, 3]
+        ]
+        rendered = subject.render(commands_as_segments)
+
+        pushed_arrays(rendered).should be == commands_as_segments
+      end
+
+      describe "snippet rendering" do
+        it "renders the snippet when config.render_ga_js? returns true" do
+          config.stub(:render_ga_js?) { true }
+          subject.render([]).should include('google-analytics.com')
+        end
+
+        it "does not render the snippet when config.render_ga_js? returns false" do
+          config.stub(:render_ga_js?) { false }
+          subject.render([]).should_not include('google-analytics.com')
+        end
+      end
+    end
+
+  end
+end