Skip to content

Commit

Permalink
Restructure to make it more transparent what the intent is
Browse files Browse the repository at this point in the history
  • Loading branch information
cstamas committed Sep 28, 2024
1 parent f7f09c9 commit 7ba5e6f
Show file tree
Hide file tree
Showing 19 changed files with 551 additions and 345 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@

import org.apache.maven.cling.invoker.InvokerException;
import org.apache.maven.cling.invoker.ParserException;
import org.apache.maven.cling.invoker.local.LocalInvoker;
import org.apache.maven.cling.invoker.local.LocalParser;
import org.apache.maven.cling.invoker.mvn.local.LocalInvoker;
import org.apache.maven.cling.invoker.mvn.local.LocalParser;
import org.apache.maven.jline.MessageUtils;
import org.codehaus.plexus.classworlds.ClassWorld;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
import org.apache.maven.cling.invoker.InvokerException;
import org.apache.maven.cling.invoker.ParserException;
import org.apache.maven.cling.invoker.ParserRequest;
import org.apache.maven.cling.invoker.local.LocalInvoker;
import org.apache.maven.cling.invoker.local.LocalParser;
import org.apache.maven.cling.invoker.mvn.local.LocalInvoker;
import org.apache.maven.cling.invoker.mvn.local.LocalParser;
import org.apache.maven.jline.MessageUtils;
import org.codehaus.plexus.classworlds.ClassWorld;

Expand Down
4 changes: 2 additions & 2 deletions maven-cli/src/main/java/org/apache/maven/cling/MavenTool.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
import org.apache.maven.cling.invoker.InvokerException;
import org.apache.maven.cling.invoker.ParserException;
import org.apache.maven.cling.invoker.ParserRequest;
import org.apache.maven.cling.invoker.local.LocalInvoker;
import org.apache.maven.cling.invoker.local.LocalParser;
import org.apache.maven.cling.invoker.mvn.local.LocalInvoker;
import org.apache.maven.cling.invoker.mvn.local.LocalParser;
import org.apache.maven.jline.MessageUtils;
import org.codehaus.plexus.classworlds.ClassWorld;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

import static java.util.Objects.requireNonNull;

