Prepare to publish 2.0.0-alpha (#118)

Author: matanlurey

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.0-alpha
+
+* Complete re-write to not use `package:analyzer`.
+* Code generation now properly uses the _builder_ pattern (via `built_value`).
+* See examples and tests for details.
+
 ## 1.0.4
 
 * Added `isInstanceOf` to `ExpressionBuilder`, which performs an `is` check:

README.md

@@ -6,7 +6,79 @@
 
 `code_builder` is a fluent Dart API for generating valid Dart source code.
 
-**Experimental Branch for _2.0_**:
-- Drops use of the `package:analyzer` API.
-- Uses a proper [builder pattern](https://github.com/square/javapoet).
+## Contributing
 
+* Read and help us document common patterns over [at the wiki][wiki].
+* Is there a *bug* in the code? [File an issue][issue].
+
+If a feature is missing (the Dart language is always evolving) or you'd like an
+easier or better way to do something, consider [opening a pull request][pull].
+You can always [file an issue][issue], but generally speaking feature requests
+will be on a best-effort basis.
+
+[wiki]: https://github.com/dart-lang/code_builder/wiki
+[issue]: https://github.com/dart-lang/code_builder/issues
+[pull]: https://github.com/dart-lang/code_builder/pulls
+
+## Usage
+
+`code_builder` has a narrow and user-friendly API.
+
+For example creating a class with a method:
+
+```dart
+import 'package:code_builder/code_builder.dart';
+import 'package:dart_style/dart_style.dart';
+
+void main() {
+  final animal = new Class((b) => b
+    ..name = 'Animal'
+    ..extend = const Reference.localScope('Organism').toType()
+    ..methods.add(new Method.returnsVoid((b) => b
+      ..name = 'eat'
+      ..lambda = true
+      ..body = new Code((b) => b..code = 'print(\'Yum\')'))));
+  final emitter = const DartEmitter();
+  print(new DartFormatter().format('${animal.accept(emitter)}'));
+}
+```
+
+Outputs:
+```dart
+class Animal extends Organism {
+  void eat() => print('Yum!');
+}
+```
+
+Have a complicated set of dependencies for your generated code?
+`code_builder` supports automatic scoping of your ASTs to automatically
+use prefixes to avoid symbol conflicts:
+
+```dart
+import 'package:code_builder/code_builder.dart';
+import 'package:dart_style/dart_style.dart';
+
+void main() {
+  final library = new File((b) => b.body.addAll([
+        new Method((b) => b
+          ..body = new Code((b) => b.code = '')
+          ..name = 'doThing'
+          ..returns = const Reference('Thing', 'package:a/a.dart').toType()),
+        new Method((b) => b
+          ..body = new Code((b) => b..code = '')
+          ..name = 'doOther'
+          ..returns = const Reference('Other', 'package:b/b.dart').toType()),
+      ]));
+  final emitter = new DartEmitter(new Allocator.simplePrefixing());
+  print(new DartFormatter().format('${library.accept(emitter)}'));
+}
+```
+
+Outputs:
+```dart
+import 'package:a/a.dart' as _1;
+import 'package:b/b.dart' as _2;
+
+_1.Thing doThing() {}
+_2.Other doOther() {}
+```

example/animal.dart

@@ -0,0 +1,18 @@
+// Copyright (c) 2017, 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 'package:code_builder/code_builder.dart';
+import 'package:dart_style/dart_style.dart';
+
+void main() {
+  final animal = new Class((b) => b
+    ..name = 'Animal'
+    ..extend = const Reference.localScope('Organism').toType()
+    ..methods.add(new Method.returnsVoid((b) => b
+      ..name = 'eat'
+      ..lambda = true
+      ..body = new Code((b) => b..code = 'print(\'Yum\')'))));
+  final emitter = const DartEmitter();
+  print(new DartFormatter().format('${animal.accept(emitter)}'));
+}

example/scope.dart

@@ -0,0 +1,21 @@
+// Copyright (c) 2017, 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 'package:code_builder/code_builder.dart';
+import 'package:dart_style/dart_style.dart';
+
+void main() {
+  final library = new File((b) => b.body.addAll([
+        new Method((b) => b
+          ..body = new Code((b) => b.code = '')
+          ..name = 'doThing'
+          ..returns = const Reference('Thing', 'package:a/a.dart').toType()),
+        new Method((b) => b
+          ..body = new Code((b) => b..code = '')
+          ..name = 'doOther'
+          ..returns = const Reference('Other', 'package:b/b.dart').toType()),
+      ]));
+  final emitter = new DartEmitter(new Allocator.simplePrefixing());
+  print(new DartFormatter().format('${library.accept(emitter)}'));
+}

lib/src/specs/method.dart

@@ -20,12 +20,23 @@ import 'type_reference.dart';
 
 part 'method.g.dart';
 
+final TypeReference _$void = const Reference.localScope('void').toType();
+
 @immutable
 abstract class Method extends Object
     with HasAnnotations, HasGenerics, HasDartDocs
     implements Built<Method, MethodBuilder>, Reference, Spec {
   factory Method([void updates(MethodBuilder b)]) = _$Method;
 
+  factory Method.returnsVoid([void updates(MethodBuilder b)]) {
+    return new Method((b) {
+      if (updates != null) {
+        updates(b);
+      }
+      b.returns = _$void;
+    });
+  }
+
   Method._();
 
   @override

pubspec.yaml

@@ -1,5 +1,5 @@
 name: code_builder
-version: 2.0.0-dev
+version: 2.0.0-alpha
 description: A fluent API for generating Dart code
 author: Dart Team <[email protected]>
 homepage: https://github.com/dart-lang/code_builder

test/specs/method_test.dart

@@ -51,6 +51,15 @@ void main() {
     );
   });
 
+  test('should create a method with a void return type', () {
+    expect(
+      new Method.returnsVoid((b) => b..name = 'foo'),
+      equalsDart(r'''
+        void foo();
+      '''),
+    );
+  });
+
   test('should create a method with generic types', () {
     expect(
       new Method((b) => b