ActionFlow

action_step

Wed, 06 Jun 2007 16:21:13 -0400

The Action Step is used to map a method definition to a flow chain of execution. It is very simple and does not take much parameters. Read the Action Step API for more details. class MyController < ActionFlow::Base def initialize # Map an action step action_step :my_step do on :event_name => :next_step_name # Use the superclass 'method' instruction to map the method named # 'my_step_implementation_method' as this step implementation. # This is optionnal si…

actionflow

Fri, 11 Jan 2008 15:34:18 -0400

simplicity and fluidity with a Rails twist What's ActionFlow anyways ?! ActionFlow is a declarative flow controller usable by Ruby on Rails applications. Its an efficient, easy and simple Domain Specific Language which allows developers to organize a suite of user actions aimed at a precise goal.

api

Wed, 06 Jun 2007 16:17:53 -0400

This is the place to find all the RDoc documentation from the ActionFlow API. Edge The edge API can be found here. Deprecated releases * Release 0.1 ~~DISCUSSION~~

basic_mapping_example

Thu, 28 Jun 2007 11:43:06 -0400

There are two main parts in an ActionFlow controller. Its mapping and it’s step implementations. Here’s an example mapping taken from the Demo Application. There are many more mapping instructions available and it’s up to you to read the API. Don’t be lazy and read it: it’s definitely worth it if you are going to use ActionFlow.

concepts

Wed, 06 Jun 2007 16:18:12 -0400

Here are the main concepts of the ActionFlow framework. * Flow * State * Step * Action Step * View Step * Event * Session Handler * Flow Execution Key * Plugin ~~DISCUSSION~~

creating_controllers

Wed, 06 Jun 2007 16:16:16 -0400

To create an ActionFlow controller, you must subclass the ActionFlow::Base ruby class. class MyController < ActionFlow::Base def initialize # Add your mapping here end # Add your step implementations here end Here’s an example controller. This particular controller is an excerpt from the demo application provided to demonstrate the ActionFlow framework.

creating_views

Thu, 28 Jun 2007 11:49:09 -0400

There are four ways to send events to an ActionFlow controller. * By a link * By a form * By an AJAX link * By an AJAX form Any ActionFlow controller views can easily use these helper methods to create views that interact with the ActionFlow framework. To have all the details, consult the BaseHelper API.

demo_application

Wed, 06 Jun 2007 16:17:30 -0400

I’ve created a simple Rails application to demonstrate ActionFlow. It’s located on the project SVN repository at Rubyforge. You can either browse the source code or checkout the latest revision with svn co svn://rubyforge.org/var/svn/actionflow/demos/actionflow_demo

event

Wed, 06 Jun 2007 16:21:39 -0400

Events are objects which tell the ActionFlow framework what to do next once a step is complete. Although the event name is entirely up to the developer, some event names are reserved. See below for more details. Sample Usage Every step definition has to return an event. An event can be returned as follows.

flow

Wed, 06 Jun 2007 16:18:27 -0400

What is a flow A flow is an instance of the ActionFlow::Base class. It consists mainly of two things. * Mapping The instructions which tell the ActionFlow framework what to do and when to do it. * Step definitions The definition of what the declared steps do.

flow_execution_key

Wed, 06 Jun 2007 16:53:04 -0400

The flow execution key is a random string of 64 alphanumeric characters. It allows the ActionFlow Session Handler to restore a given state and continue a flow execution from the correct state hash snapshot. The flow execution key always has to be returned to the controller after the execution of a view by the user. Each submission of data has to be related to a flow key. If you submit data to an ActionFlow controller without providing a key, the controller will assume that you are requesting a …

flow_step

Thu, 17 May 2007 15:29:16 -0400

The Flow Step superclass makes basic step instructions available to any ActionFlow step type. Any step types have to inherit from this superclass. Mapping instructions The mapping instructions common to every step type are the following. on The on instruction is used to map a returned event name to a subsequent step. Here’s a simple example of it’s usage.

session_handler

Wed, 06 Jun 2007 16:52:23 -0400

The session handling logic is encapsulated in the SessionHandler module extension which is added to the ActionFlow::Base class eval at the plugin initialization. The session handler has the following responsibilities. * Expose the state variable, which is a hash that saves data which is relevant to the current flow state. * Generate state snapshots in the session hash. * Persist and restore each state data and make sure the state variable contains the data corresponding to the correct r…

state

Wed, 06 Jun 2007 16:50:42 -0400

There is a mechanism available in ActionFlow which enables users to store data inside what is called a flow state. It is imlemented as a Hash object which offers a historical snapshot of himself according to a user’S position inside a flow. This allows users to hit the back button and restore exactly the flow state they were in at that precise point in the flow.

step

Wed, 06 Jun 2007 16:20:57 -0400

A step is a single unit of work which is part of a flow. Different step types will perform different tasks. Steps are ordered with ActionFlow’s domain specific language with the help of the “on” and the “upon” methods defined in the FlowStep superclass.

success_stories

Thu, 28 Jun 2007 11:11:00 -0400

I’d like to hear from the people who tried ActionFlow. Please provide feedback as to what went wrong and what was just perfect so that I can improve it to better fit your needs. Use the discussion controls down this page, and thanks a million !

view_step

Wed, 06 Jun 2007 16:21:25 -0400

A View Step is mainly used to render a view to the user. It’s default behavior facilitates this process. But it can do much more than that. Read the View Step API for more details. Here are examples of view steps. More are included in the demo application.