Class.js

Class system for low level javascript which includes inheritance, mixins, inherited statics, python style, proxy...

Setup

to setup the project for local development start with these commands in your terminal.

git clone https://github.com/y1j2x34/Class.js
cd Class.js/
npm install

Running tests

To execute all unit tests, use:

npm test

or

npm run test_phantomjs

Examples

Create Class

var Point = Class.create({
    statics: {
        DIMENSION: 1
    },
    init: function(self, x, y){
        self.x = x;
        self.y = y;
    },
    clone: function(self){
        return new self.clazz(self.x, self.y);
    }
});

Inheritance

var Animal = Class.create({
    statics: {
        STATIC_VALUE: {}
    },
    init: function(self){
        console.info('new animal');
    },
    run: function(){
        console.info('animal running');
    }
});
var Dog = Class.extend(Animal, {
    init: function(self){
        self.$super(arguments);
        console.info('new dog');
    },
    run: function(self){
        self.$callSuper('run');
        console.info('dog running');
        console.info('self.superclass === Animal', self.superclass === Animal);
    }
});
// or 
var Dog2 = Animal.extend({
    // ...
});

console.info(Animal.STATIC_VALUE === Dog.STATIC_VALUE); // true

new Dog().run();
// output:
// new animal
// new dog
// animal running
// dog running
// self.superclass === Animal true

Mixin

var Animal = Class.create('Animal', {
    name: 'Animal',
    init: function(self){
        self.$super(arguments);
        console.info('create animal');
    },
    bite: function(){
        console.info('animal bite');
    }
});

var Mammal = Class.extend(Animal, {
    name: 'Mammal',
    init: function(self){
        self.$super(arguments);
        console.info('create mammal');
    },
    bite: function(){
        console.info('mammal bite');
    }
});

var Flyable = Class.extend(Animal, {
    name: 'Flyable',
    init: function(self){
        self.$super(arguments);
        console.info('create flyable');
    },
    fly: function(){
        console.info('flyable flying');
    },
    landing: function(){
        console.info('flyable landing');
    }
});

var Bird = Class.extend(Flyable, {
    name: 'Bird',
    init: function(self){
        self.$super(arguments);
        console.info('create bird');
    },
    bite: function() {
        console.info("bird can't bite");
    },
    fly: function() {
        console.info('bird fly');
    },
    eat: function(){
        console.info('bird like to eat worms');
    }
});

var Puppy = Class.extend(Flyable, {
    name: 'Wang',
    pythonic: false,
    init: function(){
        this.$super(arguments);
        console.info('create puppy');
    },
    eat: function(){
        console.info('puppy eat');
    },
    smile: function(){
        console.info('smilling puppy');
    }
});


var flyingPuppy = Class.singleton(Class.mix(Mammal).with(Bird, Puppy), {
    name:  'FlyingPuppy',
    init: function(self) {
        self.$super(arguments);
        console.info('create FlyingPuppy');
    },
    fly: function() {
        console.info('I can fly to anywhere on the earth');
    }
});
// output:
// create animal
// create mammal
// create puppy
// create bird
// create FlyingPuppy


flyingPuppy.fly(); //I can fly to anywhere on the earth
flyingPuppy.bite(); // animal bite
flyingPuppy.landing(); // flyable landing
flyingPuppy.eat(); // puppy eat
flyingPuppy.smile();// smilling puppy

Proxy

var Cat = Class.create({
    meow: function(){
        console.info('meow~~~');
        return 'meow';
    }
});

// proxy object
var cat = new Cat();
var proxy = Class.proxy(cat, function(originObject, func, args){
    console.info('before~');
    var ret = func.apply(originObject, arg);
    console.info('after~');
    return ret;
});
proxy.meow(); // returns 'meow'
// output:
// before~
// meow~~~
// after~

// proxy class
var ProxyCat = Class.proxy(Cat, function(originalObject, func, args){
    console.info('before~');
    var ret = func.apply(originObject, arg);
    console.info('after~');
    return ret;
});

new ProxyCat().meow();
// output:
// before~
// meow~~~
// after~

Decorator

var Airplane = Class.create('Airplane', {
    init: function(){
        console.info('new airplane');
    },
    fly: function(self, where) {
        console.info('fly above the ' + where);
    },
    landing: function() {
        console.info('landing');
    }
});

var DecorateAirplane = Class.decorate(Airplane, {
    fly: function(fn, arguments){
        console.info('before');
        return fn.call(this, ['mars']);
    }
});
new DecorateAirplane().fly('earth');
// output:
// new airplane
// before
// fly above the mars

var DecorateAirplane = Class.decorate(Airplane, {
    fly: {
        before: function(where) {
            console.info(where, 'is too dangerous,please transfer to mars!');
            return ['mars'];
        },
        returns: function() {
            return true;
        },
        thrown: function(error) {
            console.error('an error occurred', error);
            throw error; // after() will not be called;
        },
        after: function(returnvalue) {
            console.info('complete without errors, returns: ', returnvalue);
        }
    },
});
new DecorateAirplane().fly('earth');
// output:
// new airplane
// earth is too dangerous,please transfer to mars!
// fly above the mars
// complete without errors, returns: true

var DecorateAirplane = Class.decorate(Airplane, {
    '*': {
        before: function(){
            console.info('before any method');
        }
    }
})
new DecorateAirplane().fly('earth');
// output:
// before any method
// fly above the earth

var DecorateAirplane = Class.decorate(Airplane, {
    constructor: {
        before: function(){
            console.info('before init');
        },
        // This will be ignored
        returns: function(){
        },
        thrown: function(error){
            console.error('an error occurred', error);
        },
        after: function(instance){
            console.info('after init', instance);
        }
    }
});
new DecorateAirplane();
// output :
// before init
// new airplane
// after init {...}

Configuration

Class.configure({
    pythonic: false
});

enum

var Color = Class.createEnum({
    YELLOW: ['#FFFF00'],
    GREEN: ['#00FF00'],
    BLUE: ['#0000FF'],
    RED: ['#FF0000']
}, {
    pythonic: false,
    init: function(hex){
        this.hex = hex;
    }
});
console.info(Color.RED instanceof Color); // true
console.info(Color.RED.hex === '#FF0000'); // true
console.info(Color.RED.name() === 'RED'); // true

var State = Class.createEnum(['Stopped','Running', 'Paused']);
console.info(State.Stopped instanceof State); // true
console.info(State.values());// [Stopped {}, Running {}, Paused {} ]