wicked-focused 0.2.0

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

@@ -0,0 +1,202 @@
+(function() {
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var token = $$('meta[name=csrf-token]')[0];
+      if (token) {
+        if (!request.options.requestHeaders) request.options.requestHeaders = {};
+        request.options.requestHeaders['X-CSRF-Token'] = token.readAttribute('content');
+      }
+    }
+  });
+
+  // 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, textarea', 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');
+      // serialize the form with respect to the submit button that was pressed
+      params = element.serialize({ submit: element.retrieve('rails:submit-button') });
+      // clear the pressed submit button information
+      element.store('rails:submit-button', null);
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onCreate:   function(response) { element.fire("ajax:create",   response); },
+      onComplete: function(response) { element.fire("ajax:complete", response); },
+      onSuccess:  function(response) { element.fire("ajax:success",  response); },
+      onFailure:  function(response) { element.fire("ajax:failure",  response); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function insertHiddenField(form, name, value) {
+    form.insert(new Element('input', { type: 'hidden', name: name, value: value }));
+  }
+
+  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') {
+      insertHiddenField(form, '_method', method);
+    }
+
+    if (csrf_param) {
+      insertHiddenField(form, csrf_param.readAttribute('content'), csrf_token.readAttribute('content'));
+    }
+
+    form.submit();
+  }
+
+  function disableFormElements(form) {
+    form.select('input[type=submit][data-disable-with]').each(function(input) {
+      input.store('rails:original-value', input.getValue());
+      input.setValue(input.readAttribute('data-disable-with')).disable();
+    });
+  }
+  
+  function enableFormElements(form) {
+    form.select('input[type=submit][data-disable-with]').each(function(input) {
+      input.setValue(input.retrieve('rails:original-value')).enable();
+    });
+  }
+
+  function allowAction(element) {
+    var message = element.readAttribute('data-confirm');
+    return !message || confirm(message);
+  }
+
+  document.on('click', 'a[data-confirm], a[data-remote], a[data-method]', function(event, link) {
+    if (!allowAction(link)) {
+      event.stop();
+      return false;
+    }
+
+    if (link.readAttribute('data-remote')) {
+      handleRemote(link);
+      event.stop();
+    } else if (link.readAttribute('data-method')) {
+      handleMethod(link);
+      event.stop();
+    }
+  });
+
+  document.on("click", "form input[type=submit], form button[type=submit], form button:not([type])", function(event, button) {
+    // register the pressed submit button
+    event.findElement('form').store('rails:submit-button', button.name || false);
+  });
+
+  document.on("submit", function(event) {
+    var form = event.findElement();
+
+    if (!allowAction(form)) {
+      event.stop();
+      return false;
+    }
+
+    if (form.readAttribute('data-remote')) {
+      handleRemote(form);
+      event.stop();
+    } else {
+      disableFormElements(form);
+    }
+  });
+
+  document.on('ajax:create', 'form', function(event, form) {
+    if (form == event.findElement()) disableFormElements(form);
+  });
+  
+  document.on('ajax:complete', 'form', function(event, form) {
+    if (form == event.findElement()) enableFormElements(form);
+  });
+})();

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/integration/helpers_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class HelpersTest < ActiveSupport::IntegrationCase
+
+  test 'next_wizard_path' do
+    step = :first
+    visit(bar_path(step))
+    assert has_content?('first')
+    click_link 'skip'
+    assert has_content?('second')
+  end
+
+  test 'wizard_path' do
+    step = :first
+    visit(bar_path(step))
+    click_link 'current'
+    assert has_content?(step.to_s)
+  end
+
+  test 'wizard_path with symbol arg' do
+    step = :first
+    visit(bar_path(step))
+    click_link 'last'
+    assert has_content?('last_step')
+  end
+
+  test 'previous_wizard_path' do
+    step = :second
+    visit(bar_path(step))
+    click_link 'previous'
+    assert has_content?("first")
+  end
+
+  test 'wizard_steps' do
+    step = :last_step
+    visit(bar_path(step))
+    assert has_content?("step 3 of 3")
+  end
+
+end

