@cparra/apexdocs 1.13.4 → 2.0.0-alpha.14

package/src/command/__test__/Generte.test.ts

@@ -1,39 +0,0 @@
-import * as fs from 'fs';
-import { generate } from '../Generate';
-import FileParser from '../../parser/FileParser';
-
-jest.mock('fs');
-jest.mock('../../parser/FileParser');
-
-beforeEach(() => {
-  (FileParser as jest.Mock).mockClear();
-});
-
-it('returns an empty list when there are no files', () => {
-  (fs.readdirSync as jest.Mock).mockReturnValue([]);
-
-  const classes = generate('src');
-
-  expect(classes.length).toBe(0);
-});
-
-it('returns an empty list when there are no files ending in .cls', () => {
-  (fs.readdirSync as jest.Mock).mockReturnValue(['file.xml', 'README.md']);
-
-  const classes = generate('src', false);
-
-  expect(classes.length).toBe(0);
-});
-
-it('returns parsed files when there are .cls files', () => {
-  (fs.readdirSync as jest.Mock).mockReturnValue(['TestClass.cls', 'README.md']);
-  (fs.readFileSync as jest.Mock).mockReturnValue('Raw class data');
-
-  generate('src', false);
-
-  expect(FileParser).toHaveBeenCalledTimes(1);
-  const mockFileParserInstance = (FileParser as jest.Mock).mock.instances[0];
-  const mockParseFileContents = mockFileParserInstance.parseFileContents;
-  expect(mockParseFileContents).toHaveBeenCalledTimes(1);
-  expect(mockParseFileContents).toHaveBeenCalledWith('Raw class data');
-});

package/src/model/ApexModel.ts

@@ -1,102 +0,0 @@
-import Settings from '../Settings';
-
-export default class ApexModel {
-  protected nameLine: string = '';
-  private nameLineIndex: number | undefined;
-  private description: string = '';
-  private author: string = '';
-  private date: string = '';
-  private returns: string = '';
-  private example: string = '';
-  private scope: string = '';
-  private isNamespaceAccessible: boolean = false;
-
-  getNameLine() {
-    return this.nameLine;
-  }
-
-  getInameLine() {
-    return this.nameLineIndex;
-  }
-
-  setNameLine(nameLine: string, iLine: number) {
-    this.nameLine = nameLine.trim();
-    this.nameLineIndex = iLine;
-    this.parseScope();
-  }
-
-  getDescription() {
-    return this.description == null ? '' : this.description;
-  }
-
-  setDescription(description: string) {
-    this.description = description;
-  }
-
-  getAuthor() {
-    return this.author == null ? '' : this.author;
-  }
-
-  setAuthor(author: string) {
-    this.author = author;
-  }
-
-  getDate() {
-    return this.date == null ? '' : this.date;
-  }
-
-  setDate(date: string) {
-    this.date = date;
-  }
-
-  getReturns() {
-    return this.returns == null ? '' : this.returns;
-  }
-
-  setReturns(returns: string) {
-    this.returns = returns;
-  }
-
-  getExample() {
-    return this.example == null ? '' : this.example;
-  }
-
-  setExample(example: string) {
-    this.example = example;
-  }
-
-  getScope() {
-    return this.scope == null ? '' : this.scope;
-  }
-
-  setScope(scope: string) {
-    this.scope = scope;
-  }
-
-  setIsNamespaceAccessible(isNamespaceAccessible: boolean) {
-    this.isNamespaceAccessible = isNamespaceAccessible;
-  }
-
-  getIsNamespaceAccessible() {
-    return this.isNamespaceAccessible;
-  }
-
-  private parseScope() {
-    this.scope = '';
-    const str = this.getScopeFromSettings(this.nameLine);
-    if (str != null) {
-      this.scope = str;
-    }
-  }
-
-  private getScopeFromSettings(str: string) {
-    str = str.toLowerCase();
-    for (const currentScope of Settings.getInstance().getScope()) {
-      if (str.toLowerCase().includes(currentScope.toLowerCase() + ' ')) {
-        return currentScope;
-      }
-    }
-
-    return null;
-  }
-}

