refinable.js docs    home    ex    api    docs    thy    arch    repo

This article is partially unfinished. You are welcome to create pull requests to help completing this article.

Below examples shows how self can be used for building a typical web application, starting from domain analysis.

Hierarchical Relationship

Construction

var Refinable = require('refinable');

var DBQuery = new Behavior();

DBQuery.add(auth);
DBQuery.add(validate);
DBQuery.add(monit);

Inheritance

/* Operation-specific Processing */
var ReadDBQuery = DBQuery.new();
var WriteDBQuery = DBQuery.new();

/* Object-specific Processing */
var ReadPosts = ReadDBQuery.new();
var WritePost = WriteDBQuery.new();

/* Feature-specific Processing */
var ReadPostsRecents = ReadPosts.new();
var ReadPostsPopular = ReadPosts.new();
var CreatePost = WritePost.new();
var UpdatePost = WritePost.new();

Explicit Refinement

var WriteDBQuery = DBQuery.new();

WriteDBQuery.add(writeBack);
WriteDBQuery.monitoring.update(cacheMonit);
WriteDBQuery.validate.before(beforeValidate);
WriteDBQuery.validate.after(afterValidate);
WriteDBQuery.validate.map(() => {
  return (validate) => {
    validateWrapper(validate);
  }
});

WriteDBQuery.beforeValidate.delete();

var CreatePost = new WriteDBQuery();

CreatePost.add(createUserSQLExec);
CreatePost.auth.update(twoFactorAuth);

Implicit Refinement

Traits is object-independent, set of composable behavior. By assign method, the behavior could be refined in high-level and implicit manner.

var publicApiTraits = {
    auth: null
};

WriteDBQuery.assign(publicApiTraits);

Custom Refinement

By using defineMethod, the user can create custom refinement method by accessing behavior array in the function. The following example is removing sub-behavior which start with add by doing simple pattern matching. In the definition, usage of standard API is possible by apply method with a custom scope.

Formula.defineMethod('deleteAddition', function () {
  var self = this;
  this.behaviorStore.behaviors.forEach(function (behavior) {
    if (behavior.name.slice(0, 3) === 'add') {
      self.delete.apply({name: behavior.name, behaviorStore: self.behaviorStore});
      // or by using private API
      //self.behaviorStore.deleteBehavior(behavior.name);
    }
  });
});

Made by hiunEdit this page on GitHub