Class: RuboCop::ProcessedSource
- Inherits:
-
Object
- Object
- RuboCop::ProcessedSource
- 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
-
#ast ⇒ Object
readonly
Returns the value of attribute ast.
-
#buffer ⇒ Object
readonly
Returns the value of attribute buffer.
-
#comments ⇒ Object
readonly
Returns the value of attribute comments.
-
#diagnostics ⇒ Object
readonly
Returns the value of attribute diagnostics.
-
#parser_error ⇒ Object
readonly
Returns the value of attribute parser_error.
-
#path ⇒ Object
readonly
Returns the value of attribute path.
-
#raw_source ⇒ Object
readonly
Returns the value of attribute raw_source.
-
#tokens ⇒ Object
readonly
Returns the value of attribute tokens.
Class Method Summary collapse
Instance Method Summary collapse
- #[](*args) ⇒ Object
-
#checksum ⇒ Object
Raw source checksum for tracking infinite loops.
- #comment_config ⇒ Object
- #disabled_line_ranges ⇒ Object
-
#initialize(source, path = nil) ⇒ ProcessedSource
constructor
A new instance of ProcessedSource.
-
#lines ⇒ Object
Returns the source lines, line break characters removed, excluding a possible END and everything that comes after.
- #valid_syntax? ⇒ Boolean
Constructor Details
#initialize(source, path = nil) ⇒ ProcessedSource
Returns a new instance of ProcessedSource.
19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/rubocop/processed_source.rb', line 19 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
#ast ⇒ Object (readonly)
Returns the value of attribute ast.
12 13 14 |
# File 'lib/rubocop/processed_source.rb', line 12 def ast @ast end |
#buffer ⇒ Object (readonly)
Returns the value of attribute buffer.
12 13 14 |
# File 'lib/rubocop/processed_source.rb', line 12 def buffer @buffer end |
#comments ⇒ Object (readonly)
Returns the value of attribute comments.
12 13 14 |
# File 'lib/rubocop/processed_source.rb', line 12 def comments @comments end |
#diagnostics ⇒ Object (readonly)
Returns the value of attribute diagnostics.
12 13 14 |
# File 'lib/rubocop/processed_source.rb', line 12 def diagnostics @diagnostics end |
#parser_error ⇒ Object (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 |
#path ⇒ Object (readonly)
Returns the value of attribute path.
12 13 14 |
# File 'lib/rubocop/processed_source.rb', line 12 def path @path end |
#raw_source ⇒ Object (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 |
#tokens ⇒ Object (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) ⇒ Object
15 16 17 |
# File 'lib/rubocop/processed_source.rb', line 15 def self.from_file(path) new(File.read(path), path) end |
Instance Method Details
#[](*args) ⇒ Object
54 55 56 |
# File 'lib/rubocop/processed_source.rb', line 54 def [](*args) lines[*args] end |
#checksum ⇒ Object
Raw source checksum for tracking infinite loops.
64 65 66 |
# File 'lib/rubocop/processed_source.rb', line 64 def checksum Digest::MD5.hexdigest(@raw_source) end |
#comment_config ⇒ Object
31 32 33 |
# File 'lib/rubocop/processed_source.rb', line 31 def comment_config @comment_config ||= CommentConfig.new(self) end |
#disabled_line_ranges ⇒ Object
35 36 37 |
# File 'lib/rubocop/processed_source.rb', line 35 def disabled_line_ranges comment_config.cop_disabled_line_ranges end |
#lines ⇒ Object
Returns the source lines, line break characters removed, excluding a possible END and everything that comes after.
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/rubocop/processed_source.rb', line 41 def lines @lines ||= begin all_lines = raw_source.lines.map(&:chomp) last_token_line = tokens.any? ? tokens.last.pos.line : all_lines.count result = [] all_lines.each_with_index do |line, ix| break if ix >= last_token_line && line == '__END__' result << line end result end end |
#valid_syntax? ⇒ Boolean
58 59 60 61 |
# File 'lib/rubocop/processed_source.rb', line 58 def valid_syntax? return false if @parser_error @diagnostics.none? { |d| [:error, :fatal].include?(d.level) } end |