fs-jetpack/spec/utils/matcher.spec.js

Better file system API

var expect = require('chai').expect;
var matcher = require('../../lib/utils/matcher');

describe('matcher', function () {
  it('can test against one pattern passed as a string', function () {
    var test = matcher.create('/', 'a');
    expect(test('/a')).to.equal(true);
    expect(test('/b')).to.equal(false);
  });

  it('can test against many patterns passed as an array', function () {
    var test = matcher.create('/', ['a', 'b']);
    expect(test('/a')).to.equal(true);
    expect(test('/b')).to.equal(true);
    expect(test('/c')).to.equal(false);
  });

  describe('pattern types', function () {
    it('only basename', function () {
      var test = matcher.create('/', 'a');
      expect(test('/a')).to.equal(true);
      expect(test('/b/a')).to.equal(true);
      expect(test('/a/b')).to.equal(false);
    });

    it('absolute', function () {
      var test = matcher.create('/', ['/b']);
      expect(test('/b')).to.equal(true);
      expect(test('/a/b')).to.equal(false);
      test = matcher.create('/a', ['/b']);
      expect(test('/a/b')).to.equal(false);
    });

    it('relative with ./', function () {
      var test = matcher.create('/a', ['./b']);
      expect(test('/a/b')).to.equal(true);
      expect(test('/b')).to.equal(false);
    });

    it('relative (because has slash inside)', function () {
      var test = matcher.create('/a', ['b/c']);
      expect(test('/a/b/c')).to.equal(true);
      expect(test('/b/c')).to.equal(false);
    });
  });

  describe('possible tokens', function () {
    it('*', function () {
      var test = matcher.create('/', ['*']);
      expect(test('/a')).to.equal(true);
      expect(test('/a/b.txt')).to.equal(true);

      test = matcher.create('/', ['a*b']);
      expect(test('/ab')).to.equal(true);
      expect(test('/a_b')).to.equal(true);
      expect(test('/a__b')).to.equal(true);
    });

    it('**', function () {
      var test = matcher.create('/', ['**']);
      expect(test('/a')).to.equal(true);
      expect(test('/a/b')).to.equal(true);

      test = matcher.create('/', ['a/**/d']);
      expect(test('/a/d')).to.equal(true);
      expect(test('/a/b/d')).to.equal(true);
      expect(test('/a/b/c/d')).to.equal(true);
      expect(test('/a')).to.equal(false);
      expect(test('/d')).to.equal(false);
    });

    it('**/something', function () {
      var test = matcher.create('/', ['**/a']);
      expect(test('/a')).to.equal(true);
      expect(test('/x/a')).to.equal(true);
      expect(test('/x/y/a')).to.equal(true);
      expect(test('/a/b')).to.equal(false);
    });

    it('@(pattern|pattern) - exactly one of patterns', function () {
      var test = matcher.create('/', ['@(foo|bar)']);
      expect(test('/foo')).to.equal(true);
      expect(test('/bar')).to.equal(true);
      expect(test('/foobar')).to.equal(false);
    });

    it('+(pattern|pattern) - one or more of patterns', function () {
      var test = matcher.create('/', ['+(foo|bar)']);
      expect(test('/foo')).to.equal(true);
      expect(test('/bar')).to.equal(true);
      expect(test('/foobar')).to.equal(true);
      expect(test('/foobarbaz')).to.equal(false);
    });

    it('?(pattern|pattern) - zero or one of patterns', function () {
      var test = matcher.create('/', ['?(foo|bar)1']);
      expect(test('/1')).to.equal(true);
      expect(test('/foo1')).to.equal(true);
      expect(test('/bar1')).to.equal(true);
      expect(test('/foobar1')).to.equal(false);
    });

    it('*(pattern|pattern) - zero or more of patterns', function () {
      var test = matcher.create('/', ['*(foo|bar)1']);
      expect(test('/1')).to.equal(true);
      expect(test('/foo1')).to.equal(true);
      expect(test('/bar1')).to.equal(true);
      expect(test('/foobar1')).to.equal(true);
      expect(test('/barfoo1')).to.equal(true);
      expect(test('/foofoo1')).to.equal(true);
    });

    it('{a,b}', function () {
      var test = matcher.create('/', ['*.{jpg,png}']);
      expect(test('a.jpg')).to.equal(true);
      expect(test('b.png')).to.equal(true);
      expect(test('c.txt')).to.equal(false);
    });

    it('?', function () {
      var test = matcher.create('/', ['a?c']);
      expect(test('/abc')).to.equal(true);
      expect(test('/ac')).to.equal(false);
      expect(test('/abbc')).to.equal(false);
    });

    it('[...] - characters range', function () {
      var test = matcher.create('/', ['[0-9][0-9]']);
      expect(test('/78')).to.equal(true);
      expect(test('/a78')).to.equal(false);
    });

    it('combining different tokens together', function () {
      var test = matcher.create('/', ['+(f?o|bar*)']);
      expect(test('/f0o')).to.equal(true);
      expect(test('/f_o')).to.equal(true);
      expect(test('/bar')).to.equal(true);
      expect(test('/bar_')).to.equal(true);
      expect(test('/f_obar123')).to.equal(true);
      expect(test('/f__obar123')).to.equal(false);
    });

    it('comment character # has no special meaning', function () {
      var test = matcher.create('/', ['#a']);
      expect(test('/#a')).to.equal(true);
    });
  });

  describe('negation', function () {
    it('selects everything except negated', function () {
      var test = matcher.create('/', '!abc');
      expect(test('/abc')).to.equal(false);
      expect(test('/xyz')).to.equal(true);
    });

    it('selects everything except negated (multiple patterns)', function () {
      var test = matcher.create('/', ['!abc', '!xyz']);
      expect(test('/abc')).to.equal(false);
      expect(test('/xyz')).to.equal(false);
      expect(test('/whatever')).to.equal(true);
    });

    it('filters previous match if negation is farther in order', function () {
      var test = matcher.create('/', ['abc', '123', '!/xyz/**', '!789/**']);
      expect(test('/abc')).to.equal(true);
      expect(test('/456/123')).to.equal(true);
      expect(test('/xyz/abc')).to.equal(false);
      expect(test('/789/123')).to.equal(false);
      expect(test('/whatever')).to.equal(false);
    });
  });

  describe('dotfiles', function () {
    it('has no problem with matching dotfile', function () {
      var test = matcher.create('/', '.foo');
      expect(test('/.foo')).to.equal(true);
      expect(test('/foo')).to.equal(false);
    });

    it('dotfile negation', function () {
      var test = matcher.create('/', ['abc', '!.foo/**']);
      expect(test('/.foo/abc')).to.equal(false);
      test = matcher.create('/', ['abc', '!.foo/**']);
      expect(test('/foo/abc')).to.equal(true);
    });
  });
});