Class: RuboCop::Cop::Cop

Inherits:
Object
  • Object
show all
Extended by:
NodePattern::Macros, Sexp
Includes:
AutocorrectLogic, IgnoredNode, Util, Sexp
Defined in:
lib/rubocop/cop/cop.rb,
lib/rubocop/rspec/cop_helper.rb

Overview

Monkey-patch Cop for tests to provide easy access to messages and highlights.

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::FloatOutOfRange, Lint::FormatParameterMismatch, Lint::HandleExceptions, Lint::ImplicitStringConcatenation, Lint::IneffectiveAccessModifier, Lint::InheritException, Lint::InvalidCharacterLiteral, Lint::LiteralInCondition, Lint::LiteralInInterpolation, Lint::Loop, Lint::NestedMethodDefinition, Lint::NextWithoutAccumulator, Lint::NonLocalExitFromIterator, Lint::ParenthesesAsGroupedExpression, Lint::PercentStringArray, Lint::PercentSymbolArray, Lint::RandOne, Lint::RequireParentheses, Lint::RescueException, Lint::ShadowedException, Lint::ShadowingOuterLocalVariable, Lint::StringConversionInInterpolation, Lint::UnderscorePrefixedVariableName, Lint::UnneededDisable, Lint::UnreachableCode, Lint::UnusedBlockArgument, Lint::UnusedMethodArgument, Lint::UselessAccessModifier, Lint::UselessArraySplat, 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::Casecmp, Performance::Count, Performance::Detect, Performance::DoubleStartEndWith, Performance::EndWith, Performance::FixedSize, Performance::FlatMap, Performance::HashEachMethods, Performance::LstripRstrip, Performance::PushSplat, Performance::RangeInclude, Performance::RedundantBlockCall, Performance::RedundantMatch, Performance::RedundantMerge, Performance::RedundantSortBy, Performance::ReverseEach, Performance::Sample, Performance::Size, Performance::StartWith, Performance::StringReplacement, Performance::TimesMap, Rails::ActionFilter, Rails::Date, Rails::Delegate, Rails::Exit, Rails::FindBy, Rails::FindEach, Rails::HasAndBelongsToMany, Rails::Output, Rails::OutputSafety, Rails::PluralizationGrammar, Rails::ReadWriteAttribute, Rails::RequestReferer, Rails::ScopeArgs, Rails::TimeZone, Rails::UniqBeforePluck, 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::ConditionalAssignment, Style::ConstantName, Style::Copyright, Style::DefWithParentheses, Style::Documentation, Style::DotPosition, Style::DoubleNegation, Style::EachForSimpleLoop, Style::EachWithObject, Style::ElseAlignment, Style::EmptyCaseCondition, 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::FirstArrayElementLineBreak, Style::FirstHashElementLineBreak, Style::FirstMethodArgumentLineBreak, Style::FirstMethodParameterLineBreak, Style::FirstParameterIndentation, Style::FlipFlop, Style::For, Style::FormatString, Style::FrozenStringLiteralComment, Style::GlobalVars, Style::GuardClause, Style::HashSyntax, Style::IdenticalConditionalBranches, Style::IfInsideElse, Style::IfUnlessModifier, Style::IfUnlessModifierOfIfUnless, Style::IfWithSemicolon, Style::ImplicitRuntimeError, Style::IndentArray, Style::IndentAssignment, 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::MultilineArrayBraceLayout, Style::MultilineAssignmentLayout, Style::MultilineBlockChain, Style::MultilineBlockLayout, Style::MultilineHashBraceLayout, Style::MultilineIfThen, Style::MultilineMethodCallBraceLayout, Style::MultilineMethodCallIndentation, Style::MultilineMethodDefinitionBraceLayout, Style::MultilineOperationIndentation, Style::MultilineTernaryOperator, Style::MutableConstant, Style::NegatedIf, Style::NegatedWhile, Style::NestedModifier, Style::NestedParenthesizedCalls, Style::NestedTernaryOperator, Style::Next, Style::NilComparison, Style::NonNilCheck, Style::Not, Style::NumericLiteralPrefix, Style::NumericLiterals, Style::OneLineConditional, Style::OpMethod, Style::OptionHash, Style::OptionalArguments, Style::ParallelAssignment, Style::ParenthesesAroundCondition, Style::PercentLiteralDelimiters, Style::PercentQLiterals, Style::PerlBackrefs, Style::PredicateName, Style::PreferredHashMethods, Style::Proc, Style::RaiseArgs, Style::RedundantBegin, Style::RedundantException, Style::RedundantFreeze, Style::RedundantParentheses, Style::RedundantReturn, Style::RedundantSelf, Style::RegexpLiteral, Style::RescueEnsureAlignment, Style::RescueModifier, Style::SelfAssignment, Style::Semicolon, Style::Send, Style::SignalException, Style::SingleLineBlockParams, Style::SingleLineMethods, Style::SpaceAfterColon, Style::SpaceAfterComma, Style::SpaceAfterMethodName, Style::SpaceAfterNot, Style::SpaceAfterSemicolon, Style::SpaceAroundBlockParameters, Style::SpaceAroundEqualsInParameterDefault, Style::SpaceAroundKeyword, Style::SpaceAroundOperators, Style::SpaceBeforeBlockBraces, Style::SpaceBeforeComma, Style::SpaceBeforeComment, Style::SpaceBeforeFirstArg, Style::SpaceBeforeSemicolon, Style::SpaceInsideArrayPercentLiteral, Style::SpaceInsideBlockBraces, Style::SpaceInsideBrackets, Style::SpaceInsideHashLiteralBraces, Style::SpaceInsideParens, Style::SpaceInsidePercentLiteralDelimiters, Style::SpaceInsideRangeLiteral, Style::SpaceInsideStringInterpolation, Style::SpecialGlobalVars, Style::StabbyLambdaParentheses, Style::StringLiterals, Style::StringLiteralsInInterpolation, Style::StringMethods, Style::StructInheritance, Style::SymbolArray, Style::SymbolLiteral, Style::SymbolProc, Style::Tab, Style::TrailingBlankLines, Style::TrailingCommaInArguments, Style::TrailingCommaInLiteral, Style::TrailingUnderscoreVariable, Style::TrailingWhitespace, Style::TrivialAccessors, Style::UnlessElse, Style::UnneededCapitalW, Style::UnneededInterpolation, Style::UnneededPercentQ, Style::VariableInterpolation, Style::VariableName, Style::WhenThen, Style::WhileUntilDo, Style::WhileUntilModifier, Style::WordArray, Style::ZeroLengthPredicate

