org.springframework.shell.boot.ComponentFlowAutoConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022 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.boot;

import org.jline.terminal.Terminal;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Scope;
import org.springframework.core.annotation.Order;
import org.springframework.core.io.ResourceLoader;
import org.springframework.shell.component.flow.ComponentFlow;
import org.springframework.shell.component.flow.ComponentFlow.Builder;
import org.springframework.shell.style.TemplateExecutor;

/**
 * {@link EnableAutoConfiguration Auto-configuration} for {@link ComponentFlow}.
 *
 * @author Janne Valkealahti
 */
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ComponentFlow.class)
public class ComponentFlowAutoConfiguration {

	@Bean
	@Scope("prototype")
	@ConditionalOnMissingBean
	public ComponentFlow.Builder componentFlowBuilder(ObjectProvider customizerProvider) {
		ComponentFlow.Builder builder = ComponentFlow.builder();
		customizerProvider.orderedStream().forEach((customizer) -> customizer.customize(builder));
		return builder;
	}

	@Configuration(proxyBeanMethods = false)
	protected static class ComponentFlowConfiguration {

		@Bean
		@ConditionalOnMissingBean
		@Order(0)
		public ComponentFlowCustomizer shellCommonComponentFlowCustomizer(ObjectProvider terminal,
				ObjectProvider resourceLoader, ObjectProvider templateExecutor) {
			return new CommonComponentFlowCustomizer(terminal, resourceLoader, templateExecutor);
		}

	}

	private static class CommonComponentFlowCustomizer implements ComponentFlowCustomizer {

		private final ObjectProvider terminal;
		private final ObjectProvider resourceLoader;
		private final ObjectProvider templateExecutor;

		CommonComponentFlowCustomizer(ObjectProvider terminal, ObjectProvider resourceLoader,
				ObjectProvider templateExecutor) {
			this.terminal = terminal;
			this.resourceLoader = resourceLoader;
			this.templateExecutor = templateExecutor;
		}

		@Override
		public void customize(Builder componentFlowBuilder) {
			terminal.ifAvailable(dep -> componentFlowBuilder.terminal(dep));
			resourceLoader.ifAvailable(dep -> componentFlowBuilder.resourceLoader(dep));
			templateExecutor.ifAvailable(dep -> componentFlowBuilder.templateExecutor(dep));
		}
	}
}