public class BaseInvokerRequest implements InvokerRequest {
public abstract class BaseInvokerRequest implements InvokerRequest {
private final Path cwd;
private final Path installationDirectory;
private final Path userHomeDirectory;
Expand All @@ -49,8 +49,6 @@ public class BaseInvokerRequest implements InvokerRequest {
private final PrintStream err;
private final List<CoreExtension> coreExtensions;

private final MavenOptions mavenOptions;

@SuppressWarnings("ParameterNumber")
public BaseInvokerRequest(
@Nonnull Path cwd,
Expand All @@ -65,8 +63,7 @@ public BaseInvokerRequest(
@Nullable InputStream in,
@Nullable PrintStream out,
@Nullable PrintStream err,
@Nullable List<CoreExtension> coreExtensions,
@Nonnull MavenOptions mavenOptions) {
@Nullable List<CoreExtension> coreExtensions) {
this.cwd = requireNonNull(cwd);
this.installationDirectory = requireNonNull(installationDirectory);
this.userHomeDirectory = requireNonNull(userHomeDirectory);
Expand All @@ -81,8 +78,6 @@ public BaseInvokerRequest(
this.out = out;
this.err = err;
this.coreExtensions = coreExtensions;

this.mavenOptions = requireNonNull(mavenOptions);
}

@Override
Expand Down Expand Up @@ -149,9 +144,4 @@ public Optional<PrintStream> err() {
public Optional<List<CoreExtension>> coreExtensions() {
return Optional.ofNullable(coreExtensions);
}

@Override
public MavenOptions options() {
return mavenOptions;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.cling.invoker;

import java.io.PrintStream;
import java.util.Collection;
import java.util.Map;
import java.util.Optional;

import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Option;
import org.apache.maven.cli.CLIManager;

import static java.util.Objects.requireNonNull;
import static org.apache.maven.cling.invoker.Utils.toMap;

public abstract class CommonsCliBaseOptions implements BaseOptions {
protected final CLIManager cliManager;
protected final CommandLine commandLine;

public CommonsCliBaseOptions(CLIManager cliManager, CommandLine commandLine) {
this.cliManager = requireNonNull(cliManager);
this.commandLine = requireNonNull(commandLine);
}

public Collection<Option> getUsedDeprecatedOptions() {
return cliManager.getUsedDeprecatedOptions();
}

@Override
public Optional<Map<String, String>> userProperties() {
if (commandLine.hasOption(CLIManager.SET_USER_PROPERTY)) {
return Optional.of(toMap(commandLine.getOptionProperties(String.valueOf(CLIManager.SET_USER_PROPERTY))));
}
return Optional.empty();
}

@Override
public Optional<Boolean> showVersionAndExit() {
if (commandLine.hasOption(CLIManager.VERSION)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<Boolean> showVersion() {
if (commandLine.hasOption(CLIManager.SHOW_VERSION)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<Boolean> quiet() {
if (commandLine.hasOption(CLIManager.QUIET)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<Boolean> verbose() {
if (commandLine.hasOption(CLIManager.VERBOSE) || commandLine.hasOption(CLIManager.DEBUG)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<Boolean> showErrors() {
if (commandLine.hasOption(CLIManager.ERRORS)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<Boolean> nonInteractive() {
if (commandLine.hasOption(CLIManager.NON_INTERACTIVE) || commandLine.hasOption(CLIManager.BATCH_MODE)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<Boolean> forceInteractive() {
if (commandLine.hasOption(CLIManager.FORCE_INTERACTIVE)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public Optional<String> altUserSettings() {
if (commandLine.hasOption(CLIManager.ALTERNATE_USER_SETTINGS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_USER_SETTINGS));
}
return Optional.empty();
}

@Override
public Optional<String> altProjectSettings() {
if (commandLine.hasOption(CLIManager.ALTERNATE_PROJECT_SETTINGS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_PROJECT_SETTINGS));
}
return Optional.empty();
}

@Override
public Optional<String> altInstallationSettings() {
if (commandLine.hasOption(CLIManager.ALTERNATE_INSTALLATION_SETTINGS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_INSTALLATION_SETTINGS));
}
if (commandLine.hasOption(CLIManager.ALTERNATE_GLOBAL_SETTINGS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_GLOBAL_SETTINGS));
}
return Optional.empty();
}

@Override
public Optional<String> altUserToolchains() {
if (commandLine.hasOption(CLIManager.ALTERNATE_USER_TOOLCHAINS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_USER_TOOLCHAINS));
}
return Optional.empty();
}

@Override
public Optional<String> altInstallationToolchains() {
if (commandLine.hasOption(CLIManager.ALTERNATE_INSTALLATION_TOOLCHAINS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_INSTALLATION_TOOLCHAINS));
}
if (commandLine.hasOption(CLIManager.ALTERNATE_GLOBAL_TOOLCHAINS)) {
return Optional.of(commandLine.getOptionValue(CLIManager.ALTERNATE_GLOBAL_TOOLCHAINS));
}
return Optional.empty();
}

@Override
public Optional<String> logFile() {
if (commandLine.hasOption(CLIManager.LOG_FILE)) {
return Optional.of(commandLine.getOptionValue(CLIManager.LOG_FILE));
}
return Optional.empty();
}

@Override
public Optional<String> color() {
if (commandLine.hasOption(CLIManager.COLOR)) {
if (commandLine.getOptionValue(CLIManager.COLOR) != null) {
return Optional.of(commandLine.getOptionValue(CLIManager.COLOR));
} else {
return Optional.of("auto");
}
}
return Optional.empty();
}

@Override
public Optional<Boolean> help() {
if (commandLine.hasOption(CLIManager.HELP)) {
return Optional.of(Boolean.TRUE);
}
return Optional.empty();
}

@Override
public void displayHelp(PrintStream printStream) {
cliManager.displayHelp(printStream);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@
package org.apache.maven.cling.invoker;

/**
* Component responsible to invoke Maven using information provided in invoker request.
* Component responsible to invoke an application using information provided in invoker request.
*
* @param <R> The request type.
*/
public interface Invoker {
public interface Invoker<R extends InvokerRequest> {
/**
* Invokes Maven and returns exit code.
* Invokes application and returns exit code.
*/
int invoke(InvokerRequest invokerRequest) throws InvokerException;
int invoke(R invokerRequest) throws InvokerException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ public interface InvokerRequest {
Optional<List<CoreExtension>> coreExtensions();

/**
* Mandatory: the effective options.
* The mandatory options.
*/
@Nonnull
MavenOptions options();
BaseOptions options();
}
Loading

0 comments on commit 7ba5e6f

Please sign in to comment.