#283: allowMinorUpdates false should imply allowMajorUpdates false

mojohaus · Oct 13, 2022 · 1fdc3b9 · 1fdc3b9
1 parent 8a21578
commit 1fdc3b9
Show file tree

Hide file tree

Showing 16 changed files with 209 additions and 345 deletions.
diff --git a/src/main/java/org/codehaus/mojo/versions/AbstractVersionsUpdaterMojo.java b/src/main/java/org/codehaus/mojo/versions/AbstractVersionsUpdaterMojo.java
@@ -31,7 +31,6 @@
 import java.util.Optional;
 import java.util.Set;
 
-import org.apache.commons.text.CaseUtils;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.artifact.manager.WagonManager;
 import org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException;
@@ -70,12 +69,6 @@
 import org.codehaus.plexus.util.WriterFactory;
 import org.codehaus.stax2.XMLInputFactory2;
 
-import static java.util.Optional.empty;
-import static java.util.Optional.of;
-import static org.codehaus.mojo.versions.api.Segment.INCREMENTAL;
-import static org.codehaus.mojo.versions.api.Segment.MAJOR;
-import static org.codehaus.mojo.versions.api.Segment.MINOR;
-
 /**
  * Abstract base class for Versions Mojos.
  *
@@ -539,41 +532,6 @@ protected boolean shouldApplyUpdate( Artifact artifact, String currentVersion, A
         return true;
     }
 
-    /**
-     * <p>Based on the passed flags, determines which segment (0-based), which is not to be changed.</p>
-     * <p>The method will return, depending on the first parameter on the list to be true:
-     * <ul>
-     * <li>{@code allowMajorUpdates}: -1</li>
-     * <li>{@code allowMinorUpdates}: 0</li>
-     * <li>{@code allowIncrementalUpdates}: 1</li>
-     * <li>(none): 2</li>
-     * </ul>
-     *
-     * This can be used when determining an upper
-     * bound for the "latest" version.
-     *
-     * @param allowMajorUpdates       Allow major updates
-     * @param allowMinorUpdates       Allow minor updates
-     * @param allowIncrementalUpdates Allow incremental updates
-     * @return Returns the segment (0-based) that is unchangeable. If any segment can change, returns -1.
-     */
-    protected Optional<Segment> determineUnchangedSegment( boolean allowMajorUpdates, boolean allowMinorUpdates,
-                                                           boolean allowIncrementalUpdates )
-    {
-        Optional<Segment> unchangedSegment = allowMajorUpdates ? empty()
-                : allowMinorUpdates ? of( MAJOR )
-                : allowIncrementalUpdates ? of( MINOR )
-                : of( INCREMENTAL );
-        if ( getLog().isInfoEnabled() )
-        {
-            getLog().info(
-                    unchangedSegment.map( s ->
-                                    CaseUtils.toCamelCase( Segment.of( s.value() + 1 ).toString(), true ) )
-                            .orElse( "All" ) + " version changes allowed" );
-        }
-        return unchangedSegment;
-    }
-
     protected ArtifactVersion updatePropertyToNewestVersion( ModifiedPomXMLEventReader pom, Property property,
                                                              PropertyVersions version, String currentVersion,
                                                              boolean allowDowngrade,

diff --git a/src/main/java/org/codehaus/mojo/versions/DisplayDependencyUpdatesMojo.java b/src/main/java/org/codehaus/mojo/versions/DisplayDependencyUpdatesMojo.java
@@ -54,14 +54,13 @@
 import org.codehaus.mojo.versions.filtering.WildcardMatcher;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
 import org.codehaus.mojo.versions.utils.DependencyComparator;
+import org.codehaus.mojo.versions.utils.SegmentUtils;
 import org.codehaus.plexus.util.StringUtils;
 
 import static java.util.Optional.empty;
 import static java.util.Optional.of;
 import static org.apache.commons.lang3.StringUtils.countMatches;
-import static org.codehaus.mojo.versions.api.Segment.INCREMENTAL;
 import static org.codehaus.mojo.versions.api.Segment.MAJOR;
-import static org.codehaus.mojo.versions.api.Segment.MINOR;
 
 /**
  * Displays all dependencies that have newer versions available.
@@ -220,28 +219,32 @@ public class DisplayDependencyUpdatesMojo
 
     /**
      * Whether to allow the major version number to be changed.
-     * You need to set {@link #allowAnyUpdates} to <code>false</code> to
-     * get this configuration gets control.
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowAnyUpdates}
+     * to be {@code false}</b></p>
      *
      * @since 2.5
      */
     @Parameter( property = "allowMajorUpdates", defaultValue = "true" )
     private boolean allowMajorUpdates;
 
     /**
-     * Whether to allow the minor version number to be changed.
-     * You need to set {@link #allowMajorUpdates} to <code>false</code> to
-     * get this configuration gets control.
+     * <p>Whether to allow the minor version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowAnyUpdates}
+     * and {@linkplain #allowMajorUpdates} to be {@code false}</b></p>
      *
      * @since 2.5
      */
     @Parameter( property = "allowMinorUpdates", defaultValue = "true" )
     private boolean allowMinorUpdates;
 
     /**
-     * Whether to allow the incremental version number to be changed.
-     * You need to set {@link #allowMinorUpdates} to <code>false</code> to
-     * get this configuration gets control.
+     * <p>Whether to allow the incremental version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowAnyUpdates},
+     * {@linkplain #allowMajorUpdates}, and {@linkplain #allowMinorUpdates}
+     * to be {@code false}</b></p>
      *
      * @since 2.5
      */
@@ -691,28 +694,11 @@ private DependencyManagement getProjectDependencyManagement( MavenProject projec
 
     private Optional<Segment> calculateUpdateScope()
     {
-        if ( !allowIncrementalUpdates && !allowMinorUpdates && !allowMajorUpdates && !allowAnyUpdates )
-        {
-            throw new IllegalArgumentException( "One of: allowAnyUpdates, allowMajorUpdates, allowMinorUpdates, "
-                    + "allowIncrementalUpdates must be true" );
-        }
-
-        if ( allowAnyUpdates && allowMajorUpdates && allowMinorUpdates )
-        {
-            return empty();
-        }
-
-        if ( allowMajorUpdates && allowMinorUpdates )
-        {
-            return of( MAJOR );
-        }
-
-        if ( allowMinorUpdates )
-        {
-            return of( MINOR );
-        }
-
-        return of( INCREMENTAL );
+        return allowAnyUpdates
+        ? empty()
+        : of( SegmentUtils.determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
+                allowIncrementalUpdates, getLog() ).map( s -> Segment.of( s.value() - 1 ) )
+                .orElse( MAJOR ) );
     }
 
     private void logUpdates( Map<Dependency, ArtifactVersions> updates, String section )

diff --git a/src/main/java/org/codehaus/mojo/versions/DisplayPropertyUpdatesMojo.java b/src/main/java/org/codehaus/mojo/versions/DisplayPropertyUpdatesMojo.java
@@ -44,6 +44,7 @@
 import org.codehaus.mojo.versions.api.Segment;
 import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.utils.SegmentUtils;
 
 /**
  * Displays properties that are linked to artifact versions and have updates available.
@@ -107,15 +108,20 @@ public class DisplayPropertyUpdatesMojo
     private boolean allowMajorUpdates;
 
     /**
-     * Whether to allow the minor version number to be changed.
+     * <p>Whether to allow the minor version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}</b></p>
      *
      * @since 2.5
      */
     @Parameter( property = "allowMinorUpdates", defaultValue = "true" )
     private boolean allowMinorUpdates;
 
     /**
-     * Whether to allow the incremental version number to be changed.
+     * <p>Whether to allow the incremental version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates}
+     * and {@linkplain #allowMinorUpdates} {@code false}</b></p>
      *
      * @since 2.5
      */
@@ -158,7 +164,8 @@ public void execute()
             }
 
             Optional<Segment> unchangedSegment =
