@cparra/apexdocs 1.13.4 → 2.0.0-alpha.14

package/lib/model/ApexModel.d.ts

@@ -1,30 +0,0 @@
-export default class ApexModel {
-    protected nameLine: string;
-    private nameLineIndex;
-    private description;
-    private author;
-    private date;
-    private returns;
-    private example;
-    private scope;
-    private isNamespaceAccessible;
-    getNameLine(): string;
-    getInameLine(): number | undefined;
-    setNameLine(nameLine: string, iLine: number): void;
-    getDescription(): string;
-    setDescription(description: string): void;
-    getAuthor(): string;
-    setAuthor(author: string): void;
-    getDate(): string;
-    setDate(date: string): void;
-    getReturns(): string;
-    setReturns(returns: string): void;
-    getExample(): string;
-    setExample(example: string): void;
-    getScope(): string;
-    setScope(scope: string): void;
-    setIsNamespaceAccessible(isNamespaceAccessible: boolean): void;
-    getIsNamespaceAccessible(): boolean;
-    private parseScope;
-    private getScopeFromSettings;
-}

package/lib/model/ApexModel.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const Settings_1 = require("../Settings");
-class ApexModel {
-    constructor() {
-        this.nameLine = '';
-        this.description = '';
-        this.author = '';
-        this.date = '';
-        this.returns = '';
-        this.example = '';
-        this.scope = '';
-        this.isNamespaceAccessible = false;
-    }
-    getNameLine() {
-        return this.nameLine;
-    }
-    getInameLine() {
-        return this.nameLineIndex;
-    }
-    setNameLine(nameLine, iLine) {
-        this.nameLine = nameLine.trim();
-        this.nameLineIndex = iLine;
-        this.parseScope();
-    }
-    getDescription() {
-        return this.description == null ? '' : this.description;
-    }
-    setDescription(description) {
-        this.description = description;
-    }
-    getAuthor() {
-        return this.author == null ? '' : this.author;
-    }
-    setAuthor(author) {
-        this.author = author;
-    }
-    getDate() {
-        return this.date == null ? '' : this.date;
-    }
-    setDate(date) {
-        this.date = date;
-    }
-    getReturns() {
-        return this.returns == null ? '' : this.returns;
-    }
-    setReturns(returns) {
-        this.returns = returns;
-    }
-    getExample() {
-        return this.example == null ? '' : this.example;
-    }
-    setExample(example) {
-        this.example = example;
-    }
-    getScope() {
-        return this.scope == null ? '' : this.scope;
-    }
-    setScope(scope) {
-        this.scope = scope;
-    }
-    setIsNamespaceAccessible(isNamespaceAccessible) {
-        this.isNamespaceAccessible = isNamespaceAccessible;
-    }
-    getIsNamespaceAccessible() {
-        return this.isNamespaceAccessible;
-    }
-    parseScope() {
-        this.scope = '';
-        const str = this.getScopeFromSettings(this.nameLine);
-        if (str != null) {
-            this.scope = str;
-        }
-    }
-    getScopeFromSettings(str) {
-        str = str.toLowerCase();
-        for (const currentScope of Settings_1.default.getInstance().getScope()) {
-            if (str.toLowerCase().includes(currentScope.toLowerCase() + ' ')) {
-                return currentScope;
-            }
-        }
-        return null;
-    }
-}
-exports.default = ApexModel;

package/lib/model/ClassModel.d.ts

@@ -1,39 +0,0 @@
-import ApexModel from './ApexModel';
-import MethodModel from './MethodModel';
-import PropertyModel from './PropertyModel';
-import EnumModel from './EnumModel';
-export default class ClassModel extends ApexModel {
-    methods: MethodModel[];
-    properties: PropertyModel[];
-    cmodelParent?: ClassModel;
-    childClasses: ClassModel[];
-    childEnums: EnumModel[];
-    strClassGroup: string;
-    strClassGroupContent: string;
-    isInterface: boolean;
-    isEnum: boolean;
-    seeList: string[];
-    className: string;
-    constructor(parent?: any);
-    getProperties(): PropertyModel[];
-    setProperties(properties: PropertyModel[]): void;
-    getMethods(): MethodModel[];
-    setMethods(methods: MethodModel[]): void;
-    getChildClasses(): ClassModel[];
-    addChildClass(child: ClassModel): void;
-    addChildEnum(childEnum: EnumModel): void;
-    getChildEnums(): EnumModel[];
-    getClassName(includeParent?: boolean): string;
-    setClassName(className: string): void;
-    getTopmostClassName(): string;
-    getClassGroup(): string;
-    setClassGroup(strGroup: string): void;
-    getClassGroupContent(): string;
-    setClassGroupContent(strGroupContent: string): void;
-    getIsInterface(): boolean;
-    setIsInterface(isInterface: boolean): void;
-    getIsEnum(): boolean;
-    setIsEnum(isEnum: boolean): void;
-    addSee(seeClassName: string): void;
-    getSeeList(): string[];
-}

