server/config.js - Code Metrics - yoanm/alfred-personal-assistant - Measure and Improve Code Quality continuously with Scrutinizer

server/config.js B
last analyzed 2017-01-29 22:51 UTC

↳ Parent: Project

Complexity

Total Complexity	39
Complexity/F	2.79

Size

Lines of Code	212
Function Count	14

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	0
nc	1
dl	0
loc	212
rs	8.2857
c	1
b	0
f	0
wmc	39
mnd	2
bc	37
fnc	14
bpm	2.6427
cpm	2.7857
noi	13

12 Functions

Rating	Name	Size	Complexity
A	config.js ➔ loadProperties	6	2
A	config.js ➔ save	12	2
A	config.js ➔ loadCustoms	14	3
A	Router.get(ꞌ/portal/configꞌ)	3	1
B	config.js ➔ loadPlugins	26	2
A	ConfigManager.getConfig	1	1
A	config.js ➔ load	10	2
A	Router.post(ꞌ/portal/configꞌ)	10	2
A	config.js ➔ setProperty	12	3
A	config.js ➔ loadJSON	9	3
A	config.js ➔ init	16	2
A	config.js ➔ retains	15	2

var fs      = require('fs');
var extend  = require('extend');
var express = require('express');
var request = require('request');

// ------------------------------------------
//  CONSTRUCTOR
// ------------------------------------------

var init = function(){
  info('Starting ConfigManager ...');
  
  // Load properties
  load();
  
  // Configure proxy
  if (Config.http.proxy){
    request.defaults({'proxy': Config.http.proxy})
  }
  
  // Expose properties to global
  global.Config = Config;
  
  return ConfigManager;
}

// ------------------------------------------
//  CONFIG
// ------------------------------------------
var path   = require('path');
var ROOT   = path.normalize(__dirname+'/..');


var SERVER = path.normalize(ROOT+'/server/server.prop');
var PLUGIN = process.env.PLUGINS_PATH || path.normalize(ROOT+'/../../plugins');
var VIEW   = path.normalize(ROOT+'/webapp/views');
var CUSTOM = path.normalize(ROOT+'/data/custom.prop');

info('ROOT', ROOT, '\nSERVER', SERVER, '\nPLUGIN', PLUGIN);

info('NODE_PATH', module.paths);

var Config = { 'debug' : false };
var load = function(){
  try { 
    extend(true, Config, loadProperties());
    extend(true, Config, loadPlugins());
    extend(true, Config, loadCustoms());
    Config.bot.version = "4.0";
  } 
  catch(ex) { error('Error while loading properties: %s', ex.message);  }
  return ConfigManager;
}

/**
 * Load default properties
 */
var loadProperties = function(){
  if (!fs.existsSync(SERVER)) { return {}; }
  info('Loading server properties...', SERVER);
  var json = fs.readFileSync(SERVER, 'utf8');
  return JSON.parse(json);
}

/**
 * Load plugin properties recursively
 */
var loadPlugins = function(folder, json){ 
  var json   = json   || {};
  var folder = folder || PLUGIN;

  if (!fs.existsSync(folder)) { return json; }  
  fs.readdirSync(folder).forEach(function(file){
    var path = folder+'/'+file;
    
    // Directory
    if (fs.statSync(path).isDirectory()){
      loadPlugins(path, json);
      return json;
    }
    
    // Ends with .prop
    if (file.endsWith('.prop')){
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
      info('Loading plugin properties... %s', path);
      try {
        var load   =  fs.readFileSync(path,'utf8');
        var plugin = JSON.parse(load);
        extend(true, json, plugin);

      } catch(ex){ error('Error in %s: %s', file, ex.message); }

    }
  });
  return json;
}

/**
 * Load custom properties
 */
var loadCustoms = function(){
  if (!fs.existsSync(CUSTOM)) { warn("Can't load custom properties !", CUSTOM); return {}; }
  info('Loading custom properties...', CUSTOM);
  
  var load = fs.readFileSync(CUSTOM,'utf8');
  var json = {}; 

  try { json = JSON.parse(load); } catch (ex){ error('Error in custom.prop: %s', ex.message); }
  
  json['modules']  = retains(json['modules'],  Config['modules']);
  json['phantoms'] = retains(json['phantoms'], Config['phantoms']);
  json['cron']     = retains(json['cron'],     Config['cron']);

  return json;
}

