iv-org-mirror/shard-ameba
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-ameba.git synced 2024-08-15 00:53:29 +00:00
Code Issues Projects Releases Packages Wiki Activity
shard-ameba/Ameba/Rule/Base.html

1606 lines
57 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Crystal Docs 1.12.2">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Base - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill="currentColor" fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<input type="checkbox" id="sidebar-btn">
<label for="sidebar-btn" id="sidebar-btn-label">
<svg class="open" xmlns="http://www.w3.org/2000/svg" height="2em" width="2em" viewBox="0 0 512 512"><title>Open Sidebar</title><path fill="currentColor" d="M80 96v64h352V96H80zm0 112v64h352v-64H80zm0 112v64h352v-64H80z"></path></svg>
<svg class="close" xmlns="http://www.w3.org/2000/svg" width="2em" height="2em" viewBox="0 0 512 512"><title>Close Sidebar</title><path fill="currentColor" d="m118.6 73.4-45.2 45.2L210.7 256 73.4 393.4l45.2 45.2L256 301.3l137.4 137.3 45.2-45.2L301.3 256l137.3-137.4-45.2-45.2L256 210.7Z"></path></svg>
</label>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="project-summary">
<h1 class="project-name">
<a href="../../index.html">
ameba
</a>
</h1>
<span class="project-version">
master
</span>
</div>
</div>
<div class="search-results hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="ameba/Ameba" data-name="ameba">
<a href="../../Ameba.html">Ameba</a>
<ul>
<li class="parent " data-id="ameba/Ameba/AST" data-name="ameba::ast">
<a href="../../Ameba/AST.html">AST</a>
<ul>
<li class=" " data-id="ameba/Ameba/AST/Argument" data-name="ameba::ast::argument">
<a href="../../Ameba/AST/Argument.html">Argument</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Assignment" data-name="ameba::ast::assignment">
<a href="../../Ameba/AST/Assignment.html">Assignment</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/BaseVisitor" data-name="ameba::ast::basevisitor">
<a href="../../Ameba/AST/BaseVisitor.html">BaseVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Branch" data-name="ameba::ast::branch">
<a href="../../Ameba/AST/Branch.html">Branch</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Branchable" data-name="ameba::ast::branchable">
<a href="../../Ameba/AST/Branchable.html">Branchable</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/CountingVisitor" data-name="ameba::ast::countingvisitor">
<a href="../../Ameba/AST/CountingVisitor.html">CountingVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/FlowExpression" data-name="ameba::ast::flowexpression">
<a href="../../Ameba/AST/FlowExpression.html">FlowExpression</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/FlowExpressionVisitor" data-name="ameba::ast::flowexpressionvisitor">
<a href="../../Ameba/AST/FlowExpressionVisitor.html">FlowExpressionVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/InstanceVariable" data-name="ameba::ast::instancevariable">
<a href="../../Ameba/AST/InstanceVariable.html">InstanceVariable</a>
</li>
<li class="parent " data-id="ameba/Ameba/AST/NodeVisitor" data-name="ameba::ast::nodevisitor">
<a href="../../Ameba/AST/NodeVisitor.html">NodeVisitor</a>
<ul>
<li class=" " data-id="ameba/Ameba/AST/NodeVisitor/Category" data-name="ameba::ast::nodevisitor::category">
<a href="../../Ameba/AST/NodeVisitor/Category.html">Category</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/AST/RedundantControlExpressionVisitor" data-name="ameba::ast::redundantcontrolexpressionvisitor">
<a href="../../Ameba/AST/RedundantControlExpressionVisitor.html">RedundantControlExpressionVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Reference" data-name="ameba::ast::reference">
<a href="../../Ameba/AST/Reference.html">Reference</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Scope" data-name="ameba::ast::scope">
<a href="../../Ameba/AST/Scope.html">Scope</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/ScopeVisitor" data-name="ameba::ast::scopevisitor">
<a href="../../Ameba/AST/ScopeVisitor.html">ScopeVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/TopLevelNodesVisitor" data-name="ameba::ast::toplevelnodesvisitor">
<a href="../../Ameba/AST/TopLevelNodesVisitor.html">TopLevelNodesVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/TypeDecVariable" data-name="ameba::ast::typedecvariable">
<a href="../../Ameba/AST/TypeDecVariable.html">TypeDecVariable</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Util" data-name="ameba::ast::util">
<a href="../../Ameba/AST/Util.html">Util</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Variable" data-name="ameba::ast::variable">
<a href="../../Ameba/AST/Variable.html">Variable</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Config" data-name="ameba::config">
<a href="../../Ameba/Config.html">Config</a>
</li>
<li class="parent " data-id="ameba/Ameba/Ext" data-name="ameba::ext">
<a href="../../Ameba/Ext.html">Ext</a>
<ul>
<li class=" " data-id="ameba/Ameba/Ext/Location" data-name="ameba::ext::location">
<a href="../../Ameba/Ext/Location.html">Location</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Formatter" data-name="ameba::formatter">
<a href="../../Ameba/Formatter.html">Formatter</a>
<ul>
<li class=" " data-id="ameba/Ameba/Formatter/BaseFormatter" data-name="ameba::formatter::baseformatter">
<a href="../../Ameba/Formatter/BaseFormatter.html">BaseFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/DisabledFormatter" data-name="ameba::formatter::disabledformatter">
<a href="../../Ameba/Formatter/DisabledFormatter.html">DisabledFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/DotFormatter" data-name="ameba::formatter::dotformatter">
<a href="../../Ameba/Formatter/DotFormatter.html">DotFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/ExplainFormatter" data-name="ameba::formatter::explainformatter">
<a href="../../Ameba/Formatter/ExplainFormatter.html">ExplainFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/FlycheckFormatter" data-name="ameba::formatter::flycheckformatter">
<a href="../../Ameba/Formatter/FlycheckFormatter.html">FlycheckFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/JSONFormatter" data-name="ameba::formatter::jsonformatter">
<a href="../../Ameba/Formatter/JSONFormatter.html">JSONFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/TODOFormatter" data-name="ameba::formatter::todoformatter">
<a href="../../Ameba/Formatter/TODOFormatter.html">TODOFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/Util" data-name="ameba::formatter::util">
<a href="../../Ameba/Formatter/Util.html">Util</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/GlobUtils" data-name="ameba::globutils">
<a href="../../Ameba/GlobUtils.html">GlobUtils</a>
</li>
<li class="parent " data-id="ameba/Ameba/InlineComments" data-name="ameba::inlinecomments">
<a href="../../Ameba/InlineComments.html">InlineComments</a>
<ul>
<li class=" " data-id="ameba/Ameba/InlineComments/Action" data-name="ameba::inlinecomments::action">
<a href="../../Ameba/InlineComments/Action.html">Action</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Issue" data-name="ameba::issue">
<a href="../../Ameba/Issue.html">Issue</a>
<ul>
<li class=" " data-id="ameba/Ameba/Issue/Status" data-name="ameba::issue::status">
<a href="../../Ameba/Issue/Status.html">Status</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Presenter" data-name="ameba::presenter">
<a href="../../Ameba/Presenter.html">Presenter</a>
<ul>
<li class=" " data-id="ameba/Ameba/Presenter/BasePresenter" data-name="ameba::presenter::basepresenter">
<a href="../../Ameba/Presenter/BasePresenter.html">BasePresenter</a>
</li>
<li class=" " data-id="ameba/Ameba/Presenter/RuleCollectionPresenter" data-name="ameba::presenter::rulecollectionpresenter">
<a href="../../Ameba/Presenter/RuleCollectionPresenter.html">RuleCollectionPresenter</a>
</li>
<li class=" " data-id="ameba/Ameba/Presenter/RulePresenter" data-name="ameba::presenter::rulepresenter">
<a href="../../Ameba/Presenter/RulePresenter.html">RulePresenter</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Reportable" data-name="ameba::reportable">
<a href="../../Ameba/Reportable.html">Reportable</a>
</li>
<li class="parent open current" data-id="ameba/Ameba/Rule" data-name="ameba::rule">
<a href="../../Ameba/Rule.html">Rule</a>
<ul>
<li class=" current" data-id="ameba/Ameba/Rule/Base" data-name="ameba::rule::base">
<a href="../../Ameba/Rule/Base.html">Base</a>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Documentation" data-name="ameba::rule::documentation">
<a href="../../Ameba/Rule/Documentation.html">Documentation</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Documentation/Documentation" data-name="ameba::rule::documentation::documentation">
<a href="../../Ameba/Rule/Documentation/Documentation.html">Documentation</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Documentation/DocumentationAdmonition" data-name="ameba::rule::documentation::documentationadmonition">
<a href="../../Ameba/Rule/Documentation/DocumentationAdmonition.html">DocumentationAdmonition</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Layout" data-name="ameba::rule::layout">
<a href="../../Ameba/Rule/Layout.html">Layout</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Layout/LineLength" data-name="ameba::rule::layout::linelength">
<a href="../../Ameba/Rule/Layout/LineLength.html">LineLength</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Layout/TrailingBlankLines" data-name="ameba::rule::layout::trailingblanklines">
<a href="../../Ameba/Rule/Layout/TrailingBlankLines.html">TrailingBlankLines</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Layout/TrailingWhitespace" data-name="ameba::rule::layout::trailingwhitespace">
<a href="../../Ameba/Rule/Layout/TrailingWhitespace.html">TrailingWhitespace</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Lint" data-name="ameba::rule::lint">
<a href="../../Ameba/Rule/Lint.html">Lint</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ComparisonToBoolean" data-name="ameba::rule::lint::comparisontoboolean">
<a href="../../Ameba/Rule/Lint/ComparisonToBoolean.html">ComparisonToBoolean</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DebugCalls" data-name="ameba::rule::lint::debugcalls">
<a href="../../Ameba/Rule/Lint/DebugCalls.html">DebugCalls</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DebuggerStatement" data-name="ameba::rule::lint::debuggerstatement">
<a href="../../Ameba/Rule/Lint/DebuggerStatement.html">DebuggerStatement</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DuplicatedRequire" data-name="ameba::rule::lint::duplicatedrequire">
<a href="../../Ameba/Rule/Lint/DuplicatedRequire.html">DuplicatedRequire</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyEnsure" data-name="ameba::rule::lint::emptyensure">
<a href="../../Ameba/Rule/Lint/EmptyEnsure.html">EmptyEnsure</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyExpression" data-name="ameba::rule::lint::emptyexpression">
<a href="../../Ameba/Rule/Lint/EmptyExpression.html">EmptyExpression</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyLoop" data-name="ameba::rule::lint::emptyloop">
<a href="../../Ameba/Rule/Lint/EmptyLoop.html">EmptyLoop</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Formatting" data-name="ameba::rule::lint::formatting">
<a href="../../Ameba/Rule/Lint/Formatting.html">Formatting</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/HashDuplicatedKey" data-name="ameba::rule::lint::hashduplicatedkey">
<a href="../../Ameba/Rule/Lint/HashDuplicatedKey.html">HashDuplicatedKey</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralAssignmentsInExpressions" data-name="ameba::rule::lint::literalassignmentsinexpressions">
<a href="../../Ameba/Rule/Lint/LiteralAssignmentsInExpressions.html">LiteralAssignmentsInExpressions</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralInCondition" data-name="ameba::rule::lint::literalincondition">
<a href="../../Ameba/Rule/Lint/LiteralInCondition.html">LiteralInCondition</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralInInterpolation" data-name="ameba::rule::lint::literalininterpolation">
<a href="../../Ameba/Rule/Lint/LiteralInInterpolation.html">LiteralInInterpolation</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralsComparison" data-name="ameba::rule::lint::literalscomparison">
<a href="../../Ameba/Rule/Lint/LiteralsComparison.html">LiteralsComparison</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/MissingBlockArgument" data-name="ameba::rule::lint::missingblockargument">
<a href="../../Ameba/Rule/Lint/MissingBlockArgument.html">MissingBlockArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/NotNil" data-name="ameba::rule::lint::notnil">
<a href="../../Ameba/Rule/Lint/NotNil.html">NotNil</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/NotNilAfterNoBang" data-name="ameba::rule::lint::notnilafternobang">
<a href="../../Ameba/Rule/Lint/NotNilAfterNoBang.html">NotNilAfterNoBang</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/PercentArrays" data-name="ameba::rule::lint::percentarrays">
<a href="../../Ameba/Rule/Lint/PercentArrays.html">PercentArrays</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RandZero" data-name="ameba::rule::lint::randzero">
<a href="../../Ameba/Rule/Lint/RandZero.html">RandZero</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RedundantStringCoercion" data-name="ameba::rule::lint::redundantstringcoercion">
<a href="../../Ameba/Rule/Lint/RedundantStringCoercion.html">RedundantStringCoercion</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RedundantWithIndex" data-name="ameba::rule::lint::redundantwithindex">
<a href="../../Ameba/Rule/Lint/RedundantWithIndex.html">RedundantWithIndex</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RedundantWithObject" data-name="ameba::rule::lint::redundantwithobject">
<a href="../../Ameba/Rule/Lint/RedundantWithObject.html">RedundantWithObject</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ShadowedArgument" data-name="ameba::rule::lint::shadowedargument">
<a href="../../Ameba/Rule/Lint/ShadowedArgument.html">ShadowedArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ShadowedException" data-name="ameba::rule::lint::shadowedexception">
<a href="../../Ameba/Rule/Lint/ShadowedException.html">ShadowedException</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ShadowingOuterLocalVar" data-name="ameba::rule::lint::shadowingouterlocalvar">
<a href="../../Ameba/Rule/Lint/ShadowingOuterLocalVar.html">ShadowingOuterLocalVar</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SharedVarInFiber" data-name="ameba::rule::lint::sharedvarinfiber">
<a href="../../Ameba/Rule/Lint/SharedVarInFiber.html">SharedVarInFiber</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SpecFilename" data-name="ameba::rule::lint::specfilename">
<a href="../../Ameba/Rule/Lint/SpecFilename.html">SpecFilename</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SpecFocus" data-name="ameba::rule::lint::specfocus">
<a href="../../Ameba/Rule/Lint/SpecFocus.html">SpecFocus</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Syntax" data-name="ameba::rule::lint::syntax">
<a href="../../Ameba/Rule/Lint/Syntax.html">Syntax</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Typos" data-name="ameba::rule::lint::typos">
<a href="../../Ameba/Rule/Lint/Typos.html">Typos</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnneededDisableDirective" data-name="ameba::rule::lint::unneededdisabledirective">
<a href="../../Ameba/Rule/Lint/UnneededDisableDirective.html">UnneededDisableDirective</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnreachableCode" data-name="ameba::rule::lint::unreachablecode">
<a href="../../Ameba/Rule/Lint/UnreachableCode.html">UnreachableCode</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnusedArgument" data-name="ameba::rule::lint::unusedargument">
<a href="../../Ameba/Rule/Lint/UnusedArgument.html">UnusedArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnusedBlockArgument" data-name="ameba::rule::lint::unusedblockargument">
<a href="../../Ameba/Rule/Lint/UnusedBlockArgument.html">UnusedBlockArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UselessAssign" data-name="ameba::rule::lint::uselessassign">
<a href="../../Ameba/Rule/Lint/UselessAssign.html">UselessAssign</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UselessConditionInWhen" data-name="ameba::rule::lint::uselessconditioninwhen">
<a href="../../Ameba/Rule/Lint/UselessConditionInWhen.html">UselessConditionInWhen</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Metrics" data-name="ameba::rule::metrics">
<a href="../../Ameba/Rule/Metrics.html">Metrics</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Metrics/CyclomaticComplexity" data-name="ameba::rule::metrics::cyclomaticcomplexity">
<a href="../../Ameba/Rule/Metrics/CyclomaticComplexity.html">CyclomaticComplexity</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Naming" data-name="ameba::rule::naming">
<a href="../../Ameba/Rule/Naming.html">Naming</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Naming/AccessorMethodName" data-name="ameba::rule::naming::accessormethodname">
<a href="../../Ameba/Rule/Naming/AccessorMethodName.html">AccessorMethodName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/AsciiIdentifiers" data-name="ameba::rule::naming::asciiidentifiers">
<a href="../../Ameba/Rule/Naming/AsciiIdentifiers.html">AsciiIdentifiers</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/BinaryOperatorParameterName" data-name="ameba::rule::naming::binaryoperatorparametername">
<a href="../../Ameba/Rule/Naming/BinaryOperatorParameterName.html">BinaryOperatorParameterName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/BlockParameterName" data-name="ameba::rule::naming::blockparametername">
<a href="../../Ameba/Rule/Naming/BlockParameterName.html">BlockParameterName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/ConstantNames" data-name="ameba::rule::naming::constantnames">
<a href="../../Ameba/Rule/Naming/ConstantNames.html">ConstantNames</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/Filename" data-name="ameba::rule::naming::filename">
<a href="../../Ameba/Rule/Naming/Filename.html">Filename</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/MethodNames" data-name="ameba::rule::naming::methodnames">
<a href="../../Ameba/Rule/Naming/MethodNames.html">MethodNames</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/PredicateName" data-name="ameba::rule::naming::predicatename">
<a href="../../Ameba/Rule/Naming/PredicateName.html">PredicateName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/QueryBoolMethods" data-name="ameba::rule::naming::queryboolmethods">
<a href="../../Ameba/Rule/Naming/QueryBoolMethods.html">QueryBoolMethods</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/RescuedExceptionsVariableName" data-name="ameba::rule::naming::rescuedexceptionsvariablename">
<a href="../../Ameba/Rule/Naming/RescuedExceptionsVariableName.html">RescuedExceptionsVariableName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/TypeNames" data-name="ameba::rule::naming::typenames">
<a href="../../Ameba/Rule/Naming/TypeNames.html">TypeNames</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/VariableNames" data-name="ameba::rule::naming::variablenames">
<a href="../../Ameba/Rule/Naming/VariableNames.html">VariableNames</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Performance" data-name="ameba::rule::performance">
<a href="../../Ameba/Rule/Performance.html">Performance</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Performance/AnyAfterFilter" data-name="ameba::rule::performance::anyafterfilter">
<a href="../../Ameba/Rule/Performance/AnyAfterFilter.html">AnyAfterFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/AnyInsteadOfEmpty" data-name="ameba::rule::performance::anyinsteadofempty">
<a href="../../Ameba/Rule/Performance/AnyInsteadOfEmpty.html">AnyInsteadOfEmpty</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/Base" data-name="ameba::rule::performance::base">
<a href="../../Ameba/Rule/Performance/Base.html">Base</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/ChainedCallWithNoBang" data-name="ameba::rule::performance::chainedcallwithnobang">
<a href="../../Ameba/Rule/Performance/ChainedCallWithNoBang.html">ChainedCallWithNoBang</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/CompactAfterMap" data-name="ameba::rule::performance::compactaftermap">
<a href="../../Ameba/Rule/Performance/CompactAfterMap.html">CompactAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/ExcessiveAllocations" data-name="ameba::rule::performance::excessiveallocations">
<a href="../../Ameba/Rule/Performance/ExcessiveAllocations.html">ExcessiveAllocations</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/FirstLastAfterFilter" data-name="ameba::rule::performance::firstlastafterfilter">
<a href="../../Ameba/Rule/Performance/FirstLastAfterFilter.html">FirstLastAfterFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/FlattenAfterMap" data-name="ameba::rule::performance::flattenaftermap">
<a href="../../Ameba/Rule/Performance/FlattenAfterMap.html">FlattenAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/MapInsteadOfBlock" data-name="ameba::rule::performance::mapinsteadofblock">
<a href="../../Ameba/Rule/Performance/MapInsteadOfBlock.html">MapInsteadOfBlock</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/MinMaxAfterMap" data-name="ameba::rule::performance::minmaxaftermap">
<a href="../../Ameba/Rule/Performance/MinMaxAfterMap.html">MinMaxAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/SizeAfterFilter" data-name="ameba::rule::performance::sizeafterfilter">
<a href="../../Ameba/Rule/Performance/SizeAfterFilter.html">SizeAfterFilter</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Style" data-name="ameba::rule::style">
<a href="../../Ameba/Rule/Style.html">Style</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Style/GuardClause" data-name="ameba::rule::style::guardclause">
<a href="../../Ameba/Rule/Style/GuardClause.html">GuardClause</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/IsAFilter" data-name="ameba::rule::style::isafilter">
<a href="../../Ameba/Rule/Style/IsAFilter.html">IsAFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/IsANil" data-name="ameba::rule::style::isanil">
<a href="../../Ameba/Rule/Style/IsANil.html">IsANil</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/LargeNumbers" data-name="ameba::rule::style::largenumbers">
<a href="../../Ameba/Rule/Style/LargeNumbers.html">LargeNumbers</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/NegatedConditionsInUnless" data-name="ameba::rule::style::negatedconditionsinunless">
<a href="../../Ameba/Rule/Style/NegatedConditionsInUnless.html">NegatedConditionsInUnless</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/ParenthesesAroundCondition" data-name="ameba::rule::style::parenthesesaroundcondition">
<a href="../../Ameba/Rule/Style/ParenthesesAroundCondition.html">ParenthesesAroundCondition</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/RedundantBegin" data-name="ameba::rule::style::redundantbegin">
<a href="../../Ameba/Rule/Style/RedundantBegin.html">RedundantBegin</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/RedundantNext" data-name="ameba::rule::style::redundantnext">
<a href="../../Ameba/Rule/Style/RedundantNext.html">RedundantNext</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/RedundantReturn" data-name="ameba::rule::style::redundantreturn">
<a href="../../Ameba/Rule/Style/RedundantReturn.html">RedundantReturn</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/UnlessElse" data-name="ameba::rule::style::unlesselse">
<a href="../../Ameba/Rule/Style/UnlessElse.html">UnlessElse</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/VerboseBlock" data-name="ameba::rule::style::verboseblock">
<a href="../../Ameba/Rule/Style/VerboseBlock.html">VerboseBlock</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/WhileTrue" data-name="ameba::rule::style::whiletrue">
<a href="../../Ameba/Rule/Style/WhileTrue.html">WhileTrue</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Runner" data-name="ameba::runner">
<a href="../../Ameba/Runner.html">Runner</a>
<ul>
<li class=" " data-id="ameba/Ameba/Runner/InfiniteCorrectionLoopError" data-name="ameba::runner::infinitecorrectionlooperror">
<a href="../../Ameba/Runner/InfiniteCorrectionLoopError.html">InfiniteCorrectionLoopError</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Severity" data-name="ameba::severity">
<a href="../../Ameba/Severity.html">Severity</a>
</li>
<li class=" " data-id="ameba/Ameba/SeverityYamlConverter" data-name="ameba::severityyamlconverter">
<a href="../../Ameba/SeverityYamlConverter.html">SeverityYamlConverter</a>
</li>
<li class="parent " data-id="ameba/Ameba/Source" data-name="ameba::source">
<a href="../../Ameba/Source.html">Source</a>
<ul>
<li class=" " data-id="ameba/Ameba/Source/Corrector" data-name="ameba::source::corrector">
<a href="../../Ameba/Source/Corrector.html">Corrector</a>
</li>
<li class=" " data-id="ameba/Ameba/Source/Rewriter" data-name="ameba::source::rewriter">
<a href="../../Ameba/Source/Rewriter.html">Rewriter</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Spec" data-name="ameba::spec">
<a href="../../Ameba/Spec.html">Spec</a>
<ul>
<li class=" " data-id="ameba/Ameba/Spec/AnnotatedSource" data-name="ameba::spec::annotatedsource">
<a href="../../Ameba/Spec/AnnotatedSource.html">AnnotatedSource</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/BeValid" data-name="ameba::spec::bevalid">
<a href="../../Ameba/Spec/BeValid.html">BeValid</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/BeValidExpectation" data-name="ameba::spec::bevalidexpectation">
<a href="../../Ameba/Spec/BeValidExpectation.html">BeValidExpectation</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/ExpectIssue" data-name="ameba::spec::expectissue">
<a href="../../Ameba/Spec/ExpectIssue.html">ExpectIssue</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/Util" data-name="ameba::spec::util">
<a href="../../Ameba/Spec/Util.html">Util</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Tokenizer" data-name="ameba::tokenizer">
<a href="../../Ameba/Tokenizer.html">Tokenizer</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">abstract class</span> Ameba::<wbr>Rule::<wbr>Base
</h1>
<ul class="superclass-hierarchy"><li class="superclass"><a href="../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
<h2>
<a id="overview" class="anchor" href="#overview">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Overview
</h2>
<p>Represents a base of all rules. In other words, all rules
inherits from this struct:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<span class="k">def</span> <span class="m">test</span>(source)
<span class="k">if</span> invalid?(source)
issue_for line, column, <span class="s">&quot;Something wrong.&quot;</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">private</span> <span class="k">def</span> <span class="m">invalid?</span>(source)
<span class="c"># ...</span>
<span class="k">end</span>
<span class="k">end</span></code></pre>
<p>Enforces rules to implement an abstract <code><a href="../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method">#test</a></code> method which
is designed to test the source passed in. If source has issues
that are tested by this rule, it should add an issue.</p>
<h2>
<a id="included-modules" class="anchor" href="#included-modules">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Included Modules
</h2>
<ul class="other-types-list">
<li class="other-type">Ameba::Config::RuleConfig</li>
</ul>
<h2>
<a id="direct-known-subclasses" class="anchor" href="#direct-known-subclasses">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Direct Known Subclasses
</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Ameba/Rule/Documentation/Documentation.html">Ameba::Rule::Documentation::Documentation</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Documentation/DocumentationAdmonition.html">Ameba::Rule::Documentation::DocumentationAdmonition</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Layout/LineLength.html">Ameba::Rule::Layout::LineLength</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Layout/TrailingBlankLines.html">Ameba::Rule::Layout::TrailingBlankLines</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Layout/TrailingWhitespace.html">Ameba::Rule::Layout::TrailingWhitespace</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">Ameba::Rule::Lint::AmbiguousAssignment</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/BadDirective.html">Ameba::Rule::Lint::BadDirective</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/ComparisonToBoolean.html">Ameba::Rule::Lint::ComparisonToBoolean</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/DebugCalls.html">Ameba::Rule::Lint::DebugCalls</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/DebuggerStatement.html">Ameba::Rule::Lint::DebuggerStatement</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/DuplicatedRequire.html">Ameba::Rule::Lint::DuplicatedRequire</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/EmptyEnsure.html">Ameba::Rule::Lint::EmptyEnsure</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/EmptyExpression.html">Ameba::Rule::Lint::EmptyExpression</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/EmptyLoop.html">Ameba::Rule::Lint::EmptyLoop</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/Formatting.html">Ameba::Rule::Lint::Formatting</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/HashDuplicatedKey.html">Ameba::Rule::Lint::HashDuplicatedKey</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralAssignmentsInExpressions.html">Ameba::Rule::Lint::LiteralAssignmentsInExpressions</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralInCondition.html">Ameba::Rule::Lint::LiteralInCondition</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralInInterpolation.html">Ameba::Rule::Lint::LiteralInInterpolation</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralsComparison.html">Ameba::Rule::Lint::LiteralsComparison</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/MissingBlockArgument.html">Ameba::Rule::Lint::MissingBlockArgument</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/NotNil.html">Ameba::Rule::Lint::NotNil</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/NotNilAfterNoBang.html">Ameba::Rule::Lint::NotNilAfterNoBang</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/PercentArrays.html">Ameba::Rule::Lint::PercentArrays</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/RandZero.html">Ameba::Rule::Lint::RandZero</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/RedundantStringCoercion.html">Ameba::Rule::Lint::RedundantStringCoercion</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/RedundantWithIndex.html">Ameba::Rule::Lint::RedundantWithIndex</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/RedundantWithObject.html">Ameba::Rule::Lint::RedundantWithObject</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/ShadowedArgument.html">Ameba::Rule::Lint::ShadowedArgument</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/ShadowedException.html">Ameba::Rule::Lint::ShadowedException</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/ShadowingOuterLocalVar.html">Ameba::Rule::Lint::ShadowingOuterLocalVar</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/SharedVarInFiber.html">Ameba::Rule::Lint::SharedVarInFiber</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/SpecFilename.html">Ameba::Rule::Lint::SpecFilename</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/SpecFocus.html">Ameba::Rule::Lint::SpecFocus</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/Syntax.html">Ameba::Rule::Lint::Syntax</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/Typos.html">Ameba::Rule::Lint::Typos</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/UnneededDisableDirective.html">Ameba::Rule::Lint::UnneededDisableDirective</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/UnreachableCode.html">Ameba::Rule::Lint::UnreachableCode</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/UnusedArgument.html">Ameba::Rule::Lint::UnusedArgument</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/UnusedBlockArgument.html">Ameba::Rule::Lint::UnusedBlockArgument</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/UselessAssign.html">Ameba::Rule::Lint::UselessAssign</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/UselessConditionInWhen.html">Ameba::Rule::Lint::UselessConditionInWhen</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Metrics/CyclomaticComplexity.html">Ameba::Rule::Metrics::CyclomaticComplexity</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/AccessorMethodName.html">Ameba::Rule::Naming::AccessorMethodName</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/AsciiIdentifiers.html">Ameba::Rule::Naming::AsciiIdentifiers</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/BinaryOperatorParameterName.html">Ameba::Rule::Naming::BinaryOperatorParameterName</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/BlockParameterName.html">Ameba::Rule::Naming::BlockParameterName</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/ConstantNames.html">Ameba::Rule::Naming::ConstantNames</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/Filename.html">Ameba::Rule::Naming::Filename</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/MethodNames.html">Ameba::Rule::Naming::MethodNames</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/PredicateName.html">Ameba::Rule::Naming::PredicateName</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/QueryBoolMethods.html">Ameba::Rule::Naming::QueryBoolMethods</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/RescuedExceptionsVariableName.html">Ameba::Rule::Naming::RescuedExceptionsVariableName</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/TypeNames.html">Ameba::Rule::Naming::TypeNames</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/VariableNames.html">Ameba::Rule::Naming::VariableNames</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/Base.html">Ameba::Rule::Performance::Base</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/GuardClause.html">Ameba::Rule::Style::GuardClause</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/IsAFilter.html">Ameba::Rule::Style::IsAFilter</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/IsANil.html">Ameba::Rule::Style::IsANil</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/LargeNumbers.html">Ameba::Rule::Style::LargeNumbers</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/NegatedConditionsInUnless.html">Ameba::Rule::Style::NegatedConditionsInUnless</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/ParenthesesAroundCondition.html">Ameba::Rule::Style::ParenthesesAroundCondition</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/RedundantBegin.html">Ameba::Rule::Style::RedundantBegin</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/RedundantNext.html">Ameba::Rule::Style::RedundantNext</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/RedundantReturn.html">Ameba::Rule::Style::RedundantReturn</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/UnlessElse.html">Ameba::Rule::Style::UnlessElse</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/VerboseBlock.html">Ameba::Rule::Style::VerboseBlock</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/WhileTrue.html">Ameba::Rule::Style::WhileTrue</a></li>
</ul>
<h2>
<a id="defined-in" class="anchor" href="#defined-in">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L29" target="_blank">
ameba/rule/base.cr
</a>
<br/>
<h2>
<a id="constant-summary" class="anchor" href="#constant-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Constant Summary
</h2>
<dl>
<dt class="entry-const" id="GROUP_SEVERITY">
<strong>GROUP_SEVERITY</strong> = <code>{<span class="t">Documentation</span>: <span class="t">Ameba</span><span class="t">::</span><span class="t">Severity</span><span class="t">::</span><span class="t">Warning</span>, <span class="t">Lint</span>: <span class="t">Ameba</span><span class="t">::</span><span class="t">Severity</span><span class="t">::</span><span class="t">Warning</span>, <span class="t">Metrics</span>: <span class="t">Ameba</span><span class="t">::</span><span class="t">Severity</span><span class="t">::</span><span class="t">Warning</span>, <span class="t">Performance</span>: <span class="t">Ameba</span><span class="t">::</span><span class="t">Severity</span><span class="t">::</span><span class="t">Warning</span>}</code>
</dt>
</dl>
<h2>
<a id="class-method-summary" class="anchor" href="#class-method-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Class Method Summary
</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#default_severity%3AAmeba%3A%3ASeverity-class-method" class="signature"><strong>.default_severity</strong> : Ameba::Severity</a>
</li>
</ul>
<h2>
<a id="macro-summary" class="anchor" href="#macro-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Macro Summary
</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#issue_for%28%2Aargs%2C%2A%2Akwargs%2C%26block%29-macro" class="signature"><strong>issue_for</strong>(*args, **kwargs, &block)</a>
<div class="summary"><p>Adds an issue to the <em>source</em></p></div>
</li>
</ul>
<h2>
<a id="instance-method-summary" class="anchor" href="#instance-method-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Instance Method Summary
</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#%3D%3D%28other%29-instance-method" class="signature"><strong>#==</strong>(other)</a>
<div class="summary"><p>Returns <code>false</code> (other can only be a <code>Value</code> here).</p></div>
</li>
<li class="entry-summary">
<a href="#catch%28source%3ASource%29-instance-method" class="signature"><strong>#catch</strong>(source : Source)</a>
<div class="summary"><p>A convenient addition to <code><a href="../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method">#test</a></code> method that does the same but returns a passed in <code>source</code> as an addition.</p></div>
</li>
<li class="entry-summary">
<a href="#excluded%3F%28source%29-instance-method" class="signature"><strong>#excluded?</strong>(source)</a>
<div class="summary"><p>Checks whether the source is excluded from this rule.</p></div>
</li>
<li class="entry-summary">
<a href="#group-instance-method" class="signature"><strong>#group</strong></a>
<div class="summary"><p>Returns a group this rule belong to.</p></div>
</li>
<li class="entry-summary">
<a href="#hash-instance-method" class="signature"><strong>#hash</strong></a>
<div class="summary"><p>Generates an <code>UInt64</code> hash value for this object.</p></div>
</li>
<li class="entry-summary">
<a href="#name-instance-method" class="signature"><strong>#name</strong></a>
<div class="summary"><p>Returns a name of this rule, which is basically a class name.</p></div>
</li>
<li class="entry-summary">
<a href="#special%3F-instance-method" class="signature"><strong>#special?</strong></a>
<div class="summary"><p>Returns <code>true</code> if this rule is special and behaves differently than usual rules.</p></div>
</li>
<li class="entry-summary">
<a href="#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="signature"><strong>#test</strong>(source : Source, node : Crystal::ASTNode, *opts)</a>
<div class="summary"><p><span class="flag purple">NOTE</span> Can't be abstract</p></div>
</li>
<li class="entry-summary">
<a href="#test%28source%3ASource%29-instance-method" class="signature"><strong>#test</strong>(source : Source)</a>
<div class="summary"><p>This method is designed to test the source passed in.</p></div>
</li>
</ul>
<div class="methods-inherited">
<h3>Macros inherited from module <code>Ameba::Config::RuleConfig</code></h3>
<a href="../../Ameba/Config/RuleConfig.html#properties%28%26block%29-macro" class="tooltip">
<span>properties(&block)</span>
properties</a>
</div>
<h2>
<a id="class-method-detail" class="anchor" href="#class-method-detail">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Class Method Detail
</h2>
<div class="entry-detail" id="default_severity:Ameba::Severity-class-method">
<div class="signature">
def self.<strong>default_severity</strong> : <a href="../../Ameba/Severity.html">Ameba::Severity</a>
<a class="method-permalink" href="#default_severity%3AAmeba%3A%3ASeverity-class-method">#</a>
</div>
<br/>
<div>
</div>
</div>
<h2>
<a id="macro-detail" class="anchor" href="#macro-detail">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Macro Detail
</h2>
<div class="entry-detail" id="issue_for(*args,**kwargs,&amp;block)-macro">
<div class="signature">
macro <strong>issue_for</strong>(*args, **kwargs, &block)
<a class="method-permalink" href="#issue_for%28%2Aargs%2C%2A%2Akwargs%2C%26block%29-macro">#</a>
</div>
<div class="doc">
<p>Adds an issue to the <em>source</em></p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L117" target="_blank">View source</a>]
</div>
</div>
<h2>
<a id="instance-method-detail" class="anchor" href="#instance-method-detail">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Instance Method Detail
</h2>
<div class="entry-detail" id="==(other)-instance-method">
<div class="signature">
def <strong>==</strong>(other)
<a class="method-permalink" href="#%3D%3D%28other%29-instance-method">#</a>
</div>
<div class="doc">
<div class="doc-inherited">
Description copied from class Reference
</div>
<p>Returns <code>false</code> (other can only be a <code>Value</code> here).</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L108" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="catch(source:Source)-instance-method">
<div class="signature">
def <strong>catch</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#catch%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
<p>A convenient addition to <code><a href="../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method">#test</a></code> method that does the same
but returns a passed in <code>source</code> as an addition.</p>
<pre><code class="language-crystal">source <span class="o">=</span> <span class="t">MyRule</span>.new.catch(source)
source.valid?</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L53" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="excluded?(source)-instance-method">
<div class="signature">
def <strong>excluded?</strong>(source)
<a class="method-permalink" href="#excluded%3F%28source%29-instance-method">#</a>
</div>
<div class="doc">
<p>Checks whether the source is excluded from this rule.
It searches for a path in <code>excluded</code> property which matches
the one of the given source.</p>
<pre><code class="language-crystal">my_rule.excluded?(source) <span class="c"># =&gt; true or false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L91" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="group-instance-method">
<div class="signature">
def <strong>group</strong>
<a class="method-permalink" href="#group-instance-method">#</a>
</div>
<div class="doc">
<p>Returns a group this rule belong to.</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">MyGroup</span><span class="t">::</span><span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<span class="c"># ...</span>
<span class="k">end</span>
<span class="t">MyGroup</span><span class="t">::</span><span class="t">MyRule</span>.new.group <span class="c"># =&gt; &quot;MyGroup&quot;</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L80" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="hash-instance-method">
<div class="signature">
def <strong>hash</strong>
<a class="method-permalink" href="#hash-instance-method">#</a>
</div>
<div class="doc">
<div class="doc-inherited">
Description copied from class Object
</div>
<p>Generates an <code>UInt64</code> hash value for this object.</p>
<p>This method must have the property that <code>a == b</code> implies <code>a.hash == b.hash</code>.</p>
<p>The hash value is used along with <code><a href="../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method">#==</a></code> by the <code>Hash</code> class to determine if two objects
reference the same hash key.</p>
<p>Subclasses must not override this method. Instead, they must define <code>hash(hasher)</code>,
though usually the macro <code>def_hash</code> can be used to generate this method.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L112" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="name-instance-method">
<div class="signature">
def <strong>name</strong>
<a class="method-permalink" href="#name-instance-method">#</a>
</div>
<div class="doc">
<p>Returns a name of this rule, which is basically a class name.</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<span class="k">def</span> <span class="m">test</span>(source)
<span class="k">end</span>
<span class="k">end</span>
<span class="t">MyRule</span>.new.name <span class="c"># =&gt; &quot;MyRule&quot;</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L67" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="special?-instance-method">
<div class="signature">
def <strong>special?</strong>
<a class="method-permalink" href="#special%3F-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if this rule is special and behaves differently than
usual rules.</p>
<pre><code class="language-crystal">my_rule.special? <span class="c"># =&gt; true or false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L104" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="test(source:Source,node:Crystal::ASTNode,*opts)-instance-method">
<div class="signature">
def <strong>test</strong>(source : <a href="../../Ameba/Source.html">Source</a>, node : Crystal::ASTNode, *opts)
<a class="method-permalink" href="#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method">#</a>
</div>
<div class="doc">
<p><span class="flag purple">NOTE</span> Can't be abstract</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L43" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="test(source:Source)-instance-method">
<div class="signature">
def <strong>test</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#test%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
<p>This method is designed to test the source passed in. If source has issues
that are tested by this rule, it should add an issue.</p>
<p>By default it uses a node visitor to traverse all the nodes in the source.</p>
<p><span class="flag purple">NOTE</span> Must be overridden for other type of rules.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/a42b218/src/ameba/rule/base.cr#L38" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink