Class: RuboCop::ProcessedSource

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/processed_source.rb

Overview

ProcessedSource contains objects which are generated by Parser and other information such as disabled lines for cops. It also provides a convenient way to access source lines.

Constant Summary

STRING_SOURCE_NAME =
'(string)'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, ruby_version, path = nil) ⇒ ProcessedSource

Returns a new instance of ProcessedSource



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'lib/rubocop/processed_source.rb', line 22

def initialize(source, ruby_version, path = nil)
  # Defaults source encoding to UTF-8, regardless of the encoding it has
  # been read with, which could be non-utf8 depending on the default
  # external encoding.
  unless source.encoding == Encoding::UTF_8
    source.force_encoding(Encoding::UTF_8)
  end

  @raw_source = source
  @path = path
  @diagnostics = []
  @ruby_version = ruby_version
  @parser_error = nil

  parse(source, ruby_version)
end

Instance Attribute Details

#astObject (readonly)

Returns the value of attribute ast



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def ast
  @ast
end

#bufferObject (readonly)

Returns the value of attribute buffer



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def buffer
  @buffer
end

#commentsObject (readonly)

Returns the value of attribute comments



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def comments
  @comments
end

#diagnosticsObject (readonly)

Returns the value of attribute diagnostics



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def diagnostics
  @diagnostics
end

#parser_errorObject (readonly)

Returns the value of attribute parser_error



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def parser_error
  @parser_error
end

#pathObject (readonly)

Returns the value of attribute path



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def path
  @path
end

#raw_sourceObject (readonly)

Returns the value of attribute raw_source



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def raw_source
  @raw_source
end

#ruby_versionObject (readonly)

Returns the value of attribute ruby_version



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def ruby_version
  @ruby_version
end

#tokensObject (readonly)

Returns the value of attribute tokens



12
13
14
# File 'lib/rubocop/processed_source.rb', line 12

def tokens
  @tokens
end

Class Method Details

.from_file(path, ruby_version) ⇒ Object



15
16
17
18
19
20
# File 'lib/rubocop/processed_source.rb', line 15

def self.from_file(path, ruby_version)
  file = File.read(path, mode: 'rb')
  new(file, ruby_version, path)
rescue Errno::ENOENT
  raise RuboCop::Error, "No such file or directory: #{path}"
end

Instance Method Details

#[](*args) ⇒ Object



67
68
69
# File 'lib/rubocop/processed_source.rb', line 67

def [](*args)
  lines[*args]
end

#ast_with_commentsObject



47
48
49
50
# File 'lib/rubocop/processed_source.rb', line 47

def ast_with_comments
  return if !ast || !comments
  @ast_with_comments ||= Parser::Source::Comment.associate(ast, comments)
end

#blank?Boolean

Returns:

  • (Boolean)


101
102
103
# File 'lib/rubocop/processed_source.rb', line 101

def blank?
  ast.nil?
end

#checksumObject

Raw source checksum for tracking infinite loops.



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

def checksum
  Digest::MD5.hexdigest(@raw_source)
end

#comment_configObject



39
40
41
# File 'lib/rubocop/processed_source.rb', line 39

def comment_config
  @comment_config ||= CommentConfig.new(self)
end

#comment_on_line?(line) ⇒ Boolean

Returns:

  • (Boolean)


109
110
111
# File 'lib/rubocop/processed_source.rb', line 109

def comment_on_line?(line)
  comments.any? { |c| c.loc.line == line }
end

#commented?(source_range) ⇒ Boolean

Returns:

  • (Boolean)


105
106
107
# File 'lib/rubocop/processed_source.rb', line 105

def commented?(source_range)
  comment_lines.include?(source_range.line)
end

#comments_before_line(line) ⇒ Object



113
114
115
# File 'lib/rubocop/processed_source.rb', line 113

def comments_before_line(line)
  comments.select { |c| c.location.line <= line }
end

#disabled_line_rangesObject



43
44
45
# File 'lib/rubocop/processed_source.rb', line 43

def disabled_line_ranges
  comment_config.cop_disabled_line_ranges
end

#each_commentObject



81
82
83
# File 'lib/rubocop/processed_source.rb', line 81

def each_comment
  comments.each { |comment| yield comment }
end

#each_tokenObject



89
90
91
# File 'lib/rubocop/processed_source.rb', line 89

def each_token
  tokens.each { |token| yield token }
end

#file_pathObject



97
98
99
# File 'lib/rubocop/processed_source.rb', line 97

def file_path
  buffer.name
end

#find_commentObject



85
86
87
# File 'lib/rubocop/processed_source.rb', line 85

def find_comment
  comments.find { |comment| yield comment }
end

#find_tokenObject



93
94
95
# File 'lib/rubocop/processed_source.rb', line 93

def find_token
  tokens.find { |token| yield token }
end

#following_line(token) ⇒ Object



126
127
128
# File 'lib/rubocop/processed_source.rb', line 126

def following_line(token)
  lines[token.line]
end

#linesObject

Returns the source lines, line break characters removed, excluding a possible __END__ and everything that comes after.



54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/rubocop/processed_source.rb', line 54

def lines
  @lines ||= begin
    all_lines = @buffer.source_lines
    last_token_line = tokens.any? ? tokens.last.line : all_lines.size
    result = []
    all_lines.each_with_index do |line, ix|
      break if ix >= last_token_line && line == '__END__'
      result << line
    end
    result
  end
end

#preceding_line(token) ⇒ Object



122
123
124
# File 'lib/rubocop/processed_source.rb', line 122

def preceding_line(token)
  lines[token.line - 2]
end

#start_with?(string) ⇒ Boolean

Returns:

  • (Boolean)


117
118
119
120
# File 'lib/rubocop/processed_source.rb', line 117

def start_with?(string)
  return false if self[0].nil?
  self[0].start_with?(string)
end

#valid_syntax?Boolean

Returns:

  • (Boolean)


71
72
73
74
# File 'lib/rubocop/processed_source.rb', line 71

def valid_syntax?
  return false if @parser_error
  @diagnostics.none? { |d| %i[error fatal].include?(d.level) }
end