Avoid confusing initialization for variables declared on the same line

·

[vc_row][vc_column][vc_btn title=”SOFTWARE RESILIENCY” style=”flat” color=”black” i_icon_fontawesome=”fa fa-shield” add_icon=”true” link=”url:http%3A%2F%2Fdoc.casthighlight.com%2Fsoftware-resiliency%2F|||”][vc_btn title=”CODE RELIABILITY” 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-resiliency%2Fcode-reliability%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]Destructuring assignment are a practical sugar syntax, but due to dynamic typing, ommitting the parentheses lead to a syntactically correct, but however functionnally incorrect, implementation.[/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 variable is initialized with a tab, variable (or function call) in the following context :

  • the variable is preceded by another declaration on the same line
  • the variables are not inside a destructuring parentheses syntax.

 

    def a, b = [1, 2]              // +1 VIOLATION (bad, b is null)
    def c, d, e = [1, 2, 3] // +1 VIOLATION  (bad, c and d are null)
    def a, b = functionReturningTad()  // +1 VIOLATION (bad, b is null, even if the function is returning a tab!!)
    class MyClass {
        def a, b, c = [1, 2, 3]  // +1 VIOLATION (bad, a and b are null)
    }
    
    def x = [1, 2, 3]       // ok
    def (f, g) = [1, 2]    // ok
    (a, b, c) = [1, 2, 3]  // ok

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

References

[/vc_column_text][vc_column_text]https://codenarc.org/codenarc-rules-groovyism.html#confusingmultiplereturns-rule[/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 *