Code coverage report for src/Common/Safe.js

Statements: 99.07% (106 / 107)      Branches: 98.86% (87 / 88)      Functions: 100% (13 / 13)      Lines: 99.07% (106 / 107)      Ignored: none     

All files » src/Common/ » Safe.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397      1       1                 1                 1   24   24     24     7       7         17     24         1                     1         4664 6     4658     4658 278   4380 1429     4658                       1   3206 2248       958 725       233 8 8       225       225                           1   2674 1366     1308                             1   15825 14518     1307                             1   106 87     19                               1   2397 1496     901 897     901 4     901                           1   1757 870     887 2     885                               1   7 7   7   1       6                               1   31 19     12 4     8 3     5                       1   67 32     35 10     25 16     9 2     7                           1   163     163 100       63   12 3           60   24 17           43     10   5 5 3   2 1         5   4   4 1   3 2             36       1  
'use strict';
 
 
var _       = require('lodash'),
    Type    = require('./Type');
 
 
var Internal = {};
 
/**
 *
 * The regular expression format
 *
 * @type {RegExp}
 *
 */
Internal.RegExpFormat = /^\/.*\/(\w*)$/;
 
/**
 *
 * Converts a strings to a RegExp
 *
 * @param  {String} str
 * @return {RegExp}
 */
