2021-01-11 14:49:07 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2021-01-12 10:04:15 +00:00
< meta name = "generator" content = "Crystal Docs 0.34.0" >
< meta name = "crystal_docs.project_version" content = "master" >
2021-01-11 14:49:07 +00:00
< 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 >
2021-01-12 10:04:15 +00:00
< svg class = "hidden" >
< symbol id = "octicon-link" viewBox = "0 0 16 16" >
< path 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 >
< meta id = "repository-name" content = "ameba" >
< title > Ameba::Rule::Base - ameba master< / title >
2021-01-11 14:49:07 +00:00
< script type = "text/javascript" >
CrystalDocs.base_path = "../../";
< / script >
< / head >
< body >
< 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" >
2021-01-12 10:04:15 +00:00
master
2021-01-11 14:49:07 +00:00
< / span >
< / div >
< / div >
2021-01-12 10:04:15 +00:00
< div class = "search-results" class = "hidden" >
2021-01-11 14:49:07 +00:00
< 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 = " " data-id = "ameba/Ameba/AST/NodeVisitor" data-name = "ameba::ast::nodevisitor" >
< a href = "../../Ameba/AST/NodeVisitor.html" > NodeVisitor< / a >
< / 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/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/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 = " " data-id = "ameba/Ameba/Issue" data-name = "ameba::issue" >
< a href = "../../Ameba/Issue.html" > Issue< / a >
< / 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/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/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/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/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/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/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/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/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/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/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/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/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/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/ConstantNames" data-name = "ameba::rule::style::constantnames" >
< a href = "../../Ameba/Rule/Style/ConstantNames.html" > ConstantNames< / 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/MethodNames" data-name = "ameba::rule::style::methodnames" >
< a href = "../../Ameba/Rule/Style/MethodNames.html" > MethodNames< / 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/PredicateName" data-name = "ameba::rule::style::predicatename" >
< a href = "../../Ameba/Rule/Style/PredicateName.html" > PredicateName< / 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/TypeNames" data-name = "ameba::rule::style::typenames" >
< a href = "../../Ameba/Rule/Style/TypeNames.html" > TypeNames< / 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/VariableNames" data-name = "ameba::rule::style::variablenames" >
< a href = "../../Ameba/Rule/Style/VariableNames.html" > VariableNames< / 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 = " " data-id = "ameba/Ameba/Runner" data-name = "ameba::runner" >
< a href = "../../Ameba/Runner.html" > Runner< / a >
< / 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 = " " data-id = "ameba/Ameba/Source" data-name = "ameba::source" >
< a href = "../../Ameba/Source.html" > Source< / a >
< / 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 struct< / span > Ameba::Rule::Base
< / h1 >
< ul class = "superclass-hierarchy" > < li class = "superclass" > < a href = "../../Ameba/Rule/Base.html" > Ameba::Rule::Base< / a > < / li > < li class = "superclass" > Struct< / li > < li class = "superclass" > Value< / 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 >
2021-01-12 10:04:15 +00:00
< pre > < code > < span class = "k" > struct< / span > < span class = "t" > MyRule< / span > < span class = "o" > < < / span > < span class = "t" > Ameba< / span > < span class = "t" > ::< / span > < span class = "t" > Rule< / span > < span class = "t" > ::< / span > < span class = "t" > Base< / span >
2021-01-11 14:49:07 +00:00
< 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" > " Something wrong." < / 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(source:Source,node:Crystal::ASTNode,*opts)-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/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/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/DebuggerStatement.html" > Ameba::Rule::Lint::DebuggerStatement< / 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/HashDuplicatedKey.html" > Ameba::Rule::Lint::HashDuplicatedKey< / 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/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/Syntax.html" > Ameba::Rule::Lint::Syntax< / 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/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/Performance/AnyAfterFilter.html" > Ameba::Rule::Performance::AnyAfterFilter< / a > < / li >
< li class = "other-type" > < a href = "../../Ameba/Rule/Performance/FirstLastAfterFilter.html" > Ameba::Rule::Performance::FirstLastAfterFilter< / a > < / li >
< li class = "other-type" > < a href = "../../Ameba/Rule/Performance/SizeAfterFilter.html" > Ameba::Rule::Performance::SizeAfterFilter< / a > < / li >
< li class = "other-type" > < a href = "../../Ameba/Rule/Style/ConstantNames.html" > Ameba::Rule::Style::ConstantNames< / 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/MethodNames.html" > Ameba::Rule::Style::MethodNames< / 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/PredicateName.html" > Ameba::Rule::Style::PredicateName< / 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/TypeNames.html" > Ameba::Rule::Style::TypeNames< / 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/VariableNames.html" > Ameba::Rule::Style::VariableNames< / 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 >
2021-01-12 10:04:15 +00:00
2021-01-26 16:23:07 +00:00
< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L30" target = "_blank" >
2021-01-12 10:04:15 +00:00
ameba/rule/base.cr
< / a >
< br / >
2021-01-11 14:49:07 +00:00
< h2 >
< a id = "constructors" class = "anchor" href = "#constructors" >
< svg class = "octicon-link" aria-hidden = "true" >
< use href = "#octicon-link" / >
< / svg >
< / a >
Constructors
< / h2 >
< ul class = "list-summary" >
< li class = "entry-summary" >
< a href = "#new-class-method" class = "signature" > < strong > .new< / strong > < / a >
< / li >
< / ul >
< 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 = "#parsed_doc-class-method" class = "signature" > < strong > .parsed_doc< / strong > < / a >
< div class = "summary" > < p > Returns documentation for this rule if any.< / 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 = "#==(other)-instance-method" class = "signature" > < strong > #==< / strong > (other)< / a >
< div class = "summary" > < p > Returns < code > true< / code > if this struct is equal to < em > other< / em > .< / p > < / div >
< / li >
< li class = "entry-summary" >
< a href = "#catch(source:Source)-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(source:Source,node:Crystal::ASTNode,*opts)-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?(source)-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?-instance-method" class = "signature" > < strong > #special?< / strong > < / a >
< div class = "summary" > < p > Returns true if this rule is special and behaves differently than usual rules.< / p > < / div >
< / li >
< li class = "entry-summary" >
< a href = "#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class = "signature" > < strong > #test< / strong > (source : Source, node : Crystal::ASTNode, *opts)< / a >
< / li >
< li class = "entry-summary" >
< a href = "#test(source:Source)-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 >
< 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(*args)-macro" class = "signature" > < strong > issue_for< / strong > (*args)< / a >
< / li >
< / ul >
< div class = "methods-inherited" >
< / div >
< h2 >
< a id = "constructor-detail" class = "anchor" href = "#constructor-detail" >
< svg class = "octicon-link" aria-hidden = "true" >
< use href = "#octicon-link" / >
< / svg >
< / a >
Constructor Detail
< / h2 >
< div class = "entry-detail" id = "new-class-method" >
< div class = "signature" >
def self.< strong > new< / strong >
< a class = "method-permalink" href = "#new-class-method" > #< / a >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L30" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / div >
< / 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 = "parsed_doc-class-method" >
< div class = "signature" >
def self.< strong > parsed_doc< / strong >
< a class = "method-permalink" href = "#parsed_doc-class-method" > #< / a >
< / div >
< div class = "doc" >
< p > Returns documentation for this rule if any.< / p >
2021-01-12 10:04:15 +00:00
< pre > < code > < span class = "k" > module< / span > < span class = "t" > Ameba< / span >
2021-01-11 14:49:07 +00:00
< span class = "c" > # This is a test rule.< / span >
< span class = "c" > # Does nothing.< / span >
< span class = "k" > struct< / span > < span class = "t" > MyRule< / span > < span class = "o" > < < / 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 = "k" > end< / span >
< span class = "t" > MyRule< / span > .parsed_doc < span class = "c" > # => " This is a test rule.\nDoes nothing." < / span > < / code > < / pre >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L157" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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 = "#==(other)-instance-method" > #< / a >
< / div >
< div class = "doc" >
< div class = "doc-inherited" >
Description copied from struct Struct
< / div >
< p > Returns < code > true< / code > if this struct is equal to < em > other< / em > .< / p >
2021-01-12 10:04:15 +00:00
< p > Both structs's instance vars are compared to each other. Thus, two
2021-01-11 14:49:07 +00:00
structs are considered equal if each of their instance variables are
equal. Subclasses should override this method to provide specific
equality semantics.< / p >
2021-01-12 10:04:15 +00:00
< pre > < code > < span class = "k" > struct< / span > < span class = "t" > Point< / span >
2021-01-11 14:49:07 +00:00
< span class = "k" > def< / span > < span class = "m" > initialize< / span > (@x : < span class = "t" > Int32< / span > , @y : < span class = "t" > Int32< / span > )
< span class = "k" > end< / span >
< span class = "k" > end< / span >
p1 < span class = "o" > =< / span > < span class = "t" > Point< / span > .< span class = "k" > new< / span > < span class = "n" > 1< / span > , < span class = "n" > 2< / span >
p2 < span class = "o" > =< / span > < span class = "t" > Point< / span > .< span class = "k" > new< / span > < span class = "n" > 1< / span > , < span class = "n" > 2< / span >
p3 < span class = "o" > =< / span > < span class = "t" > Point< / span > .< span class = "k" > new< / span > < span class = "n" > 3< / span > , < span class = "n" > 4< / span >
p1 < span class = "o" > ==< / span > p2 < span class = "c" > # => true< / span >
p1 < span class = "o" > ==< / span > p3 < span class = "c" > # => false< / span > < / code > < / pre >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L113" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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(source:Source)-instance-method" > #< / a >
< / div >
< div class = "doc" >
< p > A convenient addition to < code > < a href = "../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" > #test< / a > < / code > method that does the same
but returns a passed in < code > source< / code > as an addition.< / p >
2021-01-12 10:04:15 +00:00
< pre > < code > source < span class = "o" > =< / span > < span class = "t" > MyRule< / span > .< span class = "k" > new< / span > .catch(source)
2021-01-11 14:49:07 +00:00
source.valid?< / code > < / pre >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L54" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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?(source)-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 >
2021-01-12 10:04:15 +00:00
< pre > < code > my_rule.excluded?(source) < span class = "c" > # => true or false< / span > < / code > < / pre >
2021-01-11 14:49:07 +00:00
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L95" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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 >
2021-01-12 10:04:15 +00:00
< pre > < code > < span class = "k" > struct< / span > < span class = "t" > MyGroup< / span > < span class = "t" > ::< / span > < span class = "t" > MyRule< / span > < span class = "o" > < < / span > < span class = "t" > Ameba< / span > < span class = "t" > ::< / span > < span class = "t" > Rule< / span > < span class = "t" > ::< / span > < span class = "t" > Base< / span >
2021-01-11 14:49:07 +00:00
< span class = "c" > # ...< / span >
< span class = "k" > end< / span >
< span class = "t" > MyGroup< / span > < span class = "t" > ::< / span > < span class = "t" > MyRule< / span > .< span class = "k" > new< / span > .group < span class = "c" > # => " MyGroup" < / span > < / code > < / pre >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L83" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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 >
2021-01-12 10:04:15 +00:00
< p > This method must have the property that < code > a == b< / code > implies < code > a< a href = "../../Ameba/Rule/Base.html#hash-instance-method" > .hash< / a > == b< a href = "../../Ameba/Rule/Base.html#hash-instance-method" > .hash< / a > < / code > .< / p >
2021-01-11 14:49:07 +00:00
< p > The hash value is used along with < code > < a href = "../../Ameba/Rule/Base.html#==(other)-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 >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L117" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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 >
2021-01-12 10:04:15 +00:00
< pre > < code > < span class = "k" > struct< / span > < span class = "t" > MyRule< / span > < span class = "o" > < < / span > < span class = "t" > Ameba< / span > < span class = "t" > ::< / span > < span class = "t" > Rule< / span > < span class = "t" > ::< / span > < span class = "t" > Base< / span >
2021-01-11 14:49:07 +00:00
< 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 > .< span class = "k" > new< / span > .name < span class = "c" > # => " MyRule" < / span > < / code > < / pre >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L69" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / div >
< / div >
< div class = "entry-detail" id = "special?-instance-method" >
< div class = "signature" >
def < strong > special?< / strong >
< a class = "method-permalink" href = "#special?-instance-method" > #< / a >
< / div >
< div class = "doc" >
< p > Returns true if this rule is special and behaves differently than
usual rules.< / p >
2021-01-12 10:04:15 +00:00
< pre > < code > my_rule.special? < span class = "c" > # => true or false< / span > < / code > < / pre >
2021-01-11 14:49:07 +00:00
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L109" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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(source:Source,node:Crystal::ASTNode,*opts)-instance-method" > #< / a >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L42" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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(source:Source)-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 > Be default it uses a node visitor to traverse all the nodes in the source.
Must be overriten for other type of rules.< / p >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L38" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / 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)-macro" >
< div class = "signature" >
macro < strong > issue_for< / strong > (*args)
< a class = "method-permalink" href = "#issue_for(*args)-macro" > #< / a >
< / div >
< br / >
< div >
2021-01-26 16:23:07 +00:00
[< a href = "https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/rule/base.cr#L121" target = "_blank" > View source< / a > ]
2021-01-12 10:04:15 +00:00
2021-01-11 14:49:07 +00:00
< / div >
< / div >
< / div >
< / body >
< / html >
