Resolves mojohaus#289: Handle processParent in mojos which support it.

Also:
- added failIfNotReplaced to ForceReleasesMojo as a first steps towards converging with UseReleasesMojo
- enhanced documentation on UseReleasesMojo#allowRangeMatching
- streamlined UseReleasesMojo in order to converge it with ForceReleasesMojo and then fold further with other similar mojos
- added unit tests and integration tests
- some refactoring

Author: andrzejj0

.gitignore

@@ -4,4 +4,5 @@ target
 .project
 *.iml
 .idea
+.checkstyle
 /.factorypath

versions-maven-plugin/src/it-repo/dummy-with-parent.pom

@@ -0,0 +1,15 @@
+<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/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>localhost</groupId>
+    <artifactId>dummy-parent2</artifactId>
+    <version>2.0</version>
+  </parent>
+
+  <artifactId>dummy-with-parent</artifactId>
+  <version>1.0</version>
+  <packaging>pom</packaging>
+
+</project>

versions-maven-plugin/src/it/it-compare-dependencies-issue-289/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals = ${project.groupId}:${project.artifactId}:${project.version}:compare-dependencies
+invoker.mavenOpts = -DremotePom=localhost:dummy-with-parent:1.0 -DreportMode=false -DprocessParent=true

versions-maven-plugin/src/it/it-compare-dependencies-issue-289/pom.xml

@@ -0,0 +1,15 @@
+<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/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>localhost</groupId>
+    <artifactId>dummy-parent2</artifactId>
+    <version>1.0</version>
+  </parent>
+
+  <artifactId>dummy-with-parent</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <packaging>pom</packaging>
+
+</project>

versions-maven-plugin/src/it/it-compare-dependencies-issue-289/verify.groovy

@@ -0,0 +1,2 @@
+def project = new XmlSlurper().parse( new File( basedir, 'pom.xml' ) )
+assert project.parent.version == '2.0'

versions-maven-plugin/src/it/it-use-latest-versions-009/verify.bsh

@@ -0,0 +1,2 @@
+def project = new XmlSlurper().parse( new File( basedir, 'pom.xml' ) )
+assert project.parent.version == '3.0'

versions-maven-plugin/src/it/it-use-latest-versions-009/verify.groovy

@@ -0,0 +1,2 @@
+def project = new XmlSlurper().parse( new File( basedir, 'pom.xml' ) )
+assert project.parent.version == '3.0'

versions-maven-plugin/src/it/it-use-latest-versions-010/verify.bsh

@@ -0,0 +1,2 @@
+def project = new XmlSlurper().parse( new File( basedir, 'pom.xml' ) )
+assert project.parent.version == '1.0.0'

versions-maven-plugin/src/it/it-use-latest-versions-010/verify.groovy

@@ -20,11 +20,13 @@
  */
 
 import javax.inject.Inject;
+import javax.xml.stream.XMLStreamException;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.regex.Pattern;
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.artifact.Artifact;
@@ -41,7 +43,11 @@
 import org.apache.maven.repository.RepositorySystem;
 import org.apache.maven.shared.artifact.filter.PatternExcludesArtifactFilter;
 import org.apache.maven.shared.artifact.filter.PatternIncludesArtifactFilter;
+import org.codehaus.mojo.versions.api.PomHelper;
+import org.codehaus.mojo.versions.recording.ChangeRecorder;
+import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
 import org.codehaus.mojo.versions.utils.DependencyBuilder;
+import org.codehaus.mojo.versions.utils.DependencyComparator;
 
 /**
  * Base class for a mojo that updates dependency versions.
@@ -53,11 +59,16 @@
 public abstract class AbstractVersionsDependencyUpdaterMojo
     extends AbstractVersionsUpdaterMojo
 {
-
     private static final String END_RANGE_CHARS = "])";
 
     private static final String START_RANGE_CHARS = "[(";
 
+    /**
+     * Pattern to match snapshot versions
+     */
+    protected static final Pattern SNAPSHOT_REGEX = Pattern.compile( "^(.+)-((SNAPSHOT)|(\\d{8}\\.\\d{6}-\\d+))$" );
+
+
     /**
      * A comma separated list of artifact patterns to include. Follows the pattern
      * "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of includes from the command
@@ -104,15 +115,15 @@ public abstract class AbstractVersionsDependencyUpdaterMojo
      * @since 1.0-alpha-3
      */
     @Parameter( property = "processDependencies", defaultValue = "true" )
-    private boolean processDependencies;
+    private boolean processDependencies = true;
 
     /**
      * Whether to process the dependencyManagement section of the project.
      *
      * @since 1.0-alpha-3
      */
     @Parameter( property = "processDependencyManagement", defaultValue = "true" )
