Merge pull request #1 from MrMaydo/dev

Dev

Author: MrMaydo

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+reports/
 
 # Translations
 *.mo
@@ -150,3 +151,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
+poetry.lock

pyproject.toml

@@ -0,0 +1,24 @@
+[tool.poetry]
+name = "jsonschema-2-javaclass"
+version = "0.1.0"
+description = "Java Class generator"
+authors = ["Your Name <you@example.com>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+pytest = "^8.3.5"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.14.10"
+pytest-html = "^4.1.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = """-v --cov=src --cov-report=term-missing --cov-report=html:reports/coverage --html=reports/report.html --self-contained-html"""
+testpaths = ["tests"]
+

src/method_generator.py

@@ -1,6 +1,6 @@
 import re
 from dataclasses import dataclass
-
+from typing import List, Optional
 
 JAVA_KEYWORDS = {
     "abstract", "assert", "boolean", "break", "byte", "case", "catch",
@@ -31,45 +31,101 @@
 class Field:
     name: str
     type: str
+    description: Optional[str] = None
+
+
+def generate_fields_block(fields: List[Field]) -> str:
+    declaration = []
+    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:
+    methods = []
+    for field in fields:
+        methods.append(generate_getter(field))
+        methods.append(generate_setter(field))
 
-def generate_getter(attr: Field) -> str:
-    attr_name = attr.name
-    attr_type = attr.type
+    return "\n\n".join(methods)
 
-    _validate_java_identifier(attr_name)
 
-    getter_name = "get" + attr_name[0].upper() + attr_name[1:]
+def generate_getter(field: Field) -> str:
+    field_name = field.name
+    field_type = field.type
+
+    _validate_java_identifier(field_name)
+
+    getter_name = "get" + field_name[0].upper() + field_name[1:]
 
     getter = [
         "",
-        f"{indent_lvl1}public {attr_type} {getter_name}() {{",
-        f"{indent_lvl2}return {attr_name};",
+        f"{indent_lvl1}public {field_type} {getter_name}() {{",
+        f"{indent_lvl2}return {field_name};",
         f"{indent_lvl1}}}"
     ]
     getter = "\n".join(getter)
 
     return getter
 
 
-def generate_setter(attr: Field) -> str:
-    attr_name = attr.name
-    attr_type = attr.type
+def generate_setter(field: Field) -> str:
+    field_name = field.name
+    field_type = field.type
 
-    _validate_java_identifier(attr_name)
+    _validate_java_identifier(field_name)
 
-    setter_name = "set" + attr_name[0].upper() + attr_name[1:]
+    setter_name = "set" + field_name[0].upper() + field_name[1:]
 
     setter = [
         "",
-        f"{indent_lvl1}public void {setter_name}({attr_type} {attr_name}) {{",
-        f"{indent_lvl2}this.{attr_name} = {attr_name};",
+        f"{indent_lvl1}public void {setter_name}({field_type} {field_name}) {{",
+        f"{indent_lvl2}this.{field_name} = {field_name};",
         f"{indent_lvl1}}}"
     ]
     setter = "\n".join(setter)
     return setter
 
 
+def generate_hash_code(fields: List[Field]) -> str:
+    hash_code = [
+        "",
+        f"{indent_lvl1}@Override",
+        f"{indent_lvl1}public int hashCode() {{",
+        f"{indent_lvl2}return Objects.hash("
+    ]
+
+    for i, field in enumerate(fields):
+        _validate_java_identifier(field.name)
+        getter_name = "get" + field.name[0].upper() + field.name[1:]
+        comma = "," if i < (len(fields) - 1) else ""
+        hash_code.append(f"{indent_lvl2}        {getter_name}(){comma}")
+
+    hash_code.append(f"{indent_lvl2});")
+    hash_code.append(f"{indent_lvl1}}}")
+
+    return "\n".join(hash_code)
+
+
 def _validate_java_identifier(name: str) -> None:
     if not name:
         raise ValueError("Field name cannot be empty")

tests/reference_data.py

@@ -0,0 +1,35 @@
+from src.method_generator import Field
+
+field_exampleAttribute_int = Field(name="exampleAttribute", type="int", description="javadoc description")
+field_someName_String = Field(name="someName", type="String")
+field_customData_CustomObject = Field(name="customData", type="CustomObject", description="another javadoc description")
+
+expected_getExampleAttribute_int = """
+    public int getExampleAttribute() {
+        return exampleAttribute;
+    }"""
+
+expected_setExampleAttribute_int = """
+    public void setExampleAttribute(int exampleAttribute) {
+        this.exampleAttribute = exampleAttribute;
+    }"""
+
+expected_getSomeName_String = """
+    public String getSomeName() {
+        return someName;
+    }"""
+
+expected_setSomeName_String = """
+    public void setSomeName(String someName) {
+        this.someName = someName;
+    }"""
+
+expected_getCustomData_CustomObject = """
+    public CustomObject getCustomData() {
+        return customData;
+    }"""
+
+expected_setCustomData_CustomObject = """
+    public void setCustomData(CustomObject customData) {
+        this.customData = customData;
+    }"""

tests/test_method_generator.py

@@ -1,6 +1,7 @@
 import pytest
 
-from src.method_generator import generate_getter, Field, generate_setter
+from tests.reference_data import *
+from src.method_generator import *
 
 JAVA_KEYWORDS = {
     "abstract", "assert", "boolean", "break", "byte", "case", "catch",
@@ -22,78 +23,140 @@
     "null", "true", "false"
 }
 
+EMPTY_NAMES = {None, ""}
+
+MALFORMED_IDENTIFIERS = {"3", "abc-d", "gf*d"}
+
+illegal_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES | MALFORMED_IDENTIFIERS
+
 
 def test_generate_getter_integer():
-    attr = Field(
-        name="exampleAttribute",
-        type="int"
-    )
-    expected = """
-    public int getExampleAttribute() {
-        return exampleAttribute;
-    }"""
-    assert (generate_getter(attr) == expected)
+    attr = field_exampleAttribute_int
+
+    assert (generate_getter(attr) == expected_getExampleAttribute_int)
 
 
 def test_generate_getter_string():
-    attr = Field(name="someName", type="String")
-    expected = """
-    public String getSomeName() {
-        return someName;
-    }"""
-    assert (generate_getter(attr) == expected)
+    attr = field_someName_String
+
+    assert (generate_getter(attr) == expected_getSomeName_String)
 
 
 def test_generate_getter_custom_object():
-    attr = Field(name="customData", type="CustomObject")
-    expected = """
-    public CustomObject getCustomData() {
-        return customData;
-    }"""
-    assert (generate_getter(attr) == expected)
+    attr = field_customData_CustomObject
+
+    assert (generate_getter(attr) == expected_getCustomData_CustomObject)
 
 
 def test_generate_getter_invalid_name():
-    EMPTY_NAMES = {None, ""}
-    invalid_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES
-    for name in invalid_names:
+    for name in illegal_names:
         attr = Field(name=name, type="String")
         with pytest.raises(ValueError):
             generate_getter(attr)
 
 
 def test_generate_setter_integer():
-    attr = Field(name="exampleAttribute", type="int")
-    expected = f"""
-    public void setExampleAttribute(int exampleAttribute) {{
-        this.exampleAttribute = exampleAttribute;
-    }}"""
-    assert (generate_setter(attr) == expected)
+    attr = field_exampleAttribute_int
+
+    assert (generate_setter(attr) == expected_setExampleAttribute_int)
 
 
 def test_generate_setter_string():
-    attr = Field(name="someName", type="String")
-    expected = f"""
-    public void setSomeName(String someName) {{
-        this.someName = someName;
-    }}"""
-    assert (generate_setter(attr) == expected)
+    attr = field_someName_String
+
+    assert (generate_setter(attr) == expected_setSomeName_String)
 
 
 def test_generate_setter_custom_object():
-    attr = Field(name="customData", type="CustomObject")
-    expected = f"""
-    public void setCustomData(CustomObject customData) {{
-        this.customData = customData;
-    }}"""
-    assert (generate_setter(attr) == expected)
+    attr = field_customData_CustomObject
+
+    assert (generate_setter(attr) == expected_setCustomData_CustomObject)
 
 
 def test_generate_setter_invalid_name():
-    EMPTY_NAMES = {None, ""}
-    invalid_names = JAVA_KEYWORDS | JAVA_BUILTIN_TYPES | JAVA_LITERALS | EMPTY_NAMES
-    for name in invalid_names:
+    for name in illegal_names:
         attr = Field(name=name, type="String")
         with pytest.raises(ValueError):
             generate_setter(attr)
 
+
+def test_generate_getters_and_setters():
+    attr1 = field_exampleAttribute_int
+    attr2 = field_customData_CustomObject
+    attributes = [attr1, attr2]
+
+    expected = "\n\n".join([
+        expected_getExampleAttribute_int,
+        expected_setExampleAttribute_int,
+        expected_getCustomData_CustomObject,
+        expected_setCustomData_CustomObject
+    ])
+    assert generate_getters_and_setters(attributes) == expected
+
+
+def test_generate_field_declaration():
+    attr = field_exampleAttribute_int
+    expected = """
+    /**
+     * javadoc description
+     */
+    private int exampleAttribute;"""
+
+    assert generate_field_declaration(attr) == expected
+
+
+def test_generate_field_declaration_no_description():
+    attr = field_someName_String
+    expected = """
+    private String someName;"""
+
+    assert generate_field_declaration(attr) == expected
+
+
+def test_generate_field_declaration_invalid_name():
+    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_exampleAttribute_int
+    attr2 = field_someName_String
+    attr3 = field_customData_CustomObject
+    attributes = [attr1, attr2, attr3]
+    expected = """
+    /**
+     * javadoc description
+     */
+    private int exampleAttribute;\n
+    private String someName;\n
+    /**
+     * another javadoc description
+     */
+    private CustomObject customData;"""
+    assert generate_fields_block(attributes) == expected
+
+
+def test_generate_hash_code():
+    attr1 = field_exampleAttribute_int
+    attr2 = field_someName_String
+    attr3 = field_customData_CustomObject
+    attributes = [attr1, attr2, attr3]
+    expected = """
+    @Override
+    public int hashCode() {
+        return Objects.hash(
+                getExampleAttribute(),
+                getSomeName(),
+                getCustomData()
+        );
+    }"""
+    assert generate_hash_code(attributes) == expected
+
+
+def test_generate_hash_code_invalid_name():
+    for name in illegal_names:
+        attr = Field(name=name, type="String")
+        with pytest.raises(ValueError):
+            generate_hash_code([attr])