Class: RuboCop::CommentConfig
- Inherits:
-
Object
- Object
- RuboCop::CommentConfig
- Defined in:
- lib/rubocop/comment_config.rb
Overview
This class parses the special ‘rubocop:disable` comments in a source and provides a way to check if each cop is enabled at arbitrary line.
Defined Under Namespace
Classes: CopAnalysis
Constant Summary collapse
- UNNEEDED_DISABLE =
'Lint/UnneededCopDisableDirective'.freeze
- COP_NAME_PATTERN =
'([A-Z]\w+/)?(?:[A-Z]\w+)'.freeze
- COP_NAMES_PATTERN =
"(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}".freeze
- COPS_PATTERN =
"(all|#{COP_NAMES_PATTERN})".freeze
- COMMENT_DIRECTIVE_REGEXP =
Regexp.new( ('# rubocop : ((?:dis|en)able)\b ' + COPS_PATTERN).gsub(' ', '\s*') )
Instance Attribute Summary collapse
-
#processed_source ⇒ Object
readonly
Returns the value of attribute processed_source.
Instance Method Summary collapse
- #cop_disabled_line_ranges ⇒ Object
- #cop_enabled_at_line?(cop, line_number) ⇒ Boolean
- #extra_enabled_comments ⇒ Object
-
#initialize(processed_source) ⇒ CommentConfig
constructor
A new instance of CommentConfig.
Constructor Details
#initialize(processed_source) ⇒ CommentConfig
Returns a new instance of CommentConfig.
21 22 23 |
# File 'lib/rubocop/comment_config.rb', line 21 def initialize(processed_source) @processed_source = processed_source end |
Instance Attribute Details
#processed_source ⇒ Object (readonly)
Returns the value of attribute processed_source.
19 20 21 |
# File 'lib/rubocop/comment_config.rb', line 19 def processed_source @processed_source end |
Instance Method Details
#cop_disabled_line_ranges ⇒ Object
33 34 35 |
# File 'lib/rubocop/comment_config.rb', line 33 def cop_disabled_line_ranges @cop_disabled_line_ranges ||= analyze end |
#cop_enabled_at_line?(cop, line_number) ⇒ Boolean
25 26 27 28 29 30 31 |
# File 'lib/rubocop/comment_config.rb', line 25 def cop_enabled_at_line?(cop, line_number) cop = cop.cop_name if cop.respond_to?(:cop_name) disabled_line_ranges = cop_disabled_line_ranges[cop] return true unless disabled_line_ranges disabled_line_ranges.none? { |range| range.include?(line_number) } end |
#extra_enabled_comments ⇒ Object
37 38 39 |
# File 'lib/rubocop/comment_config.rb', line 37 def extra_enabled_comments extra_enabled_comments_with_names([], {}) end |