data/test/integration/jump_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class JumpNavigationTest < ActiveSupport::IntegrationCase
+  test 'consider jump_to when calling render_wizard with resource' do
+    step = :first
+    visit(jump_path(step, :resource => {:save => true}, :jump_to => :last_step))
+    assert has_content?('last_step')
+  end
+
+  test 'disregard jump_to when saving the resource fails' do
+    step = :first
+    visit(jump_path(step, :resource => {:save => false}, :jump_to => :last_step))
+    assert has_content?('first')
+    assert !has_content?('last_step')
+  end
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class InheritNavigationTest < ActiveSupport::IntegrationCase
+
+  test 'default index' do
+    visit(foo_index_path)
+    assert has_content?('first')
+  end
+
+  test 'show first' do
+    step = :first
+    visit(foo_path(step))
+    assert has_content?(step.to_s)
+  end
+
+  test 'show second' do
+    step = :second
+    visit(foo_path(step))
+    assert has_content?(step.to_s)
+  end
+
+  test 'skip first' do
+    step = :first
+    visit(foo_path(step.to_s, :skip_step => 'true'))
+    assert has_content?('second')
+  end
+
+  test 'invalid step' do
+    step = :notastep
+    assert_raise(ActionView::MissingTemplate) do
+      visit(foo_path(step))
+    end
+  end
+
+  test 'finish' do
+    step = :finish
+    visit(foo_path(step))
+    assert has_content?('home')
+  end
+
+end
+
+
+class IncludeNavigationTest < ActiveSupport::IntegrationCase
+
+  test 'show first' do
+    step = :first
+    visit(bar_path(step))
+    assert has_content?(step.to_s)
+  end
+
+  test 'show second' do
+    step = :second
+    visit(bar_path(step))
+    assert has_content?(step.to_s)
+  end
+
+  test 'skip first' do
+    step = :first
+    visit(bar_path(step, :skip_step => 'true'))
+    assert has_content?(:second.to_s)
+  end
+
+  test 'pointer to first' do
+    visit(bar_path(:wizard_first))
+    assert has_content?('first')
+  end
+
+  test 'pointer to last' do
+    visit(bar_path(:wizard_last))
+    assert has_content?('last_step')
+  end
+
+  test 'invalid step' do
+    step = :notastep
+    assert_raise(ActionView::MissingTemplate) do
+      visit(bar_path(step))
+    end
+  end
+
+  test 'finish' do
+    step = :finish
+    visit(bar_path(step))
+    assert has_content?('home')
+  end
+end
+
+

data/test/integration/steps_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class StepPositionsTest < ActiveSupport::IntegrationCase
+
+  test 'on first' do
+    step = :first
+    visit(step_position_path(step))
+    assert has_content?('first step is the current step')   # current_step?
+    assert true                                             # past_step?
+    assert has_content?('last_step step is a future step')  # future_step?
+    assert has_content?('second step is a future step')     # future_step?
+    assert true                                             # previous_step?
+    assert has_content?('second step is the next step')     # next_step?
+  end
+
+  test 'on second' do
+    step = :second
+    visit(step_position_path(step))
+    assert has_content?('second step is the current step')  # current_step?
+    assert has_content?('first step is a past step')        # past_step?
+    assert has_content?('last_step step is a future step')  # future_step?
+    assert has_content?('first step was the previous step') # previous_step?
+    assert has_content?('last_step step is the next step')  # next_step?
+  end
+
+end
+
+  # current_step?
+  # past_step?
+  # future_step?
+  # previous_step?
+  # next_step?

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::DSL
+  include Rails.application.routes.url_helpers
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'rails'
+
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+
+
+ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
+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 }

data/test/wicked_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class WickedTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Wicked
+  end
+end

data/wicked-focused.gemspec

