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

Recover Ruby 2.2 code analysis using TargetRubyVersion: 2.2 #10644

Merged
merged 1 commit into from May 23, 2022

Conversation

koic
Copy link
Member

@koic koic commented May 17, 2022

Follow up #10632 (comment).

Reverts part of #6766, #7026, and #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 #10626, #10632, and #10640.

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

# @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.


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.

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.
@bbatsov
Copy link
Collaborator

bbatsov commented May 18, 2022

Not sure if we need to go back so far, as I doubt there are many projects that still target such an old Ruby release. I'll leave this up to you to decide. Personally I was happy when we got back to 2.5. :D

@koic
Copy link
Member Author

koic commented May 18, 2022

I found the following backlink in PR #10632 that recovered Ruby 2.4 code analysis.
brianmario/mysql2#1256

So, there seems to be use case with gems that support older Ruby versions. Perhaps RuboCop's analysis can recover up to Ruby 1.9 code. I'm trying it, but I'm not sure if it's the best 😅

@koic koic merged commit 966cda8 into rubocop:master May 23, 2022
@koic koic deleted the recover_ruby_22 branch May 23, 2022 02:53
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.
koic added a commit to koic/rubocop-rails that referenced this pull request Jun 2, 2022
koic added a commit that referenced this pull request Nov 30, 2022
Follow #10644.

It's a redundant condition because Ruby 2.2- is not supported as a runtime version.
Recovered with #10644 is an analysis version.
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.

None yet

2 participants