@ons/design-system 50.0.1 → 53.0.0

package/components/footer/_macro.spec.js

@@ -0,0 +1,678 @@
+/** @jest-environment jsdom */
+
+import * as cheerio from 'cheerio';
+
+import axe from '../../tests/helpers/axe';
+import { mapAll } from '../../tests/helpers/cheerio';
+import { renderComponent, templateFaker } from '../../tests/helpers/rendering';
+
+const EXAMPLE_POWERED_BY_PARAM = {
+  logo: 'person',
+  alt: 'Person alt text',
+};
+
+const EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM = {
+  logo: 'person',
+  alt: 'Person alt text',
+  partnership: 'Prefix text string',
+};
+
+const EXAMPLE_OGL_LINK_PARAM = {
+  pre: 'All content is available under the',
+  link: 'Open Government Licence v3.0',
+  url: 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/',
+  post: ', except where otherwise stated',
+};
+
+const EXAMPLE_COLS_PARAM = [
+  {
+    title: 'First column',
+    itemsList: [
+      {
+        url: '/example-link-a',
+        text: 'Example Link A',
+      },
+    ],
+  },
+  {
+    title: 'Second column',
+    itemsList: [
+      {
+        url: '/example-link-b',
+        text: 'Example Link B',
+      },
+    ],
+  },
+];
+
+const EXAMPLE_ROWS_PARAM = [
+  {
+    itemsList: [
+      {
+        url: '/example-link-a',
+        text: 'Example Link A',
+      },
+    ],
+  },
+  {
+    itemsList: [
+      {
+        url: '/example-link-b',
+        text: 'Example Link B',
+      },
+    ],
+  },
+];
+
+const EXAMPLE_LEGAL_PARAM = [
+  {
+    itemsList: [
+      {
+        url: '/example-legal-link-a',
+        text: 'Example Legal Link A',
+      },
+    ],
+  },
+  {
+    itemsList: [
+      {
+        url: '/example-legal-link-b',
+        text: 'Example Legal Link B',
+      },
+    ],
+  },
+];
+
+describe('macro: footer', () => {
+  it('decorates container block with `wide` modifier when the `wide` parameter is provided', () => {
+    const $ = cheerio.load(
+      renderComponent('footer', {
+        wide: true,
+      }),
+    );
+
+    const hasClass = $('.ons-container').hasClass('ons-container--wide');
+    expect(hasClass).toBe(true);
+  });
+
+  it('does not decorate container block with `wide` modifier when the `wide` parameter is not provided', () => {
+    const $ = cheerio.load(renderComponent('footer', {}));
+
+    const hasClass = $('.ons-container').hasClass('ons-container--wide');
+    expect(hasClass).toBe(false);
+  });
+
+  it('has additionally provided `attributes` on the `body` element', () => {
+    const $ = cheerio.load(
+      renderComponent('footer', {
+        attributes: {
+          a: '123',
+          b: '456',
+        },
+      }),
+    );
+
+    expect($('.ons-footer__body').attr('a')).toBe('123');
+    expect($('.ons-footer__body').attr('b')).toBe('456');
+  });
+
+  describe('OGL link', () => {
+    const params = {
+      OGLLink: EXAMPLE_OGL_LINK_PARAM,
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders OGL icon', () => {
+      const faker = templateFaker();
+      const iconsSpy = faker.spy('icons');
+
+      faker.renderComponent('footer', params);
+
+      expect(iconsSpy.occurrences).toContainEqual(expect.objectContaining({ iconType: 'ogl' }));
+    });
+
+    it('renders raw HTML when `HTML` is provided', () => {
+      const $ = cheerio.load(
+        renderComponent('footer', {
+          OGLLink: {
+            ...params.OGLLink,
+            HTML: '<strong>Bold text.</strong>',
+          },
+        }),
+      );
+
+      const licenseHtml = $('.ons-footer__license').html();
+      expect(licenseHtml).toContain('<strong>Bold text.</strong>');
+    });
+
+    it('renders link using the external link component', () => {
+      const faker = templateFaker();
+      const externalLinkSpy = faker.spy('external-link');
+
+      faker.renderComponent('footer', params);
+
+      expect(externalLinkSpy.occurrences).toContainEqual(
+        expect.objectContaining({
+          url: 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/',
+          linkText: 'Open Government Licence v3.0',
+        }),
+      );
+    });
+
+    it('renders `post` content when provided', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const licenseHtml = $('.ons-footer__license').html();
+      expect(licenseHtml).toContain(', except where otherwise stated');
+    });
+
+    it('renders welsh `post` content when `lang:cy` provided and `OGLLink` is "true"', () => {
+      const $ = cheerio.load(
+        renderComponent('footer', {
+          lang: 'cy',
+          OGLLink: true,
+        }),
+      );
+
+      const licenseHtml = $('.ons-footer__license').html();
+      expect(licenseHtml).toContain(', oni bai y nodir fel arall');
+    });
+  });
+
+  describe('warning', () => {
+    const params = {
+      footerWarning: 'Footer warning text with <strong>bold</strong> content.',
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders warning element', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const warningHtml = $('.ons-footer__warning').html();
+      expect(warningHtml).toContain('Footer warning text with <strong>bold</strong> content.');
+    });
+
+    it('is not rendered when `footerWarning` is not provided', () => {
+      const $ = cheerio.load(renderComponent('footer', {}));
+
+      expect($('.ons-footer__warning').length).toBe(0);
+    });
+
+    it('renders warning text using the panel component', () => {
+      const faker = templateFaker();
+      const panelSpy = faker.spy('panel');
+
+      faker.renderComponent('footer', params);
+
+      expect(panelSpy.occurrences).toContainEqual(
+        expect.objectContaining({
+          type: 'warn',
+          classes: 'ons-panel--warn--footer',
+        }),
+      );
+    });
+  });
+
+  describe('copyright', () => {
+    const params = {
+      copyrightDeclaration: {
+        copyright: 'Crown copyright and database rights 2020 OS 100019153.',
+        text: 'Use of address data is subject to the terms and conditions.',
+      },
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders copyright declaration', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const text = $('.ons-footer__copyright').text();
+      expect(text).toBe(
+        '© Crown copyright and database rights 2020 OS 100019153.  Use of address data is subject to the terms and conditions.',
+      );
+    });
+
+    it('is not rendered when `copyrightDeclaration` is not provided', () => {
+      const $ = cheerio.load(renderComponent('footer', {}));
+
+      expect($('.ons-footer__copyright').length).toBe(0);
+    });
+  });
+
+  describe('cols', () => {
+    const params = {
+      cols: EXAMPLE_COLS_PARAM,
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders expected column titles', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const titleHeadings = mapAll($('.ons-footer__heading'), node => node.text().trim());
+      expect(titleHeadings).toEqual(['First column', 'Second column']);
+    });
+
+    it('renders expected lists using list component', () => {
+      const faker = templateFaker();
+      const listsSpy = faker.spy('lists');
+
+      faker.renderComponent('footer', params);
+
+      const itemsList1 = listsSpy.occurrences[0].itemsList;
+      expect(itemsList1[0]).toHaveProperty('url', '/example-link-a');
+      expect(itemsList1[0]).toHaveProperty('text', 'Example Link A');
+
+      const itemsList2 = listsSpy.occurrences[1].itemsList;
+      expect(itemsList2[0]).toHaveProperty('url', '/example-link-b');
+      expect(itemsList2[0]).toHaveProperty('text', 'Example Link B');
+    });
+  });
+
+  describe('rows', () => {
+    const params = {
+      rows: EXAMPLE_ROWS_PARAM,
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders expected lists using list component', () => {
+      const faker = templateFaker();
+      const listsSpy = faker.spy('lists');
+
+      faker.renderComponent('footer', params);
+
+      const itemsList1 = listsSpy.occurrences[0].itemsList;
+      expect(itemsList1[0]).toHaveProperty('url', '/example-link-a');
+      expect(itemsList1[0]).toHaveProperty('text', 'Example Link A');
+
+      const itemsList2 = listsSpy.occurrences[1].itemsList;
+      expect(itemsList2[0]).toHaveProperty('url', '/example-link-b');
+      expect(itemsList2[0]).toHaveProperty('text', 'Example Link B');
+    });
+  });
+
+  describe('legal', () => {
+    const params = {
+      legal: EXAMPLE_LEGAL_PARAM,
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders expected lists using list component', () => {
+      const faker = templateFaker();
+      const listsSpy = faker.spy('lists');
+
+      faker.renderComponent('footer', params);
+
+      const itemsList1 = listsSpy.occurrences[0].itemsList;
+      expect(itemsList1[0]).toHaveProperty('url', '/example-legal-link-a');
+      expect(itemsList1[0]).toHaveProperty('text', 'Example Legal Link A');
+
+      const itemsList2 = listsSpy.occurrences[1].itemsList;
+      expect(itemsList2[0]).toHaveProperty('url', '/example-legal-link-b');
+      expect(itemsList2[0]).toHaveProperty('text', 'Example Legal Link B');
+    });
+  });
+
+  describe('powered by logo', () => {
+    describe.each([
+      [
+        'the `lang` parameter is not provided',
+        {},
+        {
+          iconType: 'ons-logo-en',
+          altText: 'Office for National Statistics',
+        },
+      ],
+      [
+        'the `lang` parameter is "en"',
+        { lang: 'en' },
+        {
+          iconType: 'ons-logo-en',
+          altText: 'Office for National Statistics',
+        },
+      ],
+      [
+        'the `lang` parameter is "cy"',
+        { lang: 'cy' },
+        {
+          iconType: 'ons-logo-cy',
+          altText: 'Swyddfa Ystadegau Gwladol',
+        },
+      ],
+    ])('where %s', (_, langParams, defaultIcon) => {
+      describe.each([
+        [
+          'the `poweredBy` and `OGLLink` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_PARAM,
+            OGLLink: EXAMPLE_OGL_LINK_PARAM,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy.partnership` and `OGLLink` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM,
+            OGLLink: EXAMPLE_OGL_LINK_PARAM,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy` parameter is not provided but the `legal` parameter is provided',
+          {
+            legal: EXAMPLE_LEGAL_PARAM,
+          },
+          defaultIcon,
+        ],
+        [
+          'the `poweredBy` parameter is not provided but the `legal` and `OGLLink` parameters are provided',
+          {
+            legal: EXAMPLE_LEGAL_PARAM,
+            OGLLink: EXAMPLE_OGL_LINK_PARAM,
+          },
+          defaultIcon,
+        ],
+        [
+          'the `poweredBy` and `legal` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_PARAM,
+            legal: EXAMPLE_LEGAL_PARAM,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy.partnership` and `legal` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM,
+            legal: EXAMPLE_LEGAL_PARAM,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy` and `crest` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_PARAM,
+            crest: true,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy.partnership` and `crest` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM,
+            crest: true,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy`, `legal` and `crest` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_PARAM,
+            legal: EXAMPLE_LEGAL_PARAM,
+            crest: true,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy.partnership`, `legal` and `crest` parameters are provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM,
+            legal: EXAMPLE_LEGAL_PARAM,
+            crest: true,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy` parameter is provided but the `legal` and `crest` parameters are not provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_PARAM,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+        [
+          'the `poweredBy.partnership` parameter is provided but the `legal` and `crest` parameters are not provided',
+          {
+            poweredBy: EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM,
+          },
+          {
+            iconType: 'person',
+            altText: 'Person alt text',
+          },
+        ],
+      ])('where %s', (_, poweredByParams, expectedIcon) => {
+        const params = {
+          ...langParams,
+          ...poweredByParams,
+        };
+
+        it('passes jest-axe checks', async () => {
+          const $ = cheerio.load(renderComponent('footer', params));
+
+          const results = await axe($.html());
+          expect(results).toHaveNoViolations();
+        });
+
+        it('renders the expected icon', () => {
+          const faker = templateFaker();
+          const iconsSpy = faker.spy('icons');
+
+          faker.renderComponent('footer', params);
+
+          expect(iconsSpy.occurrences).toContainEqual(expect.objectContaining(expectedIcon));
+        });
+      });
+    });
+  });
+
+  describe('save and sign out button', () => {
+    const params = {
+      button: {
+        id: 'save-and-sign-out',
+        type: 'button',
+        classes: 'extra-class',
+        text: 'Save changes and sign out',
+        html: '<strong>html</strong>',
+        name: 'button-name',
+        value: 'button-value',
+        attributes: { a: 42 },
+        url: 'https://example.com/',
+        buttonStyle: 'mobile',
+        iconType: 'exit',
+        iconPosition: 'before',
+      },
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders "Save changes and sign out" button using the button component', () => {
+      const faker = templateFaker();
+      const buttonSpy = faker.spy('button');
+
+      faker.renderComponent('footer', params);
+
+      expect(buttonSpy.occurrences).toContainEqual(
+        expect.objectContaining({
+          ...params.button,
+          variants: 'ghost',
+        }),
+      );
+    });
+  });
+
+  describe('new tab warning', () => {
+    const params = {
+      newTabWarning: 'The following links open in a <strong>new tab</strong>',
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders new tab warning element', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const warningHtml = $('.ons-footer__new-tab-warning').html();
+      expect(warningHtml).toContain('The following links open in a <strong>new tab</strong>');
+    });
+
+    it('is not rendered when `newTabWarning` is not provided', () => {
+      const $ = cheerio.load(renderComponent('footer', {}));
+
+      expect($('.ons-footer__new-tab-warning').length).toBe(0);
+    });
+  });
+
+  describe('crest', () => {
+    const params = {
+      crest: true,
+      legal: true,
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders crest icon when `crest` parameter is provided', () => {
+      const faker = templateFaker();
+      const iconsSpy = faker.spy('icons');
+
+      faker.renderComponent('footer', params);
+
+      expect(iconsSpy.occurrences).toContainEqual(expect.objectContaining({ iconType: 'crest' }));
+    });
+
+    it('renders "crest" element', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      expect($('.ons-footer__crest').length).toBe(1);
+    });
+  });
+
+  describe('partnership', () => {
+    const params = {
+      poweredBy: EXAMPLE_POWERED_BY_WITH_PARTNERSHIP_PARAM,
+    };
+
+    it('passes jest-axe checks', async () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      const results = await axe($.html());
+      expect(results).toHaveNoViolations();
+    });
+
+    it('renders ONS icon when `partnership` parameter is provided', () => {
+      const faker = templateFaker();
+      const iconsSpy = faker.spy('icons');
+
+      faker.renderComponent('footer', params);
+
+      expect(iconsSpy.occurrences).toContainEqual(expect.objectContaining({ iconType: 'ons-logo-en' }));
+    });
+
+    it('renders "poweredBy" icon when `partnership` parameter is provided', () => {
+      const faker = templateFaker();
+      const iconsSpy = faker.spy('icons');
+
+      faker.renderComponent('footer', params);
+
+      expect(iconsSpy.occurrences).toContainEqual(expect.objectContaining({ iconType: 'person' }));
+    });
+
+    it('renders "poweredBy" element when `partnership` parameter is provided', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      expect($('.ons-footer__poweredby').length).toBe(1);
+    });
+
+    it('renders "partnership" and "prefix" elements when `partnership` parameter is provided', () => {
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      expect($('.ons-footer__partnership').length).toBe(1);
+      expect($('.ons-footer__partnership-prefix').length).toBe(1);
+    });
+
+    it('does not render "partnership" element when `partnership` parameter is not provided', () => {
+      const params = {
+        poweredBy: {
+          logo: 'person',
+          alt: 'Person alt text',
+        },
+      };
+      const $ = cheerio.load(renderComponent('footer', params));
+
+      expect($('.ons-footer__partnership').length).toBe(0);
+    });
+  });
+});