package/lib/model/ClassModel.js

@@ -1,125 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ApexModel_1 = require("./ApexModel");
-const Configuration_1 = require("../Configuration");
-class ClassModel extends ApexModel_1.default {
-    constructor(parent) {
-        var _a;
-        super();
-        this.methods = [];
-        this.properties = [];
-        this.childClasses = [];
-        this.childEnums = [];
-        this.strClassGroup = ((_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.defaultGroupName) || 'Miscellaneous';
-        this.strClassGroupContent = '';
-        this.isInterface = false;
-        this.isEnum = false;
-        this.seeList = [];
-        this.className = '';
-        if (parent) {
-            this.cmodelParent = parent;
-        }
-    }
-    getProperties() {
-        return this.properties;
-    }
-    setProperties(properties) {
-        this.properties = properties;
-    }
-    getMethods() {
-        return this.methods;
-    }
-    setMethods(methods) {
-        this.methods = methods;
-    }
-    getChildClasses() {
-        return this.childClasses;
-    }
-    addChildClass(child) {
-        this.childClasses.push(child);
-    }
-    addChildEnum(childEnum) {
-        this.childEnums.push(childEnum);
-    }
-    getChildEnums() {
-        return this.childEnums;
-    }
-    getClassName(includeParent = true) {
-        if (this.className !== '') {
-            return this.className;
-        }
-        let nameLine = this.getNameLine();
-        let strParent = '';
-        if (includeParent) {
-            strParent = this.cmodelParent == null ? '' : this.cmodelParent.getClassName() + '.';
-        }
-        if (nameLine != null)
-            nameLine = nameLine.trim();
-        if (nameLine != null && nameLine.trim().length > 0) {
-            let fFound = nameLine.toLowerCase().indexOf('class ');
-            let cch = 6;
-            if (fFound === -1) {
-                fFound = nameLine.toLowerCase().indexOf('interface ');
-                cch = 10;
-            }
-            if (fFound > -1)
-                nameLine = nameLine.substring(fFound + cch).trim();
-            const lFound = nameLine.indexOf(' ');
-            if (lFound === -1)
-                return strParent + nameLine;
-            try {
-                const name = nameLine.substring(0, lFound);
-                return strParent + name;
-            }
-            catch (ex) {
-                return strParent + nameLine.substring(nameLine.lastIndexOf(' ') + 1);
-            }
-        }
-        else {
-            return '';
-        }
-    }
-    setClassName(className) {
-        this.className = className;
-    }
-    getTopmostClassName() {
-        if (this.cmodelParent != null)
-            return this.cmodelParent.getClassName();
-        else
-            return this.getClassName();
-    }
-    getClassGroup() {
-        if (this.cmodelParent != null)
-            return this.cmodelParent.getClassGroup();
-        else
-            return this.strClassGroup;
-    }
-    setClassGroup(strGroup) {
-        this.strClassGroup = strGroup;
-    }
-    getClassGroupContent() {
-        return this.strClassGroupContent;
-    }
-    setClassGroupContent(strGroupContent) {
-        this.strClassGroupContent = strGroupContent;
-    }
-    getIsInterface() {
-        return this.isInterface;
-    }
-    setIsInterface(isInterface) {
-        this.isInterface = isInterface;
-    }
-    getIsEnum() {
-        return this.isEnum;
-    }
-    setIsEnum(isEnum) {
-        this.isEnum = isEnum;
-    }
-    addSee(seeClassName) {
-        this.seeList.push(seeClassName);
-    }
-    getSeeList() {
-        return this.seeList;
-    }
-}
-exports.default = ClassModel;

package/lib/model/EnumModel.d.ts

@@ -1,6 +0,0 @@
-import ClassModel from './ClassModel';
-export default class EnumModel extends ClassModel {
-    constructor();
-    setNameLine(nameLine: string, iLine: number): void;
-    getClassName(): string;
-}

package/lib/model/EnumModel.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ClassModel_1 = require("./ClassModel");
-class EnumModel extends ClassModel_1.default {
-    constructor() {
-        super();
-        this.setIsEnum(true);
-    }
-    setNameLine(nameLine, iLine) {
-        // remove any trailing stuff after enum name.
-        const i = nameLine.indexOf('{');
-        if (i >= 0)
-            nameLine = nameLine.substring(0, i);
-        super.setNameLine(nameLine, iLine);
-    }
-    getClassName() {
-        const nameLine = this.getNameLine().trim();
-        if (nameLine != null && nameLine.length > 0) {
-            const lastindex = nameLine.lastIndexOf(' ');
-            if (lastindex >= 0) {
-                const propertyName = nameLine.substring(lastindex + 1);
-                return propertyName;
-            }
-        }
-        return '';
-    }
-}
-exports.default = EnumModel;

package/lib/model/MethodModel.d.ts

@@ -1,18 +0,0 @@
-import ApexModel from './ApexModel';
-export default class MethodModel extends ApexModel {
-    params: string[];
-    thrownExceptions: string[];
-    iLine: number | undefined;
-    returnType: string;
-    private isConstructor;
-    setNameLine(nameLine: string, iLine: number): void;
-    getParams(): string[];
-    setParams(params: string[]): void;
-    getThrownExceptions(): string[];
-    setThrownExceptions(thrownExceptions: string[]): void;
-    getReturnType(): string;
-    getMethodName(): string;
-    getSignature(): string | undefined;
-    setIsConstructor(isConstructor: boolean): void;
-    getIsConstructor(): boolean;
-}

package/lib/model/MethodModel.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ApexModel_1 = require("./ApexModel");
-const utils_1 = require("../utils");
-class MethodModel extends ApexModel_1.default {
-    constructor() {
-        super(...arguments);
-        this.params = [];
-        this.thrownExceptions = [];
-        this.returnType = '';
-        this.isConstructor = false;
-    }
-    setNameLine(nameLine, iLine) {
-        // remove anything after the parameter list
-        if (nameLine != null) {
-            const i = nameLine.lastIndexOf(')');
-            if (i >= 0)
-                nameLine = nameLine.substring(0, i + 1);
-        }
-        super.setNameLine(nameLine, iLine);
-    }
-    getParams() {
-        return this.params;
-    }
-    setParams(params) {
-        this.params = params;
-    }
-    getThrownExceptions() {
-        return this.thrownExceptions;
-    }
-    setThrownExceptions(thrownExceptions) {
-        this.thrownExceptions = thrownExceptions;
-    }
-    getReturnType() {
-        if (this.isConstructor) {
-            // If the method is a constructor, then it return the same type as its name.
-            return this.getMethodName();
-        }
-        const nameLine = this.getNameLine().trim();
-        if (nameLine != null && nameLine.length > 0) {
-            const lastindex = nameLine.indexOf(this.getMethodName());
-            if (lastindex >= 0) {
-                const returnType = utils_1.findPreviousWord(nameLine, lastindex);
-                return returnType ? returnType : '';
-            }
-        }
-        return '';
-    }
-    getMethodName() {
-        const nameLine = this.getNameLine().trim();
-        if (nameLine != null && nameLine.length > 0) {
-            const lastindex = nameLine.indexOf('(');
-            if (lastindex >= 0) {
-                const methodName = utils_1.findPreviousWord(nameLine, lastindex);
-                return methodName ? methodName : '';
-            }
-        }
-        return '';
-    }
-    getSignature() {
-        const nameLine = this.getNameLine().trim();
-        if (nameLine != null && nameLine.length > 0) {
-            const beginParen = nameLine.indexOf('(');
-            return this.getMethodName() + nameLine.substring(beginParen);
-        }
-    }
-    setIsConstructor(isConstructor) {
-        this.isConstructor = isConstructor;
-    }
-    getIsConstructor() {
-        return this.isConstructor;
-    }
-}
-exports.default = MethodModel;

package/lib/model/PropertyModel.d.ts

@@ -1,6 +0,0 @@
-import ApexModel from './ApexModel';
-export default class PropertyModel extends ApexModel {
-    setNameLine(nameLine: string, iLine: number): void;
-    getPropertyName(): string;
-    getReturnType(): string;
-}

package/lib/model/PropertyModel.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ApexModel_1 = require("./ApexModel");
-const utils_1 = require("../utils");
-class PropertyModel extends ApexModel_1.default {
-    setNameLine(nameLine, iLine) {
-        // remove any trailing stuff after property name. { =
-        let i = nameLine.indexOf('{');
-        if (i === -1)
-            i = nameLine.indexOf('=');
-        if (i === -1)
-            i = nameLine.indexOf(';');
-        if (i >= 0)
-            nameLine = nameLine.substring(0, i);
-        super.setNameLine(nameLine, iLine);
-    }
-    getPropertyName() {
-        const nameLine = this.getNameLine().trim();
-        if (nameLine != null && nameLine.length > 0) {
-            const lastindex = nameLine.lastIndexOf(' ');
-            if (lastindex >= 0) {
-                const propertyName = nameLine.substring(lastindex + 1);
-                return propertyName;
-            }
-        }
-        return '';
-    }
-    getReturnType() {
-        const nameLine = this.getNameLine().trim();
-        if (nameLine != null && nameLine.length > 0) {
-            const lastindex = nameLine.indexOf(this.getPropertyName());
-            if (lastindex >= 0) {
-                const returnType = utils_1.findPreviousWord(nameLine, lastindex);
-                return returnType ? returnType : '';
-            }
-        }
-        return '';
-    }
-}
-exports.default = PropertyModel;

package/lib/model/__test__/ClassModel.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/model/__test__/ClassModel.test.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ClassModel_1 = require("../ClassModel");
-const PropertyModel_1 = require("../PropertyModel");
-const MethodModel_1 = require("../MethodModel");
-test('new class model initializes correctly', () => {
-    const classModel = new ClassModel_1.default();
-    expect(classModel.getProperties()).toHaveLength(0);
-    expect(classModel.getMethods()).toHaveLength(0);
-    expect(classModel.getChildClasses()).toHaveLength(0);
-    expect(classModel.getClassName()).toBe('');
-    expect(classModel.getTopmostClassName()).toBe('');
-    expect(classModel.getClassGroup()).toBe('Miscellaneous');
-    expect(classModel.getClassGroupContent()).toBe('');
-    expect(classModel.getIsInterface()).toBe(false);
-});
-test('can set properties', () => {
-    const classModel = new ClassModel_1.default();
-    const properties = [new PropertyModel_1.default()];
-    classModel.setProperties(properties);
-    expect(classModel.getProperties()).toBe(properties);
-});
-test('can set methods', () => {
-    const classModel = new ClassModel_1.default();
-    const methods = [new MethodModel_1.default()];
-    classModel.setMethods(methods);
-    expect(classModel.getMethods()).toBe(methods);
-});
-test('can add children', () => {
-    const classModel = new ClassModel_1.default();
-    const childClass = new ClassModel_1.default();
-    classModel.addChildClass(childClass);
-    expect(classModel.getChildClasses().length).toBe(1);
-    expect(classModel.getChildClasses()[0]).toBe(childClass);
-});
-test('class name can be set and retrieved correctly', () => {
-    const classModel = new ClassModel_1.default();
-    const nameLine = 'public with sharing class TestClassName {';
-    classModel.setNameLine(nameLine, 1);
-    expect(classModel.getClassName()).toBe('TestClassName');
-});
-test('interface name can be retrieved correctly', () => {
-    const classModel = new ClassModel_1.default();
-    const nameLine = 'public interface TestInterfaceName {';
-    classModel.setNameLine(nameLine, 1);
-    expect(classModel.getClassName()).toBe('TestInterfaceName');
-});
-test('topmost class name is the class name when it has no parent', () => {
-    const classModel = new ClassModel_1.default();
-    const nameLine = 'public abstract class TestClassName {';
-    classModel.setNameLine(nameLine, 1);
-    expect(classModel.getClassName()).toBe('TestClassName');
-});
-test('topmost class name is parent name', () => {
-    const parentClass = new ClassModel_1.default();
-    const nameLine = 'public abstract class TestClassName {';
-    parentClass.setNameLine(nameLine, 1);
-    const childClass = new ClassModel_1.default(parentClass);
-    const nameLineChild = 'private class ChildClassName {';
-    childClass.setNameLine(nameLineChild, 10);
-    expect(childClass.getTopmostClassName()).toBe('TestClassName');
-});
-test('can add group', () => {
-    const classModel = new ClassModel_1.default();
-    const groupName = 'GroupName';
-    classModel.setClassGroup(groupName);
-    expect(classModel.getClassGroup()).toBe(groupName);
-});
-test('can add group content', () => {
-    const classModel = new ClassModel_1.default();
-    const groupContentName = 'GroupContentName';
-    classModel.setClassGroupContent(groupContentName);
-    expect(classModel.getClassGroupContent()).toBe(groupContentName);
-});
-test('can set as interface', () => {
-    const classModel = new ClassModel_1.default();
-    classModel.setIsInterface(true);
-    expect(classModel.getIsInterface()).toBe(true);
-});

package/lib/model/__test__/MethodModel.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/model/__test__/MethodModel.test.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const MethodModel_1 = require("../MethodModel");
-test('name line can be set', () => {
-    const method = new MethodModel_1.default();
-    const nameLine = 'public static void testMethod() {';
-    method.setNameLine(nameLine, 1);
-    // Expected everyhing after the parameter list to be removed
-    const expected = 'public static void testMethod()';
-    expect(method.getNameLine()).toBe(expected);
-});
-test('new method is empty', () => {
-    const method = new MethodModel_1.default();
-    expect(method.getParams()).toHaveLength(0);
-    expect(method.getReturnType()).toBe('');
-    expect(method.getMethodName()).toBe('');
-});
-test('params can be set', () => {
-    const method = new MethodModel_1.default();
-    const params = ['a', 'b', 'c'];
-    method.setParams(params);
-    expect(method.getParams()).toBe(params);
-});
-test('return type is method name when method is constructor', () => {
-    const method = new MethodModel_1.default();
-    const nameLine = 'public TestClass() {';
-    method.setNameLine(nameLine, 10);
-    method.setIsConstructor(true);
-    expect(method.getReturnType()).toBe('TestClass');
-});
-test('return type returns previous word when method is not constructor', () => {
-    const method = new MethodModel_1.default();
-    const nameLine = 'public static void testMethod() {';
-    method.setNameLine(nameLine, 10);
-    method.setIsConstructor(false);
-    expect(method.getReturnType()).toBe('void');
-});
-test('signature can be retrieved', () => {
-    const method = new MethodModel_1.default();
-    const nameLine = 'public static void testMethod() {';
-    method.setNameLine(nameLine, 10);
-    method.setIsConstructor(false);
-    expect(method.getSignature()).toBe('testMethod()');
-});
-test('method name is retrieved correctly', () => {
-    const method = new MethodModel_1.default();
-    const nameLine = 'public static void testMethod() {';
-    method.setNameLine(nameLine, 1);
-    expect(method.getMethodName()).toBe('testMethod');
-});
-test('can get and set if the method is a constructor', () => {
-    const method = new MethodModel_1.default();
-    method.setIsConstructor(true);
-    expect(method.getIsConstructor()).toBe(true);
-});

package/lib/model/__test__/PropertyModel.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/model/__test__/PropertyModel.test.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const PropertyModel_1 = require("../PropertyModel");
-test('has no name by defaullt', () => {
-    const property = new PropertyModel_1.default();
-    expect(property.getPropertyName()).toBe('');
-});
-test('can set name line for property', () => {
-    const nameLine = 'public PropertyName { get; set; }';
-    const property = new PropertyModel_1.default();
-    property.setNameLine(nameLine, 1);
-    expect(property.getPropertyName()).toBe('PropertyName');
-});
-test('can set name line for null variable', () => {
-    const nameLine = 'public PropertyName;';
-    const property = new PropertyModel_1.default();
-    property.setNameLine(nameLine, 1);
-    expect(property.getPropertyName()).toBe('PropertyName');
-});
-test('can set name line for initialized variable', () => {
-    const nameLine = 'public PropertyName;';
-    const property = new PropertyModel_1.default();
-    property.setNameLine(nameLine, 1);
-    expect(property.getPropertyName()).toBe('PropertyName');
-});

package/lib/parser/ClassParser.d.ts

@@ -1,5 +0,0 @@
-import ClassModel from '../model/ClassModel';
-export default class ClassParser {
-    getClass(strLine: string, lstComments: string[], iLine: number, parent?: ClassModel): ClassModel;
-    private fillClassModel;
-}