Custom Metadata rendering tests

Author: cesarParra

src/core/changelog/__test__/processing-changelog.spec.ts

@@ -57,6 +57,7 @@ class CustomObjectMetadataBuilder {
       name: 'MyObject',
       description: null,
       fields: this.fields,
+      metadataRecords: [],
     };
   }
 }

src/core/markdown/__test__/generating-custom-object-docs.spec.ts

@@ -1,7 +1,10 @@
 import { extendExpect } from './expect-extensions';
 import { customFieldPickListValues, generateDocs, unparsedObjectBundleFromRawString } from './test-helpers';
 import { assertEither } from '../../test-helpers/assert-either';
-import { unparsedFieldBundleFromRawString } from '../../test-helpers/test-data-builders';
+import {
+  unparsedCustomMetadataFromRawString,
+  unparsedFieldBundleFromRawString,
+} from '../../test-helpers/test-data-builders';
 import { CustomObjectXmlBuilder } from '../../test-helpers/test-data-builders/custom-object-xml-builder';
 
 describe('Generates Custom Object documentation', () => {
@@ -136,5 +139,73 @@ describe('Generates Custom Object documentation', () => {
       expect(result).documentationBundleHasLength(1);
       assertEither(result, (data) => expect(data).firstDocContains('`TestField__c`'));
     });
+
+    describe('when documenting Custom Metadata Types', () => {
+      it('displays the Records heading if fields are present', async () => {
+        const customObjectBundle = unparsedObjectBundleFromRawString({
+          name: 'TestObject__mdt',
+          rawContent: new CustomObjectXmlBuilder().build(),
+          filePath: 'src/object/TestObject__mdt.object-meta.xml',
+        });
+
+        const customMetadataBundle = unparsedCustomMetadataFromRawString({
+          filePath: 'src/customMetadata/TestField__c.field-meta.xml',
+          parentName: 'TestObject',
+          apiName: 'TestObject.TestField__c',
+        });
+
+        const result = await generateDocs([customObjectBundle, customMetadataBundle])();
+        expect(result).documentationBundleHasLength(1);
+        assertEither(result, (data) => expect(data).firstDocContains('## Records'));
+      });
+
+      it('does not display the Records heading if no records are present', async () => {
+        const input = unparsedObjectBundleFromRawString({
+          name: 'TestObject__mdt',
+          rawContent: new CustomObjectXmlBuilder().build(),
+          filePath: 'src/object/TestObject__c.object-meta.xml',
+        });
+
+        const result = await generateDocs([input])();
+        expect(result).documentationBundleHasLength(1);
+        assertEither(result, (data) => expect(data).not.firstDocContains('## Records'));
+      });
+
+      it('displays the record label as a heading', async () => {
+        const customObjectBundle = unparsedObjectBundleFromRawString({
+          name: 'TestObject__mdt',
+          rawContent: new CustomObjectXmlBuilder().build(),
+          filePath: 'src/object/TestObject__mdt.object-meta.xml',
+        });
+
+        const customMetadataBundle = unparsedCustomMetadataFromRawString({
+          filePath: 'src/customMetadata/TestField__c.field-meta.xml',
+          parentName: 'TestObject',
+          apiName: 'TestObject.TestField__c',
+        });
+
+        const result = await generateDocs([customObjectBundle, customMetadataBundle])();
+        expect(result).documentationBundleHasLength(1);
+        assertEither(result, (data) => expect(data).firstDocContains('## Test Metadata'));
+      });
+
+      it('displays the record api name', async () => {
+        const customObjectBundle = unparsedObjectBundleFromRawString({
+          name: 'TestObject__mdt',
+          rawContent: new CustomObjectXmlBuilder().build(),
+          filePath: 'src/object/TestObject__mdt.object-meta.xml',
+        });
+
+        const customMetadataBundle = unparsedCustomMetadataFromRawString({
+          filePath: 'src/customMetadata/TestField__c.field-meta.xml',
+          parentName: 'TestObject',
+          apiName: 'TestObject.TestField__c',
+        });
+
+        const result = await generateDocs([customObjectBundle, customMetadataBundle])();
+        expect(result).documentationBundleHasLength(1);
+        assertEither(result, (data) => expect(data).firstDocContains('TestObject.TestField__c'));
+      });
+    });
   });
 });

