minor: Fix sonarcube warnings #736
Conversation
JaCoCo code coverage report
|
| if (attrIfd == id) true | ||
| else dependsOnRec(attrMap(attrIfd).childRefs, id) | ||
| attrIfd == id || dependsOnRec(attrMap(attrIfd).childRefs, id) | ||
| case ExprRef(exprId) => | ||
| if (exprId == id) true | ||
| else { | ||
| if (litMap.contains("exprId")) false | ||
| else dependsOnRec(funMap(exprId).childRefs, id) | ||
| } |
There was a problem hiding this comment.
It's shorter, but for me, the new version is harder to understand.
There was a problem hiding this comment.
What about introducing an intermediate val? For example?
lazy val attrChildIds = attrMap(attrId).childRefs
lazy val anyChildRefsDepends = dependsOnRec(attrChildRefs, id)
attrIfd == id || anyChildRefsDependsThe main motivation was to comply with the Sonar rule.
Subjectively, I understand why this is usually recommended approach. First, it's shorter, but also it is more plural for the reader. There is less nesting and branching involved for the reader. You have entire resulted condition written in one sentence that IMO looks more natural, e.g. condition = this or that and not something_else. But I agree that a lot depends on naming. So I wouldn't hesitate choosing better names for functions, or introducing intermediate variables.
On a side note, I just noticed that attrIfd is probably a typo. Shouldn't it be attrId? Also dependsOnRef instead of dependsOnRec?
There was a problem hiding this comment.
For simple cases, It may be ok, but here the second condition is more complex. The nesting and branching is still there, it just now must happen inside the reader's head instead of in the code. The reader must consider short-circuiting, negate one expression and operator precedence, and then build a truth table to make sense of it. The Sonar just doesn't consider any of that.
Shorter is not better, I think we should aim to minimize cognitive load.
Why do you mean by plural?
attrIfd yes typo
dependsOnRec no it means recursive - just private name
There was a problem hiding this comment.
plural -> fluent. Crazy typo :)
There was a problem hiding this comment.
Let me refactor it a bit and I'll propose another variant.
|
Kudos, SonarCloud Quality Gate passed!
|
Fix SonarCloud warnings