Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated docs, for release 0.5 final

  • Loading branch information...
commit 0edf4d958da5971bd40859e4eab7af1433e5effc 1 parent f47c409
@smartiniOnGitHub authored
View
3  AkkaGrailsPlugin.groovy
@@ -30,8 +30,7 @@ class AkkaGrailsPlugin {
def author = "Sandro Martini"
def authorEmail = "sandro.martini@gmail.com"
def description = '''\
-Let Grails webapps to call/use Akka actors from Groovy and Java.
-Note that it requires a Servlet 3.x environment to run.
+Akka actors integration from Groovy and Java, in a Servlet 3.x environment.
'''
def documentation = "http://grails.org/plugin/akka"
View
8 README.md
@@ -23,16 +23,16 @@ Installation
In BuildConfig.groovy of the webapp, under the plugins section (at the end of the file) add:
- compile ":akka:<version>"
+ compile ":akka:<version>"
-and copy the plugin zip under the webapp lib folder,
+and copy the plugin zip under the webapp lib folder,
then run grails refresh-dependencies, grails clean , then grails compile , and the plugin should be installed.
In case of Errors during plugin installation, Set log level to 'warn' in BuildConfig.groovy to get more information, and retry.
Instead of the compile it's possible even to use runtime, and in that case simply running a grails console should be enough.
-One time installed, you can safely move in a backup folder or delete the plugin zip just copied,
+One time installed, you can safely move in a backup folder or delete the plugin zip just copied,
but if the project folder (under the user home folder) is deleted, the plugin should be reinstalled.
-Instead, running a grails war (with the plugin zip still under the lib folder) doesn't put it in the generated war,
+Instead, running a grails war (with the plugin zip still under the lib folder) doesn't put it in the generated war,
so should be safe even to keep it there.
View
3  build_trim-whitespace.xml
@@ -43,7 +43,10 @@ limitations under the License.
<include name="**/*.groovy"/>
<include name="**/*.scala"/>
<include name="**/*.htm"/>
+ <include name="**/*.html"/>
+ <include name="**/*.gdoc"/>
<include name="**/*.gsp"/>
+ <include name="**/*.md"/>
</fileset>
<replaceregexp match="[\t]" replace=" " flags="gm" byline="true">
<fileset refid="trimfiles"/>
View
84 docs/TODO.md
@@ -4,51 +4,43 @@ grails-akka - TODO
TODO
----
-- fix docs and write the 2 Changelog (or similar) ... with 0.5, and 1.0, then remove this line
-
-- for release 0.5 (first public release):
- + tag sources in git
- + put in downloads a zipped version of the plugin
- * add by hand README.md, NOTICE, LICENSE, and RELEASE-NOTES and README if present ...
-
-
- for release 1.0:
- + 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 ...
- * ok, but up to now it doesn't seem to block execution for the given delay ... verify better, to make it work
- + test the right behaviour (to be sure that Thread suspend/resume in done the right way), with a stress test ...
- + make an akkaService, and test it
- * do it in the test webapp, because probably in the plugin it would be hard to have it so much generalized ...
- + fix TODO in code ...
+ + 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 ...
+ * ok, but up to now it doesn't seem to block execution for the given delay ... verify better, to make it work
+ + test the right behaviour (to be sure that Thread suspend/resume in done the right way), with a stress test ...
+ + make an akkaService, and test it
+ * do it in the test webapp, because probably in the plugin it would be hard to have it so much generalized ...
+ + fix TODO in code ...
+ sample usage of akka poison pill messages:
http://doc.akka.io/docs/akka/2.0.3/java/untyped-actors.html
- + sample usage of akka typed actors:
-http://doc.akka.io/docs/akka/2.0.3/java/typed-actors.html
- + verify if/how to exclude the transitivity of scala, to avoid dependency errors in the grails dependency-report ...
- * put exclusions for this in the BuildConfig of the plugin, until I get 0 evicted (in build, compile, and runtime)... ok
- * I commented all the exclusions for now otherwise a compile error will happen ...
- just for reference, but could be the wrong way to do this, so let's see later if/how to fix this
+ + verify if/how to exclude the transitivity of scala, to avoid dependency errors in the grails dependency-report ...
+ * put exclusions for this in the BuildConfig of the plugin, until I get 0 evicted (in build, compile, and runtime)... ok
+ * I commented all the exclusions for now otherwise a compile error will happen ...
+ just for reference, but could be the wrong way to do this, so let's see later if/how to fix this
- for release 1.0 or later:
- + use some remote actor ...
- * grails-akka-test webapp integration tests:
- call some remote actors (before start its server, maybe with a microkernel application under integration tests, as this) ...
- + make it load a config file from the classpath,
- maybe with a dedicated key under Config.grails (in the webapp or in the plugin ? or in both ?), or using grails.config.locations ...
- * use sample conf files for Java and put under integration tests root folder, then try to use them
- + update package creation, to add even README.md, NOTICE, LICENSE files in root, and RELEASE-NOTES and README if present ...
- * add by hand CHANGES.md with inside the full history of changes ... no, better: put this in plugin docs, in gdoc format
+ + use some remote actor ...
+ * grails-akka-test webapp integration tests:
+ call some remote actors (before start its server, maybe with a microkernel application under integration tests, as this) ...
+ + make it load a config file from the classpath,
+ maybe with a dedicated key under Config.grails (in the webapp or in the plugin ? or in both ?), or using grails.config.locations ...
+ * use sample conf files for Java and put under integration tests root folder, then try to use them
+ + update package creation, to add even README.md, NOTICE, LICENSE files in root, and RELEASE-NOTES and README if present ...
+ * add by hand CHANGES.md with inside the full history of changes ... no, better: put this in plugin docs, in gdoc format
+ + sample usage of akka typed actors:
+http://doc.akka.io/docs/akka/2.0.3/java/typed-actors.html
-- for later:
- + enabling scala ...
- * re-enable the creation of scala source folders when installing the plugin in a test webapp ...
- * enable scala compilation and verify if some scala content there is compiled ...
- * or maybe use the grails-scala plugin, but ONLY if updated to Scala version used by Akka here (now is Scala-2.9.2) ...
- + create a sample Java/Groovy project where to put common classes for messages, and use it from the test webapp ...
- * maybe build it with gradle ...
+- others:
+ + enabling scala ...
+ * re-enable the creation of scala source folders when installing the plugin in a test webapp ...
+ * enable scala compilation and verify if some scala content there is compiled ...
+ * or maybe use the grails-scala plugin, but ONLY if updated to Scala version used by Akka here (now is Scala-2.9.2) ...
+ + create a sample Java/Groovy project where to put common classes for messages, and use it from the test webapp ...
+ * maybe build it with gradle ...
- etc ...
@@ -64,11 +56,11 @@ cls && grails test-app unit: -echoOut
cls && grails test-app integration: -echoOut
- try with some local actor, as seen here: http://doc.akka.io/docs/akka/2.0.3/java/untyped-actors.html
- + ok (but without a sepcific configuration given to it),
- both in unit and integration tests (but had to duplicate test classes, to not put in the plugin, to have it cleaner) ...
+ + ok (but without a sepcific configuration given to it),
+ both in unit and integration tests (but had to duplicate test classes, to not put in the plugin, to have it cleaner) ...
- make messages classes more Groovy-like ... ok
- + add some Groovy-specific extensions (annotations, etc), to show how to simplify code ... ok
+ + add some Groovy-specific extensions (annotations, etc), to show how to simplify code ... ok
- add sample of (better) testing of actors and logic used inside them using akka TestKit, as seen here:
http://doc.akka.io/docs/akka/2.1-M2/java/testing.html
@@ -80,8 +72,8 @@ cls && grails test-app integration: -echoOut
- comment the creation of scala source folders and other scala-related stuff ... ok
- add (as usual) the ant build_trim-whitespace.xml, to normalize sources ...
- + use it with: ant -f build_trim-whitespace.xml
- (the trim-whitespace target is the default)
+ + use it with: ant -f build_trim-whitespace.xml
+ (the trim-whitespace target is the default)
- add references to akka license (and maybe even to scala license) in NOTICE ... ok
- add Apache license header in any file, important ... ok
@@ -92,5 +84,13 @@ cls && grails test-app integration: -echoOut
- in the test webapp, do a grails war and inspect the generated war file ... ok
+- for release 0.5 (first public release):
+ + update gdocs under src/docs/guide , then publish on github-pages ... ok
+ + tag sources in git ... ok
+ + put in downloads a zipped version of the plugin
+ * ensure LICENSE file is put in root of the generated plugin ... ok
+ * add by hand README.md, NOTICE, and RELEASE-NOTES and README if present ... ok
+
+
---------------
View
2  src/docs/guide/1 Introduction.gdoc
@@ -2,7 +2,7 @@ h1. Grails-Akka
h2. Introduction
-This plugin makes it easy to use [Akka](http://akka.io/) Actors (both local and remote) from a Grails webapp.
+This plugin makes it easy to use [Akka|http://akka.io/] Actors (both local and remote) from a Grails webapp.
All using standard Groovy / Java code.
View
4 src/docs/guide/1.1 History.gdoc
@@ -2,4 +2,6 @@ h4. History
* September 2012
** 0.5 release
-*** First public version of the plugin, with some basic features, and the inline test webapp
+*** First public version of the plugin, with some basic features
+*** Advanced features of Akka have not been yet tested/shown here (even under heavy load), but it's in plan for the next release
+*** In Plugin sources under the test folder there there are some initial unit and integration tests, and an inline test webapp
View
28 src/docs/guide/2 Usage.gdoc
@@ -1,5 +1,27 @@
-h1. Grails-Akka
+h4. Installing the plugin
+
+First you need to install the plugin into a Grails application:
+using the recommended way, configure it as a dependency in @BuildConfig.groovy@:
+{code}
+plugins {
+ compile ':akka:0.5'
+}
+{code}
+
+or the old way:
+{code}
+grails install-plugin akka
+{code}
+
+
+h4. Requirements
+
+* a Servlet 3.x container to run the Web application, so be sure to force it in @BuildConfig.groovy@:
+{code}
+grails.servlet.version = "3.0"
+{code}
+
+* Akka 2.x (as specified in plugin descriptor) and related dependencies,
+all downloaded from the Central Maven Repository (that must be enabled), and the Typesafe Maven Repository (defined inside the plugin).
-h2. Usage
-TODO ...
View
18 src/docs/guide/3 Tutorials.gdoc
@@ -1,5 +1,17 @@
-h1. Grails-Akka
+h4. Samples
+
+In Plugin sources under the [test|https://github.com/smartiniOnGitHub/grails-akka/tree/master/test/] folder
+there there are some initial unit and integration tests,
+and even an inline test webapp.
+
+Code is duplicated to avoid unnecessary complexity.
+
+Note that some code is more general than required for tests, but only to show some basic features.
+
+
+h4. Akka documentation
+
+Look at Akka API for Java, usable from Groovy and Java code,
+from here [Akka Java API|http://doc.akka.io/docs/akka/2.0.3/java/]
-h2. Tutorials
-TODO ...
View
11 src/docs/guide/4 Troubleshooting.gdoc
@@ -1,5 +1,10 @@
-h1. Grails-Akka
+h4. Tricks
+
+None.
+
+
+h4. Workarounds
+
+None.
-h2. Troubleshooting
-TODO ...
Please sign in to comment.
Something went wrong with that request. Please try again.