-                    determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates, allowIncrementalUpdates );
+                    SegmentUtils.determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
+                            allowIncrementalUpdates, getLog() );
             try
             {
                 ArtifactVersion winner = version.getNewestVersion( currentVersion, property, this.allowSnapshots,

diff --git a/src/main/java/org/codehaus/mojo/versions/ResolveRangesMojo.java b/src/main/java/org/codehaus/mojo/versions/ResolveRangesMojo.java
@@ -48,6 +48,7 @@
 import org.codehaus.mojo.versions.api.Segment;
 import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.utils.SegmentUtils;
 
 /**
  * Attempts to resolve dependency version ranges to the specific version being used in the build. For example a version
@@ -94,15 +95,20 @@ public class ResolveRangesMojo
     private boolean allowMajorUpdates;
 
     /**
-     * Whether to allow the minor version number to be changed.
+     * <p>Whether to allow the minor version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}</b></p>
      *
      * @since 2.5
      */
     @Parameter( property = "allowMinorUpdates", defaultValue = "true" )
     private boolean allowMinorUpdates;
 
     /**
-     * Whether to allow the incremental version number to be changed.
+     * <p>Whether to allow the incremental version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates}
+     * and {@linkplain #allowMinorUpdates} {@code false}</b></p>
      *
      * @since 2.5
      */
@@ -312,8 +318,8 @@ private void resolvePropertyRanges( ModifiedPomXMLEventReader pom )
 
             property.setVersion( currentVersion );
 
-            Optional<Segment> unchangedSegment = determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
-                    allowIncrementalUpdates );
+            Optional<Segment> unchangedSegment = SegmentUtils.determineUnchangedSegment( allowMajorUpdates,
+                    allowMinorUpdates, allowIncrementalUpdates, getLog() );
             // TODO: Check if we could add allowDowngrade ? 
             try
             {

diff --git a/src/main/java/org/codehaus/mojo/versions/UpdateParentMojo.java b/src/main/java/org/codehaus/mojo/versions/UpdateParentMojo.java
@@ -48,6 +48,7 @@
 import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
 import org.codehaus.mojo.versions.utils.DependencyBuilder;
+import org.codehaus.mojo.versions.utils.SegmentUtils;
 
 import static org.apache.maven.shared.utils.StringUtils.isBlank;
 
@@ -112,15 +113,20 @@ public class UpdateParentMojo extends AbstractVersionsUpdaterMojo
     protected boolean allowMajorUpdates = true;
 
     /**
-     * Whether to allow the minor version number to be changed.
+     * <p>Whether to allow the minor version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}</b></p>
      *
      * @since 2.13.0
      */
     @Parameter( property = "allowMinorUpdates", defaultValue = "true" )
     protected boolean allowMinorUpdates = true;
 
     /**
-     * Whether to allow the incremental version number to be changed.
+     * <p>Whether to allow the incremental version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates}
+     * and {@linkplain #allowMinorUpdates} {@code false}</b></p>
      *
      * @since 2.13.0
      */
@@ -227,8 +233,8 @@ protected ArtifactVersion resolveTargetVersion( String initialVersion )
         }
 
         final ArtifactVersions versions = getHelper().lookupArtifactVersions( artifact, false );
-        Optional<Segment> unchangedSegment = determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
-                allowIncrementalUpdates );
+        Optional<Segment> unchangedSegment = SegmentUtils.determineUnchangedSegment( allowMajorUpdates,
+                allowMinorUpdates, allowIncrementalUpdates, getLog() );
 
         // currentVersion (set to parentVersion here) is not included in the version range for searching upgrades
         // unless we set allowDowngrade to true

diff --git a/src/main/java/org/codehaus/mojo/versions/UpdatePropertiesMojo.java b/src/main/java/org/codehaus/mojo/versions/UpdatePropertiesMojo.java
@@ -41,6 +41,7 @@
 import org.codehaus.mojo.versions.api.Segment;
 import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.utils.SegmentUtils;
 
 /**
  * Sets properties to the latest versions of specific artifacts.
@@ -107,16 +108,20 @@ public class UpdatePropertiesMojo extends AbstractVersionsDependencyUpdaterMojo
     protected boolean allowMajorUpdates;
 
     /**
-     * Whether to allow the minor version number to be changed.
+     * <p>Whether to allow the minor version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}</b></p>
      *
      * @since 2.4
      */
-    @Parameter( property = "allowMinorUpdates",
-                defaultValue = "true" )
+    @Parameter( property = "allowMinorUpdates", defaultValue = "true" )
     protected boolean allowMinorUpdates;
 
     /**
-     * Whether to allow the incremental version number to be changed.
+     * <p>Whether to allow the incremental version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates}
+     * and {@linkplain #allowMinorUpdates} {@code false}</b></p>
      *
      * @since 2.4
      */
@@ -181,8 +186,8 @@ protected void update( ModifiedPomXMLEventReader pom )
 
             if ( canUpdateProperty )
             {
-                Optional<Segment> unchangedSegment = determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
-                                                         allowIncrementalUpdates );
+                Optional<Segment> unchangedSegment = SegmentUtils.determineUnchangedSegment( allowMajorUpdates,
+                        allowMinorUpdates, allowIncrementalUpdates, getLog() );
                 try
                 {
                     ArtifactVersion targetVersion =

diff --git a/src/main/java/org/codehaus/mojo/versions/UpdatePropertyMojo.java b/src/main/java/org/codehaus/mojo/versions/UpdatePropertyMojo.java
@@ -41,6 +41,7 @@
 import org.codehaus.mojo.versions.api.Segment;
 import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
 import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.utils.SegmentUtils;
 
 /**
  * Sets a property to the latest version in a given range of associated artifacts.
@@ -109,15 +110,20 @@ public class UpdatePropertyMojo
     protected boolean allowMajorUpdates;
 
     /**
-     * Whether to allow the minor version number to be changed.
+     * <p>Whether to allow the minor version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}</b></p>
      *
      * @since 2.4
      */
     @Parameter( property = "allowMinorUpdates", defaultValue = "true" )
     protected boolean allowMinorUpdates;
 
     /**
-     * Whether to allow the incremental version number to be changed.
+     * <p>Whether to allow the incremental version number to be changed.</p>
+     *
+     * <p><b>Note: {@code false} also implies {@linkplain #allowMajorUpdates}
+     * and {@linkplain #allowMinorUpdates} {@code false}</b></p>
      *
      * @since 2.4
      */
@@ -166,7 +172,8 @@ protected void update( ModifiedPomXMLEventReader pom )
             }
 
             Optional<Segment> unchangedSegment =
-                    determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates, allowIncrementalUpdates );
+                    SegmentUtils.determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
+                            allowIncrementalUpdates, getLog() );
             try
             {
                 ArtifactVersion targetVersion = updatePropertyToNewestVersion( pom, property, version, currentVersion,