Add Getters & Setters metric

metrics/getset.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+import sys
+from javalang import tree, parse
+
+sys.setrecursionlimit(10000)
+
+def is_getter_or_setter(method):
+    """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"
+        elif method.name.startswith("set") and len(method.parameters) == 1:
+            return "setter"
+    return None
+
+def count_branches(node):
+    """Counts the number of branches in a method."""
+    count = 0
+    if isinstance(node, (tree.IfStatement, tree.WhileStatement, tree.ForStatement, tree.DoStatement, tree.SwitchStatement, tree.CatchClause)):
+        count = 1
+    return count
+
+def analyze_method(method):
+    """Analyzes the complexity of the method."""
+    method_type = is_getter_or_setter(method)
+    if not method_type:
+        return None
+
+    complexity = 0
+    branches = 0
+    for _, node in method.filter(tree.Statement):
+        branches += count_branches(node)
+
+        # print(method_type)
+        # print(method.name[3:].lower())
+
+        if method_type == "setter":
+            # Increase complexity for each additional variable assignment
+            if isinstance(node, tree.Assignment) and node.expressionl != method.parameters[0].name:
+                complexity += 1
+
+        elif method_type == "getter":
+            # print('Expression: ', node.expression)
+            # print(node.expression.selectors[0].member)
+
+            # Increase complexity for each statement not related to the returned variable
+            if not (isinstance(node, tree.ReturnStatement) and node.expression.selectors[0].member == method.name[3:].lower()):
+                complexity += 1
+
+    # Increase complexity for branching
+    complexity += branches
+
+    return method_type, complexity, branches
+
+if __name__ == '__main__':
+    JAVA = sys.argv[1]
+    METRICS = sys.argv[2]
+    with open(JAVA, encoding='utf-8', errors='ignore') as f:
+        try:
+            ast = parse.parse(f.read())
+            for _, node in ast.filter(tree.MethodDeclaration):
+                result = analyze_method(node)
+                if result:
+                    method_type, complexity, branches = result
+                    with open(METRICS, 'a', encoding='utf-8') as m:
+                        # m.write(f'{method_type} {complexity} {branches} Branches of {node.name}\n')
+                        m.write(f'{method_type} {complexity} {branches}\n')
+        except FileNotFoundError as exception:
+            message = f"{type(exception).__name__} {str(exception)}: {JAVA}"
+            sys.exit(message)

tests/metrics/test-getset.sh

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+# Test script for analyzing Java getter and setter methods and their complexities
+
+set -e
+set -o pipefail
+
+# Setup temporary workspace
+# temp=$(mktemp -d)
+# stdout="${temp}/stdout.txt"
+
+temp=$1
+stdout=$2
+
+# Location of the Python script
+script_location="${LOCAL}/metrics/getset.py"
+
+# echo "${script_location}"
+# echo "${temp}"
+
+{
+    # 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"
+    # echo "${metrics_file}"    
+    "${script_location}" "${java_file}" "${metrics_file}"
+    cat "${metrics_file}"
+
+    # echo "${}"
+
+    # Assertions: Check for expected output related to getter, setter, and branches
+    # grep "getter 0 0 Branches of getName" "${metrics_file}"
+    # grep "setter 0 0 Branches of setName" "${metrics_file}"
+    # grep "getter 0 0 Branches of getAge" "${metrics_file}"
+    # grep "setter 0 0 Branches of setAge" "${metrics_file}"
+    grep "getter 0 0" "${metrics_file}"
+    grep "setter 0 0" "${metrics_file}"
+    grep "getter 0 0" "${metrics_file}"
+    grep "setter 0 0" "${metrics_file}"
+    grep "none 1 1 Branches of nonAccessorMethod" "${metrics_file}" || true # This line is expected to fail since your script currently doesn't handle non-accessor methods
+} > "${stdout}" 2>&1
+
+echo "👍 Tests passed successfully"