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

Add new Lint/RedundantDirGlobSort cop #9301

Merged

Conversation

koic
Copy link
Member

@koic koic commented Dec 28, 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[].

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


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 force-pushed the add_new_lint_redundant_dir_glob_sort_cop branch from a4b38b2 to 3021748 Compare December 28, 2020 15:38
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.
@koic koic force-pushed the add_new_lint_redundant_dir_glob_sort_cop branch from 3021748 to adfea8c Compare December 29, 2020 02:23
@bbatsov bbatsov merged commit 8389cb8 into rubocop:master Dec 31, 2020
@bbatsov
Copy link
Collaborator

bbatsov commented Dec 31, 2020

Nicely done!

@koic koic deleted the add_new_lint_redundant_dir_glob_sort_cop 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.

None yet

2 participants