August 2009 - Maven-license-plugin-commits - mailman.cloud.codelutin.com

r1631 - in trunk/src: main/java/org/nuiton/license/header main/java/org/nuiton/license/header/generator main/resources main/resources/META-INF main/resources/META-INF/services site/rst
by tchemit＠users.nuiton.org Aug. 26, 2009

Aug. 26, 2009

Author: tchemit Date: 2009-08-26 22:26:44 +0200 (Wed, 26 Aug 2009) New Revision: 1631 Added: trunk/src/main/java/org/nuiton/license/header/UpdateHeaderPlugin.java trunk/src/main/java/org/nuiton/license/header/generator/JavaHeaderGenerator.java trunk/src/main/java/org/nuiton/license/header/generator/XmlHeaderGenerator.java trunk/src/main/resources/META-INF/ trunk/src/main/resources/META-INF/services/ trunk/src/main/resources/META-INF/services/org.nuiton.license.header.generator.HeaderGenerator trunk/src/site/rst/usage.rst Log: fix bug #28, rethink the goal : now only one update-header Added: trunk/src/main/java/org/nuiton/license/header/UpdateHeaderPlugin.java =================================================================== --- trunk/src/main/java/org/nuiton/license/header/UpdateHeaderPlugin.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/header/UpdateHeaderPlugin.java 2009-08-26 20:26:44 UTC (rev 1631) @@ -0,0 +1,385 @@ +/** + * *##% Plugin maven de changement de license + * Copyright (C) 2008 - 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* + */ +package org.nuiton.license.header; + +import org.nuiton.processor.LicenseProcessor; +import org.apache.maven.plugin.MojoExecutionException; + +import java.io.BufferedReader; +import java.io.File; +import java.io.IOException; +import java.util.Calendar; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.ServiceLoader; +import java.util.TreeMap; +import org.apache.maven.project.MavenProject; +import org.nuiton.AbstractPlugin; +import org.nuiton.license.License; +import org.nuiton.license.LicenseFactory; +import org.nuiton.license.header.generator.HeaderGenerator; +import org.nuiton.util.PluginHelper; + +/** + * The goal to update (or add) the licence header on some files. + * + * @author chemit + * @requiresProject true + * @goal update-header + * + * @since 1.0.1 + */ +public class UpdateHeaderPlugin extends AbstractPlugin { + + /** + * Dependance du projet. + * + * @parameter default-value="${project}" + * @required + * @since 1.0.0 + */ + protected MavenProject project; + /** + * Encoding a utiliser pour lire et ecrire les fichiers. + * + * @parameter expression="${license.encoding}" default-value="${project.build.sourceEncoding}" + * @required + * @since 1.0.0 + */ + protected String encoding; + /** + * Un flag pour forcer la generation. + * + * @parameter expression="${license.force}" default-value="false" + * @since 1.0.0 + */ + protected boolean force; + /** + * l'annee de creation du module (sera place dans le header) + * + * @parameter expression="${license.inceptionYear}" default-value="${project.inceptionYear}" + * @required + * @since 1.0.0 + */ + protected String inceptionYear; + /** + * le nom de l'organisation (sera place dans le header) + * + * @parameter expression="${license.organizationName}" default-value="${project.organization.name}" + * @required + * @since 1.0.0 + */ + protected String organizationName; + /** + * le nom du projet (sera place dans le header) + * + * @parameter expression="${license.projectName}" default-value="${project.name}" + * @required + * @since 1.0.0 + */ + protected String projectName; + /** + * Le type de license a appliquer. + * + * @parameter expression="${license.licenseName}" + * @required + * @since 1.0.0 + */ + protected String licenseName; + /** + * Le type de générateur a utiliser pour encapsuler le header. + * + * Par défaut, on veut utiliser le plugin sur des fichiers sources java. + * + * @parameter expression="${license.generatorName}" default-value="java" + * @required + * @since 1.0.1 + */ + protected String generatorName; + /** + * La liste des patterns de fichiers à inclure (séparés par des virgules). + * + * Exemple : <code>**\/*.java,**\/*.properties</code> + * + * On recherchera alors les fichiers respectant l'un des patterns dans + * tous les répertoires de sources et de tests. + * + * Par défaut, on veut utiliser le plugin sur des fichiers sources java. + * + * @parameter expression="${license.includes}" default-value="**\/*.java" + * @required + * @since 1.0.1 + */ + protected String includes = "**/*.java"; + /** + * La liste des patterns de fichiers à exclure (séparés par des virgules). + * + * Exemple : <code>**\/*.java,**\/*.properties</code> + * + * On recherchera alors les fichiers respectant l'un des patterns dans + * tous les répertoires de sources et de tests. + * + * Par défaut, on n'exclue rien. + * + * @parameter expression="${license.excludes}" + * @since 1.0.1 + */ + protected String excludes; + /** + * Repertoires des fichiers sources a traiter. + * + * @parameter expression="${license.compileSourceRoots}" default-value="${project.compileSourceRoots}" + * @required + * @since 1.0.0 + */ + protected List<String> compileSourceRoots; + /** + * Repertoires des fichiers sources de test a traiter. + * + * @parameter expression="${license.testCompileSourceRoots}" default-value="${project.testCompileSourceRoots}" + * @required + * @since 1.0.0 + */ + protected List<String> testCompileSourceRoots; + /** + * Un resolver externe + * + * @parameter expression="${license.licenseResolver}" + * @since 1.0.0 + */ + protected String licenseResolver; + /** + * Un flag pour conserver un backup des fichiers modifies. + * + * @parameter expression="${license.keepBackup}" default-value="false" + * @since 1.0.0 + */ + protected boolean keepBackup; + /** + * Un flag pour activer le mode verbeux. + * + * @parameter expression="${license.verbose}" default-value="${maven.verbose}" + * @since 1.0.0 + */ + protected boolean verbose; + /** le header a ajouter dans chaque fichier source java */ + protected String licenseHeaderContent; + /** la liste des chemin relatifs des sources java a traiter pour chaque repertoire contenant des sources */ + protected Map<File, String[]> filesToTreate; + /** le generateur d'en-tete a utiliser */ + protected HeaderGenerator generator; + protected long timestamp; + protected Map<String, HeaderGenerator> availableGenerators; + + public UpdateHeaderPlugin() { + super("all files are up-to-date."); + } + + @Override + public boolean isVerbose() { + return verbose; + } + + @Override + public void setVerbose(boolean verbose) { + this.verbose = verbose; + } + + @Override + public MavenProject getProject() { + return project; + } + + @Override + public void setProject(MavenProject project) { + this.project = project; + } + + @Override + public boolean ensurePackaging() { + return false; +// return "pom".equals(project.getPackaging()) || "site".equals(project.getPackaging()); + } + + @Override + public boolean init() throws IOException, MojoExecutionException { + + timestamp = System.nanoTime(); + + // obtain all generators available + availableGenerators = getGenerators(); + + if (verbose) { + getLog().info("available generators : " + availableGenerators); + } + + // check if given generator exists + if (!availableGenerators.containsKey(generatorName)) { + // the generator is unknown + throw new MojoExecutionException("the generator named '" + generatorName + "' is unknown (use list-generators goal to see all of them)"); + } + + // obtain all java source files to be treated + filesToTreate = getFilesToTreate(); + + boolean doGenerate = !filesToTreate.isEmpty(); + + if (doGenerate) { + + LicenseFactory factory = LicenseFactory.newInstance(licenseResolver); + License license = factory.revolv(licenseName); + + // obtain content of license header + licenseHeaderContent = computeHeader(license); + + generator = availableGenerators.get(generatorName); + + if (verbose) { + getLog().info("config - will use the generator " + generator); + getLog().info("config - header to use \n" + licenseHeaderContent); + } + } else { + getLog().info("no file to treate."); + } + + return doGenerate; + } + + @Override + protected void doAction() throws Exception { + // create a licence processor with given header + LicenseProcessor p = new LicenseProcessor(licenseHeaderContent); + + for (Entry<File, String[]> entry : filesToTreate.entrySet()) { + File src = entry.getKey(); + for (String javaRelativePath : entry.getValue()) { + File sourceFile = new File(src, javaRelativePath); + try { + processFile(p, sourceFile); + } catch (Exception e) { + throw new MojoExecutionException("could not treate source file " + sourceFile + " for reason : " + e.getMessage(), e); + } + } + } + } + + /** + * @param p license processor + * @param file the file to process + * @throws Exception if IO pb + */ + protected void processFile(LicenseProcessor p, File file) throws Exception { + + if (verbose) { + getLog().info("process file " + file); + } + + // file where to writeFile result + File processFile = new File(file.getAbsolutePath() + "_" + timestamp); + + try { + p.process(file, processFile); + boolean foundLicenseHeader = p.getLicenceFilter().wasTouched(); + + if (!foundLicenseHeader) { + if (p.getLicenceFilter().isDetectHeader()) { + getLog().warn("license footer tag was not find on file " + file); + } else { + // no license header found in file, add it + getLog().info("adding license header on file " + file); + String content = PluginHelper.readAsString(file, encoding); + content = generator.getHeader(licenseHeaderContent) + content; + writeFile(processFile, content, encoding); + } + } + + if (keepBackup) { + File backupFile = new File(file.getAbsolutePath() + "~"); + if (verbose) { + getLog().debug("backup original file " + file); + } + file.renameTo(backupFile); + } + processFile.renameTo(file); + + } catch (Exception e) { + getLog().error("could not process file " + file + " for reason " + e.getMessage(), e); + processFile.delete(); + throw e; + } finally { + p.getLicenceFilter().reset(); + } + } + + protected Map<String, HeaderGenerator> getGenerators() { + Map<String, HeaderGenerator> generators = new TreeMap<String, HeaderGenerator>(); + ServiceLoader<HeaderGenerator> loader = ServiceLoader.load(HeaderGenerator.class, getClass().getClassLoader()); + for (HeaderGenerator h : loader) { + generators.put(h.getName(), h); + } + return generators; + } + + protected Map<File, String[]> getFilesToTreate() { + + Map<File, String[]> files = new java.util.HashMap<File, String[]>(); + + String[] in = includes.split(","); + String[] ex = excludes == null ? null : excludes.split(","); + getFilesToTreateForRoots(in, ex, compileSourceRoots, files, null); + getFilesToTreateForRoots(in, ex, testCompileSourceRoots, files, null); + + return files; + } + + protected String computeHeader(License license) throws IOException { + + String tmpHeader = license.getHeaderContent(encoding); + + // defined inceptionYear (if year is older than now suffix with a - thisYear) + Calendar cal = Calendar.getInstance(); + cal.setTime(new Date()); + String thisYear = cal.get(Calendar.YEAR) + ""; + if (!thisYear.equals(inceptionYear)) { + inceptionYear = inceptionYear + " - " + thisYear; + } + + // format header with projet informations + tmpHeader = String.format(tmpHeader, projectName, inceptionYear, organizationName); + + // add " * " before each line + BufferedReader reader = new BufferedReader(new java.io.StringReader(tmpHeader)); + StringBuilder sb = new StringBuilder(); + + String line = reader.readLine(); + sb.append(line).append('\n'); + while ((line = reader.readLine()) != null) { + line = line.trim(); + if (line.isEmpty()) { + sb.append(" *\n"); + } else { + sb.append(" * ").append(line).append("\n"); + } + } + tmpHeader = sb.toString(); + return tmpHeader.substring(0, tmpHeader.length() - 1); + } +} Property changes on: trunk/src/main/java/org/nuiton/license/header/UpdateHeaderPlugin.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/header/generator/JavaHeaderGenerator.java =================================================================== --- trunk/src/main/java/org/nuiton/license/header/generator/JavaHeaderGenerator.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/header/generator/JavaHeaderGenerator.java 2009-08-26 20:26:44 UTC (rev 1631) @@ -0,0 +1,44 @@ +/** + * *##% Plugin maven de changement de license + * Copyright (C) 2008 - 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* + */ +package org.nuiton.license.header.generator; + +import org.nuiton.processor.filters.LicenseFilter; + +/** + * Le générateur de header pour les fichiers java + * maven. + * + * @author chemit + * + * @since 1.0.1 + */ +public class JavaHeaderGenerator implements HeaderGenerator { + + public static final String GENERATOR_NAME = "java"; + + @Override + public String getHeader(String licenseHeaderContent) { + return "/**\n * " + LicenseFilter.HEADER + " " + licenseHeaderContent + " " + LicenseFilter.FOOTER + "\n */\n"; + } + + @Override + public String getName() { + return GENERATOR_NAME; + } +} Property changes on: trunk/src/main/java/org/nuiton/license/header/generator/JavaHeaderGenerator.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/java/org/nuiton/license/header/generator/XmlHeaderGenerator.java =================================================================== --- trunk/src/main/java/org/nuiton/license/header/generator/XmlHeaderGenerator.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/header/generator/XmlHeaderGenerator.java 2009-08-26 20:26:44 UTC (rev 1631) @@ -0,0 +1,43 @@ +/** + * *##% Plugin maven de changement de license + * Copyright (C) 2008 - 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* + */ +package org.nuiton.license.header.generator; + +import org.nuiton.processor.filters.LicenseFilter; + +/** + * Le header pour les fichiers xml. + * + * @author chemit + * + * @since 1.0.1 + */ +public class XmlHeaderGenerator implements HeaderGenerator { + + public static final String GENERATOR_NAME = "xml"; + + @Override + public String getHeader(String licenseHeaderContent) { + return "\n"; + } + + @Override + public String getName() { + return GENERATOR_NAME; + } +} Property changes on: trunk/src/main/java/org/nuiton/license/header/generator/XmlHeaderGenerator.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/main/resources/META-INF/services/org.nuiton.license.header.generator.HeaderGenerator =================================================================== --- trunk/src/main/resources/META-INF/services/org.nuiton.license.header.generator.HeaderGenerator (rev 0) +++ trunk/src/main/resources/META-INF/services/org.nuiton.license.header.generator.HeaderGenerator 2009-08-26 20:26:44 UTC (rev 1631) @@ -0,0 +1,2 @@ +org.nuiton.license.header.generator.JavaHeaderGenerator +org.nuiton.license.header.generator.XmlHeaderGenerator Added: trunk/src/site/rst/usage.rst =================================================================== --- trunk/src/site/rst/usage.rst (rev 0) +++ trunk/src/site/rst/usage.rst 2009-08-26 20:26:44 UTC (rev 1631) @@ -0,0 +1,4 @@ +Usage +----- + +To be done soon... \ No newline at end of file