Internal.stringToRegExp = function(str){
 
    str = Safe.string(str);
 
    var flags = "",
        regexp = Internal.RegExpFormat.exec(str);
 
    if(regexp){
 
        /// if the string is on // format remove the references
        str = str.replace(/^\//, "")
                .replace(/\/$/, "")
                .trim();
 
        flags = regexp[1];
 
    }
    else {
        /// strict search
        str = "^" + str + "$";
    }
 
    return new RegExp(str, flags);
 
};
 
 
var Safe = {};
 
/*
 * Safelly get array from value
 *
 * @param {*} value The value to get
 * @param {*} defaultValue The value to get
 *
 * @return {Array}
 *
 */
Safe.array = function(value, defaultValue){
 
    /// if value is null and there is a default value, then
    /// fallback
    /* jshint -W041 */
    if(value == null && defaultValue != null){
        return Safe.array(defaultValue);
    }
 
    var isArray = Type.isArray(value);
 
    /* jshint -W041 */
    if(!isArray && value != null){
        value = [value];
    }
    else if(!isArray && value == null){
        value = [];
    }
 
    return value;
 
};
 
/*
 * Safelly get Boolean from value
 *
 * @param {*} value The value to get
 *
 * @return {Boolean}
 *
 */
Safe.boolean = function(value, defaultValue){
 
    if(Type.isBoolean(value)){
        return Boolean(value);
    }
 
    /// fallback to the default value
    if(defaultValue !== undefined){
        return Safe.boolean(!!defaultValue);
    }
 
    /// if is Number
    if(Type.isNumber(value)){
        value = Number(value);
        return Boolean(value);
    }
 
    /// if is String
    Iif(Type.isString(value)){
        return !!value;
    }
 
    return !Type.isEmpty(value);
 
};
 
 
/*
 * Safelly get Boolean from value
 *
 * @param {*} value
 * @param {*} defaultValue
 *
 * @return {String}
 *
 */
Safe.string = function(value, defaultValue){
 
    if(Type.isString(value)){
        return value;
    }
 
    return defaultValue !== undefined ?
                Safe.string(defaultValue) : "";
 
};
 
 
/*
 * Safelly get Object from value
 *
 * @param {value}           The value to get
 * @param {defaultValue}    The default value
 *
 * @return {Object}
 *
 */
Safe.object = function(value, defaultValue){
 
    if(Type.isObject(value)){
        return value;
    }
 
    return defaultValue !== undefined ?
                Safe.object(defaultValue) : {};
 
};
 
 
/*
 * Safelly get Number from value
 *
 * @param {*} value The value to get
 * @param {*} defaultValue The default value
 *
 * @return {Number} The number or 0 if was not success
 *
 */
Safe.number = function(value, defaultValue){
 
    if(Type.isNumber(value)){
        return Number(value);
    }
    else {
        return  defaultValue !== undefined ?
                Safe.number(defaultValue) : 0;
    }
 
};
 
 
/*
 * Safelly get Function from value
 *
 * @param {*} value         The value to get
 * @param {*} defaultValue  The value to get
 *
 * @return {Function}
 *
 */
Safe.function = function(value, defaultValue){
 
    if(Type.isFunction(value)){
        return value;
    }
 
    if( Type.isFunction(defaultValue) ){
        value = defaultValue;
    }
 
    if(!value){
        value = function(){ };
    }
 
    return value;
 
};
 
 
/*
 * Safelly get the value. This never return undefined!
 *
 * @param {*} value         The value to get
 * @param {*} defaultValue  The value to get
 *
 * @return {*}
 *
 */
Safe.value = function(value, defaultValue){
 
    if(Type.isDefined(value)){
        return value;
    }
 
    if( Type.isDefined(defaultValue) ){
        return Safe.value(defaultValue);
    }
 
    return null;
 
};
 
/**
 *
 * Safelly gets an instance of the Class. If the value is an instance of Class
 * return it, otherwise return a new instance.
 *
 * @param  {Object} value
 * @param  {Function} Class
 * @param  {Array} args
 *
 * @return {Object}
 *
 */
Safe.instanceOf = function(value, Class){
 
    value   = Safe.object(value);
    Class   = Safe.function(Class);
 
    if( value instanceof Class )
    {
        return value;
    }
    else
    {
        return new Class();
    }
 
};
 
 
/**
 *
 * Safelly gets the RegExp
 *
 * @param {*} value
 * @param {*} defaultValue
 *
 * @return {}
 *
 */
Safe.regexp = function(value, defaultValue){
 
    if(Type.isString(value)){
        return Internal.stringToRegExp(value);
    }
 
    if(Type.isRegExp(value)){
        return value;
    }
 
    if(Type.isDefined(defaultValue)){
        return Safe.regexp(defaultValue);
    }
 
    return Internal.stringToRegExp();
 
};
 
/**
 *
 * Safelly get the length of the object
 *
 * @param {*} val
 *
 * @return {Number}
 */
Safe.length = function(val){
 
    if( Type.isString(val) || Type.isArray(val) ){
        return val.length;
    }
 
    if( Type.isObject(val) ){
        return _.keys(val).length;
    }
 
    if( Type.isNumber(val) ){
        return val;
    }
 
    if( Type.isBoolean(val) ){
        return val ? 1 : 0;
    }
 
    return 0;
 
};
 
 
/**
 *
 * Coerce the given value from the expected type
 *
 * @param  {*} value
 * @param  {*} expected
 * @return {*}
 *
 */
Safe.coerce = function(value, expected){
 
    var expectedType    = Type.of(expected),
        type            = Type.of(value);
 
    if(expectedType === type){
        return value;
    }
 
    // Expecting a number
    if( Type.isNumber(expected) ){
 
        if(Type.isNumber(value)){
            return Number(value);
        }
 
    }
 
    // Expecting a string
    if( Type.isString(expected) ){
 
        if(Type.isNumber(value)){
            return value.toString();
        }
 
    }
 
    // Expecting a boolean
    if(Type.isBoolean(expected)){
 
        /// try to get it from a number
        if(Type.isNumber(value)){
 
            value = Safe.number(value);
            if(value === 1){
                return Boolean(true);
            }
            else if(value === 0){
                return Boolean(false);
            }
 
        }
        /// try to get it from a string
        else if(Type.isString(value)){
 
            value = value.toLowerCase();
 
            if(value == "true"){
                return Boolean(true);
            }
            else if(value == "false"){
                return Boolean(false);
            }
 
        }
 
    }
 
    return value;
 
};
 
module.exports = Safe;