diff --git a/.gitattributes b/.gitattributes index 8151bc4fa..d820f7bf7 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,4 @@ -* text eol=lf -*.cmd text eol=crlf +* text eol=lf +*.cmd text eol=crlf +CrLf.java text eol=crlf +Lf.java text eol=lf \ No newline at end of file diff --git a/src/it/update-line-separator-test-mojo/LICENSE.txt b/src/it/update-line-separator-test-mojo/LICENSE.txt new file mode 100644 index 000000000..bdf8db0ee --- /dev/null +++ b/src/it/update-line-separator-test-mojo/LICENSE.txt @@ -0,0 +1,166 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + diff --git a/src/it/update-line-separator-test-mojo/invoker.properties b/src/it/update-line-separator-test-mojo/invoker.properties new file mode 100644 index 000000000..6a39f7344 --- /dev/null +++ b/src/it/update-line-separator-test-mojo/invoker.properties @@ -0,0 +1,23 @@ +### +# #%L +# License Maven Plugin +# %% +# Copyright (C) 2008 - 2011 CodeLutin, Codehaus, Tony Chemit +# %% +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Lesser Public License for more details. +# +# You should have received a copy of the GNU General Lesser Public +# License along with this program. If not, see +# . +# #L% +### +invoker.goals=clean compile +invoker.failureBehavior=fail-fast diff --git a/src/it/update-line-separator-test-mojo/pom.xml b/src/it/update-line-separator-test-mojo/pom.xml new file mode 100644 index 000000000..ddd682fb1 --- /dev/null +++ b/src/it/update-line-separator-test-mojo/pom.xml @@ -0,0 +1,120 @@ + + + + + + 4.0.0 + + org.codehaus.mojo.license.test + update-file-header-test-mojo + @project.version@ + + License Test :: update-file-header-specific + + 2012 + + + License Test + + + UTF-8 + 1.8 + 1.8 + + + pom + + + + + + + org.codehaus.mojo + license-maven-plugin + @project.version@ + + + + + + + + org.codehaus.mojo + license-maven-plugin + + true + true + + + + update-line-separator-test-crlf + + update-file-header + + process-sources + + gpl_v3 + + src/main/java/crlf + + CRLF + + + + update-line-separator-test-lf + + update-file-header + + process-sources + + gpl_v3 + + src/main/java/lf + + LF + + + + update-line-separator-test-str + + update-file-header + + process-sources + + gpl_v3 + + src/main/java/str + + STR + + + + + + + + + + diff --git a/src/it/update-line-separator-test-mojo/postbuild.groovy b/src/it/update-line-separator-test-mojo/postbuild.groovy new file mode 100644 index 000000000..81e60b2ec --- /dev/null +++ b/src/it/update-line-separator-test-mojo/postbuild.groovy @@ -0,0 +1,125 @@ +/* + * #%L + * License Maven Plugin + * %% + * Copyright (C) 2008 - 2011 CodeLutin, Codehaus, Tony Chemit + * %% + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * . + * #L% + */ + +def assertExistsDirectory(file) +{ + if ( !file.exists() || !file.isDirectory() ) + { + println(file.getAbsolutePath() + " file is missing or is not a directory.") + assert false + } + assert true +} + +def assertExistsFile(file) +{ + if ( !file.exists() || file.isDirectory() ) + { + println(file.getAbsolutePath() + " file is missing or a directory.") + assert false + } + assert true +} + +def assertContains(file, content, expected) +{ + if ( !content.contains(expected) ) + { + println(expected + " was not found in file [" + file + "]\n :" + content) + return false + } + return true +} + +def assertNotContains(file, content, expected) +{ + if ( content.contains(expected) ) + { + println(expected + " should not be found in file [" + file + "]\n :" + content) + return false + } + return true +} + +//def newLine = System.getProperty("line.separator") + +Calendar cal = Calendar.getInstance(); +cal.setTime(new Date()); +int currentYear = cal.get(Calendar.YEAR); +dateRange = "2012"; +if ( currentYear > 2012 ) +{ + dateRange += " - " + currentYear; +} +println("Current year: " + currentYear) +println("Date range to use: " + dateRange) + +// +// TEST CRLF +// + +file = new File(basedir, 'src/main/java/crlf/org/codehaus/mojo/license/Lf.java'); +assertExistsFile(file); + +content = file.text; +assert assertContains(file, content, 'Copyright (C) 2010 Tony\r\n'); + +file = new File(basedir, 'src/main/java/crlf/org/codehaus/mojo/license/CrLf.java'); +assertExistsFile(file); + +content = file.text; +assert assertContains(file, content, 'Copyright (C) 2010 Tony\r\n'); + +// +// TEST LF +// + +file = new File(basedir, 'src/main/java/lf/org/codehaus/mojo/license/Lf.java'); +assertExistsFile(file); + +content = file.text; +assert assertContains(file, content, 'Copyright (C) 2010 Tony\n'); + +file = new File(basedir, 'src/main/java/lf/org/codehaus/mojo/license/CrLf.java'); +assertExistsFile(file); + +content = file.text; +assert assertContains(file, content, 'Copyright (C) 2010 Tony\n'); + +// +// TEST CRLF +// + +file = new File(basedir, 'src/main/java/str/org/codehaus/mojo/license/Lf.java'); +assertExistsFile(file); + +content = file.text; +assert assertContains(file, content, 'Copyright (C) 2010 TonySTR'); + +file = new File(basedir, 'src/main/java/crlf/org/codehaus/mojo/license/CrLf.java'); +assertExistsFile(file); + +content = file.text; +assert assertContains(file, content, 'Copyright (C) 2010 TonySTR'); + + +return true; diff --git a/src/it/update-line-separator-test-mojo/src/main/java/crlf/org/codehaus/mojo/license/CrLf.java b/src/it/update-line-separator-test-mojo/src/main/java/crlf/org/codehaus/mojo/license/CrLf.java new file mode 100644 index 000000000..824df252e --- /dev/null +++ b/src/it/update-line-separator-test-mojo/src/main/java/crlf/org/codehaus/mojo/license/CrLf.java @@ -0,0 +1,21 @@ +/* + * #%L + * License Test :: do NOT update! + * %% + * Copyright (C) 2010 Tony + * %% + * Fake to be removed! + * #L% + */ + +/** + * this class owns a header, only license will be updated. + * + * @author tchemit dev@tchemit.fr + * @since 1.0 + */ +package org.codehaus.mojo.license; + +public class Lf +{ +} diff --git a/src/it/update-line-separator-test-mojo/src/main/java/crlf/org/codehaus/mojo/license/Lf.java b/src/it/update-line-separator-test-mojo/src/main/java/crlf/org/codehaus/mojo/license/Lf.java new file mode 100644 index 000000000..824df252e --- /dev/null +++ b/src/it/update-line-separator-test-mojo/src/main/java/crlf/org/codehaus/mojo/license/Lf.java @@ -0,0 +1,21 @@ +/* + * #%L + * License Test :: do NOT update! + * %% + * Copyright (C) 2010 Tony + * %% + * Fake to be removed! + * #L% + */ + +/** + * this class owns a header, only license will be updated. + * + * @author tchemit dev@tchemit.fr + * @since 1.0 + */ +package org.codehaus.mojo.license; + +public class Lf +{ +} diff --git a/src/it/update-line-separator-test-mojo/src/main/java/lf/org/codehaus/mojo/license/CrLf.java b/src/it/update-line-separator-test-mojo/src/main/java/lf/org/codehaus/mojo/license/CrLf.java new file mode 100644 index 000000000..824df252e --- /dev/null +++ b/src/it/update-line-separator-test-mojo/src/main/java/lf/org/codehaus/mojo/license/CrLf.java @@ -0,0 +1,21 @@ +/* + * #%L + * License Test :: do NOT update! + * %% + * Copyright (C) 2010 Tony + * %% + * Fake to be removed! + * #L% + */ + +/** + * this class owns a header, only license will be updated. + * + * @author tchemit dev@tchemit.fr + * @since 1.0 + */ +package org.codehaus.mojo.license; + +public class Lf +{ +} diff --git a/src/it/update-line-separator-test-mojo/src/main/java/lf/org/codehaus/mojo/license/Lf.java b/src/it/update-line-separator-test-mojo/src/main/java/lf/org/codehaus/mojo/license/Lf.java new file mode 100644 index 000000000..824df252e --- /dev/null +++ b/src/it/update-line-separator-test-mojo/src/main/java/lf/org/codehaus/mojo/license/Lf.java @@ -0,0 +1,21 @@ +/* + * #%L + * License Test :: do NOT update! + * %% + * Copyright (C) 2010 Tony + * %% + * Fake to be removed! + * #L% + */ + +/** + * this class owns a header, only license will be updated. + * + * @author tchemit dev@tchemit.fr + * @since 1.0 + */ +package org.codehaus.mojo.license; + +public class Lf +{ +} diff --git a/src/it/update-line-separator-test-mojo/src/main/java/str/org/codehaus/mojo/license/CrLf.java b/src/it/update-line-separator-test-mojo/src/main/java/str/org/codehaus/mojo/license/CrLf.java new file mode 100644 index 000000000..824df252e --- /dev/null +++ b/src/it/update-line-separator-test-mojo/src/main/java/str/org/codehaus/mojo/license/CrLf.java @@ -0,0 +1,21 @@ +/* + * #%L + * License Test :: do NOT update! + * %% + * Copyright (C) 2010 Tony + * %% + * Fake to be removed! + * #L% + */ + +/** + * this class owns a header, only license will be updated. + * + * @author tchemit dev@tchemit.fr + * @since 1.0 + */ +package org.codehaus.mojo.license; + +public class Lf +{ +} diff --git a/src/it/update-line-separator-test-mojo/src/main/java/str/org/codehaus/mojo/license/Lf.java b/src/it/update-line-separator-test-mojo/src/main/java/str/org/codehaus/mojo/license/Lf.java new file mode 100644 index 000000000..824df252e --- /dev/null +++ b/src/it/update-line-separator-test-mojo/src/main/java/str/org/codehaus/mojo/license/Lf.java @@ -0,0 +1,21 @@ +/* + * #%L + * License Test :: do NOT update! + * %% + * Copyright (C) 2010 Tony + * %% + * Fake to be removed! + * #L% + */ + +/** + * this class owns a header, only license will be updated. + * + * @author tchemit dev@tchemit.fr + * @since 1.0 + */ +package org.codehaus.mojo.license; + +public class Lf +{ +} diff --git a/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java index d7c361bf0..77b9bc2a0 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java @@ -98,7 +98,8 @@ public abstract class AbstractFileHeaderMojo extends AbstractLicenseNameMojo { private String sectionDelimiter; /** - * To specify a line separator to use. + * To specify a line separator to use. Providing "LF" and "CRLF" will instead use the characters "\n" and "\r\n", + * respectively. * * If not set, will use system property {@code line.separator}. */ @@ -396,6 +397,20 @@ public abstract class AbstractFileHeaderMojo extends AbstractLicenseNameMojo { */ protected abstract boolean isFailOnNotUptodateHeader(); + /** + * Converts line ending string, like LF or CRLF, to proper line separator character. + * + * @param lineSeparator Line separator that may be converted. + */ + public void setLineSeparator(String lineSeparator) { + try { + this.lineSeparator = Eol.valueOf(lineSeparator).getEolString(); + } catch (IllegalArgumentException e) { + LOG.warn("Unable to parse lineSeparator '{}', using it as-is.", lineSeparator); + this.lineSeparator = lineSeparator; + } + } + // ---------------------------------------------------------------------- // AbstractLicenseMojo Implementaton // ---------------------------------------------------------------------- @@ -466,6 +481,15 @@ public void init() throws Exception { if (isVerbose()) { LOG.info("Will use sectionDelimiter: {}", sectionDelimiter); } + if (isVerbose()) { + String verboseLineSeparator; + try { + verboseLineSeparator = Eol.from(lineSeparator).name(); + } catch (IllegalArgumentException e) { + verboseLineSeparator = lineSeparator; + } + LOG.info("Will use lineSeparator: {}", verboseLineSeparator); + } // add default extensions from header transformers for (Map.Entry entry : transformers.entrySet()) { diff --git a/src/main/java/org/codehaus/mojo/license/Eol.java b/src/main/java/org/codehaus/mojo/license/Eol.java index 42b1e395d..51f6c3e1d 100644 --- a/src/main/java/org/codehaus/mojo/license/Eol.java +++ b/src/main/java/org/codehaus/mojo/license/Eol.java @@ -74,4 +74,18 @@ public static Eol autodetect(Path file, Charset charset) throws IOException { public String getEolString() { return eolString; } + + public static Eol from(String eol) throws IllegalArgumentException { + switch (eol) { + case "\r\n": + return CRLF; + case "\n": + return LF; + default: + throw new IllegalArgumentException(String.format( + "Unable to convert Eol from %s", + eol + )); + } + } } diff --git a/src/site/apt/examples/update-file-header-config.apt.vm b/src/site/apt/examples/update-file-header-config.apt.vm index a00e44efd..283225586 100644 --- a/src/site/apt/examples/update-file-header-config.apt.vm +++ b/src/site/apt/examples/update-file-header-config.apt.vm @@ -41,6 +41,9 @@ Update File Header Examples * customize description section: Define a template to change the description section of a file header. + * lineSeparator: To specify a line separator to use. Providing "LF" and "CRLF" will instead use the characters "\n" + and "\r\n", respectively. + To see all extensions accepted run the <> goal. -------------------------------------------------------------------------------