Skip to content
This repository has been archived by the owner on Sep 20, 2020. It is now read-only.

Commit

Permalink
prepare for release (no more 1.0.0, but 2.2.3, aligned with Akka rela…
Browse files Browse the repository at this point in the history
…ted version)
  • Loading branch information
smartiniOnGitHub committed Feb 28, 2014
1 parent ed815d8 commit 01c57a9
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 26 deletions.
2 changes: 1 addition & 1 deletion AkkaGrailsPlugin.groovy
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/

class AkkaGrailsPlugin {
def version = "1.0.0"
def version = "2.2.3"
def grailsVersion = "2.2 > *"
def title = "Akka Integration"
def author = "Sandro Martini"
Expand Down
46 changes: 23 additions & 23 deletions docs/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,14 @@ grails-akka - TODO
TODO
----

- for release 1.0.0:
- set release number ... ok
- update to Grails-2.2.x the plugin ... ok
- update to Grails-2.2.x the test webapp (and resources:1.2.1, etc) ... ok
- verify if publish even other akka modules ... no, maybe later (but I don't think)
- create an akkaService to simplify interaction with akka (akkaService), but verify it only in the test webapp ... ok
- verify if create the akkaSystem in a Servlet (or other more Grails-related), but verify if only in the test webapp ... no
- in akkaService (transactional false), make akkaSystem static final, and use lifecycle annotations like seen here: ...
https://jira.grails.org/browse/GRAILS-10137
then make the actorSystem dependent on the webapp context name,
and then test the service in the test webapp (and even in Bootstrap, to have more info even at application startup) ... ok
- use akkaService directly from a sample Controller in the test webapp and ask for akkaSystem (maybe hiding it) ... ok
- (optional) add base class for actor messages (from Akka best practices), and add other sample generic messages ... ok
- in akkaService, check if akkaSystem read-only is good ... yes, it seems ok the same ... ok
- in akkaService, add comments to service methods, to better see them in generated docs ... ok
- test akkaService, with not-so-trivial unit and integration (this is important) tests ... ok
- in the test webapp, in Bootstrap, add one or more Actors using akkaService ... ok
- in the test webapp, create an AkkaController to show some akkaSystem info ... just started ...
- generate and publish plugin doc for this release ...


- later:
- update dependencies to Akka-2.3.x and Scala-2.10.x ...
- in the test webapp, add the config key (grails_akka.akkaSystem.name) so the akkaService can use it as actorSystem name (when given) ...
- in the test webapp, improve AkkaController to show more akkaSystem info, and invoke/play with actors ...
- if/when needed, add more methods in akkaService ...
- fix TODO in plugin ...
- add more tests ...
- verify if it's better to not expose directly the ActorSystem in the akkaService ...
- verify (deeply) if it's better to not expose directly the ActorSystem in the akkaService ...
- verify the info put in readme.md
- and then, create another test webapp (but not inline here) where to install it, following only readme info, to ensure they are right ...
- add some long-running actor, for example giving it the delay ...
Expand Down Expand Up @@ -148,7 +127,7 @@ cls && grails test-app integration: -echoOut

- for release 0.12.5 (maintenance public release):
- the strange number version of the plugin is made by Scala-2.10.2 (required by Akka-2.2.3):
10.2 + 2.3 = 10.5 :-) ... but next version probably will be 1.0.0
10.2 + 2.3 = 10.5 :-) ... but next version will be a ga release (no more 0.x release)
- update to Akka-2.2.3 (aligned with Scala-2.10.2), so this strange number in the plugin release ... ok
- verify if add an akkaService ... but check how to configure it from outside ... ok but later
- do other tests and small adjustments ... ok
Expand All @@ -160,5 +139,26 @@ cls && grails test-app integration: -echoOut
- fix tests (make them work) both for the plugin, and for the test webapp ... ok
- update Groovy doc files ... ok

- for release 2.2.3:
- set release number ... ok
- update release number to the same of Akka ... ok
- update to Grails-2.2.x the plugin ... ok
- update to Grails-2.2.x the test webapp (and resources:1.2.1, etc) ... ok
- verify if publish even other akka modules ... no, maybe later (but I don't think)
- create an akkaService to simplify interaction with akka (akkaService), but verify it only in the test webapp ... ok
- verify if create the akkaSystem in a Servlet (or other more Grails-related), but verify if only in the test webapp ... no
- in akkaService (transactional false), make akkaSystem static final, and use lifecycle annotations like seen here: ...
https://jira.grails.org/browse/GRAILS-10137
then make the actorSystem dependent on the webapp context name,
and then test the service in the test webapp (and even in Bootstrap, to have more info even at application startup) ... ok
- use akkaService directly from a sample Controller in the test webapp and ask for akkaSystem (maybe hiding it) ... ok
- (optional) add base class for actor messages (from Akka best practices), and add other sample generic messages ... ok
- in akkaService, check if akkaSystem read-only is good ... yes, it seems ok the same ... ok
- in akkaService, add comments to service methods, to better see them in generated docs ... ok
- test akkaService, with not-so-trivial unit and integration (this is important) tests ... ok
- in the test webapp, in Bootstrap, add one or more Actors using akkaService ... ok
- in the test webapp, create an AkkaController to show some akkaSystem info ... ok
- generate and publish plugin doc for this release ... ok


---------------
4 changes: 2 additions & 2 deletions src/docs/guide/1.1 History.gdoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
h4. History

* February 2014
** 1.0.0 release
** 2.2.3 release
*** Updated to Grails-2.2.4
*** Add AkkaService
*** Add AkkaService (see Tutorials for more info)

* February 2014
** 0.12.5 release
Expand Down
16 changes: 16 additions & 0 deletions src/docs/guide/3 Tutorials.gdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,26 @@ there there are some initial unit and integration tests,
and even an inline test webapp.

Code is duplicated to avoid unnecessary complexity.
Unnecessary code in plugin sources is already excluded in plugin packaging.

Note that some code is more general than required for tests, but only to show some basic features.


h5. AkkaService
The plugin now has an utility service (AkkaService) that by default creates an Akka ActorSystem at application startup
with a default name:
- if defined, the value of grails_akka.akkaSystem.name variable, set in Grails config file
- otherwise, the webapp context name
- otherwise (at last), "grails-akka" will be used.

Use it like any other Grails services, defining an akkaService variable.
For more info, look at its API in generated docs.

In the test webapp you can see that in Bootstrap a sample Actor is created in the system.
There is even a sample controller (AkkaController) that interacts with plugin AkkaService,
and show some info of the actor system and actors.


h4. Akka documentation

Look at Akka API for Java, usable from Groovy and Java code,
Expand Down

0 comments on commit 01c57a9

Please sign in to comment.