Class: RuboCop::Cop::Layout::RedundantLineBreak

Inherits:
Cop
  • Object
show all
Includes:
CheckAssignment
Defined in:
lib/rubocop/cop/layout/redundant_line_break.rb

Overview

This cop checks whether certain expressions, e.g. method calls, that could fit completely on a single line, are broken up into multiple lines unnecessarily.

Examples:

any configuration

# bad
foo(
  a,
  b
)

puts 'string that fits on ' \
     'a single line'

things
  .select { |thing| thing.cond? }
  .join('-')

# good
foo(a, b)

puts 'string that fits on a single line'

things.select { |thing| thing.cond? }.join('-')

InspectBlocks: false (default)

# good
foo(a) do |x|
  puts x
end

InspectBlocks: true

# bad
foo(a) do |x|
  puts x
end

# good
foo(a) { |x| puts x }

Constant Summary collapse

MSG = 
'Redundant line break detected.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from CheckAssignment

extract_rhs, #on_lvasgn

Methods inherited from Cop

#add_offense, all, #corrections, #find_location, #highlights, joining_forces, #messages, #on_investigation_end, #on_new_investigation, qualified_cop_name, registry, support_autocorrect?, #support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#autocorrect(node) ⇒ Object 



69
70
71
 
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 69

def autocorrect(node)
  ->(corrector) { corrector.replace(node.source_range, to_single_line(node.source).strip) }
end

#check_assignment(node, _rhs) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 62

def check_assignment(node, _rhs)
  return unless offense?(node)

  add_offense(node)
  ignore_node(node)
end

#on_send(node) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rubocop/cop/layout/redundant_line_break.rb', line 50

def on_send(node)
  # Include "the whole expression".
  node = node.parent while convertible_block?(node) ||
                           node.parent.is_a?(RuboCop::AST::BinaryOperatorNode) ||
                           node.parent&.send_type?

  return unless offense?(node) && !part_of_ignored_node?(node)

  add_offense(node)
  ignore_node(node)
end