#3128. Initial commit

tools/spec_coverage/README.md

@@ -0,0 +1,16 @@
+Command-line application that shows Dart specification coverage by co19 tests.
+
+// FIXME (sgrekhov)
+For now this tool takes a .txt version of the Dart specification as an input.
+It obtained from latex version as follows:
+
+pip install pylatexenc
+latex2text dartLangSpec.tex > spec.txt
+
+Path to `spec.txt` is specified in `config/config.json`
+
+// End of FIXME
+
+Usage:
+`$ cd Tools/spec_coverage`
+`$ dart bin/main.dart`

tools/spec_coverage/bin/main.dart

@@ -0,0 +1,42 @@
+import 'dart:convert' show jsonDecode;
+import 'dart:io';
+import 'package:spec_coverage/co19.dart';
+import 'package:spec_coverage/config.dart';
+import 'package:spec_coverage/spec.dart';
+
+main(List<String> args) {
+  Config config = Config.fromJson(readConfig());
+  Spec spec = Spec.fromTxt(config.specPath);
+  Co19 co19 = Co19(config.co19Dir);
+  findSpecChapters(co19.language.subDirs, spec.chapters);
+}
+
+void findSpecChapters(List<TestDir> testDirs, List<Chapter> chapters) {
+  for (TestDir td in testDirs) {
+    bool found = false;
+    for(Chapter ch in chapters) {
+      if (td.name.toLowerCase() == ch.co19DirName.toLowerCase()) {
+        print("Found spec for ${td.path}");
+        findSpecChapters(td.subDirs, ch.subChapters);
+        found = true;
+        break;
+      }
+    }
+    if (!found) {
+      print("Not found spec for ${td.path}. Chapters are:");
+      for (Chapter ch in chapters) {
+        print(ch.co19DirName);
+      }
+    }
+  }
+}
+
+Map<String, dynamic> readConfig() {
+  final configFile = File('config/config.json');
+  if (configFile.existsSync()) {
+    final contents = configFile.readAsStringSync();
+    return jsonDecode(contents);
+  } else {
+    throw Exception('Config file ${configFile.path} not found');
+  }
+}

tools/spec_coverage/config/config.json

@@ -0,0 +1,4 @@
+{
+  "specPath": "resources/spec.txt",
+  "co19Dir": "../.."
+}

tools/spec_coverage/lib/co19.dart

@@ -0,0 +1,68 @@
+import 'dart:io';
+
+class Co19 {
+  static const languageDirName = "Language";
+  late final TestDir root;
+  late final TestDir language;
+
+  Co19(String path) {
+    Directory dir = Directory(path);
+    if (!dir.existsSync()) {
+      throw Exception("Directory '$path' does not exists");
+    }
+    root = TestDir(dir);
+    for (TestDir td in root.subDirs) {
+      if (td.name == languageDirName) {
+        language = td;
+        break;
+      }
+    }
+  }
+}
+
+class TestDir {
+  final String path;
+  final List<TestDir> subDirs = [];
+  final List<TestFile> tests = [];
+
+  TestDir(Directory root) : path = resolvePath(root.path) {
+    List<FileSystemEntity> entities = root.listSync();
+    for (FileSystemEntity fse in entities) {
+      if (skip(fse)) {
+        continue;
+      }
+      FileStat fs = fse.statSync();
+      if (fs.type == FileSystemEntityType.directory) {
+        subDirs.add(TestDir(Directory(fse.path)));
+      } else if (fs.type == FileSystemEntityType.file) {
+        tests.add(TestFile(fse.path));
+      }
+    }
+  }
+
+  static String resolvePath(String relativePath) {
+    String basePath = Directory.current.path;
+    Uri baseUri = Uri.directory(basePath);
+    Uri resolvedUri = baseUri.resolve(relativePath);
+    return resolvedUri.toFilePath();
+  }
+
+  String get name => _entityName(path);
+
+  String _entityName(String p) =>
+      p.substring(p.lastIndexOf(Platform.pathSeparator) + 1);
+
+  bool skip(FileSystemEntity fse) {
+    // Skip directories like .git
+    if (_entityName(fse.path).startsWith(RegExp(r"\.[a-zA-Z]+"))) {
+      return true;
+    }
+    return false;
+  }
+}
+
+class TestFile {
+  final String path;
+
+  TestFile(this.path);
+}

