Strip url data from refs.

Instead of passing a new boolean flag to indicate which refs should be
included or not, just strip out the URL data for refs that are not part
of included archives and should not be linked to.

Author: mportiz08

src/components/ContentNode.vue

@@ -470,7 +470,7 @@ function renderNode(createElement, references) {
           url: reference.url,
           kind: reference.kind,
           role: reference.role,
-          isActive: reference.isFromIncludedArchive && node.isActive,
+          isActive: node.isActive,
           ideTitle: reference.ideTitle,
           titleStyle: reference.titleStyle,
           hasInlineFormatting: !!titleInlineContent,

src/components/ContentNode/Reference.vue

@@ -54,6 +54,9 @@ export default {
   name: 'Reference',
   computed: {
     isInternal({ url }) {
+      if (!url) {
+        return false;
+      }
       if (!url.startsWith('/') && !url.startsWith('#')) {
         // If the URL has a scheme, it's not an internal link.
         return false;
@@ -92,7 +95,7 @@ export default {
   props: {
     url: {
       type: String,
-      required: true,
+      required: false,
     },
     kind: {
       type: String,

src/components/ContentNode/ReferenceExternal.vue

@@ -9,7 +9,7 @@
 -->
 
 <template>
-  <a v-if="isActive" :href="url"><slot /></a>
+  <a v-if="url && isActive" :href="url"><slot /></a>
   <span v-else><slot /></span>
 </template>
 
@@ -19,7 +19,7 @@ export default {
   props: {
     url: {
       type: String,
-      required: true,
+      required: false,
     },
     isActive: {
       type: Boolean,

src/components/ContentNode/ReferenceInternal.vue

@@ -9,7 +9,7 @@
 -->
 
 <template>
-  <router-link v-if="isActive" :to="url"><slot /></router-link>
+  <router-link v-if="url && isActive" :to="url"><slot /></router-link>
   <span v-else><slot/></span>
 </template>
 
@@ -19,7 +19,7 @@ export default {
   props: {
     url: {
       type: String,
-      required: true,
+      required: false,
     },
     isActive: {
       type: Boolean,

src/components/DocumentationTopic/PrimaryContent/DeclarationToken/LinkableToken.vue

@@ -19,7 +19,7 @@ export default {
   render(createElement) {
     const reference = this.references[this.identifier];
     // internal and external link
-    if (reference && reference.isFromIncludedArchive && reference.url) {
+    if (reference && reference.url) {
       return createElement(Reference, {
         props: {
           url: reference.url,

src/components/DocumentationTopic/RelationshipsList.vue

@@ -21,7 +21,6 @@
         :role="symbol.role"
         :kind="symbol.kind"
         :url="symbol.url"
-        :isActive="symbol.isFromIncludedArchive"
       >{{symbol.title}}</Reference>
       <WordBreak v-else tag="code">{{symbol.title}}</WordBreak>
       <ConditionalConstraints

src/mixins/referencesProvider.js

@@ -32,15 +32,15 @@ export default {
           state: { references: originalRefs = {} },
         },
       } = this;
-      // if present, use `includedArchiveIdentifiers` data to determine which
-      // references should still be considered active or not
-      return Object.keys(originalRefs).reduce((newRefs, id) => ({
-        ...newRefs,
-        [id]: {
-          ...originalRefs[id],
-          isFromIncludedArchive: isFromIncludedArchive(id),
-        },
-      }), {});
+      // strip the `url` key from refs if their identifier comes from an
+      // archive that hasn't been included by DocC
+      return Object.keys(originalRefs).reduce((newRefs, id) => {
+        const { url, ...refWithoutUrl } = originalRefs[id];
+        return {
+          ...newRefs,
+          [id]: isFromIncludedArchive(id) ? originalRefs[id] : refWithoutUrl,
+        };
+      }, {});
     },
   },
   methods: {

tests/unit/components/ContentNode.spec.js

@@ -9,7 +9,6 @@
 */
 
 import { shallowMount, mount } from '@vue/test-utils';
-import AppStore from 'docc-render/stores/AppStore';
 import Aside from 'docc-render/components/ContentNode/Aside.vue';
 import CodeListing from 'docc-render/components/ContentNode/CodeListing.vue';
 import CodeVoice from 'docc-render/components/ContentNode/CodeVoice.vue';
@@ -1298,43 +1297,6 @@ describe('ContentNode', () => {
       const reference = wrapper.find('.content');
       expect(reference.isEmpty()).toBe(true);
     });
-
-    it('sets `isActive` for included archive content', () => {
-      const foo = {
-        identifier: 'doc://Foo/documentation/foo',
-        title: 'Foo',
-        url: '/documentation/foo',
-      };
-      const mountRef = (props = {}) => mountWithItem({
-        type: 'reference',
-        identifier: foo.identifier,
-        ...props,
-      }, {
-        [foo.identifier]: foo,
-      });
-
-      const wrapper1 = mountRef();
-      const ref1 = wrapper1.find('.content').find(Reference);
-      expect(ref1.exists()).toBe(true);
-      expect(ref1.props('isActive')).toBe(true);
-
-      AppStore.setIncludedArchiveIdentifiers(['Bar']);
-      const wrapper2 = mountRef();
-      const ref2 = wrapper2.find('.content').find(Reference);
-      expect(ref2.exists()).toBe(true);
-      expect(ref2.props('isActive')).toBe(false);
-
-      AppStore.setIncludedArchiveIdentifiers(['Bar', 'Foo']);
-      const wrapper3 = mountRef();
-      const ref3 = wrapper3.find('.content').find(Reference);
-      expect(ref3.exists()).toBe(true);
-      expect(ref3.props('isActive')).toBe(true);
-
-      const wrapper4 = mountRef({ isActive: false });
-      const ref4 = wrapper4.find('.content').find(Reference);
-      expect(ref4.exists()).toBe(true);
-      expect(ref4.props('isActive')).toBe(false);
-    });
   });
 
   describe('with type="strong"', () => {

tests/unit/components/ContentNode/LinksBlock.spec.js

@@ -41,7 +41,7 @@ const createWrapper = ({ propsData, ...others } = {}) => shallowMount(LinksBlock
 describe('LinksBlock', () => {
   it('renders the LinksBlock', () => {
     const wrapper = createWrapper();
-    expect(wrapper.find(TopicsLinkCardGrid).props()).toMatchObject({
+    expect(wrapper.find(TopicsLinkCardGrid).props()).toEqual({
       items: [references.foo, references.bar],
       topicStyle: defaultProps.blockStyle,
       usePager: false,
@@ -60,7 +60,7 @@ describe('LinksBlock', () => {
     // they are two, because one does not have a reference object
     const linkBlocks = wrapper.findAll(TopicsLinkBlock);
     expect(linkBlocks).toHaveLength(2);
-    expect(linkBlocks.at(0).props('topic')).toMatchObject(references.foo);
-    expect(linkBlocks.at(1).props('topic')).toMatchObject(references.bar);
+    expect(linkBlocks.at(0).props('topic')).toEqual(references.foo);
+    expect(linkBlocks.at(1).props('topic')).toEqual(references.bar);
   });
 });

tests/unit/components/DocumentationTopic/PrimaryContent/DeclarationToken/LinkableToken.spec.js

@@ -9,14 +9,13 @@
 */
 
 import { shallowMount } from '@vue/test-utils';
-import AppStore from 'docc-render/stores/AppStore';
 import LinkableToken
   from 'docc-render/components/DocumentationTopic/PrimaryContent/DeclarationToken/LinkableToken.vue';
 import Reference from 'docc-render/components/ContentNode/Reference.vue';
 
 describe('LinkableToken', () => {
   const foo = {
-    identifier: 'doc://Foo/documentation/foo',
+    identifier: 'foo',
     title: 'Foo',
     url: '/documentation/foo',
   };
@@ -71,44 +70,4 @@ describe('LinkableToken', () => {
     expect(link.props('url')).toBe(foo.url);
     expect(link.text()).toBe(foo.title);
   });
-
-  it('renders a link for references to included archive content', () => {
-    AppStore.setIncludedArchiveIdentifiers(['Foo']);
-    const wrapper = shallowMount(LinkableToken, {
-      ...defaultOpts,
-      provide: {
-        store: {
-          state: {
-            references: {
-              [foo.identifier]: foo,
-            },
-          },
-        },
-      },
-    });
-
-    const link = wrapper.find(Reference);
-    expect(link.exists()).toBe(true);
-    expect(link.props('url')).toBe(foo.url);
-    expect(link.text()).toBe(foo.title);
-  });
-
-  it('renders a span for references to non-included archive content', () => {
-    AppStore.setIncludedArchiveIdentifiers(['Bar']);
-    const wrapper = shallowMount(LinkableToken, {
-      ...defaultOpts,
-      provide: {
-        store: {
-          state: {
-            references: {
-              [foo.identifier]: foo,
-            },
-          },
-        },
-      },
-    });
-
-    expect(wrapper.is('span')).toBe(true);
-    expect(wrapper.text()).toBe(foo.title);
-  });
 });

tests/unit/components/DocumentationTopic/Relationships.spec.js

@@ -91,16 +91,18 @@ describe('Relationships', () => {
     expect(firstSection.props('anchor')).toBe(propsData.sections[0].anchor);
     const firstList = firstSection.find(List);
     expect(firstList.exists()).toBe(true);
-    expect(firstList.props('symbols')[0]).toMatchObject(foo);
-    expect(firstList.props('symbols')[1]).toMatchObject(bar);
+    expect(firstList.props('symbols')).toEqual([
+      foo,
+      bar,
+    ]);
     expect(firstList.props('type')).toEqual('inheritsFrom');
 
     const lastSection = sections.at(1);
     expect(lastSection.props('title')).toBe(propsData.sections[1].title);
     expect(lastSection.props('anchor')).toBe(null);
     const lastList = lastSection.find(List);
     expect(lastList.exists()).toBe(true);
-    expect(lastList.props('symbols')[0]).toMatchObject(baz);
+    expect(lastList.props('symbols')).toEqual([baz]);
     expect(firstList.props('type')).toEqual('inheritsFrom');
   });
 });

tests/unit/components/DocumentationTopic/TopicsLinkCardGridItem.spec.js

@@ -124,7 +124,7 @@ describe('TopicsLinkCardGridItem', () => {
         },
       },
     });
-    expect(wrapper.find(TopicTypeIcon).props('imageOverride')).toMatchObject(iconRef);
+    expect(wrapper.find(TopicTypeIcon).props('imageOverride')).toEqual(iconRef);
   });
 
   it('renders a TopicsLinkCardGridItem, in a none compact variant', async () => {

tests/unit/components/DocumentationTopic/TopicsTable.spec.js

@@ -116,7 +116,7 @@ describe('TopicsTable', () => {
     const firstSectionBlocks = sections.at(0).findAll(TopicsLinkBlock);
     expect(firstSectionBlocks.length).toBe(1);
     expect(firstSectionBlocks.at(0).classes('topic')).toBe(true);
-    expect(firstSectionBlocks.at(0).props()).toMatchObject({
+    expect(firstSectionBlocks.at(0).props()).toEqual({
       topic: foo,
       isSymbolDeprecated: false,
       isSymbolBeta: false,
@@ -125,7 +125,7 @@ describe('TopicsTable', () => {
     const lastSectionBlocks = sections.at(1).findAll(TopicsLinkBlock);
     expect(lastSectionBlocks.length).toBe(1);
     expect(lastSectionBlocks.at(0).classes('topic')).toBe(true);
-    expect(lastSectionBlocks.at(0).props()).toMatchObject({
+    expect(lastSectionBlocks.at(0).props()).toEqual({
       topic: baz,
       isSymbolDeprecated: false,
       isSymbolBeta: false,
@@ -139,15 +139,15 @@ describe('TopicsTable', () => {
 
     const firstGrid = sections.at(0).find(TopicsLinkCardGrid);
     expect(firstGrid.classes('topic')).toBe(true);
-    expect(firstGrid.props()).toMatchObject({
+    expect(firstGrid.props()).toEqual({
       topicStyle: TopicSectionsStyle.compactGrid,
       items: [foo],
       usePager: false,
     });
 
     const secondGrid = sections.at(1).find(TopicsLinkCardGrid);
     expect(secondGrid.classes('topic')).toBe(true);
-    expect(secondGrid.props()).toMatchObject({
+    expect(secondGrid.props()).toEqual({
       topicStyle: TopicSectionsStyle.compactGrid,
       items: [baz],
       usePager: false,

tests/unit/components/ReferenceUrlProvider.spec.js

@@ -53,7 +53,7 @@ describe('ReferenceUrlProvider', () => {
 
     const reference = references['doc://com.example.Test/tutorials/TechnologyX/Getting-Started'];
 
-    expect(assertProps).toMatchObject({
+    expect(assertProps).toEqual({
       title: reference.title,
       url: reference.url,
       urlWithParams: `${reference.url}?context=foo`,

tests/unit/components/Tutorial/Hero.spec.js

@@ -112,7 +112,7 @@ describe('Hero', () => {
     const metadata = wrapper.find(HeroMetadata);
     expect(metadata.props('estimatedTimeInMinutes')).toBe(estimatedTimeInMinutes);
     expect(metadata.props('projectFilesUrl')).toBe(projectFilesUrl);
-    expect(metadata.props('xcodeRequirement')).toMatchObject(xcodeRequirementReference);
+    expect(metadata.props('xcodeRequirement')).toEqual(xcodeRequirementReference);
   });
 
   it('renders a div for the background and selects the light variant', () => {