rocket/packages/engine/test-node/01a-urlPathConverter.test.js

import chai from 'chai';
import {
  sourceRelativeFilePathToOutputRelativeFilePath as sourceToOutput,
  urlToSourceRelativeFilePath,
} from '../src/file-header/urlPathConverter.js';

const { expect } = chai;

describe('sourceRelativeFilePathToOutputRelativeFilePath', () => {
  describe('html files output', () => {
    it('handles index.rocket.js files', async () => {
      expect(sourceToOutput(`index.rocket.js`)).to.equal('index.html');
      expect(sourceToOutput(`components/index.rocket.js`)).to.equal('components/index.html');
    });

    it('handles [name].rocket.js files', async () => {
      expect(sourceToOutput(`tabs.rocket.js`)).to.equal('tabs/index.html');
      expect(sourceToOutput(`components/accordion.rocket.js`)).to.equal(
        'components/accordion/index.html',
      );
    });

    it('handles [order]--[name].rocket.js files', async () => {
      expect(sourceToOutput(`01--tabs.rocket.js`)).to.equal('tabs/index.html');
      expect(sourceToOutput(`01--components/01--accordion.rocket.js`)).to.equal(
        'components/accordion/index.html',
      );
    });

    it('handles index.rocket.md files', async () => {
      expect(sourceToOutput(`index.rocket.md`)).to.equal('index.html');
      expect(sourceToOutput(`components/index.rocket.md`)).to.equal('components/index.html');
    });

    it('handles [name].rocket.md files', async () => {
      expect(sourceToOutput(`tabs.rocket.md`)).to.equal('tabs/index.html');
      expect(sourceToOutput(`components/accordion.rocket.md`)).to.equal(
        'components/accordion/index.html',
      );
    });

    it('handles index.rocket.html files', async () => {
      expect(sourceToOutput(`index.rocket.html`)).to.equal('index.html');
      expect(sourceToOutput(`components/index.rocket.html`)).to.equal('components/index.html');
    });

    it('handles [name].rocket.html files', async () => {
      expect(sourceToOutput(`tabs.rocket.html`)).to.equal('tabs/index.html');
      expect(sourceToOutput(`components/accordion.rocket.html`)).to.equal(
        'components/accordion/index.html',
      );
    });
  });

  describe('custom files output', () => {
    it('handles [name].[ext].rocket.js files', async () => {
      expect(sourceToOutput(`sitemap.xml.rocket.js`)).to.equal('sitemap.xml');
      expect(sourceToOutput(`components/sitemap.xml.rocket.js`)).to.equal('components/sitemap.xml');
    });

    it('handles [order]--[name].[ext].rocket.js files', async () => {
      expect(sourceToOutput(`01--sitemap.xml.rocket.js`)).to.equal('sitemap.xml');
      expect(sourceToOutput(`01--components/01--sitemap.xml.rocket.js`)).to.equal(
        'components/sitemap.xml',
      );
    });

    it('supports custom file extensions only with rocket.js files', async () => {
      expect(sourceToOutput(`sitemap.xml.rocket.md`)).to.equal('sitemap.xml/index.html');
      expect(sourceToOutput(`components/sitemap.xml.rocket.md`)).to.equal(
        'components/sitemap.xml/index.html',
      );
    });

    it('supports creation of custom md files', async () => {
      expect(sourceToOutput(`my-markdown.md.rocket.js`)).to.equal('my-markdown.md');
      expect(sourceToOutput(`components/my-markdown.md.rocket.js`)).to.equal(
        'components/my-markdown.md',
      );
    });

    it('doing index.html.rocket.js still works', async () => {
      expect(sourceToOutput(`index.html.rocket.js`)).to.equal('index.html');
      expect(sourceToOutput(`components/index.html.rocket.js`)).to.equal('components/index.html');
    });

    it('doing [name].html.rocket.js will not create folders with index files', async () => {
      expect(sourceToOutput(`tabs.html.rocket.js`)).to.equal('tabs.html');
      expect(sourceToOutput(`components/accordion.html.rocket.js`)).to.equal(
        'components/accordion.html',
      );
    });
  });
});

describe('urlToSourceRelativeFilePath', () => {
  function setupUrlToSource(fixturePath) {
    const pathToFixtureDir = new URL(
      `fixtures/01a-url-path-converters/${fixturePath}`,
      import.meta.url,
    ).pathname;
    return url => urlToSourceRelativeFilePath(url, pathToFixtureDir);
  }

  describe('html files output', () => {
    it('handles index.rocket.js urls', async () => {
      const urlToSource = setupUrlToSource('01-index-rocket-js-files');
      expect(await urlToSource(`/`)).to.equal('index.rocket.js');
      expect(await urlToSource(`/components/`)).to.equal('components/index.rocket.js');
    });

    it('handles [name].rocket.js files', async () => {
      const urlToSource = setupUrlToSource('02-named-rocket-js-files');
      expect(await urlToSource('/tabs/')).to.equal(`tabs.rocket.js`);
      expect(await urlToSource(`/components/accordion/`)).to.equal(
        'components/accordion.rocket.js',
      );
    });

    it('handles [order]--[name].rocket.js files', async () => {
      const urlToSource = setupUrlToSource('03-ordered-named-rocket-js-files');
      expect(await urlToSource(`/tabs/`)).to.equal('01--tabs.rocket.js');
      expect(await urlToSource(`/components/accordion/`)).to.equal(
        '01--components/01--accordion.rocket.js',
      );
    });

    it('handles index.rocket.md files', async () => {
      const urlToSource = setupUrlToSource('04-index-rocket-md-files');
      expect(await urlToSource(`/`)).to.equal('index.rocket.md');
      expect(await urlToSource(`/components/`)).to.equal('components/index.rocket.md');
    });

    it('handles [name].rocket.md files', async () => {
      const urlToSource = setupUrlToSource('05-named-rocket-md-files');
      expect(await urlToSource(`/tabs/`)).to.equal('tabs.rocket.md');
      expect(await urlToSource(`/components/accordion/`)).to.equal(
        'components/accordion.rocket.md',
      );
    });

    it('handles index.rocket.html files', async () => {
      const urlToSource = setupUrlToSource('07-index-rocket-html-files');
      expect(await urlToSource(`/`)).to.equal('index.rocket.html');
      expect(await urlToSource(`/components/`)).to.equal('components/index.rocket.html');
    });

    it('handles [name].rocket.html files', async () => {
      const urlToSource = setupUrlToSource('08-named-rocket-html-files');
      expect(await urlToSource(`/tabs/`)).to.equal('tabs.rocket.html');
      expect(await urlToSource(`/components/accordion/`)).to.equal(
        'components/accordion.rocket.html',
      );
    });
  });
});