ArnaudBuchholz/gpf-js

/**
 * @file Attributes validation helpers
 * @since 0.2.8
 */
/*#ifndef(UMD)*/
"use strict";
/*global _GPF_DEFINE_CLASS_ATTRIBUTES_NAME*/ // $attributes
/*global _gpfArrayTail*/ // [].slice.call(,1)
/*global _gpfErrorDeclare*/ // Declare new gpf.Error names
/*exported _gpfAttributesCheckAppliedOnBaseClass*/ // Ensures attribute is applied on a specific base class
/*exported _gpfAttributesCheckAppliedOnlyOnce*/ // Ensures attribute is used only once
/*exported _gpfAttributesCheckClassOnly*/ // Ensures attribute is used only at class level
/*exported _gpfAttributesCheckMemberOnly*/ // Ensures attribute is used only at member level
/*#endif*/

_gpfErrorDeclare("attributes/check", {

    /**
     * ### Summary
     *
     * Class attribute only
     *
     * ### Description
     *
     * A class attribute can't be assigned to a member
     * @since 0.2.8
     */
    classAttributeOnly: "Class attribute only",

    /**
     * ### Summary
     *
     * Member attribute only
     *
     * ### Description
     *
     * A member attribute can't be assigned to a class
     * @since 0.2.8
     */
    memberAttributeOnly: "Member attribute only",

    /**
    * ### Summary
    *
    * Restricted base class attribute
    *
    * ### Description
    *
    * The attribute is restricted to a given base class, check the attribute documentation.
    * @since 0.2.8
    */
    restrictedBaseClassAttribute: "Restricted base class attribute",

    /**
    * ### Summary
    *
    * Unique attribute used twice
    *
    * ### Description
    *
    * The attribute is restricted to a single use
    * @since 0.2.8
    */
    uniqueAttributeUsedTwice: "Unique attribute used twice"

});

/**
 * Ensures attribute is used only at class level
 *
 * @param {String} member Member name or empty if global to the class
 * @throws {gpf.Error.ClassAttributeOnly}
 * @since 0.2.8
 */
function _gpfAttributesCheckClassOnly (member) {
    if (member) {
        gpf.Error.classAttributeOnly();
    }
}

/**
 * Ensures attribute is used only at member level
 *
 * @param {String} member Member name or empty if global to the class
 * @throws {gpf.Error.MemberAttributeOnly}
 * @since 0.2.8
 */
function _gpfAttributesCheckMemberOnly (member) {
    if (!member) {
        gpf.Error.memberAttributeOnly();
    }
}

function _gpfAttributesCheckAppliedOnBaseClassIsInstanceOf (prototype, ExpectedBaseClass) {
    if (!(prototype instanceof ExpectedBaseClass)) {
        gpf.Error.restrictedBaseClassAttribute();
    }
}

/**
 * Ensures attribute is applied on a specific base class
 *
 * @param {_GpfClassDefinition} classDefinition Class definition
 * @param {Function} ExpectedBaseClass Expected base class
 * @throws {gpf.Error.RestrictedBaseClassAttribute}
 * @since 0.2.8
 */
function _gpfAttributesCheckAppliedOnBaseClass (classDefinition, ExpectedBaseClass) {
    var Extend = classDefinition._extend;
    if (Extend !== ExpectedBaseClass) {
        _gpfAttributesCheckAppliedOnBaseClassIsInstanceOf(Extend.prototype, ExpectedBaseClass);
    }
}

function _gpfAttributesCheckGetMemberAttributes (member, classDefinition, AttributeClass) {
    var allAttributes = classDefinition.getAttributes(AttributeClass);
    if (member) {
        return allAttributes[member];
    }
    return allAttributes[_GPF_DEFINE_CLASS_ATTRIBUTES_NAME];
}

/**
 * Ensures attribute is used only once
 *
 * @param {String} member Member name or empty if global to the class
 * @param {_GpfClassDefinition} classDefinition Class definition
 * @param {Function} AttributeClass Attribute class
 * @throws {gpf.Error.UniqueAttributeUsedTwice}
 * @since 0.2.8
 */
function _gpfAttributesCheckAppliedOnlyOnce (member, classDefinition, AttributeClass) {
    var attributes = _gpfAttributesCheckGetMemberAttributes(member, classDefinition, AttributeClass);
    if (_gpfArrayTail(attributes).length) {
        gpf.Error.uniqueAttributeUsedTwice();
    }
}