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
Filtered: 19 rules found
convention
    Impact
      Clean code attribute
        1. Modules should use "extend self" instead of "module_function"

           Code Smell
        2. Array and hash literals should be used instead of constructors when no parameters are needed

           Code Smell
        3. Logical operators "and" and "or" should be replaced with "&&" and "||"

           Code Smell
        4. Private methods should be declared at the end of Ruby classes

           Code Smell
        5. Predicate methods should not use redundant "is_" prefix

           Code Smell
        6. Controllers should inherit from appropriate base classes

           Code Smell
        7. Rails model callback methods should be private

           Code Smell
        8. Rails collections should use "ids" instead of "pluck(:id)" for primary keys

           Code Smell
        9. Rails queries should use "find_by" instead of "where.take" for single record retrieval

           Code Smell
        10. Safe navigation operator should be preferred over ActiveSupport's "try!"

           Code Smell
        11. Use "require_relative" instead of "require" for loading local files

           Code Smell
        12. Require statements should be placed at the top of files

           Code Smell
        13. Track lack of copyright and license headers

           Code Smell
        14. Statements should be on separate lines

           Code Smell
        15. Function and block parameter names should comply with a naming convention

           Code Smell
        16. Tabulation characters should not be used

           Code Smell
        17. Lines should not be too long

           Code Smell
        18. Class names should comply with a naming convention

           Code Smell
        19. Method names should comply with a naming convention

           Code Smell

        Use "require_relative" instead of "require" for loading local files

        consistency - conventional
        reliability
        maintainability
        Code Smell
        • convention

        This rule raises an issue when require is used with relative paths to load local files instead of using require_relative or explicit path construction.

        Why is this an issue?

        How can I fix it?

        More Info

        When requiring local files in Ruby, using require with relative paths creates fragile code that depends on the current working directory and Ruby’s load path configuration.

        The require method resolves paths by searching through Ruby’s load path ($LOAD_PATH) and the current working directory. However, since Ruby 1.9, the current directory (".") was removed from the default load path for security reasons. This means that require 'local_file' or require './local_file' will fail with a LoadError when the script is executed from a different directory or when the current directory is not explicitly added to the load path.

        This creates several problems:

        • Execution context dependency: The same script may work when run from one directory but fail when run from another
        • Deployment fragility: Code that works in development may break in production due to different execution contexts
        • Testing complications: Tests may pass or fail depending on the directory from which the test runner is executed
        • Maintenance burden: Developers may resort to modifying the global $LOAD_PATH or implementing workarounds, which pollutes the global state

        The issue is particularly common in Ruby applications where files need to load other files from the same project, such as utility modules, configuration files, or related classes.

        What is the potential impact?

        Applications may fail to start or function correctly when deployed or executed from different directories, leading to LoadError exceptions in production environments. This can cause service outages and make the codebase difficult to maintain and test reliably.

          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