Skip to content

[MSHARED-1412] Allow to customize Interpolator used by filter #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kwin merged 1 commit into from
Aug 5, 2024
Merged

[MSHARED-1412] Allow to customize Interpolator used by filter #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Properties;
import java.util.function.Consumer;

import org.apache.maven.api.Project;
import org.apache.maven.api.Session;
import org.codehaus.plexus.interpolation.Interpolator;

/**
* @since 1.0-beta-3
Expand Down Expand Up @@ -79,6 +81,8 @@ public class AbstractMavenFilteringRequest {
*/
private boolean supportMultiLineFiltering;

private Consumer<Interpolator> interpolatorCustomizer;

/**
* Create instance.
*/
Expand Down Expand Up @@ -337,4 +341,22 @@ public boolean isSupportMultiLineFiltering() {
public void setSupportMultiLineFiltering(boolean supportMultiLineFiltering) {
this.supportMultiLineFiltering = supportMultiLineFiltering;
}

/**
*
* @return the customizer which is supposed to be used by filters creating an {@link Interpolator} like those based on {@link BaseFilter}.
* @since 4.0.0-beta-2
*/
public Consumer<Interpolator> getInterpolatorCustomizer() {
return interpolatorCustomizer;
}

/**
*
* @param interpolatorCustomizer the customizer which is supposed to be used by filters creating an {@link Interpolator} like those based on {@link BaseFilter}.
* @since 4.0.0-beta-2
*/
public void setInterpolatorCustomizer(Consumer<Interpolator> interpolatorCustomizer) {
this.interpolatorCustomizer = interpolatorCustomizer;
}
}
13 changes: 11 additions & 2 deletions src/main/java/org/apache/maven/shared/filtering/BaseFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.util.Optional;
import java.util.Properties;
import java.util.TreeSet;
import java.util.function.Consumer;

import org.apache.maven.api.Project;
import org.apache.maven.api.Session;
Expand Down Expand Up @@ -169,7 +170,8 @@ public List<FilterWrapper> getDefaultFilterWrappers(final AbstractMavenFiltering
request.getProjectStartExpressions(),
request.getEscapeString(),
request.isEscapeWindowsPaths(),
request.isSupportMultiLineFiltering());
request.isSupportMultiLineFiltering(),
request.getInterpolatorCustomizer());

defaultFilterWrappers.add(wrapper);

Expand Down Expand Up @@ -221,6 +223,8 @@ private static final class Wrapper extends FilterWrapper {

private boolean supportMultiLineFiltering;

private Consumer<Interpolator> interpolatorCustomizer;

Wrapper(
LinkedHashSet<String> delimiters,
Project project,
Expand All @@ -229,7 +233,8 @@ private static final class Wrapper extends FilterWrapper {
List<String> projectStartExpressions,
String escapeString,
boolean escapeWindowsPaths,
boolean supportMultiLineFiltering) {
boolean supportMultiLineFiltering,
Consumer<Interpolator> interpolatorCustomizer) {
super();
this.delimiters = delimiters;
this.project = project;
Expand All @@ -239,6 +244,7 @@ private static final class Wrapper extends FilterWrapper {
this.escapeString = escapeString;
this.escapeWindowsPaths = escapeWindowsPaths;
this.supportMultiLineFiltering = supportMultiLineFiltering;
this.interpolatorCustomizer = interpolatorCustomizer;
}

@Override
Expand All @@ -251,6 +257,9 @@ public Reader getReader(Reader reader) {
mavenSession,
escapeString,
escapeWindowsPaths);
if (interpolatorCustomizer != null) {
interpolatorCustomizer.accept(interpolator);
}

MultiDelimiterInterpolatorFilterReaderLineEnding filterReader =
new MultiDelimiterInterpolatorFilterReaderLineEnding(
Expand Down
26 changes: 26 additions & 0 deletions src/test/java/org/apache/maven/shared/filtering/DefaultMavenFileFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package org.apache.maven.shared.filtering;

import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.nio.file.Files;
Expand All @@ -37,6 +38,7 @@
import org.apache.maven.api.model.Build;
import org.apache.maven.api.plugin.testing.stubs.ProjectStub;
import org.apache.maven.di.Injector;
import org.codehaus.plexus.interpolation.AbstractValueSource;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.sonatype.plexus.build.incremental.BuildContext;
Expand Down Expand Up @@ -172,4 +174,28 @@ public void testLineWithSingleAtAndExpression() throws Exception {
assertEquals("[email protected] bar", IOUtils.toString(reader));
}
}

@Test
void testInterpolatorCustomizer() throws MavenFilteringException, IOException {
AbstractMavenFilteringRequest req = new AbstractMavenFilteringRequest();
req.setInterpolatorCustomizer(i -> {
i.addValueSource(new AbstractValueSource(false) {

@Override
public Object getValue(String expression) {
if (expression.equals("foo")) {
return "bar";
}
return null;
}
});
});

MavenFileFilter mavenFileFilter = container.getInstance(MavenFileFilter.class);
List<FilterWrapper> wrappers = mavenFileFilter.getDefaultFilterWrappers(req);

try (Reader reader = wrappers.get(0).getReader(new StringReader("[email protected] ${foo}"))) {
assertEquals("[email protected] bar", IOUtils.toString(reader));
}
}
}