-    private boolean processDependencyManagement;
+    private boolean processDependencyManagement = true;
 
     /**
      * Whether to process the parent section of the project. If not set will default to false.
@@ -142,7 +153,7 @@ public abstract class AbstractVersionsDependencyUpdaterMojo
      * @since 1.0-alpha-3
      */
     @Parameter( property = "excludeReactor", defaultValue = "true" )
-    private boolean excludeReactor;
+    private boolean excludeReactor = true;
 
     @Inject
     protected AbstractVersionsDependencyUpdaterMojo( RepositorySystem repositorySystem,
@@ -266,6 +277,20 @@ protected Artifact toArtifact( Parent model )
                 .build() );
     }
 
+    /**
+     * Returns the {@link Dependency} instance for the parent project
+     * @return {@link Dependency} object for the parent
+     */
+    protected Dependency getParentDependency()
+    {
+        return DependencyBuilder.newBuilder()
+                .withGroupId( getProject().getParent().getGroupId() )
+                .withArtifactId( getProject().getParent().getArtifactId() )
+                .withVersion( getProject().getParent().getVersion() )
+                .withType( "pom" )
+                .build();
+    }
+
     protected String toString( MavenProject project )
     {
         StringBuilder buf = new StringBuilder();
@@ -507,4 +532,58 @@ private int findFirstChar( final String includeString, final String chars )
         }
         return nextRangeStartDelimiterIndex;
     }
+
+    /**
+     * Attempts to update the dependency {@code dep} to the given {@code newVersion}. The dependency can either
+     * be the parent project or any given dependency.
+     *
+     * @param pom {@link ModifiedPomXMLEventReader} instance to update the POM XML document
+     * @param dep dependency to be updated (can also be a dependency made from the parent)
+     * @param newVersion new version to update the dependency to
+     * @param changeRecorderTitle title for the {@link ChangeRecorder} log
+     * @return {@code true} if an update has been made, {@code false} otherwise
+     * @throws XMLStreamException thrown if updating the XML doesn't succeed
+     */
+    protected boolean updateDependencyVersion( ModifiedPomXMLEventReader pom, Dependency dep,
+                                               String newVersion, String changeRecorderTitle )
+            throws XMLStreamException
+    {
+        boolean updated = false;
+        if ( isProcessingParent()
+                && getProject().getParent() != null
+                && DependencyComparator.INSTANCE.compare( dep, DependencyBuilder.newBuilder()
+                        .withGroupId( getProject().getParentArtifact().getGroupId() )
+                        .withArtifactId( getProject().getParentArtifact().getArtifactId() )
+                        .withVersion( getProject().getParentArtifact().getVersion() )
+                        .build() ) == 0
+                && PomHelper.setProjectParentVersion( pom, newVersion ) )
+        {
+            if ( getLog().isDebugEnabled() )
+            {
+                getLog().debug( "Made parent update from " + dep.getVersion() + " to " + newVersion );
+            }
+            getChangeRecorder().recordUpdate( changeRecorderTitle,
+                    dep.getGroupId(), dep.getArtifactId(), dep.getVersion(),
+                    newVersion );
+            updated = true;
+        }
+
+        if ( PomHelper.setDependencyVersion( pom,
+                dep.getGroupId(), dep.getArtifactId(), dep.getVersion(),
+                newVersion, getProject().getModel() ) )
+        {
+            if ( getLog().isInfoEnabled() )
+            {
+                getLog().info( "Updated " + toString( dep ) + " to version " + newVersion );
+            }
+            getChangeRecorder().recordUpdate( changeRecorderTitle,
+                    dep.getGroupId(), dep.getArtifactId(), dep.getVersion(),
+                    newVersion );
+            updated = true;
+        }
+
+        return updated;
+    }
+
+    // TODO: add an updatePropertyVersion as well??? (like in CompareDependenciesMojo)
 }

versions-maven-plugin/src/it/it-use-latest-versions-011/verify.bsh

@@ -301,17 +301,13 @@ protected ArtifactVersion findLatestVersion( Artifact artifact, VersionRange ver
         }
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#getProject()
-     */
+    @Override
     protected MavenProject getProject()
     {
         return project;
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
-     */
+    @Override
     protected String getOutputDirectory()
     {
         if ( !outputDirectory.isAbsolute() )
@@ -322,25 +318,19 @@ protected String getOutputDirectory()
         return outputDirectory.getAbsolutePath();
     }
 
-    /**
-     * @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()
-     */
+    @Override
     protected Renderer getSiteRenderer()
     {
         return siteRenderer;
     }
 
-    /**
-     * @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
-     */
+    @Override
     public String getDescription( Locale locale )
     {
         return getText( locale, "report.description" );
     }
 
-    /**
-     * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
-     */
+    @Override
     public String getName( Locale locale )
     {
         return getText( locale, "report.title" );