Skip to content

Introduced default completion provider supporting enumeration values if option is of enum type #1297

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

Open
czpilar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Introduced default completion provider supporting enumeration values if option is of enum type #1297

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
4 changes: 2 additions & 2 deletions spring-shell-core/src/main/java/org/springframework/shell/core/command/AbstractCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

Expand All @@ -28,6 +27,7 @@
import org.springframework.shell.core.ParameterValidationException;
import org.springframework.shell.core.command.availability.Availability;
import org.springframework.shell.core.command.availability.AvailabilityProvider;
import org.springframework.shell.core.command.completion.DefaultCompletionProvider;
import org.springframework.shell.core.command.exit.ExitStatusExceptionMapper;
import org.springframework.shell.core.command.completion.CompletionProvider;

Expand All @@ -54,7 +54,7 @@ public abstract class AbstractCommand implements Command {

@Nullable private ExitStatusExceptionMapper exitStatusExceptionMapper;

private CompletionProvider completionProvider = context -> Collections.emptyList();
private CompletionProvider completionProvider = new DefaultCompletionProvider();

private List<CommandOption> options = new ArrayList<>();

Expand Down
5 changes: 3 additions & 2 deletions spring-shell-core/src/main/java/org/springframework/shell/core/command/Command.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.springframework.shell.core.command.adapter.ConsumerCommandAdapter;
import org.springframework.shell.core.command.adapter.FunctionCommandAdapter;
import org.springframework.shell.core.command.availability.AvailabilityProvider;
import org.springframework.shell.core.command.completion.DefaultCompletionProvider;
import org.springframework.shell.core.command.exit.ExitStatusExceptionMapper;
import org.springframework.shell.core.command.completion.CompletionProvider;
import org.springframework.util.Assert;
Expand Down Expand Up @@ -108,7 +109,7 @@ default AvailabilityProvider getAvailabilityProvider() {
* @return the completion provider of the command
*/
default CompletionProvider getCompletionProvider() {
return context -> Collections.emptyList();
return context -> new DefaultCompletionProvider().apply(context);
}

/**
Expand Down Expand Up @@ -147,7 +148,7 @@ final class Builder {

private AvailabilityProvider availabilityProvider = AvailabilityProvider.alwaysAvailable();

private CompletionProvider completionProvider = context -> Collections.emptyList();
private CompletionProvider completionProvider = new DefaultCompletionProvider();

@Nullable ExitStatusExceptionMapper exitStatusExceptionMapper;

Expand Down
4 changes: 2 additions & 2 deletions ...in/java/org/springframework/shell/core/command/annotation/support/CommandFactoryBean.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import java.lang.reflect.Parameter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import jakarta.validation.Validator;
Expand All @@ -42,6 +41,7 @@
import org.springframework.shell.core.command.adapter.MethodInvokerCommandAdapter;
import org.springframework.shell.core.command.annotation.Option;
import org.springframework.shell.core.command.availability.AvailabilityProvider;
import org.springframework.shell.core.command.completion.DefaultCompletionProvider;
import org.springframework.shell.core.command.exit.ExitStatusExceptionMapper;
import org.springframework.shell.core.command.completion.CompletionProvider;
import org.springframework.shell.core.utils.Utils;
Expand Down Expand Up @@ -142,7 +142,7 @@ private List<CommandOption> getCommandOptions() {
}

private CompletionProvider getCompletionProvider(String completionProviderBeanName) {
CompletionProvider completionProvider = CompletionContext -> Collections.emptyList();
CompletionProvider completionProvider = new DefaultCompletionProvider();
if (!completionProviderBeanName.isEmpty()) {
try {
completionProvider = this.applicationContext.getBean(completionProviderBeanName,
Expand Down
59 changes: 59 additions & 0 deletions ...ain/java/org/springframework/shell/core/command/completion/DefaultCompletionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* Copyright 2022-present the original author or authors.
*
* Licensed 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
*
* https://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.springframework.shell.core.command.completion;

import org.jspecify.annotations.Nullable;
import org.springframework.shell.core.command.CommandOption;

import java.util.Collections;
import java.util.List;

/**
* A default implementation of the {@link CompletionProvider} interface that provides
* completion proposals for enum-type command options and handles prefix generation for
* command options based on the current input context.
*
* @author David Pilar
* @since 4.0.1
*/
public class DefaultCompletionProvider implements CompletionProvider {

@Override
public List<CompletionProposal> apply(CompletionContext context) {
if (context.getCommandOption() == null || !context.getCommandOption().type().isEnum()) {
return Collections.emptyList();
}
return new EnumCompletionProvider(context.getCommandOption().type(),
getPrefix(context.currentWord(), context.getCommandOption()))
.apply(context);
}

private String getPrefix(@Nullable String currentWord, CommandOption option) {
String prefix = "";
if (currentWord == null) {
return prefix;
}

if (option.longName() != null && currentWord.startsWith("--" + option.longName() + "=")) {
prefix = "--" + option.longName();
}
else if (option.shortName() != ' ' && currentWord.startsWith("-" + option.shortName() + "=")) {
prefix = "-" + option.shortName();
}
return prefix;
}

}
85 changes: 85 additions & 0 deletions ...ava/org/springframework/shell/core/command/completion/DefaultCompletionProviderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
package org.springframework.shell.core.command.completion;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.springframework.shell.core.command.CommandOption;

import java.util.List;
import java.util.stream.Stream;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

/**
* @author David Pilar
*/
class DefaultCompletionProviderTests {

@Test
void testApplyWithNoCommandOption() {
// given
CompletionContext context = mock(CompletionContext.class);
when(context.getCommandOption()).thenReturn(null);

// when
List<CompletionProposal> result = new DefaultCompletionProvider().apply(context);

// then
assertTrue(result.isEmpty());
}

@Test
void testApplyWithNoEnumCommandOption() {
// given
CompletionContext context = mock(CompletionContext.class);
when(context.getCommandOption()).thenReturn(CommandOption.with().type(String.class).build());

// when
List<CompletionProposal> result = new DefaultCompletionProvider().apply(context);

// then
assertTrue(result.isEmpty());
}

public enum TestEnum {

VALUE1, VALUE2

}

@ParameterizedTest
@MethodSource("applyWithEnumCommandOptionData")
void testApplyWithEnumCommandOption(String currentWord, String longName, char shortName,
List<String> expectedValues) {
// given
CompletionContext context = mock(CompletionContext.class);
when(context.getCommandOption())
.thenReturn(CommandOption.with().longName(longName).shortName(shortName).type(TestEnum.class).build());
when(context.currentWord()).thenReturn(currentWord);

// when
List<CompletionProposal> result = new DefaultCompletionProvider().apply(context);
List<String> resultValues = result.stream().map(CompletionProposal::value).toList();

// then
assertEquals(expectedValues, resultValues);
}

static Stream<Arguments> applyWithEnumCommandOptionData() {
return Stream.of(Arguments.of(null, "name", 'n', List.of("VALUE1", "VALUE2")),
Arguments.of("", "name", 'n', List.of("VALUE1", "VALUE2")),
Arguments.of("different", "name", 'n', List.of("VALUE1", "VALUE2")),
Arguments.of("VA", "name", 'n', List.of("VALUE1", "VALUE2")),

Arguments.of("--name=", "name", 'n', List.of("--name=VALUE1", "--name=VALUE2")),
Arguments.of("-n=", "name", 'n', List.of("-n=VALUE1", "-n=VALUE2")),

Arguments.of("--name=", null, 'n', List.of("VALUE1", "VALUE2")),
Arguments.of("-n=", "name", ' ', List.of("VALUE1", "VALUE2")));
}

}