Constant Summary

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from NodePattern::Macros

def_node_matcher, def_node_search, node_search_body

Methods included from Sexp

s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

#initialize(config = nil, options = nil) ⇒ Cop

Returns a new instance of Cop.


119
120
121
122
123
124
125
# File 'lib/rubocop/cop/cop.rb', line 119

def initialize(config = nil, options = nil)
  @config = config || Config.new
  @options = options || { debug: false }

  @offenses = []
  @corrections = []
end

Instance Attribute Details

#configObject (readonly)

Returns the value of attribute config


77
78
79
# File 'lib/rubocop/cop/cop.rb', line 77

def config
  @config
end

#correctionsObject (readonly)

Returns the value of attribute corrections


77
78
79
# File 'lib/rubocop/cop/cop.rb', line 77

def corrections
  @corrections
end

#offensesObject (readonly)

Returns the value of attribute offenses


77
78
79
# File 'lib/rubocop/cop/cop.rb', line 77

def offenses
  @offenses
end

#processed_sourceObject

TODO: Bad design.


78
79
80
# File 'lib/rubocop/cop/cop.rb', line 78

def processed_source
  @processed_source
end

Class Method Details

.allObject


82
83
84
# File 'lib/rubocop/cop/cop.rb', line 82

def self.all
  @all.without_type(:test)
end

.cop_nameObject


98
99
100
# File 'lib/rubocop/cop/cop.rb', line 98

def self.cop_name
  @cop_name ||= name.split('::').last(2).join('/')
end

.cop_typeObject


102
103
104
# File 'lib/rubocop/cop/cop.rb', line 102

def self.cop_type
  @cop_type ||= name.split('::')[-2].downcase.to_sym
end

.inherited(subclass) ⇒ Object


94
95
96
# File 'lib/rubocop/cop/cop.rb', line 94

def self.inherited(subclass)
  @all << subclass
end

.lint?Boolean

Returns:

  • (Boolean)

106
107
108
# File 'lib/rubocop/cop/cop.rb', line 106

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.

Returns:

  • (Boolean)

112
113
114
115
116
117
# File 'lib/rubocop/cop/cop.rb', line 112

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_railsObject


90
91
92
# File 'lib/rubocop/cop/cop.rb', line 90

def self.non_rails
  all.without_type(:rails)
end

.qualified_cop_name(name, origin) ⇒ Object


86
87
88
# File 'lib/rubocop/cop/cop.rb', line 86

def self.qualified_cop_name(name, origin)
  @all.qualified_cop_name(name, origin)
end

Instance Method Details