1 0

r1630 - in trunk: . src/main/java/org/nuiton/license src/main/java/org/nuiton/license/header src/main/java/org/nuiton/license/header/generator src/main/resources src/site/rst src/test/java/org/nuiton/license src/test/java/org/nuiton/license/header src/test/resources src/test/resources/org src/test/resources/org/nuiton src/test/resources/org/nuiton/license src/test/resources/org/nuiton/license/header src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest src/test/r
by tchemit＠users.nuiton.org Aug. 26, 2009

Aug. 26, 2009

Author: tchemit Date: 2009-08-26 22:21:00 +0200 (Wed, 26 Aug 2009) New Revision: 1630 Added: trunk/src/main/java/org/nuiton/license/header/ trunk/src/main/java/org/nuiton/license/header/generator/ trunk/src/main/java/org/nuiton/license/header/generator/HeaderGenerator.java trunk/src/test/java/org/nuiton/license/header/ trunk/src/test/java/org/nuiton/license/header/LicenseProcessorTest.java trunk/src/test/java/org/nuiton/license/header/UpdateHeaderPluginTest.java trunk/src/test/resources/LicenseProcessorTest.java2 trunk/src/test/resources/LicenseProcessorTest_1.java2 trunk/src/test/resources/org/ trunk/src/test/resources/org/nuiton/ trunk/src/test/resources/org/nuiton/license/ trunk/src/test/resources/org/nuiton/license/header/ trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/ trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28.xml trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/ trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyKO.java2 trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyOK.java2 Removed: trunk/src/main/java/org/nuiton/license/plugin/ trunk/src/test/java/org/nuiton/license/plugin/ Modified: trunk/pom.xml trunk/src/main/resources/log4j.properties trunk/src/site/rst/index.rst Log: fix bug #28, rethink the goal : now only one update-header Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-08-25 22:42:31 UTC (rev 1629) +++ trunk/pom.xml 2009-08-26 20:21:00 UTC (rev 1630) @@ -39,6 +39,20 @@ <scope>compile</scope> </dependency> + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-project</artifactId> + <version>${maven.version}</version> + <scope>provided</scope> + </dependency> + + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-plugin-api</artifactId> + <version>${maven.version}</version> + <scope>provided</scope> + </dependency> +  <dependency> @@ -50,26 +64,19 @@ </dependency> <dependency> + <groupId>org.apache.maven.shared</groupId> + <artifactId>maven-plugin-testing-harness</artifactId> + <version>1.1</version> + <scope>test</scope> + </dependency> + + <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.6</version> <scope>test</scope> </dependency> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-project</artifactId> - <version>${maven.version}</version> - <scope>provided</scope> - </dependency> - - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-plugin-api</artifactId> - <version>${maven.version}</version> - <scope>provided</scope> - </dependency> - </dependencies>  @@ -77,7 +84,10 @@  <name>Plugin maven de changement de license</name> - <description>Plugin pour switcher de license dans un module maven 2</description> + <description> + Plugin pour mettre à jour l'en-tête des fichiers (avec la license choisie) + dans un module maven 2. + </description> <inceptionYear>2008</inceptionYear> <url>http://maven-site.nuiton.org/maven-license-plugin</url> @@ -89,7 +99,8 @@ <properties> - <processor.version>1.0.0</processor.version> + <helper.version>1.0.2-SNAPSHOT</helper.version> + <processor.version>1.0.1-SNAPSHOT</processor.version> </properties> Copied: trunk/src/main/java/org/nuiton/license/header/generator/HeaderGenerator.java (from rev 1628, trunk/src/main/java/org/nuiton/license/plugin/HeaderGenerator.java) =================================================================== --- trunk/src/main/java/org/nuiton/license/header/generator/HeaderGenerator.java (rev 0) +++ trunk/src/main/java/org/nuiton/license/header/generator/HeaderGenerator.java 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,40 @@ +/** + * *##% Plugin maven de changement de license + * Copyright (C) 2008 - 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* + */ +package org.nuiton.license.header.generator; + +/** + * A simple Contract to generate a new header for a given type of file. + * + * @author chemit + * @since 1.0.0 + */ +public interface HeaderGenerator { + + /** + * + * @return the name of the generator + */ + String getName(); + + /** + * @param licenseHeaderContent the content of the license header + * @return the full header to add on the first line of file. + */ + String getHeader(String licenseHeaderContent); +} Property changes on: trunk/src/main/java/org/nuiton/license/header/generator/HeaderGenerator.java ___________________________________________________________________ Added: svn:mergeinfo + Modified: trunk/src/main/resources/log4j.properties =================================================================== --- trunk/src/main/resources/log4j.properties 2009-08-25 22:42:31 UTC (rev 1629) +++ trunk/src/main/resources/log4j.properties 2009-08-26 20:21:00 UTC (rev 1630) @@ -1,10 +1,12 @@ # Global logging configuration -log4j.rootLogger=ERROR, stdout +log4j.rootLogger=DEBUG, stdout # Console output... log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) %M - %m%n # package level -log4j.logger.org.codelutin=INFO +log4j.logger.org.nuiton=INFO +log4j.logger.org.nuiton.processor=TRACE +log4j.logger.org.nuiton.license=DEBUG Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2009-08-25 22:42:31 UTC (rev 1629) +++ trunk/src/site/rst/index.rst 2009-08-26 20:21:00 UTC (rev 1630) @@ -11,16 +11,10 @@ The plugin has the following goals: - * `license-switcher license`_ add license file and third-party files to classpath (generate them if necessary). + * `license update-header`_ add or update license header on some files. - * `license-switcher third-party`_ write the licenses of all third-party libraries used in project. - - * `license-switcher switch`_ parse Java sources and switch license header. + * `license help`_ display help about the plugin (goals, usage). - * `license-switcher help`_ display help about the plugin (goals, usage). - - * `license-switcher available-licenses`_ display the known licenses of the plugin. - Usage ~~~~~ @@ -31,15 +25,9 @@ to be done. -.. _license-switcher license: license-mojo.html +.. _license update-header: license-mojo.html -.. _license-switcher third-party: third-party-mojo.html +.. _license help: help-mojo.html -.. _license-switcher switch: switch-mojo.html - -.. _license-switcher help: help-mojo.html - -.. _license-switcher available-licenses: available-licenses-mojo.html - .. _usage page: usage.html \ No newline at end of file Added: trunk/src/test/java/org/nuiton/license/header/LicenseProcessorTest.java =================================================================== --- trunk/src/test/java/org/nuiton/license/header/LicenseProcessorTest.java (rev 0) +++ trunk/src/test/java/org/nuiton/license/header/LicenseProcessorTest.java 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,89 @@ +package org.nuiton.license.header; + +import org.nuiton.processor.LicenseProcessor; +import java.io.File; +import java.io.IOException; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.codehaus.plexus.PlexusTestCase; +import org.junit.Before; +import org.junit.BeforeClass; + +import org.junit.AfterClass; +import org.junit.Assert; +import org.junit.Test; +import org.nuiton.util.PluginHelper; + +/** + * + * @author chemit + * @since 1.0.1 + */ +public class LicenseProcessorTest { + + /** to use log facility, just put in your code: log.info(\"...\"); */ + static private final Log log = LogFactory.getLog(LicenseProcessorTest.class); + static File basedir; + static File testdir; + + @BeforeClass + public static void initClass() throws Exception { + String path = PlexusTestCase.getBasedir(); + basedir = new File(path); + testdir = new File(basedir, "target" + File.separator + "tests" + File.separator + LicenseProcessorTest.class.getSimpleName()); + testdir.mkdirs(); + } + + @AfterClass + public static void afterClass() throws Exception { + } + + @Before + public void setUp() throws Exception { + } + + @Test + public void testProcessor() throws IOException { + + File in = new File(basedir, "src" + File.separator + "test" + File.separator + "resources" + File.separator + "LicenseProcessorTest.java2"); + File out = new File(testdir, in.getName()); + LicenseProcessor processor = new LicenseProcessor("my license"); + processor.process(in, out); + String content = PluginHelper.readAsString(out, "utf-8"); + if (log.isDebugEnabled()) { + log.debug("output : " + out); + log.debug(content); + } + checkPattern("// MUST BE THERE!", true, out); + checkPattern("my license", false, out); + } + + @Test + public void testProcessor2() throws IOException { + + File in = new File(basedir, "src" + File.separator + "test" + File.separator + "resources" + File.separator + "LicenseProcessorTest_1.java2"); + File out = new File(testdir, in.getName()); + LicenseProcessor processor = new LicenseProcessor("my license"); + processor.process(in, out); + String content = PluginHelper.readAsString(out, "utf-8"); + if (log.isDebugEnabled()) { + log.debug("output : " + out); + log.debug(content); + } + checkPattern("// MUST BE THERE!", true, out); + checkPattern("my license", true, out); + } + + protected void checkPattern(String pattern, boolean required, File f) throws IOException { + + if (log.isDebugEnabled()) { + log.debug("check generated file " + f); + } + + Assert.assertTrue("generated file " + f + " was not found...", f.exists()); + String content = PluginHelper.readAsString(f, "utf-8"); + + String errorMessage = required ? "could not find the pattern : " : "should not have found pattern :"; + Assert.assertEquals(errorMessage + pattern + " in file " + f, required, content.contains(pattern)); + } +} Property changes on: trunk/src/test/java/org/nuiton/license/header/LicenseProcessorTest.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/test/java/org/nuiton/license/header/UpdateHeaderPluginTest.java =================================================================== --- trunk/src/test/java/org/nuiton/license/header/UpdateHeaderPluginTest.java (rev 0) +++ trunk/src/test/java/org/nuiton/license/header/UpdateHeaderPluginTest.java 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,84 @@ +/** + * *##% Plugin maven de changement de license + * Copyright (C) 2008 - 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* + */ +package org.nuiton.license.header; + +import java.io.File; +import java.io.IOException; +import java.util.Map.Entry; +import org.nuiton.util.PluginConfig; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import static org.junit.Assert.*; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +import org.junit.AfterClass; +import org.nuiton.util.BasePluginTestCase; +import org.nuiton.util.PluginHelper; + +/** @author chemit */ +public class UpdateHeaderPluginTest extends BasePluginTestCase { + + @BeforeClass + public static void initClass() throws Exception { + initConfigs(UpdateHeaderPluginTest.class, "testBug_28"); + } + + @AfterClass + public static void afterClass() throws Exception { + configItr = null; + testDir = null; + } + + @Before + @Override + public void setUp() throws Exception { + super.setUp(); + } + + @Test + @PluginConfig(pomName = "bug_28.xml", goalName = "update-header") + public void testBug_28() throws MojoExecutionException, MojoFailureException, IOException { + assertNotNull(mojo); + + UpdateHeaderPlugin p = (UpdateHeaderPlugin) mojo; + p.execute(); + + for (Entry<File, String[]> entry : p.filesToTreate.entrySet()) { + File src = entry.getKey(); + for (String javaRelativePath : entry.getValue()) { + File f = new File(src, javaRelativePath); + checkPattern("// MUST BE THERE!", true, f); + } + } + } + + protected void checkPattern(String pattern, boolean required, File f) throws IOException { + if (mojo.isVerbose()) { + mojo.getLog().info("check generated file " + f); + } + + assertTrue("generated file " + f + " was not found...", f.exists()); + String content = PluginHelper.readAsString(f, "utf-8"); + + String errorMessage = required ? "could not find the pattern : " : "should not have found pattern :"; + assertEquals(errorMessage + pattern + " in file " + f, required, content.contains(pattern)); + } +} Property changes on: trunk/src/test/java/org/nuiton/license/header/UpdateHeaderPluginTest.java ___________________________________________________________________ Added: svn:keywords + "Author Date Id Revision HeadURL Added: trunk/src/test/resources/LicenseProcessorTest.java2 =================================================================== --- trunk/src/test/resources/LicenseProcessorTest.java2 (rev 0) +++ trunk/src/test/resources/LicenseProcessorTest.java2 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,10 @@ +/** + * *##% YO + * ##% yy + */ + +public class LicenceProcessorTest { + + +// MUST BE THERE! +} \ No newline at end of file Added: trunk/src/test/resources/LicenseProcessorTest_1.java2 =================================================================== --- trunk/src/test/resources/LicenseProcessorTest_1.java2 (rev 0) +++ trunk/src/test/resources/LicenseProcessorTest_1.java2 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,10 @@ +/** + * *##% YO + * ##%* yy + */ + +public class LicenceProcessorTest { + + +// MUST BE THERE! +} \ No newline at end of file Added: trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyKO.java2 =================================================================== --- trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyKO.java2 (rev 0) +++ trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyKO.java2 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,25 @@ +/* + * *##% Maven helper plugin + * Copyright (C) 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* + */ +package org.nuiton.license.header.UpdateHeaderPluginTest.bug_28; + +/** @author chemit */ +public class JavaDummy { + +// MUST BE THERE! +} Added: trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyOK.java2 =================================================================== --- trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyOK.java2 (rev 0) +++ trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28/JavaDummyOK.java2 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,25 @@ +/* + * *##% Maven helper plugin + * Copyright (C) 2009 CodeLutin + * + * 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 + * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##% + */ +package org.nuiton.license.header.UpdateHeaderPluginTest.bug_28; + +/** @author chemit */ +public class JavaDummy { + +// MUST BE THERE! +} Added: trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28.xml =================================================================== --- trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28.xml (rev 0) +++ trunk/src/test/resources/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28.xml 2009-08-26 20:21:00 UTC (rev 1630) @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin-bug_28</artifactId> + <version>0</version> + + <name>TestOne</name> + + <build> + + <plugins> + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <configuration> + <encoding>UTF-8</encoding> + <licenseName>lgpl_v3</licenseName> + <generatorName>java</generatorName> + <includes>**/*.java2</includes> + <compileSourceRoots> + <dir>target/test-classes/org/nuiton/license/header/UpdateHeaderPluginTest/bug_28</dir> + </compileSourceRoots> + <testCompileSourceRoots> + </testCompileSourceRoots> +  + </configuration> + <executions> + <execution> + <goals> + <goal>update-header</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> +</project> \ No newline at end of file

