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 collapse

STRING_SOURCE_NAME =
'(string)'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, path = nil) ⇒ ProcessedSource

Returns a new instance of ProcessedSource.


18
19
20
21
22
23
24
25
26
27
28
# File 'lib/rubocop/processed_source.rb', line 18

def initialize(source, path = nil)
  # In Ruby 2, source code encoding defaults to UTF-8. We follow the same
  # principle regardless of which Ruby version we're running under.
  # Encoding comments will override this setting.
  source.force_encoding(Encoding::UTF_8)

  @raw_source = source
  @path = path
  @diagnostics = []
  parse(source)
end

Instance Attribute Details

#astObject (readonly)

Returns the value of attribute ast


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

def ast
  @ast
end

#bufferObject (readonly)

Returns the value of attribute buffer


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

def buffer
  @buffer
end

#commentsObject (readonly)

Returns the value of attribute comments


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

def comments
  @comments
end

#diagnosticsObject (readonly)

Returns the value of attribute diagnostics


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

def diagnostics
  @diagnostics
end

#parser_errorObject (readonly)

Returns the value of attribute parser_error


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

def parser_error
  @parser_error
end

#pathObject (readonly)

Returns the value of attribute path


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

def path
  @path
end

#raw_sourceObject (readonly)

Returns the value of attribute raw_source


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

def raw_source
  @raw_source
end

#tokensObject (readonly)

Returns the value of attribute tokens


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

def tokens
  @tokens
end

Class Method Details

.from_file(path) ⇒ Object


14
15
16
# File 'lib/rubocop/processed_source.rb', line 14

def self.from_file(path)
  new(File.read(path), path)
end

Instance Method Details

#[](*args) ⇒ Object


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

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

#comment_configObject


30
31
32
# File 'lib/rubocop/processed_source.rb', line 30

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

#disabled_line_rangesObject


34
35
36
# File 'lib/rubocop/processed_source.rb', line 34

def disabled_line_ranges
  comment_config.cop_disabled_line_ranges
end

#linesObject


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

def lines
  @lines ||= raw_source.lines.map(&:chomp)
end

#valid_syntax?Boolean

Returns:

  • (Boolean)

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

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