Class: RuboCop::Cop::Style::RedundantParentheses

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 106

def ternary_parentheses_required?
  config = @config.for_cop('Style/TernaryParentheses')
  allowed_styles = %w[require_parentheses require_parentheses_when_complex]

  config.fetch('Enabled') && allowed_styles.include?(config['EnforcedStyle'])
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 79

def allowed_expression?(node)
  allowed_ancestor?(node) ||
    allowed_multiple_expression?(node) ||
    allowed_ternary?(node) ||
    node.parent&.range_type?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 91

def allowed_multiple_expression?(node)
  return false if node.children.one?

  ancestor = node.ancestors.first
  return false unless ancestor

  !ancestor.type?(:begin, :any_def, :any_block)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 32

def_node_matcher :allowed_pin_operator?, '^(pin (begin !{lvar ivar cvar gvar}))'

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 100

def allowed_ternary?(node)
  return false unless node&.parent&.if_type?

  node.parent.ternary? && ternary_parentheses_required?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 252

def apply_reparse_correction(corrector, node)
  ParenthesesCorrector.correct(corrector, node)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 197

def argument_of_parenthesized_method_call?(begin_node, node)
  if node.basic_conditional? || node.rescue_type? || method_call_parentheses_required?(node)
    return false
  end
  return false unless (parent = begin_node.parent)

  parent.call_type? && parent.parenthesized? && parent.receiver != begin_node
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 309

def body_range?(begin_node, node)
  return false if begin_node.chained?
  return false unless node.range_type?
  return false unless (parent = begin_node.parent)
  return false unless parent.begin_type?

  (node.begin.nil? && begin_node == parent.children.first) ||
    (node.end.nil? && begin_node == parent.children.last)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 225

def call_node?(node)
  node.call_type? || (node.any_block_type? && node.braces? && !node.lambda_or_proc?)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 139

def check(begin_node)
  node = begin_node.children.first

  if (message = find_offense_message(begin_node, node))
    return offense(begin_node, message) if message == 'block body'

    if node.range_type? && !argument_of_parenthesized_method_call?(begin_node, node)
      begin_node = begin_node.parent
    end

    return offense(begin_node, message)
  end

  check_send(begin_node, node) if call_node?(node)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 229

def check_send(begin_node, node)
  node = node.send_node if node.any_block_type?

  return check_unary(begin_node, node) if node.unary_operation?

  return unless method_call_with_redundant_parentheses?(begin_node, node)

  offense(begin_node, 'a method call')
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 239

def check_unary(begin_node, node)
  return if begin_node.chained?

  node = node.children.first while suspect_unary?(node)
  return unless method_call_with_redundant_parentheses?(begin_node, node)

  offense(begin_node, 'a unary operation')
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 301

def disallowed_literal?(begin_node, node)
  return true unless node.range_type?
  return false unless (parent = begin_node.parent)

  parent.begin_type? && parent.children.one?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 320

def disallowed_one_line_pattern_matching?(begin_node, node)
  if (parent = begin_node.parent)
    return false if parent.any_def_type? && parent.endless?
    return false if parent.assignment?
  end

  node.any_match_pattern_type? && node.each_ancestor.none?(&:operator_keyword?)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 127

def empty_parentheses?(node)
  # Don't flag `()`
  node.children.empty?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 156

def find_offense_message(begin_node, node)
  return 'a keyword' if keyword_with_redundant_parentheses?(node)
  return 'a literal' if node.literal? && disallowed_literal?(begin_node, node)
  return 'a variable' if node.variable?
  return 'a constant' if node.const_type?
  return 'block body' if begin_node.parent&.any_block_type? || body_range?(begin_node, node)

  if node.assignment? && (begin_node.parent.nil? || begin_node.parent.begin_type?)
    return 'an assignment'
  end
  if node.lambda_or_proc? && (node.braces? || node.send_node.lambda_literal?)
    return 'an expression'
  end
  if disallowed_one_line_pattern_matching?(begin_node, node)
    return 'a one-line pattern matching'
  end
  return 'an interpolated expression' if interpolation?(begin_node)
  return 'a method argument' if argument_of_parenthesized_method_call?(begin_node, node)
  return 'a one-line rescue' if oneline_rescue_parentheses_required?(begin_node, node)

  return if begin_node.chained?

  if node.operator_keyword?
    return if node.semantic_operator? && begin_node.parent
    return if node.multiline? && allow_in_multiline_conditions?
    return if ALLOWED_NODE_TYPES.include?(begin_node.parent&.type)
    return if !node.and_type? && begin_node.parent&.and_type?
    return if begin_node.parent&.if_type? && begin_node.parent.ternary?

    'a logical expression'
  elsif node.respond_to?(:comparison_method?) && node.comparison_method?
    return unless begin_node.parent.nil?

    'a comparison expression'
  end
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 72

