[Eiffel] various enhancements (#8076)

* Updated Eiffel code generator.
	Added missing language reserved words.

Updated mustache templates to use the latest Eiffel rules to avoid obsolte
feature calls and Cat-Calls.
Updated Eiffel configuration files (ecf's)
Updated comments styles.
Updated Travis CI file to use the latest Eiffel compiler.
Updated EIffel sample to use https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml

* Added missing mapping decimal to REAL_64
Added Eiffel Kernel classes to importMapping to avoid generate models for
them.
Fixed issue with Eiffel feature name generation, updated toOperationId(String) method.
Simplified toInstantiationType method implementaetion.
Improved model.mustache to generate Eiffel models.

* Updated Eiffel sample.

* Removed unneeded tabs.

* Added AnyType mapping to ANY
Removed unneeded tab
Updated model name, remane models that starts with _.

* update doc

Co-authored-by: William Cheng <[email protected]>

Author: jvelilla

docs/generators/eiffel.md

@@ -15,6 +15,11 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 
 | Type/Alias | Imports |
 | ---------- | ------- |
+|File|FILE|
+|List|LIST|
+|Map|STRING_TABLE|
+|Set|SET|
+|file|FILE|
 
 
 ## INSTANTIATION TYPES
@@ -52,6 +57,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <li>and</li>
 <li>as</li>
 <li>assign</li>
+<li>attached</li>
 <li>attribute</li>
 <li>check</li>
 <li>class</li>
@@ -60,6 +66,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 <li>current</li>
 <li>debug</li>
 <li>deferred</li>
+<li>detachable</li>
 <li>do</li>
 <li>else</li>
 <li>elseif</li>

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractEiffelCodegen.java

@@ -48,8 +48,8 @@ public AbstractEiffelCodegen() {
 
         setReservedWordsLowerCase(Arrays.asList(
                 // language reserved words
-                "across", "agent", "alias", "all", "and", "as", "assign", "attribute", "check", "class", "convert",
-                "create", "Current", "debug", "deferred", "do", "else", "elseif", "end", "ensure", "expanded", "export",
+                "across", "agent", "alias", "all", "and", "as", "assign", "attached", "attribute", "check", "class", "convert",
+                "create", "Current", "debug", "deferred", "detachable", "do", "else", "elseif", "end", "ensure", "expanded", "export",
                 "external", "False", "feature", "from", "frozen", "if", "implies", "inherit", "inspect", "invariant",
                 "like", "local", "loop", "not", "note", "obsolete", "old", "once", "only", "or", "Precursor",
                 "redefine", "rename", "require", "rescue", "Result", "retry", "select", "separate", "then", "True",
@@ -68,6 +68,7 @@ public AbstractEiffelCodegen() {
         typeMapping.put("long", "INTEGER_64");
         typeMapping.put("number", "REAL_32");
         typeMapping.put("float", "REAL_32");
+        typeMapping.put("decimal", "REAL_64");
         typeMapping.put("double", "REAL_64");
         typeMapping.put("boolean", "BOOLEAN");
         typeMapping.put("string", "STRING_32");
@@ -85,10 +86,17 @@ public AbstractEiffelCodegen() {
         typeMapping.put("map", "STRING_TABLE");
         typeMapping.put("array", "LIST");
         typeMapping.put("list", "LIST");
+        typeMapping.put("AnyType", "ANY");
 
         instantiationTypes.put("array", "ARRAYED_LIST");
         instantiationTypes.put("list", "ARRAYED_LIST");
         instantiationTypes.put("map", "STRING_TABLE");
+        
+        importMapping.put("List", "LIST");
+        importMapping.put("Set", "SET");
+        importMapping.put("file", "FILE");
+        importMapping.put("File", "FILE");
+        importMapping.put("Map", "STRING_TABLE");
 
 
         cliOptions.clear();
@@ -167,6 +175,12 @@ public String toModelName(String name) {
 
     @Override
     public String toModelFilename(String name) {
+        // We need to check if import-mapping has a different model for this class, so we use it
+        // instead of the auto-generated one.
+        if (importMapping.containsKey(name)) {
+            return importMapping.get(name);
+        }
+
         if (!StringUtils.isEmpty(modelNamePrefix)) {
             name = modelNamePrefix + "_" + name;
         }
@@ -191,6 +205,13 @@ public String toModelFilename(String name) {
             name = "model_" + name; // e.g. 200Response => Model200Response
             // (after camelize)
         }
+        // model name starts with _
+        if (name.startsWith("_")) {
+            LOGGER.warn(name + " (model name starts with _) cannot be used as model name. Renamed to "
+                    + ("model" + name));
+            name = "model" + name; // e.g. 200Response => Model200Response
+            // (after camelize)
+        }
 
         return underscore(name);
     }
@@ -278,7 +299,7 @@ public String getTypeDeclaration(Schema p) {
         } else if (ModelUtils.isMapSchema(p)) {
             Schema inner = getAdditionalProperties(p);
 
-            return getSchemaType(p) + "[" + getTypeDeclaration(inner) + "]";
+            return getSchemaType(p) + " [" + getTypeDeclaration(inner) + "]";
         }
         // return super.getTypeDeclaration(p);
 
@@ -315,14 +336,26 @@ public String getSchemaType(Schema p) {
 
     @Override
     public String toOperationId(String operationId) {
-        String sanitizedOperationId = sanitizeName(operationId);
+        // throw exception if method name is empty
+        if (StringUtils.isEmpty(operationId)) {
+            throw new RuntimeException("Empty method/operation name (operationId) not allowed");
+        }
+
+        String sanitizedOperationId = camelize(sanitizeName(operationId), true);
 
         // method name cannot use reserved keyword, e.g. return
         if (isReservedWord(sanitizedOperationId)) {
             LOGGER.warn(operationId + " (reserved word) cannot be used as method name. Renamed to "
                     + camelize("call_" + operationId));
             sanitizedOperationId = "call_" + sanitizedOperationId;
         }
+        
+        // operationId starts with a number
+        if (operationId.matches("^\\d.*")) {
+            LOGGER.warn(operationId + " (starting with a number) cannot be used as method sname. Renamed to " + camelize("call_" + operationId), true);
+            sanitizedOperationId = camelize("call_" + sanitizedOperationId, true);
+        }
+
         // method name from updateSomething to update_Something.
         sanitizedOperationId = unCamelize(sanitizedOperationId);
 
@@ -537,22 +570,23 @@ public Map<String, String> createMapping(String key, String value) {
 
     @Override
     public String toInstantiationType(Schema p) {
-        if (ModelUtils.isMapSchema(p)) {
-            Schema additionalProperties2 = getAdditionalProperties(p);
-            String type = additionalProperties2.getType();
-            if (null == type) {
-                LOGGER.error("No Type defined for Additional Schema " + additionalProperties2 + "\n" //
-                        + "\tIn Schema: " + p);
-            }
-            String inner = toModelName(getSchemaType(additionalProperties2));
-            return instantiationTypes.get("map") + " [" + inner + "]";
-        } else if (ModelUtils.isArraySchema(p)) {
-            ArraySchema ap = (ArraySchema) p;
-            String inner = toModelName(getSchemaType(ap.getItems()));
-            return instantiationTypes.get("array") + " [" + inner + "]";
-        } else {
-            return null;
-        }
+        return getTypeDeclaration(p);
+//        if (ModelUtils.isMapSchema(p)) {
+//            Schema additionalProperties2 = getAdditionalProperties(p);
+//            String type = additionalProperties2.getType();
+//            if (null == type) {
+//                LOGGER.error("No Type defined for Additional Schema " + additionalProperties2 + "\n" //
+//                        + "\tIn Schema: " + p);
+//            }
+//            String inner = toModelName(getSchemaType(additionalProperties2));
+//            return instantiationTypes.get("map") + " [" + inner + "]";
+//        } else if (ModelUtils.isArraySchema(p)) {
+//            ArraySchema ap = (ArraySchema) p;
+//            String inner = toModelName(getSchemaType(ap.getItems()));
+//            return instantiationTypes.get("array") + " [" + inner + "]";
+//        } else {
+//            return null;
+//        }
     }
 
     public String unCamelize(String name) {

modules/openapi-generator/src/main/resources/Eiffel/api.mustache

@@ -59,11 +59,11 @@ feature -- API Access
 			end
 			{{/formParams}}
 
-			if attached {STRING} api_client.select_header_accept (<<{{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}}>>)  as l_accept then
+			if attached {STRING} api_client.select_header_accept ({ARRAY [STRING]}<<{{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}}>>)  as l_accept then
 				l_request.add_header(l_accept,"Accept");
 			end
-			l_request.add_header(api_client.select_header_content_type (<<{{#consumes}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/consumes}}>>),"Content-Type")
-			l_request.set_auth_names (<<{{#authMethods}}"{{name}}"{{^-last}}, {{/-last}}{{/authMethods}}>>)
+			l_request.add_header(api_client.select_header_content_type ({ARRAY [STRING]}<<{{#consumes}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/consumes}}>>),"Content-Type")
+			l_request.set_auth_names ({ARRAY [STRING]}<<{{#authMethods}}"{{name}}"{{^-last}}, {{/-last}}{{/authMethods}}>>)
 			l_response := api_client.call_api (l_path, "{{httpMethod}}", l_request, {{#returnType}}Void{{/returnType}}{{^returnType}}agent serializer{{/returnType}}, {{#returnType}}agent deserializer{{/returnType}}{{^returnType}}Void{{/returnType}})
 			{{#returnType}}	
 			if l_response.has_error then

modules/openapi-generator/src/main/resources/Eiffel/api_client.mustache

@@ -233,7 +233,8 @@ feature -- Query Parameter Helpers
 						-- dateTime	string	date-time	As defined by date-time - RFC3339
 					Result := date_time.date.debug_output
 				elseif attached {STRING_32} a_param as str_32 then
-					Result := str_32
+						-- TODO check if this is a good convertion.
+					Result := str_32.to_string_8
 				elseif attached {STRING_8} a_param as str_8 then
 					Result := str_8
 				else
@@ -420,18 +421,18 @@ feature -- HTTP client: call api
 			end
 		end
 
-	add_header_params (a_content_executor:HTTP_CLIENT_REQUEST_CONTEXT; a_header_params: STRING_TABLE [STRING])
+	add_header_params (a_content_executor:HTTP_CLIENT_REQUEST_CONTEXT; a_header_params: STRING_TABLE [READABLE_STRING_8])
 			-- Set header parameters `a_header_params' to the request context executor `a_content_executor', including default headers.
 		do
 				-- headers
 			across a_header_params as ic  loop
-				a_content_executor.add_header (ic.key.as_string_8, ic.item)
+				a_content_executor.add_header (ic.key.to_string_8, ic.item)
 			end
 
 				-- default headers
 			across default_header_map as ic  loop
 				if not a_header_params.has (ic.key) then
-					a_content_executor.add_header (ic.key.as_string_8, ic.item)
+					a_content_executor.add_header (ic.key.to_string_8, ic.item)
 				end
 			end
 		end
@@ -484,7 +485,7 @@ feature -- HTTP client: Change Element
 
 feature {NONE} -- Implementation
 
-	default_header_map: STRING_TABLE [STRING]
+	default_header_map: STRING_TABLE [READABLE_STRING_8]
 			-- default header map.
 
 	http_session: detachable HTTP_CLIENT_SESSION

modules/openapi-generator/src/main/resources/Eiffel/ecf.mustache

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<system xmlns="http://www.eiffel.com/developers/xml/configuration-1-16-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-16-0 http://www.eiffel.com/developers/xml/configuration-1-16-0.xsd" name="{{libraryTarget}}" uuid="{{uuid}}" library_target="{{libraryTarget}}">	
+<system xmlns="http://www.eiffel.com/developers/xml/configuration-1-21-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-21-0 http://www.eiffel.com/developers/xml/configuration-1-21-0.xsd" name="{{libraryTarget}}" uuid="{{uuid}}" library_target="{{libraryTarget}}">	
 	<target name="{{libraryTarget}}">
 		<root all_classes="true"/>
 		<file_rule>
@@ -8,17 +8,17 @@
 			<exclude>/CVS$</exclude>
 			<exclude>/EIFGENs$</exclude>
 		</file_rule>
-		<option warning="true">
+		<option warning="warning" manifest_array_type="mismatch_warning">
 			<assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/>
-		</option>
+		</option>		
 		<setting name="console_application" value="true"/>
 		<library name="base" location="$ISE_LIBRARY/library/base/base.ecf"/>
-		<library name="encoder" location="$ISE_LIBRARY\contrib\library\web\framework\ewf\text\encoder\encoder-safe.ecf"/>
-		<library name="json" location="$ISE_LIBRARY\contrib\library\text\parser\json\library\json-safe.ecf" readonly="false"/>
-		<library name="http" location="$ISE_LIBRARY\contrib\library\network\protocol\http\http-safe.ecf"/>
-		<library name="http_client" location="$ISE_LIBRARY\contrib\library\network\http_client\http_client-safe.ecf"/>
-		<library name="time" location="$ISE_LIBRARY\library\time\time-safe.ecf"/>
-		<library name="uri" location="$ISE_LIBRARY\library\text\uri\uri-safe.ecf"/>
+		<library name="encoder" location="$ISE_LIBRARY\contrib\library\web\framework\ewf\text\encoder\encoder.ecf"/>
+		<library name="json" location="$ISE_LIBRARY\contrib\library\text\parser\json\library\json.ecf" readonly="false"/>
+		<library name="http" location="$ISE_LIBRARY\contrib\library\network\protocol\http\http.ecf"/>
+		<library name="http_client" location="$ISE_LIBRARY\contrib\library\network\http_client\http_client.ecf"/>
+		<library name="time" location="$ISE_LIBRARY\library\time\time.ecf"/>
+		<library name="uri" location="$ISE_LIBRARY\library\text\uri\uri.ecf"/>
 		<library name="uuid" location="$ISE_LIBRARY\library\uuid\uuid.ecf"/>
 		<cluster name="client" location=".\src" recursive="true"/>
 	</target>

modules/openapi-generator/src/main/resources/Eiffel/framework/api_client_response.mustache

@@ -7,7 +7,7 @@ create
 
 feature {NONE} -- Initialization
 
-	make (a_response: detachable HTTP_CLIENT_RESPONSE; a_error: detachable API_ERROR; a_custom_deserializer: detachable FUNCTION [TUPLE [STRING, STRING, TYPE [detachable ANY]], detachable ANY])
+	make (a_response: detachable HTTP_CLIENT_RESPONSE; a_error: detachable API_ERROR; a_custom_deserializer: detachable FUNCTION [TUPLE [READABLE_STRING_8, READABLE_STRING_8, TYPE [detachable ANY]], detachable ANY])
 		do
 			response := a_response
 			error := a_error
@@ -23,6 +23,7 @@ feature -- Access
 		end
 
 	status: INTEGER
+			-- Status code of the response.
 		do
 			if attached response as l_response then
 				Result := l_response.status
@@ -32,7 +33,7 @@ feature -- Access
 feature -- Data
 
 	data (a_type: TYPE [detachable ANY]): detachable ANY
-			-- Data representation of the HTTP Response
+			-- Data representation of the HTTP Response.
 		do
 			if
 				attached response as l_response  and then
@@ -54,8 +55,7 @@ feature {NONE} -- Implementation
 	response: detachable HTTP_CLIENT_RESPONSE
 			-- Low level response returned by the API call.
 
-	deserializer: detachable FUNCTION [TUPLE [STRING, STRING, TYPE [detachable ANY]], detachable ANY]
-			-- function to map a response body with a given content type to the target
-			-- in the domain model.
+	deserializer: detachable FUNCTION [TUPLE [READABLE_STRING_8, READABLE_STRING_8, TYPE [detachable ANY]], detachable ANY]
+			-- Function to map a response body with a given content type to the target in the domain model.
 
 end

modules/openapi-generator/src/main/resources/Eiffel/framework/api_i.mustache

@@ -24,12 +24,12 @@ feature {NONE} -- Initialization
 feature -- Status Report
 
     last_error: detachable API_ERROR
-            -- last error if any from the API call.
+            -- Last error if any from the API call.
 
 feature -- Error
 
 	reset_error
-			-- reset `last_error' to void.
+			-- Reset `last_error' to void.
 		do
 			last_error := Void
 		end

modules/openapi-generator/src/main/resources/Eiffel/framework/auth/api_key_auth.mustache

@@ -45,7 +45,7 @@ feature -- Change Element
 
 feature -- Access
 
-   apply_to_params(a_query_params: LIST [TUPLE [name:STRING; value:STRING]]; a_header_params: STRING_TABLE [STRING])
+   apply_to_params(a_query_params: LIST [TUPLE [name:READABLE_STRING_8; value:READABLE_STRING_8]]; a_header_params: STRING_TABLE [READABLE_STRING_8])
    			-- <Precursor>.
    		local
    			l_value: STRING_32

modules/openapi-generator/src/main/resources/Eiffel/framework/auth/authentication.mustache

@@ -5,7 +5,7 @@ deferred class
 
 feature -- Access
 
-   apply_to_params(a_query_params: LIST [TUPLE [name:STRING; value:STRING]]; a_header_params: STRING_TABLE [STRING])
+   apply_to_params(a_query_params: LIST [TUPLE [name:READABLE_STRING_8; value:READABLE_STRING_8]]; a_header_params: STRING_TABLE [READABLE_STRING_8])
    			-- Apply authentication settings to header and query params.
    			-- `a_query_params' List of query parameters.
    			-- `a_header_params' Map of header parameters.

modules/openapi-generator/src/main/resources/Eiffel/framework/auth/http_basic_auth.mustache

@@ -10,10 +10,10 @@ inherit
 feature -- Access
 
 	user_name: detachable STRING_32
-			-- user name.
+			-- User name.
 
 	password: detachable STRING_32
-			-- password.
+			-- Password.
 
 feature -- Element Change	
 
@@ -35,14 +35,15 @@ feature -- Element Change
 
 feature -- Access
 
-	apply_to_params(a_query_params: LIST [TUPLE [name:STRING; value:STRING]]; a_header_params: STRING_TABLE [STRING])
+	apply_to_params(a_query_params: LIST [TUPLE [name:READABLE_STRING_8; value:READABLE_STRING_8]]; a_header_params: STRING_TABLE [READABLE_STRING_8])
    			-- <Precursor>.
 		do
 			if
 				attached user_name as l_username and then
 				attached password as l_password
 			then
-				a_header_params.force ("Basic " + (create {BASE64}).encoded_string (l_username + ":" + l_password) , "Authorization")
+					-- TODO check if this convertion it's ok.
+				a_header_params.force ("Basic " + (create {BASE64}).encoded_string (l_username.to_string_8 + ":" + l_password.to_string_8) , "Authorization")
 			end
    		end