@@ -0,0 +1,138 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "wicked-focused"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kristianmandrup", "schneems"]
+  s.date = "2012-08-06"
+  s.description = "Rails engine for producing Focused Controller based wizards"
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".rvmrc",
+    ".travis.yml",
+    "CHANGELOG.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/wicked-focused.rb",
+    "lib/wicked/action.rb",
+    "lib/wicked/controller/concerns/path.rb",
+    "lib/wicked/controller/concerns/render_redirect.rb",
+    "lib/wicked/controller/concerns/steps.rb",
+    "lib/wicked/engine.rb",
+    "lib/wicked/macros.rb",
+    "lib/wicked/wizard.rb",
+    "test/dummy/Rakefile",
+    "test/dummy/app/controllers/application_controller.rb",
+    "test/dummy/app/controllers/bar_controller.rb",
+    "test/dummy/app/controllers/foo_controller.rb",
+    "test/dummy/app/controllers/jump_controller.rb",
+    "test/dummy/app/controllers/steps_controller.rb",
+    "test/dummy/app/helpers/application_helper.rb",
+    "test/dummy/app/models/bar.rb",
+    "test/dummy/app/views/bar/first.html.erb",
+    "test/dummy/app/views/bar/last_step.html.erb",
+    "test/dummy/app/views/bar/second.html.erb",
+    "test/dummy/app/views/foo/first.html.erb",
+    "test/dummy/app/views/foo/last_step.html.erb",
+    "test/dummy/app/views/foo/second.html.erb",
+    "test/dummy/app/views/jump/first.html.erb",
+    "test/dummy/app/views/jump/last_step.html.erb",
+    "test/dummy/app/views/jump/second.html.erb",
+    "test/dummy/app/views/layouts/application.html.erb",
+    "test/dummy/app/views/step_positions/_step_position.html.erb",
+    "test/dummy/app/views/step_positions/first.html.erb",
+    "test/dummy/app/views/step_positions/last_step.html.erb",
+    "test/dummy/app/views/step_positions/second.html.erb",
+    "test/dummy/config.ru",
+    "test/dummy/config/application.rb",
+    "test/dummy/config/boot.rb",
+    "test/dummy/config/database.yml",
+    "test/dummy/config/environment.rb",
+    "test/dummy/config/environments/development.rb",
+    "test/dummy/config/environments/production.rb",
+    "test/dummy/config/environments/test.rb",
+    "test/dummy/config/initializers/backtrace_silencers.rb",
+    "test/dummy/config/initializers/inflections.rb",
+    "test/dummy/config/initializers/mime_types.rb",
+    "test/dummy/config/initializers/secret_token.rb",
+    "test/dummy/config/initializers/session_store.rb",
+    "test/dummy/config/initializers/wicked.rb",
+    "test/dummy/config/locales/en.yml",
+    "test/dummy/config/routes.rb",
+    "test/dummy/public/404.html",
+    "test/dummy/public/422.html",
+    "test/dummy/public/500.html",
+    "test/dummy/public/favicon.ico",
+    "test/dummy/public/index.html",
+    "test/dummy/public/javascripts/application.js",
+    "test/dummy/public/javascripts/controls.js",
+    "test/dummy/public/javascripts/dragdrop.js",
+    "test/dummy/public/javascripts/effects.js",
+    "test/dummy/public/javascripts/prototype.js",
+    "test/dummy/public/javascripts/rails.js",
+    "test/dummy/public/stylesheets/.gitkeep",
+    "test/dummy/script/rails",
+    "test/integration/helpers_test.rb",
+    "test/integration/jump_test.rb",
+    "test/integration/navigation_test.rb",
+    "test/integration/steps_test.rb",
+    "test/support/integration_case.rb",
+    "test/test_helper.rb",
+    "test/wicked_test.rb",
+    "wicked-focused.gemspec"
+  ]
+  s.homepage = "http://github.com/schneems/wicked"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Use Wicked to turn your Focused Controller into a wizard"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.7"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.7"])
+      s.add_runtime_dependency(%q<focused_controller>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 1.0.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<launchy>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.7"])
+      s.add_dependency(%q<rails>, [">= 3.0.7"])
+      s.add_dependency(%q<focused_controller>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<capybara>, [">= 1.0.0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<launchy>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.7"])
+    s.add_dependency(%q<rails>, [">= 3.0.7"])
+    s.add_dependency(%q<focused_controller>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<capybara>, [">= 1.0.0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<launchy>, [">= 0"])
+  end
+end
+