Skip to content

Commit 9f011c2

Browse files
ChuckameChuckame
committed
apply & generate-profile working nice
1 parent a0bc3e5 commit 9f011c2

15 files changed

+166
-44
lines changed

‎build.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ dependencies {
1616
implementation 'org.springframework.boot:spring-boot-starter'
1717
implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml'
1818
compile 'io.projectreactor:reactor-core'
19+
implementation 'com.beust:jcommander:1.78'
1920

2021
compileOnly 'org.projectlombok:lombok'
2122
annotationProcessor 'org.projectlombok:lombok'

‎gradle/wrapper/gradle-wrapper.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#Wed Oct 07 14:18:54 CEST 2020
2-
distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-all.zip
2+
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
33
distributionBase=GRADLE_USER_HOME
44
distributionPath=wrapper/dists
55
zipStorePath=wrapper/dists

‎src/main/java/fr/chuckame/marlinfw/configurator/InvalidUseException.java

-7
This file was deleted.

‎src/main/java/fr/chuckame/marlinfw/configurator/command/ApplyProfileCommand.java ‎src/main/java/fr/chuckame/marlinfw/configurator/command/ApplyCommand.java

+14-13
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
import com.beust.jcommander.Parameter;
44
import com.beust.jcommander.Parameters;
5-
import fr.chuckame.marlinfw.configurator.InvalidUseException;
65
import fr.chuckame.marlinfw.configurator.change.LineChange;
76
import fr.chuckame.marlinfw.configurator.change.LineChangeFormatter;
87
import fr.chuckame.marlinfw.configurator.change.LineChangeManager;
98
import fr.chuckame.marlinfw.configurator.constant.Constant;
109
import fr.chuckame.marlinfw.configurator.constant.ProfilePropertiesChangeAdapter;
1110
import fr.chuckame.marlinfw.configurator.profile.ProfilePropertiesParser;
11+
import fr.chuckame.marlinfw.configurator.util.ConsoleHelper;
1212
import fr.chuckame.marlinfw.configurator.util.FileHelper;
1313
import lombok.RequiredArgsConstructor;
1414
import org.springframework.stereotype.Component;
@@ -25,28 +25,29 @@
2525
import java.util.stream.Collectors;
2626

2727
@Component
28-
@Parameters(commandNames = "apply-profile")
28+
@Parameters(commandNames = "apply", commandDescription = "Apply the given profile to marlin constants files, that will enable, change value or disable constants into marlin configuration files")
2929
@RequiredArgsConstructor
30-
public class ApplyProfileCommand implements Command {
31-
@Parameter(names = {"--profile", "-p"}, required = true)
32-
private Path profilePath;
33-
@Parameter(names = {"--file", "--files", "-f"}, required = true)
30+
public class ApplyCommand implements Command {
31+
@Parameter(required = true, description = "/path1 /path2 ...\tFile(s) path(s) where all changes will be applied")
3432
private List<Path> filesPath;
35-
@Parameter(names = {"--save", "-s"})
33+
@Parameter(names = {"--profile", "-p"}, required = true, description = "Profile's path containing changes to apply. Format: yaml")
34+
private Path profilePath;
35+
@Parameter(names = {"--save", "-s"}, description = "When is present, will save changes to files. Else, just display changes without saving")
3636
private boolean doSave;
37-
@Parameter(names = {"--yes", "-y"})
37+
@Parameter(names = {"--yes", "-y"}, description = "when present, the changes will be saved without prompting the user")
3838
private boolean applyWithoutPrompt;
3939

4040
private final ProfilePropertiesChangeAdapter changeAdapter;
4141
private final LineChangeManager lineChangeManager;
4242
private final LineChangeFormatter lineChangeFormatter;
4343
private final ProfilePropertiesParser profilePropertiesParser;
4444
private final FileHelper fileHelper;
45+
private final ConsoleHelper consoleHelper;
4546

4647
@Override
4748
public Mono<Void> run() {
4849
return profilePropertiesParser.parseFromFile(profilePath)
49-
.map(changeAdapter::getWantedConstants)
50+
.map(changeAdapter::profileToConstants)
5051
.flatMap(wantedConstants ->
5152
prepareChanges(filesPath, wantedConstants)
5253
.flatMap(changes -> printChanges(changes)
@@ -62,7 +63,7 @@ private Mono<Void> printChanges(final Map<Path, List<LineChange>> changes) {
6263
Flux.fromIterable(fileChanges.getValue()).filter(LineChange::isConstant).map(lineChangeFormatter::format),
6364
Flux.just("")
6465
))
65-
.doOnNext(System.out::println)
66+
.doOnNext(consoleHelper::writeLine)
6667
.then()
6768
;
6869
}
@@ -71,18 +72,18 @@ private Mono<Void> printUnusedConstants(final Map<Path, List<LineChange>> change
7172
return lineChangeManager.getUnusedWantedConstants(changes.values().stream().flatMap(List::stream).collect(Collectors.toList()), wantedConstants)
7273
.collectList()
7374
.filter(Predicate.not(List::isEmpty))
74-
.doOnNext(unusedConstants -> System.out.printf("Still some unused constants: %s%n", unusedConstants))
75+
.doOnNext(unusedConstants -> consoleHelper.writeLine(String.format("Still some unused constants: %s%n", unusedConstants)))
7576
.then();
7677
}
7778

7879
private Mono<Void> checkIfUserAgree() {
7980
if (applyWithoutPrompt) {
8081
return Mono.empty();
8182
}
82-
return Mono.fromRunnable(() -> System.out.println("Apply changes ? type 'y' to apply changes, or everything else to cancel"))
83+
return Mono.fromRunnable(() -> consoleHelper.writeLine("Apply changes ? type 'y' to apply changes, or everything else to cancel"))
8384
.then(Mono.fromSupplier(() -> new Scanner(System.in).next()))
8485
.filter("y"::equals)
85-
.switchIfEmpty(Mono.error(() -> new InvalidUseException("User refused to apply")))
86+
.switchIfEmpty(Mono.error(() -> new ManuallyStoppedException("User refused to apply")))
8687
.then();
8788
}
8889

‎src/main/java/fr/chuckame/marlinfw/configurator/command/CommandRunner.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import com.beust.jcommander.JCommander;
44
import com.beust.jcommander.ParameterException;
5-
import fr.chuckame.marlinfw.configurator.InvalidUseException;
5+
import fr.chuckame.marlinfw.configurator.util.ConsoleHelper;
66
import lombok.RequiredArgsConstructor;
77
import org.springframework.boot.CommandLineRunner;
88
import org.springframework.stereotype.Component;
@@ -11,23 +11,23 @@
1111
@RequiredArgsConstructor
1212
public class CommandRunner implements CommandLineRunner {
1313
private final JCommander jCommander;
14+
private final ConsoleHelper consoleHelper;
1415

1516
@Override
1617
public void run(final String... args) throws Exception {
1718
try {
1819
jCommander.parse(args);
1920
} catch (final ParameterException e) {
20-
System.err.println("Bad argument: " + e.getMessage());
21-
e.usage();
22-
System.exit(1);
21+
consoleHelper.writeErrorLine("Bad argument: " + e.getMessage());
22+
consoleHelper.writeLine(jCommander.getUsageFormatter()::usage);
23+
System.exit(InvalidUseException.EXIT_CODE);
2324
}
2425
try {
2526
final Command command = (Command) jCommander.findCommandByAlias(jCommander.getParsedAlias()).getObjects().get(0);
2627
command.run().blockOptional();
27-
} catch (final InvalidUseException e) {
28-
System.err.println(e.getMessage());
29-
System.exit(2);
28+
} catch (final ManuallyStoppedException e) {
29+
consoleHelper.writeErrorLine(e.getMessage());
30+
System.exit(e.getExitCode());
3031
}
31-
3232
}
3333
}

‎src/main/java/fr/chuckame/marlinfw/configurator/command/GenerateProfileCommand.java

+11-7
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import fr.chuckame.marlinfw.configurator.constant.ConstantLineInterpreter;
66
import fr.chuckame.marlinfw.configurator.profile.ConstantHelper;
77
import fr.chuckame.marlinfw.configurator.profile.ProfilePropertiesParser;
8+
import fr.chuckame.marlinfw.configurator.util.ConsoleHelper;
89
import fr.chuckame.marlinfw.configurator.util.FileHelper;
910
import lombok.RequiredArgsConstructor;
1011
import org.springframework.stereotype.Component;
@@ -15,27 +16,30 @@
1516
import java.util.List;
1617

1718
@Component
18-
@Parameters(commandNames = "generate-profile")
19+
@Parameters(commandNames = "generate-profile", commandDescription = "Generate a profile from given marlin constants files")
1920
@RequiredArgsConstructor
2021
public class GenerateProfileCommand implements Command {
21-
@Parameter(names = {"--output", "-o"}, required = true)
22-
private Path profilePath;
23-
@Parameter(names = {"--input", "-i"}, required = true)
22+
@Parameter(required = true, description = "/path1 /path2 ...\tThe marlin constants files paths")
2423
private List<Path> filesPath;
24+
@Parameter(names = {"--output", "-o"}, required = true, description = "The output profile path, will be overwritten if already existing file. If 'console' is specified, the profile will just be printed to the console")
25+
private Path profilePath;
26+
27+
private static final Path CONSOLE_OUTPUT = Path.of("console");
2528

2629
private final ProfilePropertiesParser profilePropertiesParser;
2730
private final FileHelper fileHelper;
2831
private final ConstantHelper constantHelper;
2932
private final ConstantLineInterpreter constantLineInterpreter;
30-
31-
// todo: without --output, print to console
33+
private final ConsoleHelper consoleHelper;
3234

3335
@Override
3436
public Mono<Void> run() {
3537
return constantHelper.constantsToProfile(Flux.fromIterable(filesPath)
3638
.flatMap(fileHelper::lines)
3739
.flatMap(constantLineInterpreter::parseLine)
3840
.map(ConstantLineInterpreter.ParsedConstant::getConstant))
39-
.flatMap(profile -> profilePropertiesParser.writeToFile(profile, profilePath));
41+
.flatMap(profile -> profilePath.equals(CONSOLE_OUTPUT) ?
42+
profilePropertiesParser.writeToString(profile).doOnNext(consoleHelper::writeLine).then()
43+
: profilePropertiesParser.writeToFile(profile, profilePath));
4044
}
4145
}

‎src/main/java/fr/chuckame/marlinfw/configurator/command/HelpCommand.java

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
package fr.chuckame.marlinfw.configurator.command;
2+
3+
import com.beust.jcommander.JCommander;
4+
import com.beust.jcommander.Parameters;
5+
import fr.chuckame.marlinfw.configurator.util.ConsoleHelper;
6+
import lombok.RequiredArgsConstructor;
7+
import org.springframework.stereotype.Component;
8+
import reactor.core.publisher.Mono;
9+
10+
@Component
11+
@Parameters(commandNames = "help", commandDescription = "Display this help message")
12+
@RequiredArgsConstructor
13+
public class HelpCommand implements Command {
14+
private final ConsoleHelper consoleHelper;
15+
private final JCommander jCommander;
16+
17+
@Override
18+
public Mono<Void> run() {
19+
return Mono.fromSupplier(StringBuilder::new)
20+
.doOnNext(jCommander.getUsageFormatter()::usage)
21+
.map(StringBuilder::toString)
22+
.doOnNext(consoleHelper::writeLine)
23+
.then();
24+
}
25+
}

‎src/main/java/fr/chuckame/marlinfw/configurator/command/InvalidUseException.java

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package fr.chuckame.marlinfw.configurator.command;
2+
3+
import org.springframework.boot.ExitCodeGenerator;
4+
5+
public class InvalidUseException extends RuntimeException implements ExitCodeGenerator {
6+
public static final int EXIT_CODE = 2;
7+
8+
public InvalidUseException(final String format, final Object... args) {
9+
super(String.format(format, args));
10+
}
11+
12+
@Override
13+
public int getExitCode() {
14+
return EXIT_CODE;
15+
}
16+
}

‎src/main/java/fr/chuckame/marlinfw/configurator/command/ManuallyStoppedException.java

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package fr.chuckame.marlinfw.configurator.command;
2+
3+
import org.springframework.boot.ExitCodeGenerator;
4+
5+
public class ManuallyStoppedException extends RuntimeException implements ExitCodeGenerator {
6+
public static final int EXIT_CODE = 1;
7+
8+
public ManuallyStoppedException(final String format, final Object... args) {
9+
super(String.format(format, args));
10+
}
11+
12+
@Override
13+
public int getExitCode() {
14+
return EXIT_CODE;
15+
}
16+
}

‎src/main/java/fr/chuckame/marlinfw/configurator/config/JCommanderConfig.java

+16-5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import com.beust.jcommander.JCommander;
44
import fr.chuckame.marlinfw.configurator.command.Command;
5+
import org.springframework.beans.factory.ObjectProvider;
56
import org.springframework.beans.factory.annotation.Value;
67
import org.springframework.context.annotation.Bean;
78
import org.springframework.context.annotation.Configuration;
@@ -10,11 +11,21 @@
1011

1112
@Configuration
1213
public class JCommanderConfig {
14+
@Value("${command-usage}")
15+
private String commandUsage;
16+
17+
@Bean
18+
public List<Command> commands(final ObjectProvider<List<Command>> commandsProvider) {
19+
final var commands = commandsProvider.getObject(jCommander());
20+
commands.forEach(jCommander()::addCommand);
21+
return commands;
22+
}
23+
1324
@Bean
14-
public JCommander jCommander(final List<Command> commands, @Value("${command-usage}") final String commandUsage) {
15-
final var jcmd = JCommander.newBuilder();
16-
jcmd.programName(commandUsage);
17-
commands.forEach(jcmd::addCommand);
18-
return jcmd.build();
25+
public JCommander jCommander() {
26+
final var jcmd = new JCommander();
27+
jcmd.setProgramName(commandUsage);
28+
jcmd.setColumnSize(140);
29+
return jcmd;
1930
}
2031
}

‎src/main/java/fr/chuckame/marlinfw/configurator/constant/ProfilePropertiesChangeAdapter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
@Component
1010
public class ProfilePropertiesChangeAdapter {
11-
public Map<String, Constant> getWantedConstants(final ProfileProperties profileProperties) {
11+
public Map<String, Constant> profileToConstants(final ProfileProperties profileProperties) {
1212
final var wantedChanges = new HashMap<String, Constant>();
1313
profileProperties.getDisabled().forEach(constantName -> wantedChanges.put(constantName, disabledConstant(constantName)));
1414
profileProperties.getEnabled().forEach((constantName, constantValue) -> wantedChanges.put(constantName, enabledConstant(constantName, constantValue)));

‎src/main/java/fr/chuckame/marlinfw/configurator/profile/ProfilePropertiesParser.java

+4
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ public Mono<Void> writeToFile(final ProfileProperties profile, final Path output
3737
.then();
3838
}
3939

40+
public Mono<String> writeToString(final ProfileProperties profile) {
41+
return Mono.fromCallable(() -> yamlParser.writeValueAsString(profile));
42+
}
43+
4044
private ObjectMapper prepareYamlMapper() {
4145
return new ObjectMapper(newYamlFactoryWithCustomIndentationForArrays(2)
4246
.enable(MINIMIZE_QUOTES)

‎src/main/java/fr/chuckame/marlinfw/configurator/util/ConsoleHelper.java

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
package fr.chuckame.marlinfw.configurator.util;
2+
3+
import lombok.RequiredArgsConstructor;
4+
import org.springframework.stereotype.Service;
5+
6+
import java.util.Scanner;
7+
import java.util.function.Consumer;
8+
9+
@Service
10+
public class ConsoleHelper {
11+
private static final String RESET_COLOR = "\u001B[0m";
12+
13+
@RequiredArgsConstructor
14+
public enum ColorEnum {
15+
// BLACK("\u001B[30m"), useless since it is the default background color
16+
RED("\u001B[31m"),
17+
GREEN("\u001B[32m"),
18+
YELLOW("\u001B[33m"),
19+
BLUE("\u001B[34m"),
20+
PURPLE("\u001B[35m"),
21+
CYAN("\u001B[36m"),
22+
// WHITE("\u001B[37m") useless since it is the default color
23+
;
24+
private final String colorCode;
25+
}
26+
27+
public void writeLine(final String line, final ColorEnum color) {
28+
writeLine(String.join("", color.colorCode, line, RESET_COLOR));
29+
}
30+
31+
public void writeLine(final String line) {
32+
System.out.println(line);
33+
}
34+
35+
public void writeLine(final Consumer<StringBuilder> lineBuilder) {
36+
final var line = new StringBuilder();
37+
lineBuilder.accept(line);
38+
writeLine(lineBuilder.toString());
39+
}
40+
41+
public void writeErrorLine(final String line) {
42+
System.err.println(line);
43+
}
44+
45+
public String readLine() {
46+
return new Scanner(System.in).next();
47+
}
48+
}

‎src/main/resources/application.yml

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
spring.main.web-application-type: none
22
spring.main.banner-mode: off
33
command-usage: ./gradlew bootRun
4+
spring:
5+
main:
6+
log-startup-info: false

‎src/test/java/fr/chuckame/marlinfw/configurator/constant/ProfilePropertiesChangeAdapterTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ void getWantedConstantsShouldReturnEmptyMapWhenEmptyEnabledAndEmptyDisabled() {
1919
.disabled(List.of())
2020
.build();
2121

22-
final var wantedConstants = changeAdapter.getWantedConstants(profile);
22+
final var wantedConstants = changeAdapter.profileToConstants(profile);
2323

2424
assertThat(wantedConstants).isEmpty();
2525
}
@@ -31,7 +31,7 @@ void getWantedConstantsShouldReturnExpectedConstants() {
3131
.disabled(List.of("c3", "c4"))
3232
.build();
3333

34-
final var wantedConstants = changeAdapter.getWantedConstants(profile);
34+
final var wantedConstants = changeAdapter.profileToConstants(profile);
3535

3636
assertThat(wantedConstants)
3737
.containsEntry("c1", Constant.builder().enabled(true).name("c1").value(null).build())

0 commit comments

Comments
 (0)