Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix #10258] Recover Ruby 2.4 code analysis using TargetRubyVersion: 2.4 #10632

Merged
merged 1 commit into from May 13, 2022

Conversation

koic
Copy link
Member

@koic koic commented May 13, 2022

Fixes #10258 and reverts part of #9648.

Only the Ruby version (2.4) to runtime should have been dropped, not code analysis.
This PR makes Ruby 2.4 code analysis with TargetRubyVersion: 2.4.
So, this keeps it compatible with TargetRubyVersion up to RuboCop 1.12.1 as semver.

It aims to solve essentially the same problem as #10626.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

…ersion: 2.4`

Fixes rubocop#10258 and reverts part of rubocop#9648.

Only the Ruby version (2.4) to runtime should have been dropped,
not code analysis.
This PR makes Ruby 2.4 code analysis with `TargetRubyVersion: 2.4`.
So, this keeps it compatible with `TargetRubyVersion` up to
RuboCop 1.12.1 as semver.

It aims to solve essentially the same problem as rubocop#10626.
@koic koic changed the title [Fix #10258] Analyze Ruby 2.4 code with TargetRubyVersion: 2.4 [Fix #10258] Recover Ruby 2.4 code analysis using TargetRubyVersion: 2.4 May 13, 2022
@bbatsov bbatsov merged commit a5c1bc4 into rubocop:master May 13, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented May 13, 2022

Thanks!

@bbatsov
Copy link
Collaborator

bbatsov commented May 13, 2022

I'm thinking we should also update the compatibility docs to mention separately the runtime support and the analysis support for the various releases.

@koic koic deleted the analyze_ruby_24_code branch May 13, 2022 10:43
@koic
Copy link
Member Author

koic commented May 13, 2022

Yeah. OTOH, I will try to recover as much as possible to analysis the old Ruby versions code.

koic added a commit to koic/rubocop-ast that referenced this pull request May 13, 2022
RuboCop can analyze Ruby 1.9 or later. But now it turns out that RuboCop
hasn't been able to parse older Ruby versions.
https://docs.rubocop.org/rubocop/1.29/compatibility.html#support-matrix

Analysis Ruby code and runtime Ruby versions are different.
So, only runtime version should have been dropped.

This PR makes it possible to parse older Ruby versions that were
accidentally dropped before RuboCop AST was separated from RuboCop core.

With this fix, the following recovery work will be possible.

- Recover for Ruby 2.5 analysis: rubocop/rubocop#10626
- Recover for Ruby 2.4 analysis: rubocop/rubocop#10632
marcandre pushed a commit to rubocop/rubocop-ast that referenced this pull request May 13, 2022
RuboCop can analyze Ruby 1.9 or later. But now it turns out that RuboCop
hasn't been able to parse older Ruby versions.
https://docs.rubocop.org/rubocop/1.29/compatibility.html#support-matrix

Analysis Ruby code and runtime Ruby versions are different.
So, only runtime version should have been dropped.

This PR makes it possible to parse older Ruby versions that were
accidentally dropped before RuboCop AST was separated from RuboCop core.

With this fix, the following recovery work will be possible.

- Recover for Ruby 2.5 analysis: rubocop/rubocop#10626
- Recover for Ruby 2.4 analysis: rubocop/rubocop#10632
koic added a commit to koic/rubocop-performance that referenced this pull request May 15, 2022
koic added a commit to koic/rubocop-performance that referenced this pull request May 15, 2022
koic added a commit to koic/rubocop that referenced this pull request May 16, 2022
Follow up rubocop#10632 (comment).

Reverts part of rubocop#7869 and rubocop#8056.

Only the Ruby version (2.3) to runtime should have been dropped, not
code analysis.
This PR makes Ruby 2.3 code analysis with `TargetRubyVersion: 2.3`.
It aims to solve essentially the same problem as rubocop#10626 and 10632.

And this change requires RuboCop AST 1.18 or later:
rubocop/rubocop-ast#233
koic added a commit to koic/rubocop that referenced this pull request May 18, 2022
Follow up rubocop#10632 (comment).

Reverts part of rubocop#6766, rubocop#7026, and rubocop#7030.

Only the Ruby version (2.2) to runtime should have been dropped, not code analysis.
This PR makes Ruby 2.2 code analysis with `TargetRubyVersion: 2.2`.
It aims to solve essentially the same problem as rubocop#10626, rubocop#10632, and rubocop#10640.

Previously, there was the following default enforced style `when_needed` for
`Style/FrozenStringLiteralComment` cop.

```ruby
# @example EnforcedStyle: when_needed (default)
#   # The `when_needed` style will add the frozen string literal
#   # to files only when the `TargetRubyVersion` is set to 2.3+.
#   # bad
#   module Foo
#     # ...
#   end
#
#   # good
#   # frozen_string_literal: true
#
#   module Foo
#     # ...
#   end
```

This PR does not restore that option, but sets the `minimum_target_ruby_version 2.3`
to make `always (default)` apply by default. It is a simple solution that does not
handle frozen literal magic comment added in Ruby 2.3 when `TargetRubyVersion` is
Ruby 2.2 or lower.
koic added a commit to koic/rubocop that referenced this pull request May 23, 2022
Follow up rubocop#10632 (comment).

Reverts part of rubocop#5990 and rubocop#6101.

Only the Ruby version (2.1) to runtime should have been dropped, not code analysis.
This PR makes Ruby 2.1 code analysis with `TargetRubyVersion: 2.1`.
It aims to solve essentially the same problem as rubocop#10626, rubocop#10632, rubocop#10640, and rubocop#10644.
bbatsov pushed a commit that referenced this pull request May 25, 2022
Follow up #10632 (comment).

Reverts part of #5990 and #6101.

Only the Ruby version (2.1) to runtime should have been dropped, not code analysis.
This PR makes Ruby 2.1 code analysis with `TargetRubyVersion: 2.1`.
It aims to solve essentially the same problem as #10626, #10632, #10640, and #10644.
koic added a commit to koic/rubocop that referenced this pull request May 25, 2022
Follow up rubocop#10632 (comment).

Reverts part of rubocop#4787.

Only the Ruby version (2.0) to runtime should have been dropped, not code analysis.
This PR makes Ruby 2.0 code analysis with `TargetRubyVersion: 2.0`.
It aims to solve essentially the same problem as rubocop#10626, rubocop#10632, rubocop#10640, rubocop#10644, and rubocop#10662.
bbatsov pushed a commit that referenced this pull request May 25, 2022
Follow up #10632 (comment).

Reverts part of #4787.

Only the Ruby version (2.0) to runtime should have been dropped, not code analysis.
This PR makes Ruby 2.0 code analysis with `TargetRubyVersion: 2.0`.
It aims to solve essentially the same problem as #10626, #10632, #10640, #10644, and #10662.
@thomthom
Copy link
Contributor

Has runtime analysis always been decoupled from TargetRubyVersion, or is that new?

I'm curious because I work against Ruby that is embedded in an desktop application, meaning I have to support a wide range of Ruby versions on the same code-base.

I've these RuboCop configs: TargetRubyVersion: 2.5 # Should be 2.2, but RuboCop only support 2.3+.

Having runtime support decoupled from static analysis support is a big double thumbs up from me! 👍👍

@koic koic mentioned this pull request May 30, 2022
8 tasks
koic added a commit to koic/rubocop that referenced this pull request May 30, 2022
Follow up rubocop#10632 (comment).

RuboCop targets Ruby 2.0+ code analysis since RuboCop 1.30.
This PR tweaks docs about target Ruby version.

NOTE: Ruby 1.9 code analysis is not restored because its some incompatibilities with
Ruby 2.0+ cops. It may not be worth the maintenance cost.
bbatsov pushed a commit that referenced this pull request May 30, 2022
Follow up #10632 (comment).

RuboCop targets Ruby 2.0+ code analysis since RuboCop 1.30.
This PR tweaks docs about target Ruby version.

NOTE: Ruby 1.9 code analysis is not restored because its some incompatibilities with
Ruby 2.0+ cops. It may not be worth the maintenance cost.
renawatson68 added a commit to renawatson68/performance-develop-rubyonrails that referenced this pull request Sep 23, 2022
richardstewart0213 added a commit to richardstewart0213/performance-build-Performance-optimization-analysis- that referenced this pull request Nov 4, 2022
MarttiCheng added a commit to MarttiCheng/Rubocop-Performance that referenced this pull request Sep 28, 2023
SerhiiMisiura added a commit to SerhiiMisiura/Rubocop-Performance that referenced this pull request Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Errors thrown from Layout/BlockAlignment cop when running with ruby-head
3 participants