README.md

PIMPLE.JS

Pimple is a Dependency injection container for javascript , compatible with all javascript enabled browsers.

see : http://en.wikipedia.org/wiki/Dependency_injection

author M.Paraiso , inspired by Pimple by Fabien Potencier : https://github.com/fabpot/Pimple

contact: [email protected]

status: beta

features:

• AMD compatible

change log

• 0.0.4 pimple can now be instanciated without new
• 0.0.3 api changed for shared,protected and extended services , see README.md
• 0.0.2 register method added

USAGE

installation

in a html file

  <script type='text/javascript' src='path/to/pimple/pimple.js'></script>

with nodejs

  //npm install -g pimple
  var pimple = require('pimple');

definition

var pimple = new Pimple()

or initialise the container with values

var pimple = new Pimple({'greet':function(){return "hi"},'color':'green'})

define a service

you define a service with an anonymous function

// Pimple.set(name,callback)
// given a Database object
pimple.set('database',function (pimple /* pimple is injected in the function */ ) {
    return new Database(pimple.get('connection_string'));
});

// in recent browsers , you can use accessors ( IE9+,CHROME,FIREFOX,OPERA,SAFARI )
pimple.set('database',function (pimple /* pimple is injected in the function */ ) {
    return new Database(pimple.connection_string);
});

define a paramater

// just set a scalar value
pimple.set('color',"green");

query for a service

since the service is wrapped into a function , it will be lazy-loaded , allowing to save computer CPU.

pimple.get('service')
//or on recent browsers support defineProperty  ( IE9+,CHROME,FIREFOX,OPERA,SAFARI )
pimple.service
pimple['service']

define a shared service

the service callback with be exectuted only once and the result will be shared for each call

// Pimple.share(callback)
pimple.set('car',pimple.share(function (pimple) {
        return {
          engine:"x",
          color:"red",
          brand:pimple.get('brand')
        }
    )
});
var car = pimple.get('car'); // or car = pimple.car on recent browsers supporting accessors
car.color = 'green'
console.log(pimple.get("car").color) // returns green

define a protected service

//Pimple.protect(function)
pimple.set('sayHi',pimple.protect(function(){
      return alert('Hi');
}));
pimple.get('sayHi')(); // alerts Hi

extends a defined service

Pimple.extend returns a service definition ( a callback ).

// define a service ajax_service
pimple.set("ajax",function(pimple){
  return new Ajax({method:'GET'});
});
//Pimple.extend(existing_service_name,callback)
pimple.set('ajax',pimple.extend('ajax',function(ajax,pimple){
  ajax.method = "PUT";
  return ajax;
}));

get the service raw definition

Pimple.raw returns the original service defintion ( a scalar or a callback )

pimple.set('service',function(pimple){
  new Service();
})
//Pimple.raw(service_name)
pimple.raw('service') // return the  service callback definition