SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • ShellShell
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
Ruby

Ruby static code analysis

Unique rules to find Bugs, Security Hotspots, and Code Smells in your RUBY code

  • All rules 75
  • Bug17
  • Security Hotspot2
  • Code Smell56
 
Tags
    Impact
      Clean code attribute
        1. Before destroy callbacks should use proper halt mechanism

           Bug
        2. Rails applications should define a root route with proper controller#action syntax

           Bug
        3. Non-mutating sort methods should have their return values used

           Bug
        4. "return" statements should not be used in blocks

           Bug
        5. Rails API controllers using "respond_to" should include "ActionController::MimeResponds"

           Bug
        6. Environment variables should be validated or have default values

           Bug
        7. Regular expressions should not be passed to "String#include?"

           Bug
        8. Symbol keys containing hyphens should be quoted

           Bug
        9. Column names should not use SQL reserved words

           Bug
        10. ActiveRecord models should override "as_json" instead of "to_json" for custom JSON serialization

           Bug
        11. All branches in a conditional structure should not have exactly the same implementation

           Bug
        12. Non-existent operators like "=+" should not be used

           Bug
        13. Related "if/elsif" statements and "when" in a "case" should not have the same condition

           Bug
        14. Identical expressions should not be used on both sides of a binary operator

           Bug
        15. All code should be reachable

           Bug
        16. Variables should not be self-assigned

           Bug
        17. Useless "if true ..." and "if false ..." blocks should be removed

           Bug

        Symbol keys containing hyphens should be quoted

        intentionality - logical
        reliability
        maintainability
        Bug
        • syntax
        • confusing

        This rule raises an issue when unquoted symbol keys contain hyphens, which causes Ruby syntax errors.

        Why is this an issue?

        How can I fix it?

        More Info

        In Ruby, symbols are identifiers that start with a colon (:symbol). When you use a hyphen in an unquoted symbol like :data-role, Ruby interprets the hyphen as a subtraction operator instead of part of the symbol name.

        This means Ruby tries to subtract the variable role from the variable data, which typically results in an "undefined variable" error since these variables don’t exist.

        The problem stems from Ruby’s parsing rules: unquoted symbols can only contain letters, numbers, underscores, and certain special characters. Hyphens are not allowed because they conflict with the subtraction operator.

        What is the potential impact?

        This issue causes immediate syntax errors that prevent the application from running. The error messages can be confusing to developers, especially beginners, as they mention "undefined variable" rather than explaining the symbol syntax problem.

        In development, this leads to:

        • Application crashes with cryptic error messages
        • Wasted debugging time trying to understand why variables are "undefined"
        • Frustration for developers learning Ruby

        The impact is typically caught early since the code won’t run, but it can slow down development and create confusion about proper Ruby syntax.

          Available In:
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories

        © 2008-2025 SonarSource SA. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use