mayakwd / robotlegs

A Haxe application framework for OpenFL

Robotlegs

Robotlegs is a Haxe application framework for OpenFL. It offers:

• Dependency injection
• Module management
• Command management
• View management
• Plug-and-play extensions

Download

http://www.robotlegs.org/

Documentation & Support

The framework documentation exists as README files in the repository. The best way to read them is through GitHub:

Documentation

Support

Robotlegs 2 (What's New?)

• The fluent API makes your code more readable
• An extension mechanism makes the framework highly customizable
• Bundles allow you to get applications started quickly
• Lightweight, built-in logging shows you what the framework is doing
• Mediators can be mapped to abstract types and interfaces
• View processing has been significantly optimized
• A context can process more than one display list (PopUp support)
• Greatly simplified module (multi-context) support

Change log

Quickstart

Creating A Context

To create a Robotlegs application or module you need to instantiate a Context. A context won't do much without some configuration.

Plain Haxe:

_context = new Context()
    .install(MVCSBundle)
    .configure(MyAppConfig, SomeOtherConfig)
    .configure(new ContextView(this));

We install the MVCSBundle, which in turn installs a number of commonly used Extensions. We then add some custom application configurations.

We pass the instance "this" through as the "contextView" which is required by many of the view related extensions. It must be installed after the bundle or it won't be processed. Also, it should always be added as the final configuration as it may trigger context initialization.

Note: You must hold on to the context instance or it will be garbage collected.

Framework

Context Initialization

If a ContextView is provided the Context is automatically initialized when the supplied view lands on stage. Be sure to install the ContextView last, as it may trigger context initialization.

If a ContextView is not supplied then the Context must be manually initialized.

_context = new Context()
    .install(MyCompanyBundle)
    .configure(MyAppConfig, SomeOtherConfig)
    .initialize();

ContextView

Application & Module Configuration

A simple application configuration file might look something like this:

public class MyAppConfig implements IConfig
{
    @inject public var injector:IInjector;

    @inject public var mediatorMap:IMediatorMap;

    @inject public var commandMap:IEventCommandMap;

    @inject public var contextView:ContextView;

    public function configure():void
    {
        // Map UserModel as a context enforced singleton
        injector.map(UserModel).asSingleton();

        // Create a UserProfileMediator for each UserProfileView
        // that lands inside of the Context View
        mediatorMap.map(UserProfileView).toMediator(UserProfileMediator);

        // Execute UserSignInCommand when UserEvent.SIGN_IN
        // is dispatched on the context's Event Dispatcher
        commandMap.map(UserEvent.SIGN_IN).toCommand(UserSignInCommand);

        // The "view" property is a DisplayObjectContainer reference.
        // If this was a Flex application we would need to cast it
        // as an IVisualElementContainer and call addElement().
        contextView.view.addChild(new MainView());
    }
}

The configuration file above implements IConfig. An instance of this class will be created automatically when the context initializes.

We Inject the utilities that we want to configure, and add our Main View to the Context View.

Framework

An Example Mediator

The mediator we mapped above might look like this:

public class UserProfileMediator extends Mediator
{
    @inject public var view:UserProfileView;

    override public function initialize():void
    {
        // Redispatch an event from the view to the framework
        addViewListener(UserEvent.SIGN_IN, dispatch);
    }
}

The view that caused this mediator to be created is available for Injection.

MediatorMap

An Example Command

The command we mapped above might look like this:

public class UserSignInCommand extends Command
{
    @inject public var event:UserEvent;

    @inject public var model:UserModel;

    override public function execute():void
    {
        if (event.username == "bob")
            model.signedIn = true;
    }
}

The event that triggered this command is available for Injection.

EventCommandMap

Building and Running the Tests

Building with ANT

Copy the "user.properties.eg" file to "user.properties" and edit it to point to your local Flex SDK. Then run:

ant package

Building with Maven

See: Maven-README

Building with Buildr on OSX

• Install XCode 3 or 4

• check RubyGems version

  $ gem -v 1.8.1

• update RubyGems if version is less than 1.3.6

  $ sudo gem update --system

• install Bundler

  $ sudo gem install bundler

• run Bundler to install dependencies

  $ bundle install

• run Buildr to build RobotLegs & run Tests

  $ bundle exec buildr test

• open test report

  $ open reports/flexunit4/html/index.html

Example output of this process

Robotlegs 1

The source for Robotlegs 1 can be found in the version1 branch:

Robotlegs Version 1 Branch