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 #9773] Fix Style/EmptyLiteral to not register offenses for String.new when Style/FrozenStringLiteral is enabled #9774

Merged
merged 1 commit into from May 5, 2021

Conversation

dvandersluis
Copy link
Member

Style/EmptyLiteral replaces String.new with '', unless the file has a frozen-string-literal: true magic comment. However, if Style/FrozenStringLiteral is also enabled, this will cause broken code, because the magic comment will be added afterwards.

This change makes string behaviour the same if Style/FrozenStringLiteral is enabled as if the magic comment is found. However, if Style/FrozenStringLiteral is enabled but there is a frozen-string-literal: false magic comment, Style/EmptyLiteral will continue to replace the literal.

Fixes #9773.


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.

…for `String.new` when `Style/FrozenStringLiteral` is enabled.
@adfoster-r7
Copy link

Ran this against our codebase and it worked great - thanks for looking into this! 👍

@koic koic merged commit 4a4ad98 into rubocop:master May 5, 2021
@koic
Copy link
Member

koic commented May 5, 2021

Cool👍 This solution approach to the issue seems to make sense!

@dvandersluis dvandersluis deleted the issue/9773 branch September 14, 2021 16:04
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.

Style/EmptyLiteral and frozen_string_literal generate broken code
4 participants