Merge pull request #267 from padjal/get-set

Add Getters & Setters metric

metrics/getset.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+# The MIT License (MIT)
+#
+# Copyright (c) 2021-2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# This metric counts the number of getter and setter methods in a class.
+
+import sys
+from javalang import tree, parse
+
+sys.setrecursionlimit(10000)
+
+
+def is_getter_or_setter(method: tree.MethodDeclaration) -> str | None:
+    """Figures out whether a method is a getter or a setter."""
+    if isinstance(method, tree.MethodDeclaration):
+        if method.name.startswith("get") and len(method.parameters) == 0:
+            return "getter"
+        if method.name.startswith("set") and len(method.parameters) == 1:
+            return "setter"
+    return None
+
+
+def analyze_method(method: tree.MethodDeclaration) -> str | None:
+    """Analyzes the complexity of the method."""
+    if not (method_type := is_getter_or_setter(method)):
+        return None
+
+    return method_type
+
+
+if __name__ == '__main__':
+    java = sys.argv[1]
+    metrics = sys.argv[2]
+
+    getter_count = 0
+    setter_count = 0
+    with open(java, encoding='utf-8', errors='ignore') as f:
+        try:
+            ast = parse.parse(f.read())
+            for _, tree_node in ast.filter(tree.MethodDeclaration):
+                if (result := analyze_method(tree_node)):
+                    method_type_result = result
+                    if method_type_result == 'getter':
+                        getter_count += 1
+
+                    if method_type_result == 'setter':
+                        setter_count += 1
+
+            with open(metrics, 'a', encoding='utf-8') as m:
+                m.write(f'Getters {getter_count} The number of getter methods\n')
+                m.write(f'Setters {setter_count} The number of setter methods\n')
+        except FileNotFoundError as exception:
+            message = f"{type(exception).__name__} {str(exception)}: {java}"
+            sys.exit(message)

tests/metrics/test-getset.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+# The MIT License (MIT)
+#
+# Copyright (c) 2021-2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Test script for analyzing Java getter and setter methods and their complexities
+
+set -e
+set -o pipefail
+
+# Setup temporary workspace
+temp=$1
+stdout=$2
+
+# Location of the Python script
+script_location="${LOCAL}/metrics/getset.py"
+
+{
+    # Create a simple Java file with getter and setter methods
+    java_file="${temp}/Person.java"
+    echo "public class Person {
+        private String name;
+        private int age;
+        
+        public String getName() {return this.name;}
+        public void setName(String name) {this.name = name;}        
+        public int getAge() {return this.age;}        
+        public void setAge(int age) {this.age = age;}        
+        public void nonAccessorMethod() {
+            if (age > 18) {System.out.println(\"Adult\");}
+        }
+    }" > "${java_file}"
+
+    metrics_file="${temp}/metrics.txt"
+    "${script_location}" "${java_file}" "${metrics_file}"
+    cat "${metrics_file}"
+
+    # Assertions: Check for expected output related to getter, setter, and branches
+    grep "Getters 2 The number of getter methods" "${metrics_file}"
+    grep "Setters 2 The number of setter methods" "${metrics_file}"
+} > "${stdout}" 2>&1
+
+echo "👍 Correctly calculated Getter & Setter complexity"