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

Make Lint/NonDeterministicRequireOrder not to register offense for Ruby 3 #9300

Conversation

koic
Copy link
Member

@koic koic commented Dec 28, 2020

Dir.glob and Dir[] sort the results by default in Ruby 3.0.

This PR will make not to register an offense when using Ruby 3.0.

So users don't need this cop when using Ruby 3.0.
It can be deprecated when supporting only Ruby 3.0 and higher.

I will open a PR about a new cop against Dir.glob.sort and Dir[].sort, which became redundant in Ruby 3.0.


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.

@koic koic mentioned this pull request Dec 28, 2020
8 tasks
koic added a commit to koic/rubocop that referenced this pull request Dec 29, 2020
Sort globbed results by default in Ruby 3.0.
https://bugs.ruby-lang.org/issues/8709

This PR adds new `Lint/RedundantDirGlobSort` cop.
It checks for redundant `sort` method to `Dir.glob` and `Dir[]`.

```ruby
# bad
Dir.glob('./lib/**/*.rb').sort.each do |file|
end

Dir['./lib/**/*.rb'].sort.each do |file|
end

# good
Dir.glob('./lib/**/*.rb').each do |file|
end

Dir['./lib/**/*.rb'].each do |file|
end

# good - Respect intent if `sort` keyword option is specified.
Dir.glob('./lib/**/*.rb', sort: false).each do |file|
end
```

Related PR rubocop#9300.
…Ruby 3

`Dir.glob` and `Dir[]` sort the results by default in Ruby 3.0.

- https://bugs.ruby-lang.org/issues/8709
- ruby/ruby@2f1081a

This PR will make not to register an offense when using Ruby 3.0.

So users don't need this cop when using Ruby 3.0.
It can be deprecated when supporting only Ruby 3.0 and higher.

I will open a PR about a new cop against `Dir.glob.sort` and `Dir[]`.sort,
which became redundant in Ruby 3.0.
@koic koic force-pushed the change_make_deterministic_require_order_not_to_register_offense_for_ruby3 branch from e2110e1 to 7ac1922 Compare December 29, 2020 02:23
bbatsov pushed a commit that referenced this pull request Dec 31, 2020
Sort globbed results by default in Ruby 3.0.
https://bugs.ruby-lang.org/issues/8709

This PR adds new `Lint/RedundantDirGlobSort` cop.
It checks for redundant `sort` method to `Dir.glob` and `Dir[]`.

```ruby
# bad
Dir.glob('./lib/**/*.rb').sort.each do |file|
end

Dir['./lib/**/*.rb'].sort.each do |file|
end

# good
Dir.glob('./lib/**/*.rb').each do |file|
end

Dir['./lib/**/*.rb'].each do |file|
end

# good - Respect intent if `sort` keyword option is specified.
Dir.glob('./lib/**/*.rb', sort: false).each do |file|
end
```

Related PR #9300.
@bbatsov bbatsov merged commit 6896bd9 into rubocop:master Dec 31, 2020
@bbatsov
Copy link
Collaborator

bbatsov commented Dec 31, 2020

Thanks!

@koic koic deleted the change_make_deterministic_require_order_not_to_register_offense_for_ruby3 branch December 31, 2020 07:58
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.

2 participants