Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix parser handling of positional args

Browse Source 
- Change to have better support for args like:

    "--arg1 a --arg2 b"
    "--arg1 a --arg2 b c"
    "--arg1 a c --arg2 b c"
    "c --arg1 a --arg2 b"

  where option can have default values and position of
  positional args doesn't matter that much.
- Make parser to be aware of if it's handling last option
  so that we can differentiate if error can be given i.e.
  with too many args, etc.
- Fixes #795
This commit is contained in:
Janne Valkealahti
2023-06-22 09:46:01 +01:00
parent 9ef509a4da
commit 811f1f9a55
4 changed files with 392 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
spring-shell-samples/spring-shell-sample-e2e/src/main/java/org/springframework/shell/samples/e2e/PositionalArgumentsCommands.java Normal file
View File

@@ -0,0 +1,71 @@
/*
* Copyright 2023 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.samples.e2e;
import org.springframework.shell.command.CommandRegistration.OptionArity;
import org.springframework.shell.command.annotation.Command;
import org.springframework.shell.command.annotation.Option;
import org.springframework.shell.standard.ShellComponent;
import org.springframework.shell.standard.ShellMethod;
import org.springframework.shell.standard.ShellOption;
public class PositionalArgumentsCommands {
@ShellComponent
public static class LegacyAnnotation extends BaseE2ECommands {
@ShellMethod(key = LEGACY_ANNO + "positional-args-1", group = GROUP)
public String testPositionalArgs1(
@ShellOption(arity = 1, defaultValue = ShellOption.NULL) String arg1,
@ShellOption(arity = 1, defaultValue = ShellOption.NULL) String arg2,
@ShellOption(arity = 1, defaultValue = ShellOption.NULL) String arg3
) {
return String.format("Hi arg1='%s' arg2='%s' arg3='%s'", arg1, arg2, arg3);
}
@ShellMethod(key = LEGACY_ANNO + "positional-args-2", group = GROUP)
public String testPositionalArgs2(
@ShellOption(arity = 1, defaultValue = "defaultArg1") String arg1,
@ShellOption(arity = 1, defaultValue = "defaultArg2") String arg2,
@ShellOption(arity = 1, defaultValue = ShellOption.NULL) String arg3
) {
return String.format("Hi arg1='%s' arg2='%s' arg3='%s'", arg1, arg2, arg3);
}
}
@Command(command = BaseE2ECommands.ANNO, group = BaseE2ECommands.GROUP)
public static class Annotation extends BaseE2ECommands {
@Command(command = "positional-args-1")
public String testPositionalArgs1(
@Option(arity = OptionArity.EXACTLY_ONE) String arg1,
@Option(arity = OptionArity.EXACTLY_ONE) String arg2,
@Option(arity = OptionArity.EXACTLY_ONE) String arg3
) {
return String.format("Hi arg1='%s' arg2='%s' arg3='%s'", arg1, arg2, arg3);
}
@Command(command = "positional-args-2")
public String testPositionalArgs2(
@Option(arity = OptionArity.EXACTLY_ONE, defaultValue = "defaultArg1") String arg1,
@Option(arity = OptionArity.EXACTLY_ONE, defaultValue = "defaultArg2") String arg2,
@Option(arity = OptionArity.EXACTLY_ONE) String arg3
) {
return String.format("Hi arg1='%s' arg2='%s' arg3='%s'", arg1, arg2, arg3);
}
}
}