#227 - add dynamic code templates for named schema properties + tests

RepreZen · Oct 2, 2017 · 2ee8900 · 2ee8900
1 parent fd8c537
commit 2ee8900
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 9 deletions.
diff --git a/com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/validation/SwaggerError.java b/com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/validation/SwaggerError.java
@@ -63,6 +63,11 @@ public int getLevel() {
     public int getLine() {
         return line;
     }
+
+    @Override
+    public java.lang.String toString() {
+        return getMessage();
+    }
 
     String getIndentedMessage() {
         final StringBuilder builder = new StringBuilder();

diff --git a/com.reprezen.swagedit.openapi3.tests/resources/code-assist/code-templates/SchemaObject.yaml b/com.reprezen.swagedit.openapi3.tests/resources/code-assist/code-templates/SchemaObject.yaml
@@ -40,6 +40,15 @@ components:
           type: integer
           format: int32
           minimum: 0    
+
+    SchemaWithProperties:
+      type: object
+      required:
+      - name
+      properties:
+        name:
+          type: string
+        #KZOE-template name="named schema in a property", value="properties"
 
     StringToModelMappingObject:
       type: object

diff --git a/...gedit.openapi3.tests/src/com/reprezen/swagedit/openapi3/validation/ValidationHelper.xtend b/...gedit.openapi3.tests/src/com/reprezen/swagedit/openapi3/validation/ValidationHelper.xtend
@@ -23,7 +23,7 @@ class ValidationHelper {
 		val JsonNode schemaAsJson = getSchema().asJson()
 		val ErrorProcessor processor = new ErrorProcessor(null, null) {
 			override protected Set<SwaggerError> fromNode(JsonNode error, int indent) {
-				fail('''JSON Schema validation error: «error.asText()»''')
+				fail('''JSON Schema validation error: «super.fromNode(error, indent)»''')
 				return super.fromNode(error, indent)
 			}
 		}

diff --git a/com.reprezen.swagedit.openapi3/resources/templates.xml b/com.reprezen.swagedit.openapi3/resources/templates.xml
@@ -331,6 +331,14 @@ properties:
   properties:
     ${name}:
       type: string</template>          
+
+ 	<template name="$ref property" 
+       id="com.reprezen.swagedit.openapi3.templates.properties.ref" 
+       description="Property with a schema $ref template" 
+       context="com.reprezen.swagedit.openapi3.templates.properties" 
+       enabled="true">propertyName:
+  $$ref: "#/components/schemas/${schema}"</template>
+
 <!--
 	CALLBACKS 
  -->
@@ -378,5 +386,4 @@ properties:
           'text/html':
             schema:
               $$ref: '${errorModel}'</template>            
-
 </templates>
diff --git a/com.reprezen.swagedit.openapi3/src/com/reprezen/swagedit/openapi3/Activator.java b/com.reprezen.swagedit.openapi3/src/com/reprezen/swagedit/openapi3/Activator.java
@@ -101,27 +101,39 @@ public TemplateStore getTemplateStore() {
             } catch (IOException e) {
                 YEditLog.logException(e);
             }
-            addNamedSchemaTemplates();
+            addNamedSchemaTemplatesInSchemas();
+            addNamedSchemaTemplatesInSchemaProperties();
         }
         return templateStore;
     }
 
-    private void addNamedSchemaTemplates() {
-        Template[] schemaTemplates = templateStore.getTemplates("com.reprezen.swagedit.openapi3.templates.schema");
+    private void addNamedSchemaTemplatesInSchemas() {
+        addNamedTemplates("com.reprezen.swagedit.openapi3.templates.schema",
+                "com.reprezen.swagedit.openapi3.templates.schemas", "schema");
+    }
+
+    private void addNamedSchemaTemplatesInSchemaProperties() {
+        addNamedTemplates("com.reprezen.swagedit.openapi3.templates.schema",
+                "com.reprezen.swagedit.openapi3.templates.properties", "property");
+    }
+
+    private void addNamedTemplates(String inlineContextId, String namedContextId, String key) {
+        Template[] schemaTemplates = templateStore.getTemplates(inlineContextId);
         for (int i = 0; i < schemaTemplates.length; i++) {
             Template schemaTemplate = schemaTemplates[i];
-            Template template = createNamedTemplate(schemaTemplate, "com.reprezen.swagedit.openapi3.templates.schemas");
+            Template template = createNamedTemplate(schemaTemplate, namedContextId, key);
             templateStore.add(new TemplatePersistenceData(template, true));
         }
     }
 
-    private Template createNamedTemplate(Template inlineTemplate, String newTemplateId) {
+    private Template createNamedTemplate(Template inlineTemplate, String newTemplateId, String key) {
         String indent = Strings.repeat(" ", getTabWidth());
         String newPattern = inlineTemplate.getPattern().replaceAll("\n", "\n" + indent);
+        String pattern = String.format("${%s_name}:\n%s%s", key, indent, newPattern);
         Template template = new Template(inlineTemplate.getName(), //
                 inlineTemplate.getDescription(), //
                 newTemplateId, //
-                "${schemaName}:\n" + indent + newPattern, //
+                pattern, //
                 inlineTemplate.isAutoInsertable());
         return template;
     }

diff --git a/...it.openapi3/src/com/reprezen/swagedit/openapi3/templates/OpenApi3ContextTypeProvider.java b/...it.openapi3/src/com/reprezen/swagedit/openapi3/templates/OpenApi3ContextTypeProvider.java
@@ -84,7 +84,10 @@ private SchemaBasedTemplateContextType createOpenApi3TemplateContextType(String
             createOpenApi3TemplateContextType("securityScheme", "/definitions/securityScheme"),
             createOpenApi3TemplateContextType("header", "/definitions/header"),
             // Other
-            createOpenApi3TemplateContextType("mediaTypes", "/definitions/mediaTypes"));
+            createOpenApi3TemplateContextType("mediaTypes", "/definitions/mediaTypes"),
+            createOpenApi3TemplateContextType("properties", "/definitions/schema/properties/type",
+                    "/definitions/schema/properties/properties")//
+    );
 
     public List<TemplateContextType> allContextTypes() {
         return allContextTypes;