Class: RuboCop::Cop::Style::RedundantLineContinuation
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/redundant_line_continuation.rb |
Overview
Check for redundant line continuation.
This cop marks a line continuation as redundant if removing the backslash does not result in a syntax error. However, a backslash at the end of a comment or for string concatenation is not redundant and is not considered an offense.
Constant Summary
-
ALLOWED_STRING_TOKENS =
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 74%i[tSTRING tSTRING_CONTENT].freeze
-
ARGUMENT_TAKING_FLOW_TOKEN_TYPES =
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 79%i[tIDENTIFIER kRETURN kBREAK kNEXT kYIELD].freeze
-
ARGUMENT_TYPES =
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 75%i[ kDEF kFALSE kNIL kSELF kTRUE tCONSTANT tCVAR tFLOAT tGVAR tIDENTIFIER tINTEGER tIVAR tLBRACK tLCURLY tLPAREN_ARG tSTRING tSTRING_BEG tSYMBOL tXSTRING_BEG ].freeze
-
LINE_CONTINUATION =
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 72'\\'
-
LINE_CONTINUATION_PATTERN =
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 73/(\\\n)/.freeze
-
MSG =
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 71'Redundant line continuation.'
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- 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 #on_new_investigation and |
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::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_new_investigation
- #argument_is_method?(node) ⇒ Boolean private
- #argument_newline?(node) ⇒ Boolean private
- #ends_with_backslash_without_comment?(source_line) ⇒ Boolean private
- #find_node_for_line(last_line) private
- #inside_string_literal?(range, token) ⇒ Boolean private
- #inside_string_literal_or_method_with_argument?(range) ⇒ Boolean private
- #inspect_end_of_ruby_code_line_continuation private
- #leading_dot_method_chain_with_blank_line?(range) ⇒ Boolean private
- #method_call_with_arguments?(node) ⇒ Boolean private
-
#method_with_argument?(current_token, next_token) ⇒ Boolean
private
A method call without parentheses such as the following cannot remove
\
: - #redundant_line_continuation?(range) ⇒ Boolean private
- #require_line_continuation?(range) ⇒ Boolean private
- #same_line?(node, line) ⇒ Boolean private
- #start_with_arithmetic_operator?(source_line) ⇒ Boolean private
- #string_concatenation?(source_line) ⇒ Boolean private
::RuboCop::Cop::MatchRange
- Included
#each_match_range | Return a new |
#match_range | For a |
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::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_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
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#argument_is_method?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 202
def argument_is_method?(node) return false unless node.send_type? return false unless (first_argument = node.first_argument) method_call_with_arguments?(first_argument) end
#argument_newline?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 166
def argument_newline?(node) node = node.to_a.last if node.assignment? return false if node.parenthesized_call? node = node.children.first if node.root? && node.begin_type? if argument_is_method?(node) argument_newline?(node.first_argument) else return false unless method_call_with_arguments?(node) node.loc.selector.line != node.first_argument.loc.line end end
#ends_with_backslash_without_comment?(source_line) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 106
def ends_with_backslash_without_comment?(source_line) source_line.gsub(/#.+/, '').end_with?('\\') end
#find_node_for_line(last_line) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 182
def find_node_for_line(last_line) processed_source.ast.each_node do |node| return node if node.respond_to?(:expression) && node.expression&.last_line == last_line end end
#inside_string_literal?(range, token) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 151
def inside_string_literal?(range, token) ALLOWED_STRING_TOKENS.include?(token.type) && token.pos.overlaps?(range) end
#inside_string_literal_or_method_with_argument?(range) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 114
def inside_string_literal_or_method_with_argument?(range) processed_source.tokens.each_cons(2).any? do |token, next_token| next if token.line == next_token.line inside_string_literal?(range, token) || method_with_argument?(token, next_token) end end
#inspect_end_of_ruby_code_line_continuation (private)
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 139
def inspect_end_of_ruby_code_line_continuation last_line = processed_source.lines[processed_source.ast.last_line - 1] return unless last_line.end_with?(LINE_CONTINUATION) last_column = last_line.length line_continuation_range = range_between(last_column - 1, last_column) add_offense(line_continuation_range) do |corrector| corrector.remove_trailing(line_continuation_range, 1) end end
#leading_dot_method_chain_with_blank_line?(range) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 122
def leading_dot_method_chain_with_blank_line?(range) return false unless range.source_line.strip.start_with?('.', '&.') processed_source[range.line].strip.empty? end
#method_call_with_arguments?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 209
def method_call_with_arguments?(node) node.call_type? && !node.arguments.empty? end
#method_with_argument?(current_token, next_token) ⇒ Boolean
(private)
A method call without parentheses such as the following cannot remove \
:
do_something \
argument
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 159
def method_with_argument?(current_token, next_token) return false unless ARGUMENT_TAKING_FLOW_TOKEN_TYPES.include?(current_token.type) ARGUMENT_TYPES.include?(next_token.type) end
#on_new_investigation
[ GitHub ]# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 81
def on_new_investigation return unless processed_source.ast each_match_range(processed_source.ast.source_range, LINE_CONTINUATION_PATTERN) do |range| next if require_line_continuation?(range) next unless redundant_line_continuation?(range) add_offense(range) do |corrector| corrector.remove_leading(range, 1) end end inspect_end_of_ruby_code_line_continuation end
#redundant_line_continuation?(range) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 128
def redundant_line_continuation?(range) return true unless (node = find_node_for_line(range.last_line)) return false if argument_newline?(node) source = node.source while (node = node.parent) source = node.source end parse(source.gsub("\\\n", "\n")).valid_syntax? end
#require_line_continuation?(range) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 98
def require_line_continuation?(range) !ends_with_backslash_without_comment?(range.source_line) || string_concatenation?(range.source_line) || start_with_arithmetic_operator?(processed_source[range.line]) || inside_string_literal_or_method_with_argument?(range) || leading_dot_method_chain_with_blank_line?(range) end
#same_line?(node, line) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 188
def same_line?(node, line) return false unless (source_range = node.source_range) if node.is_a?(AST::StrNode) if node.heredoc? (node.loc.heredoc_body.line..node.loc.heredoc_body.last_line).cover?(line) else (source_range.line..source_range.last_line).cover?(line) end else source_range.line == line end end
#start_with_arithmetic_operator?(source_line) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 213
def start_with_arithmetic_operator?(source_line) %r{\A\s*[+\-*/%]}.match?(source_line) end
#string_concatenation?(source_line) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/redundant_line_continuation.rb', line 110
def string_concatenation?(source_line) /["']\s*\\\z/.match?(source_line) end