You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2021/04/04 17:49:54 UTC
[maven] branch master updated: [MNG-6656] rename build+consumer
filters to buildToRaw+rawToConsumer
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new 1b6caed [MNG-6656] rename build+consumer filters to buildToRaw+rawToConsumer
1b6caed is described below
commit 1b6caed1ea9bf1bbb46e90a23090433af0627a4f
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Apr 4 19:49:51 2021 +0200
[MNG-6656] rename build+consumer filters to buildToRaw+rawToConsumer
---
.../xml/internal/DefaultConsumerPomXMLFilterFactory.java | 6 +++---
.../maven/model/building/BuildModelSourceTransformer.java | 8 ++++----
.../model/building/DefaultBuildPomXMLFilterFactory.java | 4 ++--
.../{BuildPomXMLFilter.java => BuildToRawPomXMLFilter.java} | 13 ++++++-------
...ilterFactory.java => BuildToRawPomXMLFilterFactory.java} | 12 ++++++------
...terListener.java => BuildToRawPomXMLFilterListener.java} | 4 ++--
.../org/apache/maven/model/transform/ModulesXMLFilter.java | 4 ++--
...umerPomXMLFilter.java => RawToConsumerPomXMLFilter.java} | 8 ++++----
...erFactory.java => RawToConsumerPomXMLFilterFactory.java} | 12 ++++++------
.../apache/maven/model/transform/RelativePathXMLFilter.java | 4 ++--
maven-model-transform/src/site/apt/index.apt | 8 ++++----
.../maven/model/transform/ConsumerPomXMLFilterTest.java | 6 +++---
.../model/transform/ReactorDependencyXMLFilterTest.java | 1 +
13 files changed, 45 insertions(+), 45 deletions(-)
diff --git a/maven-core/src/main/java/org/apache/maven/xml/internal/DefaultConsumerPomXMLFilterFactory.java b/maven-core/src/main/java/org/apache/maven/xml/internal/DefaultConsumerPomXMLFilterFactory.java
index dd15739..fa21591 100644
--- a/maven-core/src/main/java/org/apache/maven/xml/internal/DefaultConsumerPomXMLFilterFactory.java
+++ b/maven-core/src/main/java/org/apache/maven/xml/internal/DefaultConsumerPomXMLFilterFactory.java
@@ -20,16 +20,16 @@ package org.apache.maven.xml.internal;
*/
import org.apache.maven.model.building.DefaultBuildPomXMLFilterFactory;
-import org.apache.maven.model.transform.ConsumerPomXMLFilterFactory;
+import org.apache.maven.model.transform.RawToConsumerPomXMLFilterFactory;
/**
- * The default implementation of the {@link ConsumerPomXMLFilterFactory}
+ * The default implementation of the {@link RawToConsumerPomXMLFilterFactory}
* It will provide several values for the consumer pom based on its context.
*
* @author Robert Scholte
* @since 4.0.0
*/
-public class DefaultConsumerPomXMLFilterFactory extends ConsumerPomXMLFilterFactory
+public class DefaultConsumerPomXMLFilterFactory extends RawToConsumerPomXMLFilterFactory
{
public DefaultConsumerPomXMLFilterFactory( DefaultBuildPomXMLFilterFactory buildPomXMLFilterFactory )
{
diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/BuildModelSourceTransformer.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/BuildModelSourceTransformer.java
index 5047494..699a009 100644
--- a/maven-model-builder/src/main/java/org/apache/maven/model/building/BuildModelSourceTransformer.java
+++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/BuildModelSourceTransformer.java
@@ -31,8 +31,8 @@ import javax.inject.Singleton;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerConfigurationException;
-import org.apache.maven.model.transform.BuildPomXMLFilterFactory;
-import org.apache.maven.model.transform.BuildPomXMLFilterListener;
+import org.apache.maven.model.transform.BuildToRawPomXMLFilterFactory;
+import org.apache.maven.model.transform.BuildToRawPomXMLFilterListener;
import org.apache.maven.model.transform.sax.AbstractSAXFilter;
import org.eclipse.sisu.Nullable;
import org.xml.sax.SAXException;
@@ -50,14 +50,14 @@ class BuildModelSourceTransformer extends AbstractModelSourceTransformer
{
@Inject
@Nullable
- private BuildPomXMLFilterListener xmlFilterListener;
+ private BuildToRawPomXMLFilterListener xmlFilterListener;
protected AbstractSAXFilter getSAXFilter( Path pomFile,
TransformerContext context,
Consumer<LexicalHandler> lexicalHandlerConsumer )
throws TransformerConfigurationException, SAXException, ParserConfigurationException
{
- BuildPomXMLFilterFactory buildPomXMLFilterFactory =
+ BuildToRawPomXMLFilterFactory buildPomXMLFilterFactory =
new DefaultBuildPomXMLFilterFactory( context, lexicalHandlerConsumer, false );
return buildPomXMLFilterFactory.get( pomFile );
diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultBuildPomXMLFilterFactory.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultBuildPomXMLFilterFactory.java
index f6a6386..2cd3c6b 100644
--- a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultBuildPomXMLFilterFactory.java
+++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultBuildPomXMLFilterFactory.java
@@ -27,7 +27,7 @@ import java.util.function.Consumer;
import java.util.function.Function;
import org.apache.maven.model.Model;
-import org.apache.maven.model.transform.BuildPomXMLFilterFactory;
+import org.apache.maven.model.transform.BuildToRawPomXMLFilterFactory;
import org.apache.maven.model.transform.RelativeProject;
import org.xml.sax.ext.LexicalHandler;
@@ -37,7 +37,7 @@ import org.xml.sax.ext.LexicalHandler;
* @author Robert Scholte
* @since 4.0.0
*/
-public class DefaultBuildPomXMLFilterFactory extends BuildPomXMLFilterFactory
+public class DefaultBuildPomXMLFilterFactory extends BuildToRawPomXMLFilterFactory
{
private final TransformerContext context;
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilter.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilter.java
similarity index 87%
rename from maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilter.java
rename to maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilter.java
index cc9cc26..8cc392f 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilter.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilter.java
@@ -1,7 +1,5 @@
package org.apache.maven.model.transform;
-import org.apache.maven.model.transform.sax.AbstractSAXFilter;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -23,24 +21,25 @@ import org.apache.maven.model.transform.sax.AbstractSAXFilter;
import org.xml.sax.XMLReader;
+import org.apache.maven.model.transform.sax.AbstractSAXFilter;
+
/**
* Filter to adjust pom on filesystem before being processed for effective pom.
- * There should only be 1 BuildPomXMLFilter, so the same is being used by both
+ * There should only be 1 BuildToRawPomXMLFilter, so the same is being used by both
* org.apache.maven.model.building.DefaultModelBuilder.transformData(InputStream) and
* org.apache.maven.internal.aether.DefaultRepositorySystemSessionFactory.newFileTransformerManager()
*
- *
* @author Robert Scholte
* @since 4.0.0
*/
-public class BuildPomXMLFilter extends AbstractSAXFilter
+public class BuildToRawPomXMLFilter extends AbstractSAXFilter
{
- BuildPomXMLFilter()
+ BuildToRawPomXMLFilter()
{
super();
}
- BuildPomXMLFilter( AbstractSAXFilter parent )
+ BuildToRawPomXMLFilter( AbstractSAXFilter parent )
{
super( parent );
}
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilterFactory.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilterFactory.java
similarity index 91%
rename from maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilterFactory.java
rename to maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilterFactory.java
index 24ac755..3531e2b 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilterFactory.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilterFactory.java
@@ -35,23 +35,23 @@ import org.xml.sax.XMLReader;
import org.xml.sax.ext.LexicalHandler;
/**
- * Base implementation for providing the BuildPomXML.
+ * Base implementation for providing the BuildToRawPomXML.
*
* @author Robert Scholte
* @since 4.0.0
*/
-public class BuildPomXMLFilterFactory
+public class BuildToRawPomXMLFilterFactory
{
private final boolean consume;
private final Consumer<LexicalHandler> lexicalHandlerConsumer;
- public BuildPomXMLFilterFactory( Consumer<LexicalHandler> lexicalHandlerConsumer )
+ public BuildToRawPomXMLFilterFactory( Consumer<LexicalHandler> lexicalHandlerConsumer )
{
this( lexicalHandlerConsumer, false );
}
- public BuildPomXMLFilterFactory( Consumer<LexicalHandler> lexicalHandlerConsumer, boolean consume )
+ public BuildToRawPomXMLFilterFactory( Consumer<LexicalHandler> lexicalHandlerConsumer, boolean consume )
{
this.lexicalHandlerConsumer = lexicalHandlerConsumer;
this.consume = consume;
@@ -64,7 +64,7 @@ public class BuildPomXMLFilterFactory
* @throws ParserConfigurationException
* @throws TransformerConfigurationException
*/
- public final BuildPomXMLFilter get( Path projectFile )
+ public final BuildToRawPomXMLFilter get( Path projectFile )
throws SAXException, ParserConfigurationException, TransformerConfigurationException
{
AbstractSAXFilter parent = new AbstractSAXFilter();
@@ -104,7 +104,7 @@ public class BuildPomXMLFilterFactory
parent = ciFriendlyFilter;
}
- return new BuildPomXMLFilter( parent );
+ return new BuildToRawPomXMLFilter( parent );
}
private XMLReader getXMLReader() throws SAXException, ParserConfigurationException
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilterListener.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilterListener.java
similarity index 90%
rename from maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilterListener.java
rename to maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilterListener.java
index c6f9a47..ff9cfb6 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildPomXMLFilterListener.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/BuildToRawPomXMLFilterListener.java
@@ -22,13 +22,13 @@ package org.apache.maven.model.transform;
import java.nio.file.Path;
/**
- * Listener can be used to capture the result of the build pom
+ * Listener can be used to capture the result of the transformation of build to raw POM.
*
* @author Robert Scholte
* @since 4.0.0
*/
@FunctionalInterface
-public interface BuildPomXMLFilterListener
+public interface BuildToRawPomXMLFilterListener
{
/**
* Captures the result of the XML transformation
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/ModulesXMLFilter.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/ModulesXMLFilter.java
index a3ec4bb..187fc78 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/ModulesXMLFilter.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/ModulesXMLFilter.java
@@ -1,7 +1,5 @@
package org.apache.maven.model.transform;
-import org.apache.maven.model.transform.sax.AbstractSAXFilter;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -24,6 +22,8 @@ import org.apache.maven.model.transform.sax.AbstractSAXFilter;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
+import org.apache.maven.model.transform.sax.AbstractSAXFilter;
+
/**
* Remove all modules, this is just buildtime information
*
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/ConsumerPomXMLFilter.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/RawToConsumerPomXMLFilter.java
similarity index 93%
rename from maven-model-transform/src/main/java/org/apache/maven/model/transform/ConsumerPomXMLFilter.java
rename to maven-model-transform/src/main/java/org/apache/maven/model/transform/RawToConsumerPomXMLFilter.java
index 0215cf3..767cb0b 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/ConsumerPomXMLFilter.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/RawToConsumerPomXMLFilter.java
@@ -1,7 +1,5 @@
package org.apache.maven.model.transform;
-import org.apache.maven.model.transform.sax.AbstractSAXFilter;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -24,6 +22,8 @@ import org.apache.maven.model.transform.sax.AbstractSAXFilter;
import org.xml.sax.XMLReader;
import org.xml.sax.ext.LexicalHandler;
+import org.apache.maven.model.transform.sax.AbstractSAXFilter;
+
/**
* XML Filter to transform pom.xml to consumer pom.
* This often means stripping of build-specific information.
@@ -35,9 +35,9 @@ import org.xml.sax.ext.LexicalHandler;
* @author Robert Scholte
* @since 4.0.0
*/
-public class ConsumerPomXMLFilter extends AbstractSAXFilter
+public class RawToConsumerPomXMLFilter extends AbstractSAXFilter
{
- ConsumerPomXMLFilter( AbstractSAXFilter filter )
+ RawToConsumerPomXMLFilter( AbstractSAXFilter filter )
{
super( filter );
}
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/ConsumerPomXMLFilterFactory.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/RawToConsumerPomXMLFilterFactory.java
similarity index 79%
rename from maven-model-transform/src/main/java/org/apache/maven/model/transform/ConsumerPomXMLFilterFactory.java
rename to maven-model-transform/src/main/java/org/apache/maven/model/transform/RawToConsumerPomXMLFilterFactory.java
index bdbb023..d03b9e8 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/ConsumerPomXMLFilterFactory.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/RawToConsumerPomXMLFilterFactory.java
@@ -32,19 +32,19 @@ import org.xml.sax.SAXException;
* @author Robert Scholte
* @since 4.0.0
*/
-public class ConsumerPomXMLFilterFactory
+public class RawToConsumerPomXMLFilterFactory
{
- private BuildPomXMLFilterFactory buildPomXMLFilterFactory;
+ private BuildToRawPomXMLFilterFactory buildPomXMLFilterFactory;
- public ConsumerPomXMLFilterFactory( BuildPomXMLFilterFactory buildPomXMLFilterFactory )
+ public RawToConsumerPomXMLFilterFactory( BuildToRawPomXMLFilterFactory buildPomXMLFilterFactory )
{
this.buildPomXMLFilterFactory = buildPomXMLFilterFactory;
}
- public final ConsumerPomXMLFilter get( Path projectPath )
+ public final RawToConsumerPomXMLFilter get( Path projectPath )
throws SAXException, ParserConfigurationException, TransformerConfigurationException
{
- BuildPomXMLFilter parent = buildPomXMLFilterFactory.get( projectPath );
+ BuildToRawPomXMLFilter parent = buildPomXMLFilterFactory.get( projectPath );
// Ensure that xs:any elements aren't touched by next filters
@@ -55,6 +55,6 @@ public class ConsumerPomXMLFilterFactory
// Adjust relativePath
filter = new RelativePathXMLFilter( filter );
- return new ConsumerPomXMLFilter( filter );
+ return new RawToConsumerPomXMLFilter( filter );
}
}
diff --git a/maven-model-transform/src/main/java/org/apache/maven/model/transform/RelativePathXMLFilter.java b/maven-model-transform/src/main/java/org/apache/maven/model/transform/RelativePathXMLFilter.java
index e3b88c3..2ca09ac 100644
--- a/maven-model-transform/src/main/java/org/apache/maven/model/transform/RelativePathXMLFilter.java
+++ b/maven-model-transform/src/main/java/org/apache/maven/model/transform/RelativePathXMLFilter.java
@@ -1,7 +1,5 @@
package org.apache.maven.model.transform;
-import org.apache.maven.model.transform.sax.AbstractSAXFilter;
-
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -24,6 +22,8 @@ import org.apache.maven.model.transform.sax.AbstractSAXFilter;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
+import org.apache.maven.model.transform.sax.AbstractSAXFilter;
+
/**
* Remove relativePath element, has no value for consumer pom
*
diff --git a/maven-model-transform/src/site/apt/index.apt b/maven-model-transform/src/site/apt/index.apt
index 3b3314f..69f89c7 100644
--- a/maven-model-transform/src/site/apt/index.apt
+++ b/maven-model-transform/src/site/apt/index.apt
@@ -41,8 +41,8 @@ Maven Model XML Transformer
Transformation is implemented as two filters:
- * <<build to raw>> in <<<BuildPomXMLFilter>>> ({{{./apidocs/org/apache/maven/model/transform/BuildPomXMLFilter.html}javadoc}}),
- with its <<<BuildPomXMLFilterFactory>>> ({{{./xref/org/apache/maven/model/transform/BuildPomXMLFilterFactory.html}source}}) assembling transformation steps,
+ * <<build to raw>> in <<<BuildToRawPomXMLFilter>>> ({{{./apidocs/org/apache/maven/model/transform/BuildPomToRawXMLFilter.html}javadoc}}),
+ with its <<<BuildToRawPomXMLFilterFactory>>> ({{{./xref/org/apache/maven/model/transform/BuildToRawPomXMLFilterFactory.html}source}}) assembling transformation steps,
* in a multi-module build, <<<parent>>>'s <<<version>>> is automatically added,
@@ -52,8 +52,8 @@ Maven Model XML Transformer
[]
- * <<raw to consumer>> in <<<ConsumerPomXMLFilter>>> ({{{./apidocs/org/apache/maven/model/transform/ConsumerPomXMLFilter.html}javadoc}}),
- with its <<<ConsumerPomXMLFilterFactory>>> ({{{./xref/org/apache/maven/model/transform/ConsumerPomXMLFilterFactory.html}source}}) assembling transformation steps.
+ * <<raw to consumer>> in <<<RawToConsumerPomXMLFilter>>> ({{{./apidocs/org/apache/maven/model/transform/RawToConsumerPomXMLFilter.html}javadoc}}),
+ with its <<<RawToConsumerPomXMLFilterFactory>>> ({{{./xref/org/apache/maven/model/transform/RawToConsumerPomXMLFilterFactory.html}source}}) assembling transformation steps.
* <<<modules>>> is stripped because it only has a meaning at build time on disk, but not once mapped to repository format,
diff --git a/maven-model-transform/src/test/java/org/apache/maven/model/transform/ConsumerPomXMLFilterTest.java b/maven-model-transform/src/test/java/org/apache/maven/model/transform/ConsumerPomXMLFilterTest.java
index 4cb00cc..4fe2c19 100644
--- a/maven-model-transform/src/test/java/org/apache/maven/model/transform/ConsumerPomXMLFilterTest.java
+++ b/maven-model-transform/src/test/java/org/apache/maven/model/transform/ConsumerPomXMLFilterTest.java
@@ -48,7 +48,7 @@ public class ConsumerPomXMLFilterTest extends AbstractXMLFilterTests
protected AbstractSAXFilter getFilter( Consumer<LexicalHandler> lexicalHandlerConsumer )
throws SAXException, ParserConfigurationException, TransformerConfigurationException
{
- final BuildPomXMLFilterFactory buildPomXMLFilterFactory = new BuildPomXMLFilterFactory( lexicalHandlerConsumer, true )
+ final BuildToRawPomXMLFilterFactory buildPomXMLFilterFactory = new BuildToRawPomXMLFilterFactory( lexicalHandlerConsumer, true )
{
@Override
protected Function<Path, Optional<RelativeProject>> getRelativePathMapper()
@@ -82,8 +82,8 @@ public class ConsumerPomXMLFilterTest extends AbstractXMLFilterTests
};
- ConsumerPomXMLFilter filter =
- new ConsumerPomXMLFilterFactory( buildPomXMLFilterFactory ).get( Paths.get( "pom.xml" ) );
+ RawToConsumerPomXMLFilter filter =
+ new RawToConsumerPomXMLFilterFactory( buildPomXMLFilterFactory ).get( Paths.get( "pom.xml" ) );
filter.setFeature( "http://xml.org/sax/features/namespaces", true );
return filter;
}
diff --git a/maven-model-transform/src/test/java/org/apache/maven/model/transform/ReactorDependencyXMLFilterTest.java b/maven-model-transform/src/test/java/org/apache/maven/model/transform/ReactorDependencyXMLFilterTest.java
index 5f11b64..69b4783 100644
--- a/maven-model-transform/src/test/java/org/apache/maven/model/transform/ReactorDependencyXMLFilterTest.java
+++ b/maven-model-transform/src/test/java/org/apache/maven/model/transform/ReactorDependencyXMLFilterTest.java
@@ -18,6 +18,7 @@ package org.apache.maven.model.transform;
* specific language governing permissions and limitations
* under the License.
*/
+
import static org.xmlunit.assertj.XmlAssert.assertThat;
import java.util.function.Consumer;