Class: RuboCop::Cop::Style::EmptyStringInsideInterpolation
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
::RuboCop::Cop::AutoCorrector,
::RuboCop::Cop::Base,
::RuboCop::ExcludeLimit,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
|
Instance Chain:
|
|
| Inherits: |
RuboCop::Cop::Base
|
| Defined in: | lib/rubocop/cop/style/empty_string_inside_interpolation.rb |
Overview
Checks for empty strings being assigned inside string interpolation.
Empty strings are a meaningless outcome inside of string interpolation, so we remove them. Alternatively, when configured to do so, we prioritise using empty strings.
While this cop would also apply to variables that are only going to be used as strings, RuboCop can’t detect that, so we only check inside of string interpolation.
Constant Summary
-
INTERPOLATED_TYPES =
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 48%i[dstr dsym regexp xstr].freeze
-
MSG_TERNARY =
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 46'Do not return empty strings in string interpolation.' -
MSG_TRAILING_CONDITIONAL =
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 45'Do not use trailing conditionals in string interpolation.'
::RuboCop::Cop::Base - Inherited
DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector - Extended
::RuboCop::Cop::Base - Inherited
| .gem_requirements, .lint?, | |
| .support_autocorrect? | Returns if class supports autocorrect. |
| .support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::Base - Inherited
| .autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
| .badge | Naming. |
| .callbacks_needed, .cop_name, .department, | |
| .documentation_url | Returns a url to view this cops documentation online. |
| .exclude_from_registry | Call for abstract Cop classes. |
| .inherited, | |
| .joining_forces | Override and return the Force class(es) you need to join. |
| .match? | Returns true if the cop name or the cop namespace matches any of the given names. |
| .new, | |
| .requires_gem | Register a version requirement for the given gem name. |
| .restrict_on_send | Reserved for Commissioner. |
::RuboCop::ExcludeLimit - Extended
| exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
| transform | |
Instance Attribute Summary
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::Base - Inherited
| #active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?, | |
| #preview? | Whether the user opted in to unstable behavior, with |
| #processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements? | |
::RuboCop::Cop::AutocorrectLogic - Included
| #autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?, | |
| #skipped_unsafe_correction_with_disable_uncorrectable? | Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while |
| #contextual_autocorrect_held_back? | When LSP is enabled or the |
Instance Method Summary
- #on_interpolation(node)
- #autocorrect_to_ternary(corrector, if_node) private
- #command_call?(node) ⇒ Boolean private
- #empty_branch_outcome?(branch) ⇒ Boolean private
- #empty_else_outcome?(node) ⇒ Boolean private
- #empty_if_outcome?(node) ⇒ Boolean private
- #empty_string_conditional_in_condition?(if_node) ⇒ Boolean private
- #nested_trailing_conditional?(if_node) ⇒ Boolean private
- #ternary_branch_source(branch) private
- #ternary_correction(node, child_node) private
- #ternary_style_autocorrect(node, outcome, keyword) private
- #trailing_conditional_correction(child_node) private
::RuboCop::Cop::Interpolation - Included
| #on_dstr, | |
| #on_dsym | Alias for Interpolation#on_dstr. |
| #on_interpolation | Inspect the |
| #on_node_with_interpolations, | |
| #on_regexp | Alias for Interpolation#on_dstr. |
| #on_xstr | Alias for Interpolation#on_dstr. |
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::Base - Inherited
| #add_global_offense | Adds an offense that has no particular location. |
| #add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
| #begin_investigation | Called before any investigation. |
| #callbacks_needed | — grouped under the Commissioner heading above. |
| #cop_config | Configuration Helpers. |
| #cop_name, #excluded_file?, | |
| #external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
| #inspect, | |
| #message | Gets called if no message is specified when calling |
| #name | Alias for Base#cop_name. |
| #offenses, | |
| #on_investigation_end | Called after all on_… |
| #on_new_investigation | Called before all on_… |
| #on_other_file | Called instead of all on_… |
| #parse | There should be very limited reasons for a Cop to do it’s own parsing. |
| #parser_engine, | |
| #ready | Called between investigations. |
| #relevant_file?, | |
| #target_gem_version | Returns the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked). |
| #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
| #callback_argument | Reserved for Cop::Cop. |
| #complete_investigation | Called to complete an investigation. |
| #correct, #covering_disabled_range, #current_corrector, | |
| #current_offense_locations | Reserved for Commissioner: |
| #current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, | |
| #enabled_lines? | A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code. |
| #file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range, | |
| #reset_investigation | Actually private methods. |
| #suppression_reason | The |
| #use_corrector | |
::RuboCop::Cop::AutocorrectLogic - Included
::RuboCop::Cop::IgnoredNode - Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#autocorrect_to_ternary(corrector, if_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 92
def autocorrect_to_ternary(corrector, if_node) condition = if_node.condition.source branch = ternary_branch_source(if_node.if_branch) outcomes = if_node.unless? ? "'' : #{branch}" : "#{branch} : ''" corrector.replace(if_node, "#{condition} ? #{outcomes}") end
#command_call?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 109
def command_call?(node) return false unless node.type?(:call, :super, :yield) && node.arguments? return false if node.call_type? && (node.operator_method? || node.setter_method?) !node.parenthesized? end
#empty_branch_outcome?(branch) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 124
def empty_branch_outcome?(branch) return false unless branch branch.nil_type? || (branch.str_type? && branch.value.empty?) end
#empty_else_outcome?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 120
def empty_else_outcome?(node) empty_branch_outcome?(node.else_branch) end
#empty_if_outcome?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 116
def empty_if_outcome?(node) empty_branch_outcome?(node.if_branch) end
#empty_string_conditional_in_condition?(if_node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 142
def empty_string_conditional_in_condition?(if_node) if_node.condition.each_descendant(:if).any? do |node| next false if node.modifier_form? || !node.parent.parent&.type?(*INTERPOLATED_TYPES) empty_if_outcome?(node) || empty_else_outcome?(node) end end
#nested_trailing_conditional?(if_node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 86
def nested_trailing_conditional?(if_node) if_node.each_descendant(:if).any? do |node| node.modifier_form? && node.parent.parent&.type?(*INTERPOLATED_TYPES) end end
#on_interpolation(node)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 50
def on_interpolation(node) node.each_child_node(:if) do |child_node| if style == :trailing_conditional trailing_conditional_correction(child_node) elsif style == :ternary ternary_correction(node, child_node) end end end
#ternary_branch_source(branch) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 100
def ternary_branch_source(branch) return branch.source unless command_call?(branch) arguments = branch.first_argument.source_range.join(branch.last_argument.source_range) method = branch.source_range.begin.join(arguments.begin).source.rstrip "#{method}(#{arguments.source})" end
#ternary_correction(node, child_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 76
def ternary_correction(node, child_node) return unless child_node.modifier_form? add_offense(node, message: MSG_TRAILING_CONDITIONAL) do |corrector| next if nested_trailing_conditional?(child_node) autocorrect_to_ternary(corrector, child_node) end end
#ternary_style_autocorrect(node, outcome, keyword) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 130
def ternary_style_autocorrect(node, outcome, keyword) add_offense(node, message: MSG_TERNARY) do |corrector| next if empty_string_conditional_in_condition?(node) head = node.source_range.begin.join(outcome.source_range.begin) tail = outcome.source_range.end.join(node.source_range.end) corrector.remove(head) corrector.replace(tail, " #{keyword} #{node.condition.source}") end end
#trailing_conditional_correction(child_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 62
def trailing_conditional_correction(child_node) # A modifier `if`/`unless` is already a trailing conditional and has # no `else` branch, so the ternary-to-trailing rewrite does not apply. return if child_node.modifier_form? if empty_if_outcome?(child_node) ternary_style_autocorrect(child_node, child_node.else_branch, 'unless') end return unless empty_else_outcome?(child_node) ternary_style_autocorrect(child_node, child_node.if_branch, 'if') end