Class: RuboCop::Cop::Style::InverseMethods

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 202

def camel_case_constant?(node)
  node.const_type? && CAMEL_CASE.match?(node.source)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 144

def correct_inverse_block(corrector, node)
  method_call, method, block = inverse_block?(node)

  corrector.replace(method_call.loc.selector, inverse_blocks[method].to_s)
  correct_inverse_selector(block, corrector)
end

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

def correct_inverse_method(corrector, node)
  method_call, _lhs, method, _rhs = inverse_candidate?(node)
  return unless method_call && method

  remove_negation(corrector, node, method, method_call)
  corrector.replace(method_call.loc.selector, inverse_methods[method].to_s)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 151

def correct_inverse_selector(block, corrector)
  selector_loc = block.loc.selector
  selector = selector_loc.source

  if NEGATED_EQUALITY_METHODS.include?(selector.to_sym)
    selector[0] = '='
    corrector.replace(selector_loc, selector)
  else
    if block.loc.dot
      range = dot_range(block.loc)
      corrector.remove(range)
    end

    corrector.remove(selector_loc)
  end
end

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

def dot_range(loc)
  range_between(loc.dot.begin_pos, loc.expression.end_pos)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 185

def end_parentheses(node, method_call)
  method_call.source_range.end.join(node.source_range.end)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 70

def_node_matcher :inverse_block?, <<~PATTERN
  (any_block $(call (...) $_) ... { $(call ... :!)
                                    $(send (...) {:!= :!~} ...)
                                    (begin ... $(call ... :!))
                                    (begin ... $(send (...) {:!= :!~} ...))
                                  })
PATTERN

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 173

def inverse_blocks
  @inverse_blocks ||= cop_config['InverseBlocks'].merge(cop_config['InverseBlocks'].invert)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 61

def_node_matcher :inverse_candidate?, <<~PATTERN
  {
    (send $(call $(...) $_ $...) :!)
    (send (any_block $(call $(...) $_) $...) :!)
    (send (begin $(call $(...) $_ $...)) :!)
  }
PATTERN

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 168

def inverse_methods
  @inverse_methods ||= cop_config['InverseMethods']
                       .merge(cop_config['InverseMethods'].invert)
end

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

def keep_parentheses?(node, method_call)
  return false unless node.receiver.begin_type? || node.parenthesized?
  return false unless method_call.operator_method?
  return false unless (parent = node.parent)&.call_type?

  binary_operator?(parent) || parent.receiver.equal?(node)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 216

def message(method, inverse)
  format(MSG, method: method, inverse: inverse)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 177

def negated?(node)
  node.parent.respond_to?(:method?) && node.parent.method?(:!)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 181

def not_to_receiver(node, method_call)
  node.loc.selector.begin.join(method_call.source_range.begin)
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 92

def on_block(node)
  inverse_block?(node) do |_method_call, method, block|
    return unless inverse_blocks.key?(method)
    return if negated?(node) && negated?(node.parent)
    return if node.each_node(:next).any?

    # Inverse method offenses inside of the block of an inverse method
    # offense, such as `y.reject { |key, _value| !(key =~ /c\d/) }`,
    # can cause autocorrection to apply improper corrections.
    ignore_node(block)
    add_offense(node, message: message(method, inverse_blocks[method])) do |corrector|
      correct_inverse_block(corrector, node)
    end
  end
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 90

alias on_csend on_send

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 109

alias on_itblock on_block

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 108

alias on_numblock on_block

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 78

def on_send(node)
  inverse_candidate?(node) do |method_call, lhs, method, rhs|
    return unless inverse_methods.key?(method)
    return if negated?(node) || safe_navigation_incompatible?(method_call)
    return if part_of_ignored_node?(node)
    return if possible_class_hierarchy_check?(lhs, rhs, method)

    add_offense(node, message: message(method, inverse_methods[method])) do |corrector|
      correct_inverse_method(corrector, node)
    end
  end
end

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

def possible_class_hierarchy_check?(lhs, rhs, method)
  CLASS_COMPARISON_METHODS.include?(method) &&
    (camel_case_constant?(lhs) || (rhs.size == 1 && camel_case_constant?(rhs.first)))
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 210

def remove_end_parenthesis(corrector, node, method, method_call)
  return unless EQUALITY_METHODS.include?(method) || method_call.parent.begin_type?

  corrector.remove(end_parentheses(node, method_call))
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 121

def remove_negation(corrector, node, method, method_call)
  if !keep_parentheses?(node, method_call)
    corrector.remove(not_to_receiver(node, method_call))
    remove_end_parenthesis(corrector, node, method, method_call)
  elsif node.parenthesized?
    corrector.remove(node.loc.selector)
  else
    corrector.remove(node.loc.selector.join(node.receiver.source_range.begin))
  end
end

# File 'lib/rubocop/cop/style/inverse_methods.rb', line 189

def safe_navigation_incompatible?(node)
  return false unless node.csend_type?

  SAFE_NAVIGATION_INCOMPATIBLE_METHODS.include?(node.method_name)
end