juice10-action_flow 0.1.0

data/test_app/db/schema.rb

@@ -0,0 +1,15 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/test_app/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/test_app/features/flow_management.feature

@@ -0,0 +1,122 @@
+Feature: Manage flow transitions
+
+  Background: Setup default flows
+    Given I have the flows:
+    """
+    flow :steps,    settings.one,
+                    settings.two,
+                    settings.three
+
+    flow :large,    settings.four,
+                    settings.five,
+                    settings.six,
+                    settings.seven,
+                    settings.eight
+
+    flow :process,  settings.intro + application.other,
+                    :steps,
+                    settings.outro(:id => find(:text))
+
+    flow :pass,     settings.passthrough,
+                    settings.intro
+    """
+  
+  Scenario: Simple flow sequence terminated at end
+    When I visit "/settings/one"
+    And I follow "Next"
+    Then I should be at "/settings/two"
+    When I follow "Next"
+    Then I should be at "/settings/three"
+    And I should not see "Next"
+  
+  Scenario: One sequence nested inside another
+    When I visit "/settings/intro"
+    And I follow "Next"
+    Then I should be at "/settings/one"
+    When I follow "Next"
+    Then I should be at "/settings/two"
+    When I follow "Next"
+    Then I should be at "/settings/three"
+    When I follow "Next"
+    Then I should be at "/settings/outro"
+  
+  Scenario: Skipping the outer sequence from the controller
+    When I visit "/settings/intro"
+    And I follow "Next"
+    Then I should be at "/settings/one"
+    When I visit "/settings/two?skip=true"
+    Then I should be at "/settings/outro"
+  
+  Scenario: Skip a subflow
+    When I visit "/settings/intro"
+    And I follow "Next"
+    And I follow "Skip"
+    Then I should be at "/settings/outro"
+  
+  Scenario: Get partway through a subflow before skipping
+    When I visit "/settings/intro"
+    And I follow "Next"
+    And I follow "Next"
+    And I follow "Skip"
+    Then I should be at "/settings/outro"
+  
+  Scenario: Get to the final page of a subflow before skipping
+    When I visit "/settings/intro"
+    And I follow "Next"
+    And I follow "Next"
+    And I follow "Next"
+    And I follow "Skip"
+    Then I should be at "/settings/outro"
+  
+  Scenario: Pass through variables to flow expressions
+    When I visit "/settings/intro/Hello"
+    And I follow "Next"
+    And I follow "Skip"
+    Then I should be at "/settings/outro/Hello"
+    Then I should see "Hello"
+  
+  Scenario: Last page of a flow is still part of the flow
+    When I visit "/settings/intro"
+    Then I should see "You're in the :process flow"
+    When I follow "Next"
+    And I follow "Skip"
+    Then I should see "You're in the :process flow"
+    When I visit "/settings/outro"
+    Then I should see "You're in the :process flow"
+  
+  Scenario: Backtracking still picks the right next action
+    When I visit "/settings/one"
+    And I follow "Next"
+    When I follow "Next"
+    Then I should be at "/settings/three"
+    When I visit "/settings/two"
+    When I follow "Next"
+    Then I should be at "/settings/three"
+  
+  Scenario: Skip back and forth between visited pages
+    When I visit "/settings/four"
+    And I follow "Next"
+    And I follow "Next"
+    And I follow "Next"
+    Then I should be at "/settings/seven"
+    When I visit "/settings/five"
+    And I follow "Next"
+    Then I should be at "/settings/six"
+    When I visit "/settings/five"
+    And I visit "/settings/seven"
+    And I follow "Next"
+    Then I should be at "/settings/eight"
+  
+  Scenario: Pass params through #next_in_flow
+    When I visit "/settings/passthrough/milk"
+    Then I should see "Received milk"
+  
+  Scenario: Session contains invalid objects
+    Given I visit "/settings/poison"
+    And I visit "/settings/one"
+  
+  Scenario: Session contains data for nonexistent flows
+    Given I visit "/settings/delete"
+    And I visit "/settings/one"
+    Then I should see "This is a step"
+

data/test_app/features/flow_with_array_alternatives.feature

@@ -0,0 +1,13 @@
+Feature: Use arrays instead of '+' to manage alternatives that reference flows using symbols
+  
+  Background:
+    Given I have the flows:
+    """
+    flow :has_alternates, [:start, anything.action]
+    flow :start,          settings.one
+    """
+  
+  Scenario: Enter a flow when I match a group of alternatives
+    When I visit "/settings/one"
+    Then I should see "In the alternatives flow"
+  

data/test_app/features/flows_with_conditions.feature

