Skip to content

Suggestion: Rails/FilePath: Use Rails.root.join('path/to').to_path instead of .to_s . #1480

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

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

Conversation

kaibadash
Copy link

@kaibadash kaibadash commented May 16, 2025

Currently, Rails/FilePath recommends using Rails.root.join('app', 'models', 'goober').to_s, but would .to_path be more appropriate?
When we use .to_s, we expect to get its class name and address.

Example:

[1] pry(main)> User.first.to_s
=> “#<User:0x0000ffff7872b6e0>”

Similarly, I'm worried that Rails.root.join('app', 'models', 'goober').to_s might return that.
On the other hand, .to_path does not have this fear. It's an alias to to_s.
https://docs.ruby-lang.org/en/master/Pathname.html#method-i-to_path


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). : no related issues
  • 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.

@kaibadash kaibadash force-pushed the fix-rails-file-path-uses-to_path branch from fa1267e to 373bbe3 Compare May 16, 2025 09:02
@kaibadash kaibadash marked this pull request as ready for review May 16, 2025 09:02
@koic
Copy link
Member

koic commented May 20, 2025

The reasoning makes sense, but this seems like a style discussion that should be proposed (PR or issue) in the Rails Style Guide.
https://github.com/rubocop/rails-style-guide

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