Refine core APIs

- Make interactive shell runner independent of JLine
- Introduce an interactive shell based on the JVM's system console
- Simplify input providing APIs
- Improve package cohesion
- Update Spring Boot support

Author: fmbenhassine

spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/CommandRegistryAutoConfiguration.java

@@ -46,21 +46,19 @@ public class CommandRegistryAutoConfiguration {
 
 	@Bean
 	@ConditionalOnMissingBean
-	CommandRegistry commandRegistry(ApplicationContext applicationContext) {
+	public CommandRegistry commandRegistry(ApplicationContext applicationContext) {
 		CommandRegistry commandRegistry = new CommandRegistry();
 		registerProgrammaticCommands(applicationContext, commandRegistry);
 		registerAnnotatedCommands(applicationContext, commandRegistry);
 		return commandRegistry;
 	}
 
-	private static void registerProgrammaticCommands(ApplicationContext applicationContext,
-			CommandRegistry commandRegistry) {
+	private void registerProgrammaticCommands(ApplicationContext applicationContext, CommandRegistry commandRegistry) {
 		Map<String, Command> commandBeans = applicationContext.getBeansOfType(Command.class);
 		commandBeans.values().forEach(commandRegistry::registerCommand);
 	}
 
-	private static void registerAnnotatedCommands(ApplicationContext applicationContext,
-			CommandRegistry commandRegistry) {
+	private void registerAnnotatedCommands(ApplicationContext applicationContext, CommandRegistry commandRegistry) {
 		Map<String, Object> springBootApps = applicationContext.getBeansWithAnnotation(SpringBootApplication.class);
 		Class<?> mainClass = AopUtils.getTargetClass(springBootApps.values().iterator().next());
 		String mainPackage = ClassUtils.getPackageName(mainClass);

spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/JLineShellAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2021 the original author or authors.
+ * Copyright 2017-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.
@@ -17,33 +17,147 @@
 package org.springframework.shell.boot;
 
 import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.regex.Pattern;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.jline.reader.Highlighter;
+import org.jline.reader.LineReader;
+import org.jline.reader.LineReaderBuilder;
 import org.jline.reader.Parser;
 import org.jline.reader.impl.history.DefaultHistory;
 import org.jline.terminal.Terminal;
 import org.jline.terminal.TerminalBuilder;
 import org.jline.terminal.TerminalBuilder.SystemOutput;
 import org.jline.utils.AttributedString;
+import org.jline.utils.AttributedStringBuilder;
 import org.jline.utils.AttributedStyle;
 
 import org.springframework.beans.factory.BeanCreationException;
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.event.ContextClosedEvent;
+import org.springframework.context.event.EventListener;
+import org.springframework.shell.core.command.Command;
+import org.springframework.shell.core.command.CommandRegistry;
+import org.springframework.shell.core.config.UserConfigPathProvider;
 import org.springframework.shell.core.jline.ExtendedDefaultParser;
 import org.springframework.shell.core.jline.PromptProvider;
+import org.springframework.util.StringUtils;
 
 /**
  * Shell implementation using JLine to capture input and trigger completions.
  *
  * @author Eric Bottard
  * @author Florent Biville
+ * @author Mahmoud Ben Hassine
  */
 @AutoConfiguration
+@EnableConfigurationProperties(SpringShellProperties.class)
+@ConditionalOnProperty(prefix = "spring.shell.interactive.type", name = "jline", havingValue = "true")
 public class JLineShellAutoConfiguration {
 
+	private final static Log log = LogFactory.getLog(JLineShellAutoConfiguration.class);
+
+	private Terminal terminal;
+
+	private Parser parser;
+
+	private CommandRegistry commandRegistry;
+
+	private org.jline.reader.History jLineHistory;
+
+	@Value("${spring.application.name:spring-shell}.log")
+	private String fallbackHistoryFileName = "spring-shell.log";
+
+	private SpringShellProperties springShellProperties;
+
+	private UserConfigPathProvider userConfigPathProvider;
+
+	public JLineShellAutoConfiguration(Terminal terminal, Parser parser, CommandRegistry commandRegistry,
+			org.jline.reader.History jLineHistory, SpringShellProperties springShellProperties,
+			UserConfigPathProvider userConfigPathProvider) {
+		this.terminal = terminal;
+		this.parser = parser;
+		this.commandRegistry = commandRegistry;
+		this.jLineHistory = jLineHistory;
+		this.springShellProperties = springShellProperties;
+		this.userConfigPathProvider = userConfigPathProvider;
+	}
+
+	@EventListener
+	public void onContextClosedEvent(ContextClosedEvent event) throws IOException {
+		jLineHistory.save();
+	}
+
+	@Bean
+	public LineReader lineReader() {
+		LineReaderBuilder lineReaderBuilder = LineReaderBuilder.builder()
+			.terminal(terminal)
+			.appName("Spring Shell")
+			.history(jLineHistory)
+			.highlighter(new Highlighter() {
+
+				@Override
+				public AttributedString highlight(LineReader reader, String buffer) {
+					int l = 0;
+					String best = null;
+					for (Command command : commandRegistry.getCommands()) {
+						if (buffer.startsWith(command.getName()) && command.getName().length() > l) {
+							l = command.getName().length();
+							best = command.getName();
+						}
+					}
+					if (best != null) {
+						return new AttributedStringBuilder(buffer.length()).append(best, AttributedStyle.BOLD)
+							.append(buffer.substring(l))
+							.toAttributedString();
+					}
+					else {
+						return new AttributedString(buffer, AttributedStyle.DEFAULT.foreground(AttributedStyle.RED));
+					}
+				}
+
+				@Override
+				public void setErrorPattern(Pattern errorPattern) {
+				}
+
+				@Override
+				public void setErrorIndex(int errorIndex) {
+				}
+			})
+			.parser(parser);
+
+		LineReader lineReader = lineReaderBuilder.build();
+		if (this.springShellProperties.getHistory().isEnabled()) {
+			// Discover history location
+			Path userConfigPath = this.userConfigPathProvider.provide();
+			log.debug("Resolved userConfigPath " + userConfigPath);
+			String historyFileName = this.springShellProperties.getHistory().getName();
+			if (!StringUtils.hasText(historyFileName)) {
+				historyFileName = fallbackHistoryFileName;
+			}
+			log.debug("Resolved historyFileName " + historyFileName);
+			String historyPath = userConfigPath.resolve(historyFileName).toAbsolutePath().toString();
+			log.debug("Resolved historyPath " + historyPath);
+			// set history file
+			lineReader.setVariable(LineReader.HISTORY_FILE, Paths.get(historyPath));
+		}
+		lineReader.unsetOpt(LineReader.Option.INSERT_TAB); // This allows completion on an
+		// empty buffer, rather than
+		// inserting a tab
+		jLineHistory.attach(lineReader);
+		return lineReader;
+	}
+
 	@Bean(destroyMethod = "close")
 	public Terminal terminal(ObjectProvider<TerminalCustomizer> customizers) {
 		try {