Add new Performance/ConditionalDefinition
cop
#499
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's a well-known pattern of defining methods conditionally, especially in gems:
If
foo
is a hotspot, its performance can be improved (see benchmarks below) by moving the conditional logic outside the method body definition:I'd like to propose a new
Performance/ConditionalDefinition
cop that detects conditional method definitions, as described above. We can start by matching constant expressions such as{RUBY_VERSION,RUBY_RELEASE_DATE,...} <op> ...
, and generalize the detection logic later.I'm not an expert in YJIT (or any other MRI JIT compiler), but AFAIK even when YJIT determines that
RUBY_VERSION <op> ...
is constant, it still needs to check a guard clause for every method call. So there's still a performance improvement:NOTE: This is a WIP, and the cop is not yet ready -- at this point I just want to get feedback on the idea so I can continue working on it.
Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).bundle exec rake default
. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.md
if the new code introduces user-observable changes. See changelog entry format for details.