RubyGems - gaq - Versions diffs - 0.2.0 - Mend

gaq 0.2.0

Files changed (70) hide show

data/.gitignore +18 -0
data/Gemfile +15 -0
data/Guardfile +23 -0
data/LICENSE.txt +22 -0
data/README.md +102 -0
data/Rakefile +1 -0
data/gaq.gemspec +22 -0
data/lib/gaq.rb +3 -0
data/lib/gaq/class_cache.rb +32 -0
data/lib/gaq/command_language.rb +145 -0
data/lib/gaq/configuration.rb +159 -0
data/lib/gaq/controller_facade.rb +15 -0
data/lib/gaq/controller_handle.rb +93 -0
data/lib/gaq/dsl_target.rb +51 -0
data/lib/gaq/dsl_target_factory.rb +64 -0
data/lib/gaq/flash_commands_adapter.rb +48 -0
data/lib/gaq/interprets_config.rb +13 -0
data/lib/gaq/railtie.rb +40 -0
data/lib/gaq/snippet_renderer.rb +44 -0
data/lib/gaq/version.rb +3 -0
data/spec-dummy/.rspec +1 -0
data/spec-dummy/README.rdoc +261 -0
data/spec-dummy/Rakefile +7 -0
data/spec-dummy/app/assets/images/rails.png +0 -0
data/spec-dummy/app/assets/javascripts/application.js +13 -0
data/spec-dummy/app/assets/stylesheets/application.css +13 -0
data/spec-dummy/app/controllers/application_controller.rb +3 -0
data/spec-dummy/app/controllers/integration_spec_controller.rb +22 -0
data/spec-dummy/app/helpers/application_helper.rb +2 -0
data/spec-dummy/app/views/integration_spec/view.erb +0 -0
data/spec-dummy/app/views/layouts/application.html.erb +16 -0
data/spec-dummy/config.ru +4 -0
data/spec-dummy/config/application.rb +64 -0
data/spec-dummy/config/boot.rb +6 -0
data/spec-dummy/config/environment.rb +5 -0
data/spec-dummy/config/environments/development.rb +26 -0
data/spec-dummy/config/environments/production.rb +51 -0
data/spec-dummy/config/environments/test_dynamic.rb +39 -0
data/spec-dummy/config/environments/test_static.rb +38 -0
data/spec-dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec-dummy/config/initializers/inflections.rb +15 -0
data/spec-dummy/config/initializers/mime_types.rb +5 -0
data/spec-dummy/config/initializers/secret_token.rb +7 -0
data/spec-dummy/config/initializers/session_store.rb +8 -0
data/spec-dummy/config/initializers/wrap_parameters.rb +10 -0
data/spec-dummy/config/locales/en.yml +5 -0
data/spec-dummy/config/routes.rb +8 -0
data/spec-dummy/db/seeds.rb +7 -0
data/spec-dummy/public/404.html +26 -0
data/spec-dummy/public/422.html +26 -0
data/spec-dummy/public/500.html +25 -0
data/spec-dummy/public/favicon.ico +0 -0
data/spec-dummy/public/robots.txt +5 -0
data/spec-dummy/script/rails +6 -0
data/spec-dummy/spec/common_spec_methods.rb +88 -0
data/spec-dummy/spec/features/dynamic_config_spec.rb +21 -0
data/spec-dummy/spec/features/next_request_spec.rb +27 -0
data/spec-dummy/spec/features/presence_spec.rb +64 -0
data/spec-dummy/spec/spec_helper.rb +41 -0
data/spec/lib/gaq/class_cache_spec.rb +62 -0
data/spec/lib/gaq/command_language_spec.rb +267 -0
data/spec/lib/gaq/configuration_spec.rb +233 -0
data/spec/lib/gaq/controller_facade_spec.rb +29 -0
data/spec/lib/gaq/controller_handle_spec.rb +510 -0
data/spec/lib/gaq/dsl_target_factory_spec.rb +163 -0
data/spec/lib/gaq/dsl_target_spec.rb +87 -0
data/spec/lib/gaq/flash_commands_adapter_spec.rb +116 -0
data/spec/lib/gaq/interprets_config_spec.rb +37 -0
data/spec/lib/gaq/snippet_renderer_spec.rb +60 -0
metadata +159 -0

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec-dummy/public/500.html ADDED

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec-dummy/public/favicon.ico ADDED

