kylekatarnls/business-time

Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

See

• Cognitive Complexity

A for loop stop condition should test the loop counter against an invariant value (i.e. one that is true at both the beginning and ending of every loop iteration). Ideally, this means that the stop condition is set to a local variable just before the loop begins.

Stop conditions that are not invariant are slightly less efficient, as well as being difficult to understand and maintain, and likely lead to the introduction of errors in the future.

This rule tracks three types of non-invariant stop conditions:

• When the loop counters are updated in the body of the for loop
• When the stop condition depend upon a method call
• When the stop condition depends on an object property, since such properties could change during the execution of the loop.

Noncompliant Code Example

for ($i = 0; $i < 10; $i++) {
  echo $i;
  if(condition) {
    $i = 20;
  }
}

Compliant Solution

for ($i = 0; $i < 10; $i++) {
  echo $i;
}

See

• MISRA C:2004, 13.6 - Numeric variables being used within a for loop for iteration counting shall not be modified in the body of the loop.
• MISRA C++:2008, 6-5-3 - The loop-counter shall not be modified within condition or statement.

Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

See

• Cognitive Complexity

Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

Noncompliant Code Example

With the default threshold of 3:

function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

Compliant Solution

ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

Exceptions

To prevent generating some false-positives, literals having less than 5 characters are excluded.

A for loop stop condition should test the loop counter against an invariant value (i.e. one that is true at both the beginning and ending of every loop iteration). Ideally, this means that the stop condition is set to a local variable just before the loop begins.

Stop conditions that are not invariant are slightly less efficient, as well as being difficult to understand and maintain, and likely lead to the introduction of errors in the future.

This rule tracks three types of non-invariant stop conditions:

• When the loop counters are updated in the body of the for loop
• When the stop condition depend upon a method call
• When the stop condition depends on an object property, since such properties could change during the execution of the loop.

Noncompliant Code Example

for ($i = 0; $i < 10; $i++) {
  echo $i;
  if(condition) {
    $i = 20;
  }
}

Compliant Solution

for ($i = 0; $i < 10; $i++) {
  echo $i;
}

See

• MISRA C:2004, 13.6 - Numeric variables being used within a for loop for iteration counting shall not be modified in the body of the loop.
• MISRA C++:2008, 6-5-3 - The loop-counter shall not be modified within condition or statement.

A for loop stop condition should test the loop counter against an invariant value (i.e. one that is true at both the beginning and ending of every loop iteration). Ideally, this means that the stop condition is set to a local variable just before the loop begins.

Stop conditions that are not invariant are slightly less efficient, as well as being difficult to understand and maintain, and likely lead to the introduction of errors in the future.

This rule tracks three types of non-invariant stop conditions:

• When the loop counters are updated in the body of the for loop
• When the stop condition depend upon a method call
• When the stop condition depends on an object property, since such properties could change during the execution of the loop.

Noncompliant Code Example

for ($i = 0; $i < 10; $i++) {
  echo $i;
  if(condition) {
    $i = 20;
  }
}

Compliant Solution

for ($i = 0; $i < 10; $i++) {
  echo $i;
}

See

• MISRA C:2004, 13.6 - Numeric variables being used within a for loop for iteration counting shall not be modified in the body of the loop.
• MISRA C++:2008, 6-5-3 - The loop-counter shall not be modified within condition or statement.

A for loop stop condition should test the loop counter against an invariant value (i.e. one that is true at both the beginning and ending of every loop iteration). Ideally, this means that the stop condition is set to a local variable just before the loop begins.

Stop conditions that are not invariant are slightly less efficient, as well as being difficult to understand and maintain, and likely lead to the introduction of errors in the future.

This rule tracks three types of non-invariant stop conditions:

• When the loop counters are updated in the body of the for loop
• When the stop condition depend upon a method call
• When the stop condition depends on an object property, since such properties could change during the execution of the loop.

Noncompliant Code Example

for ($i = 0; $i < 10; $i++) {
  echo $i;
  if(condition) {
    $i = 20;
  }
}

Compliant Solution

for ($i = 0; $i < 10; $i++) {
  echo $i;
}

See

• MISRA C:2004, 13.6 - Numeric variables being used within a for loop for iteration counting shall not be modified in the body of the loop.
• MISRA C++:2008, 6-5-3 - The loop-counter shall not be modified within condition or statement.