@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

package/src/model/__tests__/manifest-diff.spec.ts

@@ -1,139 +0,0 @@
-import Manifest from '../manifest';
-import { EnumMirror } from '@cparra/apex-reflection';
-import { ManifestDiff } from '../manifest-diff';
-import { Annotation } from '@cparra/apex-reflection/index';
-
-const deprecatedAnnotation: Annotation = {
-  rawDeclaration: '@deprecated',
-  name: 'deprecated',
-  type: 'deprecated',
-};
-
-const namespaceAccessibleAnnotation: Annotation = {
-  rawDeclaration: '@NamespaceAccessible',
-  name: 'namespaceaccessible',
-  type: 'namespaceaccessible',
-};
-
-it('detects when new types are added', () => {
-  const commonType = {
-    annotations: [],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-
-  const originalManifest = new Manifest([commonType]);
-
-  const addedType = {
-    annotations: [],
-    name: 'NewEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-  const newManifest = new Manifest([addedType, commonType]);
-
-  const manifestDiff = ManifestDiff.build(originalManifest, newManifest);
-  expect(manifestDiff.added.length).toBe(1);
-  expect(manifestDiff.added[0].name).toBe('NewEnum');
-});
-
-it('detects when types are deleted', () => {
-  const commonType = {
-    annotations: [],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-
-  const deletedType = {
-    annotations: [],
-    name: 'OldEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-  const originalManifest = new Manifest([commonType, deletedType]);
-  const newManifest = new Manifest([commonType]);
-
-  const manifestDiff = ManifestDiff.build(originalManifest, newManifest);
-  expect(manifestDiff.deleted.length).toBe(1);
-  expect(manifestDiff.deleted[0].name).toBe('OldEnum');
-});
-
-it('does not add enums that have no changes', () => {
-  const originalEnum = {
-    annotations: [],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-
-  const modifiedEnum = {
-    annotations: [],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-
-  const originalManifest = new Manifest([originalEnum]);
-  const newManifest = new Manifest([modifiedEnum]);
-
-  const manifestDiff = ManifestDiff.build(originalManifest, newManifest);
-  expect(manifestDiff.changes.length).toBe(0);
-});
-
-it('detects changes to access modifiers within an enum', () => {
-  const originalEnum = {
-    annotations: [],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-
-  const modifiedEnum = {
-    annotations: [],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'private',
-  } as EnumMirror;
-
-  const originalManifest = new Manifest([originalEnum]);
-  const newManifest = new Manifest([modifiedEnum]);
-
-  const manifestDiff = ManifestDiff.build(originalManifest, newManifest);
-  expect(manifestDiff.changes.length).toBe(1);
-  expect(manifestDiff.changes[0].originalType).toBe(originalEnum);
-  expect(manifestDiff.changes[0].newType).toBe(modifiedEnum);
-  expect(manifestDiff.changes[0].accessModifierChange).not.toBeNull();
-  expect(manifestDiff.changes[0].accessModifierChange?.oldAccessModifier).toBe('public');
-  expect(manifestDiff.changes[0].accessModifierChange?.newAccessModifier).toBe('private');
-});
-
-it('detects changes to annotations within an enum', () => {
-  const originalEnum = {
-    annotations: [deprecatedAnnotation],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'public',
-  } as EnumMirror;
-
-  const modifiedEnum = {
-    annotations: [namespaceAccessibleAnnotation],
-    name: 'CommonEnum',
-    type_name: 'enum',
-    access_modifier: 'private',
-  } as EnumMirror;
-
-  const originalManifest = new Manifest([originalEnum]);
-  const newManifest = new Manifest([modifiedEnum]);
-
-  const manifestDiff = ManifestDiff.build(originalManifest, newManifest);
-  expect(manifestDiff.changes.length).toBe(1);
-  expect(manifestDiff.changes[0].annotationChanges.length).toBe(2);
-  expect(manifestDiff.changes[0].annotationChanges.find((change) => change.type === 'added')?.annotation.name).toBe(
-    namespaceAccessibleAnnotation.name,
-  );
-  expect(manifestDiff.changes[0].annotationChanges.find((change) => change.type === 'removed')?.annotation.name).toBe(
-    deprecatedAnnotation.name,
-  );
-});

package/src/model/manifest-diff.ts

@@ -1,94 +0,0 @@
-import Manifest from './manifest';
-import { Type } from '@cparra/apex-reflection';
-import { Annotation } from '@cparra/apex-reflection/index';
-
-export class ManifestDiff {
-  added: Type[] = [];
-  deleted: Type[] = [];
-  changes: DiffChange[] = [];
-
-  static build(originalManifest: Manifest, newManifest: Manifest) {
-    const addedTypes = newManifest.types.filter(
-      (currentType) => !originalManifest.types.find((originalType) => currentType.name === originalType.name),
-    );
-    const deletedTypes = originalManifest.types.filter(
-      (currentType) => !newManifest.types.find((newType) => currentType.name === newType.name),
-    );
-
-    const changes: DiffChange[] = [];
-    for (const newType of newManifest.types) {
-      const oldType = originalManifest.types.find((oldType) => oldType.name === newType.name);
-      if (!oldType) {
-        continue;
-      }
-
-      const change = new DiffChange(oldType, newType);
-      if (change.hasChanges()) {
-        changes.push(change);
-      }
-    }
-
-    const diff = new ManifestDiff();
-    diff.added = addedTypes;
-    diff.deleted = deletedTypes;
-    diff.changes = changes;
-    return diff;
-  }
-}
-
-class DiffChange {
-  accessModifierChange?: AccessModifierChange;
-  annotationChanges: AnnotationChange[] = [];
-
-  constructor(public originalType: Type, public newType: Type) {
-    this.parse();
-  }
-
-  public hasChanges(): boolean {
-    return !!this.accessModifierChange || this.annotationChanges.length > 0;
-  }
-
-  private parse() {
-    // Access modifier changes
-    if (this.originalType.access_modifier !== this.newType.access_modifier) {
-      this.accessModifierChange = {
-        oldAccessModifier: this.originalType.access_modifier,
-        newAccessModifier: this.newType.access_modifier,
-      };
-    }
-
-    // Annotation changes
-    const addedAnnotations = this.newType.annotations.filter(
-      (currentAnnotation) =>
-        !this.originalType.annotations.find((originalAnnotation) => currentAnnotation.name === originalAnnotation.name),
-    );
-    const removedAnnotations = this.originalType.annotations.filter(
-      (currentAnnotation) =>
-        !this.newType.annotations.find((newAnnotation) => currentAnnotation.name === newAnnotation.name),
-    );
-    const annotationChangeMapper = (annotation: Annotation, changeType: 'added' | 'removed') => {
-      return {
-        annotation: annotation,
-        type: changeType,
-      } as AnnotationChange;
-    };
-    this.annotationChanges = [
-      ...addedAnnotations.map((annotation) => {
-        return annotationChangeMapper(annotation, 'added');
-      }),
-      ...removedAnnotations.map((annotation) => {
-        return annotationChangeMapper(annotation, 'removed');
-      }),
-    ];
-  }
-}
-
-interface AccessModifierChange {
-  oldAccessModifier: string;
-  newAccessModifier: string;
-}
-
-interface AnnotationChange {
-  annotation: Annotation;
-  type: 'added' | 'removed';
-}