The rule “Do not extend Data.define” is an important guideline in Ruby programming. Data.define is a method used to define a data type with specified fields, and it returns an anonymous class. Extending this anonymous class can lead to unpredictable behaviors and complications in your code, making it less maintainable and potentially introducing bugs.
It’s important because extending Data.define can lead to a lack of clarity about the hierarchy and structure of your classes. In addition, this practice can make the code more difficult to read and understand for other developers, thereby reducing the code’s maintainability.
Good coding practice dictates that you should avoid extending Data.define. Instead, you can assign the result of Data.define to a constant, and use this constant where needed in your code. For example, instead of writing class MyClass < Data.define(:field1, :field2), you should write MyClass = Data.define(:field1, :field2). This way, MyClass will be a clearly defined data type with the specified fields, and the code will be more readable and maintainable.
Non-Compliant Code Examples
classMyClass<Data.define(:field1,:field2)end
Compliant Code Examples
value=Data.define(:first_name,:last_name)
Seamless integrations. Try Datadog Code Analysis
Datadog Code Analysis
Try this rule and analyze your code with Datadog Code Analysis
How to use this rule
1
2
rulesets:- ruby-best-practices # Rules to enforce Ruby best practices.
Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
