[Fix #9793] Add Style/QuotedSymbols to enforce consistency in quoted symbols #9809
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…n quoted symbols. Like `Style/StringLiterals`, this cop checks for the quoting style for symbols to be consistent. Checking whether a symbol _should_ be quoted or not is still handled by `Lint/SymbolConversion`. This cop shares as much as possible with `Style/StringLiterals` for ease of maintainabilty. As well, for simple configuration, the default "style" is `same_as_string_literals` which will automatically apply the same configuration set up for `Style/StringLiterals` to this cop as well (it defaults to `single_quotes` if `StringLiterals` is not enabled).
…e `Style/QuotedSymbols` can now correct those to the correct quotes as per configuration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Like
Style/StringLiterals, this cop checks for the quoting style for symbols to be consistent. Checking whether a symbol should be quoted or not is still handled byLint/SymbolConversion.This cop shares as much as possible with
Style/StringLiteralsfor ease of maintainabilty. As well, for simple configuration, the default "style" issame_as_string_literalswhich will automatically apply the same configuration set up forStyle/StringLiteralsto this cop as well (it defaults tosingle_quotesifStringLiteralsis not enabled).Additionally,
Lint/SymbolConversionno longer tries to figure out what quote type to use fromStyle/StringLiterals' configuration. Instead, it always inserts a double quote (since that's always "safe"), and allows this new cop to handle the quoting.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.