Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

124 lines (80 sloc) 2.641 kb

Red Yellow Green

Finite state machine in JavaScript.

This project uses Semantic Versioning.

Sponsored by Evil Martians.

API

Coming soon.

Examples

Define events

State machine definition:

class TrafficLights extends RedYellowGreen

  # Default state
  state: 'red'

  # Avaliable states list
  states: [
    'red'
    'yellow'
    'green'
  ]

  # Events list
  events:
    makeRed:    'yellow -> red'
    makeGreen:  'yellow -> green'
    makeYellow: 'red, green -> yellow'

Usage:

trafficLights = new TrafficLights() # => state: red

trafficLights.makeYellow() # => state: yellow
trafficLights.makeGreen()  # => state: green
trafficLights.makeRed()    # => throw ReferenceError

Callbacks

State machine definition:

class Timer extends RedYellowGreen

  # Default state
  state: 'stopped'

  # Avaliable states list
  states: [
    'stopped'
    'started'
  ]

  # Events list
  events:
    start: 'stopped -> started'
    stop:  'started -> stopped'

  ## Callbacks

  onStopped: ->
    # Process callback

  onStarted: ->
    # Process callback

Usage:

timer = new Timer()
timer.start() # => timer.onStarted was called
timer.stop()  # => timer.onStopped was called

Roadmap

Coming soon.

Changelog

0.1.0 (October 20, 2011)

  • Initial release

Contributing

Bundle necessary gems:

bundle

Start Jasmine and Guard via Foreman:

foreman start

More info coming soon.

License

The MIT License

Copyright (c) 2011 Sasha Koss

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Jump to Line
Something went wrong with that request. Please try again.