[6.0] Include code and referenced text in metadata description (#862) (#864)

Include code and referenced text in metadata description (#862)

Resolves: rdar://129801569, rdar://130035323

Co-authored-by: Sergei Osipov <[email protected]>

Author: mportiz08

src/components/ContentNode.vue

@@ -673,13 +673,21 @@ export default {
     // without any inline formatting—other block kinds like asides will be
     // ignored in the resulting plaintext representation.
     plaintext() {
+      const { references = {} } = this;
       return this.reduce((text, node) => {
         if (node.type === BlockType.paragraph) {
           return `${text}\n`;
         }
+        if (node.type === InlineType.codeVoice) {
+          return `${text}${node.code}`;
+        }
         if (node.type === InlineType.text) {
           return `${text}${node.text}`;
         }
+        if (node.type === InlineType.reference) {
+          const title = references[node.identifier]?.title ?? '';
+          return `${text}${title}`;
+        }
         return text;
       }, '').trim();
     },

src/mixins/metadata.js

@@ -18,9 +18,11 @@ export default {
     // Extracts the first paragraph of plaintext from the given content tree,
     // which can be used for metadata purposes.
     extractFirstParagraphText(content = []) {
+      const { references = {} } = this;
       const plaintext = ContentNode.computed.plaintext.bind({
         ...ContentNode.methods,
         content,
+        references,
       })();
       return firstParagraph(plaintext);
     },

tests/unit/components/ContentNode.spec.js

@@ -2538,10 +2538,58 @@ describe('ContentNode', () => {
                 },
               ],
             },
+            {
+              type: ContentNode.BlockType.paragraph,
+              inlineContent: [
+                {
+                  type: ContentNode.InlineType.codeVoice,
+                  code: 'C',
+                },
+              ],
+            },
+          ],
+        },
+      });
+      expect(wrapper.vm.plaintext).toBe('A\nB\nC');
+    });
+
+    it('includes text from references', () => {
+      const wrapper = shallowMount(ContentNode, {
+        propsData: {
+          content: [
+            {
+              type: ContentNode.BlockType.paragraph,
+              inlineContent: [
+                {
+                  type: ContentNode.InlineType.text,
+                  text: 'A',
+                },
+                {
+                  type: ContentNode.InlineType.text,
+                  text: ' ',
+                },
+                {
+                  type: ContentNode.InlineType.reference,
+                  identifier: 'b',
+                },
+              ],
+            },
           ],
         },
+        provide: {
+          store: {
+            state: {
+              references: {
+                b: {
+                  title: 'B',
+                  url: '/b',
+                },
+              },
+            },
+          },
+        },
       });
-      expect(wrapper.vm.plaintext).toBe('A\nB');
+      expect(wrapper.vm.plaintext).toBe('A B');
     });
   });
 });

tests/unit/mixins/metadata.spec.js

@@ -45,6 +45,9 @@ const createWrapper = ({
       disableMetadata: () => disableMetadata,
       pageTitle: () => title,
       pageDescription: () => description,
+      references: () => ({
+        'ref-d': { title: 'd' },
+      }),
     },
   }, {
     mocks: {
@@ -99,7 +102,11 @@ describe('metadata', () => {
             },
             {
               type: 'text',
-              text: ' c',
+              text: ' c ',
+            },
+            {
+              type: 'reference',
+              identifier: 'ref-d',
             },
           ],
         },
@@ -114,7 +121,7 @@ describe('metadata', () => {
         },
       ];
       const wrapper = createWrapper(pageData);
-      expect(wrapper.vm.extractFirstParagraphText(content)).toBe('a b c');
+      expect(wrapper.vm.extractFirstParagraphText(content)).toBe('a b c d');
       expect(wrapper.vm.extractFirstParagraphText([])).toBe('');
     });
   });