org.grails.cli.profile.commands.DefaultMultiStepCommand.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grace-shell Show documentation
Grace Framework : Grace Shell
There is a newer version: 2023.1.0-RC1
/*
 * Copyright 2014-2024 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.grails.cli.profile.commands

import groovy.transform.CompileDynamic
import jline.console.completer.Completer

import grails.build.logging.GrailsConsole

import org.grails.cli.profile.AbstractStep
import org.grails.cli.profile.CommandDescription
import org.grails.cli.profile.MultiStepCommand
import org.grails.cli.profile.Profile
import org.grails.cli.profile.Step
import org.grails.cli.profile.steps.StepRegistry

/**
 * Simple implementation of the {@link MultiStepCommand} abstract class that parses commands defined in YAML or JSON
 *
 * @author Lari Hotari
 * @author Graeme Rocher
 * @author Michael Yan
 * @since 3.0
 */
class DefaultMultiStepCommand extends MultiStepCommand {

    private final Map data
    private List steps

    final CommandDescription description

    DefaultMultiStepCommand(String name, Profile profile, Map data) {
        super(name, profile)
        this.data = data
        this.visible = data?.visible?.toString() != 'false'
        this.deprecated = data?.deprecated?.toString() == 'true'

        def description = data?.description
        if (description instanceof List) {
            List descList = (List) description
            if (descList) {
                this.description = new CommandDescription(name: name, description: descList.get(0).toString(), usage: data?.usage)

                if (descList.size() > 1) {
                    for (arg in descList[1..-1]) {
                        if (arg instanceof Map) {
                            Map map = (Map) arg
                            if (map.containsKey('usage')) {
                                this.description.usage = map.get('usage')?.toString()
                            }
                            else if (map.containsKey('completer')) {
                                def completerClass = map.get('completer')
                                if (completerClass) {
                                    try {
                                        this.description.completer = (Completer) Thread.currentThread().contextClassLoader
                                                .loadClass(completerClass.toString()).newInstance()
                                    }
                                    catch (ignored) {
                                    }
                                }
                            }
                            else {
                                handleArgumentOrFlag(map, 'argument')
                                handleArgumentOrFlag(map, 'flag')
                            }
                        }
                    }
                }
            }
        }
        else {
            this.description = new CommandDescription(name: name, description: description.toString(), usage: data?.usage)
        }
    }

    @CompileDynamic
    boolean handleArgumentOrFlag(Map map, String name) {
        try {
            if (map.containsKey(name)) {
                def argName = map.remove(name)
                map.put('name', argName)
                this.description."$name"(map)
                return true
            }
        }
        catch (Throwable e) {
            GrailsConsole.getInstance().error("Invalid $name found in [$profile.name] profile ${map}: ${e.message}", e)
        }
        false
    }

    List getSteps() {
        if (steps == null) {
            steps = []
            data.steps?.each {
                Map stepParameters = it.collectEntries { k, v -> [k as String, v] }
                AbstractStep step = createStep(stepParameters)
                if (step != null) {
                    steps.add(step)
                }
            }
        }
        steps
    }

    protected AbstractStep createStep(Map stepParameters) {
        StepRegistry.getStep(stepParameters.command?.toString(), this, stepParameters)
    }

}