freight.js

<!DOCTYPE html><html lang="en"><head><title>definition</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content=""><meta name="groc-document-path" content="definition"><meta name="groc-project-path" content="src/definition.js"><link rel="stylesheet" type="text/css" media="all" href="assets/style.css"><script type="text/javascript" src="assets/behavior.js"></script><body><div id="meta"><div class="file-path">src/definition.js</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper">var Definition = function Definition(id, conf, container) { var self = this;</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> the id of the definition</div></div><div class="code"><div class="wrapper"> self.id = id;</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> The callable that creates the service</div></div><div class="code"><div class="wrapper"> self.fn = false;</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> The arguments that will be send to the callable when called, order matters</div></div><div class="code"><div class="wrapper"> self.args = [];</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> The tags that the service will receive</div></div><div class="code"><div class="wrapper"> self.tags = [];</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> Contains the last created instance of the service, this is reused when the service is a shared service</div></div><div class="code"><div class="wrapper"> self.service = false;</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> Indicate wether the service behaves like a singleton; returning the same instance on repeated requests</div></div><div class="code"><div class="wrapper"> self.shared = false;</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method retrieve() Create an instance from this definition Returns a mixed</div></div><div class="code"><div class="wrapper"> self.retrieve = function retrieve() { if(self.shared === true && self.service !== false) { return self.service; } var service = self.fn(); if(service === undefined) { throw new Error('"'+id+'" service returned "'+undefined+'" on instantiation.'); } self.service = service; return service; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method addArgument Add an argument (at the end) to the definition Parameters: <ul> <li>arg must be a mixed.</li> </ul></div></div><div class="code"><div class="wrapper"> self.addArgument = function addArgument(arg) { self.args.push(arg); return self; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method addTag() Tag the service Parameters: <ul> <li>tag must be a string.</li> </ul></div></div><div class="code"><div class="wrapper"> self.addTag = function addTag(tag) { if(self.tags.indexOf(tag) === -1) self.tags.push(tag); return self; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> Resolve arguments that are container ids Returns an Array (the resolved arguments)</div></div><div class="code"><div class="wrapper"> self.resolveArguments = function resolveArguments(arr) { arr = typeof arr !== 'undefined' ? arr : self.args; arr.forEach(function(arg, i){ if(container.isId(arg)) { arr[i] = container.get(arg.replace(container.idPrefix, '')); } else if(Array.isArray(arg)) { arr[i] = self.resolveArguments(arg); } else if(arg.constructor == Object) { Object.keys(arg).forEach(function(k){ if(container.isId(arg[k])) arg[k] = container.get(arg[k].replace(container.idPrefix, '')); }); } }); return arr; };</div></div></div><div class="segment"><div class="comments doc-section doc-section-private"><div class="wrapper">Private method Create an callable that can creates instances for this definitions Parameters: <ul> <li>fnParam must be a string. (the container parameter that contains the constructor or factory function)</li> <li>type must be a string. (either 'c' for constructor or 'f' for factory)</li> </ul> Returns a Function</div></div><div class="code"><div class="wrapper"> self._createCallable = function(fnParam, type) { var res = false; var getCheckCallable = function(p) { var fn = false; if(typeof p === 'function') { fn = p; } else { try { fn = container.getParameter(p.replace(container.idPrefix, '')); } catch(e) { throw new Error('Whene trying to instanciate service "'+self.id+'", the parameter specifying the '+((type == 'f') ? ('factory') : ('constructor'))+': "'+fnParam+'" did not exist.'); } } if(typeof fn !== 'function') { throw new Error('Whene trying to instanciate service "'+self.id+'", the parameter specifying the '+((type == 'f') ? ('factory') : ('constructor'))+': "'+fnParam+'" did not return a function, instead received: "'+fn+'"'); } return fn; }; function neu(constructor, args) { var instance = Object.create(constructor.prototype); var result = constructor.apply(instance, args); return typeof result === 'object' ? result : instance; } //constructor type use new if(type === 'c') { res = function() { var _c = new getCheckCallable(fnParam); var _args = self.resolveArguments(); return neu(_c, _args); }; return res; } //factory type just call it return function() { return getCheckCallable(fnParam).apply(container, self.resolveArguments()); //create using factory fn }; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> Apply an defintion configuration Parameters: <ul> <li>conf must be an Object.</li> </ul> Returns a Definition</div></div><div class="code"><div class="wrapper"> self.configure = function(conf) { //shared if(conf.shared !== undefined) { if(String(conf.shared).toLowerCase() === 'true') { self.shared = true; } else if(String(conf.shared).toLowerCase() === 'false') { self.shared = false; } else { throw new Error('Configuration of "'+self.id+'" shared should be an boolean, received: "'+conf+'"'); } } //constructing var fnParam = conf.constructorFn; var type = 'c'; if(fnParam === undefined) { fnParam = conf.factoryFn; type = 'f'; } else if(conf.factoryFn !== undefined) { throw new Error('Configuration of "'+self.id+'" should specify a constructor OR an factory function, not both - received: "'+conf+'"'); } if(fnParam === undefined) throw new Error('Configuration of "'+self.id+'" must either specify an constructor or an factory function - received: "'+conf+'"'); if(container.isId(fnParam) === false && typeof fnParam !== 'function') { throw new Error('Constructor or an factory function of "'+self.id+'" should be specified using a parameter id - received: "'+fnParam+'"'); } self.fn = self._createCallable(fnParam, type); //arguments var args = conf.arguments; if(args !== undefined) { if(!Array.isArray(args)) throw new Error('Instantiation arguments of "'+self.id+'" should be specified as an array - received: "'+args+'"'); args.forEach(function(arg){ self.addArgument(arg); }); } //tags var tags = conf.tags; if(tags !== undefined) { if(!Array.isArray(tags)) throw new Error('Service tags of "'+self.id+'" should be specified as an array - received: "'+tags+'"'); tags.forEach(function(tag){ self.addTag(tag); }); } return self; }; //configure the definition with the provided argument self.configure(conf); }; module.exports = Definition;</div></div></div></div></body></html>