class Ameba::Rule::Style::RedundantReturn

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
  1. 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
  AllowMultiReturn: true
  AllowEmptyReturn: true

Included Modules

Defined in:

ameba/rule/style/redundant_return.cr

Constant Summary

MSG = "Redundant `return` detected"

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Ameba::AST::Util

abort?(node) abort?, control_exp_code(node : Crystal::ControlExpression, code_lines) control_exp_code, dynamic_literal?(node) : Bool dynamic_literal?, exit?(node) exit?, flow_command?(node, in_loop) flow_command?, flow_expression?(node, in_loop = false) flow_expression?, literal?(node) : Bool literal?, loop?(node) loop?, name_end_location(node) name_end_location, name_location(node) name_location, name_size(node) name_size, node_source(node, code_lines) node_source, path_named?(node, name) : Bool path_named?, raise?(node) raise?, source_between(loc, end_loc, code_lines) : String | Nil source_between, static_literal?(node) : Bool static_literal?

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Class methods inherited from class Ameba::Rule::Base

default_severity : Ameba::Severity default_severity

Macros inherited from class Ameba::Rule::Base

issue_for(*args, **kwargs, &block) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

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
  1. 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
  AllowMultiReturn: true
  AllowEmptyReturn: true

[View source]

Class Method Detail

def self.parsed_doc : String | Nil #

Returns documentation for this rule, if there is any.

module Ameba
  # This is a test rule.
  # Does nothing.
  class MyRule < Ameba::Rule::Base
    def test(source)
    end
  end
end

MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."

Instance Method Detail

def allow_empty_return=(allow_empty_return : Bool) #

def allow_empty_return? : Bool #

def allow_multi_return=(allow_multi_return : Bool) #

def allow_multi_return? : Bool #

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

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

[View source]
def test(source, node : Crystal::Def) #

[View source]