hazendaz / htmlcompressor-maven-plugin / 86

Committed 20 Apr 2025 08:12PM UTC coverage: 36.479% (+0.2%) from 36.249%

Build # 86

Build Type

push

github

Committed by

hazendaz

Commit Message

[maven-release-plugin] prepare release htmlcompressor-maven-plugin-1.10.2

Run Details

44 of 218 branches covered (20.18%)

Branch coverage included in aggregate %.

273 of 651 relevant lines covered (41.94%)

0.42 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

50.85

/src/main/java/com/tunyk/mvn/plugins/htmlcompressor/XmlCompressorMojo.java

/*
 *    Copyright 2011-2025 the original author or authors.
 *
 *    Licensed 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
 *
 *       https://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.
 */
package com.tunyk.mvn.plugins.htmlcompressor;

import java.nio.charset.Charset;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

/**
 * Compress XML files.
 */
@Mojo(name = "xml", defaultPhase = LifecyclePhase.COMPILE, requiresProject = false, threadSafe = true)
public class XmlCompressorMojo extends AbstractMojo {

    /**
     * File extensions to be processed.
     *
     * @deprecated use fileExtensions
     */
    @Deprecated
    @Parameter(property = "htmlcompressor.fileExt")
    private String[] fileExt;

    /** file extensions to be processed. */
    @Parameter(property = "htmlcompressor.fileExtensions")
    private String[] fileExtensions;

    /** if false all compression is off (default is true). */
    @Parameter(property = "htmlcompressor.enabled", defaultValue = "true")
    private boolean enabled = true;

    /** Skip run of plugin. */
    @Parameter(defaultValue = "false", alias = "skip", property = "skip")
    private boolean skip;

    /** if false keeps XML comments (default is true). */
    @Parameter(property = "htmlcompressor.removeComments", defaultValue = "true")
    private boolean removeComments = true;

    /** removes iter-tag whitespace characters (default is true). */
    @Parameter(property = "htmlcompressor.removeIntertagSpaces", defaultValue = "true")
    private boolean removeIntertagSpaces = true;

    /**
     * source folder where xml files are located.
     */
    @Parameter(property = "htmlcompressor.srcFolder", defaultValue = "${project.basedir}/src/main/resources")
    private String srcFolder = "src/main/resources";

    /**
     * target folder where compressed xml files will be placed.
     */
    @Parameter(property = "htmlcompressor.targetFolder", defaultValue = "${project.build.directory}/classes")
    private String targetFolder = "target/classes";

    /** Charset encoding for files to read and create. */
    @Parameter(property = "htmlcompressor.encoding", defaultValue = "UTF-8")
    private String encoding = "UTF-8";

    @Override
    public void execute() throws MojoExecutionException {
        // Check if plugin run should be skipped
        if (this.skip) {
            getLog().info("XMLCompressor is skipped");
            return;
        }

        if (!enabled) {
            getLog().info("XML compression was turned off.");
            return;
        }

        // Deprecated
        if (fileExt != null && fileExtensions == null) {
            fileExtensions = fileExt;
        }

        getLog().info("Compressing " + srcFolder);
        XmlCompressor xmlCompressor = new XmlCompressor(srcFolder, targetFolder);
        xmlCompressor.setFileExtensions(fileExtensions);
        xmlCompressor.setFileEncoding(Charset.forName(encoding));

        com.googlecode.htmlcompressor.compressor.XmlCompressor xmlCompressorHandler = new com.googlecode.htmlcompressor.compressor.XmlCompressor();
        xmlCompressorHandler.setEnabled(enabled);
        xmlCompressorHandler.setRemoveComments(removeComments);
        xmlCompressorHandler.setRemoveIntertagSpaces(removeIntertagSpaces);
        xmlCompressor.setXmlCompressor(xmlCompressorHandler);

        try {
            xmlCompressor.compress();
        } catch (Exception e) {
            throw new MojoExecutionException(e.getMessage());
        }

        getLog().info("XML compression completed.");
    }

    /**
     * Gets the file ext.
     *
     * @return the file ext
     *
     * @deprecated use getFileExtensions
     */
    @Deprecated
    public String[] getFileExt() {
        return fileExt;
    }

    /**
     * Sets the file ext.
     *
     * @param fileExt
     *            the new file ext
     *
     * @deprecated use setFileExtensions
     */
    @Deprecated
    public void setFileExt(String[] fileExt) {
        this.fileExt = fileExt;
    }

    /**
     * Gets the file extensions.
     *
     * @return the file extensions
     */
    public String[] getFileExtensions() {
        return fileExtensions;
    }

    /**
     * Sets the file ext.
     *
     * @param fileExtensions
     *            the new file extensions
     */
    public void setFileExtensions(String[] fileExtensions) {
        this.fileExtensions = fileExtensions;
    }