package/src/model/ClassModel.ts

@@ -1,140 +0,0 @@
-import ApexModel from './ApexModel';
-import MethodModel from './MethodModel';
-import PropertyModel from './PropertyModel';
-import EnumModel from './EnumModel';
-import Configuration from '../Configuration';
-
-export default class ClassModel extends ApexModel {
-  methods: MethodModel[] = [];
-  properties: PropertyModel[] = [];
-  cmodelParent?: ClassModel;
-  childClasses: ClassModel[] = [];
-  childEnums: EnumModel[] = [];
-  strClassGroup: string = Configuration.getConfig()?.defaultGroupName || 'Miscellaneous';
-  strClassGroupContent: string = '';
-  isInterface: boolean = false;
-  isEnum: boolean = false;
-  seeList: string[] = [];
-  className: string = '';
-
-  constructor(parent?: any) {
-    super();
-    if (parent) {
-      this.cmodelParent = parent as ClassModel;
-    }
-  }
-
-  getProperties() {
-    return this.properties;
-  }
-
-  setProperties(properties: PropertyModel[]) {
-    this.properties = properties;
-  }
-
-  getMethods() {
-    return this.methods;
-  }
-
-  setMethods(methods: MethodModel[]) {
-    this.methods = methods;
-  }
-
-  getChildClasses() {
-    return this.childClasses;
-  }
-
-  addChildClass(child: ClassModel) {
-    this.childClasses.push(child);
-  }
-
-  addChildEnum(childEnum: EnumModel) {
-    this.childEnums.push(childEnum);
-  }
-
-  getChildEnums() {
-    return this.childEnums;
-  }
-
-  getClassName(includeParent: boolean = true): string {
-    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: string) {
-    this.className = className;
-  }
-
-  getTopmostClassName() {
-    if (this.cmodelParent != null) return this.cmodelParent.getClassName();
-    else return this.getClassName();
-  }
-
-  getClassGroup(): string {
-    if (this.cmodelParent != null) return this.cmodelParent.getClassGroup();
-    else return this.strClassGroup;
-  }
-
-  setClassGroup(strGroup: string) {
-    this.strClassGroup = strGroup;
-  }
-
-  getClassGroupContent() {
-    return this.strClassGroupContent;
-  }
-
-  setClassGroupContent(strGroupContent: string) {
-    this.strClassGroupContent = strGroupContent;
-  }
-
-  getIsInterface() {
-    return this.isInterface;
-  }
-
-  setIsInterface(isInterface: boolean) {
-    this.isInterface = isInterface;
-  }
-
-  getIsEnum() {
-    return this.isEnum;
-  }
-
-  setIsEnum(isEnum: boolean) {
-    this.isEnum = isEnum;
-  }
-
-  addSee(seeClassName: string) {
-    this.seeList.push(seeClassName);
-  }
-
-  getSeeList() {
-    return this.seeList;
-  }
-}

package/src/model/EnumModel.ts

@@ -1,27 +0,0 @@
-import ClassModel from './ClassModel';
-
-export default class EnumModel extends ClassModel {
-  constructor() {
-    super();
-    this.setIsEnum(true);
-  }
-
-  setNameLine(nameLine: string, iLine: number) {
-    // 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 '';
-  }
-}

package/src/model/MethodModel.ts

@@ -1,80 +0,0 @@
-import ApexModel from './ApexModel';
-import { findPreviousWord } from '../utils';
-
-export default class MethodModel extends ApexModel {
-  params: string[] = [];
-  thrownExceptions: string[] = [];
-  iLine: number | undefined;
-  returnType: string = '';
-  private isConstructor: boolean = false;
-
-  setNameLine(nameLine: string, iLine: number) {
-    // 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: string[]) {
-    this.params = params;
-  }
-
-  getThrownExceptions() {
-    return this.thrownExceptions;
-  }
-
-  setThrownExceptions(thrownExceptions: string[]) {
-    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 = findPreviousWord(nameLine, lastindex);
-        return returnType ? returnType : '';
-      }
-    }
-    return '';
-  }
-
-  getMethodName(): string {
-    const nameLine = this.getNameLine().trim();
-    if (nameLine != null && nameLine.length > 0) {
-      const lastindex = nameLine.indexOf('(');
-      if (lastindex >= 0) {
-        const methodName = 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: boolean) {
-    this.isConstructor = isConstructor;
-  }
-
-  getIsConstructor() {
-    return this.isConstructor;
-  }
-}

package/src/model/PropertyModel.ts

@@ -1,37 +0,0 @@
-import ApexModel from './ApexModel';
-import { findPreviousWord } from '../utils';
-
-export default class PropertyModel extends ApexModel {
-  setNameLine(nameLine: string, iLine: number) {
-    // 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 = findPreviousWord(nameLine, lastindex);
-        return returnType ? returnType : '';
-      }
-    }
-    return '';
-  }
-}

package/src/model/__test__/ClassModel.test.ts

@@ -1,100 +0,0 @@
-import ClassModel from '../ClassModel';
-import PropertyModel from '../PropertyModel';
-import MethodModel from '../MethodModel';
-
-test('new class model initializes correctly', () => {
-  const classModel = new ClassModel();
-
-  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();
-  const properties = [new PropertyModel()];
-
-  classModel.setProperties(properties);
-  expect(classModel.getProperties()).toBe(properties);
-});
-
-test('can set methods', () => {
-  const classModel = new ClassModel();
-  const methods = [new MethodModel()];
-
-  classModel.setMethods(methods);
-  expect(classModel.getMethods()).toBe(methods);
-});
-
-test('can add children', () => {
-  const classModel = new ClassModel();
-  const childClass = new ClassModel();
-
-  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();
-  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();
-  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();
-  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();
-  const nameLine = 'public abstract class TestClassName {';
-  parentClass.setNameLine(nameLine, 1);
-
-  const childClass = new ClassModel(parentClass);
-  const nameLineChild = 'private class ChildClassName {';
-  childClass.setNameLine(nameLineChild, 10);
-
-  expect(childClass.getTopmostClassName()).toBe('TestClassName');
-});
-
-test('can add group', () => {
-  const classModel = new ClassModel();
-  const groupName = 'GroupName';
-  classModel.setClassGroup(groupName);
-
-  expect(classModel.getClassGroup()).toBe(groupName);
-});
-
-test('can add group content', () => {
-  const classModel = new ClassModel();
-  const groupContentName = 'GroupContentName';
-  classModel.setClassGroupContent(groupContentName);
-
-  expect(classModel.getClassGroupContent()).toBe(groupContentName);
-});
-
-test('can set as interface', () => {
-  const classModel = new ClassModel();
-  classModel.setIsInterface(true);
-
-  expect(classModel.getIsInterface()).toBe(true);
-});

package/src/model/__test__/MethodModel.test.ts

@@ -1,70 +0,0 @@
-import MethodModel from '../MethodModel';
-
-test('name line can be set', () => {
-  const method = new MethodModel();
-  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();
-
-  expect(method.getParams()).toHaveLength(0);
-  expect(method.getReturnType()).toBe('');
-  expect(method.getMethodName()).toBe('');
-});
-
-test('params can be set', () => {
-  const method = new MethodModel();
-  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();
-  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();
-  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();
-  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();
-  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();
-  method.setIsConstructor(true);
-
-  expect(method.getIsConstructor()).toBe(true);
-});

package/src/model/__test__/PropertyModel.test.ts

@@ -1,34 +0,0 @@
-import PropertyModel from '../PropertyModel';
-
-test('has no name by defaullt', () => {
-  const property = new PropertyModel();
-
-  expect(property.getPropertyName()).toBe('');
-});
-
-test('can set name line for property', () => {
-  const nameLine = 'public PropertyName { get; set; }';
-
-  const property = new PropertyModel();
-  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();
-  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();
-  property.setNameLine(nameLine, 1);
-
-  expect(property.getPropertyName()).toBe('PropertyName');
-});