1 0

r1629 - trunk
by tchemit＠users.nuiton.org Aug. 25, 2009

Aug. 25, 2009

Author: tchemit Date: 2009-08-26 00:42:31 +0200 (Wed, 26 Aug 2009) New Revision: 1629 Modified: trunk/pom.xml Log: - bump mavenpom version Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-08-23 15:21:11 UTC (rev 1628) +++ trunk/pom.xml 2009-08-25 22:42:31 UTC (rev 1629) @@ -9,7 +9,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>mavenpom</artifactId> - <version>1.0.0</version> + <version>1.0.1</version> </parent> <artifactId>maven-license-plugin</artifactId>

1 0

r1628 - trunk
by tchemit＠users.nuiton.org Aug. 23, 2009

Aug. 23, 2009

Author: tchemit Date: 2009-08-23 17:21:11 +0200 (Sun, 23 Aug 2009) New Revision: 1628 Modified: trunk/pom.xml Log: [maven-release-plugin] prepare for next development iteration Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-08-23 15:21:10 UTC (rev 1627) +++ trunk/pom.xml 2009-08-23 15:21:11 UTC (rev 1628) @@ -13,7 +13,7 @@ </parent> <artifactId>maven-license-plugin</artifactId> - <version>1.0.0</version> + <version>1.0.1-SNAPSHOT</version> <dependencies> @@ -143,9 +143,9 @@  <scm> - <connection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/tags/maven-license-p…</connection> - <developerConnection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/tags/maven-license-p…</developerConnection> - <url>http://www.nuiton.org/repositories/browse/maven-license-plugin/tags/maven-l…</url> + <connection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk</connection> + <developerConnection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk</developerConnection> + <url>http://www.nuiton.org/repositories/browse/maven-license-plugin/trunk</url> </scm> </project>

