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 #1071] Mark Rails/FilePath unsafe because of interaction with root filepath #1400

Conversation

corsonknowles
Copy link

@corsonknowles corsonknowles commented Dec 23, 2024

Here, we add the requested @safety annotation for Rails/FilePath since it can produce invalid code like this:

pass any string argument beginning with '/' to Rails.root.join and it will omit the Rails path

(dev)> Rails.root.join '/'
=> #<Pathname:/>
(dev)> Rails.root.join '//'
=> #<Pathname://>
(dev)> Rails.root.join '/abc'
=> #<Pathname:/abc>
(dev)> Rails.root.join '/abc/'
=> #<Pathname:/abc/>

This partly addresses: #1071

See:

See also:

This will not be amended in Rails, so the responsibility for the autocorrect behavior falls on Rubocop.


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.

@corsonknowles corsonknowles force-pushed the fix_safety_declaration_for_file_path branch from b193fd3 to c559f7a Compare December 23, 2024 06:38
@corsonknowles corsonknowles changed the title [Fix #1177] Partially fix Rails/FilePath autocorrect for root filepaths by marking cop as unsafe for autocorrection [Fix #1071] Partially fix Rails/FilePath autocorrect for root filepaths by marking cop as unsafe for autocorrection Dec 23, 2024
@corsonknowles corsonknowles force-pushed the fix_safety_declaration_for_file_path branch from c559f7a to e00b21f Compare December 23, 2024 06:55
@corsonknowles corsonknowles changed the title [Fix #1071] Partially fix Rails/FilePath autocorrect for root filepaths by marking cop as unsafe for autocorrection [Fix #1071] Mark `Rails/FilePath unsafe for autocorrection because of its effect on root filepathes Feb 2, 2025
@corsonknowles corsonknowles changed the title [Fix #1071] Mark `Rails/FilePath unsafe for autocorrection because of its effect on root filepathes [Fix #1071] Mark Rails/FilePath unsafe for autocorrection because of its effect on root filepath Feb 2, 2025
@corsonknowles
Copy link
Author

corsonknowles commented Feb 2, 2025

This came up while I was working on fixing all safely auto-correctable Rubocop rules in our code base.

Example problems:

relative_path = absolute_path.delete_prefix("#{Rails.root}/") # rubocop:disable Rails/FilePath

path&.start_with?("#{Rails.root}/") # rubocop:disable Rails/FilePath

@corsonknowles
Copy link
Author

@Earlopain Are we doing the right thing here?

@corsonknowles corsonknowles changed the title [Fix #1071] Mark Rails/FilePath unsafe for autocorrection because of its effect on root filepath [Fix #1071] Mark Rails/FilePath unsafe because of its effect on root filepath Feb 3, 2025
@corsonknowles corsonknowles changed the title [Fix #1071] Mark Rails/FilePath unsafe because of its effect on root filepath [Fix #1071] Mark Rails/FilePath unsafe because of its interaction with root filepath Feb 3, 2025
@corsonknowles corsonknowles changed the title [Fix #1071] Mark Rails/FilePath unsafe because of its interaction with root filepath [Fix #1071] Mark Rails/FilePath unsafe because of interaction with root filepath Feb 3, 2025
…filepaths by marking cop as unsafe for autocorrection

We correctly add a @safety annotation for Rails/FilePath since it can produce invalid code like this:

# pass any string argument beginning with '/' to Rails.root.join and it will omit the Rails path

(dev)> Rails.root.join '/'
=> #<Pathname:/>
(dev)> Rails.root.join '//'
=> #<Pathname://>
(dev)> Rails.root.join '/abc'
=> #<Pathname:/abc>
(dev)> Rails.root.join '/abc/'
=> #<Pathname:/abc/>
@corsonknowles corsonknowles force-pushed the fix_safety_declaration_for_file_path branch from e00b21f to a2e38f9 Compare February 3, 2025 11:02
@koic
Copy link
Member

koic commented Feb 3, 2025

Can you add concrete example code in the safety section of the documentation and add a changelog entry?

@@ -492,6 +492,7 @@ Rails/FilePath:
VersionAdded: '0.47'
VersionChanged: '2.4'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
VersionChanged: '2.4'
VersionChanged: '<<next>>'

@koic
Copy link
Member

koic commented Feb 3, 2025

This PR will be closed to take the approach of ignoring unsafe cases proposed in #1433. Thank you.

@koic koic closed this Feb 3, 2025
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