#227 Better code completion proposal for name/key of additional properties

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/JsonProposalProvider.java

@@ -195,10 +195,17 @@ protected Collection<Proposal> createObjectProposals(ObjectTypeDefinition type,
             }
         }
 
+        if (type.getAdditionalProperties() != null) {
+            String elementTitle = type.getLabel();
+            String elementName = elementTitle != null? elementTitle : type.getAdditionalProperties().getLabel();
+            if (elementName != null) {
+                elementName = String.format("(%s name)", elementName);
+                proposals.add(new Proposal(elementName + ":", elementName, null, null, elementName));
+            }
+        }
         if (proposals.isEmpty()) {
             proposals.add(new Proposal("_key_" + ":", "_key_", null, null));
         }
-
         return proposals;
     }
 

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/Proposal.java

@@ -30,6 +30,7 @@ public class Proposal {
     public final String displayString;
     public final String type;
     public final String description;
+    private final String selection;
 
     protected final Styler typeStyler = new StyledString.Styler() {
         @Override
@@ -38,11 +39,16 @@ public void applyStyles(TextStyle textStyle) {
         }
     };
 
-    public Proposal(String replacementString, String displayString, String description, String type) {
+    public Proposal(String replacementString, String displayString, String description, String type, String selection) {
         this.replacementString = replacementString;
         this.displayString = displayString;
         this.type = type;
         this.description = description;
+        this.selection = selection;
+    }
+
+    public Proposal(String replacementString, String displayString, String description, String type) {
+        this(replacementString, displayString, description, type, "");
     }
 
     /**
@@ -93,9 +99,10 @@ public StyledCompletionProposal asStyledCompletionProposal(String prefix, int of
 
         StyledCompletionProposal proposal = null;
         if (Strings.emptyToNull(prefix) == null) {
-            proposal = new StyledCompletionProposal(replacementString, styledString, null, description, offset);
+            proposal = new StyledCompletionProposal(replacementString, styledString, null, description, offset,
+                    selection);
         } else if (rString.toLowerCase().contains(prefix.toLowerCase())) {
-            proposal = new StyledCompletionProposal(rString, styledString, prefix, description, offset);
+            proposal = new StyledCompletionProposal(rString, styledString, prefix, description, offset, selection);
         }
 
         return proposal;

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/StyledCompletionProposal.java

@@ -34,11 +34,13 @@ public class StyledCompletionProposal
     private final String description;
     /** Lower-cased prefix - content assist typeahead should be case-insensitive */
     private final String prefix;
+    private final String selection;
 
     public StyledCompletionProposal(String replacement, StyledString label, String prefix, String description,
-            int offset) {
+            int offset, String selection) {
         this.label = label;
         this.replacementString = replacement;
+        this.selection = selection == null ? "" : selection;
         this.prefix = prefix != null ? prefix.toLowerCase() : null;
         this.replacementOffset = offset;
         this.description = description;
@@ -82,10 +84,9 @@ public Point getSelection(IDocument document) {
                 offset = replacementOffset - prefix.length();
             }
         }
-
-        int cursorPosition = offset + replacementString.length();
-
-        return new Point(cursorPosition, 0);
+        int replacementIndex = !"".equals(selection) ? replacementString.indexOf(selection) : -1;
+        int selectionStart = offset + (replacementIndex < 0 ? replacementString.length() : replacementIndex);
+        return new Point(selectionStart, selection.length());
     }
 
     @Override

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/assist/contexts/ComponentContextType.java

@@ -13,8 +13,8 @@
 import java.util.Collection;
 
 import com.fasterxml.jackson.core.JsonPointer;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.reprezen.swagedit.core.json.references.JsonReference;
 import com.reprezen.swagedit.core.model.AbstractNode;
 import com.reprezen.swagedit.core.model.Model;
 import com.reprezen.swagedit.core.schema.ComplexTypeDefinition;
@@ -23,13 +23,13 @@
 
 public class ComponentContextType extends ContextType {
 
-    private final ObjectNode componentRef;
-    
+    private final String componentRef;
+
     public ComponentContextType(String value, String label, String componentSchemaPath) {
         super(value, label);
-        componentRef = new ObjectMapper().createObjectNode().put("$ref", "#/definitions/" + componentSchemaPath);
+        componentRef = "#/definitions/" + componentSchemaPath;
     }
-    
+
     protected String getReferencePointerString() {
         return "/definitions/reference/properties/$ref";
     }
@@ -73,12 +73,17 @@ protected boolean isReferenceToComponent(Model model, JsonPointer pointer) {
         if (parentType instanceof ComplexTypeDefinition) {
             Collection<TypeDefinition> types = ((ComplexTypeDefinition) parentType).getComplexTypes();
             for (TypeDefinition type : types) {
-                if (componentRef.equals(type.getContent())) {
+                if (hasRefToComponent(type.getContent())) {
                     return true;
                 }
             }
         }
-        return componentRef.equals(parentType.getContent());
+        return hasRefToComponent(parentType.getContent());
+    }
+
+    private boolean hasRefToComponent(JsonNode content) {
+        return content.hasNonNull(JsonReference.PROPERTY)
+                && componentRef.equals(content.get(JsonReference.PROPERTY).asText());
     }
 
 }

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/preferences/KaiZenPreferencesUtils.java

@@ -0,0 +1,21 @@
+/*******************************************************************************
+ * Copyright (c) 2016 ModelSolv, Inc. and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    ModelSolv, Inc. - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package com.reprezen.swagedit.core.preferences;
+
+import org.dadacoalition.yedit.preferences.PreferenceConstants;
+import org.eclipse.jface.preference.IPreferenceStore;
+
+public class KaiZenPreferencesUtils {
+    public static int getTabWidth() {
+        IPreferenceStore prefs = org.dadacoalition.yedit.Activator.getDefault().getPreferenceStore();
+        return prefs.getInt(PreferenceConstants.SPACES_PER_TAB);
+    }
+}

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/quickfix/QuickFixer.java

@@ -10,13 +10,13 @@
  *******************************************************************************/
 package com.reprezen.swagedit.core.quickfix;
 
+import static com.reprezen.swagedit.core.preferences.KaiZenPreferencesUtils.getTabWidth;
+
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.dadacoalition.yedit.preferences.PreferenceConstants;
 import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.runtime.CoreException;
-import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.text.BadLocationException;
 import org.eclipse.jface.text.IDocument;
 import org.eclipse.jface.text.IRegion;
@@ -83,10 +83,6 @@ protected String getIndent(IDocument document, int line) throws BadLocationExcep
             return definitionIndent + Strings.repeat(" ", getTabWidth());
         }
 
-        private int getTabWidth() {
-            IPreferenceStore prefs = org.dadacoalition.yedit.Activator.getDefault().getPreferenceStore();
-            return prefs.getInt(PreferenceConstants.SPACES_PER_TAB);
-        }
     }
 
 }

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/ComplexTypeDefinition.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.core.JsonPointer;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.google.common.collect.Iterables;
 import com.reprezen.swagedit.core.model.AbstractNode;
 
 /**
@@ -139,4 +140,9 @@ public boolean validate(AbstractNode valueNode) {
 
         return isValid;
     }
+
+    @Override
+    public String getLabel() {
+        return Iterables.getFirst(complexTypes, null).getLabel();
+    }
 }

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/CompositeSchema.java

@@ -138,7 +138,7 @@ protected String baseURI(String href) {
         return href.startsWith("#") ? null : href.split("#")[0];
     }
 
-    protected JsonPointer pointer(String href) {
+    public static JsonPointer pointer(String href) {
         if (href.startsWith("#")) {
             return JsonPointer.compile(href.substring(1));
         } else if (href.startsWith("/")) {

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/JsonSchemaUtils.java

@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * Copyright (c) 2017 ModelSolv, Inc. and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *    ModelSolv, Inc. - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package com.reprezen.swagedit.core.schema;
+
+import static com.google.common.collect.Iterators.transform;
+
+import java.util.Iterator;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.google.common.base.Function;
+import com.google.common.base.Joiner;
+
+public class JsonSchemaUtils {
+    public static String getHumanFriendlyText(JsonNode swaggerSchemaNode, final String defaultValue) {
+        String schemaTitle = getSchemaTitle(swaggerSchemaNode);
+        if (schemaTitle != null) {
+            return schemaTitle;
+        }
+        // nested array
+        if (swaggerSchemaNode.get("items") != null) {
+            return getHumanFriendlyText(swaggerSchemaNode.get("items"), defaultValue);
+        }
+        // "$ref":"#/definitions/headerParameterSubSchema"
+        JsonNode ref = swaggerSchemaNode.get("$ref");
+        if (ref != null) {
+            return getLabelForRef(ref.asText());
+        }
+        // Auxiliary oneOf in "oneOf": [ { "$ref": "#/definitions/securityRequirement" }]
+        JsonNode oneOf = swaggerSchemaNode.get("oneOf");
+        if (oneOf != null) {
+            if (oneOf instanceof ArrayNode) {
+                ArrayNode arrayNode = (ArrayNode) oneOf;
+                if (arrayNode.size() > 0) {
+                    Iterator<String> labels = transform(arrayNode.elements(), new Function<JsonNode, String>() {
+
+                        @Override
+                        public String apply(JsonNode el) {
+                            return getHumanFriendlyText(el, defaultValue);
+                        }
+                    });
+                    return "[" + Joiner.on(", ").join(labels) + "]";
+                }
+            }
+        }
+        return defaultValue;
+    }
+
+    public static String getSchemaTitle(JsonNode swaggerSchemaNode) {
+        JsonNode title = swaggerSchemaNode.get("title");
+        if (title != null) {
+            return title.asText();
+        }
+        return null;
+    }
+
+    public static String getLabelForRef(String refValue) {
+        return refValue.substring(refValue.lastIndexOf("/") + 1);
+    }
+}

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/ReferenceTypeDefinition.java

@@ -68,4 +68,18 @@ public TypeDefinition getPropertyType(String property) {
     public boolean validate(AbstractNode valueNode) {
         return resolve().validate(valueNode);
     }
+
+    @Override
+    public String getLabel() {
+        String label = JsonSchemaUtils.getSchemaTitle(content);
+        if (label != null) {
+            return label;
+        }
+        // $ref=schemaOrReference
+        if (resolve() instanceof ComplexTypeDefinition) {
+            return resolve().getLabel();
+        }
+        // $ref=schema
+        return JsonSchemaUtils.getLabelForRef(content.get(JsonReference.PROPERTY).asText());
+    }
 }

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/TypeDefinition.java

@@ -73,6 +73,21 @@ public String getDescription() {
         }
         return content.get("description").asText();
     }
+
+    /**
+     * Human-friendly label which can be used in GUI.
+     * It does not intent to provide complete information about a type, 
+     * just a concise label.</br>
+     * Subclasses are welcome to override this method.
+     * </br>
+     * Can return null.
+     */
+    public String getLabel() {
+        if (content == null) {
+            return null;
+        }
+        return JsonSchemaUtils.getHumanFriendlyText(content, null);
+    }
 
     @Override
     public String toString() {

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/templates/ElementNameResolver.java

@@ -0,0 +1,42 @@
+/*******************************************************************************
+ *  Copyright (c) 2016 ModelSolv, Inc. and others.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *  
+ *  Contributors:
+ *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+package com.reprezen.swagedit.core.templates;
+
+import java.util.List;
+
+import org.eclipse.jface.text.templates.TemplateContext;
+import org.eclipse.jface.text.templates.TemplateVariable;
+import org.eclipse.jface.text.templates.TemplateVariableResolver;
+
+/**
+ * Standard code template variables can only define values that are valid variables, e.g. no space allowed. </br>
+ * This template variable resolver provides a way to create and select names with special characters (whitespaces, '(', ')') in code templates. For
+ * example, `${element_name:element_name('(schema name)')}` creates `(schema name)` and selects it for editing.
+ *
+ */
+public class ElementNameResolver extends TemplateVariableResolver {
+    public ElementNameResolver() {
+        super("element_name", "Provides human-friendly element name and selects it");
+    }
+
+    @Override
+    public void resolve(TemplateVariable variable, TemplateContext context) {
+        List params = variable.getVariableType().getParams();
+        String[] bindings = new String[params.size()];
+        for (int i = 0; i < params.size(); i++) {
+            bindings[i] = params.get(i).toString();
+        }
+        if (bindings.length != 0)
+            variable.setValues(bindings);
+        variable.setResolved(true);
+    }
+
+}

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/templates/SchemaBasedTemplateContextType.java

@@ -65,6 +65,7 @@ private void addGlobalResolvers() {
         addResolver(new GlobalTemplateVariables.Year());
         addResolver(new GlobalTemplateVariables.Time());
         addResolver(new GlobalTemplateVariables.User());
+        addResolver(new ElementNameResolver());
     }
 
 }