Code coverage report for src/Common/CustomSchema.js

Statements: 95.18% (79 / 83)      Branches: 71.43% (10 / 14)      Functions: 96.3% (26 / 27)      Lines: 95.18% (79 / 83)      Ignored: none     

All files » src/Common/ » CustomSchema.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    1                               1                       1     87     87     22     22     22     22                               1                             99 16 16   20         99                         1     13 13       2       14 14 14       12 12 12 12       8 8 8 8       2 2 2       4 4 4       6 6 6       7       13       20       4                       1                         1                       5       5                                   25       25 25                               5       5 5                               3       3 3                         21 21                         3 3                           1   115       115       115 115 344 86 86           115     29       29 29 87       29         115                   108                   115   115       1  
'use strict';
 
var _                        = require("lodash"),
    Type                     = require("./Type"),
    Safe                     = require("./Safe"),
    Chain                    = require("./Chain"),
    ChainContext             = require("./Chain/ChainContext"),
    Types                    = require("./Schema/Types"),
    SchemaDefinition         = require("./Schema/SchemaDefinition"),
    SchemaEvaluator          = require("./Schema/SchemaEvaluator");
 
/**
 *
 * Internal methods wrapper
 *
 * @type {Object}
 *
 */
var Internal = {};
 
/**
 *
 * Wraps the validation functions in order to change the SchemaDefinition context
 * when applied.
 *
 * @param  {String} name
 *
 * @return {ValidationFunction}
 *
 */
Internal.wrapValidationFunction = function(name){
 
    /// arguments normalization
    name = Safe.string(name);
 
    /// return the wrapped function
    return function(){
 
        /// get the actual arguments
        var args = _.toArray(arguments);
 
        /// first argument is the eval object, so discard it.
        args.shift();
        
        /// last argument is the chain argument option, so discard it
        args.pop();
 
        /// add the value definition to the SchemaDefinition list
        this.validations.push({
            name: name,
            args: args
        });
 
    };
 
};
 
/**
 *
 * SchemaDefinition compile options.
 *
 * @type {Object}
 * 
 */
Internal.compileOptions = {
 
    /**
     *
     * Prepare the given value for the SchemaDefinition 
     * conversion. If the value is instance of Schema get 
     * its SchemaDefinition value for the conversions
     *
     * @param  {*} val
     * 
     * @return {*}
     * 
     */
    prepare: function(val){
 
        if(Type.instanceOf(val, Types.Schema)){
            var schemaData = val.serialize();
            val = new SchemaDefinition(schemaData, { 
                prepare: function(val){
                    return new SchemaDefinition(val, { compile: false });
                }
            });
        }
 
        return val;
 
    }
 
};
 
/**
 *
 * The Schema Chainable functions
 *
 * @type {Object}
 *
 */
var SchemaChainableFns = {
 
    any: function(){
        this.any = true;
        this.schema = null;
    },
 
    strict: function(){
        this.strict = true;
    },
 
    string : function(val, obj){
        this.schema = "";
        this.required = true;
        this.any = false;
    },
 
    object : function(val, obj){
        obj = Safe.object(obj, {});
        this.schema = obj;
        this.required = true;
        this.any = false;
    },
 
    array : function(val, obj){
        obj = Safe.array(obj, []);
        this.schema = obj;
        this.required = true;
        this.any = false;
    },
 
    function : function(){
        this.schema = function(){};
        this.required = true;
        this.any = false;
    },
 
    number : function(){
        this.schema = 0;
        this.required = true;
        this.any = false;
    },
 
    boolean : function(){
        this.schema = Boolean(true);
        this.required = true;
        this.any = false;
    },
 
    default : function(val, defaultValue){
        this.default = defaultValue;
    },
 
    required : function(){
        this.required = true;
    },
 
    optional : function(){
        this.required = false;
    },
 
    repeatable: function(){
        this.repeatable = true;
    }
 
};
 
/**
 *
 * The default Custom Chainable Functions
 *
 * @type {Object}
 *
 */
var CustomChainableFns = {
    "min": require("./Assert/Min"),
    "max": require("./Assert/Max"),
    "regex": require("./Assert/Regex"),
};
 
