struct Ameba::Rule::Style::RedundantReturn

• Ameba::Rule::Style::RedundantReturn
• Ameba::Rule::Base
• Struct
• Value
• Object

Overview

A rule that disallows redundant return expressions.

For example, this is considered invalid:

def foo
  return :bar
end

def bar(arg)
  case arg
  when .nil?
    return "nil"
  when .blank?
    return "blank"
  else
    return "empty"
  end
end

And has to be written as the following:

def foo
  :bar
end

def bar(arg)
  case arg
  when .nil?
    "nil"
  when .blank?
    "blank"
  else
    "empty"
  end
end

Configuration params

1. allow_multi_return, default: true

Allows end-user to configure whether to report or not the return statements which return tuple literals i.e.

def method(a, b)
  return a, b
end

If this param equals to false, the method above has to be written as:

def method(a, b)
  {a, b}
end

2. allow_empty_return, default: true

Allows end-user to configure whether to report or not the return statements without arguments. Sometimes such returns are used to return the nil value explicitly.

def method
  @foo = :empty
  return
end

If this param equals to false, the method above has to be written as:

def method
  @foo = :empty
  nil
end

YAML config example

Style/RedundantReturn:
  Enabled: true
  AllowMutliReturn: true
  AllowEmptyReturn: true

Defined in:

Constant Summary

MSG = "Redundant `return` detected"

Constructors

• .new(config = nil)

  A rule that disallows redundant return expressions.

Instance Method Summary

• #test(source, node : Crystal::Return, visitor : AST::RedundantControlExpressionVisitor)
• #test(source, node : Crystal::Def)

Constructor Detail

def foo
  return :bar
end

def bar(arg)
  case arg
  when .nil?
    return "nil"
  when .blank?
    return "blank"
  else
    return "empty"
  end
end

def foo
  :bar
end

def bar(arg)
  case arg
  when .nil?
    "nil"
  when .blank?
    "blank"
  else
    "empty"
  end
end

def method(a, b)
  return a, b
end

def method(a, b)
  {a, b}
end

def method
  @foo = :empty
  return
end

def method
  @foo = :empty
  nil
end

Style/RedundantReturn:
  Enabled: true
  AllowMutliReturn: true
  AllowEmptyReturn: true

Instance Method Detail