UT refactoring

examples/changelog/docs/changelog.md

@@ -49,4 +49,21 @@ These members have been added or modified.
 ### SolidService
 
 - New Method: newMethod
-- Removed Method: deprecatedMethod
+- Removed Method: deprecatedMethod
+
+## New or Removed Fields in Existing Objects
+
+These custom fields have been added or removed.
+
+### Event__c
+
+- New Field: Description__c
+- New Field: Tag_Line__c
+
+### Price_Component__c
+
+- New Field: Description__c
+
+### Product__c
+
+- New Field: Description__c

src/core/changelog/__test__/generating-change-log.spec.ts

@@ -7,6 +7,7 @@ import {
 import { ChangeLogPageData, generateChangeLog } from '../generate-change-log';
 import { assertEither } from '../../test-helpers/assert-either';
 import { isSkip } from '../../shared/utils';
+import { customObjectGenerator } from '../../test-helpers/test-data-builders';
 
 const config = {
   fileName: 'changelog',
@@ -18,20 +19,6 @@ const config = {
   skipIfNoChanges: false,
 };
 
-function customObjectGenerator(
-  config: { deploymentStatus: string; visibility: string } = { deploymentStatus: 'Deployed', visibility: 'Public' },
-) {
-  return `
-    <?xml version="1.0" encoding="UTF-8"?>
-    <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
-        <deploymentStatus>${config.deploymentStatus}</deploymentStatus>
-        <description>test object for testing</description>
-        <label>MyTestObject</label>
-        <pluralLabel>MyFirstObjects</pluralLabel>
-        <visibility>${config.visibility}</visibility>
-    </CustomObject>`;
-}
-
 export const customField = `
 <?xml version="1.0" encoding="UTF-8"?>
 <CustomField xmlns="http://soap.sforce.com/2006/04/metadata">

src/core/changelog/templates/changelog-template.ts

@@ -94,6 +94,7 @@ export const changelogTemplate = `
 {{#each this.modifications}}
 - {{this}}
 {{/each}}
+
 {{/each}}
 {{/if}}
 `.trim();

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

@@ -1,12 +1,12 @@
 import { extendExpect } from './expect-extensions';
 import {
   customField,
-  customObjectGenerator,
   generateDocs,
   unparsedFieldBundleFromRawString,
   unparsedObjectBundleFromRawString,
 } from './test-helpers';
 import { assertEither } from '../../test-helpers/assert-either';
+import { customObjectGenerator } from '../../test-helpers/test-data-builders';
 
 describe('Generates Custom Object documentation', () => {
   beforeAll(() => {

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

@@ -1,12 +1,8 @@
 import { DocPageData, PostHookDocumentationBundle } from '../../shared/types';
 import { extendExpect } from './expect-extensions';
-import {
-  unparsedApexBundleFromRawString,
-  generateDocs,
-  unparsedObjectBundleFromRawString,
-  customObjectGenerator,
-} from './test-helpers';
+import { unparsedApexBundleFromRawString, generateDocs, unparsedObjectBundleFromRawString } from './test-helpers';
 import { assertEither } from '../../test-helpers/assert-either';
+import { customObjectGenerator } from '../../test-helpers/test-data-builders';
 
 function aSingleDoc(result: PostHookDocumentationBundle): DocPageData {
   expect(result.docs).toHaveLength(1);

src/core/markdown/__test__/generating-reference-guide.spec.ts

@@ -1,14 +1,10 @@
 import { extendExpect } from './expect-extensions';
 import { pipe } from 'fp-ts/function';
 import * as E from 'fp-ts/Either';
-import {
-  unparsedApexBundleFromRawString,
-  generateDocs,
-  customObjectGenerator,
-  unparsedObjectBundleFromRawString,
-} from './test-helpers';
+import { unparsedApexBundleFromRawString, generateDocs, unparsedObjectBundleFromRawString } from './test-helpers';
 import { ReferenceGuidePageData } from '../../shared/types';
 import { assertEither } from '../../test-helpers/assert-either';
+import { customObjectGenerator } from '../../test-helpers/test-data-builders';
 
 describe('When generating the Reference Guide', () => {
   beforeAll(() => {

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

@@ -59,20 +59,6 @@ export function generateDocs(apexBundles: UnparsedSourceBundle[], config?: Parti
   });
 }
 
-export function customObjectGenerator(
-  config: { deploymentStatus: string; visibility: string } = { deploymentStatus: 'Deployed', visibility: 'Public' },
-) {
-  return `
-    <?xml version="1.0" encoding="UTF-8"?>
-    <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
-        <deploymentStatus>${config.deploymentStatus}</deploymentStatus>
-        <description>test object for testing</description>
-        <label>MyTestObject</label>
-        <pluralLabel>MyFirstObjects</pluralLabel>
-        <visibility>${config.visibility}</visibility>
-    </CustomObject>`;
-}
-
 export const customField = `
 <?xml version="1.0" encoding="UTF-8"?>
 <CustomField xmlns="http://soap.sforce.com/2006/04/metadata">

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

@@ -0,0 +1,13 @@
+export function customObjectGenerator(
+  config: { deploymentStatus: string; visibility: string } = { deploymentStatus: 'Deployed', visibility: 'Public' },
+) {
+  return `
+    <?xml version="1.0" encoding="UTF-8"?>
+    <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+        <deploymentStatus>${config.deploymentStatus}</deploymentStatus>
+        <description>test object for testing</description>
+        <label>MyTestObject</label>
+        <pluralLabel>MyFirstObjects</pluralLabel>
+        <visibility>${config.visibility}</visibility>
+    </CustomObject>`;
+}