tools/spec_coverage/lib/config.dart

@@ -0,0 +1,8 @@
+class Config {
+  final String co19Dir;
+  final String specPath;
+
+  Config.fromJson(Map<String, dynamic> json)
+      : co19Dir = json["co19Dir"],
+        specPath = json["specPath"];
+}

tools/spec_coverage/lib/spec.dart

@@ -0,0 +1,37 @@
+import 'dart:io';
+
+import 'package:spec_coverage/spec_parser.dart';
+
+class Spec {
+  late final List<Chapter> chapters;
+
+  Spec.fromTxt(String path) {
+    File file = File(path);
+    List<String> lines = file.readAsLinesSync();
+    SpecParser sp = SpecParser();
+    chapters = sp.parse(lines);
+  }
+}
+
+class Chapter {
+  ChapterNumber number;
+  String header;
+  late String co19DirName;
+  List<Chapter> subChapters = [];
+  List<String> lines = [];
+
+  Chapter({required this.number, required this.header})
+    : co19DirName = header.replaceAll(" ", "_");
+
+  @override
+  String toString() => "$number $header";
+}
+
+class ChapterNumber {
+  final List<int> numbers;
+
+  ChapterNumber(this.numbers);
+
+  @override
+  String toString() => numbers.join(".");
+}

tools/spec_coverage/lib/spec_parser.dart

@@ -0,0 +1,61 @@
+import 'spec.dart';
+
+class SpecParser {
+  static const pchar = "§";
+  int chapterCounter1 = 0;
+  int chapterCounter2 = 0;
+  int chapterCounter3 = 0;
+
+  List<Chapter> parse(List<String> lines) {
+    return _parseLevel(null, lines, 1);
+  }
+
+  List<Chapter> _parseLevel(Chapter? ch, List<String> lines, int level) {
+    final List<Chapter> parsed = [];
+    final List<String> chLines = [];
+
+    Pattern pattern = switch (level) {
+      1 => RegExp("$pchar [a-zA-Z]{2,}"),
+      2 => RegExp(" $pchar.$pchar [a-zA-Z]{2,}"),
+      3 => RegExp("  $pchar.$pchar.$pchar [a-zA-Z]{2,}"),
+      _ => throw "Wrong level number $level",
+    };
+
+    while (lines.isNotEmpty) {
+      String line = lines.removeAt(0);
+      if (line.startsWith(pattern)) {
+        if (ch != null) {
+          if (level < 3) {
+            ch.subChapters = _parseLevel(ch, chLines, level + 1);
+          }
+          ch.lines = chLines;
+          chLines.clear();
+        }
+        ChapterNumber cn = _getChapterNumber(line);
+        int start = cn.numbers.length == 1 ? 2 : 2 * cn.numbers.length + 1;
+        ch = Chapter(number: cn, header: line.substring(start).trim());
+        parsed.add(ch);
+      } else if (ch != null) {
+        chLines.add(line);
+      }
+    }
+    return parsed;
+  }
+
+  ChapterNumber _getChapterNumber(String line) {
+    if (line.startsWith("  $pchar.$pchar.$pchar")) {
+      return ChapterNumber([
+        chapterCounter1,
+        chapterCounter2,
+        ++chapterCounter3,
+      ]);
+    }
+    if (line.startsWith(" $pchar.$pchar")) {
+      chapterCounter3 = 0;
+      return ChapterNumber([chapterCounter1, ++chapterCounter2]);
+    }
+    chapterCounter2 = 0;
+    chapterCounter3 = 0;
+    return ChapterNumber([++chapterCounter1]);
+  }
+}

tools/spec_coverage/pubspec.yaml

@@ -0,0 +1,9 @@
+name: spec_coverage
+description: "Dart specification coverage CLI tool"
+
+publish_to: 'none'
+
+version: 0.0.1
+
+environment:
+  sdk: '^3.7.0'