1 0

r1627 - in tags: . maven-license-plugin-1.0.0
by tchemit＠users.nuiton.org Aug. 23, 2009

Aug. 23, 2009

Author: tchemit Date: 2009-08-23 17:21:10 +0200 (Sun, 23 Aug 2009) New Revision: 1627 Added: tags/maven-license-plugin-1.0.0/ Log: [maven-scm] copy for tag maven-license-plugin-1.0.0 Property changes on: tags/maven-license-plugin-1.0.0 ___________________________________________________________________ Added: svn:ignore + target .settings .classpath .project Added: svn:mergeinfo +

1 0

r1626 - trunk
by tchemit＠users.nuiton.org Aug. 23, 2009

Aug. 23, 2009

Author: tchemit Date: 2009-08-23 17:21:06 +0200 (Sun, 23 Aug 2009) New Revision: 1626 Modified: trunk/pom.xml Log: [maven-release-plugin] prepare release maven-license-plugin-1.0.0 Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-08-23 15:20:00 UTC (rev 1625) +++ trunk/pom.xml 2009-08-23 15:21:06 UTC (rev 1626) @@ -13,7 +13,7 @@ </parent> <artifactId>maven-license-plugin</artifactId> - <version>1.0.0-rc-3-SNAPSHOT</version> + <version>1.0.0</version> <dependencies> @@ -143,9 +143,9 @@  <scm> - <connection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk</connection> - <developerConnection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/trunk</developerConnection> - <url>http://www.nuiton.org/repositories/browse/maven-license-plugin/trunk</url> + <connection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/tags/maven-license-p…</connection> + <developerConnection>scm:svn:http://svn.nuiton.org/svn/maven-license-plugin/tags/maven-license-p…</developerConnection> + <url>http://www.nuiton.org/repositories/browse/maven-license-plugin/tags/maven-l…</url> </scm> </project>

