Coverage Report

Coverage Report - org.apache.maven.plugins.pdf.DocumentModelBuilder

Classes in this File

Line Coverage

Branch Coverage

Complexity

DocumentModelBuilder

95 %

83/87

82 %

38/46

3,5

 package org.apache.maven.plugins.pdf;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 
 import org.apache.maven.doxia.document.DocumentAuthor;
 import org.apache.maven.doxia.document.DocumentCover;
 import org.apache.maven.doxia.document.DocumentMeta;
 import org.apache.maven.doxia.document.DocumentModel;
 import org.apache.maven.doxia.document.DocumentTOC;
 import org.apache.maven.doxia.document.DocumentTOCItem;
 import org.apache.maven.doxia.site.decoration.DecorationModel;
 import org.apache.maven.doxia.site.decoration.Menu;
 import org.apache.maven.doxia.site.decoration.MenuItem;
 import org.apache.maven.model.Developer;
 import org.apache.maven.project.MavenProject;
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.StringUtils;
 import org.apache.commons.io.input.XmlStreamReader;
 
 /**
  * Construct a DocumentModel from a MavenProject and related information.
  *
  * @author ltheussl
  * @version $Id$
  */
 public class DocumentModelBuilder
 {
     /** A MavenProject to extract the information. */
     private final MavenProject project;
 
     /** A DecorationModel to extract additional information. */
     private final DecorationModel decorationModel;
 
     /**
      * Constructor. Initialize a MavenProject to extract information from.
      *
      * @param project a MavenProject. May be null.
      */
     public DocumentModelBuilder( MavenProject project )
     {
         this( project, null );
     }
 
     /**
      * Constructor. Initialize a MavenProject and a DecorationModel to extract information from.
      *
      * @param project a MavenProject. May be null.
      * @param decorationModel a DecorationModel. May be null.
      */
     public DocumentModelBuilder( MavenProject project, DecorationModel decorationModel )
     {
         this.project = project;
         this.decorationModel = decorationModel;
     }
 
     /**
      * Get a DocumentModel.
      *
      * @return a DocumentModel. Always non-null.
      */
     public DocumentModel getDocumentModel()
     {
         return getDocumentModel( project, decorationModel, null );
     }
 
     /**
      * Get a DocumentModel.
      *
      * @param date overrides the default date in meta- and cover information.
      * @return a DocumentModel. Always non-null.
      */
     public DocumentModel getDocumentModel( Date date )
     {
         return getDocumentModel( project, decorationModel, date );
     }
 
     // ----------------------------------------------------------------------
     // Private methods
     // ----------------------------------------------------------------------
 
     /**
      * Extract a DocumentModel from a MavenProject.
      *
      * @param project a MavenProject. May be null.
      * @param decorationModel a DecorationModel. May be null.
      * @param date the date of the TOC. May be null in which case the build date will be used.
      *
      * @return a DocumentModel. Always non-null.
      */
     private static DocumentModel getDocumentModel( MavenProject project,
             DecorationModel decorationModel, Date date )
     {
         final Date now = ( date == null ? new Date() : date );
 
         final DocumentModel docModel = new DocumentModel();
 
         docModel.setModelEncoding( getProjectModelEncoding( project ) );
         docModel.setOutputName( project == null || project.getArtifactId() == null
                 ? "unnamed" : project.getArtifactId() );
         docModel.setMeta( getDocumentMeta( project, now ) );
         docModel.setCover( getDocumentCover( project, now ) );
         docModel.setToc( getDocumentTOC( decorationModel ) );
 
         return docModel;
     }
 
     /**
      * Extract a DocumentTOC from a DecorationModel.
      *
      * @param decorationModel a DecorationModel. May be null.
      * @return a DocumentTOC, always non-null.
      */
     private static DocumentTOC getDocumentTOC( DecorationModel decorationModel )
     {
         final DocumentTOC toc = new DocumentTOC();
 
         if ( decorationModel != null && decorationModel.getMenus() != null )
         {
             for ( final Menu menu  : decorationModel.getMenus() )
             {
                 for ( final MenuItem item : menu.getItems() )
                 {
                     final DocumentTOCItem documentTOCItem = new DocumentTOCItem();
                     documentTOCItem.setName( item.getName() );
                     documentTOCItem.setRef( item.getHref() );
                     toc.addItem( documentTOCItem );
                 }
             }
         }
 
         return toc;
     }
 
     /**
      * Extract meta information from a MavenProject.
      *
      * @param project a MavenProject. May be null.
      * @param date the date to use in meta. May be null.
      *
      * @return a DocumentMeta object. Always non-null.
      */
     private static DocumentMeta getDocumentMeta( MavenProject project, Date date )
     {
         final DocumentMeta meta = new DocumentMeta();
 
         meta.setAuthors( getAuthors( project ) );
         meta.setCreationDate( date );
         meta.setCreator( System.getProperty( "user.name" ) );
         meta.setDate( date );
         meta.setDescription( project == null ? null : project.getDescription() );
         //meta.setGenerator( generator );
         meta.setInitialCreator( System.getProperty( "user.name" ) );
         //meta.setLanguage( locale == null ? null : locale.getLanguage() );
         //meta.setPageSize( pageSize );
         meta.setSubject( getProjectName( project ) );
         meta.setTitle( getProjectName( project ) );
 
         return meta;
     }
 
     /**
      * Extract information for a DocumentCover from a MavenProject.
      *
      * @param project a MavenProject. May be null.
      * @param date the cover date. May be null.
      *
      * @return a DocumentCover object. Always non-null.
      */
     private static DocumentCover getDocumentCover( MavenProject project, Date date )
     {
         final DocumentCover cover = new DocumentCover();
 
         cover.setAuthors( getAuthors( project ) );
         //cover.setCompanyLogo( companyLogo );
         cover.setCompanyName( getProjectOrganizationName( project ) );
         cover.setCoverDate( date );
         cover.setCoverSubTitle( project == null ? null : "v. " + project.getVersion() );
         cover.setCoverTitle( getProjectName( project ) );
         //cover.setCoverType( type );
         cover.setCoverVersion( project == null ? null : project.getVersion() );
         //cover.setProjectLogo( projectLogo );
         cover.setProjectName( getProjectName( project ) );
 
         return cover;
     }
 
     /**
      * Wrap the list of project {@link Developer} to a list of {@link DocumentAuthor}.
      *
      * @param project the MavenProject to extract the authors from.
      * @return a list of DocumentAuthors from the project developers.
      * Returns null if project is null or contains no developers.
      */
     private static List<DocumentAuthor> getAuthors( MavenProject project )
     {
         if ( project == null || project.getDevelopers() == null )
         {
             return null;
         }
 
         final List<DocumentAuthor> ret = new ArrayList<DocumentAuthor>( 4 );
 
         for ( Object o : project.getDevelopers() )
         {
             final Developer developer = (Developer) o;
 
             final DocumentAuthor author = new DocumentAuthor();
             author.setName( developer.getName() );
             author.setEmail( developer.getEmail() );
             author.setCompanyName( developer.getOrganization() );
             StringBuilder roles = null;
 
             for ( final String role : developer.getRoles() )
             {
                 if ( roles == null )
                 {
                     roles = new StringBuilder( 32 );
                 }
                 else
                 {
                     roles.append( ',' ).append( ' ' );
                 }
                 roles.append( role );
             }
             if ( roles != null )
             {
                 author.setPosition( roles.toString() );
             }
 
             ret.add( author );
         }
 
         return ret;
     }
 
     /**
      * @param project the MavenProject to extract the project organization name from.
      * @return the project organization name if not empty, or the current System user name otherwise.
      */
     private static String getProjectOrganizationName( MavenProject project )
     {
         if ( project != null && project.getOrganization() != null
                 && StringUtils.isNotEmpty( project.getOrganization().getName() ) )
         {
             return project.getOrganization().getName();
         }
 
         return System.getProperty( "user.name" );
     }
 
     /**
      * Extract the name of the project.
      *
      * @param project the MavenProject to extract the project name from.
      * @return the project name, or the project groupId and artifactId if
      * the project name is empty, or null if project is null.
      */
     private static String getProjectName( MavenProject project )
     {
         if ( project == null )
         {
             return null;
         }
 
         if ( StringUtils.isEmpty( project.getName() ) )
         {
             return project.getGroupId() + ":" + project.getArtifactId();
         }
 
         return project.getName();
     }
 
     /**
      * Extract the encoding.
      *
      * @param project the MavenProject to extract the encoding name from.
      * @return the project encoding if defined, or UTF-8 otherwise, or null if project is null.
      */
     private static String getProjectModelEncoding( MavenProject project )
     {
         if ( project == null )
         {
             return null;
         }
 
         String encoding = project.getModel().getModelEncoding();
         // Workaround for MNG-4289
         XmlStreamReader reader = null;
         try
         {
             reader = new XmlStreamReader( project.getFile() );
             encoding = reader.getEncoding();
         }
         catch ( IOException e )
         {
             // nop
         }
         finally
         {
             IOUtil.close( reader );
         }
 
         if ( StringUtils.isEmpty( encoding ) )
         {
             return "UTF-8";
         }
 
         return encoding;
     }
 }

1		package org.apache.maven.plugins.pdf;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.IOException;
23		import java.util.ArrayList;
24		import java.util.Date;
25		import java.util.List;
26
27		import org.apache.maven.doxia.document.DocumentAuthor;
28		import org.apache.maven.doxia.document.DocumentCover;
29		import org.apache.maven.doxia.document.DocumentMeta;
30		import org.apache.maven.doxia.document.DocumentModel;
31		import org.apache.maven.doxia.document.DocumentTOC;
32		import org.apache.maven.doxia.document.DocumentTOCItem;
33		import org.apache.maven.doxia.site.decoration.DecorationModel;
34		import org.apache.maven.doxia.site.decoration.Menu;
35		import org.apache.maven.doxia.site.decoration.MenuItem;
36		import org.apache.maven.model.Developer;
37		import org.apache.maven.project.MavenProject;
38		import org.codehaus.plexus.util.IOUtil;
39		import org.codehaus.plexus.util.StringUtils;
40		import org.apache.commons.io.input.XmlStreamReader;
41
42		/**
43		* Construct a DocumentModel from a MavenProject and related information.
44		*
45		* @author ltheussl
46		* @version $Id$
47		*/
48		public class DocumentModelBuilder
49		{
50		/** A MavenProject to extract the information. */
51		private final MavenProject project;
52
53		/** A DecorationModel to extract additional information. */
54		private final DecorationModel decorationModel;
55
56		/**
57		* Constructor. Initialize a MavenProject to extract information from.
58		*
59		* @param project a MavenProject. May be null.
60		*/
61		public DocumentModelBuilder( MavenProject project )
62		{
63	2	this( project, null );
64	2	}
65
66		/**
67		* Constructor. Initialize a MavenProject and a DecorationModel to extract information from.
68		*
69		* @param project a MavenProject. May be null.
70		* @param decorationModel a DecorationModel. May be null.
71		*/
72		public DocumentModelBuilder( MavenProject project, DecorationModel decorationModel )
73	3	{
74	3	this.project = project;
75	3	this.decorationModel = decorationModel;
76	3	}
77
78		/**
79		* Get a DocumentModel.
80		*
81		* @return a DocumentModel. Always non-null.
82		*/
83		public DocumentModel getDocumentModel()
84		{
85	3	return getDocumentModel( project, decorationModel, null );
86		}
87
88		/**
89		* Get a DocumentModel.
90		*
91		* @param date overrides the default date in meta- and cover information.
92		* @return a DocumentModel. Always non-null.
93		*/
94		public DocumentModel getDocumentModel( Date date )
95		{
96	0	return getDocumentModel( project, decorationModel, date );
97		}
98
99		// ----------------------------------------------------------------------
100		// Private methods
101		// ----------------------------------------------------------------------
102
103		/**
104		* Extract a DocumentModel from a MavenProject.
105		*
106		* @param project a MavenProject. May be null.
107		* @param decorationModel a DecorationModel. May be null.
108		* @param date the date of the TOC. May be null in which case the build date will be used.
109		*
110		* @return a DocumentModel. Always non-null.
111		*/
112		private static DocumentModel getDocumentModel( MavenProject project,
113		DecorationModel decorationModel, Date date )
114		{
115	3	final Date now = ( date == null ? new Date() : date );
116
117	3	final DocumentModel docModel = new DocumentModel();
118
119	3	docModel.setModelEncoding( getProjectModelEncoding( project ) );
120	3	docModel.setOutputName( project == null \|\| project.getArtifactId() == null
121		? "unnamed" : project.getArtifactId() );
122	3	docModel.setMeta( getDocumentMeta( project, now ) );
123	3	docModel.setCover( getDocumentCover( project, now ) );
124	3	docModel.setToc( getDocumentTOC( decorationModel ) );
125
126	3	return docModel;
127		}
128
129		/**
130		* Extract a DocumentTOC from a DecorationModel.
131		*
132		* @param decorationModel a DecorationModel. May be null.
133		* @return a DocumentTOC, always non-null.
134		*/
135		private static DocumentTOC getDocumentTOC( DecorationModel decorationModel )
136		{
137	3	final DocumentTOC toc = new DocumentTOC();
138
139	3	if ( decorationModel != null && decorationModel.getMenus() != null )
140		{
141	1	for ( final Menu menu : decorationModel.getMenus() )
142		{
143	1	for ( final MenuItem item : menu.getItems() )
144		{
145	1	final DocumentTOCItem documentTOCItem = new DocumentTOCItem();
146	1	documentTOCItem.setName( item.getName() );
147	1	documentTOCItem.setRef( item.getHref() );
148	1	toc.addItem( documentTOCItem );
149	1	}
150	1	}
151		}
152
153	3	return toc;
154		}
155
156		/**
157		* Extract meta information from a MavenProject.
158		*
159		* @param project a MavenProject. May be null.
160		* @param date the date to use in meta. May be null.
161		*
162		* @return a DocumentMeta object. Always non-null.
163		*/
164		private static DocumentMeta getDocumentMeta( MavenProject project, Date date )
165		{
166	3	final DocumentMeta meta = new DocumentMeta();
167
168	3	meta.setAuthors( getAuthors( project ) );
169	3	meta.setCreationDate( date );
170	3	meta.setCreator( System.getProperty( "user.name" ) );
171	3	meta.setDate( date );
172	3	meta.setDescription( project == null ? null : project.getDescription() );
173		//meta.setGenerator( generator );
174	3	meta.setInitialCreator( System.getProperty( "user.name" ) );
175		//meta.setLanguage( locale == null ? null : locale.getLanguage() );
176		//meta.setPageSize( pageSize );
177	3	meta.setSubject( getProjectName( project ) );
178	3	meta.setTitle( getProjectName( project ) );
179
180	3	return meta;
181		}
182
183		/**
184		* Extract information for a DocumentCover from a MavenProject.
185		*
186		* @param project a MavenProject. May be null.
187		* @param date the cover date. May be null.
188		*
189		* @return a DocumentCover object. Always non-null.
190		*/
191		private static DocumentCover getDocumentCover( MavenProject project, Date date )
192		{
193	3	final DocumentCover cover = new DocumentCover();
194
195	3	cover.setAuthors( getAuthors( project ) );
196		//cover.setCompanyLogo( companyLogo );
197	3	cover.setCompanyName( getProjectOrganizationName( project ) );
198	3	cover.setCoverDate( date );
199	3	cover.setCoverSubTitle( project == null ? null : "v. " + project.getVersion() );
200	3	cover.setCoverTitle( getProjectName( project ) );
201		//cover.setCoverType( type );
202	3	cover.setCoverVersion( project == null ? null : project.getVersion() );
203		//cover.setProjectLogo( projectLogo );
204	3	cover.setProjectName( getProjectName( project ) );
205
206	3	return cover;
207		}
208
209		/**
210		* Wrap the list of project {@link Developer} to a list of {@link DocumentAuthor}.
211		*
212		* @param project the MavenProject to extract the authors from.
213		* @return a list of DocumentAuthors from the project developers.
214		* Returns null if project is null or contains no developers.
215		*/
216		private static List<DocumentAuthor> getAuthors( MavenProject project )
217		{
218	6	if ( project == null \|\| project.getDevelopers() == null )
219		{
220	2	return null;
221		}
222
223	4	final List<DocumentAuthor> ret = new ArrayList<DocumentAuthor>( 4 );
224
225	4	for ( Object o : project.getDevelopers() )
226		{
227	8	final Developer developer = (Developer) o;
228
229	8	final DocumentAuthor author = new DocumentAuthor();
230	8	author.setName( developer.getName() );
231	8	author.setEmail( developer.getEmail() );
232	8	author.setCompanyName( developer.getOrganization() );
233	8	StringBuilder roles = null;
234
235	8	for ( final String role : developer.getRoles() )
236		{
237	8	if ( roles == null )
238		{
239	4	roles = new StringBuilder( 32 );
240		}
241		else
242		{
243	4	roles.append( ',' ).append( ' ' );
244		}
245	8	roles.append( role );
246	8	}
247	8	if ( roles != null )
248		{
249	4	author.setPosition( roles.toString() );
250		}
251
252	8	ret.add( author );
253	8	}
254
255	4	return ret;
256		}
257
258		/**
259		* @param project the MavenProject to extract the project organization name from.
260		* @return the project organization name if not empty, or the current System user name otherwise.
261		*/
262		private static String getProjectOrganizationName( MavenProject project )
263		{
264	3	if ( project != null && project.getOrganization() != null
265		&& StringUtils.isNotEmpty( project.getOrganization().getName() ) )
266		{
267	2	return project.getOrganization().getName();
268		}
269
270	1	return System.getProperty( "user.name" );
271		}
272
273		/**
274		* Extract the name of the project.
275		*
276		* @param project the MavenProject to extract the project name from.
277		* @return the project name, or the project groupId and artifactId if
278		* the project name is empty, or null if project is null.
279		*/
280		private static String getProjectName( MavenProject project )
281		{
282	12	if ( project == null )
283		{
284	4	return null;
285		}
286
287	8	if ( StringUtils.isEmpty( project.getName() ) )
288		{
289	0	return project.getGroupId() + ":" + project.getArtifactId();
290		}
291
292	8	return project.getName();
293		}
294
295		/**
296		* Extract the encoding.
297		*
298		* @param project the MavenProject to extract the encoding name from.
299		* @return the project encoding if defined, or UTF-8 otherwise, or null if project is null.
300		*/
301		private static String getProjectModelEncoding( MavenProject project )
302		{
303	3	if ( project == null )
304		{
305	1	return null;
306		}
307
308	2	String encoding = project.getModel().getModelEncoding();
309		// Workaround for MNG-4289
310	2	XmlStreamReader reader = null;
311		try
312		{
313	2	reader = new XmlStreamReader( project.getFile() );
314	2	encoding = reader.getEncoding();
315		}
316	0	catch ( IOException e )
317		{
318		// nop
319		}
320		finally
321		{
322	2	IOUtil.close( reader );
323	2	}
324
325	2	if ( StringUtils.isEmpty( encoding ) )
326		{
327	0	return "UTF-8";
328		}
329
330	2	return encoding;
331		}
332		}