@@ -0,0 +1,60 @@
+Feature: Flows with conditions
+  In order to have finer grained control of what flows are active
+  I want to specify boolean conditions on flow expressions
+
+  Scenario: Mutually exclusive flows
+    Given I have the flows:
+    """
+    flow :steps,    settings.one,
+                    settings.two,
+                    settings.three
+
+    flow :mess,     settings.two { not in_any_flow? },
+                    settings.one
+    """
+    When I visit "/settings/one"
+    And I follow "Next"
+    When I follow "Next"
+    Then I should be at "/settings/three"
+    When I visit "/settings/two"
+    When I follow "Next"
+    Then I should be at "/settings/three"
+    And I should not see "Next"
+    
+  Scenario: Terminate flow on given expression
+    Given I have the flows:
+    """
+    flow :steps, settings.three
+                         
+    flow :mess, settings.two,
+                settings.three,
+                settings.four
+
+    terminate :mess, :on => settings.five
+    """
+    When I visit "/settings/two"
+    And I visit "/settings/five"
+    And I visit "/settings/three"
+    Then I am at the end of the "mess" flow
+
+  Scenario: Specify list of flows to terminate flow on given expression
+    Given I have the flows:
+    """
+    flow :flow_one, settings.one,
+                    settings.two,
+                    settings.five
+
+    flow :flow_two, settings.four,
+                    settings.five,
+                    settings.two
+
+    terminate :flow_one, :flow_two, :on => settings.seven
+    """
+    When I visit "/settings/one"
+    And I visit "/settings/seven"
+    And I visit "/settings/two"
+    Then I am at the end of the "flow_two" flow
+    When I visit "/settings/four"
+    And I visit "/settings/seven"
+    And I visit "/settings/five"
+    Then I am at the end of the "flow_one" flow

data/test_app/features/mutual_exclusion.feature

@@ -0,0 +1,39 @@
+Feature: Mutually exclusive flows
+  In order to simplify managment of overlapping flows
+  I want to mark sets of flows as mtually exclusive
+  
+  Background:
+    Given I have the flows:
+    """
+    flow :one, settings.one,
+               settings.two
+    
+    flow :two, settings.two
+    
+    flow :others, settings.four,
+                  settings.five
+    
+    terminate :others, :on => settings.one
+    
+    mutex :one, :two, :others
+    """
+  
+  Scenario: Don't enter a flow excluded by another
+    When I visit "/settings/one"
+    And I visit "/settings/two"
+    Then I should see "In flow one"
+    And I should not see "In flow two"
+  
+  Scenario: Locked flow becomes available after locking flow exits
+    When I visit "/settings/one"
+    And I visit "/settings/two"
+    And I visit "/settings/three"
+    And I visit "/settings/two"
+    Then I should not see "In flow one"
+    And I should see "In flow two"
+  
+  Scenario: Locked flow becomes available if it terminates another
+    When I visit "/settings/four"
+    And I visit "/settings/one"
+    Then I should see "Flow number 1"
+

data/test_app/features/step_definitions/flow_steps.rb

@@ -0,0 +1,20 @@
+module ActionFlow
+  def define_flows(flow_dsl_string)
+    ApplicationController.instance_eval do
+    
+      ActionFlow.configure do
+        instance_eval(flow_dsl_string)
+      end
+    end
+  end
+end
+
+World(ActionFlow)
+
+Given "I have the flows:" do |dsl|
+  define_flows(dsl)
+end
+
+Then /^I am at the end of the "([^\"]+)" flow$/ do |_|
+  Then 'I should not see "Next"'
+end

data/test_app/features/step_definitions/url_steps.rb

@@ -0,0 +1,7 @@
+When /^(?:|I )visit "([^\"]+)"$/ do |url|
+  visit(url)
+end
+
+Then /^I should be at "([^\"]+)"$/ do |url|
+  URI.parse(current_url).path.should == url
+end

data/test_app/features/step_definitions/web_steps.rb

@@ -0,0 +1,211 @@
+# TL;DR: YOU SHOULD DELETE THIS FILE
+#
+# This file was generated by Cucumber-Rails and is only here to get you a head start
+# These step definitions are thin wrappers around the Capybara/Webrat API that lets you
+# visit pages, interact with widgets and make assertions about page content.
+#
+# If you use these step definitions as basis for your features you will quickly end up
+# with features that are:
+#
+# * Hard to maintain
+# * Verbose to read
+#
+# A much better approach is to write your own higher level step definitions, following
+# the advice in the following blog posts:
+#
+# * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
+# * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
+# * http://elabs.se/blog/15-you-re-cuking-it-wrong
+#
+
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within ([^:]+)$/ do |step, parent|
+  with_scope(parent) { When step }
+end
+
+# Multi-line step scoper
+When /^(.*) within ([^:]+):$/ do |step, parent, table_or_string|
+  with_scope(parent) { When "#{step}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+ 
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
+  
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end