NullPointerException on KDOC inspection #1334

Cheshiriks · 2022-05-31T10:44:25Z

What's done:

fixed NullPointerException on KDOC inspection
Closes NullPointerException on KDOC inspection #1331

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

orchestr7 · 2022-05-31T10:53:32Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

@@ -88,7 +88,8 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
            val config = configRules.getCommonConfiguration()
            val filePath = node.getFilePath()
            val isTestMethod = node.hasTestAnnotation() || isLocatedInTest(filePath.splitPathToDirs(), config.testAnchors)
-            if (!isTestMethod && !node.isStandardMethod() && !node.isSingleLineGetterOrSetter()) {
+            if (!isTestMethod && !node.isStandardMethod() && !node.isSingleLineGetterOrSetter() &&


please cover with tests

orchestr7 · 2022-05-31T10:55:33Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

@@ -88,7 +88,8 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
            val config = configRules.getCommonConfiguration()
            val filePath = node.getFilePath()
            val isTestMethod = node.hasTestAnnotation() || isLocatedInTest(filePath.splitPathToDirs(), config.testAnchors)
-            if (!isTestMethod && !node.isStandardMethod() && !node.isSingleLineGetterOrSetter()) {
+            if (!isTestMethod && !node.isStandardMethod() && !node.isSingleLineGetterOrSetter() &&
+                    node.treeParent.findAllDescendantsWithSpecificType(ElementType.FUNCTION_TYPE).isEmpty()) {


Are you sure that there is node.treeParent exists?

codecov · 2022-05-31T10:55:52Z

Codecov Report

Merging #1334 (0d4aec1) into master (d7810d6) will increase coverage by 0.03%.
The diff coverage is 66.66%.

@@             Coverage Diff              @@
##             master    #1334      +/-   ##
============================================
+ Coverage     83.49%   83.52%   +0.03%     
- Complexity     2561     2563       +2     
============================================
  Files           106      106              
  Lines          7275     7278       +3     
  Branches       2014     2017       +3     
============================================
+ Hits           6074     6079       +5     
+ Misses          354      353       -1     
+ Partials        847      846       -1

Flag	Coverage Δ
unittests	`83.52% <66.66%> (+0.03%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ruleset/rules/chapter5/AvoidNestedFunctionsRule.kt	`93.02% <50.00%> (+0.16%)`	⬆️
...tlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt	`82.74% <50.00%> (-0.20%)`	⬇️
.../diktat/ruleset/rules/chapter1/IdentifierNaming.kt	`82.23% <100.00%> (ø)`
.../diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt	`87.42% <100.00%> (ø)`
.../cqfn/diktat/ruleset/utils/FunctionAstNodeUtils.kt	`82.14% <0.00%> (+10.71%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d7810d6...0d4aec1. Read the comment docs.

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/smoke/DiktatSmokeTest.kt

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter5/AvoidNestedFunctionsRule.kt

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

nulls · 2022-06-01T07:53:01Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

+/**
+ * Checks if a function is anonymous
+ */
+fun ASTNode.isAnonymousFunction() {


do we have a rule for explicit typing for public function?

Missing explicit type can only mean that the function returns Unit, so there is no need in such rule. Even in the rule that checks @return KDoc tag we allow it to be missing if the function has no explicit return type or explicitly specified Unit.

But @Cheshiriks wanted to make a boolean function, no?
He wanted return this.getIdentifierName() == null

nulls · 2022-06-01T07:53:25Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

+ * Checks if a function is anonymous
+ */
+fun ASTNode.isAnonymousFunction() {
+    require(this.elementType == FUN)


can it be a part of checking of this function instead of assumption?

I don't think it's needed here. We already everywhere have a check that this value is equal to FUN before calling this method

so this function treats to node to be a FUN. it means that it's can be called only
node.elementType == FUN && node.isAnonymousFunction(), otherwise -- exception

can we then move it to KdocMethods.kt as private method, because it contains a specific logic for your cases only

Yes, that's the point. We do not want the developer to try to call this function on a different type of node, In this case, we will not know what to return

orchestr7 · 2022-06-01T09:10:45Z

diktat-rules/src/test/resources/test/smoke/src/main/kotlin/Example8Expected.kt

+package org.cqfn.diktat
+
+fun foo() {
+    val sum: (Int, Int, Int,) -> Int = fun(


please also add a unit test (at list for checks), even duplicated. Not only smoke is needed

### What's done: * fixed NullPointerException on KDOC inspection closes #1334

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

nulls · 2022-06-01T11:13:18Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt

+ * Checks if a function is anonymous
+ */
+fun ASTNode.isAnonymousFunction() {
+    require(this.elementType == FUN)


can we then move it to KdocMethods.kt as private method, because it contains a specific logic for your cases only

Cheshiriks · 2022-06-01T13:40:16Z

This is not quite the correct name of the error. We initially thought that the error was only in the cdoc rules, but it turned out that we didn’t take into account anonymous functions in many places, so it’s wrong to put them only in KdocMethods.kt

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

nulls

approved after adding a KDoc about expectation

NullPointerException on KDOC inspection

e1d27ee

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

Cheshiriks requested review from petertrr and orchestr7 May 31, 2022 10:44

orchestr7 reviewed May 31, 2022

View reviewed changes

Cheshiriks added 2 commits May 31, 2022 14:46

NullPointerException on KDOC inspection

e4575d1

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

NullPointerException on KDOC inspection

6237abe

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

Cheshiriks force-pushed the bugfix/npe-on-kdoc branch from ceb5433 to 6237abe Compare May 31, 2022 12:58

petertrr reviewed May 31, 2022

View reviewed changes

diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/smoke/DiktatSmokeTest.kt Outdated Show resolved Hide resolved

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter5/AvoidNestedFunctionsRule.kt Outdated Show resolved Hide resolved

Cheshiriks added 2 commits May 31, 2022 18:01

NullPointerException on KDOC inspection

fd86fd8

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

Merge branch 'master' into bugfix/npe-on-kdoc

0a07e40

petertrr approved these changes May 31, 2022

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt Outdated Show resolved Hide resolved

NullPointerException on KDOC inspection

8df28b7

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

nulls requested changes Jun 1, 2022

View reviewed changes

orchestr7 reviewed Jun 1, 2022

View reviewed changes

Cheshiriks added 5 commits June 1, 2022 12:38

NullPointerException on KDOC inspection

03fbaf8

### What's done: * fixed NullPointerException on KDOC inspection closes #1334

Merge branch 'master' into bugfix/npe-on-kdoc

330d64d

NullPointerException on KDOC inspection

6d3766e

### What's done: * fixed NullPointerException on KDOC inspection closes #1334

NullPointerException on KDOC inspection

e64723e

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

NullPointerException on KDOC inspection

8d3a11b

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

nulls requested changes Jun 1, 2022

View reviewed changes

orchestr7 approved these changes Jun 2, 2022

View reviewed changes

Cheshiriks added 2 commits June 2, 2022 15:17

NullPointerException on KDOC inspection

70c5b4b

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

NullPointerException on KDOC inspection

0d4aec1

### What's done: * fixed NullPointerException on KDOC inspection Closes #1331

nulls approved these changes Jun 2, 2022

View reviewed changes

Cheshiriks merged commit 92f2fef into master Jun 2, 2022

Cheshiriks deleted the bugfix/npe-on-kdoc branch June 2, 2022 12:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NullPointerException on KDOC inspection #1334

NullPointerException on KDOC inspection #1334

Cheshiriks commented May 31, 2022

orchestr7 May 31, 2022

Cheshiriks May 31, 2022

orchestr7 May 31, 2022

Cheshiriks May 31, 2022

codecov bot commented May 31, 2022 •

edited

Loading

nulls Jun 1, 2022

petertrr Jun 1, 2022

orchestr7 Jun 1, 2022 •

edited

Loading

Cheshiriks Jun 1, 2022

nulls Jun 1, 2022

Cheshiriks Jun 1, 2022

nulls Jun 1, 2022

nulls Jun 1, 2022

Cheshiriks Jun 1, 2022

orchestr7 Jun 1, 2022 •

edited

Loading

Cheshiriks Jun 1, 2022

nulls Jun 1, 2022

Cheshiriks commented Jun 1, 2022

nulls left a comment •

edited

Loading

NullPointerException on KDOC inspection #1334

NullPointerException on KDOC inspection #1334

Conversation

Cheshiriks commented May 31, 2022

What's done:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented May 31, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orchestr7 Jun 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orchestr7 Jun 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cheshiriks commented Jun 1, 2022

nulls left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented May 31, 2022 •

edited

Loading

orchestr7 Jun 1, 2022 •

edited

Loading

orchestr7 Jun 1, 2022 •

edited

Loading

nulls left a comment •

edited

Loading