File without changes

data/spec-dummy/public/robots.txt ADDED

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec-dummy/script/rails ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec-dummy/spec/common_spec_methods.rb ADDED

@@ -0,0 +1,88 @@
+require 'nokogiri'
+module Helpers
+  def gaq_cdata
+    html = Nokogiri::HTML.parse(page.body)
+    html.css('script[type="text/javascript"]').find do |script|
+      cdata = script.children.find(&:cdata?) \
+        and cdata.text.include?('_gaq') \
+        and break(cdata)
+    end
+  end
+  def gaq_cdata_content
+    /<!\[CDATA\[(.*)\]\]>/m.match(gaq_cdata)[1]
+  end
+  def gaq_split_at_snippet_beginning
+    text_lines_without_comments = gaq_cdata_content.split("\n").map do |line|
+      if me = %r{^(.*?)//}.match(line)
+        line = me[1]
+      end
+      if me = %r{^\s*(.*)}.match(line)
+        line = me[1]
+      end
+      line
+    end.reject(&:blank?)
+    text_lines_without_comments.join("\n").split(%r{(?=\(function\(\))})
+  end
+  def snippet_and_beyond
+    gaq_split_at_snippet_beginning[1..-1]
+  end
+  def gaq_js_instructions
+    gaq_split_at_snippet_beginning.first.split(%r{(?<=;)\n}m)
+  end
+  def gaq_pushed_instructions
+    lines = %r{\A_gaq.push\((.*)\);\Z}m.match(gaq_js_instructions.second)[1]
+    lines.split(",\n").map do |instruction_line|
+      instruction_line.should start_with('[')
+      instruction_line.should end_with(']')
+      JSON.parse(instruction_line)
+    end
+  end
+  def track_event_from_before_filter(action)
+    be_instruction('_trackEvent').with_args("controller", "action", action)
+  end
+end
+RSpec.configure{ |c| c.include Helpers }
+RSpec::Matchers.define :be_instruction do |instruction|
+  match do |actual|
+    (actual.first == instruction) &&
+      if defined?(@instruction_args)
+        (actual.drop(1) == @instruction_args)
+      else
+        true
+      end
+  end
+  chain :with_args do |*args|
+    @instruction_args = args
+  end
+  chain :without_args do
+    @instruction_args = []
+  end
+  failure_message_for_should do |actual|
+    message = "expected that #{actual} would be instruction #{instruction.inspect}"
+    if @instruction_args
+      if @instruction_args.empty?
+        message << "without args"
+      else
+        message << " with args #{@instruction_args}"
+      end
+    end
+    message
+  end
+end

data/spec-dummy/spec/features/dynamic_config_spec.rb ADDED

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'common_spec_methods'
+describe "dynamic config interpretation", dynamic: true do
+  it "interprets web property id dynamically" do
+    visit '/snippet_presence?wip=UA-OVERRIDE-1'
+    first_instruction = gaq_pushed_instructions.first
+    first_instruction.should be_instruction("_setAccount", 'UA-OVERRIDE-1')
+  end
+  it "interprets anonymize_ip dynamically" do
+    visit '/snippet_presence?anonymize_ip=true'
+    gaq_pushed_instructions[1].should be_instruction('_gat._anonymizeIp')
+    visit '/snippet_presence?anonymize_ip=false'
+    gaq_pushed_instructions.each do |instruction|
+      instruction.should_not be_instruction('_gat._anonymizeIp')
+    end
+  end
+end

data/spec-dummy/spec/features/next_request_spec.rb ADDED

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'common_spec_methods'
+describe "gaq next_request effect" do
+  it "renders events after redirect, but not after the request following" do
+    visit '/redirecting_action'
+    gaq_pushed_instructions.should have(4).items
+    first_instruction, second_instruction, third_instruction, fourth_instruction = gaq_pushed_instructions
+    first_instruction.should be_instruction("_setAccount")
+    second_instruction.should be_instruction("_trackPageview").without_args
+    third_instruction.should be_instruction('_trackEvent').with_args('from', 'redirecting', 'action')
+    fourth_instruction.should track_event_from_before_filter('target_action')
+    visit '/final_action'
+    gaq_pushed_instructions.should have(3).items
+    first_instruction, second_instruction, third_instruction = gaq_pushed_instructions
+    first_instruction.should be_instruction("_setAccount")
+    second_instruction.should be_instruction("_trackPageview").without_args
+    third_instruction.should track_event_from_before_filter('final_action')
+  end
+end

data/spec-dummy/spec/features/presence_spec.rb ADDED

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'common_spec_methods'
+describe "gaq snippet presence" do
+  it "renders 'gaq' in the page" do
+    visit '/snippet_presence'
+    expect(page.body).to have_text("_gaq")
+  end
+  describe "conditional examples by rails environment" do
+    it "renders the configured basic web property id", :static do
+      visit '/snippet_presence'
+      expect(page.body).to have_text("UA-TESTSTAT-1")
+    end
+    it "renders the configured basic web property id", :dynamic do
+      visit '/snippet_presence'
+      expect(page.body).to have_text("UA-TESTDYNA-1")
+    end
+  end
+  describe "common spec methods" do
+    before { visit '/snippet_presence' }
+    it "renders a CDATA containing _gaq" do
+      gaq_cdata.should_not be_nil
+    end
+    it "starts by initializing _gaq array" do
+      gaq_js_instructions.first.should == "var _gaq = _gaq || [];"
+    end
+    it "continues with a _gaq.push line" do
+      gaq_js_instructions.second.should match(%r{\A_gaq.push\(.*\);\Z}m)
+    end
+    it "does not have more js lines before the snippet" do
+      gaq_js_instructions.should have(2).items
+    end
+    it "continues with the snippet, and that's the end" do
+      snippet_and_beyond.should have(1).item
+      snippet_and_beyond.first.should start_with('(function()')
+      snippet_and_beyond.first.should end_with('})();')
+    end
+    describe "pushed instructions" do
+      it "pushed the expected instructions, part 1" do
+        gaq_pushed_instructions.should have(3).items
+        first_instruction, second_instruction, third_instruction = gaq_pushed_instructions
+        first_instruction.should be_instruction("_setAccount")
+        second_instruction.should be_instruction("_trackPageview").without_args
+        third_instruction.should track_event_from_before_filter('snippet_presence')
+      end
+      it "pushed the expected instructions, part 2", :static do
+        gaq_pushed_instructions.first.should be_instruction("_setAccount").with_args('UA-TESTSTAT-1')
+      end
+    end
+  end
+end

data/spec-dummy/spec/spec_helper.rb ADDED

@@ -0,0 +1,41 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'capybara/rails'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/lib/gaq/class_cache_spec.rb ADDED

@@ -0,0 +1,62 @@
+require 'gaq/class_cache'
+module Gaq
+  describe ClassCache do
+    let(:assertion_double) { double }
+    shared_context silence_double: true do
+      before do
+        assertion_double.as_null_object
+      end
+    end
+    before do
+      subject.building(:foo, String) do |cls|
+        assertion_double.build(:foo)
+        cls.class_eval do
+          def foo
+            "foo"
+          end
+        end
+      end
+      subject.building(:bar, Hash) do |cls|
+        assertion_double.build(:bar)
+        subject[:foo]
+        cls.class_eval do
+          def bar
+            "bar"
+          end
+        end
+      end
+    end
+    context silence_double: true do
+      it "builds a class as instructed" do
+        built = subject[:foo]
+        built.should be < String
+        built.new.foo.should be == "foo"
+      end
+      it "raises an exception on miss" do
+        expect {
+          subject[:baz]
+        }.to raise_exception ClassCache::Miss
+      end
+    end
+    it "only builds the class once" do
+      assertion_double.should_receive(:build).with(:foo).once
+      subject[:foo]
+      subject[:foo]
+    end
+    it "implicitly supports dependencies" do
+      assertion_double.should_receive(:build).with(:foo)
+      assertion_double.should_receive(:build).with(:bar)
+      subject[:bar]
+    end
+  end
+end

data/spec/lib/gaq/command_language_spec.rb ADDED

@@ -0,0 +1,267 @@
+require 'gaq/command_language'
+module Gaq
+  describe CommandLanguage do
+    let(:value_coercer) { double "value coercer" }
+    def null_coercing
+      value_coercer.stub(:call) { |type, value| value }
+    end
+    subject do
+      result = described_class.new
+      result.value_coercer = value_coercer
+      result
+    end
+    let(:descriptors) { {} }
+    before do
+      subject.knows_command(:foo) do |desc|
+        desc.signature = [String]
+        desc.name = "_myFooCommand"
+        descriptors[:foo] = desc
+      end if example.metadata[:foo_command]
+      subject.knows_command(:bar) do |desc|
+        desc.signature = [String, Integer]
+        desc.name = "_myBarCommand"
+        desc.sort_slot = 1
+        descriptors[:bar] = desc
+      end if example.metadata[:bar_command]
+      subject.knows_command(:baz) do |desc|
+        desc.signature = []
+        desc.name = "_myBazCommand"
+        desc.sort_slot = 0
+        descriptors[:baz] = desc
+      end if example.metadata[:baz_command]
+    end
+    RSpec::Matchers.define :be_identified_as do |identifier|
+      match do |command|
+        command.descriptor.identifier.equal? identifier
+      end
+    end
+    describe ".new_command" do
+      it "returns a properly identified and named command", foo_command: true do
+        null_coercing
+        command = subject.new_command(:foo, "string")
+        command.should be_identified_as(:foo)
+        command.name.should be == "_myFooCommand"
+      end
+      it "passes params through value coercer", foo_command: true do
+        value_coercer.should_receive(:call).with(String, "string").and_return "coerced string"
+        command = subject.new_command(:foo, "string")
+        command.params.should be == ["coerced string"]
+      end
+      it "passes only given params through coercer, even if less than signature length", bar_command: true do
+        value_coercer.should_receive(:call).with(String, "string").and_return "coerced string"
+        command = subject.new_command(:bar, "string")
+        command.params.should be == ["coerced string"]
+      end
+    end
+    shared_examples ".commands_to_flash_items behaves" do
+      let(:flash_data_item) do
+        flash_items = subject.commands_to_flash_items([command])
+        flash_items.should have(1).item
+        flash_items.first
+      end
+      context "with a command accepting two parameters", bar_command: true do
+        let(:command) do
+          command = CommandLanguage::Command.new
+          command.descriptor = descriptors[:bar]
+          command.name = "_myBarCommand"
+          command.params = []
+          command
+        end
+        it "adds params to data items" do
+          command.params << "first param" << "second param"
+          flash_data_item.should have(3).items
+          flash_data_item[1].should be == "first param"
+          flash_data_item[2].should be == "second param"
+        end
+        it "adds only as many params as signature length" do
+          command.params << "first param"
+          flash_data_item.should have(2).items
+          flash_data_item[1].should be == "first param"
+        end
+      end
+      context "with a command accepting one parameter", foo_command: true do
+        let(:command) do
+          command = CommandLanguage::Command.new
+          command.descriptor = descriptors[:foo]
+          command.name = "_myFooCommand"
+          command.params = ["param"]
+          command
+        end
+        it "sets the first flash item's first item to the command name (no target set)" do
+          null_coercing
+          flash_data_item.should have(2).items
+          flash_data_item.first.should be == "_myFooCommand"
+        end
+        it "sets the first flash item's first item to the command name (target set)" do
+          null_coercing
+          command.tracker_name = "tracker"
+          flash_data_item.should have(2).items
+          flash_data_item.first.should be == "tracker._myFooCommand"
+        end
+      end
+    end
+    describe ".commands_to_flash_items" do
+      let(:result) do
+        subject.commands_to_flash_items([command])
+      end
+      it_should_behave_like ".commands_to_flash_items behaves"
+    end
+    describe ".commands_to_segments_for_to_json" do
+      let(:result) do
+        subject.commands_to_segments_for_to_json([command])
+      end
+      it_should_behave_like ".commands_to_flash_items behaves"
+    end
+    describe ".sort_commands" do
+      def assert_order(commands)
+        commands[0].should be_identified_as(:baz)
+        commands[1].should be_identified_as(:bar)
+        commands[2].should be_identified_as(:foo)
+      end
+      it "sorts commands by sort_slot, missing sort_slot values last",
+          foo_command: true, bar_command: true, baz_command: true do
+        commands = [
+          subject.new_command(:foo),
+          subject.new_command(:bar),
+          subject.new_command(:baz)
+        ]
+        subject.sort_commands(commands)
+        assert_order(commands)
+        commands = [
+          subject.new_command(:bar),
+          subject.new_command(:foo),
+          subject.new_command(:baz)
+        ]
+        subject.sort_commands(commands)
+        assert_order(commands)
+      end
+    end
+    describe ".commands_from_flash_items", foo_command: true, bar_command: true do
+      it "correctly detects the command" do
+        flash_items = [
+          ["_myFooCommand"],
+          ["_myBarCommand"]
+        ]
+        commands = subject.commands_from_flash_items(flash_items)
+        commands.should have(2).items
+        command = commands.first
+        command.should be_identified_as(:foo)
+        command.name.should be == '_myFooCommand'
+        command = commands.last
+        command.should be_identified_as(:bar)
+        command.name.should be == '_myBarCommand'
+      end
+      it "sets command's params to remaining segments from flash item" do
+        flash_item = ["_myBarCommand", "first param", "second param"]
+        commands = subject.commands_from_flash_items([flash_item])
+        commands.should have(1).item
+        command = commands.first
+        command.params.should be == ["first param", "second param"]
+      end
+      it "sets tracker name to nil when no explicit tracker given" do
+        flash_item = ["_myFooCommand"]
+        commands = subject.commands_from_flash_items([flash_item])
+        commands.should have(1).item
+        command = commands.first
+        command.tracker_name.should be_nil
+      end
+      it "correctly sets present tracker name" do
+        flash_item = ["my_tracker._myFooCommand"]
+        commands = subject.commands_from_flash_items([flash_item])
+        commands.should have(1).item
+        command = commands.first
+        command.tracker_name.should be == "my_tracker"
+      end
+    end
+    describe ".coerce_value" do
+      describe "type :Boolean" do
+        it "coerces boolish values properly" do
+          described_class.coerce_value(:Boolean, true).should be true
+          described_class.coerce_value(:Boolean, false).should be false
+          described_class.coerce_value(:Boolean, 1).should be true
+          described_class.coerce_value(:Boolean, nil).should be false
+        end
+      end
+      describe "type :String" do
+        it "coerces values like String()" do
+          described_class.coerce_value(:String, "str").should be == "str"
+          described_class.coerce_value(:String, 1).should be == "1"
+          expect {
+            described_class.coerce_value(:String, BasicObject.new)
+          }.to raise_exception
+        end
+      end
+      describe "type :Int" do
+        it "coerces values like Integer()" do
+          described_class.coerce_value(:Int, 1).should be 1
+          described_class.coerce_value(:Int, "5").should be 5
+          expect {
+            described_class.coerce_value(:Int, "_")
+          }.to raise_exception
+          expect {
+            described_class.coerce_value(:Int, "3.14")
+          }.to raise_exception
+        end
+      end
+    end
+  end
+end