navigo/test/spec/Helpers.spec.js

A simple vanilla JavaScript router with a fallback for older browsers

import chai from 'chai';
import Navigo from '../../src';

chai.expect();

const { clean, match, root } = (new Navigo()).helpers;
const expect = chai.expect;
const routes = (...args) => args.map(r => {
  return { route: r };
});
const rootTestCases = [
  {
    source: 'http://site.com', routes: routes(),
    expected: 'http://site.com'
  },
  {
    source: 'https://site.com', routes: routes(),
    expected: 'https://site.com'
  },
  {
    source: 'http://site.com/a/b', routes: routes(),
    expected: 'http://site.com/a/b'
  },
  {
    source: 'http://site.com/a/b/', routes: routes(),
    expected: 'http://site.com/a/b'
  },
  {
    source: 'http://site.com/a/b/', routes: routes('/b'),
    expected: 'http://site.com/a'
  },
  {
    source: 'http://site.com/a/b/', routes: routes('/b', '/a/b/'),
    expected: 'http://site.com'
  },
  {
    source: 'http://site.com/a/b/', routes: routes('/a/b/', '/b', '/c'),
    expected: 'http://site.com'
  },
  {
    source: 'http://site.com/a/b/', routes: routes('/d/', '/a/b/', '/b', '/c'),
    expected: 'http://site.com'
  },
  {
    source: 'http://site.com/something/else/brother/blah', routes: routes('/d/', '/a/b/', '/b', '/c'),
    expected: 'http://site.com/something/else/brother/blah'
  },
  {
    source: 'http://site.com/something/else', routes: routes(''),
    expected: 'http://site.com/something/else'
  },
  {
    source: 'http://site.com/something/else', routes: routes('*'),
    expected: 'http://site.com/something/else'
  }
];

describe('Given the helper methods', function () {

  describe('when we use `clear` method', function () {
    it('should remove forward slashes', function () {
      expect(clean('/test/something/')).to.be.equal('^/test/something');
    });
    it('should remove multiple forward slashes', function () {
      expect(clean('///test/something///')).to.be.equal('^/test/something');
    });
    it('should leave the regular expression untouched', function () {
      expect(clean(/(\d)/).toString()).to.be.equal(/(\d)/.toString());
    });
  });

  describe('when we use `match` method', function () {
    it('should match a url if we have an empty string as a pattern', function () {
      expect(match('http://site.com/app/users/', routes(''))).to.not.be.false;
      expect(match('', routes(''))).to.not.be.false;
      expect(match('/some/path', routes(''))).to.not.be.false;
    });
    it('should not match if there is no pattern matching', function () {
      expect(match('http://site.com/app/users/', routes('missing'))).to.be.false;
    });
    it('should match and return parameters', function () {
      expect(match('http://site.com/app/users/42', routes('http://site.com/app/users/:id')).params).to.be.deep.equal({ id: '42' });
    });
    it('should match multiple parameters', function () {
      expect(match('http://site.com/app/users/42/save', routes('http://site.com/app/users/:id/:action')).params)
        .to.be.deep.equal({ id: '42', action: 'save' });
    });
    it('should not greedily match extra parameters at the end of a url if not terminated by a wildcard', function () {
      expect(match('/app/users/', routes('/app'))).to.be.false;
      expect(match('/app/users/42/save/something/else', routes('/app/users/:id/:action'))).to.be.false;
      expect(match('/app/something/users/blah', routes('/app/*/users'))).to.be.false;
    });
    it('should match if there is a wildcard used', function () {
      expect(match('/app/users/', routes('app/*'))).to.not.be.false;
      expect(match('/users/mmm/save/nnn/blah', routes('*/users/*/save/*/blah'))).to.not.be.false;
      expect(match('/app/users/comments/save', routes('app/*/comments/:action')).params)
        .to.be.deep.equal({ action: 'save' });
    });
  });

  describe('when we use the `root` method', function () {
    rootTestCases.forEach(testCase => {
      (testCase.only ? it.only : it)(`should get the root as ${testCase.expected} if we sent
        source: ${testCase.source}
        routes: ${testCase.routes.map(r => r.route).join(', ')}`, function () {
        expect(root(testCase.source, testCase.routes)).to.be.equal(testCase.expected);
      });
    });
  });
});