class RuboCop::Cop::Style::SignalException

This cop checks for uses of `fail` and `raise`.

Constants

FAIL_MSG
RAISE_MSG

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 46
def autocorrect(node)
  lambda do |corrector|
    name =
      case style
      when :semantic
        command_or_kernel_call?(:raise, node) ? 'fail' : 'raise'
      when :only_raise then 'raise'
      when :only_fail then 'fail'
      end

    corrector.replace(node.loc.selector, name)
  end
end
investigate(processed_source) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 17
def investigate(processed_source)
  ast = processed_source.ast
  @custom_fail_defined = ast && custom_fail_methods(ast).any?
end
on_rescue(node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 22
def on_rescue(node)
  return unless style == :semantic

  begin_node, *rescue_nodes, _else_node = *node
  check_scope(:raise, begin_node)

  rescue_nodes.each do |rescue_node|
    check_scope(:fail, rescue_node)
    allow(:raise, rescue_node)
  end
end
on_send(node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 34
def on_send(node)
  case style
  when :semantic
    check_send(:raise, node) unless ignored_node?(node)
  when :only_raise
    return if @custom_fail_defined
    check_send(:fail, node)
  when :only_fail
    check_send(:raise, node)
  end
end

Private Instance Methods

allow(method_name, node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 95
def allow(method_name, node)
  each_command_or_kernel_call(method_name, node) do |send_node|
    ignore_node(send_node)
  end
end
check_scope(method_name, node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 73
def check_scope(method_name, node)
  return unless node

  each_command_or_kernel_call(method_name, node) do |send_node|
    next if ignored_node?(send_node)

    add_offense(send_node,
                location: :selector, message: message(method_name))
    ignore_node(send_node)
  end
end
check_send(method_name, node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 85
def check_send(method_name, node)
  return unless node && command_or_kernel_call?(method_name, node)

  add_offense(node, location: :selector, message: message(method_name))
end
command_or_kernel_call?(name, node) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 91
def command_or_kernel_call?(name, node)
  node.command?(name) || kernel_call?(node, name)
end
each_command_or_kernel_call(method_name, node) { |send_node| ... } click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 101
def each_command_or_kernel_call(method_name, node)
  on_node(:send, node, :rescue) do |send_node|
    yield send_node if command_or_kernel_call?(method_name, send_node)
  end
end
message(method_name) click to toggle source
# File lib/rubocop/cop/style/signal_exception.rb, line 62
def message(method_name)
  case style
  when :semantic
    method_name == :fail ? RAISE_MSG : FAIL_MSG
  when :only_raise
    'Always use `raise` to signal exceptions.'
  when :only_fail
    'Always use `fail` to signal exceptions.'
  end
end