fixes per review comments

Author: Kostiantyn Sologubov

third_party.md

@@ -1,6 +1,6 @@
 ### Introduction
 
-This file is broken into three Parts: SDL Base, SDL Android, and SDL Java. SDL Android and SDL Java are sub projects of SDL Base. Additionally, SDL Java contains two sub-projects: SDL JavaSE and SDL JavaEE.
+This file is broken into four Parts: SDL Base, SDL Android, SDL Java and Utils/Generator. SDL Android and SDL Java are sub projects of SDL Base. Additionally, SDL Java contains two sub-projects: SDL JavaSE and SDL JavaEE. Utils/Generator is Proxy Library RPC Generator for SDL BASE.
 
 ## SDL BASE
 
@@ -86,4 +86,43 @@ The third party software included and used by this project is:
 SDL JavaEE inherits any license defined in SDL JavaSE.
 
 
+## Utils
+
+### Generator
+
+Proxy Library RPC Generator inherits any license defined in SDL BASE.
+
+#### Third Party Licenses
+
+Both the source and binary distributions of this software contain
+some third party software. All the third party software included
+or linked is redistributed under the terms and conditions of their 
+original licenses.
+
+The third party software included and used by this project is:
+
+**xmlschema**
+
+* Licensed under MIT License
+* See [https://pypi.org/project/xmlschema/](https://pypi.org/project/xmlschema/)
+
+**Jinja2**
+
+* Licensed under BSD License (BSD-3-Clause)
+* See [https://pypi.org/project/Jinja2/](https://pypi.org/project/Jinja2/)
+
+**coverage**
+
+* Licensed under Apache Software License (Apache 2.0)
+* See [https://pypi.org/project/coverage/](https://pypi.org/project/coverage/)
+
+**pathlib2**
+
+* Licensed under MIT License
+* See [https://pypi.org/project/pathlib2/](https://pypi.org/project/pathlib2/)
+
+**pylint**
+
+* Licensed under GNU General Public License (GPL)
+* See [https://pypi.org/project/pylint/](https://pypi.org/project/pylint/)
 

utils/generator/generator.py

@@ -280,9 +280,9 @@ def write_file(self, file_name, template, data):
         """
         Calling producer/transformer instance to transform initial Model to dict used in jinja2 templates.
         Applying transformed dict to jinja2 templates and writing to appropriate file
-        :param file_name: output js file
+        :param file_name: output java file
         :param template: name of template
-        :param data: transformed moder ready for apply to Jinja2 template
+        :param data: transformed model ready for apply to Jinja2 template
         """
         file_name.parents[0].mkdir(parents=True, exist_ok=True)
         try:

utils/generator/templates/enum_template.java

@@ -24,6 +24,8 @@ public enum {{class_name}} {
     {%- endif %}
     {%- if kind == "simple" %}
     {{param.name}}{{ "," if not loop.last }}
+    {%- elif kind == "complex" %}
+    {{param.name}}({{param.value}}){{ "," if not loop.last }}
     {%- elif kind == "custom" %}
     {{param.name}}({{param.internal}}){{ "," if not loop.last }}
     {%- endif %}
@@ -44,11 +46,14 @@ public enum {{class_name}} {
             return null;
         }
     }
-    {%- elif kind == "custom" %}
+    {%- elif kind == "complex" or kind == "custom" %}
     {%- if return_type == "String" %}
 
     private final String INTERNAL_NAME;
 
+    /**
+     * Private constructor
+     */
     private {{class_name}}(String internalName) {
         this.INTERNAL_NAME = internalName;
     }
@@ -72,20 +77,32 @@ public enum {{class_name}} {
         return null;
     }
 
+    /**
+     * Return String value of element
+     *
+     * @return String
+     */
     @Override
     public String toString() {
         return INTERNAL_NAME;
     }
     {%- elif return_type == "int" %}
 
     private final int VALUE;
+
     /**
      * Private constructor
      */
     private {{class_name}} (int value) {
         this.VALUE = value;
     }
 
+    /**
+     * Convert int to {{class_name}}
+     *
+     * @param value int
+     * @return {{class_name}}
+     */
     public static {{class_name}} valueForInt(int value) {
         for ({{class_name}} anEnum : EnumSet.allOf({{class_name}}.class)) {
             if (anEnum.getValue() == value) {
@@ -95,28 +112,14 @@ public String toString() {
         return null;
     }
 
+    /**
+     * Return value of element
+     *
+     * @return int
+     */
     public int getValue(){
         return VALUE;
     }
-    {%- elif return_type == "bool" %}
-
-    boolean IS_QUERYABLE;
-
-    {{class_name}}(boolean isQueryable) {
-        this.IS_QUERYABLE = isQueryable;
-    }
-
-    public boolean isQueryable() {
-        return IS_QUERYABLE;
-    }
-
-    public static {{class_name}} valueForString(String value) {
-        try {
-            return valueOf(value);
-        } catch (Exception e) {
-            return null;
-        }
-    }
     {%- endif %}
     {%- endif %}
 }

utils/generator/templates/function_template.java

@@ -12,7 +12,7 @@
      * Constructs a new {{class_name}} object
      *
      * @param success    whether the request is successfully processed
-     * @param resultCode whether the request is successfully processed
+     * @param resultCode result code of processed request
      */
     public {{class_name}}(@NonNull Boolean success, @NonNull Result resultCode) {
         this();

utils/generator/templates/javadoc_return.java

@@ -1,4 +1,3 @@
-     {%- if p.param_doc is not defined %}
      {%- if p.description is defined %}
      {%- for d in p.description %}
      {%- if loop.index == 1 -%}
@@ -9,15 +8,6 @@
      {%- else %}
      * @return {{p.last}}
      {%- endif -%}
-     {%- else -%}
-     {%- set l = p.last|length + 8 -%}
-     * {% for v in p.param_doc -%}
-     {%- if loop.index == 1 -%}
-     @return {{p.last}} {{v}}
-     {%- else -%}
-     * {{v|indent(l,True)}}
-     {%- endif -%}{% endfor -%}
-     {%- endif -%}
      {%- if p.since is defined %}
      * @since SmartDeviceLink {{p.since}}
      {%- endif %}

utils/generator/templates/javadoc_template.java

@@ -1,4 +1,3 @@
-     {%- if p.param_doc is not defined %}
      {%- if p.description is defined %}
      {%- for d in p.description %}
      {%- if loop.index == 1 -%}
@@ -9,15 +8,6 @@
      {%- else %}
      * @param {{p.last}}
      {%- endif -%}
-     {%- else -%}
-     {%- set l = p.last|length + 8 -%}
-     * {% for v in p.param_doc -%}
-     {%- if loop.index == 1 -%}
-     @param {{p.last}} {{v}}
-     {%- else -%}
-     * {{v|indent(l,True)}}
-     {%- endif -%}{% endfor -%}
-     {%- endif -%}
      {%- if p.since is defined %}
      * @since SmartDeviceLink {{p.since}}
      {%- endif %}

utils/generator/transformers/common_producer.py

@@ -20,17 +20,13 @@ class InterfaceProducerCommon(ABC):
     version = '1.0.0'
 
     def __init__(self, container_name, enums_package, structs_package, package_name,
-                 enum_names=(), struct_names=(), mapping=None, all_mapping=None):
-        if all_mapping is None:
-            all_mapping = OrderedDict()
+                 enum_names=(), struct_names=()):
         self.logger = logging.getLogger('Generator.InterfaceProducerCommon')
         self.container_name = container_name
         self.enum_names = enum_names
         self.struct_names = struct_names
         self.enums_package = enums_package
         self.structs_package = structs_package
-        self.mapping = mapping
-        self.all_mapping = all_mapping
         self.package_name = package_name
         self._params = namedtuple('params', 'deprecated description key last mandatory origin return_type since title '
                                             'param_doc name')
@@ -99,10 +95,6 @@ def extract_type(self, param):
         def evaluate(t1):
             if isinstance(t1, Struct) or isinstance(t1, Enum):
                 name = t1.name
-                element_type = 'enums' if isinstance(t1, Enum) else 'structs'
-                if element_type in self.all_mapping and name in self.all_mapping[element_type] \
-                        and 'rename' in self.all_mapping[element_type][name]:
-                    name = self.all_mapping[element_type][name]['rename']
                 return name
             else:
                 return type(t1).__name__

utils/generator/transformers/enums_producer.py

@@ -38,7 +38,9 @@ def transform(self, item: Enum) -> dict:
 
         for param in getattr(item, self.container_name).values():
             (t, p) = self.extract_param(param, item.name)
-            if t == 'custom':
+            if t == 'complex':
+                kind = t
+            elif t == 'custom' and kind != 'complex':
                 kind = t
             return_type = self.extract_type(param)
 
@@ -74,7 +76,7 @@ def extract_param(self, param: EnumElement, item_name):
             d['name'] = self.key(n)
             d['value'] = param.value
             d['internal'] = '"{}"'.format(n)
-            kind = 'custom'
+            kind = 'complex'
         elif getattr(param, 'internal_name', None) is not None:
             if param.internal_name.startswith(item_name):
                 n = param.internal_name[len(item_name):]
@@ -100,9 +102,7 @@ def extract_param(self, param: EnumElement, item_name):
     @staticmethod
     def extract_imports(param):
         imports = []
-        if getattr(param, 'value', None):
-            imports.extend(['java.util.EnumSet', 'java.util.HashMap', 'java.util.Iterator', 'java.util.Map.Entry'])
-        elif getattr(param, 'internal_name', None):
+        if getattr(param, 'value', None) or getattr(param, 'internal_name', None):
             imports.append('java.util.EnumSet')
         return imports
 
@@ -113,7 +113,7 @@ def extract_type(self, param: EnumElement) -> str:
         :param param: sub-element (EnumElement) of element from initial Model
         :return: string with sub-element type
         """
-        if getattr(param, 'hex_value') is not None or getattr(param, 'value') is not None:
+        if getattr(param, 'value') is not None:
             return 'int'
         else:
             return 'String'

utils/generator/transformers/functions_producer.py

@@ -81,8 +81,6 @@ def transform(self, item: Function) -> dict:
         description = self.extract_description(item.description)
         if description:
             render['description'] = description
-        if imports:
-            render['imports'] = imports
         if params:
             render['params'] = params
 

utils/generator/transformers/structs_producer.py

@@ -60,8 +60,6 @@ def transform(self, item: Struct) -> dict:
         description = self.extract_description(item.description)
         if description:
             render['description'] = description
-        if imports:
-            render['imports'] = imports
         if params:
             render['params'] = params