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 Rails/RootPathnameMethods autocorrection safe #993

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

r7kamura
Copy link
Contributor

The safety section states the following:

This cop is unsafe for autocorrection because Dir's children, each_child, entries, and glob methods return string element, but these methods of Pathname return Pathname element.

If so, it should be possible to append .map(&:to_s) on autocorrection so that the behavior does not change before and after the autocorrection, and I thought that more users would be helped by providing such a safe autocorrection logic.

In addition, I found that autocorrection to some File singleton methods is also unsafe, which has not been mentioned in the safety section. I thought it would be better to append .to_s to safely handle these cases as well.


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.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@r7kamura r7kamura force-pushed the root-pathname-safe-autocorrect branch from a903b09 to 4e1e7e3 Compare April 26, 2023 00:12
@r7kamura
Copy link
Contributor Author

r7kamura commented Apr 26, 2023

I tried this change on a larger project and found another incompatibility between Pathname#join and File.join.

$ irb -r pathname
irb(main):001:0> Pathname.new("foo").join("/bar").to_s
=> "/bar"
irb(main):002:0> File.join("foo", "/bar")
=> "foo/bar"

I created a separate pull request for this:

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.

1 participant