class RuboCop::CommentConfig
and provides a way to check if each cop is enabled at arbitrary line.
This class parses the special ‘rubocop:disable` comments in a source
def all_cop_names
def all_cop_names @all_cop_names ||= Cop::Cop.registry.names - [UNNEEDED_DISABLE] end
def analyze
def analyze analyses = Hash.new { |hash, key| hash[key] = CopAnalysis.new([], nil) } each_mentioned_cop do |cop_name, disabled, line, single_line| analyses[cop_name] = analyze_cop(analyses[cop_name], disabled, line, single_line) end analyses.each_with_object({}) do |element, hash| cop_name, analysis = *element hash[cop_name] = cop_line_ranges(analysis) end end
def analyze_cop(analysis, disabled, line, single_line)
def analyze_cop(analysis, disabled, line, single_line) if single_line analyze_single_line(analysis, line, disabled) elsif disabled analyze_disabled(analysis, line) else analyze_rest(analysis, line) end end
def analyze_disabled(analysis, line)
def analyze_disabled(analysis, line) if (start_line = analysis.start_line_number) # Cop already disabled on this line, so we end the current disabled # range before we start a new range. return CopAnalysis.new(analysis.line_ranges + [start_line..line], line) end CopAnalysis.new(analysis.line_ranges, line) end
def analyze_rest(analysis, line)
def analyze_rest(analysis, line) if (start_line = analysis.start_line_number) return CopAnalysis.new(analysis.line_ranges + [start_line..line], nil) end CopAnalysis.new(analysis.line_ranges, nil) end
def analyze_single_line(analysis, line, disabled)
def analyze_single_line(analysis, line, disabled) return analysis unless disabled CopAnalysis.new(analysis.line_ranges + [(line..line)], analysis.start_line_number) end
def comment_only_line?(line_number)
def comment_only_line?(line_number) non_comment_token_line_numbers.none? do |non_comment_line_number| non_comment_line_number == line_number end end
def cop_disabled_line_ranges
def cop_disabled_line_ranges @cop_disabled_line_ranges ||= analyze end
def cop_enabled_at_line?(cop, line_number)
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
def cop_line_ranges(analysis)
def cop_line_ranges(analysis) return analysis.line_ranges unless analysis.start_line_number analysis.line_ranges + [(analysis.start_line_number..Float::INFINITY)] end
def directive_parts(comment)
def directive_parts(comment) match = comment.text.match(COMMENT_DIRECTIVE_REGEXP) return unless match switch, cops_string = match.captures cop_names = cops_string == 'all' ? all_cop_names : cops_string.split(/,\s*/) disabled = (switch == 'disable') [cop_names, disabled] end
def each_directive
def each_directive return if processed_source.comments.nil? processed_source.comments.each do |comment| directive = directive_parts(comment) next unless directive yield comment, *directive end end
def each_mentioned_cop
def each_mentioned_cop each_directive do |comment, cop_names, disabled| comment_line_number = comment.loc.expression.line single_line = !comment_only_line?(comment_line_number) cop_names.each do |cop_name| yield qualified_cop_name(cop_name), disabled, comment_line_number, single_line end end end
def initialize(processed_source)
def initialize(processed_source) @processed_source = processed_source end
def non_comment_token_line_numbers
def non_comment_token_line_numbers @non_comment_token_line_numbers ||= begin non_comment_tokens = processed_source.tokens.reject do |token| token.type == :tCOMMENT end non_comment_tokens.map { |token| token.pos.line }.uniq end end
def qualified_cop_name(cop_name)
def qualified_cop_name(cop_name) Cop::Cop.qualified_cop_name(cop_name.strip, processed_source.buffer.name) end