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

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

        consistency - conventional
        maintainability
        Code Smell
        • rails
        • activerecord
        • convention

        This rule raises an issue when where(…​).take is used to retrieve a single record by attributes.

        Why is this an issue?

        How can I fix it?

        More Info

        Using where(…​).take for single record retrieval is less semantic and readable compared to find_by. The find_by method clearly expresses the intent to find a single record by specific attributes and return nil if not found.

        The where.take pattern requires readers to understand that:

        • where creates a query scope
        • take retrieves the first record from that scope
        • The combination returns nil if no record matches

        In contrast, find_by makes this intent explicit and follows Rails conventions. It’s the idiomatic way to retrieve a single record by attributes in ActiveRecord.

        Using find_by also makes code more consistent with Rails style guidelines and community best practices, improving maintainability and reducing cognitive load for developers familiar with Rails conventions.

        What is the potential impact?

        This issue affects code readability and maintainability. While both approaches have similar performance characteristics, using non-idiomatic patterns can:

        • Make code harder to understand for developers familiar with Rails conventions
        • Reduce consistency across the codebase
        • Increase cognitive load when reading and maintaining the code

        The impact is primarily on code quality rather than functionality, as both patterns produce the same results.

          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