habit-hooks-java 1.4.0rc2__tar.gz → 1.5.0__tar.gz

{habit_hooks_java-1.4.0rc2 → habit_hooks_java-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: habit-hooks-java
-Version: 1.4.0rc2
+Version: 1.5.0
 Summary: The Java Habit Hooks plugin
 Project-URL: Homepage, https://habit-hooks.com
 Project-URL: Repository, https://github.com/habit-hooks/habit-hooks

{habit_hooks_java-1.4.0rc2 → habit_hooks_java-1.5.0}/docs/java-plugin.spec.md

@@ -66,6 +66,71 @@ habit-sensors --all | jq 'sort_by(.smell)[] | {smell, language, key: (.issues[0]
 }
 ```
 
+## pmd sensor reports the third nested if from the bundled ruleset
+
+With no PMD ruleset in the project, the plugin's bundled fallback explicitly
+sets `AvoidDeeplyNestedIfStmts` to report depth 3. The finding points at the
+third `if` and translates the PMD rule to the shared `deep-nesting` smell.
+
+📄Nested.java
+```java
+class Nested {
+    boolean accepts(int value) {
+        if (value > 0) {
+            if (value < 10) {
+                if (value != 5) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+}
+```
+
+```bash
+habit-sensors --all | jq '.[] | {smell, language, key: (.issues[0].key | sub(".*/"; "")), line: .issues[0].details.line, source: .issues[0].details.source}'
+```
+
+🖥️ ✅
+```json
+{
+  "smell": "deep-nesting",
+  "language": "java",
+  "key": "Nested.java",
+  "line": 5,
+  "source": "pmd:AvoidDeeplyNestedIfStmts"
+}
+```
+
+## two nested ifs remain below the bundled threshold
+
+The third nested `if` is the first one PMD reports at `problemDepth=3`, so an
+otherwise equivalent two-level chain remains clean.
+
+📄Nested.java
+```java
+class Nested {
+    boolean accepts(int value) {
+        if (value > 0) {
+            if (value < 10) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+```
+
+```bash
+habit-sensors --all | jq '[.[].smell]'
+```
+
+🖥️ ✅
+```json
+[]
+```
+
 ## pmd sensor maps a deeply-branched method to high-complexity
 
 A method whose conditions are littered with `||` exceeds PMD's cyclomatic
@@ -103,7 +168,9 @@ habit-sensors --all | jq '.[] | {smell, language, source: .issues[0].details.sou
 PMD never discovers a project ruleset, so the sensor reaches for one only where
 the Java ecosystem conventionally keeps it. A `src/main/resources/pmd/ruleset.xml`
 that lowers the parameter threshold is in force for the run — the bundled
-fallback is only the answer to "this project has none".
+fallback is only the answer to "this project has none". The source also has
+three nested `if`s, but this project ruleset omits `AvoidDeeplyNestedIfStmts`,
+so only the rule the project selected produces a finding.
 
 📄src/main/resources/pmd/ruleset.xml
 ```xml
@@ -122,6 +189,13 @@ fallback is only the answer to "this project has none".
 ```java
 class Project {
     void save(String a, String b) {
+        if (a != null) {
+            if (b != null) {
+                if (!a.equals(b)) {
+                    System.out.println(a);
+                }
+            }
+        }
     }
 }
 ```
@@ -139,6 +213,53 @@ habit-sensors --all | jq '.[] | {smell, language, key: (.issues[0].key | sub(".*
 }
 ```
 
+## a project ruleset can enable deep nesting at its own threshold
+
+A project can opt into the same PMD rule with a different `problemDepth`. Its
+ruleset still replaces the bundled fallback as a whole; the sensor translates
+the enabled rule normally.
+
+📄pmd/ruleset.xml
+```xml
+<?xml version="1.0"?>
+<ruleset name="custom" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+ <description>report the second nested if</description>
+ <rule ref="category/java/design.xml/AvoidDeeplyNestedIfStmts">
+  <properties><property name="problemDepth" value="2"/></properties>
+ </rule>
+</ruleset>
+```
+
+📄Nested.java
+```java
+class Nested {
+    boolean accepts(int value) {
+        if (value > 0) {
+            if (value < 10) {
+                return true;
+            }
+        }
+        return false;
+    }
+}
+```
+
+```bash
+habit-sensors --all | jq '.[] | {smell, language, line: .issues[0].details.line, source: .issues[0].details.source}'
+```
+
+🖥️ ✅
+```json
+{
+  "smell": "deep-nesting",
+  "language": "java",
+  "line": 4,
+  "source": "pmd:AvoidDeeplyNestedIfStmts"
+}
+```
+
 ## `[sensors.pmd] args` reaches PMD directly
 
 `args` is spliced into the sensor's command as `${args} -- ${files}`, so a real

{habit_hooks_java-1.4.0rc2 → habit_hooks_java-1.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "habit-hooks-java"
-version = "1.4.0rc2"
+version = "1.5.0"
 description = "The Java Habit Hooks plugin"
 readme = "README.md"
 license = "MIT"

{habit_hooks_java-1.4.0rc2 → habit_hooks_java-1.5.0}/src/habit_hooks_java/sensors/pmd-ruleset.xml

@@ -8,6 +8,9 @@
   <rule ref="category/java/design.xml/ExcessiveParameterList">
     <properties><property name="minimum" value="4"/></properties>
   </rule>
+  <rule ref="category/java/design.xml/AvoidDeeplyNestedIfStmts">
+    <properties><property name="problemDepth" value="3"/></properties>
+  </rule>
   <rule ref="category/java/design.xml/CyclomaticComplexity">
     <properties><property name="methodReportLevel" value="10"/></properties>
   </rule>

{habit_hooks_java-1.4.0rc2 → habit_hooks_java-1.5.0}/src/habit_hooks_java/sensors/pmd_sensor.py

@@ -35,6 +35,7 @@ from pathlib import Path
 from pmd_ruleset import ruleset_of
 
 RULE_SMELLS = {
+    "AvoidDeeplyNestedIfStmts": "deep-nesting",
     "ExcessiveParameterList": "too-many-parameters",
     "CyclomaticComplexity": "high-complexity",
     "NcssCount": "oversized-function",
@@ -131,9 +132,6 @@ def findings(entries: list[dict]) -> list[dict]:
 
 def main() -> int:
     pmd, argv = sys.argv[1], sys.argv[2:]
-    if not argv:
-        print("[]")
-        return 0
     pmd_args, files = split_argv(argv)
     ruleset, remaining_args = ruleset_of(pmd_args, Path.cwd())
     file_args = [token for file in files for token in ("-d", file)]

habit_hooks_java-1.5.0/tests/test_bundled_ruleset_declares_its_contract.py

@@ -0,0 +1,33 @@
+"""The bundled PMD fallback pins behavior that PMD's defaults must not move."""
+
+from __future__ import annotations
+
+import xml.etree.ElementTree as ElementTree
+from pathlib import Path
+
+RULESET = (
+    Path(__file__).resolve().parents[1]
+    / "src"
+    / "habit_hooks_java"
+    / "sensors"
+    / "pmd-ruleset.xml"
+)
+PMD_NAMESPACE = {"pmd": "http://pmd.sourceforge.net/ruleset/2.0.0"}
+DEEP_NESTING_RULE = "category/java/design.xml/AvoidDeeplyNestedIfStmts"
+
+
+def test_the_bundled_ruleset_explicitly_reports_the_third_nested_if() -> None:
+    root = ElementTree.parse(RULESET).getroot()
+
+    rules = [
+        rule
+        for rule in root.findall("pmd:rule", PMD_NAMESPACE)
+        if rule.get("ref") == DEEP_NESTING_RULE
+    ]
+
+    assert len(rules) == 1
+    problem_depth = rules[0].findall(
+        "pmd:properties/pmd:property[@name='problemDepth']", PMD_NAMESPACE
+    )
+    assert len(problem_depth) == 1
+    assert problem_depth[0].get("value") == "3"