PartBuilder requireLibraryDirective now defaults to false (#310)

Require at least Dart 2.0.0-dev.19
Prepare to release 0.7.5

Author: kevmoo

.travis.yml

@@ -2,18 +2,12 @@ language: dart
 
 dart:
   - dev
-  - stable
-  - 1.22.1
+  # Flutter Alpha @ v0.0.23
+  - 2.0.0-dev.19.0
 dart_task:
   - test
   - dartfmt
   - dartanalyzer
-matrix:
-  exclude:
-    - dart: 1.22.1
-      dart_task: dartfmt
-    - dart: 1.22.1
-      dart_task: dartanalyzer
 
 # Only building master means that we don't run two builds for each pull request.
 branches:

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.7.5
+
+* The `PartBuilder` constructor parameter `requireLibraryDirective` now defaults
+  to `false`. It will be removed in `0.8.0`.
+
+* Require at least Dart `2.0.0-dev.19.0`.
+
 ## 0.7.4+3
 
 * Support the latest `analyzer` package.

lib/src/builder.dart

@@ -37,19 +37,24 @@ class _Builder extends Builder {
   final Map<String, List<String>> buildExtensions;
 
   /// Wrap [_generators] to form a [Builder]-compatible API.
-  _Builder(this._generators,
+  _Builder(
+      this._generators,
       {String formatOutput(String code),
       String generatedExtension: '.g.dart',
       List<String> additionalOutputExtensions: const [],
       bool isStandalone: false,
-      bool requireLibraryDirective: true,
+      @Deprecated(
+          'Library directives are no longer required for part generation. '
+          'This option will be removed in v0.8.0.')
+          bool requireLibraryDirective: false,
       String header})
       : _generatedExtension = generatedExtension,
         buildExtensions = {
           '.dart': [generatedExtension]..addAll(additionalOutputExtensions)
         },
         _isStandalone = isStandalone,
         formatOutput = formatOutput ?? _formatter.format,
+        // ignore: deprecated_member_use
         _requireLibraryDirective = requireLibraryDirective,
         _header = header ?? defaultFileHeader {
     if (_generatedExtension == null) {
@@ -167,23 +172,30 @@ class PartBuilder extends _Builder {
   /// If `null`, the content of [defaultFileHeader] is used.
   /// If [header] is an empty `String` no header is added.
   ///
-  /// May set [requireLibraryDirective] to `false` in order to opt-in to
-  /// supporting a `2.0.0-dev` feature of `part of` being usable without an
-  /// explicit `library` directive. Developers should restrict their `pubspec`
+  /// May set [requireLibraryDirective] to `true` in order to opt-out of the
+  /// Dart `2.0.0-dev` feature of `part of` being usable without an explicit
+  /// `library` directive. Developers should restrict their `pubspec`
   /// accordingly:
   /// ```yaml
   /// sdk: '>=2.0.0-dev <2.0.0'
   /// ```
-  PartBuilder(List<Generator> generators,
+  ///
+  /// This option will be removed in version 0.8.0 of `source_gen`.
+  PartBuilder(
+      List<Generator> generators,
       {String formatOutput(String code),
       String generatedExtension: '.g.dart',
       List<String> additionalOutputExtensions: const [],
-      bool requireLibraryDirective: true,
+      @Deprecated(
+          'Library directives are no longer required for part generation. '
+          'This option will be removed in v0.8.0.')
+          bool requireLibraryDirective: false,
       String header})
       : super(generators,
             formatOutput: formatOutput,
             generatedExtension: generatedExtension,
             additionalOutputExtensions: additionalOutputExtensions,
+            // ignore: deprecated_member_use
             requireLibraryDirective: requireLibraryDirective,
             header: header);
 }

pubspec.yaml

@@ -1,10 +1,10 @@
 name: source_gen
-version: 0.7.4+3
+version: 0.7.5
 author: Dart Team <[email protected]>
 description: Automated source code generation for Dart.
 homepage: https://github.com/dart-lang/source_gen
 environment:
-  sdk: '>=1.22.1 <2.0.0'
+  sdk: '>=2.0.0-dev.19.0 <2.0.0'
 dependencies:
   analyzer: '>=0.29.10 <0.32.0'
   build: '>=0.10.0 <0.13.0'

test/builder_test.dart

@@ -71,9 +71,21 @@ void main() {
         returnsNormally);
   });
 
-  test('Throws an exception when no library identifier is found', () async {
+  test('Allow no "library"  by default', () async {
     var sources = _createPackageStub(pkgName, testLibContent: 'class A {}');
     var builder = new PartBuilder([const CommentGenerator()]);
+
+    await testBuilder(builder, sources,
+        outputs: {'$pkgName|lib/test_lib.g.dart': _testGenNoLibrary});
+  });
+
+  test(
+      'Throws when no library identifier and requireLibraryDirective is `true`',
+      () async {
+    var sources = _createPackageStub(pkgName, testLibContent: 'class A {}');
+    var builder = new PartBuilder([const CommentGenerator()],
+        // ignore: deprecated_member_use
+        requireLibraryDirective: true);
     expect(
         testBuilder(builder, sources,
             outputs: {'$pkgName|lib/test_lib.g.dart': ''}),
@@ -86,10 +98,9 @@ void main() {
     await testBuilder(builder, sources, outputs: {});
   });
 
-  test('Allow no "library" when requireLibraryDirective=false', () async {
+  test('Use new part syntax when no library directive exists', () async {
     var sources = _createPackageStub(pkgName, testLibContent: 'class A {}');
-    var builder = new PartBuilder([const CommentGenerator()],
-        requireLibraryDirective: false);
+    var builder = new PartBuilder([const CommentGenerator()]);
     await testBuilder(builder, sources,
         outputs: {'$pkgName|lib/test_lib.g.dart': _testGenNoLibrary});
   });

test/src/comment_generator.dart

@@ -17,7 +17,11 @@ class CommentGenerator extends Generator {
   Future<String> generate(LibraryReader library, _) async {
     var output = new StringBuffer();
     if (forLibrary) {
-      output.writeln('// Code for "${library.element}"');
+      var name = library.element.name;
+      if (name.isEmpty) {
+        name = library.element.source.uri.pathSegments.last;
+      }
+      output.writeln('// Code for "$name"');
     }
     if (forClasses) {
       for (var classElement