    /**
     * Gets the enabled.
     *
     * @return the enabled
     */
    public Boolean getEnabled() {
        return enabled;
    }

    /**
     * Sets the enabled.
     *
     * @param enabled
     *            the new enabled
     */
    public void setEnabled(Boolean enabled) {
        this.enabled = enabled;
    }

    /**
     * Gets the removes the comments.
     *
     * @return the removes the comments
     */
    public Boolean getRemoveComments() {
        return removeComments;
    }

    /**
     * Sets the removes the comments.
     *
     * @param removeComments
     *            the new removes the comments
     */
    public void setRemoveComments(Boolean removeComments) {
        this.removeComments = removeComments;
    }

    /**
     * Gets the removes the intertag spaces.
     *
     * @return the removes the intertag spaces
     */
    public Boolean getRemoveIntertagSpaces() {
        return removeIntertagSpaces;
    }

    /**
     * Sets the removes the intertag spaces.
     *
     * @param removeIntertagSpaces
     *            the new removes the intertag spaces
     */
    public void setRemoveIntertagSpaces(Boolean removeIntertagSpaces) {
        this.removeIntertagSpaces = removeIntertagSpaces;
    }

    /**
     * Gets the src folder.
     *
     * @return the src folder
     */
    public String getSrcFolder() {
        return srcFolder;
    }

    /**
     * Sets the src folder.
     *
     * @param srcFolder
     *            the new src folder
     */
    public void setSrcFolder(String srcFolder) {
        this.srcFolder = srcFolder;
    }

    /**
     * Gets the target folder.
     *
     * @return the target folder
     */
    public String getTargetFolder() {
        return targetFolder;
    }

    /**
     * Sets the target folder.
     *
     * @param targetFolder
     *            the new target folder
     */
    public void setTargetFolder(String targetFolder) {
        this.targetFolder = targetFolder;
    }
}

