Migrate checked_yaml to null safety (#762)

Fixes #758

Author: kevmoo

.github/workflows/dart.yml

@@ -36,16 +36,16 @@ jobs:
       - run: pub global activate mono_repo 3.3.0
       - run: pub global run mono_repo generate --validate
   job_002:
-    name: "OS: linux; SDK: dev; PKGS: _test_yaml, checked_yaml, json_annotation, json_serializable; TASKS: [`dartfmt -n --set-exit-if-changed .`, `dartanalyzer --fatal-warnings --fatal-infos .`]"
+    name: "OS: linux; SDK: dev; PKGS: _test_yaml, checked_yaml, example, json_annotation, json_serializable; TASKS: [`dartfmt -n --set-exit-if-changed .`, `dartanalyzer --fatal-infos .`]"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@v2
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;dart:dev;packages:_test_yaml-checked_yaml-json_annotation-json_serializable;commands:dartfmt-dartanalyzer_0"
+          key: "os:ubuntu-latest;pub-cache-hosted;dart:dev;packages:_test_yaml-checked_yaml-example-json_annotation-json_serializable;commands:dartfmt-dartanalyzer"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;dart:dev;packages:_test_yaml-checked_yaml-json_annotation-json_serializable
+            os:ubuntu-latest;pub-cache-hosted;dart:dev;packages:_test_yaml-checked_yaml-example-json_annotation-json_serializable
             os:ubuntu-latest;pub-cache-hosted;dart:dev
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -55,56 +55,9 @@ jobs:
       - run: dart --version
       - uses: actions/checkout@v2
       - env:
-          PKGS: _test_yaml checked_yaml json_annotation json_serializable
+          PKGS: _test_yaml checked_yaml example json_annotation json_serializable
           TRAVIS_OS_NAME: linux
-        run: tool/ci.sh dartfmt dartanalyzer_0
-  job_005:
-    name: "OS: linux; SDK: 2.7.0; PKG: checked_yaml; TASKS: `dartanalyzer --fatal-warnings .`"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cache Pub hosted dependencies
-        uses: actions/cache@v2
-        with:
-          path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;dart:2.7.0;packages:checked_yaml;commands:dartanalyzer_1"
-          restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;dart:2.7.0;packages:checked_yaml
-            os:ubuntu-latest;pub-cache-hosted;dart:2.7.0
-            os:ubuntu-latest;pub-cache-hosted
-            os:ubuntu-latest
-      - uses: cedx/setup-dart@v2
-        with:
-          release-channel: stable
-          version: "2.7.0"
-      - run: dart --version
-      - uses: actions/checkout@v2
-      - env:
-          PKGS: checked_yaml
-          TRAVIS_OS_NAME: linux
-        run: tool/ci.sh dartanalyzer_1
-  job_008:
-    name: "OS: linux; SDK: dev; PKG: example; TASKS: [`dartfmt -n --set-exit-if-changed .`, `dartanalyzer --fatal-warnings .`]"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cache Pub hosted dependencies
-        uses: actions/cache@v2
-        with:
-          path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;dart:dev;packages:example;commands:dartfmt-dartanalyzer_1"
-          restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;dart:dev;packages:example
-            os:ubuntu-latest;pub-cache-hosted;dart:dev
-            os:ubuntu-latest;pub-cache-hosted
-            os:ubuntu-latest
-      - uses: cedx/setup-dart@v2
-        with:
-          release-channel: dev
-      - run: dart --version
-      - uses: actions/checkout@v2
-      - env:
-          PKGS: example
-          TRAVIS_OS_NAME: linux
-        run: tool/ci.sh dartfmt dartanalyzer_1
+        run: tool/ci.sh dartfmt dartanalyzer
   job_003:
     name: "OS: linux; SDK: dev; PKGS: _test_yaml, checked_yaml, example, json_serializable; TASKS: `pub run test`"
     runs-on: ubuntu-latest
@@ -131,38 +84,7 @@ jobs:
     needs:
       - job_001
       - job_002
-      - job_005
-      - job_008
-  job_006:
-    name: "OS: linux; SDK: 2.7.0; PKG: checked_yaml; TASKS: `pub run test`"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cache Pub hosted dependencies
-        uses: actions/cache@v2
-        with:
-          path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;dart:2.7.0;packages:checked_yaml;commands:test_0"
-          restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;dart:2.7.0;packages:checked_yaml
-            os:ubuntu-latest;pub-cache-hosted;dart:2.7.0
-            os:ubuntu-latest;pub-cache-hosted
-            os:ubuntu-latest
-      - uses: cedx/setup-dart@v2
-        with:
-          release-channel: stable
-          version: "2.7.0"
-      - run: dart --version
-      - uses: actions/checkout@v2
-      - env:
-          PKGS: checked_yaml
-          TRAVIS_OS_NAME: linux
-        run: tool/ci.sh test_0
-    needs:
-      - job_001
-      - job_002
-      - job_005
-      - job_008
-  job_009:
+  job_005:
     name: "OS: linux; SDK: dev; PKG: json_serializable; TASKS: `pub run test -p chrome`"
     runs-on: ubuntu-latest
     steps:
@@ -188,8 +110,6 @@ jobs:
     needs:
       - job_001
       - job_002
-      - job_005
-      - job_008
   job_004:
     name: "OS: linux; SDK: dev; PKGS: _test_yaml, checked_yaml, example, json_serializable; TASKS: `pub run test --run-skipped -t presubmit-only test/ensure_build_test.dart`"
     runs-on: ubuntu-latest
@@ -215,33 +135,4 @@ jobs:
         run: tool/ci.sh test_1
     needs:
       - job_003
-      - job_006
-      - job_009
-  job_007:
-    name: "OS: linux; SDK: 2.7.0; PKG: checked_yaml; TASKS: `pub run test --run-skipped -t presubmit-only test/ensure_build_test.dart`"
-    runs-on: ubuntu-latest
-    steps:
-      - name: Cache Pub hosted dependencies
-        uses: actions/cache@v2
-        with:
-          path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;dart:2.7.0;packages:checked_yaml;commands:test_1"
-          restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;dart:2.7.0;packages:checked_yaml
-            os:ubuntu-latest;pub-cache-hosted;dart:2.7.0
-            os:ubuntu-latest;pub-cache-hosted
-            os:ubuntu-latest
-      - uses: cedx/setup-dart@v2
-        with:
-          release-channel: stable
-          version: "2.7.0"
-      - run: dart --version
-      - uses: actions/checkout@v2
-      - env:
-          PKGS: checked_yaml
-          TRAVIS_OS_NAME: linux
-        run: tool/ci.sh test_1
-    needs:
-      - job_003
-      - job_006
-      - job_009
+      - job_005

_test_yaml/mono_pkg.yaml

@@ -6,8 +6,7 @@ stages:
 - analyzer_and_format:
   - group:
     - dartfmt
-    - dartanalyzer: --fatal-warnings --fatal-infos .
-    dart: [dev]
+    - dartanalyzer: --fatal-infos .
 - unit_test:
   - test
 - ensure_build:

_test_yaml/pubspec.yaml

@@ -19,3 +19,6 @@ dependency_overrides:
     path: ../json_annotation
   json_serializable:
     path: ../json_serializable
+
+  # For yaml!
+  yaml: 3.0.0-nullsafety.0

_test_yaml/test/yaml_test.dart

@@ -27,7 +27,10 @@ void main() {
     for (final filePath in _tests) {
       test(p.basenameWithoutExtension(filePath), () {
         final content = File(filePath).readAsStringSync();
-        final yamlContent = loadYaml(content, sourceUrl: filePath) as YamlMap;
+        final yamlContent = loadYaml(
+          content,
+          sourceUrl: Uri.file(filePath),
+        ) as YamlMap;
 
         try {
           final config = Config.fromJson(yamlContent);
@@ -47,7 +50,7 @@ void main() {
     for (final entry in _badConfigs.entries) {
       test('${index++}', () {
         final yamlContent =
-            loadYaml(entry.key, sourceUrl: 'file.yaml') as YamlMap;
+            loadYaml(entry.key, sourceUrl: Uri.file('file.yaml')) as YamlMap;
 
         expect(yamlContent, isNotNull);
         printOnFailure(entry.key);

checked_yaml/changelog.md

@@ -1,6 +1,7 @@
-## 1.0.3-dev
+## 2.0.0-nullsafety-dev
 
-- Require at least Dart `2.7.0`.
+- *BREAKING* `checkedYamlDecode` `sourceUrl` parameter is now a `Uri`.
+- Require at least Dart `2.12.0-0`.
 
 ## 1.0.2
 

checked_yaml/example/example.dart

@@ -13,15 +13,14 @@ part 'example.g.dart';
   anyMap: true,
   checked: true,
   disallowUnrecognizedKeys: true,
-  nullable: false,
 )
 class Configuration {
   @JsonKey(required: true)
   final String name;
   @JsonKey(required: true)
   final int count;
 
-  Configuration({this.name, this.count}) {
+  Configuration({required this.name, required this.count}) {
     if (name.isEmpty) {
       throw ArgumentError.value(name, 'name', 'Cannot be empty.');
     }
@@ -36,18 +35,21 @@ class Configuration {
 }
 
 void main(List<String> arguments) {
-  var sourcePathOrYaml = arguments.single;
+  final sourcePathOrYaml = arguments.single;
   String yamlContent;
+  Uri? sourceUri;
 
   if (FileSystemEntity.isFileSync(sourcePathOrYaml)) {
     yamlContent = File(sourcePathOrYaml).readAsStringSync();
+    sourceUri = Uri.parse(sourcePathOrYaml);
   } else {
     yamlContent = sourcePathOrYaml;
-    sourcePathOrYaml = null;
   }
 
   final config = checkedYamlDecode(
-      yamlContent, (m) => Configuration.fromJson(m),
-      sourceUrl: sourcePathOrYaml);
+    yamlContent,
+    (m) => Configuration.fromJson(m!),
+    sourceUrl: sourceUri,
+  );
   print(config);
 }

checked_yaml/lib/checked_yaml.dart

@@ -20,11 +20,10 @@ import 'package:yaml/yaml.dart';
 /// `null` values.
 T checkedYamlDecode<T>(
   String yamlContent,
-  T Function(Map) constructor, {
-  sourceUrl,
+  T Function(Map?) constructor, {
+  Uri? sourceUrl,
   bool allowNull = false,
 }) {
-  allowNull ??= false;
   YamlNode yaml;
 
   try {
@@ -33,7 +32,7 @@ T checkedYamlDecode<T>(
     throw ParsedYamlException.fromYamlException(e);
   }
 
-  Map map;
+  Map? map;
   if (yaml is YamlMap) {
     map = yaml;
   } else if (allowNull && yaml is YamlScalar && yaml.value == null) {
@@ -56,7 +55,7 @@ T checkedYamlDecode<T>(
 /// `package:yaml`. If not, you may provide an alternative via [exceptionMap].
 ParsedYamlException toParsedYamlException(
   CheckedFromJsonException exception, {
-  YamlMap exceptionMap,
+  YamlMap? exceptionMap,
 }) {
   final yamlMap = exceptionMap ?? exception.map as YamlMap;
 
@@ -71,7 +70,7 @@ ParsedYamlException toParsedYamlException(
         (k) => (k as YamlScalar).value == key,
         orElse: () => yamlMap) as YamlNode;
     return ParsedYamlException(
-      exception.message,
+      exception.message!,
       node,
       innerError: exception,
     );
@@ -81,7 +80,7 @@ ParsedYamlException toParsedYamlException(
     if (yamlValue == null) {
       // TODO: test this case!
       return ParsedYamlException(
-        exception.message,
+        exception.message!,
         yamlMap,
         innerError: exception,
       );
@@ -108,25 +107,26 @@ class ParsedYamlException implements Exception {
   /// The node associated with this exception.
   ///
   /// May be `null` if there was an error decoding.
-  final YamlNode yamlNode;
+  final YamlNode? yamlNode;
 
   /// If this exception was thrown as a result of another error,
   /// contains the source error object.
-  final Object innerError;
+  final Object? innerError;
 
   ParsedYamlException(
     this.message,
-    this.yamlNode, {
+    YamlNode yamlNode, {
     this.innerError,
-  })  : assert(message != null),
-        assert(yamlNode != null);
+  }) :
+        // ignore: prefer_initializing_formals
+        yamlNode = yamlNode;
 
   factory ParsedYamlException.fromYamlException(YamlException exception) =>
       _WrappedYamlException(exception);
 
   /// Returns [message] formatted with source information provided by
   /// [yamlNode].
-  String get formattedMessage => yamlNode.span.message(message);
+  String? get formattedMessage => yamlNode?.span.message(message);
 
   @override
   String toString() => 'ParsedYamlException: $formattedMessage';
@@ -136,7 +136,7 @@ class _WrappedYamlException implements ParsedYamlException {
   _WrappedYamlException(this.innerError);
 
   @override
-  String get formattedMessage => innerError.span.message(innerError.message);
+  String? get formattedMessage => innerError.span?.message(innerError.message);
 
   @override
   final YamlException innerError;
@@ -145,7 +145,7 @@ class _WrappedYamlException implements ParsedYamlException {
   String get message => innerError.message;
 
   @override
-  YamlNode get yamlNode => null;
+  YamlNode? get yamlNode => null;
 
   @override
   String toString() => 'ParsedYamlException: $formattedMessage';

checked_yaml/mono_pkg.yaml

@@ -1,17 +1,12 @@
 # See https://github.com/google/mono_repo.dart for details on this file
 dart:
-- 2.7.0
 - dev
 
 stages:
 - analyzer_and_format:
   - group:
     - dartfmt
-    - dartanalyzer: --fatal-warnings --fatal-infos .
-    dart: [dev]
-  - group:
-    - dartanalyzer: --fatal-warnings .
-    dart: [2.7.0]
+    - dartanalyzer: --fatal-infos .
 
 - unit_test:
   - test