Coverage Report

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

Classes in this File

Line Coverage

Branch Coverage

Complexity

DocumentModelBuilder

98%

78/80

90%

43/48

2.667

 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.util.ArrayList;
 import java.util.Date;
 import java.util.Iterator;
 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.StringUtils;
 
 /**
  * Construct a DocumentModel from a MavenProject and related information.
  *
  * @author ltheussl
  * @version $Id: DocumentModelBuilder.java 787640 2009-06-23 11:36:59Z ltheussl $
  */
 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 Iterator it = decorationModel.getMenus().iterator(); it.hasNext(); )
             {
                 final Menu menu = (Menu) it.next();
 
                 for ( final Iterator it2 = menu.getItems().iterator(); it2.hasNext(); )
                 {
                     final MenuItem item = (MenuItem) it2.next();
 
                     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 getAuthors( MavenProject project )
     {
         if ( project == null || project.getDevelopers() == null )
         {
             return null;
         }
 
         final List ret = new ArrayList();
 
         for ( final Iterator it = project.getDevelopers().iterator(); it.hasNext(); )
         {
             final Developer developer = (Developer) it.next();
 
             final DocumentAuthor author = new DocumentAuthor();
             author.setName( developer.getName() );
             author.setEmail( developer.getEmail() );
             author.setCompanyName( developer.getOrganization() );
             StringBuffer roles = null;
 
             for ( final Iterator it2 = developer.getRoles().iterator(); it2.hasNext(); )
             {
                 final String role = (String) it2.next();
 
                 if ( roles == null )
                 {
                     roles = new StringBuffer();
                 }
 
                 roles.append( role );
 
                 if ( it2.hasNext() )
                 {
                     roles.append( ',' ).append( ' ' );
                 }
             }
             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;
         }
 
         if ( StringUtils.isEmpty( project.getModel().getModelEncoding() ) )
         {
             return "UTF-8";
         }
 
         return project.getModel().getModelEncoding();
     }
 }

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
23		import java.util.ArrayList;
24		import java.util.Date;
25		import java.util.Iterator;
26		import java.util.List;
27
28		import org.apache.maven.doxia.document.DocumentAuthor;
29		import org.apache.maven.doxia.document.DocumentCover;
30		import org.apache.maven.doxia.document.DocumentMeta;
31		import org.apache.maven.doxia.document.DocumentModel;
32		import org.apache.maven.doxia.document.DocumentTOC;
33		import org.apache.maven.doxia.document.DocumentTOCItem;
34		import org.apache.maven.doxia.site.decoration.DecorationModel;
35		import org.apache.maven.doxia.site.decoration.Menu;
36		import org.apache.maven.doxia.site.decoration.MenuItem;
37		import org.apache.maven.model.Developer;
38		import org.apache.maven.project.MavenProject;
39
40		import org.codehaus.plexus.util.StringUtils;
41
42		/**
43		* Construct a DocumentModel from a MavenProject and related information.
44		*
45		* @author ltheussl
46		* @version $Id: DocumentModelBuilder.java 787640 2009-06-23 11:36:59Z ltheussl $
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	4	{
74	4	this.project = project;
75	4	this.decorationModel = decorationModel;
76	4	}
77
78		/**
79		* Get a DocumentModel.
80		*
81		* @return a DocumentModel. Always non-null.
82		*/
83		public DocumentModel getDocumentModel()
84		{
85	4	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	4	final Date now = ( date == null ? new Date() : date );
116
117	4	final DocumentModel docModel = new DocumentModel();
118
119	4	docModel.setModelEncoding( getProjectModelEncoding( project ) );
120	4	docModel.setOutputName( project == null \|\| project.getArtifactId() == null
121		? "unnamed" : project.getArtifactId() );
122	4	docModel.setMeta( getDocumentMeta( project, now ) );
123	4	docModel.setCover( getDocumentCover( project, now ) );
124	4	docModel.setToc( getDocumentTOC( decorationModel ) );
125
126	4	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	4	final DocumentTOC toc = new DocumentTOC();
138
139	4	if ( decorationModel != null && decorationModel.getMenus() != null )
140		{
141	2	for ( final Iterator it = decorationModel.getMenus().iterator(); it.hasNext(); )
142		{
143	2	final Menu menu = (Menu) it.next();
144
145	2	for ( final Iterator it2 = menu.getItems().iterator(); it2.hasNext(); )
146		{
147	6	final MenuItem item = (MenuItem) it2.next();
148
149	6	final DocumentTOCItem documentTOCItem = new DocumentTOCItem();
150	6	documentTOCItem.setName( item.getName() );
151	6	documentTOCItem.setRef( item.getHref() );
152	6	toc.addItem( documentTOCItem );
153		}
154		}
155		}
156
157	4	return toc;
158		}
159
160		/**
161		* Extract meta information from a MavenProject.
162		*
163		* @param project a MavenProject. May be null.
164		* @param date the date to use in meta. May be null.
165		*
166		* @return a DocumentMeta object. Always non-null.
167		*/
168		private static DocumentMeta getDocumentMeta( MavenProject project, Date date )
169		{
170	4	final DocumentMeta meta = new DocumentMeta();
171
172	4	meta.setAuthors( getAuthors( project ) );
173	4	meta.setCreationDate( date );
174	4	meta.setCreator( System.getProperty( "user.name" ) );
175	4	meta.setDate( date );
176	4	meta.setDescription( project == null ? null : project.getDescription() );
177		//meta.setGenerator( generator );
178	4	meta.setInitialCreator( System.getProperty( "user.name" ) );
179		//meta.setLanguage( locale == null ? null : locale.getLanguage() );
180		//meta.setPageSize( pageSize );
181	4	meta.setSubject( getProjectName( project ) );
182	4	meta.setTitle( getProjectName( project ) );
183
184	4	return meta;
185		}
186
187		/**
188		* Extract information for a DocumentCover from a MavenProject.
189		*
190		* @param project a MavenProject. May be null.
191		* @param date the cover date. May be null.
192		*
193		* @return a DocumentCover object. Always non-null.
194		*/
195		private static DocumentCover getDocumentCover( MavenProject project, Date date )
196		{
197	4	final DocumentCover cover = new DocumentCover();
198
199	4	cover.setAuthors( getAuthors( project ) );
200		//cover.setCompanyLogo( companyLogo );
201	4	cover.setCompanyName( getProjectOrganizationName( project ) );
202	4	cover.setCoverDate( date );
203	4	cover.setCoverSubTitle( project == null ? null : "v. " + project.getVersion() );
204	4	cover.setCoverTitle( getProjectName( project ) );
205		//cover.setCoverType( type );
206	4	cover.setCoverVersion( project == null ? null : project.getVersion() );
207		//cover.setProjectLogo( projectLogo );
208	4	cover.setProjectName( getProjectName( project ) );
209
210	4	return cover;
211		}
212
213		/**
214		* Wrap the list of project {@link Developer} to a list of {@link DocumentAuthor}.
215		*
216		* @param project the MavenProject to extract the authors from.
217		* @return a list of DocumentAuthors from the project developers.
218		* Returns null if project is null or contains no developers.
219		*/
220		private static List getAuthors( MavenProject project )
221		{
222	8	if ( project == null \|\| project.getDevelopers() == null )
223		{
224	2	return null;
225		}
226
227	6	final List ret = new ArrayList();
228
229	6	for ( final Iterator it = project.getDevelopers().iterator(); it.hasNext(); )
230		{
231	8	final Developer developer = (Developer) it.next();
232
233	8	final DocumentAuthor author = new DocumentAuthor();
234	8	author.setName( developer.getName() );
235	8	author.setEmail( developer.getEmail() );
236	8	author.setCompanyName( developer.getOrganization() );
237	8	StringBuffer roles = null;
238
239	8	for ( final Iterator it2 = developer.getRoles().iterator(); it2.hasNext(); )
240		{
241	8	final String role = (String) it2.next();
242
243	8	if ( roles == null )
244		{
245	4	roles = new StringBuffer();
246		}
247
248	8	roles.append( role );
249
250	8	if ( it2.hasNext() )
251		{
252	4	roles.append( ',' ).append( ' ' );
253		}
254		}
255	8	if ( roles != null )
256		{
257	4	author.setPosition( roles.toString() );
258		}
259
260	8	ret.add( author );
261		}
262
263	6	return ret;
264		}
265
266		/**
267		* @param project the MavenProject to extract the project organization name from.
268		* @return the project organization name if not empty, or the current System user name otherwise.
269		*/
270		private static String getProjectOrganizationName( MavenProject project )
271		{
272	4	if ( project != null && project.getOrganization() != null
273		&& StringUtils.isNotEmpty( project.getOrganization().getName() ) )
274		{
275	2	return project.getOrganization().getName();
276		}
277
278	2	return System.getProperty( "user.name" );
279		}
280
281		/**
282		* Extract the name of the project.
283		*
284		* @param project the MavenProject to extract the project name from.
285		* @return the project name, or the project groupId and artifactId if
286		* the project name is empty, or null if project is null.
287		*/
288		private static String getProjectName( MavenProject project )
289		{
290	16	if ( project == null )
291		{
292	4	return null;
293		}
294
295	12	if ( StringUtils.isEmpty( project.getName() ) )
296		{
297	4	return project.getGroupId() + ":" + project.getArtifactId();
298		}
299
300	8	return project.getName();
301		}
302
303		/**
304		* Extract the encoding.
305		*
306		* @param project the MavenProject to extract the encoding name from.
307		* @return the project encoding if defined, or UTF-8 otherwise, or null if project is null.
308		*/
309		private static String getProjectModelEncoding( MavenProject project )
310		{
311	4	if ( project == null )
312		{
313	1	return null;
314		}
315
316	3	if ( StringUtils.isEmpty( project.getModel().getModelEncoding() ) )
317		{
318	0	return "UTF-8";
319		}
320
321	3	return project.getModel().getModelEncoding();
322		}
323		}