1	/*
2	* Copyright 2011-2025 the original author or authors.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* https://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16	package com.tunyk.mvn.plugins.htmlcompressor;
17
18	import java.nio.charset.Charset;
19
20	import org.apache.maven.plugin.AbstractMojo;
21	import org.apache.maven.plugin.MojoExecutionException;
22	import org.apache.maven.plugins.annotations.LifecyclePhase;
23	import org.apache.maven.plugins.annotations.Mojo;
24	import org.apache.maven.plugins.annotations.Parameter;
25
26	/**
27	* Compress XML files.
28	*/
29	@Mojo(name = "xml", defaultPhase = LifecyclePhase.COMPILE, requiresProject = false, threadSafe = true)
30	public class XmlCompressorMojo extends AbstractMojo {	1✔
31
32	/**
33	* File extensions to be processed.
34	*
35	* @deprecated use fileExtensions
36	*/
37	@Deprecated
38	@Parameter(property = "htmlcompressor.fileExt")
39	private String[] fileExt;
40
41	/** file extensions to be processed. */
42	@Parameter(property = "htmlcompressor.fileExtensions")
43	private String[] fileExtensions;
44
45	/** if false all compression is off (default is true). */
46	@Parameter(property = "htmlcompressor.enabled", defaultValue = "true")	1✔
47	private boolean enabled = true;
48
49	/** Skip run of plugin. */
50	@Parameter(defaultValue = "false", alias = "skip", property = "skip")
51	private boolean skip;
52
53	/** if false keeps XML comments (default is true). */
54	@Parameter(property = "htmlcompressor.removeComments", defaultValue = "true")	1✔
55	private boolean removeComments = true;
56
57	/** removes iter-tag whitespace characters (default is true). */
58	@Parameter(property = "htmlcompressor.removeIntertagSpaces", defaultValue = "true")	1✔
59	private boolean removeIntertagSpaces = true;
60
61	/**
62	* source folder where xml files are located.
63	*/
64	@Parameter(property = "htmlcompressor.srcFolder", defaultValue = "${project.basedir}/src/main/resources")	1✔
65	private String srcFolder = "src/main/resources";
66
67	/**
68	* target folder where compressed xml files will be placed.
69	*/
70	@Parameter(property = "htmlcompressor.targetFolder", defaultValue = "${project.build.directory}/classes")	1✔
71	private String targetFolder = "target/classes";
72
73	/** Charset encoding for files to read and create. */
74	@Parameter(property = "htmlcompressor.encoding", defaultValue = "UTF-8")	1✔
75	private String encoding = "UTF-8";
76
77	@Override
78	public void execute() throws MojoExecutionException {
79	// Check if plugin run should be skipped
80	if (this.skip) {	1!
81	getLog().info("XMLCompressor is skipped");	×
82	return;	×
83	}
84
85	if (!enabled) {	1!
86	getLog().info("XML compression was turned off.");	×
87	return;	×
88	}
89
90	// Deprecated
91	if (fileExt != null && fileExtensions == null) {	1!
92	fileExtensions = fileExt;	×
93	}
94
95	getLog().info("Compressing " + srcFolder);	1✔
96	XmlCompressor xmlCompressor = new XmlCompressor(srcFolder, targetFolder);	1✔
97	xmlCompressor.setFileExtensions(fileExtensions);	1✔
98	xmlCompressor.setFileEncoding(Charset.forName(encoding));	1✔
99
100	com.googlecode.htmlcompressor.compressor.XmlCompressor xmlCompressorHandler = new com.googlecode.htmlcompressor.compressor.XmlCompressor();	1✔
101	xmlCompressorHandler.setEnabled(enabled);	1✔
102	xmlCompressorHandler.setRemoveComments(removeComments);	1✔
103	xmlCompressorHandler.setRemoveIntertagSpaces(removeIntertagSpaces);	1✔
104	xmlCompressor.setXmlCompressor(xmlCompressorHandler);	1✔
105
106	try {
107	xmlCompressor.compress();	1✔
108	} catch (Exception e) {	×
109	throw new MojoExecutionException(e.getMessage());	×
110	}	1✔
111
112	getLog().info("XML compression completed.");	1✔
113	}	1✔
114
115	/**
116	* Gets the file ext.
117	*
118	* @return the file ext
119	*
120	* @deprecated use getFileExtensions
121	*/
122	@Deprecated
123	public String[] getFileExt() {
124	return fileExt;	×
125	}
126
127	/**
128	* Sets the file ext.
129	*
130	* @param fileExt
131	* the new file ext
132	*
133	* @deprecated use setFileExtensions
134	*/
135	@Deprecated
136	public void setFileExt(String[] fileExt) {
137	this.fileExt = fileExt;	×
138	}	×
139
140	/**
141	* Gets the file extensions.
142	*
143	* @return the file extensions
144	*/
145	public String[] getFileExtensions() {
146	return fileExtensions;	×
147	}
148
149	/**
150	* Sets the file ext.
151	*
152	* @param fileExtensions
153	* the new file extensions
154	*/
155	public void setFileExtensions(String[] fileExtensions) {
156	this.fileExtensions = fileExtensions;	×
157	}	×
158
159	/**
160	* Gets the enabled.
161	*
162	* @return the enabled
163	*/
164	public Boolean getEnabled() {
165	return enabled;	×
166	}
167
168	/**
169	* Sets the enabled.
170	*
171	* @param enabled
172	* the new enabled
173	*/
174	public void setEnabled(Boolean enabled) {
175	this.enabled = enabled;	×
176	}	×
177
178	/**
179	* Gets the removes the comments.
180	*
181	* @return the removes the comments
182	*/
183	public Boolean getRemoveComments() {
184	return removeComments;	×
185	}
186
187	/**
188	* Sets the removes the comments.
189	*
190	* @param removeComments
191	* the new removes the comments
192	*/
193	public void setRemoveComments(Boolean removeComments) {
194	this.removeComments = removeComments;	×
195	}	×
196
197	/**
198	* Gets the removes the intertag spaces.
199	*
200	* @return the removes the intertag spaces
201	*/
202	public Boolean getRemoveIntertagSpaces() {
203	return removeIntertagSpaces;	×
204	}
205
206	/**
207	* Sets the removes the intertag spaces.
208	*
209	* @param removeIntertagSpaces
210	* the new removes the intertag spaces
211	*/
212	public void setRemoveIntertagSpaces(Boolean removeIntertagSpaces) {
213	this.removeIntertagSpaces = removeIntertagSpaces;	×
214	}	×
215
216	/**
217	* Gets the src folder.
218	*
219	* @return the src folder
220	*/
221	public String getSrcFolder() {
222	return srcFolder;	×
223	}
224
225	/**
226	* Sets the src folder.
227	*
228	* @param srcFolder
229	* the new src folder
230	*/
231	public void setSrcFolder(String srcFolder) {
232	this.srcFolder = srcFolder;	1✔
233	}	1✔
234
235	/**
236	* Gets the target folder.
237	*
238	* @return the target folder
239	*/
240	public String getTargetFolder() {
241	return targetFolder;	×
242	}
243
244	/**
245	* Sets the target folder.
246	*
247	* @param targetFolder
248	* the new target folder
249	*/
250	public void setTargetFolder(String targetFolder) {
251	this.targetFolder = targetFolder;	1✔
252	}	1✔
253	}

hazendaz / htmlcompressor-maven-plugin / 86

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous