Class: RuboCop::Cop::Layout::RedundantLineBreak
| 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/layout/redundant_line_break.rb |
Overview
Checks whether certain expressions, e.g. method calls, that could fit completely on a single line, are broken up into multiple lines unnecessarily.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 55'Redundant line break detected.'
::RuboCop::Cop::Base - Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ReparsedEquivalence - 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
- #single_line_block_chain_enabled? ⇒ Boolean readonly private
::RuboCop::Cop::Base - Inherited
::RuboCop::Cop::AutocorrectLogic - Included
Instance Method Summary
-
#on_csend(node)
Alias for #on_send.
- #on_lvasgn(node)
- #on_send(node) (also: #on_csend)
- #apply_reparse_correction(corrector, node) private
- #check_assignment(node, _rhs) private
- #configured_to_not_be_inspected?(node) ⇒ Boolean private
- #convertible_block?(node) ⇒ Boolean private
- #end_with_percent_blank_string?(processed_source) ⇒ Boolean private
-
#fold_string_concatenation(node)
private
Joining lines merges split string literals (
"a" \<newline> "b"into"ab") and turns mixed-quote pairs into+concatenation, which changes the tree but not the resulting string. - #index_access_call_chained?(node) ⇒ Boolean private
- #merge_plain_strings(chunk) private
- #merge_string_parts(parts) private
- #normalize_reparsed_ast(node) private
- #offense?(node) ⇒ Boolean private
- #other_cop_takes_precedence?(node) ⇒ Boolean private
- #plain_string?(node) ⇒ Boolean private
-
#preprocess_reparsed_source(source)
private
Joining lines shifts the value of any later
LINE, exactly as any other line-removing correction does; neutralize it on both sides with an identifier, which stays valid in every position the keyword can appear in. - #register_offense(node) private
- #require_backslash?(node) ⇒ Boolean private
- #string_concatenation_parts(node) private
- #stringish?(node) ⇒ Boolean private
::RuboCop::Cop::ReparsedEquivalence - Included
| #corrected_scope_fragment | The corrections' edits are all contained within the scope, so the corrected fragment can be cut out of the corrected source by adjusting for the edits' length delta. |
| #correction_parses? | Whether the exact correction for |
| #corrections_verify?, #item_range, | |
| #normalize_reparsed_ast | Hook: loosen strict tree equality for corrections that are equivalence-preserving beyond parse identity. |
| #normalized_original, | |
| #parses_equivalently? | Both sides are parsed with the original path so that |
| #preprocess_reparsed_source | Hook: rewrite both sides before parsing. |
| #reparse_scope | The innermost scope that both contains |
| #scope_groups, #verification_too_large?, | |
| #verified_by_reparse | Returns the items whose corrections are verified. |
::RuboCop::Cop::CheckSingleLineSuitability - Included
::RuboCop::Cop::CheckAssignment - Included
| #on_and_asgn | Alias for CheckAssignment#on_lvasgn. |
| #on_casgn | Alias for CheckAssignment#on_lvasgn. |
| #on_cvasgn | Alias for CheckAssignment#on_lvasgn. |
| #on_gvasgn | Alias for CheckAssignment#on_lvasgn. |
| #on_ivasgn | Alias for CheckAssignment#on_lvasgn. |
| #on_lvasgn, | |
| #on_masgn | Alias for CheckAssignment#on_lvasgn. |
| #on_op_asgn | Alias for CheckAssignment#on_lvasgn. |
| #on_or_asgn | Alias for CheckAssignment#on_lvasgn. |
| #on_send, #extract_rhs | |
::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, #matches_absolute_include_pattern?, #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 Attribute Details
#single_line_block_chain_enabled? ⇒ Boolean (readonly, private)
[ GitHub ]
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 200
def single_line_block_chain_enabled? @config.cop_enabled?('Layout/SingleLineBlockChain') end
Instance Method Details
#apply_reparse_correction(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 97
def apply_reparse_correction(corrector, node) corrector.replace(node, to_single_line(node.source).strip) end
#check_assignment(node, _rhs) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 79
def check_assignment(node, _rhs) return unless offense?(node) register_offense(node) end
#configured_to_not_be_inspected?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 185
def configured_to_not_be_inspected?(node) return true if other_cop_takes_precedence?(node) return false if cop_config['InspectBlocks'] node.any_block_type? || any_descendant?(node, :any_block, &:multiline?) end
#convertible_block?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 204
def convertible_block?(node) return false unless (parent = node.parent) parent.any_block_type? && node == parent.send_node && (node.parenthesized? || !node.arguments?) end
#end_with_percent_blank_string?(processed_source) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 75
def end_with_percent_blank_string?(processed_source) processed_source.buffer.source.end_with?("%\n\n") end
#fold_string_concatenation(node) (private)
Joining lines merges split string literals ("a" \<newline> "b" into
"ab") and turns mixed-quote pairs into + concatenation, which
changes the tree but not the resulting string. Normalize all string
concatenation to a canonical form before comparing: nested
concatenations are flattened and adjacent literal parts merged.
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 118
def fold_string_concatenation(node) return node unless node.is_a?(::Parser::AST::Node) children = node.children.map { |child| fold_string_concatenation(child) } node = node.updated(nil, children) parts = string_concatenation_parts(node) return node unless parts merged = merge_string_parts(parts) if merged.one? && merged.first.str_type? node.updated(:str, merged.first.children) else node.updated(:dstr, merged) end end
#index_access_call_chained?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 179
def index_access_call_chained?(node) return false unless node.send_type? && node.method?(:[]) node.children.first.send_type? && node.children.first.method?(:[]) end
#merge_plain_strings(chunk) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 154
def merge_plain_strings(chunk) return chunk.first if chunk.one? chunk.first.updated(:str, [chunk.map { |part| part.children.first }.join]) end
#merge_string_parts(parts) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 145
def merge_string_parts(parts) flattened = parts.flat_map do |part| part.is_a?(::Parser::AST::Node) && part.dstr_type? ? part.children : [part] end flattened.chunk_while { |left, right| plain_string?(left) && plain_string?(right) } .map { |chunk| merge_plain_strings(chunk) } end
#normalize_reparsed_ast(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 109
def normalize_reparsed_ast(node) fold_string_concatenation(node) end
#offense?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 168
def offense?(node) return false unless node.multiline? && suitable_as_single_line?(node) return require_backslash?(node) if node.operator_keyword? !index_access_call_chained?(node) && !configured_to_not_be_inspected?(node) end
#on_csend(node)
Alias for #on_send.
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 71
alias on_csend on_send
#on_lvasgn(node)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 57
def on_lvasgn(node) super unless end_with_percent_blank_string?(processed_source) end
#on_send(node) Also known as: #on_csend
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 61
def on_send(node) # Include "the whole expression". node = node.parent while node.parent&.send_type? || convertible_block?(node) || node.parent.is_a?(RuboCop::AST::BinaryOperatorNode) return unless offense?(node) && !part_of_ignored_node?(node) register_offense(node) end
#other_cop_takes_precedence?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 192
def other_cop_takes_precedence?(node) single_line_block_chain_enabled? && any_descendant?(node, :any_block) do |block_node| next unless (parent = block_node.parent) parent.call_type? && parent.loc.dot && block_node.single_line? end end
#plain_string?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 164
def plain_string?(node) node.is_a?(::Parser::AST::Node) && node.str_type? && node.children.one? end
#preprocess_reparsed_source(source) (private)
Joining lines shifts the value of any later LINE, exactly as
any other line-removing correction does; neutralize it on both sides
with an identifier, which stays valid in every position the keyword
can appear in.
#register_offense(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 85
def register_offense(node) # The exact single-line correction is verified to parse equivalently # before the offense is registered, so a join that would change how # the code parses is never reported or offered. return if verified_by_reparse([node], oversized: :verify).empty? add_offense(node) do |corrector| corrector.replace(node, to_single_line(node.source).strip) end ignore_node(node) end
#require_backslash?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 175
def require_backslash?(node) processed_source.lines[node.loc.operator.line - 1].end_with?('\\') end
#string_concatenation_parts(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 135
def string_concatenation_parts(node) case node.type when :dstr node.children when :send parts = [node.receiver, *node.arguments] parts if node.method?(:+) && parts.all? { |part| stringish?(part) } end end
#stringish?(node) ⇒ Boolean (private)
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 160
def stringish?(node) node.is_a?(::Parser::AST::Node) && %i[str dstr].include?(node.type) end