Class: Solargraph::Parser::CommentRipper

Inherits:
Ripper::SexpBuilderPP
  • Object
show all
Defined in:
lib/solargraph/parser/comment_ripper.rb

Instance Method Summary collapse

Constructor Details

#initialize(src, filename = '(ripper)', lineno = 0) ⇒ CommentRipper

Returns a new instance of CommentRipper.

Parameters:

  • src (String)
  • filename (String) (defaults to: '(ripper)')
  • lineno (Integer) (defaults to: 0) 


18
19
20
21
22
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 18

def initialize src, filename = '(ripper)', lineno = 0
  super
  @buffer = src
  @buffer_lines = @buffer.lines
end

Instance Method Details

#create_snippet(result) ⇒ void

This method returns an undefined value.

Parameters:

  • result (Array(Symbol, String, Array([Integer, nil], [Integer, nil]))) 


43
44
45
46
47
48
49
50
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 43

def create_snippet result
  chomped = result[1].chomp
  @comments[result[2][0]] =
    Snippet.new(
      Range.from_to(result[2][0] || 0, result[2][1] || 0, result[2][0] || 0,
                    (result[2][1] || 0) + chomped.length), chomped
    )
end

#on_comment(*args) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 24

def on_comment *args
  # @sg-ignore
  # @type [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
  result = super
  # @sg-ignore Need to add nil check here
  if @buffer_lines[result[2][0]][0..result[2][1]].strip =~ /^#/
    chomped = result[1].chomp
    if result[2][0].zero? && chomped.encode('UTF-8', 'binary', invalid: :replace, undef: :replace,
                                                               replace: '').match(/^#\s*frozen_string_literal:/)
      chomped = '#'
    end
    @comments[result[2][0]] =
      Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
  end
  result
end

#on_embdoc(*args) ⇒ Object

@sg-ignore @override is adding, not overriding



61
62
63
64
65
66
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 61

def on_embdoc *args
  result = super
  # @sg-ignore @override is adding, not overriding
  create_snippet(result)
  result
end

#on_embdoc_beg(*args) ⇒ Object

@sg-ignore @override is adding, not overriding



53
54
55
56
57
58
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 53

def on_embdoc_beg *args
  result = super
  # @sg-ignore @override is adding, not overriding
  create_snippet(result)
  result
end

#on_embdoc_end(*args) ⇒ Object

@sg-ignore @override is adding, not overriding



69
70
71
72
73
74
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 69

def on_embdoc_end *args
  result = super
  # @sg-ignore @override is adding, not overriding
  create_snippet(result)
  result
end

#parse ⇒ Hash{Integer => Solargraph::Parser::Snippet}

Returns:



77
78
79
80
81
 
# File 'lib/solargraph/parser/comment_ripper.rb', line 77

def parse
  @comments = {}
  super
  @comments
end