add fields generation

Author: MrMaydo

src/method_generator.py

@@ -1,7 +1,6 @@
 import re
 from dataclasses import dataclass
-from typing import List
-
+from typing import List, Optional
 
 JAVA_KEYWORDS = {
     "abstract", "assert", "boolean", "break", "byte", "case", "catch",
@@ -32,6 +31,33 @@
 class Field:
     name: str
     type: str
+    description: Optional[str] = None
+
+
+def generate_fields_block(fields: List[Field]) -> str:
+    declaration: list[str] = []
+    for field in fields:
+        declaration.append(generate_field_declaration(field))
+
+    return "\n".join(declaration)
+
+
+def generate_field_declaration(field: Field) -> str:
+    _validate_java_identifier(field.name)
+    if field.description:
+        javadoc = "\n".join([
+            "",
+            f"{indent_lvl1}/**",
+            f"{indent_lvl1} * {field.description}",
+            f"{indent_lvl1} */"
+        ])
+    else:
+        javadoc = ""
+    declaration = [
+        javadoc,
+        f"{indent_lvl1}private {field.type} {field.name};"
+    ]
+    return "\n".join(declaration)
 
 
 def generate_getters_and_setters(fields: List[Field]) -> str:

tests/test_method_generator.py

@@ -1,6 +1,7 @@
 import pytest
 
-from src.method_generator import generate_getter, Field, generate_setter, generate_getters_and_setters
+from src.method_generator import generate_getter, Field, generate_setter, generate_getters_and_setters, \
+    generate_field_declaration, generate_fields_block
 
 JAVA_KEYWORDS = {
     "abstract", "assert", "boolean", "break", "byte", "case", "catch",
@@ -22,6 +23,10 @@
     "null", "true", "false"
 }
 
+EMPTY_NAMES = {None, ""}
+
+MALFORMED_IDENTIFIERS = {"3", "abc-d", "gf*d"}
+
 
 def test_generate_getter_integer():
     attr = Field(
@@ -54,9 +59,8 @@ def test_generate_getter_custom_object():
 
 
 def test_generate_getter_invalid_name():
-    EMPTY_NAMES = {None, ""}
-    invalid_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES | {"3", "abc-d"}
-    for name in invalid_names:
+    illegal_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES | MALFORMED_IDENTIFIERS
+    for name in illegal_names:
         attr = Field(name=name, type="String")
         with pytest.raises(ValueError):
             generate_getter(attr)
@@ -90,9 +94,8 @@ def test_generate_setter_custom_object():
 
 
 def test_generate_setter_invalid_name():
-    EMPTY_NAMES = {None, ""}
-    invalid_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES | {"9", "gf*d"}
-    for name in invalid_names:
+    illegal_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES | MALFORMED_IDENTIFIERS
+    for name in illegal_names:
         attr = Field(name=name, type="String")
         with pytest.raises(ValueError):
             generate_setter(attr)
@@ -116,3 +119,50 @@ def test_generate_getters_and_setters():
         this.customData = customData;
     }"""
     assert generate_getters_and_setters(attributes) == expected
+
+
+def test_generate_field_declaration():
+    attr = Field(name="exampleAttribute", type="int", description="javadoc description")
+    expected = """
+    /**
+     * javadoc description
+     */
+    private int exampleAttribute;"""
+
+    assert generate_field_declaration(attr) == expected
+
+
+def test_generate_field_declaration_no_description():
+    attr = Field(name="customData", type="CustomObject")
+    expected = """
+    private CustomObject customData;"""
+
+    assert generate_field_declaration(attr) == expected
+
+
+def test_generate_field_declaration_invalid_name():
+    illegal_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES | MALFORMED_IDENTIFIERS
+    for name in illegal_names:
+        attr = Field(name=name, type="String")
+        with pytest.raises(ValueError):
+            generate_field_declaration(attr)
+
+
+def test_generate_fields_block():
+    attr1 = Field(name="exampleAttribute", type="int", description="javadoc description")
+    attr2 = Field(name="someName", type="String")
+    attr3 = Field(name="customData", type="CustomObject", description="another javadoc description")
+    attributes = [attr1, attr2, attr3]
+    expected = """
+    /**
+     * javadoc description
+     */
+    private int exampleAttribute;
+
+    private String someName;
+
+    /**
+     * another javadoc description
+     */
+    private CustomObject customData;"""
+    assert generate_fields_block(attributes) == expected