docbrown

DocBrown

Minimalistic, simple, opinionated Flux implementation. Right, yet another one, I'm so sorry.

Read more about Flux here.

Dispatcher

Essential, central piece of the Flux architecture, the Dispatcher registers and dispatches action events.

Creating a dispatcher is rather simple:

var Dispatcher = DocBrown.createDispatcher();

Dispatcher.dispatch("foo");

Most of the time, you'll never have to directly consume from the Dispatcher; Actions and Stores will.

Actions

Actions are defined using an array of strings, where entries are action names. Actions are responsible of dispatching events on their own, that's why they need to know about the dispatcher.

var Dispatcher = DocBrown.createDispatcher();
var TimeActions = DocBrown.createActions(Dispatcher, [
  "backward",
  "forward"
]);

typeof TimeActions.backward; // "function"
typeof TimeActions.forward;  // "function"

TimeActions.forward(); // dispatches a "forward" action event.

Note: Arguments passed to action functions are applied to their matching store methods.

Stores

A store reflects the current state of a given application domain data. It:

• defines initial state;
• alters state;
• subscribes to action events and optionnaly react accordingly (eg. by altering state);
• notifies subscribers from state change events.

var Dispatcher = DocBrown.createDispatcher();
var TimeActions = DocBrown.createActions(Dispatcher, [
  "backward",
  "forward"
]);
var TimeStore = DocBrown.createStore({
  actions: [TimeActions],
  getInitialState: function() {
    return {year: 2015};
  },
  backward: function() {
    this.setState({year: this.getState().year - 1});
  },
  forward: function() {
    this.setState({year: this.getState().year + 1});
  },
});

// Usage
var store = new TimeStore();

console.log(store.getState().year); // 2015

store.subscribe(function(state) {
  console.log(state.year);                 // 2016
  console.log(state === store.getState()); // true
});

store.forward();

Promises support

Store action handlers returning promises will execute *Success and *Error handlers, respectively on success and rejection:

var TimeStore = DocBrown.createStore({
  actions: [TimeActions],
  getInitialState: function() {
    return {year: 2015};
  },
  backward: function(years) {
    return new Promise(function(fulfill, reject) {
      setTimeout(function() {
        if (Math.random() > .5) {
          fulfill(years); // calls backwardSuccess
        } else {
          reject(new Error("Damn.")); // calls backwardError
        }
      }.bind(this), 50);
    });
  },
  backwardSuccess: function(years) {
    this.setState({years: this.state.years - years});
  },
  backwardError: function(error) {
    this.setState({error: error});
  }
});

Yeah, this is a little magic, though so convenient. I debated that. Anyway.

If you're not working with Promise and want to deal with triggering store updates explicitely; note that this also allows to finely control any supplementary transition steps, while a little more verbose:

var TimeActions = DocBrown.createActions(Dispatcher, [
  "travelBackward",
  "travelBackwardStarted",
  "travelBackwardSucceeded",
  "travelBackwardFailed"
]);

var TimeStore = DocBrown.createStore({
  actions: [TimeActions],
  getInitialState: function() {
    return {year: 2015, travelling: false, error: null};
  },
  travelBackward: function(years) {
    TimeActions.travelBackwardStarted(years);
    setTimeout(function() {
      if (Math.random() > .5) {
        TimeActions.travelBackwardSucceeded(this.getState().years - years);
      } else {
        TimeActions.travelBackwardFailed(new Error("Damn."));
      }
    }.bind(this), 50);
  },
  travelBackwardStarted: function(years) {
    this.setState({travelling: true});
  },
  travelBackwardSucceeded: function(newYear) {
    this.setState({year: newYear, travelling: false});
  },
  travelBackwardFailed: function(err) {
    this.setState({error: err, travelling: false});
  }
});

React mixin

This Flux implementation isn't tied to React, though a React mixin is conveniently provided.

Basic usage:

var Dispatcher = DocBrown.createDispatcher();

var TimeActions = DocBrown.createActions(Dispatcher, ["travelBy"]);

var TimeStore = DocBrown.createStore({
  actions: [TimeActions],
  getInitialState: function() {
    return {year: new Date().getFullYear()};
  },
  travelBy: function(years) {
    this.setState({year: this.getState().year + years});
  }
});

var Counter = React.createClass({
  mixins: [DocBrown.storeMixin(timeStore)],

  travelClickHandler: function(years) {
    return function() {
      TimeActions.travelBy(years);
    };
  },

  render: function() {
    return <div>
      <p style={{fontSize: "30px"}}>Year: {this.state.year}</p>
      <button onClick={this.travelClickHandler(-1)}>back 1 year</button>
      <button onClick={this.travelClickHandler(1)}>forward 1 year</button>
    </div>;
  }
});

React.render(<Counter/>, document.body);

A working demo is available in the demo/ directory in this repository and on JSBin.

Dynamic store retriever

When applying the storeMixin at react class declaration time, it might happen that your store instance isn't created just yet; in that case you can pass a function to the storeMixin function instead of a store object:

// registry module
module.exports = {};

// app module
var registry = require("registry")
// …
registry.timeStore = new TimeStore();
// …

// view module
var registry = require("registry");
var Counter = React.createClass({
  mixins: [DocBrown.storeMixin(function() {
    return registry.timeStore;
  })],
  actions: [Actions],
  // …
});

That way, the mixin will only try to retrieve the store instance at component mount time.

Install

$ git clone https://github.com/n1k0/docbrown.git
$ npm install --dev

Test

$ npm test

Note: this will try to send coverage reports to Coveralls. Ignore any error about that.

License

MIT.