def ignore_syntax?(node)
  return false unless (parent = node.parent)

  parent.type?(:while_post, :until_post, :match_with_lvasgn) ||
    like_method_argument_parentheses?(parent) || multiline_control_flow_statements?(node)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 132

def in_pattern_matching_in_method_argument?(begin_node)
  return false unless begin_node.parent&.call_type?
  return false unless (node = begin_node.children.first)

  target_ruby_version <= 2.7 ? node.match_pattern_type? : node.match_pattern_p_type?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 195

def_node_matcher :interpolation?, '[^begin ^^dstr]'

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 297

def keyword_ancestor?(node)
  node.parent&.keyword?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 329

def keyword_with_redundant_parentheses?(node)
  return false unless node.keyword?
  return true if node.special_keyword?

  args = *node

  if only_begin_arg?(args)
    parentheses?(args.first)
  else
    args.empty? || parentheses?(node)
  end
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 113

def like_method_argument_parentheses?(node)
  return false unless node.type?(:send, :super, :yield)

  node.arguments.one? && !node.parenthesized? &&
    !node.operator_method? && node.first_argument.begin_type?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 215

def method_call_parentheses_required?(node)
  return false unless node.call_type?

  (node.receiver.nil? || node.loc.dot) && node.arguments.any?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 342

def method_call_with_redundant_parentheses?(begin_node, node)
  return false unless node.type?(:call, :super, :yield, :defined?)
  return false if node.prefix_not?
  return true if singular_parenthesized_parent?(begin_node)

  node.arguments.empty? || parentheses?(node) || square_brackets?(node)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 120

def multiline_control_flow_statements?(node)
  return false unless (parent = node.parent)
  return false if parent.single_line?

  parent.type?(:return, :next, :break)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 262

def normalize_reparsed_ast(node)
  return node unless node.is_a?(::Parser::AST::Node)

  children = node.children.map { |child| normalize_reparsed_ast(child) }
  children = splice_nested_sequences(children) if %i[begin kwbegin].include?(node.type)

  node = node.updated(nil, children)
  if node.begin_type? && children.one? && children.first.is_a?(::Parser::AST::Node)
    children.first
  else
    rotate_same_operator(node)
  end
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 248

def offense(node, msg)
  @pending_offenses[node] = "Don't use parentheses around #{msg}."
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 39

def on_begin(node)
  return if !parentheses?(node) || parens_allowed?(node) || ignore_syntax?(node)

  check(node)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 45

def on_investigation_end
  # Each candidate's exact correction is verified by reparsing before
  # the offense is registered, so redundancy never depends on
  # hand-maintained knowledge of Ruby's grammar.
  verified_by_reparse(@pending_offenses.keys).each do |node|
    add_offense(node, message: @pending_offenses[node]) do |corrector|
      ParenthesesCorrector.correct(corrector, node)
    end
  end

  super
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 34

def on_new_investigation
  @pending_offenses = {}.compare_by_identity
  super
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 206

def oneline_rescue_parentheses_required?(begin_node, node)
  return false unless node.rescue_type?
  return false unless (parent = begin_node.parent)
  return false if parent.if_type? && parent.ternary?
  return false if parent.conditional? && parent.condition == begin_node

  !parent.type?(:call, :array, :pair)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 357

def only_begin_arg?(args)
  args.one? && args.first&.begin_type?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 64

def parens_allowed?(node)
  empty_parentheses?(node) ||
    rescue?(node) ||
    in_pattern_matching_in_method_argument?(node) ||
    allowed_pin_operator?(node) ||
    allowed_expression?(node)
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 29

def_node_matcher :rescue?, '{^resbody ^^resbody}'

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 282

def rotate_same_operator(node)
  return node unless node.type?(:and, :or)

  right = node.rhs
  return node unless right.is_a?(::Parser::AST::Node) && right.type == node.type

  rotated_left = rotate_same_operator(node.updated(nil, [node.lhs, right.lhs]))

  rotate_same_operator(node.updated(nil, [rotated_left, right.rhs]))
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 350

def singular_parenthesized_parent?(begin_node)
  return true unless (parent = begin_node.parent)
  return false if parent.type?(:splat, :kwsplat)

  parent.children.one?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 276

def splice_nested_sequences(children)
  children.flat_map do |child|
    child.is_a?(::Parser::AST::Node) && child.begin_type? ? child.children : [child]
  end
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 24

def_node_matcher :square_brackets?, <<~PATTERN
  (send `{(send _recv _msg) str array hash const #variable?} :[] ...)
PATTERN

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 293

def suspect_unary?(node)
  node.send_type? && node.unary_operation? && !node.prefix_not?
end

# File 'lib/rubocop/cop/style/redundant_parentheses.rb', line 60

def variable?(node)
  node.respond_to?(:variable?) && node.variable?
end