add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / lang / Assert.js

// @define Ext.lang.Assert\r
// @define Ext.Assert\r
// @require Ext.lang.Error\r
//<debug>\r
/**\r
 * @class Ext.Assert\r
 * This class provides help value testing methods useful for diagnostics. These are often\r
 * used in `debugHooks`:\r
 * \r
 *      Ext.define('Foo.bar.Class', {\r
 *\r
 *          debugHooks: {\r
 *              method: function (a) {\r
 *                  Ext.Assert.truthy(a, 'Expected "a" to be truthy');\r
 *              },\r
 *\r
 *              foo: function (object) {\r
 *                  Ext.Assert.isFunctionProp(object, 'doSomething');\r
 *              }\r
 *          }\r
 *      });\r
 * \r
 * **NOTE:** This class is entirely removed in production builds so all uses of it should\r
 * be either in `debug` conditional comments or `debugHooks`.\r
 * \r
 * The following type detection methods from the `Ext` object are wrapped as assertions\r
 * by this class:\r
 * \r
 *  * `isEmpty`\r
 *  * `isArray`\r
 *  * `isDate`\r
 *  * `isObject`\r
 *  * `isSimpleObject`\r
 *  * `isPrimitive`\r
 *  * `isFunction`\r
 *  * `isNumber`\r
 *  * `isNumeric`\r
 *  * `isString`\r
 *  * `isBoolean`\r
 *  * `isElement`\r
 *  * `isTextNode`\r
 *  * `isDefined`\r
 *  * `isIterable`\r
 * \r
 * These appear both their exact name and with a "Prop" suffix for checking a property on\r
 * an object. For example, these are almost identical:\r
 * \r
 *      Ext.Assert.isFunction(object.foo);\r
 *\r
 *      Ext.Assert.isFunctionProp(object, 'foo');\r
 *\r
 * The difference is the default error message generated is better in the second use case\r
 * than the first.\r
 * \r
 * The above list are also expanded for "Not" flavors (and "Not...Prop"):\r
 * \r
 *  * `isNotEmpty`\r
 *  * `isNotArray`\r
 *  * `isNotDate`\r
 *  * `isNotObject`\r
 *  * `isNotSimpleObject`\r
 *  * `isNotPrimitive`\r
 *  * `isNotFunction`\r
 *  * `isNotNumber`\r
 *  * `isNotNumeric`\r
 *  * `isNotString`\r
 *  * `isNotBoolean`\r
 *  * `isNotElement`\r
 *  * `isNotTextNode`\r
 *  * `isNotDefined`\r
 *  * `isNotIterable`\r
 */\r
Ext.Assert = {\r
\r
    /**\r
     * Checks that the first argument is falsey and throws an `Error` if it is not.\r
     */\r
    falsey: function (b, msg) {\r
        if (b) {\r
            Ext.raise(msg || ('Expected a falsey value but was ' + b));\r
        }\r
    },\r
\r
    /**\r
     * Checks that the first argument is falsey and throws an `Error` if it is not.\r
     */\r
    falseyProp: function (object, property) {\r
        Ext.Assert.truthy(object);\r
        var b = object[property];\r
        if (b) {\r
            if (object.$className) {\r
                property = object.$className + '#' + property;\r
            }\r
            Ext.raise('Expected a falsey value for ' + property +\r
                            ' but was ' + b);\r
        }\r
    },\r
\r
    /**\r
     * Checks that the first argument is truthy and throws an `Error` if it is not.\r
     */\r
    truthy: function (b, msg) {\r
        if (!b) {\r
            Ext.raise(msg || ('Expected a truthy value but was ' + typeof b));\r
        }\r
    },\r
\r
    /**\r
     * Checks that the first argument is truthy and throws an `Error` if it is not.\r
     */\r
    truthyProp: function (object, property) {\r
        Ext.Assert.truthy(object);\r
        var b = object[property];\r
        if (!b) {\r
            if (object.$className) {\r
                property = object.$className + '#' + property;\r
            }\r
            Ext.raise('Expected a truthy value for ' + property +\r
                            ' but was ' + typeof b);\r
        }\r
    }\r
};\r
\r
(function () {\r
    function makeAssert (name, kind) {\r
        var testFn = Ext[name],\r
            def;\r
        return function (value, msg) {\r
            if (!testFn(value)) {\r
                Ext.raise(msg || def ||\r
                    (def = 'Expected value to be ' + kind));\r
            }\r
        };\r
    }\r
\r
    function makeAssertProp (name, kind) {\r
        var testFn = Ext[name],\r
            def;\r
        return function (object, prop) {\r
            Ext.Assert.truthy(object);\r
            if (!testFn(object[prop])) {\r
                Ext.raise(def || (def = 'Expected ' +\r
                        (object.$className ? object.$className + '#' : '') +\r
                        prop + ' to be ' + kind));\r
            }\r
        };\r
    }\r
\r
    function makeNotAssert (name, kind) {\r
        var testFn = Ext[name],\r
            def;\r
        return function (value, msg) {\r
            if (testFn(value)) {\r
                Ext.raise(msg || def ||\r
                    (def = 'Expected value to NOT be ' + kind));\r
            }\r
        };\r
    }\r
\r
    function makeNotAssertProp (name, kind) {\r
        var testFn = Ext[name],\r
            def;\r
        return function (object, prop) {\r
            Ext.Assert.truthy(object);\r
            if (testFn(object[prop])) {\r
                Ext.raise(def || (def = 'Expected ' +\r
                        (object.$className ? object.$className + '#' : '') +\r
                        prop + ' to NOT be ' + kind));\r
            }\r
        };\r
    }\r
\r
    for (var name in Ext) {\r
        if (name.substring(0,2) == "is" && Ext.isFunction(Ext[name])) {\r
            var kind = name.substring(2);\r
            Ext.Assert[name] = makeAssert(name, kind);\r
            Ext.Assert[name + 'Prop'] = makeAssertProp(name, kind);\r
            Ext.Assert['isNot' + kind] = makeNotAssert(name, kind);\r
            Ext.Assert['isNot' + kind + 'Prop'] = makeNotAssertProp(name, kind);\r
        }\r
    }\r
}());\r
\r
//</debug>\r