Migrate uses values to store dart:* references directly (dart-lang#42)

* Migrate `uses` values to store dart:* references directly
  Makes the values stored in JSON output much less opaque
* Add description to PlatformInfo – along with other refactoring
* Removed the concept of 'angular' in `uses`

Author: kevmoo

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.3.0
+
+* Renamed `KnownPlatforms` to `PlatformFlags`. Also:
+  * Removed `mirrors`, `browser` and `standalone`.
+  * Renamed `native` to `dartExtension`.
+
+* `PlatformInfo`
+  * Now store `dart:*` references directly in `uses`.
+  * `worksInStandalone` renamed to `worksOnServer`.
+  * Other `.worksIn*` renamed to `worksOn*`.
+  * Added `String get description` which returns a simple `String` description
+    of the supported platforms. Examples: `everywhere`, `flutter`, 
+    `server, web`, `conflict`.
+  * Removed `angular` as a value in `uses`.
+
 ## 0.2.4
 
 * Detect native extensions.

lib/src/platform.dart

@@ -1,21 +1,18 @@
 library pana.platform;
 
+import 'dart:collection';
 import 'package:source_gen/generators/json_serializable.dart';
 
 import 'pubspec.dart';
 
 part 'platform.g.dart';
 
-abstract class KnownPlatforms {
-  static const String browser = 'browser';
-  static const String standalone = 'standalone';
+abstract class PlatformFlags {
+  /// Denotes a package that references Flutter in `pubspec.yaml`.
   static const String flutter = 'flutter';
-  static const String mirrors = 'mirrors';
 
-  /// Native extensions (Dart VM with C/C++ code).
-  static const String native = 'native';
-
-  static const String angular = 'angular';
+  /// Denotes a library that depends on a native extensions via `dart-ext:`
+  static const String dartExtension = 'dart-ext';
 }
 
 class PlatformSummary {
@@ -30,8 +27,8 @@ class PlatformSummary {
       _conflictsFlutter;
 
   bool get _conflictsFlutter =>
-      package.uses.contains(KnownPlatforms.flutter) &&
-      libraries.values.any((p) => !p.worksInFlutter);
+      package.uses.contains(PlatformFlags.flutter) &&
+      libraries.values.any((p) => !p.worksOnFlutter);
 }
 
 @JsonSerializable()
@@ -48,28 +45,54 @@ class PlatformInfo extends Object with _$PlatformInfoSerializerMixin {
 
   bool get hasConflict =>
       (!worksAnywhere) ||
-      (uses.contains(KnownPlatforms.flutter) && !worksInFlutter) ||
-      (uses.contains(KnownPlatforms.native) && !worksInStandalone);
+      (uses.contains(PlatformFlags.flutter) && !worksOnFlutter) ||
+      (uses.contains(PlatformFlags.dartExtension) && !worksOnServer);
+
+  bool get worksEverywhere => worksOnWeb && worksOnServer && worksOnFlutter;
+
+  bool get worksAnywhere => worksOnWeb || worksOnServer || worksOnFlutter;
+
+  bool get worksOnWeb =>
+      _hasNoUseOf(
+          [PlatformFlags.flutter, 'dart:ui', PlatformFlags.dartExtension]) &&
+      (_webPackages.any(uses.contains) || _hasNoUseOf(['dart:io']));
+
+  bool get worksOnServer =>
+      _hasNoUseOf(_webAnd(['dart:ui', PlatformFlags.flutter]));
 
-  bool get worksEverywhere =>
-      worksInBrowser && worksInStandalone && worksInFlutter;
+  bool get worksOnFlutter => _hasNoUseOf(_webAnd([
+        'dart:mirrors',
+        PlatformFlags.dartExtension,
+      ]));
 
-  bool get worksAnywhere =>
-      worksInBrowser || worksInStandalone || worksInFlutter;
+  String get description {
+    if (worksEverywhere) {
+      return 'everywhere';
+    }
 
-  bool get worksInBrowser =>
-      _hasNoUseOf([KnownPlatforms.flutter, KnownPlatforms.native]) &&
-      (uses.contains(KnownPlatforms.browser) ||
-          _hasNoUseOf([KnownPlatforms.standalone]));
+    var items = <String>[];
+    if (worksOnFlutter) {
+      items.add('flutter');
+    }
 
-  bool get worksInStandalone =>
-      _hasNoUseOf([KnownPlatforms.browser, KnownPlatforms.flutter]);
+    if (worksOnServer) {
+      items.add('server');
+    }
 
-  bool get worksInFlutter => _hasNoUseOf([
-        KnownPlatforms.browser,
-        KnownPlatforms.mirrors,
-        KnownPlatforms.native,
-      ]);
+    if (worksOnWeb) {
+      items.add('web');
+    }
+
+    if (items.isEmpty) {
+      assert(hasConflict);
+      return 'conflict';
+    }
+
+    return items.join(', ');
+  }
+
+  @override
+  String toString() => 'PlatformInfo: $description';
 
   bool _hasNoUseOf(Iterable<String> platforms) =>
       !platforms.any((p) => uses.contains(p));
@@ -78,7 +101,7 @@ class PlatformInfo extends Object with _$PlatformInfoSerializerMixin {
 PlatformInfo classifyPubspec(Pubspec pubspec) {
   final Set<String> uses = new Set();
   if (pubspec.hasFlutterKey || pubspec.dependsOnFlutterSdk) {
-    uses.add(KnownPlatforms.flutter);
+    uses.add(PlatformFlags.flutter);
   }
   return new PlatformInfo(uses);
 }
@@ -94,36 +117,22 @@ PlatformSummary classifyPlatforms(
 
 PlatformInfo classifyPlatform(Iterable<String> dependencies) {
   Set<String> libs = dependencies.toSet();
-  Set<String> uses = new Set();
-
-  if (_webPackages.any(libs.contains)) {
-    uses.add(KnownPlatforms.browser);
-  }
-
-  if (libs.contains('dart:io')) {
-    uses.add(KnownPlatforms.standalone);
-  }
-
-  if (libs.contains('dart:ui')) {
-    uses.add(KnownPlatforms.flutter);
-  }
+  Set<String> uses = new SplayTreeSet<String>();
 
-  if (libs.contains('dart:mirrors')) {
-    uses.add(KnownPlatforms.mirrors);
-  }
+  uses.addAll(libs.where((l) => _dartLibRegexp.hasMatch(l)));
 
   if (libs.any((String lib) => lib.startsWith('dart-ext:'))) {
-    uses.add(KnownPlatforms.native);
-  }
-
-  // packages
-  if (libs.any((p) => p.startsWith('package:angular2/'))) {
-    uses.add(KnownPlatforms.angular);
+    uses.add(PlatformFlags.dartExtension);
   }
 
   return new PlatformInfo(uses);
 }
 
+final _dartLibRegexp = new RegExp(r"^dart:[a-z_]+$");
+
+Iterable<String> _webAnd(Iterable<String> other) =>
+    [_webPackages, other].expand((s) => s);
+
 const List<String> _webPackages = const [
   'dart:html',
   'dart:indexed_db',

pubspec.yaml

@@ -1,6 +1,6 @@
 name: pana
 description: Evaluate the health and quality of a Dart package
-version: 0.2.4
+version: 0.3.0-dev
 homepage: https://github.com/dart-lang/pana
 author: Dart Team <[email protected]>
 

test/end2end/http_data.dart

@@ -183,7 +183,15 @@ final data = {
         "package:typed_data/typed_data.dart"
       ],
       "platform": {
-        "uses": ["browser", "standalone"]
+        "uses": [
+          'dart:async',
+          'dart:collection',
+          'dart:convert',
+          'dart:html',
+          'dart:io',
+          'dart:math',
+          'dart:typed_data'
+        ]
       }
     },
     "lib/http.dart": {
@@ -340,7 +348,14 @@ final data = {
         "package:typed_data/typed_data.dart"
       ],
       "platform": {
-        "uses": ["standalone"]
+        "uses": [
+          'dart:async',
+          'dart:collection',
+          'dart:convert',
+          'dart:io',
+          'dart:math',
+          'dart:typed_data'
+        ]
       }
     },
     "lib/src/base_client.dart": {
@@ -573,7 +588,14 @@ final data = {
         "package:typed_data/typed_data.dart"
       ],
       "platform": {
-        "uses": ["standalone"]
+        "uses": [
+          'dart:async',
+          'dart:collection',
+          'dart:convert',
+          'dart:io',
+          'dart:math',
+          'dart:typed_data'
+        ]
       }
     },
     "test/html/client_test.dart": {

test/end2end/pub_server_data.dart

@@ -127,7 +127,9 @@ final data = {
         "package:pub_semver/src/version_range.dart",
         "package:pub_semver/src/version_union.dart"
       ],
-      "platform": {"uses": []}
+      "platform": {
+        "uses": ['dart:async', 'dart:collection', 'dart:math']
+      }
     },
     "lib/shelf_pubserver.dart": {
       "uri": "package:pub_server/shelf_pubserver.dart",
@@ -328,7 +330,16 @@ final data = {
         "package:yaml/src/yaml_node_wrapper.dart",
         "package:yaml/yaml.dart"
       ],
-      "platform": {"uses": []}
+      "platform": {
+        "uses": [
+          'dart:async',
+          'dart:collection',
+          'dart:convert',
+          'dart:isolate',
+          'dart:math',
+          'dart:typed_data'
+        ]
+      }
     },
     "test/shelf_pubserver_test.dart": {
       "uri": "path:pub_server/test/shelf_pubserver_test.dart",