1 0

r1625 - in trunk: . src/main/java/org/nuiton/license/plugin src/site
by tchemit＠users.nuiton.org Aug. 23, 2009

Aug. 23, 2009

Author: tchemit Date: 2009-08-23 17:20:00 +0200 (Sun, 23 Aug 2009) New Revision: 1625 Removed: trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java Modified: trunk/pom.xml trunk/src/site/site.xml Log: bump versions + use jrst in site + clean site.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-08-16 08:46:34 UTC (rev 1624) +++ trunk/pom.xml 2009-08-23 15:20:00 UTC (rev 1625) @@ -9,7 +9,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>mavenpom</artifactId> - <version>1.0.0-rc-5-SNAPSHOT</version> + <version>1.0.0</version> </parent> <artifactId>maven-license-plugin</artifactId> @@ -18,9 +18,9 @@ <dependencies> <dependency> - <groupId>org.nuiton.nuiton-processor</groupId> + <groupId>org.nuiton.processor</groupId> <artifactId>nuiton-processor</artifactId> - <version>1.0.0-rc-3</version> + <version>${processor.version}</version> <scope>compile</scope> </dependency> @@ -35,7 +35,7 @@ <dependency> <groupId>org.codehaus.plexus</groupId> <artifactId>plexus-utils</artifactId> - <version>1.5.5</version> + <version>1.5.15</version> <scope>compile</scope> </dependency> @@ -87,10 +87,16 @@ <packaging>maven-plugin</packaging> + <properties> + + <processor.version>1.0.0</processor.version> + + </properties> + <build> <defaultGoal>install</defaultGoal> - + <plugins> <plugin> @@ -106,6 +112,21 @@ </plugins> + <pluginManagement> + <plugins> + <plugin> + <artifactId>maven-site-plugin</artifactId> + <dependencies> + <dependency> + <groupId>org.nuiton.jrst</groupId> + <artifactId>doxia-module-jrst</artifactId> + <version>1.0.0</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </pluginManagement> + </build> <reporting> Deleted: trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java 2009-08-16 08:46:34 UTC (rev 1624) +++ trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java 2009-08-23 15:20:00 UTC (rev 1625) @@ -1,348 +0,0 @@ -/** - * *##% Plugin maven de changement de license - * Copyright (C) 2008 - 2009 CodeLutin - * - * 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 - * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%* - */ -package org.nuiton.license.plugin; - -import org.apache.maven.plugin.MojoExecutionException; - -import java.io.BufferedReader; -import java.io.File; -import java.io.IOException; -import java.util.Calendar; -import java.util.Date; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import org.apache.maven.project.MavenProject; -import org.nuiton.AbstractPlugin; -import org.nuiton.license.License; -import org.nuiton.license.LicenseFactory; -import org.nuiton.license.LicenseGenerator; -import org.nuiton.processor.LicenseProcessor; -import org.nuiton.processor.filters.LicenseFilter; -import org.nuiton.util.FileUpdaterHelper; -import org.nuiton.util.MirroredFileUpdater; -import org.nuiton.util.PluginHelper; - -/** - * Le goal pour switcher les licenses de tous les sources java d'un module - * maven. - * - * @author chemit - * @goal switch - * @phase process-resources - * @requiresProject true - * @deprecated since 1.0.0 prefer use {@link UpdateJavaHeaderPlugin} goal - */ -@Deprecated -public class SwitchLicensePlugin extends AbstractPlugin { - - /** - * Dependance du projet. - * - * @parameter default-value="${project}" - * @required - * @since 1.0.0 - */ - protected MavenProject project; - /** - * Encoding a utiliser pour lire et ecrire les fichiers. - * - * @parameter expression="${license.encoding}" default-value="${project.build.sourceEncoding}" - * @required - * @since 1.0.0 - */ - protected String encoding; - /** - * Un flag pour forcer la generation. - * - * @parameter expression="${license.force}" default-value="false" - * @since 1.0.0 - */ - protected boolean force; - /** - * l'annee de creation du module (sera place dans le header) - * - * @parameter expression="${license.inceptionYear}" default-value="${project.inceptionYear}" - * @required - * @since 1.0.0 - */ - protected String inceptionYear; - /** - * le nom de l'organisation (sera place dans le header) - * - * @parameter expression="${license.organizationName}" default-value="${project.organization.name}" - * @required - * @since 1.0.0 - */ - protected String organizationName; - /** - * le nom du projet (sera place dans le header) - * - * @parameter expression="${license.projectName}" default-value="${project.name}" - * @required - * @since 1.0.0 - */ - protected String projectName; - /** - * Le type de license a appliquer. - * - * @parameter expression="${license.licenseName}" - * @required - * @since 1.0.0 - */ - protected String licenseName; - /** - * Repertoires des fichiers sources a traiter. - * - * @parameter expression="${license.compileSourceRoots}" default-value="${project.compileSourceRoots}" - * @required - * @since 1.0.0 - */ - protected List<String> compileSourceRoots; - /** - * Repertoires des fichiers sources de test a traiter. - * - * @parameter expression="${license.testCompileSourceRoots}" default-value="${project.testCompileSourceRoots}" - * @required - * @since 1.0.0 - */ - protected List<String> testCompileSourceRoots; - /** - * Repertoire de sortie des classes (classpath). - * - * @parameter expression="${license.outputDirectory}" default-value="${project.build.outputDirectory}" - * @required - * @since 1.0.0 - */ - protected File outputDirectory; - /** - * Repertoire du build des tests - * - * @parameter expression="${license.testOutputDirectory}" default-value="${project.build.testOutputDirectory}" - * @required - * @since 1.0.0 - */ - protected File testOutputDirectory; - /** - * Un resolver externe - * - * @parameter expression="${license.extraResolver}" - * @since 1.0.0 - */ - protected String[] extraResolver; - /** - * Un flag pour conserver un backup des fichiers modifies. - * - * @parameter expression="${license.keepBackup}" default-value="false" - * @since 1.0.0 - */ - protected boolean keepBackup; - /** - * Un flag pour activer le mode verbeux. - * - * @parameter expression="${license.verbose}" default-value="${maven.verbose}" - * @since 1.0.0 - */ - protected boolean verbose; - /** le header a ajouter dans chaque fichier source java */ - protected String licenseHeaderContent; - /** la liste des chemin relatifs des sources java a traiter pour chaque repertoire contenant des sources */ - protected Map<File, String[]> javaFilesToTreate; - protected Map<LicenseGenerator, List<String>> generators; - protected long timestamp; - - public SwitchLicensePlugin() { - super("all files are up-to-date."); - } - - @Override - public boolean ensurePackaging() { - return "pom".equals(project.getPackaging()) || "site".equals(project.getPackaging()); - } - - @Override - public boolean init() throws IOException { - - timestamp = System.nanoTime(); - - // obtain all java source files to be treated - javaFilesToTreate = getFilesToTreate(); - - boolean doGenerate = !javaFilesToTreate.isEmpty(); - - if (doGenerate) { - - LicenseFactory factory = LicenseFactory.newInstance(extraResolver); - License license = factory.revolv(licenseName); - - // obtain content of license header - licenseHeaderContent = computeHeader(license); - - if (verbose) { - getLog().info("header to write on java source files \n" + licenseHeaderContent); - } - } - - return doGenerate; - } - - @Override - protected void doAction() throws Exception { - // create a licence processor with given header - LicenseProcessor p = new LicenseProcessor(licenseHeaderContent); - - for (Entry<File, String[]> entry : javaFilesToTreate.entrySet()) { - File src = entry.getKey(); - for (String javaRelativePath : entry.getValue()) { - File sourceFile = new File(src, javaRelativePath); - try { - processJavaSource(p, sourceFile); - } catch (Exception e) { - throw new MojoExecutionException("could not treate java source file " + sourceFile + " for reason : " + e.getMessage(), e); - } - } - } - } - - protected Map<File, String[]> getFilesToTreate() { - - Map<File, String[]> files = new java.util.HashMap<File, String[]>(); - - MirroredFileUpdater updater = null; - if (!force) { - updater = FileUpdaterHelper.newJavaFileUpdater(); - updater.setDestinationDirectory(outputDirectory); - } - getFilesToTreateForRoots(new String[]{"**\\/*.java"}, null, compileSourceRoots, files, updater); - if (!force) { - updater.setDestinationDirectory(testOutputDirectory); - } - getFilesToTreateForRoots(new String[]{"**\\/*.java"}, null, testCompileSourceRoots, files, updater); - - return files; - } - - protected String computeHeader(License license) throws IOException { - - - String tmpHeader = license.getHeaderContent(encoding); - - // defined inceptionYear (if year is older than now suffix with a - thisYear) - Calendar cal = Calendar.getInstance(); - cal.setTime(new Date()); - String thisYear = cal.get(Calendar.YEAR) + ""; - if (!thisYear.equals(inceptionYear)) { - inceptionYear = inceptionYear + " - " + thisYear; - } - - // format header with projet informations - tmpHeader = String.format(tmpHeader, projectName, inceptionYear, organizationName); - - // add " * " before each line - BufferedReader reader = new BufferedReader(new java.io.StringReader(tmpHeader)); - StringBuilder sb = new StringBuilder(); - - String line = reader.readLine(); - sb.append(line).append('\n'); - while ((line = reader.readLine()) != null) { - line = line.trim(); - if (line.isEmpty()) { - sb.append(" *\n"); - } else { - sb.append(" * ").append(line).append("\n"); - } - } - tmpHeader = sb.toString(); - return tmpHeader.substring(0, tmpHeader.length() - 1); - } - - /** - * @param p license processor - * @param sourceFile the java source file where to switch (or add the licence) - * @throws Exception if IO pb - */ - protected void processJavaSource(LicenseProcessor p, File sourceFile) throws Exception { - - if (verbose) { - getLog().info("process file " + sourceFile); - } - - // file where to writeFile result - File processFile = new File(sourceFile.getAbsolutePath() + "_" + timestamp); - - try { - p.process(sourceFile, processFile); - - if (!p.getLicenceFilter().wasTouched()) { - // no license header found in file, add it - addLicenseToJavaSourceFile(sourceFile, processFile); - } - - if (keepBackup) { - File backupFile = new File(sourceFile.getAbsolutePath() + "~"); - if (verbose) { - getLog().debug("backup original file " + sourceFile); - } - sourceFile.renameTo(backupFile); - } - processFile.renameTo(sourceFile); - - } catch (Exception e) { - getLog().error("could not process file " + sourceFile + " for reason " + e.getMessage(), e); - processFile.delete(); - throw e; - } finally { - p.getLicenceFilter().reset(); - } - } - - protected void addLicenseToJavaSourceFile(File sourceFile, File processFile) throws IOException { - getLog().warn("no license was found on file " + sourceFile + ", adding one"); - String content = PluginHelper.readAsString(sourceFile, encoding); - content = "/**\n * " + LicenseFilter.HEADER + " " + licenseHeaderContent + " " + LicenseFilter.FOOTER + "\n */\n" + content; - writeFile(processFile, content, encoding); - } - - protected void addLicenseToXmlSourceFile(File sourceFile, File processFile) throws IOException { - getLog().warn("no license was found on file " + sourceFile + ", adding one"); - String content = PluginHelper.readAsString(sourceFile, encoding); - content = ""; - writeFile(processFile, content, encoding); - } - - @Override - public boolean isVerbose() { - return verbose; - } - - @Override - public void setVerbose(boolean verbose) { - this.verbose = verbose; - } - - @Override - public MavenProject getProject() { - return project; - } - - @Override - public void setProject(MavenProject project) { - this.project = project; - } -} Modified: trunk/src/site/site.xml =================================================================== --- trunk/src/site/site.xml 2009-08-16 08:46:34 UTC (rev 1624) +++ trunk/src/site/site.xml 2009-08-23 15:20:00 UTC (rev 1625) @@ -1,24 +1,11 @@ <?xml version="1.0" encoding="UTF-8"?> <project name="${project.name}"> - <publishDate format="dd/MM/yyyy"/> - - <skin> - <groupId>org.nuiton</groupId> - <artifactId>maven-nuiton-skin</artifactId> - <version>1.0.0</version> - </skin> - <bannerLeft> <name>${project.name}</name> <href>index.html</href> </bannerLeft> - <bannerRight> - <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> - <href>${project.organization.url}</href> - </bannerRight> - <poweredBy> <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> <logo href="http://jrst.labs.libre-entreprise.org" name="JRst" img="images/jrst-logo.png"/>

1 0

r1624 - in trunk: . src/main/java/org/nuiton/license/plugin src/site
by tchemit＠users.nuiton.org Aug. 16, 2009

Aug. 16, 2009

Author: tchemit Date: 2009-08-16 10:46:34 +0200 (Sun, 16 Aug 2009) New Revision: 1624 Modified: trunk/pom.xml trunk/src/main/java/org/nuiton/license/plugin/AbstractUpdateHeaderPlugin.java trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java trunk/src/site/site.xml Log: bump versions + update skin Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-06-22 15:25:58 UTC (rev 1623) +++ trunk/pom.xml 2009-08-16 08:46:34 UTC (rev 1624) @@ -9,7 +9,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>mavenpom</artifactId> - <version>1.0.0-rc-2</version> + <version>1.0.0-rc-5-SNAPSHOT</version> </parent> <artifactId>maven-license-plugin</artifactId> @@ -87,10 +87,6 @@ <packaging>maven-plugin</packaging> - <properties> - <helper.version>1.0.0-rc-3-SNAPSHOT</helper.version> - </properties> - <build> <defaultGoal>install</defaultGoal> Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractUpdateHeaderPlugin.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractUpdateHeaderPlugin.java 2009-06-22 15:25:58 UTC (rev 1623) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractUpdateHeaderPlugin.java 2009-08-16 08:46:34 UTC (rev 1624) @@ -34,7 +34,7 @@ import org.nuiton.license.License; import org.nuiton.license.LicenseFactory; import org.nuiton.processor.LicenseProcessor; -import org.nuiton.util.FileUtil; +import org.nuiton.util.PluginHelper; /** * Le modele de goal a utiliser pour mettre a jour l'entete d'un fichier. @@ -317,7 +317,7 @@ protected void addHeaderToFile(File sourceFile, File processFile) throws IOException { getLog().warn("no license header was found on file " + processFile + ", adding one"); - String content = FileUtil.readAsString(sourceFile, encoding); + String content = PluginHelper.readAsString(sourceFile, encoding); content = getGenerator().getHeader(licenseHeaderContent) + content; writeFile(processFile, content, encoding); } Modified: trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java 2009-06-22 15:25:58 UTC (rev 1623) +++ trunk/src/main/java/org/nuiton/license/plugin/SwitchLicensePlugin.java 2009-08-16 08:46:34 UTC (rev 1624) @@ -20,8 +20,6 @@ import org.apache.maven.plugin.MojoExecutionException; -import org.nuiton.util.FileUtil; - import java.io.BufferedReader; import java.io.File; import java.io.IOException; @@ -39,6 +37,7 @@ import org.nuiton.processor.filters.LicenseFilter; import org.nuiton.util.FileUpdaterHelper; import org.nuiton.util.MirroredFileUpdater; +import org.nuiton.util.PluginHelper; /** * Le goal pour switcher les licenses de tous les sources java d'un module @@ -315,14 +314,14 @@ protected void addLicenseToJavaSourceFile(File sourceFile, File processFile) throws IOException { getLog().warn("no license was found on file " + sourceFile + ", adding one"); - String content = FileUtil.readAsString(sourceFile, encoding); + String content = PluginHelper.readAsString(sourceFile, encoding); content = "/**\n * " + LicenseFilter.HEADER + " " + licenseHeaderContent + " " + LicenseFilter.FOOTER + "\n */\n" + content; writeFile(processFile, content, encoding); } protected void addLicenseToXmlSourceFile(File sourceFile, File processFile) throws IOException { getLog().warn("no license was found on file " + sourceFile + ", adding one"); - String content = FileUtil.readAsString(sourceFile, encoding); + String content = PluginHelper.readAsString(sourceFile, encoding); content = ""; writeFile(processFile, content, encoding); } Modified: trunk/src/site/site.xml =================================================================== --- trunk/src/site/site.xml 2009-06-22 15:25:58 UTC (rev 1623) +++ trunk/src/site/site.xml 2009-08-16 08:46:34 UTC (rev 1624) @@ -6,7 +6,7 @@ <skin> <groupId>org.nuiton</groupId> <artifactId>maven-nuiton-skin</artifactId> - <version>1.0.0-rc-1</version> + <version>1.0.0</version> </skin> <bannerLeft>

1 0