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

Better file system API

"use strict";

const expect = require("chai").expect;
const matcher = require("../../lib/utils/matcher");

describe("matcher", () => {
  it("can test against one pattern passed as a string", () => {
    const 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", () => {
    const 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", () => {
    it("only basename", () => {
      const 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", () => {
      let 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 ./", () => {
      const test = matcher.create("/a", ["./b"]);
      expect(test("/a/b")).to.equal(true);
      expect(test("/b")).to.equal(false);
    });

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

  describe("possible tokens", () => {
    it("*", () => {
      let 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("**", () => {
      let 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", () => {
      const 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", () => {
      const 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", () => {
      const 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", () => {
      const 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", () => {
      const 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}", () => {
      const 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("?", () => {
      const 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", () => {
      const test = matcher.create("/", ["[0-9][0-9]"]);
      expect(test("/78")).to.equal(true);
      expect(test("/a78")).to.equal(false);
    });

    it("combining different tokens together", () => {
      const 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", () => {
      const test = matcher.create("/", ["#a"]);
      expect(test("/#a")).to.equal(true);
    });
  });

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

    it("selects everything except negated (multiple patterns)", () => {
      const 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", () => {
      const 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", () => {
    it("has no problem with matching dotfile", () => {
      const test = matcher.create("/", ".foo");
      expect(test("/.foo")).to.equal(true);
      expect(test("/foo")).to.equal(false);
    });

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