Create a glob package.

pkg/glob/test/match_test.dart

+// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'package:glob/glob.dart';
+import 'package:path/path.dart' as p;
+import 'package:unittest/unittest.dart';
+
+const ASCII_WITHOUT_SLASH = "\t\n\r !\"#\$%&'()*+`-.0123456789:;<=>?@ABCDEFGHIJ"
+    "KLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~";
+
+void main() {
+  test("literals match exactly", () {
+    expect("foo", contains(new Glob("foo")));
+    expect("foo/bar", contains(new Glob("foo/bar")));
+    expect("foo*", contains(new Glob("foo\\*")));

[Bob Nystrom, 2014/08/27 22:16:44]

Raw string here?

[nweiz, 2014/09/02 19:48:15]

Done.

+  });
+
+  group("star", () {
+    test("matches non-separator characters", () {
+      var glob = new Glob("*");
+      expect(ASCII_WITHOUT_SLASH, contains(glob));
+    });
+
+    test("matches the empty string", () {
+      var glob = new Glob("foo*");
+      expect("foo", contains(glob));
+    });

[Bob Nystrom, 2014/08/27 22:16:44]

What about a totally empty string?

expect("", contains(new Glob("*"));

I know it's meaningless for a real path, but it would be good to nail down the
edge case behavior.

[nweiz, 2014/09/02 19:48:15]

Done.

+
+    test("doesn't match separators", () {
+      var glob = new Glob("*");
+      expect("foo/bar", isNot(contains(glob)));
+    });
+  });
+
+  group("double star", () {
+    test("matches non-separator characters", () {
+      var glob = new Glob("**");
+      expect(ASCII_WITHOUT_SLASH, contains(glob));
+    });
+
+    test("matches the empty string", () {
+      var glob = new Glob("foo**");
+      expect("foo", contains(glob));
+    });
+
+    test("matches any level of nesting", () {
+      var glob = new Glob("**");
+      expect("a", contains(glob));
+      expect("a/b/c/d/e/f", contains(glob));
+    });
+
+    test("doesn't match unresolved dot dots", () {
+      expect("../foo/bar", isNot(contains(new Glob("**"))));
+    });
+
+    test("matches entities containing dot dots", () {
+      expect("..foo/bar", contains(new Glob("**")));
+      expect("foo../bar", contains(new Glob("**")));
+      expect("foo/..bar", contains(new Glob("**")));
+      expect("foo/bar..", contains(new Glob("**")));
+    });
+  });
+
+  group("any char", () {
+    test("matches any non-separator character", () {
+      var glob = new Glob("foo?");
+      for (var char in ASCII_WITHOUT_SLASH.split('')) {
+        expect("foo$char", contains(glob));
+      }
+    });
+
+    test("doesn't match a separator", () {
+      expect("foo/bar", isNot(contains(new Glob("foo?bar"))));
+    });
+  });
+
+  group("range", () {
+    test("can match individual characters", () {
+      var glob = new Glob("foo[a<.*]");
+      expect("fooa", contains(glob));
+      expect("foo<", contains(glob));
+      expect("foo.", contains(glob));
+      expect("foo*", contains(glob));
+      expect("foob", isNot(contains(glob)));
+      expect("foo>", isNot(contains(glob)));
+    });
+
+    test("can match a range of characters", () {
+      var glob = new Glob("foo[a-z]");
+      expect("fooa", contains(glob));
+      expect("foon", contains(glob));
+      expect("fooz", contains(glob));
+      expect("foo`", isNot(contains(glob)));
+      expect("foo{", isNot(contains(glob)));
+    });
+
+    test("can match multiple ranges of characters", () {
+      var glob = new Glob("foo[a-zA-Z]");
+      expect("fooa", contains(glob));
+      expect("foon", contains(glob));
+      expect("fooz", contains(glob));
+      expect("fooA", contains(glob));
+      expect("fooN", contains(glob));
+      expect("fooZ", contains(glob));
+      expect("foo?", isNot(contains(glob)));
+      expect("foo{", isNot(contains(glob)));
+    });
+
+    test("can match individual characters and ranges of characters", () {
+      var glob = new Glob("foo[a-z_A-Z]");
+      expect("fooa", contains(glob));
+      expect("foon", contains(glob));
+      expect("fooz", contains(glob));
+      expect("fooA", contains(glob));
+      expect("fooN", contains(glob));
+      expect("fooZ", contains(glob));
+      expect("foo_", contains(glob));
+      expect("foo?", isNot(contains(glob)));
+      expect("foo{", isNot(contains(glob)));
+    });
+
+    test("can be negated", () {
+      var glob = new Glob("foo[^a<.*]");
+      expect("fooa", isNot(contains(glob)));
+      expect("foo<", isNot(contains(glob)));
+      expect("foo.", isNot(contains(glob)));
+      expect("foo*", isNot(contains(glob)));
+      expect("foob", contains(glob));
+      expect("foo>", contains(glob));
+    });
+
+    test("never matches separators", () {
+      expect("foo/bar", isNot(contains(new Glob("foo[/]bar"))));

[Bob Nystrom, 2014/08/27 22:16:44]

Should it be an error to use "/" in a [] then?

[nweiz, 2014/09/02 19:48:15]

I'm not sure. On one hand, it won't ever match anything; on the other hand, I
don't think it makes sense to disallow ranges that include "/" (such as "!-~"),
and it seems weird to allow it there but forbid it in and of itself. What do you
think?

[Bob Nystrom, 2014/09/02 20:23:51]

Yeah, I think it makes sense to allow ranges that span it (even though it will
be ignored).

However, if a user uses "/" by itself, or as the endpoint of a range, it seems
like they are trying to express that the "/" is meaningful, and it's not going
to do anything useful for them. Given that, I think raising an error will be
more helpful than silently doing nothing.

[nweiz, 2014/09/02 23:20:16]

Done.

+      expect("foo/bar", isNot(contains(new Glob("foo[\t-~]bar"))));

[Bob Nystrom, 2014/08/27 22:16:44]

Document that \t-~ is a range that includes "/".

[nweiz, 2014/09/02 19:48:15]

Done.

+      expect("foo/bar", isNot(contains(new Glob("foo[^a]bar"))));
+    });
+
+    test("doesn't choke on RegExp-active characters", () {
+      var glob = new Glob(r"foo[\]].*");
+      expect("foobar", isNot(contains(glob)));
+      expect("foo].*", contains(glob));
+    });
+  });
+
+  group("options", () {
+    test("match if any of the options match", () {
+      var glob = new Glob("foo/{bar,baz,bang}");
+      expect("foo/bar", contains(glob));
+      expect("foo/baz", contains(glob));
+      expect("foo/bang", contains(glob));
+      expect("foo/qux", isNot(contains(glob)));
+    });
+
+    test("can contain nested operators", () {
+      var glob = new Glob("foo/{ba?,*az,ban{g,f}}");
+      expect("foo/bar", contains(glob));
+      expect("foo/baz", contains(glob));
+      expect("foo/bang", contains(glob));
+      expect("foo/qux", isNot(contains(glob)));
+    });
+
+    test("can conditionally match separators", () {
+      var glob = new Glob("foo/{bar,baz/bang}");
+      expect("foo/bar", contains(glob));
+      expect("foo/baz/bang", contains(glob));
+      expect("foo/baz", isNot(contains(glob)));
+      expect("foo/bar/bang", isNot(contains(glob)));
+    });
+  });
+
+  group("normalization", () {
+    test("extra slashes are ignored", () {
+      expect("foo//bar", contains(new Glob("foo/bar")));
+      expect("foo/", contains(new Glob("*")));
+    });
+
+    test("dot directories are ignored", () {
+      expect("foo/./bar", contains(new Glob("foo/bar")));
+      expect("foo/.", contains(new Glob("foo")));
+    });
+
+    test("dot dot directories are resolved", () {
+      expect("foo/../bar", contains(new Glob("bar")));
+      expect("../foo/bar", contains(new Glob("../foo/bar")));
+      expect("foo/../../bar", contains(new Glob("../bar")));
+    });
+
+    test("Windows separators are converted in a Windows context", () {
+      expect(r"foo\bar", contains(new Glob("foo/bar", context: p.windows)));
+      expect(r"foo\bar/baz",
+          contains(new Glob("foo/bar/baz", context: p.windows)));
+    });
+  });
+
+  test("an absolute path can be matched by a relative glob", () {
+    var path = p.absolute('foo/bar');
+    expect(path, contains(new Glob("foo/bar")));
+  });
+
+  test("a relative path can be matched by an absolute glob", () {
+    var pattern = p.absolute('foo/bar');
+    if (Platform.isWindows) pattern = pattern.replaceAll('\\', '/');
+    expect('foo/bar', contains(new Glob(pattern)));
+  });
+
+  group("with recursive: true", () {
+    var glob = new Glob("foo/bar", recursive: true);
+
+    test("still matches basic files", () {
+      expect("foo/bar", contains(glob));
+    });
+
+    test("matches subfiles", () {
+      expect("foo/bar/baz", contains(glob));
+      expect("foo/bar/baz/bang", contains(glob));
+    });
+
+    test("doesn't match suffixes", () {
+      expect("foo/barbaz", isNot(contains(glob)));
+      expect("foo/barbaz/bang", isNot(contains(glob)));
+    });
+  });
+
+  test("absolute POSIX paths", () {
+    expect("/foo/bar", contains(new Glob("/foo/bar", context: p.posix)));
+    expect("/foo/bar", isNot(contains(new Glob("**", context: p.posix))));
+    expect("/foo/bar", contains(new Glob("/**", context: p.posix)));
+  });
+
+  test("absolute Windows paths", () {
+    expect(r"C:\foo\bar", contains(new Glob("C:/foo/bar", context: p.windows)));
+    expect(r"C:\foo\bar", isNot(contains(new Glob("**", context: p.windows))));
+    expect(r"C:\foo\bar", contains(new Glob("C:/**", context: p.windows)));
+
+    expect(r"\\foo\bar\baz",
+        contains(new Glob("//foo/bar/baz", context: p.windows)));
+    expect(r"\\foo\bar\baz",
+        isNot(contains(new Glob("**", context: p.windows))));
+    expect(r"\\foo\bar\baz", contains(new Glob("//**", context: p.windows)));
+    expect(r"\\foo\bar\baz",
+        contains(new Glob("//foo/**", context: p.windows)));
+  });
+
+  test("absolute URL paths", () {
+    expect(r"http://foo.com/bar",
+        contains(new Glob("http://foo.com/bar", context: p.url)));
+    expect(r"http://foo.com/bar",
+        isNot(contains(new Glob("**", context: p.url))));
+    expect(r"http://foo.com/bar",
+        contains(new Glob("http://**", context: p.url)));
+    expect(r"http://foo.com/bar",
+        contains(new Glob("http://foo.com/**", context: p.url)));
+
+    expect("/foo/bar", contains(new Glob("/foo/bar", context: p.url)));
+    expect("/foo/bar", isNot(contains(new Glob("**", context: p.url))));
+    expect("/foo/bar", contains(new Glob("/**", context: p.url)));
+  });
+}