src/core/markdown/__test__/test-helpers.ts

@@ -15,17 +15,18 @@ export function unparsedApexBundleFromRawString(raw: string, rawMetadata?: strin
 export function unparsedObjectBundleFromRawString(meta: {
   rawContent: string;
   filePath: string;
+  name?: string;
 }): UnparsedCustomObjectBundle {
   return {
     type: 'customobject',
-    name: 'TestObject__c',
+    name: meta.name ?? 'TestObject__c',
     filePath: meta.filePath,
     content: meta.rawContent,
   };
 }
 
-export function generateDocs(apexBundles: UnparsedSourceBundle[], config?: Partial<MarkdownGeneratorConfig>) {
-  return gen(apexBundles, {
+export function generateDocs(bundles: UnparsedSourceBundle[], config?: Partial<MarkdownGeneratorConfig>) {
+  return gen(bundles, {
     targetDir: 'target',
     scope: ['global', 'public'],
     defaultGroupName: 'Miscellaneous',

src/core/markdown/adapters/type-to-renderable.ts

@@ -305,7 +305,6 @@ function customMetadataToRenderable(metadata: CustomMetadataMetadata, headingLev
     type: 'metadata',
     headingLevel: headingLevel,
     heading: metadata.label ?? metadata.name,
-    description: metadata.description ? [metadata.description] : [],
     apiName: metadata.apiName,
     label: metadata.label ?? metadata.name,
     protected: metadata.protected,

src/core/reflection/sobject/reflect-custom-metadata-source.ts

@@ -12,9 +12,7 @@ export type CustomMetadataMetadata = {
   apiName: string;
   name: string;
   label?: string | null;
-  description: string | null;
   parentName: string;
-  // TODO: Reflect values
 };
 
 export function reflectCustomMetadataSources(
@@ -57,9 +55,8 @@ function toCustomMetadataMetadata(parserResult: { CustomMetadata: unknown }): Cu
     parserResult?.CustomMetadata != null && typeof parserResult.CustomMetadata === 'object'
       ? parserResult.CustomMetadata
       : {};
-  const defaultValues = {
+  const defaultValues: Partial<CustomMetadataMetadata> = {
     label: null,
-    description: null,
   };
 
   return {

src/core/renderables/types.d.ts

@@ -201,11 +201,9 @@ export type RenderableCustomMetadata = {
   headingLevel: number;
   heading: string;
   apiName: string;
-  description: RenderableContent[];
   type: 'metadata';
   label: string;
   protected: boolean;
-  // TODO: Add values?
 };
 
 export type Renderable = (RenderableClass | RenderableInterface | RenderableEnum | RenderableCustomObject) & {

src/core/test-helpers/test-data-builders.ts

@@ -1,4 +1,4 @@
-import { UnparsedCustomFieldBundle } from '../shared/types';
+import { UnparsedCustomFieldBundle, UnparsedCustomMetadataBundle } from '../shared/types';
 
 export const customField = `
 <?xml version="1.0" encoding="UTF-8"?>
@@ -25,3 +25,31 @@ export function unparsedFieldBundleFromRawString(meta: {
     parentName: meta.parentName,
   };
 }
+
+export const customMetadata = `
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    <label>Test Metadata</label>
+    <protected>true</protected>
+    <values>
+        <field>Field1__c</field>
+        <value xsi:type="xsd:string">Sample Value</value>
+    </values>
+</CustomMetadata>
+`;
+
+export function unparsedCustomMetadataFromRawString(meta: {
+  rawContent?: string;
+  filePath: string;
+  apiName: string;
+  parentName: string;
+}): UnparsedCustomMetadataBundle {
+  return {
+    type: 'custommetadata',
+    name: meta.apiName,
+    filePath: meta.filePath,
+    content: meta.rawContent ?? customMetadata,
+    apiName: meta.apiName,
+    parentName: meta.parentName,
+  };
+}