Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-1151

"switch case" clauses should not have too many lines of code

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
    • Message:
      Reduce this "[switch/CASE|CASE/WHEN]" number of lines from {} to at most {}, for example by extracting code into a [method|subroutine|function].
    • List of parameters:
      • key : max
      • Description: Maximum number of lines of code
      • Default value : 5
      • Default for PHP: 10
      • Default for T-SQL: 10
      • Type: Integer
    • Default Severity:
      Major
    • Impact:
      Low
    • Likelihood:
      High
    • Legacy Key:
      too-many-loc-in-case-clause
    • Targeted languages:
      ABAP, Cobol, JavaScript, PL/I, TypeScript
    • Covered Languages:
      C#, C, C++, Flex, Go, Java, Kotlin, Objective-C, PHP, PL/SQL, RPG, Ruby, Scala, Swift, T-SQL, VB.Net, VB6
    • Irrelevant for Languages:
      HTML, Python, XML
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      5min
    • Analysis Level:
      Syntactic Analysis
    • Analysis Scope:
      Main Sources
    • Common Rule:
      Yes
    • PMD:
      SwitchDensity

      Description

      The switch statement should be used only to clearly define some new branches in the control flow. As soon as a case clause contains too many statements this highly decreases the readability of the overall control flow statement. In such case, the content of the case clause should be extracted into a dedicated method.

      Noncompliant Code Example

      With the default threshold of 5:

      switch (myVariable) {
  case 0: // Noncompliant: 6 lines till next case
    methodCall1("");
    methodCall2("");
    methodCall3("");
    methodCall4("");
    break;
  case 1:
  ...
}

      Compliant Solution

      switch (myVariable) {
  case 0:                  
    doSomething()
    break;
  case 1:
  ...
}
...
private void doSomething(){
    methodCall1("");
    methodCall2("");
    methodCall3("");
    methodCall4("");
}

        Attachments

          Issue Links

          is duplicated by

          Finding Detection - RSPEC-137 Avoid switch case clause with too many lines of code

          • Closed
          is implemented by

          New Feature - A new feature of the product, which has yet to be developed. SONARABAP-351 Rule: "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARCOBOL-1493 Rule: "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. SONARPLI-168 Rule: "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. CPP-395 Rule: Switch cases should not have too many lines

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARRPG-12 Rule "WHEN" clauses should not have too many lines"

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARSLANG-46 Rule S1151: "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARSLANG-209 [Scala] Enable Rule: S1151 "match case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARSLANG-282 [Apex] Enable Rule: S1151 "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARSWIFT-126 Rule: "switch case" clauses should not have too many lines

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARTSQL-44 Rule: "WHEN" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARVB-283 Rule: "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARVBSIX-183 Rule: "[switch|case|CASE|WHEN]" clauses should not have too many lines

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARVBSIX-245 Rule: "switch case" clauses should not have too many lines of code

          • Major - Major loss of function.
          • Closed

          Task - A task that needs to be done. CPP-707 Create Objective-C rules repository containing targeted rules

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARABAP-207 Update title and description of rule "Switch cases should not have too many lines"

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARFLEX-87 Update "too many lines of code" rules to use LoC

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARPLSQL-489 Rule: "[switch|case|CASE|WHEN]" clauses should not have too many lines

          • Major - Major loss of function.
          • Closed
          is related to

          False-Positive - Unexpected issue reported by a rule CPP-2421 S1151: Fix FP linked to counting the outermost curly braces

          • Major - Major loss of function.
          • Closed
          links to

          Web Link Is implemented by sonar-csharp/issues/1170

          Web Link is implemented by sonar-go/issues/81

          Web Link Is implemented by SonarJS/issues/941

          Web Link Is implemented by SonarTS/issues/510

            Activity

              People

              • Assignee:
                evgeny.mandrikov Evgeny Mandrikov
                Reporter:
                freddy.mallet Freddy Mallet (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: