Author: tchemit Date: 2010-09-25 11:11:50 +0200 (Sat, 25 Sep 2010) New Revision: 968 Url: http://nuiton.org/repositories/revision/eugene/968 Log: update doc Modified: trunk/maven-eugene-plugin/src/site/fr/rst/index.rst trunk/maven-eugene-plugin/src/site/fr/rst/usage.rst Modified: trunk/maven-eugene-plugin/src/site/fr/rst/index.rst =================================================================== (Binary files differ) Modified: trunk/maven-eugene-plugin/src/site/fr/rst/usage.rst =================================================================== --- trunk/maven-eugene-plugin/src/site/fr/rst/usage.rst 2010-09-25 00:30:35 UTC (rev 967) +++ trunk/maven-eugene-plugin/src/site/fr/rst/usage.rst 2010-09-25 09:11:50 UTC (rev 968) @@ -96,11 +96,13 @@ </goals> </execution> -Une entrée peut avoir trois formes : +Une entrée peut avoir cinq formes : - <input>XXX</input> : utilise la phase XXX avec sa configuration par défaut. - <input>dir:includes</input> : utilise le répertoire donné et utilise le 'pattern' d'exclusion pour définir la phase à utiliser. -- <input>XXX:dir:includes</input> : utilise la phase XXX avec le répertoire et le 'pattern d'inclusion' donnés. +- <input>classpath:XXX:dir:includes</input> : utilise la phase XXX avec recherche dans le classpath à partir du répertoire et le 'pattern d'inclusion' donnés. +- <input>dir:includes</input> : utilise le répertoire donné et utilise le 'pattern' d'exclusion pour définir la phase à utiliser. +- <input>classpath:XXX:dir:includes</input> : utilise la phase XXX avec recherche dans le classpath et le 'pattern d'inclusion' donnés. Example: @@ -110,7 +112,9 @@ <configuration> <inputs>zargo</inputs> <inputs>src/main/myzargo:**/*.zargo</inputs> - <inputs>zargo:src/main/myzargo2:**/*.zargo2</inputs> + <inputs>classpath:/myzargo:.*\.zargo</inputs> + <inputs>zargo:src/main/myzargo:**/*.zargo</inputs> + <inputs>classpath:zargo:/myzargo:.*\.zargo</inputs> </configuration> <goals> <goal>smart-generate</goal> @@ -118,6 +122,81 @@ </execution> +Utilisation du classpath (depuis 2.2) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +On autorise désormais la recherche de fichiers dans le classpath, cela est util +par exemple, lorsque le modèle est dans différents modules d'un projet maven. + +On distingue deux sortes de recherche dans le class-path : + +- Une recherche exacte on on donne directement le nom du fichier recherché. + + Dans l'exemple suivant, on recherche exactement le fichier /xmi/myModel.zargo + dans le class-path : + +:: + + <execution> + <configuration> + <inputs> + <input>classpath:zargo:/xmi:myModel.zargo</input> + </inputs> + </configuration> + <goals> + <goal>smart-generate</goal> + </goals> + </execution> + +- Une recherche non exacte (avec des patterns), dans ce cas la pattern + d'inclusion (contrairement au cas des fichiers) doit être un expression + régulière : + + Dans l'exemple suivant, on veut traiter tous les fichiers zargo contenus dans + le class-path : +:: + + <execution> + <configuration> + <inputs> + <input>classpath:zargo:/:.*\.zargo</input> + </inputs> + </configuration> + <goals> + <goal>smart-generate</goal> + </goals> + </execution> + +Techniquement le plugin va rechercher les fichiers à traiter dans le class-path +et les extraire vers un répertoire précis (donné par le paramètre extractDirectory/inputType) +du mojo. + +En reprenant notre premier exemple, cela donnera : + +:: + +myProject +. +`-- target + `-- extracted-sources + `-- zargo + `-- xmi + |-- myModel.properties + `-- myModel.zargo + + +Une fois ces données extrait, le plugin utilisera ces données comme un input +classique sur fichiers : + +:: + + <input>zargo:target/extracted-sources/zargo:xmi/myModel.zargo</input> + +Note:: + + On notera que les répertoires dont viennent les données du class-path sont + conservés pour éviter toute collision. + phases ******