/*
* The MIT License
*
* Copyright 2014 Jesse Glick.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.jenkinsci.plugins.workflow.cps;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import javax.lang.model.SourceVersion;
import org.jenkinsci.plugins.workflow.steps.Step;
import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
import org.kohsuke.stapler.ClassDescriptor;
/**
* Takes a {@link Step} as configured through the UI and tries to produce equivalent Groovy code.
*/
class Snippetizer {
public static String object2Groovy(Object o) throws UnsupportedOperationException {
Class<? extends Object> clazz = o.getClass();
for (StepDescriptor d : StepDescriptor.all()) {
if (d.clazz.equals(clazz)) {
StringBuilder b = new StringBuilder(d.getFunctionName());
Step step = (Step) o;
Map<String,Object> args = new TreeMap<String,Object>(d.defineArguments(step));
args.values().removeAll(Collections.singleton(null)); // do not write null values
boolean first = true;
boolean singleMap = args.size() == 1 && args.values().iterator().next() instanceof Map;
for (Map.Entry<String,Object> entry : args.entrySet()) {
if (first) {
first = false;
if (d.takesImplicitBlockArgument() || singleMap) {
b.append('(');
} else {
b.append(' ');
}
} else {
b.append(", ");
}
String key = entry.getKey();
if (args.size() > 1 || !isDefaultKey(step, key)) {
b.append(key).append(": ");
}
render(b, entry.getValue());
}
if (d.takesImplicitBlockArgument()) {
if (!args.isEmpty()) {
b.append(')');
}
b.append(" {\n // some block\n}");
} else if (singleMap) {
b.append(')');
}
return b.toString();
}
}
throw new UnsupportedOperationException("Unknown step " + clazz);
}
private static boolean isDefaultKey(Step step, String key) {
String[] names = new ClassDescriptor(step.getClass()).loadConstructorParamNames();
return names.length == 1 && key.equals(names[0]);
}
static void render(StringBuilder b, Object value) {
if (value == null) {
b.append("null");
return;
}
Class<?> valueC = value.getClass();
if (valueC == String.class || valueC == Character.class) {
String text = String.valueOf(value);
if (text.contains("\n")) {
b.append("'''").append(text.replace("\\", "\\\\").replace("'", "\\'")).append("'''");
} else {
b.append('\'').append(text.replace("\\", "\\\\").replace("'", "\\'")).append('\'');
}
} else if (valueC == Boolean.class || valueC == Integer.class || valueC == Long.class) {
b.append(value);
} else if (value instanceof List) {
List<?> list = (List<?>) value;
b.append('[');
boolean first = true;
for (Object elt : list) {
if (first) {
first = false;
} else {
b.append(", ");
}
render(b, elt);
}
b.append(']');
} else if (value instanceof Map) {
Map<?,?> map = (Map) value;
b.append('[');
boolean first = true;
for (Map.Entry<?,?> entry : map.entrySet()) {
if (first) {
first = false;
} else {
b.append(", ");
}
Object key = entry.getKey();
if (key instanceof String && SourceVersion.isName((String) key)) {
b.append(key);
} else {
render(b, key);
}
b.append(": ");
render(b, entry.getValue());
}
b.append(']');
} else {
b.append("<object of type ").append(valueC.getCanonicalName()).append('>');
}
}
private Snippetizer() {}
}