Class: RuboCop::Cop::Lint::Syntax

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/syntax.rb

Overview

This is actually not a cop and inspects nothing. It just provides methods to repack Parser’s diagnostics/errors into RuboCop’s offenses.

Defined Under Namespace

Classes: PseudoSourceRange

Constant Summary collapse

ERROR_SOURCE_RANGE = 
PseudoSourceRange.new(1, 0, '', 0, 1).freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Class Method Details

.offenses_from_processed_source(processed_source, config, options) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/rubocop/cop/lint/syntax.rb', line 14

def self.offenses_from_processed_source(processed_source,
                                        config, options)
  cop = new(config, options)

  if processed_source.parser_error
    cop.add_offense_from_error(processed_source.parser_error)
  end

  processed_source.diagnostics.each do |diagnostic|
    cop.add_offense_from_diagnostic(diagnostic,
                                    processed_source.ruby_version)
  end

  cop.offenses
end

Instance Method Details

#add_offense_from_diagnostic(diagnostic, ruby_version) ⇒ Object 



30
31
32
33
34
35
36
37
38
 
# File 'lib/rubocop/cop/lint/syntax.rb', line 30

def add_offense_from_diagnostic(diagnostic, ruby_version)
  message =
    "#{diagnostic.message}\n(Using Ruby #{ruby_version} parser; " \
    'configure using `TargetRubyVersion` parameter, under `AllCops`)'
  add_offense(nil,
              location: diagnostic.location,
              message: message,
              severity: diagnostic.level)
end

#add_offense_from_error(error) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/rubocop/cop/lint/syntax.rb', line 40

def add_offense_from_error(error)
  message = beautify_message(error.message)
  add_offense(nil,
              location: ERROR_SOURCE_RANGE,
              message: message,
              severity: :fatal)
end