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] Partially fix Rails/FilePath autocorrect for root filepaths by marking cop as unsafe for autocorrection #1400

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

corsonknowles
Copy link

@corsonknowles corsonknowles commented Dec 23, 2024

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/>

See also:


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
…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 c559f7a to e00b21f Compare December 23, 2024 06:55
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