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
-
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
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 |
::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
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#on_interpolation(node)
Metrics/MethodLength, Metrics/PerceivedComplexity.
- #empty_branch_outcome?(branch) ⇒ Boolean private
- #empty_else_outcome?(node) ⇒ Boolean private
- #empty_if_outcome?(node) ⇒ Boolean private
- #ternary_style_autocorrect(node, outcome, condition) 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, | |
#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 a gems locked versions (i.e. |
#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, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#empty_branch_outcome?(branch) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 86
def empty_branch_outcome?(branch) return false unless branch branch.nil_type? || (branch.literal? && branch.value.empty?) end
#empty_else_outcome?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 82
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 78
def empty_if_outcome?(node) empty_branch_outcome?(node.if_branch) end
#on_interpolation(node)
Metrics/MethodLength, Metrics/PerceivedComplexity
# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 49
def on_interpolation(node) node.each_child_node(:if) do |child_node| if style == :trailing_conditional if empty_if_outcome?(child_node) ternary_style_autocorrect(child_node, child_node.else_branch.source, 'unless') end if empty_else_outcome?(child_node) ternary_style_autocorrect(child_node, child_node.if_branch.source, 'if') end elsif style == :ternary next unless child_node.modifier_form? ternary_component = if child_node.unless? "'' : #{child_node.if_branch.source}" else "#{child_node.if_branch.source} : ''" end add_offense(node, message: MSG_TRAILING_CONDITIONAL) do |corrector| corrector.replace(node, "\#{#{child_node.condition.source} ? #{ternary_component}}") end end end end
#ternary_style_autocorrect(node, outcome, condition) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/empty_string_inside_interpolation.rb', line 92
def ternary_style_autocorrect(node, outcome, condition) add_offense(node, message: MSG_TERNARY) do |corrector| corrector.replace(node, "#{outcome} #{condition} #{node.condition.source}") end end