1 package org.andromda.maven.plugin.site;
2
3 import java.util.ArrayList;
4 import java.util.Iterator;
5 import java.util.List;
6
7 import org.apache.maven.plugin.AbstractMojo;
8 import org.apache.maven.plugin.MojoExecutionException;
9
10
11
12
13
14
15
16
17
18
19 public class HelpMojo
20 extends AbstractMojo
21 {
22
23
24
25
26
27 private boolean detail;
28
29
30
31
32
33
34 private java.lang.String goal;
35
36
37
38
39
40
41 private int lineLength;
42
43
44
45
46
47
48 private int indentSize;
49
50
51
52 public void execute()
53 throws MojoExecutionException
54 {
55 if ( lineLength <= 0 )
56 {
57 getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
58 lineLength = 80;
59 }
60 if ( indentSize <= 0 )
61 {
62 getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
63 indentSize = 2;
64 }
65
66 StringBuffer sb = new StringBuffer();
67
68 append( sb, "org.andromda.maven.plugins.site:andromda-site-plugin:3.5-SNAPSHOT", 0 );
69 append( sb, "", 0 );
70
71 append( sb, "AndroMDA Site Plugin", 0 );
72 append( sb, "A plugin that enhances the maven site plugin to suit AndroMDA\'s modifications. It creates the namespace and profile documentation, copy and unpack site artifacts.", 1 );
73 append( sb, "", 0 );
74
75 if ( goal == null || goal.length() <= 0 )
76 {
77 append( sb, "This plugin has 5 goals:", 0 );
78 append( sb, "", 0 );
79 }
80
81 if ( goal == null || goal.length() <= 0 || "copy-documentation".equals( goal ) )
82 {
83 append( sb, "andromda-site:copy-documentation", 0 );
84 append( sb, "Goal that copies the required AndroMDA site files to suitable locations preparing for deployment.", 1 );
85 append( sb, "", 0 );
86 if ( detail )
87 {
88 append( sb, "Available parameters:", 1 );
89 append( sb, "", 0 );
90
91 append( sb, "animalQuizOutputDirectory", 2 );
92 append( sb, "Path to the destination directory to copy the animal-quiz model", 3 );
93 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
94 append( sb, "", 0 );
95
96 append( sb, "animalQuizSourcePath", 2 );
97 append( sb, "Path to the animal-quiz model", 3 );
98 append( sb, "Expression: ${basedir}/../samples/animal-quiz/mda/src/main/uml/AnimalQuiz.xml.zip", 3 );
99 append( sb, "", 0 );
100
101 append( sb, "carRentalSystemOutputDirectory", 2 );
102 append( sb, "Path to the destination directory to copy the car-rental-system model", 3 );
103 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
104 append( sb, "", 0 );
105
106 append( sb, "carRentalSystemSourcePath", 2 );
107 append( sb, "Path to the car-rental-system model", 3 );
108 append( sb, "Expression: ${basedir}/../samples/car-rental-system/mda/src/main/uml/CarRentalSystem.xml.zip", 3 );
109 append( sb, "", 0 );
110
111 append( sb, "documentationOutputDirectory", 2 );
112 append( sb, "The documentation output directory used to copy the generated site reporting artifacts", 3 );
113 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
114 append( sb, "", 0 );
115
116 append( sb, "documentationSourceDirectory", 2 );
117 append( sb, "The directory containing the documentation site reporting artifacts", 3 );
118 append( sb, "Expression: ${project.reporting.outputDirectory}", 3 );
119 append( sb, "", 0 );
120
121 append( sb, "mappingsOutputDirectory", 2 );
122 append( sb, "Path to the mapping destination directory", 3 );
123 append( sb, "Expression: ${project.reporting.outputDirectory}/mappings", 3 );
124 append( sb, "", 0 );
125
126 append( sb, "mappingsSourceDirectory", 2 );
127 append( sb, "Path to the mapping source directory containing the mappings", 3 );
128 append( sb, "Expression: ${basedir}/../andromda-etc/mappings", 3 );
129 append( sb, "", 0 );
130
131 append( sb, "projectName (Default: ${project.name})", 2 );
132 append( sb, "The name of the project injected from pom.xml. Not used.", 3 );
133 append( sb, "", 0 );
134 }
135 }
136
137 if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
138 {
139 append( sb, "andromda-site:help", 0 );
140 append( sb, "Display help information on andromda-site-plugin.\nCall\n\u00a0\u00a0mvn\u00a0andromda-site:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
141 append( sb, "", 0 );
142 if ( detail )
143 {
144 append( sb, "Available parameters:", 1 );
145 append( sb, "", 0 );
146
147 append( sb, "detail (Default: false)", 2 );
148 append( sb, "If true, display all settable properties for each goal.", 3 );
149 append( sb, "Expression: ${detail}", 3 );
150 append( sb, "", 0 );
151
152 append( sb, "goal", 2 );
153 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
154 append( sb, "Expression: ${goal}", 3 );
155 append( sb, "", 0 );
156
157 append( sb, "indentSize (Default: 2)", 2 );
158 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
159 append( sb, "Expression: ${indentSize}", 3 );
160 append( sb, "", 0 );
161
162 append( sb, "lineLength (Default: 80)", 2 );
163 append( sb, "The maximum length of a display line, should be positive.", 3 );
164 append( sb, "Expression: ${lineLength}", 3 );
165 append( sb, "", 0 );
166 }
167 }
168
169 if ( goal == null || goal.length() <= 0 || "namespace-xsl".equals( goal ) )
170 {
171 append( sb, "andromda-site:namespace-xsl", 0 );
172 append( sb, "Used to perform the transformation of the namespace XSL document to namespace.xml xdoc format within the site plugin.", 1 );
173 append( sb, "", 0 );
174 if ( detail )
175 {
176 append( sb, "Available parameters:", 1 );
177 append( sb, "", 0 );
178
179 append( sb, "namespaceDocumentPath", 2 );
180 append( sb, "Path to the project namespace.xml", 3 );
181 append( sb, "Expression: ${basedir}/src/main/resources/META-INF/andromda/namespace.xml", 3 );
182 append( sb, "", 0 );
183
184 append( sb, "namespaceOutputPath", 2 );
185 append( sb, "Path to the project namespace document output", 3 );
186 append( sb, "Expression: ${basedir}/src/site/xdoc/namespace.xml", 3 );
187 append( sb, "", 0 );
188
189 append( sb, "namespaceTransformationPath", 2 );
190 append( sb, "Not used", 3 );
191 append( sb, "Expression: ${basedir}/src/main/resources/META-INF/xsl/namespace.xsl", 3 );
192 append( sb, "", 0 );
193
194 append( sb, "projectName (Default: ${project.name})", 2 );
195 append( sb, "The name of the project injected from pom.xml", 3 );
196 append( sb, "", 0 );
197 }
198 }
199
200 if ( goal == null || goal.length() <= 0 || "profile-xsl".equals( goal ) )
201 {
202 append( sb, "andromda-site:profile-xsl", 0 );
203 append( sb, "Used to perform the transformation of the profile XSL document to profile.xml xdoc format within the site plugin.", 1 );
204 append( sb, "", 0 );
205 if ( detail )
206 {
207 append( sb, "Available parameters:", 1 );
208 append( sb, "", 0 );
209
210 append( sb, "profileDocumentPath", 2 );
211 append( sb, "Path to the project profile.xml", 3 );
212 append( sb, "Expression: ${basedir}/src/main/resources/META-INF/andromda/profile.xml", 3 );
213 append( sb, "", 0 );
214
215 append( sb, "profileOutputPath", 2 );
216 append( sb, "Path to the project profile document output", 3 );
217 append( sb, "Expression: ${basedir}/src/site/xdoc/profile.xml", 3 );
218 append( sb, "", 0 );
219
220 append( sb, "profileTransformationPath", 2 );
221 append( sb, "Not used.", 3 );
222 append( sb, "Expression: ${basedir}/src/main/resources/META-INF/xsl/profile.xsl", 3 );
223 append( sb, "", 0 );
224
225 append( sb, "projectName (Default: ${project.name})", 2 );
226 append( sb, "The name of the project injected from pom.xml", 3 );
227 append( sb, "", 0 );
228 }
229 }
230
231 if ( goal == null || goal.length() <= 0 || "unpack-documentation".equals( goal ) )
232 {
233 append( sb, "andromda-site:unpack-documentation", 0 );
234 append( sb, "Goal that unpacks the required AndroMDA site zip packages to suitable locations preparing for deployment.", 1 );
235 append( sb, "", 0 );
236 if ( detail )
237 {
238 append( sb, "Available parameters:", 1 );
239 append( sb, "", 0 );
240
241 append( sb, "jmiApiOutputDirectory", 2 );
242 append( sb, "Path to the JMI 1.4 API destination extraction directory", 3 );
243 append( sb, "Expression: ${basedir}/../../target/site", 3 );
244 append( sb, "", 0 );
245
246 append( sb, "jmiApiSourcePath", 2 );
247 append( sb, "Path to the JMI 1.4 API zip source", 3 );
248 append( sb, "Expression: ${basedir}/src/site/resources/resources/jmi-uml1.4.zip", 3 );
249 append( sb, "", 0 );
250
251 append( sb, "projectName (Default: ${project.name})", 2 );
252 append( sb, "The name of the project injected from pom.xml. Not used.", 3 );
253 append( sb, "", 0 );
254
255 append( sb, "umlDocCarRentalSampleOutputDirectory", 2 );
256 append( sb, "Path to the UmlDoc car-rental-sample extraction directory", 3 );
257 append( sb, "Expression: ${basedir}/../../target/site", 3 );
258 append( sb, "", 0 );
259
260 append( sb, "umlDocCarRentalSampleSourcePath", 2 );
261 append( sb, "Path to the UmlDoc car-rental-sample zip source", 3 );
262 append( sb, "Expression: ${basedir}/src/site/resources/resources/car-rental-umldoc.zip", 3 );
263 append( sb, "", 0 );
264 }
265 }
266
267 if ( getLog().isInfoEnabled() )
268 {
269 getLog().info( sb.toString() );
270 }
271 }
272
273
274
275
276
277
278
279
280
281
282 private static String repeat( String str, int repeat )
283 {
284 StringBuffer buffer = new StringBuffer( repeat * str.length() );
285
286 for ( int i = 0; i < repeat; i++ )
287 {
288 buffer.append( str );
289 }
290
291 return buffer.toString();
292 }
293
294
295
296
297
298
299
300
301
302 private void append( StringBuffer sb, String description, int indent )
303 {
304 for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
305 {
306 sb.append( it.next().toString() ).append( '\n' );
307 }
308 }
309
310
311
312
313
314
315
316
317
318
319
320 private static List toLines( String text, int indent, int indentSize, int lineLength )
321 {
322 List lines = new ArrayList();
323
324 String ind = repeat( "\t", indent );
325 String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
326 for ( int i = 0; i < plainLines.length; i++ )
327 {
328 toLines( lines, ind + plainLines[i], indentSize, lineLength );
329 }
330
331 return lines;
332 }
333
334
335
336
337
338
339
340
341
342 private static void toLines( List lines, String line, int indentSize, int lineLength )
343 {
344 int lineIndent = getIndentLevel( line );
345 StringBuffer buf = new StringBuffer( 256 );
346 String[] tokens = line.split( " +" );
347 for ( int i = 0; i < tokens.length; i++ )
348 {
349 String token = tokens[i];
350 if ( i > 0 )
351 {
352 if ( buf.length() + token.length() >= lineLength )
353 {
354 lines.add( buf.toString() );
355 buf.setLength( 0 );
356 buf.append( repeat( " ", lineIndent * indentSize ) );
357 }
358 else
359 {
360 buf.append( ' ' );
361 }
362 }
363 for ( int j = 0; j < token.length(); j++ )
364 {
365 char c = token.charAt( j );
366 if ( c == '\t' )
367 {
368 buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
369 }
370 else if ( c == '\u00A0' )
371 {
372 buf.append( ' ' );
373 }
374 else
375 {
376 buf.append( c );
377 }
378 }
379 }
380 lines.add( buf.toString() );
381 }
382
383
384
385
386
387
388
389 private static int getIndentLevel( String line )
390 {
391 int level = 0;
392 for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
393 {
394 level++;
395 }
396 for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
397 {
398 if ( line.charAt( i ) == '\t' )
399 {
400 level++;
401 break;
402 }
403 }
404 return level;
405 }
406 }