class Ameba::Rule::Naming::RescuedExceptionsVariableName

Overview

A rule that makes sure that rescued exceptions variables are named as expected.

For example, these are considered valid:

def foo
  # potentially raising computations
rescue e
  Log.error(exception: e) { "Error" }
end

And these are invalid variable names:

def foo
  # potentially raising computations
rescue wtf
  Log.error(exception: wtf) { "Error" }
end

YAML configuration example:

Naming/RescuedExceptionsVariableName:
  Enabled: true
  AllowedNames: [e, ex, exception, error]

Included Modules

Defined in:

ameba/rule/naming/rescued_exceptions_variable_name.cr

Constant Summary

MSG = "Disallowed variable name, use one of these instead: %s"
MSG_SINGULAR = "Disallowed variable name, use %s instead"

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_location_or(token : Crystal::Token, name, *, adjust_location_column_number = nil)
name_location_or(node : Crystal::ASTNode, *, adjust_location_column_number = nil) name_location_or, name_size(node) name_size, node_source(node, code_lines) node_source, nodoc?(node) nodoc?, path_named?(node, *names : String) : 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(hasher) 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 makes sure that rescued exceptions variables are named as expected.

For example, these are considered valid:

def foo
  # potentially raising computations
rescue e
  Log.error(exception: e) { "Error" }
end

And these are invalid variable names:

def foo
  # potentially raising computations
rescue wtf
  Log.error(exception: wtf) { "Error" }
end

YAML configuration example:

Naming/RescuedExceptionsVariableName:
  Enabled: true
  AllowedNames: [e, ex, exception, error]

[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 allowed_names : Array(String) #

def allowed_names=(allowed_names : Array(String)) #

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 since_version : SemanticVersion | Nil #

[View source]
def since_version=(since_version : String) #

def test(source, node : Crystal::ExceptionHandler) #

[View source]