Merge branch 'main' into fix/challenge25-GCI82-manage-record

Author: cali0pe

.github/workflows/build.yml

@@ -5,12 +5,12 @@ on:
     branches:
       - main
     paths-ignore:
-      - '*.md'
-      - '.github/**/*.yml'
+      - "*.md"
+      - ".github/**/*.yml"
     tags:
-      - '[0-9]+.[0-9]+.[0-9]+'
+      - "[0-9]+.[0-9]+.[0-9]+"
   pull_request:
-    types: [ opened, synchronize, reopened ]
+    types: [opened, synchronize, reopened]
 
 jobs:
   build:
@@ -22,32 +22,27 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
-          distribution: 'temurin'
+          distribution: "temurin"
           java-version: 17
-
-      - name: Cache Maven packages
-        uses: actions/cache@v3
-        with:
-          path: ~/.m2
-          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-          restore-keys: ${{ runner.os }}-m2
+          cache: maven
 
       - name: Verify
         run: ./mvnw -e -B verify
 
       - name: Cache SonarQube packages
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
 
       - name: SonarQube Scan
+        if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - correction of technical problem with Integration tests (because of Maven format in technical answer to "sonar-orchestrator-junit5" library)
 - upgrade JDK from 11 to 17
 - [#105](https://github.com/green-code-initiative/creedengo-java/pull/105) fix GCI82 rule to handle record types and adjust test cases
+- [#4](https://github.com/green-code-initiative/creedengo-java/issues/4) Improvement: "++i" statement is not so bad
 
 ### Deleted
 

src/it/java/org/greencodeinitiative/creedengo/java/integration/tests/GCIRulesIT.java

@@ -429,8 +429,8 @@ void testGCI67() {
         String filePath = "src/main/java/org/greencodeinitiative/creedengo/java/checks/IncrementCheck.java";
         String ruleId = "creedengo-java:GCI67";
         String ruleMsg = "Use ++i instead of i++";
-        int[] startLines = new int[]{9, 19, 38};
-        int[] endLines = new int[]{9, 19, 38};
+        int[] startLines = new int[]{9, 24, 47};
+        int[] endLines = new int[]{9, 24, 47};
 
         checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines);
     }

src/it/test-projects/creedengo-java-plugin-test-project/src/main/java/org/greencodeinitiative/creedengo/java/checks/IncrementCheck.java

@@ -9,40 +9,71 @@ int foo1() {
         return counter++; // Noncompliant {{Use ++i instead of i++}}
     }
 
+    private int j = 0;
+    int foo10() {
+        return this.j++; // Compliant because maybe the use case needs to return j AND increment it
+    }
+
     int foo11() {
         int counter = 0;
         return ++counter;
     }
 
-    void foo2(int value) {
+    int foo2() {
         int counter = 0;
         counter++; // Noncompliant {{Use ++i instead of i++}}
+        return counter;
     }
 
-    void foo22(int value) {
+    int foo22() {
         int counter = 0;
         ++counter;
+        return counter;
     }
 
-    void foo3(int value) {
+    int foo3() {
         int counter = 0;
         counter = counter + 197845 ;
+        return counter;
     }
 
-    void foo4(int value) {
+    int foo4() {
         int counter = 0;
         counter = counter + 35 + 78 ;
+        return counter;
     }
 
-    void foo50(int value) {
+    void foo50() {
         for (int i=0; i < 10; i++) { // Noncompliant {{Use ++i instead of i++}}
-            System.out.println(i);
+            System.out.println(i); //NOSONAR
         }
     }
 
-    void foo51(int value) {
+    void foo51() {
         for (int i=0; i < 10; ++i) {
-            System.out.println(i);
+            System.out.println(i); //NOSONAR
         }
     }
+
+    void bar61(int value) {
+        // For test purpose
+    }
+
+    int foo61() {
+        int i = 0;
+        bar61(i++); // Compliant because maybe bar61 needs the unincremented value
+        return i;
+    }
+
+    int foo62() {
+        int i = 0;
+        bar61(2 + i++); // Compliant because maybe bar61 needs the unincremented value
+        return i;
+    }
+
+    void foo71() {
+        int counter = 0;
+        int a = 2 + counter++;  // Compliant because we probably want to increment counter
+                                // then to add it to 2 to initialize a
+    }
 }

src/main/java/org/greencodeinitiative/creedengo/java/checks/IncrementCheck.java

@@ -22,7 +22,10 @@
 
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
+import org.sonar.plugins.java.api.tree.Arguments;
+import org.sonar.plugins.java.api.tree.BinaryExpressionTree;
 import org.sonar.plugins.java.api.tree.Tree;
+import org.sonar.plugins.java.api.tree.UnaryExpressionTree;
 import org.sonar.plugins.java.api.tree.Tree.Kind;
 import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
 
@@ -40,6 +43,13 @@ public List<Kind> nodesToVisit() {
 
     @Override
     public void visitNode(Tree tree) {
+        UnaryExpressionTree unaryExprTree = (UnaryExpressionTree) tree;
+
+        if (unaryExprTree.parent() instanceof BinaryExpressionTree
+            || unaryExprTree.parent() instanceof Arguments
+            || unaryExprTree.expression().is(Tree.Kind.MEMBER_SELECT)) {
+            return ;
+        }
         reportIssue(tree, MESSAGERULE);
     }
 }

src/test/files/IncrementCheck.java

@@ -15,49 +15,92 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class MyClass {
-    MyClass(MyClass mc) {
+package org.greencodeinitiative.creedengo.java.checks;
+
+private class Foo {
+    public int i; //NOSONAR
+}
+
+class IncrementCheck {
+
+    IncrementCheck(IncrementCheck mc) {
     }
 
     int foo1() {
         int counter = 0;
         return counter++; // Noncompliant {{Use ++i instead of i++}}
     }
 
+    private int j = 0;
+    int foo10() {
+        return this.j++; // Compliant because maybe the use case needs to return j AND increment it
+    }
+
     int foo11() {
         int counter = 0;
         return ++counter;
     }
 
-    void foo2(int value) {
+    int foo12() {
+        Foo f;
+        return f.i++; // Compliant because maybe the use case needs to return j AND increment it
+    }
+
+    int foo2() {
         int counter = 0;
         counter++; // Noncompliant {{Use ++i instead of i++}}
+        return counter;
     }
 
-    void foo22(int value) {
+    int foo22() {
         int counter = 0;
         ++counter;
+        return counter;
     }
 
-    void foo3(int value) {
+    int foo3() {
         int counter = 0;
         counter = counter + 197845 ;
+        return counter;
     }
 
-    void foo4(int value) {
-        int counter =0;
+    int foo4() {
+        int counter = 0;
         counter = counter + 35 + 78 ;
+        return counter;
     }
 
-    void foo50(int value) {
+    void foo50() {
         for (int i=0; i < 10; i++) { // Noncompliant {{Use ++i instead of i++}}
-            System.out.println(i);
+            System.out.println(i); //NOSONAR
         }
     }
 
-    void foo51(int value) {
+    void foo51() {
         for (int i=0; i < 10; ++i) {
-            System.out.println(i);
+            System.out.println(i); //NOSONAR
         }
     }
+
+    void bar61(int value) {
+        // For test purpose
+    }
+
+    int foo61() {
+        int i = 0;
+        bar61(i++); // Compliant because maybe bar61 needs the unincremented value
+        return i;
+    }
+
+    int foo62() {
+        int i = 0;
+        bar61(2 + i++); // Compliant because maybe bar61 needs the unincremented value
+        return i;
+    }
+
+    void foo71() {
+        int counter = 0;
+        int a = 2 + counter++;  // Compliant because we probably want to increment counter
+                                // then to add it to 2 to initialize a
+    }
 }