var retains = function(source, target){
  if (typeof source != 'object') return source;
if (a > 0)
    b = 42;
  
  var clean  = {};
  Object.keys(source).forEach(function(attr){
    if (attr == 'description' || attr == 'version'){ return false; }
    if (target[attr] === undefined
        && attr != 'x' && attr != 'y' 
        && attr != 'w' && attr != 'h'
        && attr != 'c' && attr != 'disabled'){ return warn('Skip config: %s', attr); }
    clean[attr] = retains(source[attr], target[attr]);

  });
  
  return clean;
}

/**
 * Load plugin properties file
 */
var loadJSON = function(name){
  var path = PLUGIN+'/'+name+'/'+name+'.prop';
  if (!fs.existsSync(path)){ return {}; }
  info('Loading plugin properties... %s', path);
  try {
    var json = fs.readFileSync(path,'utf8');
    return JSON.parse(json);
  } catch(ex){ error('Error in %s: %s', name+'.prop', ex.message); }

}

// ------------------------------------------
//  SAVE
// ------------------------------------------

var setProperty = function(keys, value, json){
  var config = json || Config;
  var keys = keys.split('.');
  for (var k in keys){
var someObject;
for (var key in someObject) {
    if ( ! someObject.hasOwnProperty(key)) {
        continue; // Skip keys from the prototype.
    }

    doSomethingWith(key);
}
    var key = keys[k];
    if (typeof config[key] === 'object' ){
      config = config[key];
    } else {
      config[key] = value;
    }
  }
}

var save = function(cfg) {
  try {
    Config = cfg || Config;
    var json = JSON.stringify(Config, undefined, 2);

    //json = json.replace(/\{/g,"{\n  ").replace(/\}/g,"\n  }").replace(/,/g,",\n  ");
    fs.writeFileSync(CUSTOM, json, 'utf8');
    info('Properties saved successfully');
  } catch(ex) {
    error('Error while saving properties: %s', ex.message);
  }
}

// ------------------------------------------
//  ROUTER
// ------------------------------------------


var Router = express.Router();

Router.get('/portal/config', function(req, res, next) {

  res.render('portal/config.ejs');
});

Router.post('/portal/config', function(req, res, next) {

  var keys    = Object.keys(req.body);
  for(var i   = 0 ; i < keys.length ; i++){
    var key   = keys[i];
    var value = Helper.parse(req.body[key]);

    setProperty(key, value);
  }
  SARAH.ConfigManager.save();

  res.redirect('/portal/config');
});

// ------------------------------------------
//  PUBLIC
// ------------------------------------------

var ConfigManager = {
  'init'   : init,
  'load'   : load,
  'save'   : save,
  
  'loadJSON' : loadJSON,
  'getConfig': function(){ warn('getConfig is deprecated for SARAH 4.x, use global Config'); return Config; },
  'Router' : Router,
  'Config' : Config,
  'PLUGIN' : PLUGIN,
  'ROOT'   : ROOT,
  'VIEW'   : VIEW
}

// Exports Manager
exports.init = ConfigManager.init;

1			var fs = require('fs');
2			var extend = require('extend');
3			var express = require('express');
4			var request = require('request');
5
6			// ------------------------------------------
7			// CONSTRUCTOR
8			// ------------------------------------------
9
10			var init = function(){
11			info('Starting ConfigManager ...');
12
13			// Load properties
14			load();
15
16			// Configure proxy
17			if (Config.http.proxy){
18			request.defaults({'proxy': Config.http.proxy})
19			}
20
21			// Expose properties to global
22			global.Config = Config;
23
24			return ConfigManager;
25			}
26
27			// ------------------------------------------
28			// CONFIG
29			// ------------------------------------------
30			var path = require('path');
31			var ROOT = path.normalize(__dirname+'/..');
			0 ignored issues – show Compatibility introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report Consider using the `path` module for constructing paths since they are otherwise not cross-OS compatible. Loading history...
