jinject

jinject is an IoC container for node which focus on resolve object dependencies. The project is largely inspired by Ninject.

Installation

Features

• Focus on resolving object dependencies.
• Can resolve inline object and function.
• Asynchronous resolving (Unstable / Not test)
• Fluent API for define dependency binding.
• Scope capability (Transient, Singleton).
• Bind validation of object depend on other object structure (interface/contract like)
• Capability to create not found properties in an object when resolve dependencies.
• No package dependencies

Getting start

The container resolve object dependencies. You can declare dependencies to inject as inline object or function :

var Dependency = {
    myAttribute : 'Hello world'
};

var FunctionDependency = function(){
    var self = this;
    self.myAttribute = 'Hello world';
};

To define binding use the fluent capability of the API :

var ObjectToInspect = {
    aPropObjectToInspect : {};
};

var kernel = require('jinject');
kernel.bind('aPropObjectToInspect').to(Dependency).inSingletonScope();

By default jinject inject a dependency when the property to inspect is found. But you can dynamically create a not found property :

kernel.bind('aPropObjectToInspect').to(Dependency).create(true).inSingletonScope();

Binding can have contract on dependency. To do this, your need to define an inline object which contains keys / values structure. Keys are property name and values are types corresponding of the properties to inspect :

var Contract = {
    myProp : "string"
};

Kernel call binding method "isValid" to check the structure of an object. This method is public, you can invoke it like this :

var ValidDependency = {
    myProp : 'this is a valid type :)'
};

var InvalidDependency = {
    myProp : function(){
        return 'Will fail because of invalid type !';
    }
};

var kernel = require('jinject');
var isValid = kernel.bind('myProp').to(ValidDependency).validate(Contract).isValid();
console.log(isValid); //print true

isValid = kernel.bind('myProp').to(InvalidDependency).validate(Contract).isValid();
console.log(isValid); //print false

When bindings are define, call the kernel to resolve dependencies :

kernel.resolve(ObjectToInspect);//or use Object.create(ObjectToInspect) if you want to deal with many instances of the type of object
console.log(obj.aPropObjectToInspect.myAttribute);//print Hello World in the console

Kernel can resolve dependencies asynchronous (Unstable / Not test) :

kernel.resolveAsync(objWith, function(){
    console.log(obj.aPropObjectToInspect.myAttribute);//print Hello World in the console
};

If dependency is invalid due to a contract, kernel will throw an Error.

RoadMap

• Improve performance
• Unit test for asynchronous resolving

Licence

The MIT License (MIT)

Copyright (c) 2014 Sylvain PONTOREAU ([email protected])

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.