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

r1821 - trunk/src/main/java/org/nuiton/license/plugin
by ymartel＠users.nuiton.org Sept. 24, 2010

Sept. 24, 2010

Author: ymartel Date: 2010-09-24 12:25:11 +0200 (Fri, 24 Sep 2010) New Revision: 1821 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1821 Log: re-think the usage of boolean :p Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-24 09:30:43 UTC (rev 1820) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-24 10:25:11 UTC (rev 1821) @@ -105,26 +105,28 @@ LicenseMap licenseMap = new LicenseMap(this.getProjectFilter()); licenseMap.setLog(log); - boolean noIncludedGroups = StringUtils.isEmpty(includedGroups); - boolean noExcludedGroups = StringUtils.isEmpty(excludedGroups); - boolean noIncludedArtifacts = StringUtils.isEmpty(includedArtifacts); - boolean noExcludedArtifacts = StringUtils.isEmpty(excludedArtifacts); + boolean haveNoIncludedGroups = StringUtils.isEmpty(includedGroups); + boolean haveNoIncludedArtifacts = StringUtils.isEmpty(includedArtifacts); + boolean haveExcludedGroups = StringUtils.isNotEmpty(excludedGroups); + boolean haveExcludedArtifacts = StringUtils.isNotEmpty(excludedArtifacts); + boolean haveExclusions = haveExcludedGroups || haveExcludedArtifacts; + Pattern includedGroupPattern = null; Pattern includedArtifactPattern = null; Pattern excludedGroupPattern = null; Pattern excludedArtifactPattern = null; - if (!noIncludedGroups) { + if (!haveNoIncludedGroups) { includedGroupPattern = Pattern.compile(includedGroups); } - if (!noIncludedArtifacts) { + if (!haveNoIncludedArtifacts) { includedArtifactPattern = Pattern.compile(includedArtifacts); } - if (!noExcludedGroups) { + if (haveExcludedGroups) { excludedGroupPattern = Pattern.compile(excludedGroups); } - if (!noExcludedArtifacts) { + if (haveExcludedArtifacts) { excludedArtifactPattern = Pattern.compile(excludedArtifacts); } @@ -143,11 +145,14 @@ MavenProject project = addArtifact(id, artifact); // Check if the project should be included - boolean isToInclude = noIncludedArtifacts && noIncludedGroups + // If there is no specified artifacts and group to include, include all + boolean isToInclude = haveNoIncludedArtifacts && haveNoIncludedGroups || isIncludable(project, includedGroupPattern, includedArtifactPattern); // Check if the project should be excluded - boolean isToExclude = isExcludable(project, excludedGroupPattern, excludedArtifactPattern); + boolean isToExclude = isToInclude + && haveExclusions + && isExcludable(project, excludedGroupPattern, excludedArtifactPattern); if (isToInclude && !isToExclude) { licenseMap.addLicense(project, project.getLicenses());

1 0

r1820 - trunk/src/main/java/org/nuiton/license/plugin
by ymartel＠users.nuiton.org Sept. 24, 2010

Sept. 24, 2010

Author: ymartel Date: 2010-09-24 11:30:43 +0200 (Fri, 24 Sep 2010) New Revision: 1820 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1820 Log: Review code to extract some operation out of loops Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-23 14:56:51 UTC (rev 1819) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-24 09:30:43 UTC (rev 1820) @@ -159,6 +159,7 @@ /** * A filter for projects licenses. + * * @parameter expression="${license.projectFilter}" default-value="" * @since 2.3.2 */ @@ -203,9 +204,9 @@ * property {@code file.encoding}. * * @parameter expression="${license.encoding}" default-value="${project.build.sourceEncoding}" - * + * * tchemit 2010-08-29 Ano #842 - * In maven 3, it will not pass if nothing was filled in project.build.sourceEncoding, + * In maven 3, it will not pass if nothing was filled in project.build.sourceEncoding, * As we have a futher fallback for this case we do not need to be required here. * //@required * @since 2.1 @@ -272,8 +273,8 @@ log.info("bundle third-party file : " + bundleFile.lastModified()); } setDoGenerateBundle(isForce() || - !bundleFile.exists() || - buildTimestamp > bundleFile.lastModified()); + !bundleFile.exists() || + buildTimestamp > bundleFile.lastModified()); } else { // not generating bundled file @@ -285,8 +286,8 @@ unsafeDependencies = licenseMap.getUnsafeDependencies(); if (!CollectionUtils.isEmpty(unsafeDependencies) && - isUseMissingFile() && - isDoGenerate()) { + isUseMissingFile() && + isDoGenerate()) { // load unsafeMapping unsafeMappings = createUnsafeMapping(); @@ -369,7 +370,7 @@ // group by license sb.append("List of third-party dependencies grouped by " + - "their license type."); + "their license type."); for (String licenseName : licenseMap.keySet()) { SortedSet<MavenProject> projects = licenseMap.get(licenseName); sb.append("\n\n").append(licenseName).append(" : "); @@ -547,25 +548,21 @@ this.doGenerateBundle = doGenerateBundle; } - public String getProjectFilter() - { - return projectFilter; - } + public String getProjectFilter() { + return projectFilter; + } - public void setProjectFilter(String projectFilter) - { - this.projectFilter = projectFilter; - } + public void setProjectFilter(String projectFilter) { + this.projectFilter = projectFilter; + } - public String getExcludedGroups() - { - return excludedGroups; - } + public String getExcludedGroups() { + return excludedGroups; + } - public void setExcludedGroups(String excludedGroups) - { - this.excludedGroups = excludedGroups; - } + public void setExcludedGroups(String excludedGroups) { + this.excludedGroups = excludedGroups; + } public String getIncludedGroups() { return includedGroups; Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-23 14:56:51 UTC (rev 1819) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-24 09:30:43 UTC (rev 1820) @@ -105,6 +105,29 @@ LicenseMap licenseMap = new LicenseMap(this.getProjectFilter()); licenseMap.setLog(log); + boolean noIncludedGroups = StringUtils.isEmpty(includedGroups); + boolean noExcludedGroups = StringUtils.isEmpty(excludedGroups); + boolean noIncludedArtifacts = StringUtils.isEmpty(includedArtifacts); + boolean noExcludedArtifacts = StringUtils.isEmpty(excludedArtifacts); + + Pattern includedGroupPattern = null; + Pattern includedArtifactPattern = null; + Pattern excludedGroupPattern = null; + Pattern excludedArtifactPattern = null; + + if (!noIncludedGroups) { + includedGroupPattern = Pattern.compile(includedGroups); + } + if (!noIncludedArtifacts) { + includedArtifactPattern = Pattern.compile(includedArtifacts); + } + if (!noExcludedGroups) { + excludedGroupPattern = Pattern.compile(excludedGroups); + } + if (!noExcludedArtifacts) { + excludedArtifactPattern = Pattern.compile(excludedArtifacts); + } + // build the license map for the dependencies of the project for (Object o : getProject().getArtifacts()) { @@ -120,10 +143,11 @@ MavenProject project = addArtifact(id, artifact); // Check if the project should be included - boolean isToInclude = isIncludable(project); + boolean isToInclude = noIncludedArtifacts && noIncludedGroups + || isIncludable(project, includedGroupPattern, includedArtifactPattern); // Check if the project should be excluded - boolean isToExclude = isExcludable(project); + boolean isToExclude = isExcludable(project, excludedGroupPattern, excludedArtifactPattern); if (isToInclude && !isToExclude) { licenseMap.addLicense(project, project.getLicenses()); @@ -256,66 +280,62 @@ } - protected boolean isIncludable(MavenProject project) { + protected boolean isIncludable(MavenProject project, + Pattern includedGroupPattern, + Pattern includedArtifactPattern) { Log log = getLog(); - // If there is no constraint on groups or artifacts, all should be included - if(StringUtils.isEmpty(includedGroups) && StringUtils.isEmpty(includedArtifacts)) { - return true; - } else { - // check if the groupId of the project should be included - if (StringUtils.isNotEmpty(includedGroups)) { + // check if the groupId of the project should be included + if (includedGroupPattern != null) { // we have some defined license filters - try { - Pattern pattern = Pattern.compile(includedGroups); - Matcher matchGroupId = pattern.matcher(project.getGroupId()); - if (matchGroupId.find()) { - if (log.isDebugEnabled()) { - log.debug("Include " + project.getGroupId()); - } - return true; + try { + Matcher matchGroupId = includedGroupPattern.matcher(project.getGroupId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Include " + project.getGroupId()); } + return true; } - catch (PatternSyntaxException e) { - getLog().warn("The pattern specified by expression <" - + includedGroups + "> seems to be invalid."); - } } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + + includedGroups + "> seems to be invalid."); + } + } - // check if the artifactId of the project should be included - if (StringUtils.isNotEmpty(includedArtifacts)) { + // check if the artifactId of the project should be included + if (includedArtifactPattern != null) { // we have some defined license filters - try { - Pattern pattern = Pattern.compile(includedArtifacts); - Matcher matchGroupId = pattern.matcher(project.getArtifactId()); - if (matchGroupId.find()) { - if (log.isDebugEnabled()) { - log.debug("Include " + project.getArtifactId()); - } - return true; + try { + Matcher matchGroupId = includedArtifactPattern.matcher(project.getArtifactId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Include " + project.getArtifactId()); } + return true; } - catch (PatternSyntaxException e) { - getLog().warn("The pattern specified by expression <" - + includedArtifacts + "> seems to be invalid."); - } } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + + includedArtifacts + "> seems to be invalid."); + } } return false; } - protected boolean isExcludable(MavenProject project) { + protected boolean isExcludable(MavenProject project, + Pattern excludedGroupPattern, + Pattern excludedArtifactPattern) { Log log = getLog(); // check if the groupId of the project should be included - if (StringUtils.isNotEmpty(excludedGroups)) { - // we have some defined license filters + if (excludedGroupPattern != null) { + // we have some defined license filters try { - Pattern pattern = Pattern.compile(excludedGroups); - Matcher matchGroupId = pattern.matcher(project.getGroupId()); + Matcher matchGroupId = excludedGroupPattern.matcher(project.getGroupId()); if (matchGroupId.find()) { if (log.isDebugEnabled()) { log.debug("Exclude " + project.getGroupId()); @@ -330,11 +350,10 @@ } // check if the artifactId of the project should be included - if (StringUtils.isNotEmpty(excludedArtifacts)) { - // we have some defined license filters + if (excludedArtifactPattern != null) { + // we have some defined license filters try { - Pattern pattern = Pattern.compile(excludedArtifacts); - Matcher matchGroupId = pattern.matcher(project.getArtifactId()); + Matcher matchGroupId = excludedArtifactPattern.matcher(project.getArtifactId()); if (matchGroupId.find()) { if (log.isDebugEnabled()) { log.debug("Exclude " + project.getArtifactId());

1 0

r1819 - trunk/src/main/java/org/nuiton/license/plugin
by ymartel＠users.nuiton.org Sept. 23, 2010

Sept. 23, 2010

Author: ymartel Date: 2010-09-23 16:56:51 +0200 (Thu, 23 Sep 2010) New Revision: 1819 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1819 Log: review two operation, extracting log from parameters Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-23 14:53:27 UTC (rev 1818) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-23 14:56:51 UTC (rev 1819) @@ -120,10 +120,10 @@ MavenProject project = addArtifact(id, artifact); // Check if the project should be included - boolean isToInclude = isIncludable(project, log); + boolean isToInclude = isIncludable(project); // Check if the project should be excluded - boolean isToExclude = isExcludable(project, log); + boolean isToExclude = isExcludable(project); if (isToInclude && !isToExclude) { licenseMap.addLicense(project, project.getLicenses()); @@ -256,8 +256,9 @@ } - protected boolean isIncludable(MavenProject project, Log log) { + protected boolean isIncludable(MavenProject project) { + Log log = getLog(); // If there is no constraint on groups or artifacts, all should be included if(StringUtils.isEmpty(includedGroups) && StringUtils.isEmpty(includedArtifacts)) { return true; @@ -306,8 +307,9 @@ } - protected boolean isExcludable(MavenProject project, Log log) { + protected boolean isExcludable(MavenProject project) { + Log log = getLog(); // check if the groupId of the project should be included if (StringUtils.isNotEmpty(excludedGroups)) { // we have some defined license filters

1 0

r1818 - in trunk/src: it/excluded-included main/java/org/nuiton/license/plugin
by ymartel＠users.nuiton.org Sept. 23, 2010

Sept. 23, 2010

Author: ymartel Date: 2010-09-23 16:53:27 +0200 (Thu, 23 Sep 2010) New Revision: 1818 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1818 Log: Add properties to exclude artifacts from Third Party reports, and to include only some groups or/and artifacts Modified: trunk/src/it/excluded-included/pom.xml trunk/src/it/excluded-included/verify.groovy trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java Modified: trunk/src/it/excluded-included/pom.xml =================================================================== --- trunk/src/it/excluded-included/pom.xml 2010-09-23 11:04:09 UTC (rev 1817) +++ trunk/src/it/excluded-included/pom.xml 2010-09-23 14:53:27 UTC (rev 1818) @@ -65,17 +65,65 @@ <thirdPartyFilename>thirdWithoutGroup.txt</thirdPartyFilename> </configuration> </execution> -  -  -  -  -  -  -  -  -  -  -  + <execution> + <id>artifact-filter</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <excludedArtifacts>nuiton-i18n</excludedArtifacts> + <thirdPartyFilename>thirdWithoutArtifact.txt</thirdPartyFilename> + </configuration> + </execution> + <execution> + <id>artifact-off-over-group-on</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <includedGroups>org\.nuiton</includedGroups> + <excludedArtifacts>nuiton-utils|nuiton-i18n</excludedArtifacts> + <thirdPartyFilename>thirdWithGroupWithoutArtifact.txt</thirdPartyFilename> + </configuration> + </execution> + <execution> + <id>artifact-on-over-group-off</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <excludedGroups>org\.nuiton</excludedGroups> + <includedArtifacts>nuiton-utils|nuiton-i18n</includedArtifacts> + <thirdPartyFilename>thirdWithoutGroupWithArtifact.txt</thirdPartyFilename> + </configuration> + </execution> + <execution> + <id>artifact-on-over-group-on</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <includedGroups>org\.nuiton</includedGroups> + <includedArtifacts>nuiton-utils</includedArtifacts> + <thirdPartyFilename>thirdWithGroupWithArtifact.txt</thirdPartyFilename> + </configuration> + </execution> + <execution> + <id>artifact-off-over-group-off</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <excludedGroups>org\.nuiton</excludedGroups> + <excludedArtifacts>nuiton-i18n</excludedArtifacts> + <thirdPartyFilename>thirdWithoutGroupWithoutArtifact.txt</thirdPartyFilename> + </configuration> + </execution> </executions> </plugin> </plugins> Modified: trunk/src/it/excluded-included/verify.groovy =================================================================== --- trunk/src/it/excluded-included/verify.groovy 2010-09-23 11:04:09 UTC (rev 1817) +++ trunk/src/it/excluded-included/verify.groovy 2010-09-23 14:53:27 UTC (rev 1818) @@ -4,7 +4,56 @@ content = file.text; assert !content.contains( 'the project has no dependencies.' ); assert content.contains( 'commons-logging:commons-logging:1.1.1' ); -assert !content.contains( 'org.nuiton:nuiton-util:1.4' ); +assert !content.contains( 'org.nuiton:nuiton-utils:1.4' ); assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); + +file = new File(basedir, 'target/generated-sources/license/thirdWithoutArtifact.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert content.contains( 'org.nuiton:nuiton-utils:1.4' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); + + +file = new File(basedir, 'target/generated-sources/license/thirdWithGroupWithoutArtifact.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert !content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert !content.contains( 'org.nuiton:nuiton-utils:1.4' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); +assert content.contains( 'org.nuiton:maven-helper-plugin' ); + + +file = new File(basedir, 'target/generated-sources/license/thirdWithoutGroupWithArtifact.txt'); +assert file.exists(); +content = file.text; +assert content.contains( 'the project has no dependencies.' ); +assert !content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert !content.contains( 'org.nuiton:nuiton-utils:1.4' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); +assert !content.contains( 'org.nuiton:maven-helper-plugin' ); + + +file = new File(basedir, 'target/generated-sources/license/thirdWithGroupWithArtifact.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert !content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert content.contains( 'org.nuiton:nuiton-utils:1.4' ); +assert content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); +assert content.contains( 'org.nuiton:maven-helper-plugin' ); + + +file = new File(basedir, 'target/generated-sources/license/thirdWithoutGroupWithoutArtifact.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert !content.contains( 'org.nuiton:nuiton-utils:1.4' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); +assert !content.contains( 'org.nuiton:maven-helper-plugin' ); + return true; Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-23 11:04:09 UTC (rev 1817) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-23 14:53:27 UTC (rev 1818) @@ -173,6 +173,30 @@ protected String excludedGroups; /** + * A filter to include only some GroupIds + * + * @parameter expression="${license.includedGroups}" default-value="" + * @since 2.3.2 + */ + protected String includedGroups; + + /** + * A filter to exclude some ArtifactsIds + * + * @parameter expression="${license.excludedArtifacts}" default-value="" + * @since 2.3.2 + */ + protected String excludedArtifacts; + + /** + * A filter to include only some ArtifactsIds + * + * @parameter expression="${license.includedArtifacts}" default-value="" + * @since 2.3.2 + */ + protected String includedArtifacts; + + /** * Encoding used to read and writes files. * * Note: If nothing is filled here, we will use the system @@ -359,6 +383,7 @@ } else { + // group by dependencies SortedMap<MavenProject, String[]> map = licenseMap.toDependencyMap(); @@ -541,4 +566,28 @@ { this.excludedGroups = excludedGroups; } + + public String getIncludedGroups() { + return includedGroups; + } + + public void setIncludedGroups(String includedGroups) { + this.includedGroups = includedGroups; + } + + public String getExcludedArtifacts() { + return excludedArtifacts; + } + + public void setExcludedArtifacts(String excludedArtifacts) { + this.excludedArtifacts = excludedArtifacts; + } + + public String getIncludedArtifacts() { + return includedArtifacts; + } + + public void setIncludedArtifacts(String includedArtifacts) { + this.includedArtifacts = includedArtifacts; + } } \ No newline at end of file Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-23 11:04:09 UTC (rev 1817) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-23 14:53:27 UTC (rev 1818) @@ -28,6 +28,7 @@ import java.io.File; import java.io.FileWriter; import java.io.IOException; +import java.util.HashSet; import java.util.List; import java.util.Set; import java.util.SortedSet; @@ -105,7 +106,6 @@ licenseMap.setLog(log); // build the license map for the dependencies of the project - for (Object o : getProject().getArtifacts()) { Artifact artifact = (Artifact) o; @@ -119,26 +119,17 @@ MavenProject project = addArtifact(id, artifact); - // filter with the excluded groupIds - if (StringUtils.isNotEmpty(excludedGroups)) { - // we have some defined license filters - try { - Pattern pattern = Pattern.compile(excludedGroups); - Matcher matchGroupId = pattern.matcher(project.getGroupId()); - if (!matchGroupId.find()) { - if (log.isDebugEnabled()) { - log.debug("Exclude " + project.getGroupId()); - } - licenseMap.addLicense(project, project.getLicenses()); - } - } - catch (PatternSyntaxException e) { - getLog().warn("The pattern specified by expression <" + excludedGroups + "> seems to be invalid."); - } - } else { + // Check if the project should be included + boolean isToInclude = isIncludable(project, log); + + // Check if the project should be excluded + boolean isToExclude = isExcludable(project, log); + + if (isToInclude && !isToExclude) { licenseMap.addLicense(project, project.getLicenses()); } } + return licenseMap; } @@ -264,4 +255,97 @@ this.doGenerateMissing = doGenerateMissing; } + + protected boolean isIncludable(MavenProject project, Log log) { + + // If there is no constraint on groups or artifacts, all should be included + if(StringUtils.isEmpty(includedGroups) && StringUtils.isEmpty(includedArtifacts)) { + return true; + + } else { + // check if the groupId of the project should be included + if (StringUtils.isNotEmpty(includedGroups)) { + // we have some defined license filters + try { + Pattern pattern = Pattern.compile(includedGroups); + Matcher matchGroupId = pattern.matcher(project.getGroupId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Include " + project.getGroupId()); + } + return true; + } + } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + + includedGroups + "> seems to be invalid."); + } + } + + // check if the artifactId of the project should be included + if (StringUtils.isNotEmpty(includedArtifacts)) { + // we have some defined license filters + try { + Pattern pattern = Pattern.compile(includedArtifacts); + Matcher matchGroupId = pattern.matcher(project.getArtifactId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Include " + project.getArtifactId()); + } + return true; + } + } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + + includedArtifacts + "> seems to be invalid."); + } + } + } + + return false; + } + + + protected boolean isExcludable(MavenProject project, Log log) { + + // check if the groupId of the project should be included + if (StringUtils.isNotEmpty(excludedGroups)) { + // we have some defined license filters + try { + Pattern pattern = Pattern.compile(excludedGroups); + Matcher matchGroupId = pattern.matcher(project.getGroupId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Exclude " + project.getGroupId()); + } + return true; + } + } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + + excludedGroups + "> seems to be invalid."); + } + } + + // check if the artifactId of the project should be included + if (StringUtils.isNotEmpty(excludedArtifacts)) { + // we have some defined license filters + try { + Pattern pattern = Pattern.compile(excludedArtifacts); + Matcher matchGroupId = pattern.matcher(project.getArtifactId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Exclude " + project.getArtifactId()); + } + return true; + } + } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + + excludedArtifacts + "> seems to be invalid."); + } + } + + return false; + } }

1 0

r1817 - trunk/src/it/excluded-included
by ymartel＠users.nuiton.org Sept. 23, 2010

Sept. 23, 2010

Author: ymartel Date: 2010-09-23 13:04:09 +0200 (Thu, 23 Sep 2010) New Revision: 1817 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1817 Log: fix a regex about exluded groups Modified: trunk/src/it/excluded-included/pom.xml trunk/src/it/excluded-included/verify.groovy Modified: trunk/src/it/excluded-included/pom.xml =================================================================== --- trunk/src/it/excluded-included/pom.xml 2010-09-23 10:22:07 UTC (rev 1816) +++ trunk/src/it/excluded-included/pom.xml 2010-09-23 11:04:09 UTC (rev 1817) @@ -61,7 +61,7 @@ </goals> <phase>validate</phase> <configuration> - <excludedGroups>org.nuiton*</excludedGroups> + <excludedGroups>org\.nuiton.*</excludedGroups> <thirdPartyFilename>thirdWithoutGroup.txt</thirdPartyFilename> </configuration> </execution> Modified: trunk/src/it/excluded-included/verify.groovy =================================================================== --- trunk/src/it/excluded-included/verify.groovy 2010-09-23 10:22:07 UTC (rev 1816) +++ trunk/src/it/excluded-included/verify.groovy 2010-09-23 11:04:09 UTC (rev 1817) @@ -5,5 +5,6 @@ assert !content.contains( 'the project has no dependencies.' ); assert content.contains( 'commons-logging:commons-logging:1.1.1' ); assert !content.contains( 'org.nuiton:nuiton-util:1.4' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.2' ); return true;

1 0

r1816 - in trunk: . src/it src/it/excluded-included src/main/java/org/nuiton/license/plugin
by ymartel＠users.nuiton.org Sept. 23, 2010

Sept. 23, 2010

Author: ymartel Date: 2010-09-23 12:22:07 +0200 (Thu, 23 Sep 2010) New Revision: 1816 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1816 Log: Add parameter excludedGroups to exclude some groupIds from the thirdParty reports. Added: trunk/src/it/excluded-included/ trunk/src/it/excluded-included/invoker.properties trunk/src/it/excluded-included/pom.xml trunk/src/it/excluded-included/verify.groovy Modified: trunk/pom.xml trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-09-22 15:46:33 UTC (rev 1815) +++ trunk/pom.xml 2010-09-23 10:22:07 UTC (rev 1816) @@ -429,6 +429,7 @@ <artifactId>maven-invoker-plugin</artifactId> <configuration> <pomIncludes> + <pomInclude>excluded-included/pom.xml</pomInclude> <pomInclude>evol-818/pom.xml</pomInclude> <pomInclude>ano-816/pom.xml</pomInclude> <pomInclude>add-third-party/no-encoding/pom.xml</pomInclude> @@ -438,7 +439,6 @@ <pomInclude>add-third-party/with-deps/pom.xml</pomInclude> <pomInclude>update-file-header/pom.xml</pomInclude> <pomInclude>update-project-license/pom.xml</pomInclude> -  </pomIncludes> <postBuildHookScript>verify</postBuildHookScript> <localRepositoryPath>${basedir}/target/local-repo</localRepositoryPath> Added: trunk/src/it/excluded-included/invoker.properties =================================================================== --- trunk/src/it/excluded-included/invoker.properties (rev 0) +++ trunk/src/it/excluded-included/invoker.properties 2010-09-23 10:22:07 UTC (rev 1816) @@ -0,0 +1,21 @@ +# A comma or space separated list of goals/phases to execute, may +# specify an empty list to execute the default goal of the IT project +invoker.goals=validate + +# Optionally, a list of goals to run during further invocations of Maven +#invoker.goals.2=${project.groupId}:${project.artifactId}:${project.version}:run + +# A comma or space separated list of profiles to activate +#invoker.profiles=run-all run-once + +# The value for the environment variable MAVEN_OPTS +#invoker.mavenOpts=-Dfile.encoding=UTF-16 -Xms32m -Xmx256m + +# Possible values are "fail-fast" (default), "fail-at-end" and "fail-never" +invoker.failureBehavior=fail-at-end + +# The expected result of the build, possible values are "success" (default) and "failure" +#invoker.buildResult=success + +# A boolean value controlling the -N flag, defaults to "false" +#invoker.nonRecursive=false Added: trunk/src/it/excluded-included/pom.xml =================================================================== --- trunk/src/it/excluded-included/pom.xml (rev 0) +++ trunk/src/it/excluded-included/pom.xml 2010-09-23 10:22:07 UTC (rev 1816) @@ -0,0 +1,86 @@ +<?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"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.nuiton.license.test</groupId> + <artifactId>excluded-included</artifactId> + <version>1.0</version> + + <name>License Test :: excluded-included</name> + + <url>no-url</url> + <properties> + + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <license.verbose>true</license.verbose> + </properties> + + + <dependencies> + <dependency> + <groupId>org.nuiton</groupId> + <artifactId>maven-helper-plugin</artifactId> + <version>1.2.3</version> + </dependency> + <dependency> + <groupId>org.nuiton</groupId> + <artifactId>nuiton-utils</artifactId> + <version>1.4</version> + </dependency> + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>1.1.1</version> + </dependency> + </dependencies> + + <build> + + <pluginManagement> + <plugins> + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <version>@pom.version@</version> + </plugin> + </plugins> + </pluginManagement> + + <plugins> + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <executions> + <execution> + <id>group-filter</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <excludedGroups>org.nuiton*</excludedGroups> + <thirdPartyFilename>thirdWithoutGroup.txt</thirdPartyFilename> + </configuration> + </execution> +  +  +  +  +  +  +  +  +  +  +  + </executions> + </plugin> + </plugins> + </build> + +</project> + + Added: trunk/src/it/excluded-included/verify.groovy =================================================================== --- trunk/src/it/excluded-included/verify.groovy (rev 0) +++ trunk/src/it/excluded-included/verify.groovy 2010-09-23 10:22:07 UTC (rev 1816) @@ -0,0 +1,9 @@ + +file = new File(basedir, 'target/generated-sources/license/thirdWithoutGroup.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert !content.contains( 'org.nuiton:nuiton-util:1.4' ); + +return true; Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-22 15:46:33 UTC (rev 1815) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-23 10:22:07 UTC (rev 1816) @@ -163,8 +163,16 @@ * @since 2.3.2 */ protected String projectFilter; - + /** + * A filter to exclude some GroupIds + * + * @parameter expression="${license.excludedGroups}" default-value="" + * @since 2.3.2 + */ + protected String excludedGroups; + + /** * Encoding used to read and writes files. * * Note: If nothing is filled here, we will use the system @@ -523,4 +531,14 @@ { this.projectFilter = projectFilter; } + + public String getExcludedGroups() + { + return excludedGroups; + } + + public void setExcludedGroups(String excludedGroups) + { + this.excludedGroups = excludedGroups; + } } \ No newline at end of file Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-22 15:46:33 UTC (rev 1815) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-23 10:22:07 UTC (rev 1816) @@ -31,8 +31,12 @@ import java.util.List; import java.util.Set; import java.util.SortedSet; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; import org.apache.commons.collections.CollectionUtils; +import org.apache.commons.lang.StringUtils; import org.apache.maven.artifact.Artifact; import org.apache.maven.artifact.repository.ArtifactRepository; import org.apache.maven.plugin.MojoFailureException; @@ -115,7 +119,25 @@ MavenProject project = addArtifact(id, artifact); - licenseMap.addLicense(project, project.getLicenses()); + // filter with the excluded groupIds + if (StringUtils.isNotEmpty(excludedGroups)) { + // we have some defined license filters + try { + Pattern pattern = Pattern.compile(excludedGroups); + Matcher matchGroupId = pattern.matcher(project.getGroupId()); + if (!matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Exclude " + project.getGroupId()); + } + licenseMap.addLicense(project, project.getLicenses()); + } + } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + excludedGroups + "> seems to be invalid."); + } + } else { + licenseMap.addLicense(project, project.getLicenses()); + } } return licenseMap; } @@ -125,7 +147,7 @@ SortedProperties unsafeMappings = getLicenseMap().loadUnsafeMapping(getEncoding(), - getMissingFile()); + getMissingFile()); SortedSet<MavenProject> unsafeDependencies = getUnsafeDependencies(); @@ -150,8 +172,8 @@ @Override protected boolean checkSkip() { if (!isDoGenerate() && - !isDoGenerateBundle() && - !isDoGenerateMissing()) { + !isDoGenerateBundle() && + !isDoGenerateMissing()) { getLog().info("All files are up to date, skip goal execution."); return false; @@ -186,7 +208,7 @@ createDirectoryIfNecessary(file.getParentFile()); log.info("Regenerate missing license file " + file); - + FileWriter writer = new FileWriter(file); try { StringBuilder sb = new StringBuilder(" Generated by " + getClass().getName()); Modified: trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java 2010-09-22 15:46:33 UTC (rev 1815) +++ trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java 2010-09-23 10:22:07 UTC (rev 1816) @@ -62,10 +62,13 @@ private static final long serialVersionUID = 864199843545688069L; private transient Log log; - private transient String licenseFilterPattern; + private String licenseFilterPattern; public static final String unknownLicenseMessage = "Unknown license"; + public LicenseMap() { + } + public LicenseMap(String someLicenseFilterPattern) { licenseFilterPattern = someLicenseFilterPattern; }

1 0

r1815 - in trunk: . src/it src/it/evol-818 src/main/java/org/nuiton/license/plugin
by ymartel＠users.nuiton.org Sept. 22, 2010

Sept. 22, 2010

Author: ymartel Date: 2010-09-22 17:46:33 +0200 (Wed, 22 Sep 2010) New Revision: 1815 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1815 Log: [Evo 818] Add a way to filter (exclude) some groupId or ArtifactId from thirdParty report Added: trunk/src/it/evol-818/ trunk/src/it/evol-818/invoker.properties trunk/src/it/evol-818/pom.xml trunk/src/it/evol-818/verify.groovy Modified: trunk/pom.xml trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/AggregatorAddThirdPartyMojo.java trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-09-09 09:30:33 UTC (rev 1814) +++ trunk/pom.xml 2010-09-22 15:46:33 UTC (rev 1815) @@ -429,6 +429,7 @@ <artifactId>maven-invoker-plugin</artifactId> <configuration> <pomIncludes> + <pomInclude>evol-818/pom.xml</pomInclude> <pomInclude>ano-816/pom.xml</pomInclude> <pomInclude>add-third-party/no-encoding/pom.xml</pomInclude> <pomInclude>aggregate-add-third-party/pom.xml</pomInclude> Copied: trunk/src/it/evol-818/invoker.properties (from rev 1814, trunk/src/it/ano-816/invoker.properties) =================================================================== --- trunk/src/it/evol-818/invoker.properties (rev 0) +++ trunk/src/it/evol-818/invoker.properties 2010-09-22 15:46:33 UTC (rev 1815) @@ -0,0 +1,21 @@ +# A comma or space separated list of goals/phases to execute, may +# specify an empty list to execute the default goal of the IT project +invoker.goals=validate + +# Optionally, a list of goals to run during further invocations of Maven +#invoker.goals.2=${project.groupId}:${project.artifactId}:${project.version}:run + +# A comma or space separated list of profiles to activate +#invoker.profiles=run-all run-once + +# The value for the environment variable MAVEN_OPTS +#invoker.mavenOpts=-Dfile.encoding=UTF-16 -Xms32m -Xmx256m + +# Possible values are "fail-fast" (default), "fail-at-end" and "fail-never" +invoker.failureBehavior=fail-at-end + +# The expected result of the build, possible values are "success" (default) and "failure" +#invoker.buildResult=success + +# A boolean value controlling the -N flag, defaults to "false" +#invoker.nonRecursive=false Added: trunk/src/it/evol-818/pom.xml =================================================================== --- trunk/src/it/evol-818/pom.xml (rev 0) +++ trunk/src/it/evol-818/pom.xml 2010-09-22 15:46:33 UTC (rev 1815) @@ -0,0 +1,86 @@ +<?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"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.nuiton.license.test</groupId> + <artifactId>test-it-818</artifactId> + <version>1.0</version> + + <name>License Test :: evo-818</name> + + <url>no-url</url> + <properties> + + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <license.verbose>true</license.verbose> + </properties> + + + <dependencies> + <dependency> + <groupId>org.nuiton</groupId> + <artifactId>maven-helper-plugin</artifactId> + <version>1.2.3</version> + </dependency> + <dependency> + <groupId>org.nuiton.i18n</groupId> + <artifactId>nuiton-i18n</artifactId> + <version>1.2.1</version> + </dependency> + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>1.1.1</version> + </dependency> + </dependencies> + + <build> + + <pluginManagement> + <plugins> + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <version>@pom.version@</version> + </plugin> + </plugins> + </pluginManagement> + + <plugins> + <plugin> + <groupId>org.nuiton</groupId> + <artifactId>maven-license-plugin</artifactId> + <executions> + <execution> + <id>group-filter</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <projectFilter>org.nuiton</projectFilter> + <thirdPartyFilename>thirdWithoutGroup.txt</thirdPartyFilename> + </configuration> + </execution> + <execution> + <id>artifact-filter</id> + <goals> + <goal>add-third-party</goal> + </goals> + <phase>validate</phase> + <configuration> + <projectFilter>nuiton-i18n</projectFilter> + <thirdPartyFilename>thirdWithoutArtifact.txt</thirdPartyFilename> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> + +</project> + + Copied: trunk/src/it/evol-818/verify.groovy (from rev 1814, trunk/src/it/ano-816/verify.groovy) =================================================================== --- trunk/src/it/evol-818/verify.groovy (rev 0) +++ trunk/src/it/evol-818/verify.groovy 2010-09-22 15:46:33 UTC (rev 1815) @@ -0,0 +1,18 @@ + +file = new File(basedir, 'target/generated-sources/license/thirdWithoutGroup.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.1' ); + + +file = new File(basedir, 'target/generated-sources/license/thirdWithoutArtifact.txt'); +assert file.exists(); +content = file.text; +assert !content.contains( 'the project has no dependencies.' ); +assert content.contains( 'commons-logging:commons-logging:1.1.1' ); +assert !content.contains( 'org.nuiton.i18n:nuiton-i18n:1.2.1' ); +assert content.contains( 'org.nuiton:maven-helper-plugin:1.2.3' ); + +return true; Modified: trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-09 09:30:33 UTC (rev 1814) +++ trunk/src/main/java/org/nuiton/license/plugin/AbstractAddThirdPartyMojo.java 2010-09-22 15:46:33 UTC (rev 1815) @@ -25,6 +25,16 @@ package org.nuiton.license.plugin; +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.SortedMap; +import java.util.SortedSet; +import java.util.TreeMap; + import org.apache.commons.collections.CollectionUtils; import org.apache.commons.lang.StringUtils; import org.apache.maven.artifact.Artifact; @@ -35,16 +45,6 @@ import org.nuiton.plugin.PluginHelper; import org.nuiton.plugin.PluginWithEncoding; -import java.io.File; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; -import java.util.Map; -import java.util.SortedMap; -import java.util.SortedSet; -import java.util.TreeMap; - /** * Goal to generate the THIRD-PARTY.txt file which resumes all dependencies with * their licenses. @@ -158,6 +158,13 @@ protected boolean groupByLicense; /** + * A filter for projects licenses. + * @parameter expression="${license.projectFilter}" default-value="" + * @since 2.3.2 + */ + protected String projectFilter; + + /** * Encoding used to read and writes files. * * Note: If nothing is filled here, we will use the system @@ -506,4 +513,14 @@ public void setDoGenerateBundle(boolean doGenerateBundle) { this.doGenerateBundle = doGenerateBundle; } + + public String getProjectFilter() + { + return projectFilter; + } + + public void setProjectFilter(String projectFilter) + { + this.projectFilter = projectFilter; + } } \ No newline at end of file Modified: trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-09 09:30:33 UTC (rev 1814) +++ trunk/src/main/java/org/nuiton/license/plugin/AddThirdPartyMojo.java 2010-09-22 15:46:33 UTC (rev 1815) @@ -25,6 +25,13 @@ package org.nuiton.license.plugin; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.util.List; +import java.util.Set; +import java.util.SortedSet; + import org.apache.commons.collections.CollectionUtils; import org.apache.maven.artifact.Artifact; import org.apache.maven.artifact.repository.ArtifactRepository; @@ -35,13 +42,6 @@ import org.apache.maven.project.ProjectBuildingException; import org.nuiton.io.SortedProperties; -import java.io.File; -import java.io.FileWriter; -import java.io.IOException; -import java.util.List; -import java.util.Set; -import java.util.SortedSet; - /** * Le goal pour copier le fichier THIRD-PARTY.txt (contenant les licenses de * toutes les dependances du projet) dans le classpath (et le generer s'il @@ -97,7 +97,7 @@ protected LicenseMap createLicenseMap() throws ProjectBuildingException { Log log = getLog(); - LicenseMap licenseMap = new LicenseMap(); + LicenseMap licenseMap = new LicenseMap(this.getProjectFilter()); licenseMap.setLog(log); // build the license map for the dependencies of the project @@ -242,4 +242,4 @@ this.doGenerateMissing = doGenerateMissing; } -} \ No newline at end of file +} Modified: trunk/src/main/java/org/nuiton/license/plugin/AggregatorAddThirdPartyMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/AggregatorAddThirdPartyMojo.java 2010-09-09 09:30:33 UTC (rev 1814) +++ trunk/src/main/java/org/nuiton/license/plugin/AggregatorAddThirdPartyMojo.java 2010-09-22 15:46:33 UTC (rev 1815) @@ -25,6 +25,12 @@ package org.nuiton.license.plugin; +import java.io.File; +import java.io.IOException; +import java.util.List; +import java.util.SortedMap; +import java.util.SortedSet; + import org.apache.commons.collections.CollectionUtils; import org.apache.maven.plugin.MojoFailureException; import org.apache.maven.plugin.logging.Log; @@ -32,12 +38,6 @@ import org.apache.maven.project.ProjectBuildingException; import org.nuiton.io.SortedProperties; -import java.io.File; -import java.io.IOException; -import java.util.List; -import java.util.SortedMap; -import java.util.SortedSet; - /** * This aggregator goal (will be executed only once and only on pom projects) * executed the {@code add-third-party} on all his modules (in a parellel build cycle) @@ -83,7 +83,7 @@ protected LicenseMap createLicenseMap() throws ProjectBuildingException { Log log = getLog(); - LicenseMap licenseMap = new LicenseMap(); + LicenseMap licenseMap = new LicenseMap(this.getProjectFilter()); licenseMap.setLog(log); SortedMap<String, MavenProject> artifacts = getArtifactCache(); @@ -159,4 +159,4 @@ } } -} \ No newline at end of file +} Modified: trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java 2010-09-09 09:30:33 UTC (rev 1814) +++ trunk/src/main/java/org/nuiton/license/plugin/LicenseMap.java 2010-09-22 15:46:33 UTC (rev 1815) @@ -47,6 +47,9 @@ import java.util.SortedSet; import java.util.TreeMap; import java.util.TreeSet; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; /** * Map of artifacts (stub in mavenproject) group by their license. @@ -59,10 +62,12 @@ private static final long serialVersionUID = 864199843545688069L; private transient Log log; + private transient String licenseFilterPattern; public static final String unknownLicenseMessage = "Unknown license"; - public LicenseMap() { + public LicenseMap(String someLicenseFilterPattern) { + licenseFilterPattern = someLicenseFilterPattern; } public void setLog(Log log) { @@ -82,6 +87,31 @@ return; } + if (StringUtils.isNotEmpty(licenseFilterPattern)) { + // we have some defined license filters + try { + Pattern pattern = Pattern.compile(licenseFilterPattern); + Matcher matchGroupId = pattern.matcher(project.getGroupId()); + if (matchGroupId.find()) { + if (log.isDebugEnabled()) { + log.debug("Exclude " + project.getGroupId()); + } + return; + } + Matcher matchArtifactId = pattern.matcher(project.getArtifactId()); + if (matchArtifactId.find()) { + if (log.isDebugEnabled()) { + log.debug("Exclude " + project.getGroupId() + ":" + + project.getArtifactId()); + } + return; + } + } + catch (PatternSyntaxException e) { + getLog().warn("The pattern specified by expression <" + licenseFilterPattern + "> seems to be invalid."); + } + } + if (CollectionUtils.isEmpty(licenses)) { // no license found for the dependency

1 0

r1814 - trunk
by tchemit＠users.nuiton.org Sept. 9, 2010

Sept. 9, 2010

Author: tchemit Date: 2010-09-09 11:30:33 +0200 (Thu, 09 Sep 2010) New Revision: 1814 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1814 Log: Utilisation de mavenpom4redmine 2.2.5 Modified: trunk/pom.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-09-09 08:39:32 UTC (rev 1813) +++ trunk/pom.xml 2010-09-09 09:30:33 UTC (rev 1814) @@ -34,7 +34,7 @@ <parent> <groupId>org.nuiton</groupId> <artifactId>mavenpom4redmine</artifactId> - <version>2.2.4</version> + <version>2.2.5</version> </parent> <artifactId>maven-license-plugin</artifactId>

1 0

r1813 - trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest
by tchemit＠users.nuiton.org Sept. 9, 2010

Sept. 9, 2010

Author: tchemit Date: 2010-09-09 10:39:32 +0200 (Thu, 09 Sep 2010) New Revision: 1813 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1813 Log: use default value of canUpdateLicense parameter (mojo test framework should do it for us...) Modified: trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/all.xml trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/updateLicense.xml Modified: trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/all.xml =================================================================== --- trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/all.xml 2010-09-09 08:38:55 UTC (rev 1812) +++ trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/all.xml 2010-09-09 08:39:32 UTC (rev 1813) @@ -25,6 +25,7 @@ <inceptionYear>2010</inceptionYear> <ignoreTag>%%Ignore-License</ignoreTag> <encoding>UTF-8</encoding> + <canUpdateLicense>true</canUpdateLicense> </configuration> <executions> <execution> Modified: trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/updateLicense.xml =================================================================== --- trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/updateLicense.xml 2010-09-09 08:38:55 UTC (rev 1812) +++ trunk/src/test/resources/org/nuiton/license/plugin/updateFileHeaderMojoTest/updateLicense.xml 2010-09-09 08:39:32 UTC (rev 1813) @@ -25,6 +25,7 @@ <inceptionYear>2010</inceptionYear> <ignoreTag>NEVER_FINd_ME!</ignoreTag> <encoding>UTF-8</encoding> + <canUpdateLicense>true</canUpdateLicense> </configuration> <executions> <execution>

1 0

r1812 - in trunk/src/main/java/org/nuiton/license/plugin: . header header/transformer
by tchemit＠users.nuiton.org Sept. 9, 2010

Sept. 9, 2010

Author: tchemit Date: 2010-09-09 10:38:55 +0200 (Thu, 09 Sep 2010) New Revision: 1812 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1812 Log: Evolution #810: Can update project description part of header in update-file-header Evolution #811: Can update project license part of header in update-file-header Evolution #859: Can update project copyright part of header in update-file-header Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateFileHeaderMojo.java trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java trunk/src/main/java/org/nuiton/license/plugin/header/UpdateFileHeaderFilter.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateFileHeaderMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateFileHeaderMojo.java 2010-09-09 08:34:00 UTC (rev 1811) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateFileHeaderMojo.java 2010-09-09 08:38:55 UTC (rev 1812) @@ -26,7 +26,12 @@ package org.nuiton.license.plugin; import org.apache.commons.lang.StringUtils; -import org.nuiton.license.plugin.header.*; +import org.codehaus.plexus.util.FileUtils; +import org.nuiton.license.plugin.header.FileHeader; +import org.nuiton.license.plugin.header.FileHeaderProcessor; +import org.nuiton.license.plugin.header.FileHeaderProcessorConfiguration; +import org.nuiton.license.plugin.header.InvalideFileHeaderException; +import org.nuiton.license.plugin.header.UpdateFileHeaderFilter; import org.nuiton.license.plugin.header.transformer.FileHeaderTransformer; import org.nuiton.license.plugin.model.License; import org.nuiton.license.plugin.model.descriptor.FileSet; @@ -35,7 +40,13 @@ import java.io.File; import java.io.IOException; -import java.util.*; +import java.util.Arrays; +import java.util.EnumMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.TreeMap; /** * The goal to update (or add) the header on some files described in @@ -99,6 +110,39 @@ protected boolean addSvnKeyWords; /** + * A flag to authorize update of the description part of the header. + * + * Note: By default, do NOT authorize it since description can change + * on each file). + * + * @parameter expression="${license.canUpdateDescription}" default-value="false" + * @since 2.3.2 + */ + protected boolean canUpdateDescription; + + /** + * A flag to authorize update of the copyright part of the header. + * + * Note: By default, do NOT authorize it since copyright part should be + * handled by developpers (holder can change on each file for example). + * + * @parameter expression="${license.canUpdateCopyright}" default-value="false" + * @since 2.3.2 + */ + protected boolean canUpdateCopyright; + + /** + * A flag to authorize update of the license part of the header. + * + * Note: By default, authorize it since license part should always be + * generated by the plugin. + * + * @parameter expression="${license.canUpdateLicense}" default-value="true" + * @since 2.3.2 + */ + protected boolean canUpdateLicense; + + /** * A flag to update copyright application time (change copyright last year * if required) according to the last commit made on the processed file. * @@ -256,7 +300,11 @@ // set timestamp used for temporary files setTimestamp(System.nanoTime()); - getFilter().setUpdateCopyright(isUpdateCopyright()); + // add flags to authorize or not updates of header + getFilter().setUpdateCopyright(isCanUpdateCopyright()); + getFilter().setUpdateDescription(isCanUpdateDescription()); + getFilter().setUpdateLicense(isCanUpdateLicense()); + getFilter().setLog(getLog()); getProcessor().setConfiguration(this); getProcessor().setFilter(filter); @@ -560,8 +608,21 @@ deleteFile(processFile); } else { - // replace file with - renameFile(processFile, file); + try { + + // replace file with the updated one + renameFile(processFile, file); + } catch (IOException e) { + + // workaround windows problem to rename files + getLog().warn(e.getMessage()); + + // try to copy content (fail on windows xp...) + FileUtils.copyFile(processFile, file); + + // then delete process file + deleteFile(processFile); + } } } @@ -635,6 +696,18 @@ return updateCopyright; } + public boolean isCanUpdateDescription() { + return canUpdateDescription; + } + + public boolean isCanUpdateCopyright() { + return canUpdateCopyright; + } + + public boolean isCanUpdateLicense() { + return canUpdateLicense; + } + public String getIgnoreTag() { return ignoreTag; } @@ -742,4 +815,16 @@ public void setFilter(UpdateFileHeaderFilter filter) { this.filter = filter; } + + public void setCanUpdateDescription(boolean canUpdateDescription) { + this.canUpdateDescription = canUpdateDescription; + } + + public void setCanUpdateCopyright(boolean canUpdateCopyright) { + this.canUpdateCopyright = canUpdateCopyright; + } + + public void setCanUpdateLicense(boolean canUpdateLicense) { + this.canUpdateLicense = canUpdateLicense; + } } Modified: trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java 2010-09-09 08:34:00 UTC (rev 1811) +++ trunk/src/main/java/org/nuiton/license/plugin/header/FileHeaderFilter.java 2010-09-09 08:38:55 UTC (rev 1812) @@ -68,13 +68,26 @@ protected Log log; /** + * Obtains the new header to use according to the old one. + * + * Note: If the new header should not be updated, then the result is {@code null}. + * + * @param oldHeader the old header found in file. + * @return {@code null} if header is still the same, otherwise the new header to apply + * @since 2.3.2 + */ + protected abstract FileHeader getNewHeader(FileHeader oldHeader); + + /** * The logic to implements when a header was touched. * * @param ch the actual header content * @return the new header content (beginning by a * {@link FileHeaderTransformer#getProcessStartTag()} and ending * with a {@link FileHeaderTransformer#getProcessEndTag()}). + * @deprecated since 2.3.2, use now the method {@link #getNewHeader(FileHeader)}. */ + @Deprecated protected abstract String treateHeader(String ch); public FileHeaderFilter() { @@ -103,24 +116,50 @@ // the header was detected, mark file to be touched touched = true; - // update header - String newHeader = treateHeader(ch); - if (log.isDebugEnabled()) { - log.debug("old header =\n" + ch); - log.debug("new header =\n" + newHeader); - } - if (!newHeader.contains(ch.trim())) { - // this is a weak test, but should be more enough - // if the new header contains the old one, it would be - // bad luck to not have equality ? - //TODO-TC-20100415 : use an exact test (must remove process tag on new header) -// if (!ch.equals(newHeader)) { + // obtain old header model + FileHeaderTransformer headerTransformer = getTransformer(); + String tmp = headerTransformer.unboxComent(ch); + FileHeader oldHeader = headerTransformer.toFileHeader(tmp); - // header content was modified, mark it + // obtain the new header (according to what to update) + FileHeader newFileHeader = getNewHeader(oldHeader); + + FileHeader header; + + if (newFileHeader == null) { + + // keep the old header + header = oldHeader; + + } else { + + // mark that the header was updated modified = true; + + header = newFileHeader; } - return newHeader; + String result = transformer.toHeaderContent(header); + return result; + +// // update header +// String newHeader = treateHeader(ch); +// if (log.isDebugEnabled()) { +// log.debug("old header =\n" + ch); +// log.debug("new header =\n" + newHeader); +// } +// if (!newHeader.contains(ch.trim())) { +// // this is a weak test, but should be more enough +// // if the new header contains the old one, it would be +// // bad luck to not have equality ? +// //TODO-TC-20100415 : use an exact test (must remove process tag on new header) +//// if (!ch.equals(newHeader)) { +// +// // header content was modified, mark it +// modified = true; +// } +// +// return newHeader; } // Means we detects the process start tag but not the end one. // coming then here from the flush filter method... So changes nothing Modified: trunk/src/main/java/org/nuiton/license/plugin/header/UpdateFileHeaderFilter.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/UpdateFileHeaderFilter.java 2010-09-09 08:34:00 UTC (rev 1811) +++ trunk/src/main/java/org/nuiton/license/plugin/header/UpdateFileHeaderFilter.java 2010-09-09 08:38:55 UTC (rev 1812) @@ -36,12 +36,109 @@ */ public class UpdateFileHeaderFilter extends FileHeaderFilter { + /** + * Flag sets to {@code true} if description can be updated. + * + * @since 2.3.2 + */ + protected boolean updateDescription; + + /** + * Flag set to {@code true} if license can be updated. + * + * @since 2.3.2 + */ + protected boolean updateLicense; + + /** + * Flag sets to {@code true} if copyright can be updated. + * + * @since 2.1 + */ protected boolean updateCopyright; public UpdateFileHeaderFilter() { } @Override + protected FileHeader getNewHeader(FileHeader oldHeader) { + + FileHeader result = new FileHeader(); + + FileHeader newHeader = getFileHeader(); + + FileHeaderTransformer transformer = getTransformer(); + + boolean modified = false; + + // by default, reuse the old header + result.setDescription(oldHeader.getDescription()); + result.setCopyrightFirstYear(oldHeader.getCopyrightFirstYear()); + result.setCopyrightLastYear(oldHeader.getCopyrightLastYear()); + result.setCopyrightHolder(oldHeader.getCopyrightHolder()); + result.setLicense(oldHeader.getLicense()); + + if (isUpdateDescription() && + !transformer.isDescriptionEquals(oldHeader, newHeader)) { + + // can update description and it has changed + + if (log.isDebugEnabled()) { + log.debug("description has changed from [" + oldHeader.getDescription() + "] to [" + newHeader.getDescription() + "]"); + } + + // description has changed, mark header to be updated + modified = true; + + // use the new description + result.setDescription(newHeader.getDescription()); + } + + if (isUpdateCopyright() && + !transformer.isCopyrightEquals(oldHeader, newHeader)) { + + // can update copyright and it has changed + + if (log.isDebugEnabled()) { + log.debug("copyright has changed from [" + oldHeader.getCopyright() + "] to [" + newHeader.getCopyright() + "]"); + } + + // description has changed, mark header to be updated + modified = true; + + // use the new copyright + result.setCopyrightFirstYear(result.getCopyrightFirstYear()); + result.setCopyrightLastYear(result.getCopyrightLastYear()); + result.setCopyrightHolder(result.getCopyrightHolder()); + } + + if (isUpdateLicense() && + !transformer.isLicenseEquals(oldHeader, newHeader)) { + + // can update license and it has changed + + if (log.isDebugEnabled()) { + log.debug("license has changed from [" + oldHeader.getLicense() + "] to [" + newHeader.getLicense() + "]"); + } + + // description has changed, mark header to be updated + modified = true; + + // use the new license + result.setLicense(newHeader.getLicense()); + } + + if (!modified) { + + // nothing has to be updated, so return a {@code null} result + result = null; + } + + return result; + } + + @Override + @Deprecated protected String treateHeader(String ch) { if (getLog().isDebugEnabled()) { @@ -103,4 +200,20 @@ public void setUpdateCopyright(boolean updateCopyright) { this.updateCopyright = updateCopyright; } + + public boolean isUpdateDescription() { + return updateDescription; + } + + public void setUpdateDescription(boolean updateDescription) { + this.updateDescription = updateDescription; + } + + public boolean isUpdateLicense() { + return updateLicense; + } + + public void setUpdateLicense(boolean updateLicense) { + this.updateLicense = updateLicense; + } } Modified: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java 2010-09-09 08:34:00 UTC (rev 1811) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/AbstractFileHeaderTransformer.java 2010-09-09 08:38:55 UTC (rev 1812) @@ -251,6 +251,32 @@ } @Override + public String toHeaderContent(FileHeader model) throws NullPointerException { + + String result; + + // model to text + result = toString(model); + + // box with process tag + result = boxProcessTag(result); + + // box header with comment prefix + result = boxComment(result, false); + + // remove all before process start tag + // remove all after process end tag + // this is a requirement for processor to respect involution. + int index = result.indexOf(getProcessStartTag()); + int lastIndex = + result.lastIndexOf(getProcessEndTag()) + + getProcessEndTag().length(); + + result = result.substring(index, lastIndex); + return result; + } + + @Override public String boxComment(String header, boolean withTags) { StringBuilder buffer = new StringBuilder(); if (withTags) { @@ -323,4 +349,35 @@ } return buffer.toString(); } + + @Override + public boolean isDescriptionEquals(FileHeader header1, FileHeader header2) { + return header1.getDescription().equals(header2.getDescription()); + } + + @Override + public boolean isCopyrightEquals(FileHeader header1, FileHeader header2) { + return header1.getCopyright().equals(header2.getCopyright()); + } + + @Override + public boolean isLicenseEquals(FileHeader header1, FileHeader header2) { + String license1 = removeSpaces(header1.getLicense()); + String license2 = removeSpaces(header2.getLicense()); + boolean result = license1.equals(license2); + return result; + } + + protected static final Pattern REMOVE_SPACE_PATTERN = Pattern.compile("(\\s+)"); + + protected String removeSpaces(String str) { + Matcher matcher = REMOVE_SPACE_PATTERN.matcher(str); + String result; + if (matcher.find()) { + result = matcher.replaceAll(""); + } else { + result = str; + } + return result; + } } Modified: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java 2010-09-09 08:34:00 UTC (rev 1811) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java 2010-09-09 08:38:55 UTC (rev 1812) @@ -113,8 +113,8 @@ /** * Adds the header. - * - * @param header header to add + * + * @param header header to add * @param content content of original file * @return the new full file content beginning with header */ @@ -176,6 +176,45 @@ String toString(FileHeader model) throws NullPointerException; /** + * Build a fully boxed header content from the given {@code model}. + * + * @param model the model of the file header + * @return the fully boxed header content + * @throws NullPointerException if model is null + */ + String toHeaderContent(FileHeader model) throws NullPointerException; + + /** + * Tests if the description of the two models are equals. + * + * @param header1 the first header + * @param header2 the second header + * @return {@code true} if headers description are stricly the same + * @since 2.3.2 + */ + boolean isDescriptionEquals(FileHeader header1, FileHeader header2); + + /** + * Tests if the copyright of the two models are equals. + * + * @param header1 the first header + * @param header2 the second header + * @return {@code true} if headers copyright are stricly the same + * @since 2.3.2 + */ + boolean isCopyrightEquals(FileHeader header1, FileHeader header2); + + /** + * Tests if the license of the two models are equals. + * + * @param header1 the first header + * @param header2 the second header + * @return {@code true} if headers license are stricly the same (WITHOUT ANY space) + * @since 2.3.2 + */ + boolean isLicenseEquals(FileHeader header1, FileHeader header2); + + /** * Changes the name of the transformer. * * @param name the new name of the transformer

1 0