Boolean checks should not be inverted

·

[vc_row][vc_column][vc_btn title=”SOFTWARE ELEGANCE” style=”flat” color=”black” i_icon_fontawesome=”fa fa-shield” add_icon=”true” link=”url:http%3A%2F%2Fdoc.casthighlight.com%2Fsoftware-elegance%2F|||”][vc_btn title=”CODE COMPLEXITY” style=”outline” color=”black” i_icon_fontawesome=”fa fa-code” add_icon=”true” link=”url:http%3A%2F%2Fdoc.casthighlight.com%2Fcategory%2Fproduct%2Findicators-methodology%2Fcode-insights%2Fsoftware-elegance%2Fcode-complexity%2F|||”][vc_empty_space height=”12px”][vc_row_inner][vc_column_inner][vc_column_text]

Why you should care

[/vc_column_text][vc_column_text]It is needlessly complex to invert the result of a boolean comparison. The opposite comparison should be made instead. This is furthermore the case in compound conditions.[/vc_column_text][vc_empty_space][/vc_column_inner][/vc_row_inner][vc_empty_space height=”12px”][vc_empty_space][vc_separator][vc_column_text]

How we detect

[/vc_column_text][vc_column_text]CAST Highlight counts one occurrence each time a conditions begins with an unjustified negation.
The negation is justified if it provides more benefits than disadvantages.
To evaluate the needing of using a negation, check how many “!” operators appear or disappear if we take the opposite conditional expression. Count one violation if the resulting number of ‘!’ is less or equal than is the original expression.
Consider conditions expressions that comply with the following patterns :

  • if (!( ….. ))
  • while (!( ….. ))
  • return !( … )
  • … = !( … )

 

fun toto () {
    if (!(a == 2)) { b++ }  // Not compliant, prefer (a != 2)
    val b = !(i < 10)  // Not compliant, prefer (i >= 10)
    
    if (!((a>b) && titi() || !(a==1) && b==6)) { b++ }
    // not compliant, prefer (((a<b) || !titi()) && ((a==1) || b!==6))
        
    return !(!entityOptions.containerType.isFragment || !(entityOptions.cache ?: getGlobalCacheImpl(currentClass)).hasCache)
    // not compliant, prefer (entityOptions.containerType.isFragment && (entityOptions.cache ?: getGlobalCacheImpl(currentClass)).hasCache)        
 
    a = !(b && c && d) // OK, because (!b || !c || !d) is not more readable.
        
    if (!(a is FunctionDescriptor || a is PropertyDescriptor || a is PackageFragmentDescriptor)) {return}
    // not compliant, prefer (a !is FunctionDescriptor && a !is PropertyDescriptor && a !is PackageFragmentDescriptor)
}

[/vc_column_text][vc_empty_space][vc_separator][vc_column_text]

References

[/vc_column_text][vc_column_text]https://rules.sonarsource.com/kotlin/RSPEC-1940[/vc_column_text][vc_empty_space][vc_row_inner][vc_column_inner][vc_single_image image=”5362″ img_size=”full”][vc_column_text]

About CAST and Highlight’s Code Insights

Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.

[/vc_column_text][vc_empty_space height=”16px”][vc_btn title=”SEE FEATURES” style=”flat” color=”black” i_icon_fontawesome=”fa fa-desktop” add_icon=”true” link=”url:https%3A%2F%2Fwww.castsoftware.com%2Fproducts%2Fhighlight%2Foutputs-analytics||target:%20_blank|”][vc_btn title=”HOW IT WORKS” style=”outline” color=”black” i_icon_fontawesome=”fa fa-cog” add_icon=”true” link=”url:https%3A%2F%2Fwww.castsoftware.com%2Fproducts%2Fhighlight%2Fhow-it-works||target:%20_blank|”][/vc_column_inner][/vc_row_inner][/vc_column][/vc_row]


Leave a Reply

Your email address will not be published. Required fields are marked *