Class: YARD::Parser::Ruby::Legacy::Statement

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/parser/ruby/legacy/statement.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tokens, block = nil, comments = nil) ⇒ Statement


14
15
16
17
18
19
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 14

def initialize(tokens, block = nil, comments = nil)
  @tokens = tokens
  @block  = block
  @comments = comments
  @comments_hash_flag = false
end

Instance Attribute Details

#blockObject (readonly)

Returns the value of attribute block


5
6
7
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 5

def block
  @block
end

#commentsObject (readonly)

Returns the value of attribute comments


5
6
7
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 5

def comments
  @comments
end

#comments_hash_flagObject

Returns the value of attribute comments_hash_flag


12
13
14
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 12

def comments_hash_flag
  @comments_hash_flag
end

#comments_rangeObject

Returns the value of attribute comments_range


6
7
8
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 6

def comments_range
  @comments_range
end

#groupObject

Deprecated.

Groups are now defined by directives


10
11
12
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 10

def group
  @group
end

#tokensObject (readonly)

Returns the value of attribute tokens


5
6
7
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 5

def tokens
  @tokens
end

Instance Method Details

#first_lineObject


21
22
23
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 21

def first_line
  to_s.split(/\n/)[0]
end

#inspectObject


32
33
34
35
36
37
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 32

def inspect
  l = line - 1
  to_s(false).split(/\n/).map do |text|
    "\t#{l += 1}:  #{text}"
  end.join("\n")
end

#lineFixnum


44
45
46
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 44

def line
  tokens.first.line_no
end

#line_rangeRange<Fixnum>

Returns the first to last lines of Ruby source

Since:

  • 0.5.4


50
51
52
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 50

def line_range
  tokens.first.line_no..tokens.last.line_no
end

#showObject


39
40
41
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 39

def show
  "\t#{line}: #{first_line}"
end

#to_s(include_block = true) ⇒ Object Also known as: source


25
26
27
28
29
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 25

def to_s(include_block = true)
  tokens.map do |token|
    RubyToken::TkBlockContents === token ? (include_block ? block.to_s : '') : token.text
  end.join
end