Class: RuboCop::Cop::Cop
Overview
A scaffold for concrete cops.
The Cop class is meant to be extended.
Cops track offenses and can autocorrect them of the fly.
A commissioner object is responsible for traversing the AST and invoking
the specific callbacks on each cop.
If a cop needs to do its own processing of the AST or depends on
something else, it should define the #investigate
method and do
the processing there.
Direct Known Subclasses
Lint::AmbiguousOperator, Lint::AmbiguousRegexpLiteral, Lint::AssignmentInCondition, Lint::BlockAlignment, Lint::CircularArgumentReference, Lint::ConditionPosition, Lint::Debugger, Lint::DefEndAlignment, Lint::DeprecatedClassMethods, Lint::DuplicateMethods, Lint::DuplicatedKey, Lint::EachWithObjectArgument, Lint::ElseLayout, Lint::EmptyEnsure, Lint::EmptyInterpolation, Lint::EndAlignment, Lint::EndInMethod, Lint::EnsureReturn, Lint::Eval, Lint::FormatParameterMismatch, Lint::HandleExceptions, Lint::InvalidCharacterLiteral, Lint::LiteralInCondition, Lint::LiteralInInterpolation, Lint::Loop, Lint::NestedMethodDefinition, Lint::NonLocalExitFromIterator, Lint::ParenthesesAsGroupedExpression, Lint::RequireParentheses, Lint::RescueException, Lint::ShadowingOuterLocalVariable, Lint::SpaceBeforeFirstArg, Lint::StringConversionInInterpolation, Lint::UnderscorePrefixedVariableName, Lint::UnneededDisable, Lint::UnreachableCode, Lint::UnusedBlockArgument, Lint::UnusedMethodArgument, Lint::UselessAccessModifier, Lint::UselessAssignment, Lint::UselessComparison, Lint::UselessElseWithoutRescue, Lint::UselessSetterCall, Lint::Void, Metrics::AbcSize, Metrics::BlockNesting, Metrics::ClassLength, Metrics::CyclomaticComplexity, Metrics::LineLength, Metrics::MethodLength, Metrics::ModuleLength, Metrics::ParameterLists, Metrics::PerceivedComplexity, Performance::CaseWhenSplat, Performance::Count, Performance::Detect, Performance::FlatMap, Performance::ReverseEach, Performance::Sample, Performance::Size, Performance::StringReplacement, Rails::ActionFilter, Rails::Date, Rails::DefaultScope, Rails::Delegate, Rails::FindBy, Rails::FindEach, Rails::HasAndBelongsToMany, Rails::Output, Rails::ReadWriteAttribute, Rails::ScopeArgs, Rails::TimeZone, Rails::Validation, Style::AccessModifierIndentation, Style::AccessorMethodName, Style::Alias, Style::AlignArray, Style::AlignHash, Style::AlignParameters, Style::AndOr, Style::ArrayJoin, Style::AsciiComments, Style::AsciiIdentifiers, Style::Attr, Style::AutoResourceCleanup, Style::BarePercentLiterals, Style::BeginBlock, Style::BlockComments, Style::BlockDelimiters, Style::BlockEndNewline, Style::BracesAroundHashParameters, Style::CaseEquality, Style::CaseIndentation, Style::CharacterLiteral, Style::ClassAndModuleCamelCase, Style::ClassAndModuleChildren, Style::ClassCheck, Style::ClassMethods, Style::ClassVars, Style::ClosingParenthesisIndentation, Style::CollectionMethods, Style::ColonMethodCall, Style::CommandLiteral, Style::CommentAnnotation, Style::CommentIndentation, Style::ConstantName, Style::Copyright, Style::DefWithParentheses, Style::DeprecatedHashMethods, Style::Documentation, Style::DotPosition, Style::DoubleNegation, Style::EachWithObject, Style::ElseAlignment, Style::EmptyElse, Style::EmptyLineBetweenDefs, Style::EmptyLines, Style::EmptyLinesAroundAccessModifier, Style::EmptyLinesAroundBlockBody, Style::EmptyLinesAroundClassBody, Style::EmptyLinesAroundMethodBody, Style::EmptyLinesAroundModuleBody, Style::EmptyLiteral, Style::Encoding, Style::EndBlock, Style::EndOfLine, Style::EvenOdd, Style::ExtraSpacing, Style::FileName, Style::FirstParameterIndentation, Style::FlipFlop, Style::For, Style::FormatString, Style::GlobalVars, Style::GuardClause, Style::HashSyntax, Style::IfUnlessModifier, Style::IfWithSemicolon, Style::IndentArray, Style::IndentHash, Style::IndentationConsistency, Style::IndentationWidth, Style::InfiniteLoop, Style::InitialIndentation, Style::InlineComment, Style::Lambda, Style::LambdaCall, Style::LeadingCommentSpace, Style::LineEndConcatenation, Style::MethodCallParentheses, Style::MethodCalledOnDoEndBlock, Style::MethodDefParentheses, Style::MethodName, Style::MissingElse, Style::ModuleFunction, Style::MultilineBlockChain, Style::MultilineBlockLayout, Style::MultilineIfThen, Style::MultilineOperationIndentation, Style::MultilineTernaryOperator, Style::MutableConstant, Style::NegatedIf, Style::NegatedWhile, Style::NestedTernaryOperator, Style::Next, Style::NilComparison, Style::NonNilCheck, Style::Not, Style::NumericLiterals, Style::OneLineConditional, Style::OpMethod, Style::OptionHash, Style::OptionalArguments, Style::ParallelAssignment, Style::ParenthesesAroundCondition, Style::PercentLiteralDelimiters, Style::PercentQLiterals, Style::PerlBackrefs, Style::PredicateName, Style::Proc, Style::RaiseArgs, Style::RedundantBegin, Style::RedundantException, Style::RedundantFreeze, Style::RedundantReturn, Style::RedundantSelf, Style::RegexpLiteral, Style::RescueEnsureAlignment, Style::RescueModifier, Style::SelfAssignment, Style::Semicolon, Style::Send, Style::SignalException, Style::SingleLineBlockParams, Style::SingleLineMethods, Style::SingleSpaceBeforeFirstArg, Style::SpaceAfterColon, Style::SpaceAfterComma, Style::SpaceAfterControlKeyword, Style::SpaceAfterMethodName, Style::SpaceAfterNot, Style::SpaceAfterSemicolon, Style::SpaceAroundBlockParameters, Style::SpaceAroundEqualsInParameterDefault, Style::SpaceAroundOperators, Style::SpaceBeforeBlockBraces, Style::SpaceBeforeComma, Style::SpaceBeforeComment, Style::SpaceBeforeModifierKeyword, Style::SpaceBeforeSemicolon, Style::SpaceInsideBlockBraces, Style::SpaceInsideBrackets, Style::SpaceInsideHashLiteralBraces, Style::SpaceInsideParens, Style::SpaceInsideRangeLiteral, Style::SpaceInsideStringInterpolation, Style::SpecialGlobalVars, Style::StringLiterals, Style::StringLiteralsInInterpolation, Style::StringMethods, Style::StructInheritance, Style::SymbolArray, Style::SymbolLiteral, Style::SymbolProc, Style::Tab, Style::TrailingBlankLines, Style::TrailingComma, Style::TrailingUnderscoreVariable, Style::TrailingWhitespace, Style::TrivialAccessors, Style::UnlessElse, Style::UnneededCapitalW, Style::UnneededPercentQ, Style::VariableInterpolation, Style::VariableName, Style::WhenThen, Style::WhileUntilDo, Style::WhileUntilModifier, Style::WordArray
Constant Summary
Constants included
from Util
Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?
Methods included from PathUtil
hidden?, issue_deprecation_warning, match_path?, relative_path
Constructor Details
#initialize(config = nil, options = nil) ⇒ Cop
Returns a new instance of Cop.
110
111
112
113
114
115
116
|
# File 'lib/rubocop/cop/cop.rb', line 110
def initialize(config = nil, options = nil)
@config = config || Config.new
@options = options || { debug: false }
@offenses = []
@corrections = []
end
|
Instance Attribute Details
#config ⇒ Object
Returns the value of attribute config.
73
74
75
|
# File 'lib/rubocop/cop/cop.rb', line 73
def config
@config
end
|
#corrections ⇒ Object
Returns the value of attribute corrections.
73
74
75
|
# File 'lib/rubocop/cop/cop.rb', line 73
def corrections
@corrections
end
|
#offenses ⇒ Object
Returns the value of attribute offenses.
73
74
75
|
# File 'lib/rubocop/cop/cop.rb', line 73
def offenses
@offenses
end
|
#processed_source ⇒ Object
74
75
76
|
# File 'lib/rubocop/cop/cop.rb', line 74
def processed_source
@processed_source
end
|
Class Method Details
.all ⇒ Object
78
79
80
|
# File 'lib/rubocop/cop/cop.rb', line 78
def self.all
@all.without_type(:test)
end
|
.cop_name ⇒ Object
94
95
96
|
# File 'lib/rubocop/cop/cop.rb', line 94
def self.cop_name
@cop_name ||= name.to_s.split('::').last(2).join('/')
end
|
.cop_type ⇒ Object
98
99
100
|
# File 'lib/rubocop/cop/cop.rb', line 98
def self.cop_type
name.to_s.split('::')[-2].downcase.to_sym
end
|
.inherited(subclass) ⇒ Object
90
91
92
|
# File 'lib/rubocop/cop/cop.rb', line 90
def self.inherited(subclass)
@all << subclass
end
|
.lint? ⇒ Boolean
102
103
104
|
# File 'lib/rubocop/cop/cop.rb', line 102
def self.lint?
cop_type == :lint
end
|
.match?(given_names) ⇒ Boolean
Returns true if the cop name or the cop namespace matches any of the
given names.
143
144
145
146
147
148
|
# File 'lib/rubocop/cop/cop.rb', line 143
def self.match?(given_names)
return false unless given_names
given_names.include?(cop_name) ||
given_names.include?(cop_type.to_s.capitalize)
end
|
.non_rails ⇒ Object
86
87
88
|
# File 'lib/rubocop/cop/cop.rb', line 86
def self.non_rails
all.without_type(:rails)
end
|
.qualified_cop_name(name, origin) ⇒ Object
82
83
84
|
# File 'lib/rubocop/cop/cop.rb', line 82
def self.qualified_cop_name(name, origin)
@all.qualified_cop_name(name, origin)
end
|
.rails? ⇒ Boolean
106
107
108
|
# File 'lib/rubocop/cop/cop.rb', line 106
def self.rails?
cop_type == :rails
end
|
Instance Method Details
#add_offense(node, loc, message = nil, severity = nil) ⇒ Object
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
# File 'lib/rubocop/cop/cop.rb', line 154
def add_offense(node, loc, message = nil, severity = nil)
location = loc.is_a?(Symbol) ? node.loc.send(loc) : loc
return if @offenses.any? { |o| o.location == location }
severity = custom_severity || severity || default_severity
message ||= message(node)
message = annotate_message(message)
status = enabled_line?(location.line) ? correct(node) : :disabled
@offenses << Offense.new(severity, location, message, name, status)
yield if block_given? && status != :disabled
end
|
#config_to_allow_offenses ⇒ Object
#config_to_allow_offenses=(hash) ⇒ Object
#cop_config ⇒ Object
122
123
124
|
# File 'lib/rubocop/cop/cop.rb', line 122
def cop_config
@config.for_cop(self)
end
|
#cop_name ⇒ Object
Also known as:
name
190
191
192
|
# File 'lib/rubocop/cop/cop.rb', line 190
def cop_name
self.class.cop_name
end
|
#correct(node) ⇒ Object
171
172
173
174
175
176
177
178
179
|
# File 'lib/rubocop/cop/cop.rb', line 171
def correct(node)
return :unsupported unless support_autocorrect?
return :uncorrected unless autocorrect?
correction = autocorrect(node)
return :uncorrected unless correction
@corrections << correction
:corrected
end
|
#debug? ⇒ Boolean
126
127
128
|
# File 'lib/rubocop/cop/cop.rb', line 126
def debug?
@options[:debug]
end
|
#display_cop_names? ⇒ Boolean
130
131
132
133
|
# File 'lib/rubocop/cop/cop.rb', line 130
def display_cop_names?
debug? || @options[:display_cop_names] ||
config['AllCops'] && config['AllCops']['DisplayCopNames']
end
|
#display_style_guide? ⇒ Boolean
135
136
137
138
139
|
# File 'lib/rubocop/cop/cop.rb', line 135
def display_style_guide?
(style_guide_url || reference_url) &&
(@options[:display_style_guide] ||
config['AllCops'] && config['AllCops']['DisplayStyleGuide'])
end
|
#excluded_file?(file) ⇒ Boolean
201
202
203
|
# File 'lib/rubocop/cop/cop.rb', line 201
def excluded_file?(file)
!relevant_file?(file)
end
|
#join_force?(_force_class) ⇒ Boolean
118
119
120
|
# File 'lib/rubocop/cop/cop.rb', line 118
def join_force?(_force_class)
false
end
|
#message(_node = nil) ⇒ Object
150
151
152
|
# File 'lib/rubocop/cop/cop.rb', line 150
def message(_node = nil)
self.class::MSG
end
|
#reference_url ⇒ Object
210
211
212
213
|
# File 'lib/rubocop/cop/cop.rb', line 210
def reference_url
url = cop_config && cop_config['Reference']
(url.nil? || url.empty?) ? nil : url
end
|
#relevant_file?(file) ⇒ Boolean
196
197
198
199
|
# File 'lib/rubocop/cop/cop.rb', line 196
def relevant_file?(file)
file_name_matches_any?(file, 'Include', true) &&
!file_name_matches_any?(file, 'Exclude', false)
end
|
#style_guide_url ⇒ Object
205
206
207
208
|
# File 'lib/rubocop/cop/cop.rb', line 205
def style_guide_url
url = cop_config && cop_config['StyleGuide']
(url.nil? || url.empty?) ? nil : url
end
|