version 0.8 notes

Author: UnquietCode

Documentation.java

@@ -17,9 +17,12 @@
  * the API should operate. Once constructed, the descriptor is then used to
  * generate a set of Java source files. These files are comprised of a few
  * runtime classes and generated interfaces. The generated sources should
- * be included in your project, perhaps as a module dependency. (This project
- * also contains a maven plugin which allows you to regenerate your sources
- * on the fly. See more [here](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin)).
+ * be included in your project, perhaps as a module dependency.
+ *
+ * There are two build plugins availble, one for
+ * [Maven](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin)
+ * and one for [Gradle](https://github.com/UnquietCode/Flapi/wiki/Gradle-Build-Plugin)
+ * which allow you to regenerate your sources on the fly.
  *
  *
  * ### At Run Time

README.md

@@ -1,5 +1,5 @@
 # Flapi - A fluent API generator for Java
-## v0.7.3 [![Build Status](https://travis-ci.org/UnquietCode/Flapi.png?branch=master)](https://travis-ci.org/UnquietCode/Flapi) 
+## v0.8.0 [![Build Status](https://travis-ci.org/UnquietCode/Flapi.png?branch=master)](https://travis-ci.org/UnquietCode/Flapi)
 
 [![Tip with Gratipay](https://assets.gratipay.com/gratipay.svg)](https://gratipay.com/UnquietCode) [![Tip with Bitcoin](https://assets.gratipay.com/bitcoin.png)](https://blockchain.info/address/1Ec6mzLpJQvuzXqhxfJz1h9ZwJmoHMW9BX)**Bitcoin**
 
@@ -73,7 +73,7 @@ repository and dependency in your build script:
 <dependency>
   <groupId>unquietcode.tools.flapi</groupId>
   <artifactId>flapi</artifactId>
-  <version>0.7.3</version>
+  <version>0.8</version>
   <scope>test</scope>
 </dependency>
 ```
@@ -89,18 +89,23 @@ repositories {
 ...
 
 dependencies {
-  testCompile 'unquietcode.tools.flapi:flapi:0.7.3'
+  testCompile 'unquietcode.tools.flapi:flapi:0.8'
 }
 ```
 
 In a test define your `Descriptor` object and output the generated source code. (The
 [Pizza Builder](https://github.com/UnquietCode/Flapi/wiki/Pizza-Builder-Example)
 example is a simple descriptor you can start with.) You can also make use of the
-[maven plugin](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin) to
+[gradle plugin](https://github.com/UnquietCode/Flapi/wiki/Gradle-Build-Plugin), or the
+[maven plugin](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin), to
 perform the code generation.
 
-At the time of writing, the project builds fine in JDK 6 and 7. However, please note that
-the automated builds are no longer being run against JDK 6.
+At the time of writing the project builds fine in JDK 6, however please note that
+the automated builds are no longer being run for that release. Future versions will
+be built using JDK 8, exposing a JDK 7 compatible public interface, and use JDK 7 as
+the default target for code generation, where the current default is JDK 6.
+
+(PSA: If you're still using JDK 6 or lower please do something about that soon.)
 
 
 ### Additional Resources
@@ -117,9 +122,8 @@ The original blog post describing Flapi.
 
 
 ### What's the project's status?
-Version 0.7 has been released, and includes enhancements for customizing the generated code, plus several
-other new features and improvements. See the
-[Release Notes](https://github.com/UnquietCode/Flapi/wiki/Version-0.7) for the full details.
+Version 0.8 has been released, and includes a new Gradle build plugin, support for
+block mixins, and more. See the [Release Notes](./VERSION.md) for the full details.
 
 ### Problems?
 Use the [issue tracker](https://github.com/UnquietCode/Flapi/issues) to report problems encountered or new

VERSION.md

@@ -1,6 +1,42 @@
+# Version 0.8
+This version includes several key features, and is also intended to be the last
+feature release before 1.0.
+
+### Gradle Plugin
+A new build plugin for Gradle is available, extending the build-time support
+for code generation offered by the Maven plugin. See the
+[wiki page](https://github.com/UnquietCode/Flapi/wiki/Gradle-Build-Plugin)
+for more information.
+
+### Block Mixins
+Using block mixins, it is possible to 'extend' one or more already existing
+blocks, reducing duplication, and covering a common use case. See the
+[Block Mixins](http://unquietcode.github.io/Flapi/#block%20mixins) section
+in the documentation for usage notes.
+
+### `Head` wrapper interface
+Similar to the `Start<Void>` wrapper interface which was removed previously,
+every descriptor now includes a simple, untyped interface for public consumption
+named `Head`. This interface will extend whatever the internal `Start` interface
+demands, creating a more shelf-stable API.
+
+### Features and Improvements
+
+	+ [#25]: new Gradle build plugin
+	+ [#44]: support for block mixins
+	+ [#216]: support for extended type hierarchies in annotated helpers
+	+ [#215]: allow customization of anonymous names via the NameGenerator API
+	+ [#214]: support for single wildcard generics in method signatures
+	+ [#213]: new `Head` convenience class, replacing confusing uses of `Start<Void>`
+
+The full list of tasks and issues included in the release is available on the project's
+[Issue Tracker](https://github.com/UnquietCode/Flapi/milestones/0.8).
+
+------------------------------------------------
+
 # Version 0.7
 The latest version includes some new features for modifying the output
-of the generated source code. As well, better type handling is availble
+of the generated source code. As well, better type handling is available
 for arrays and generics.
 
 ### Features and Improvements
@@ -57,6 +93,10 @@ You can now create descriptors from annotated helper classes and interfaces. See
 ### Bean Builders
 Similar to annotations, you can provide a class with `setXYZ(..)` and `withXYZ(..)` methods, and these will be turned into a simple builder where each method can only be called at most one time, and where a bean will be returned at the end of the chain.
 
+### BREAKING CHANGE - wrapper `Start` interface requires a type parameter
+In order to enable proper nested blocks, all `Start` interfaces now require a
+type parameter to be provided. In most cases, this value will simply be `Void`.
+
 ## Resolved Issues
 Issues are now handled through GitHub, and historical issues have been migrated from JIRA.
 
@@ -73,10 +113,6 @@ Issues are now handled through GitHub, and historical issues have been migrated
 	+ [FLAPI-190 / #34]: Update docs and wiki with annotations info.
 	+ [FLAPI-189 / #17]: Move issues from JIRA to GitHub
 
-### BREAKING CHANGE - wrapper `Start` interface requires a type parameter
-In order to enable proper nested blocks, all `Start` interfaces now require a
-type parameter to be provided. In most cases, this value will simply be `Void`.
-
 The full list of tasks and issues included in the release is available on the project's
 [Issue Tracker](https://github.com/UnquietCode/Flapi/milestones/0.6).
 
@@ -223,7 +259,6 @@ The full list of tasks and issues included in the release is available on the pr
 
 ------------------------------------------------
 
-# Version 0.3
 Flapi 0.3 includes several bugfixes, as well as some new features.
 
 ## Javadocs
@@ -239,8 +274,12 @@ Methods which are marked `atMost(..)` can now be grouped together within the sam
 This means that when one goes, so does the other. Use this in place of unnecessary anonymous blocks.
 The new documentation methods, for example, make use of this.
 
-## Demonstration Video
-A screencast which attempts to explain the basic use of Flapi has been posted [here](http://vimeo.com/58855907).
+## Demos and Examples
+A screencast which attempts to explain the basic use of Flapi has been posted [here](http://vimeo.com/58855907/).
+
+As well, a new example has been added, called PipedProcessorExample. This showcases building up computation
+instead of an object, by piping processes together. Find it in the
+[test directory](https://github.com/UnquietCode/Flapi/tree/master/src/test/java/unquietcode/tools/flapi/examples/pipes).
 
 ## Resolved Issues
 
@@ -274,11 +313,24 @@ The full list of tasks and issues included in the release is available on the pr
 ------------------------------------------------
 
 # Version 0.2
-Notes also available at: https://github.com/UnquietCode/Flapi/wiki/v0_2
-JIRA: https://unquietcode.atlassian.net/secure/ReleaseNote.jspa?projectId=10160&version=10141
+Flapi 0.2 contains several bugfixes, as well as a complete rearchitecture of the code generation
+classes. More javadocs have been added, a few new features, and a few API changes. All of the examples
+have been updated. As well, tests have been improved with a suite of in-memory compilation tests, as
+well as the inclusion of example code as full-fledged tests.
 
-Stable beta release. There are still some features to be added.
-This version includes a few notable changes:
+For clarity, the `once()` method when delaring methods and blocks has been replaced with `exactly(x)`.
+`exactly(1)` is equivalent to using `between(1, 1)`.
+
+The `@Generated` annotation is now added to classes when the JDK version is set to >= 6. You can set the target JDK version in Flapi by calling `Flapi.setJDKVersion(...)` and this setting will affect how the classes are generated.
+
+The most important external change is that the 'support' classes and interfaces which comprise the
+runtime dependencies of Flapi have been reduced. The required classes are written out with the
+generated ones and can be dropped into your application.
+
+A new feature, implicit terminals, allows a block to automatically exit when there are no more methods
+left to call. See [this example](House-Builder-Example) for more information.
+
+Key Features:
 
 + StateClass rearchitecture [FLAPI-83]
 + common interface for implementation classes [FLAPI-67]
@@ -301,10 +353,17 @@ The full list of tasks and issues included in the release is available on the pr
 ------------------------------------------------
 
 # Version 0.1
-Notes also available at: https://github.com/UnquietCode/Flapi/wiki/v0_1
-JIRA: https://unquietcode.atlassian.net/secure/ReleaseNote.jspa?projectId=10160&version=10140
-
-Initial beta release.
+Flapi is a fluent API generator for Java. By 'fluent' I primarily mean
+simplified method chaining, but also the ability to obscure methods which
+have been called a certain number of times. This allows a user to see
+compile-time errors, or helpful autocomplete suggestions while working
+with the API. As well, because the API is generated from a descriptor,
+changes are easy to integrate without spending time reworking your
+classes.
+
+This version, 0.1, is an initial beta laying the groundwork for using
+Flapi. See the [Examples](https://github.com/UnquietCode/Flapi/wiki/Examples)
+in the wiki for more information.
 
 The full list of tasks and issues included in the release is available on the project's
 [Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.1).