#add_offense(node, loc, message = nil, severity = nil) ⇒ Object


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/rubocop/cop/cop.rb', line 158

def add_offense(node, loc, message = nil, severity = nil)
  location = loc.is_a?(Symbol) ? node.loc.public_send(loc) : loc

  # Don't include the same location twice for one cop.
  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_offensesObject


185
186
187
188
# File 'lib/rubocop/cop/cop.rb', line 185

def config_to_allow_offenses
  Formatter::DisabledConfigFormatter
    .config_to_allow_offenses[cop_name] ||= {}
end

#config_to_allow_offenses=(hash) ⇒ Object


190
191
192
193
# File 'lib/rubocop/cop/cop.rb', line 190

def config_to_allow_offenses=(hash)
  Formatter::DisabledConfigFormatter.config_to_allow_offenses[cop_name] =
    hash
end

#cop_configObject


131
132
133
# File 'lib/rubocop/cop/cop.rb', line 131

def cop_config
  @cop_config ||= @config.for_cop(self)
end

#cop_nameObject Also known as: name


203
204
205
# File 'lib/rubocop/cop/cop.rb', line 203

def cop_name
  @cop_name ||= self.class.cop_name
end

#correct(node) ⇒ Object


175
176
177
178
179
180
181
182
183
# File 'lib/rubocop/cop/cop.rb', line 175

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

Returns:

  • (Boolean)

135
136
137
# File 'lib/rubocop/cop/cop.rb', line 135

def debug?
  @options[:debug]
end

#detailsObject


228
229
230
231
# File 'lib/rubocop/cop/cop.rb', line 228

def details
  details = cop_config && cop_config['Details']
  (details.nil? || details.empty?) ? nil : details
end

#display_cop_names?Boolean

Returns:

  • (Boolean)

139
140
141
142
# File 'lib/rubocop/cop/cop.rb', line 139

def display_cop_names?
  debug? || @options[:display_cop_names] ||
    @config.for_all_cops['DisplayCopNames']
end

#display_style_guide?Boolean

Returns:

  • (Boolean)

144
145
146
147
148
# File 'lib/rubocop/cop/cop.rb', line 144

def display_style_guide?
  (style_guide_url || reference_url) &&
    (@options[:display_style_guide] ||
      config.for_all_cops['DisplayStyleGuide'])
end

#excluded_file?(file) ⇒ Boolean

Returns:

  • (Boolean)

214
215
216
# File 'lib/rubocop/cop/cop.rb', line 214

def excluded_file?(file)
  !relevant_file?(file)
end

#extra_details?Boolean

Returns:

  • (Boolean)

150
151
152
# File 'lib/rubocop/cop/cop.rb', line 150

def extra_details?
  @options[:extra_details] || config.for_all_cops['ExtraDetails']
end

#highlightsObject


75
76
77
# File 'lib/rubocop/rspec/cop_helper.rb', line 75

def highlights
  offenses.sort.map { |o| o.location.source }
end

#join_force?(_force_class) ⇒ Boolean

Returns:

  • (Boolean)

127
128
129
# File 'lib/rubocop/cop/cop.rb', line 127

def join_force?(_force_class)
  false
end

#message(_node = nil) ⇒ Object


154
155
156
# File 'lib/rubocop/cop/cop.rb', line 154

def message(_node = nil)
  self.class::MSG
end

#messagesObject


71
72
73
# File 'lib/rubocop/rspec/cop_helper.rb', line 71

def messages
  offenses.sort.map(&:message)
end

#parse(source, path = nil) ⇒ Object


199
200
201
# File 'lib/rubocop/cop/cop.rb', line 199

def parse(source, path = nil)
  ProcessedSource.new(source, target_ruby_version, path)
end

#reference_urlObject


223
224
225
226
# File 'lib/rubocop/cop/cop.rb', line 223

def reference_url
  url = cop_config['Reference']
  (url.nil? || url.empty?) ? nil : url
end

#relevant_file?(file) ⇒ Boolean

Returns:

  • (Boolean)

209
210
211
212
# File 'lib/rubocop/cop/cop.rb', line 209

def relevant_file?(file)
  file_name_matches_any?(file, 'Include', true) &&
    !file_name_matches_any?(file, 'Exclude', false)
end

#style_guide_urlObject


218
219
220
221
# File 'lib/rubocop/cop/cop.rb', line 218

def style_guide_url
  url = cop_config['StyleGuide']
  (url.nil? || url.empty?) ? nil : url
end

#target_ruby_versionObject


195
196
197
# File 'lib/rubocop/cop/cop.rb', line 195

def target_ruby_version
  @config.target_ruby_version
end