quo_vadis 0.0.1 → 1.0.0

data/test/dummy/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/test/dummy/script/rails

@@ -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/test/dummy/tmp/capybara/capybara-20110124133149.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  
+  <script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/prototype.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/effects.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/dragdrop.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/controls.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/rails.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/application.js?1295870562" type="text/javascript"></script>
+  
+</head>
+<body>
+
+  <div id='topnav'>
+      You are signed in as Bob.
+      <a href="/sign-out">Sign out</a>
+  </div>
+
+    <div class='flash notice'>You have successfully signed in.</div>
+
+<h1>Articles</h1>
+
+
+</body>
+</html>

data/test/dummy/tmp/capybara/capybara-20110124133340.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  
+  <script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/prototype.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/effects.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/dragdrop.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/controls.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/rails.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/application.js?1295870562" type="text/javascript"></script>
+  
+</head>
+<body>
+
+  <div id='topnav'>
+      You are signed in as Bob.
+      <a href="/sign-out">Sign out</a>
+  </div>
+
+    <div class='flash notice'>You have successfully signed in.</div>
+
+<h1>Articles</h1>
+
+
+</body>
+</html>

data/test/dummy/tmp/capybara/capybara-20110124134001.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  
+  <script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/prototype.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/effects.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/dragdrop.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/controls.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/rails.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/application.js?1295870562" type="text/javascript"></script>
+  
+</head>
+<body>
+
+  <div id='topnav'>
+      You are signed in as Bob.
+      <a href="/sign-out">Sign out</a>
+  </div>
+
+    <div class='flash notice'>You have successfully signed in.</div>
+
+<h1>Articles</h1>
+
+
+</body>
+</html>

data/test/dummy/tmp/capybara/capybara-20110124134214.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  
+  <script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/prototype.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/effects.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/dragdrop.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/controls.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/rails.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/application.js?1295870562" type="text/javascript"></script>
+  
+</head>
+<body>
+
+  <div id='topnav'>
+      You are signed in as Bob.
+      <a href="/sign-out">Sign out</a>
+  </div>
+
+    <div class='flash notice'>You have successfully signed in.</div>
+
+<h1>Articles</h1>
+
+
+</body>
+</html>

data/test/dummy/tmp/capybara/capybara-20110124135435.html

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  
+  <script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/prototype.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/effects.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/dragdrop.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/controls.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/rails.js?1295870562" type="text/javascript"></script>
+<script src="/Users/andy/code/src/quo_vadis/test/dummy/public/javascripts/application.js?1295870562" type="text/javascript"></script>
+  
+</head>
+<body>
+
+  <div id='topnav'>
+      <a href="/sign-in">Sign in</a>
+  </div>
+
+    <div class='flash notice'>Please sign in first.</div>
+
+<h1>Sign in</h1>
+
+<form accept-charset="UTF-8" action="/sign-in" method="post"><div style="margin:0;padding:0;display:inline"><input name="utf8" type="hidden" value="&#x2713;" /></div>
+  <p>
+    <label for="username">Username</label>
+    <input id="username" name="username" type="text" />
+  </p>
+  <p>
+    <label for="password">Password</label>
+    <input id="password" name="password" type="password" />
+  </p>
+  <p>
+    <input name="commit" type="submit" value="Sign in" />
+  </p>
+</form>
+
+</body>
+</html>

data/test/integration/authenticate_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class AuthenticationTest < ActiveSupport::IntegrationCase
+
+  teardown do
+    Capybara.reset_sessions!
+  end
+
+  test 'action not requiring authentication' do
+    visit articles_path
+
+    assert_equal articles_path, current_path
+    within 'h1' do
+      assert page.has_content?('Articles')
+    end
+  end
+
+  test 'action requiring authentication' do
+    # try to see page
+    visit new_article_path
+    
+    # test we need to authenticate
+    assert_equal sign_in_path, current_path
+    within '.flash.notice' do
+      assert page.has_content? 'Please sign in first.'
+    end
+
+    # sign in
+    user_factory 'Bob', 'bob', 'secret'
+    sign_in_as 'bob', 'secret'
+    visit new_article_path
+
+    # test we can now see page
+    assert_equal new_article_path, current_path
+    within 'h1' do
+      assert page.has_content?('New Article')
+    end
+  end
+end

data/test/integration/config_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class ConfigTest < ActiveSupport::IntegrationCase
+
+  setup do
+    user_factory 'Bob', 'bob', 'secret'
+  end
+
+  teardown do
+    Capybara.reset_sessions!
+    reset_quo_vadis_configuration
+  end
+
+  test 'signed_in_url config' do
+    sign_in_as 'bob', 'secret'
+    assert_equal root_path, current_path
+    visit sign_out_path
+
+    QuoVadis.signed_in_url = :articles
+
+    sign_in_as 'bob', 'secret'
+    assert_equal articles_path, current_path
+  end
+
+  test 'signed_in_url proc config' do
+    QuoVadis.signed_in_url = Proc.new do |user|
+      user.name == 'Bob' ? :articles : :root
+    end
+    sign_in_as 'bob', 'secret'
+    assert_equal articles_path, current_path
+
+    QuoVadis.signed_in_url = Proc.new do |user|
+      user.name != 'Bob' ? :articles : :root
+    end
+    sign_in_as 'bob', 'secret'
+    assert_equal root_path, current_path
+  end
+
+  test 'override_original_url config' do
+    visit new_article_path
+    assert_equal sign_in_path, current_path
+    sign_in_as 'bob', 'secret'
+    assert_equal new_article_path, current_path
+    visit sign_out_path
+
+    QuoVadis.override_original_url = true
+
+    visit new_article_path
+    assert_equal sign_in_path, current_path
+    sign_in_as 'bob', 'secret'
+    assert_equal root_path, current_path
+  end
+
+  test 'signed_out_url config' do
+    visit sign_out_path
+    assert_equal root_path, current_path
+
+    QuoVadis.signed_out_url = :articles
+
+    visit sign_out_path
+    assert_equal articles_path, current_path
+  end
+
+  test 'signed_in_hook' do
+    QuoVadis.signed_in_hook = Proc.new do |user, request|
+      user.update_attributes :name => 'Robert'
+    end
+    sign_in_as 'bob', 'secret'
+    within '#topnav' do
+      assert page.has_content?('You are signed in as Robert.')
+    end
+  end
+
+  test 'failed_sign_in hook' do
+    QuoVadis.failed_sign_in_hook = Proc.new do |request|
+      request.flash[:muppet] = request.params[:username]
+    end
+    sign_in_as 'bob', 'wrong'
+    within '.flash.muppet' do
+      assert page.has_content?('bob')
+    end
+  end
+
+  test 'signed_out hook' do
+    QuoVadis.signed_out_hook = Proc.new do |user, request|
+      request.flash[:fyi] = user.name
+    end
+    sign_in_as 'bob', 'secret'
+    visit sign_out_path
+
+    within '.flash.fyi' do
+      assert page.has_content?('Bob')
+    end
+  end
+
+end

data/test/integration/helper_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class HelperTest < ActiveSupport::IntegrationCase
+
+  teardown do
+    Capybara.reset_sessions!
+  end
+
+  test 'Current user helper' do
+    user_factory 'Bob', 'bob', 'secret'
+    sign_in_as 'bob', 'secret'
+
+    within '#topnav' do
+      assert page.has_content?('You are signed in as Bob.')
+    end
+  end
+
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NavigationTest < ActiveSupport::IntegrationCase
+  test 'Sanity test' do
+    assert_kind_of Dummy::Application, Rails.application
+  end
+end

data/test/integration/sign_in_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class SignInTest < ActiveSupport::IntegrationCase
+
+  teardown do
+    Capybara.reset_sessions!
+  end
+
+  test 'failed sign in' do
+    sign_in_as 'bob', 'secret'
+
+    assert_equal sign_in_path, current_path
+    within '.flash.alert' do
+      assert page.has_content?('Sorry, we did not recognise you.')
+    end
+  end
+
+  test 'successful sign in' do
+    user_factory 'Bob', 'bob', 'secret'
+    sign_in_as 'bob', 'secret'
+
+    assert_equal root_path, current_path
+    within '.flash.notice' do
+      assert page.has_content?('You have successfully signed in.')
+    end
+  end
+
+end

data/test/integration/sign_out_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class SignOutTest < ActiveSupport::IntegrationCase
+
+  teardown do
+    Capybara.reset_sessions!
+  end
+
+  test 'sign out' do
+    user_factory 'Bob', 'bob', 'secret'
+    sign_in_as 'bob', 'secret'
+    visit sign_out_path
+
+    assert_equal root_path, current_path
+    within '.flash.notice' do
+      assert page.has_content?('You have successfully signed out.')
+    end
+  end
+
+end

data/test/quo_vadis_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class QuoVadisTest < ActiveSupport::TestCase
+  test 'Sanity test' do
+    assert_kind_of Module, QuoVadis
+  end
+end

data/test/support/integration_case.rb

@@ -0,0 +1,5 @@
+# Define a bare test case to use with Capybara
+class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
+  include Capybara
+  include Rails.application.routes.url_helpers
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Configure capybara for integration testing
+require "capybara/rails"
+Capybara.default_driver   = :rack_test
+Capybara.default_selector = :css
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+#
+# Common methods
+#
+
+def sign_in_as(username, password)
+  visit sign_in_path
+  fill_in 'username', :with => username
+  fill_in 'password', :with => password
+  click_button 'Sign in'
+end
+
+def user_factory(name, username, password)
+  User.create! :name => name, :username => username, :password => password
+end
+
+def reset_quo_vadis_configuration
+  QuoVadis.signed_in_url = :root
+  QuoVadis.override_original_url = false
+  QuoVadis.signed_out_url = :root
+  QuoVadis.signed_in_hook = nil
+  QuoVadis.failed_sign_in_hook = nil
+  QuoVadis.signed_out_hook = nil
+end