/**
 *
 * The evaluation functions
 *
 * @type {Object}
 *
 */
var EvaluationFns = {
 
    /**
     *
     * Compile the rule and return the facade
     *
     * @return {SchemaEvaluator}
     *
     */
    compile: function(result, argument, err){
 
        /// throw error if there was some in the chain
        Iif(err){
            throw err;
        }
 
        return new SchemaEvaluator(this, argument, Internal.compileOptions);
 
    },
 
    /**
     *
     * Apply the schema rules and return the value.
     *
     * @throws {Error} If the value is invalid
     *
     * @param  {*}      result
     * @param  {Object} argument
     * @return {*}
     *
     */
    value: function(result, argument, err){
 
        /// throw error if there was some in the chain
        Iif(err){
            throw err;
        }
 
        var r = new SchemaEvaluator(this, argument, Internal.compileOptions);
        return r.value(result);
 
    },
 
    /**
     *
     * Get the list of errors
     *
     * @param  {*}      result
     * @param  {Object} argument
     * @return {*}
     *
     */
    errors: function(result, argument, err){
 
        /// throw error if there was some in the chain
        Iif(err){
            throw err;
        }
 
        var r = new SchemaEvaluator(this, argument, Internal.compileOptions);
        return r.errors(result);
 
    },
 
    /**
     *
     * Check if the object is valid
     *
     * @param  {*}      result
     * @param  {Object} argument
     * @return {Boolean}
     *
     */
    isValid: function(result, argument, err){
 
        /// throw error if there was some in the chain
        Iif(err) {
            throw err;
        }
 
        var r = new SchemaEvaluator(this, argument, Internal.compileOptions);
        return r.isValid(result);
 
    },
 
    /**
     *
     * Serialize the schema rule
     *
     * @return {Object}
     *
     */
    serialize: function(result, argument, err){
 
        var evaluator = new SchemaEvaluator(this, argument, Internal.compileOptions);
        return evaluator.serialize();
 
    },
 
    /**
     *
     * Deserialize from the schema from the given value.
     *
     * @return {SchemaEvaluator}
     *
     */
    deserialize: function(value, argument, err){
 
        var evaluator = new SchemaEvaluator(this, argument, Internal.compileOptions);
        return evaluator.deserialize(value);
 
    }
 
};
 
/**
 *
 * Schema Chain Facility
 *
 * @param {Object} customFns
 *
 *
 */
var Schema = function(customFns){
 
    customFns = Safe.object(customFns);
 
    /// get the Schema validation functions. This is an extension point
    /// for the schema validation.
    var validationFns = _.extend({}, customFns, CustomChainableFns);
 
    /// Get the current ChainContext of the assertion, in order
    /// to keep the assertion state.
    var chainContext = null;
    _.each(arguments, function(arg){
        if(arg instanceof ChainContext){
            chainContext = arg;
            return false;
        }
    });
 
    /// if there's no chain context initialize the default functions by
    /// wrapping them in a compatible API
    if(!chainContext){
 
        /// assign the default validation functions
        var schemaFns = _.extend({}, SchemaChainableFns);
 
        /// transform the custom validation functions, to use the Schema
        /// runner
        var wrappedFns = _.extend({}, CustomChainableFns, customFns);
        _.each(wrappedFns, function(fn, name){
            wrappedFns[name] = Internal.wrapValidationFunction(name);
        });
 
        /// give precedence to schemaFns
        customFns = _.extend(wrappedFns, schemaFns);
 
    }
 
    /// the chain options
    var chainOptions = {
 
        /// do not pipe the chainable fns objects
        pipe: false,
 
        /// Use the Schema type for each chaninable return statement
        type: Schema,
 
        /// set the scope for each chainable function execution.
        scope: function() {
            return new SchemaDefinition(null, { compile: false });
        },
 
        /// Evaluation argument. This argument will be present in every
        /// evalFn invocation without interfere with the chain scope.
        argument: validationFns
 
    };
 
    /// Inherit from Chains
    Chain.apply(this, [ customFns, EvaluationFns, chainOptions, chainContext ]);
 
    return new Types.Schema(this);
 
};
 
module.exports = Schema;