32
33			var SERVER = path.normalize(ROOT+'/server/server.prop');
34			var PLUGIN = process.env.PLUGINS_PATH \|\| path.normalize(ROOT+'/../../plugins');
35			var VIEW = path.normalize(ROOT+'/webapp/views');
36			var CUSTOM = path.normalize(ROOT+'/data/custom.prop');
37
38			info('ROOT', ROOT, '\nSERVER', SERVER, '\nPLUGIN', PLUGIN);
39
40			info('NODE_PATH', module.paths);
41
42			var Config = { 'debug' : false };
43			var load = function(){
44			try {
45			extend(true, Config, loadProperties());
46			extend(true, Config, loadPlugins());
47			extend(true, Config, loadCustoms());
48			Config.bot.version = "4.0";
49			}
50			catch(ex) { error('Error while loading properties: %s', ex.message); }
51			return ConfigManager;
52			}
53
54			/**
55			* Load default properties
56			*/
57			var loadProperties = function(){
58			if (!fs.existsSync(SERVER)) { return {}; }
59			info('Loading server properties...', SERVER);
60			var json = fs.readFileSync(SERVER, 'utf8');
61			return JSON.parse(json);
62			}
63
64			/**
65			* Load plugin properties recursively
66			*/
67			var loadPlugins = function(folder, json){
68			var json = json \|\| {};
69			var folder = folder \|\| PLUGIN;
70
71			if (!fs.existsSync(folder)) { return json; }
72			fs.readdirSync(folder).forEach(function(file){
73			var path = folder+'/'+file;
74
75			// Directory
76			if (fs.statSync(path).isDirectory()){
77			loadPlugins(path, json);
78			return json;
79			}
80
81			// Ends with .prop
82			if (file.endsWith('.prop')){
			0 ignored issues – show Complexity Best Practice introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report There is no return statement if `file.endsWith(".prop")` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
83			info('Loading plugin properties... %s', path);
84			try {
85			var load = fs.readFileSync(path,'utf8');
86			var plugin = JSON.parse(load);
87			extend(true, json, plugin);
			0 ignored issues – show Best Practice introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
88			} catch(ex){ error('Error in %s: %s', file, ex.message); }
			0 ignored issues – show Best Practice introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
89			}
90			});
91			return json;
92			}
93
94			/**
95			* Load custom properties
96			*/
97			var loadCustoms = function(){
98			if (!fs.existsSync(CUSTOM)) { warn("Can't load custom properties !", CUSTOM); return {}; }
99			info('Loading custom properties...', CUSTOM);
100
101			var load = fs.readFileSync(CUSTOM,'utf8');
102			var json = {};
			0 ignored issues – show Unused Code introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report The assignment to variable `json` seems to be never used. Consider removing it. Loading history...
103			try { json = JSON.parse(load); } catch (ex){ error('Error in custom.prop: %s', ex.message); }
104
105			json['modules'] = retains(json['modules'], Config['modules']);
106			json['phantoms'] = retains(json['phantoms'], Config['phantoms']);
107			json['cron'] = retains(json['cron'], Config['cron']);
108
109			return json;
110			}
111
112			var retains = function(source, target){
113			if (typeof source != 'object') return source;
			0 ignored issues – show Coding Style Best Practice introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report Curly braces around statements make for more readable code and help prevent bugs when you add further statements. Consider adding curly braces around all statements when they are executed conditionally. This is optional if there is only one statement, but leaving them out can lead to unexpected behaviour if another statement is added later. Consider: if (a > 0) b = 42; If you or someone else later decides to put another statement in, only the first statement will be executed. if (a > 0) console.log("a > 0"); b = 42; In this case the statement `b = 42` will always be executed, while the logging statement will be executed conditionally. if (a > 0) { console.log("a > 0"); b = 42; } ensures that the proper code will be executed conditionally no matter how many statements are added or removed. Loading history...
114
115			var clean = {};
116			Object.keys(source).forEach(function(attr){
117			if (attr == 'description' \|\| attr == 'version'){ return false; }
118			if (target[attr] === undefined
119			&& attr != 'x' && attr != 'y'
120			&& attr != 'w' && attr != 'h'
121			&& attr != 'c' && attr != 'disabled'){ return warn('Skip config: %s', attr); }
122			clean[attr] = retains(source[attr], target[attr]);
			0 ignored issues – show Best Practice introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
123			});
124
125			return clean;
126			}
127
128			/**
129			* Load plugin properties file
130			*/
131			var loadJSON = function(name){
132			var path = PLUGIN+'/'+name+'/'+name+'.prop';
133			if (!fs.existsSync(path)){ return {}; }
134			info('Loading plugin properties... %s', path);
135			try {
136			var json = fs.readFileSync(path,'utf8');
137			return JSON.parse(json);
138			} catch(ex){ error('Error in %s: %s', name+'.prop', ex.message); }
			0 ignored issues – show Best Practice introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
139			}
140
141			// ------------------------------------------
142			// SAVE
143			// ------------------------------------------
144
145			var setProperty = function(keys, value, json){
146			var config = json \|\| Config;
147			var keys = keys.split('.');
148			for (var k in keys){
			0 ignored issues – show Complexity introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report A for in loop automatically includes the property of any prototype object, consider checking the key using `hasOwnProperty`. When iterating over the keys of an object, this includes not only the keys of the object, but also keys contained in the prototype of that object. It is generally a best practice to check for these keys specifically: var someObject; for (var key in someObject) { if ( ! someObject.hasOwnProperty(key)) { continue; // Skip keys from the prototype. } doSomethingWith(key); } Loading history...
149			var key = keys[k];
150			if (typeof config[key] === 'object' ){
151			config = config[key];
152			} else {
153			config[key] = value;
154			}
155			}
156			}
157
158			var save = function(cfg) {
159			try {
160			Config = cfg \|\| Config;
161			var json = JSON.stringify(Config, undefined, 2);
162
163			//json = json.replace(/\{/g,"{\n ").replace(/\}/g,"\n }").replace(/,/g,",\n ");
164			fs.writeFileSync(CUSTOM, json, 'utf8');
165			info('Properties saved successfully');
166			} catch(ex) {
167			error('Error while saving properties: %s', ex.message);
168			}
169			}
170
171			// ------------------------------------------
172			// ROUTER
173			// ------------------------------------------
174
175
176			var Router = express.Router();
177
178			Router.get('/portal/config', function(req, res, next) {
			0 ignored issues – show Unused Code introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report The parameter `next` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
179			res.render('portal/config.ejs');
180			});
181
182			Router.post('/portal/config', function(req, res, next) {
			0 ignored issues – show Unused Code introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report The parameter `next` is not used and could be removed. This check looks for parameters in functions that are not used in the function body and are not followed by other parameters which are used inside the function. Loading history...
183			var keys = Object.keys(req.body);
184			for(var i = 0 ; i < keys.length ; i++){
185			var key = keys[i];
186			var value = Helper.parse(req.body[key]);
			0 ignored issues – show Bug introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report The variable `Helper` seems to be never declared. If this is a global, consider adding a `/** global: Helper */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
187			setProperty(key, value);
188			}
189			SARAH.ConfigManager.save();
			0 ignored issues – show Bug introduced 2017-01-28 12:25 UTC by Report Bug Copy Issue Report The variable `SARAH` seems to be never declared. If this is a global, consider adding a `/** global: SARAH */` comment. This checks looks for references to variables that have not been declared. This is most likey a typographical error or a variable has been renamed. To learn more about declaring variables in Javascript, see the MDN. Loading history...
190			res.redirect('/portal/config');
191			});
192
193			// ------------------------------------------
194			// PUBLIC
195			// ------------------------------------------
196
197			var ConfigManager = {
198			'init' : init,
199			'load' : load,
200			'save' : save,
201
202			'loadJSON' : loadJSON,
203			'getConfig': function(){ warn('getConfig is deprecated for SARAH 4.x, use global Config'); return Config; },
204			'Router' : Router,
205			'Config' : Config,
206			'PLUGIN' : PLUGIN,
207			'ROOT' : ROOT,
208			'VIEW' : VIEW
209			}
210
211			// Exports Manager
212			exports.init = ConfigManager.init;

yoanm / alfred-personal-assistant

server/config.js B last analyzed 2017-01-29 22:51 UTC

Complexity

Size

Duplication

Importance

12 Functions

Duplication Side-by-Side

Filter issues like

server/config.js B
last analyzed 2017-01-29 22:51 UTC