Class: YARD::Parser::Ruby::Legacy::Statement
- Inherits:
-
Object
- Object
- YARD::Parser::Ruby::Legacy::Statement
- Defined in:
- lib/yard/parser/ruby/legacy/statement.rb
Instance Attribute Summary (collapse)
-
- (Object) block
readonly
Returns the value of attribute block.
-
- (Object) comments
readonly
Returns the value of attribute comments.
-
- (Object) comments_hash_flag
Returns the value of attribute comments_hash_flag.
-
- (Object) comments_range
Returns the value of attribute comments_range.
-
- (Object) group
Returns the value of attribute group.
-
- (Object) tokens
readonly
Returns the value of attribute tokens.
Instance Method Summary (collapse)
- - (Object) first_line
-
- (Statement) initialize(tokens, block = nil, comments = nil)
constructor
A new instance of Statement.
- - (Object) inspect
-
- (Fixnum) line
The first line of Ruby source.
-
- (Range<Fixnum>) line_range
The first to last lines of Ruby source.
- - (Object) show
- - (Object) to_s(include_block = true) (also: #source)
Constructor Details
- (Statement) initialize(tokens, block = nil, comments = nil)
A new instance of Statement
8 9 10 11 12 13 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 8 def initialize(tokens, block = nil, comments = nil) @tokens = tokens @block = block @comments = comments @comments_hash_flag = false end |
Instance Attribute Details
- (Object) block (readonly)
Returns the value of attribute block
4 5 6 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 4 def block @block end |
- (Object) comments (readonly)
Returns the value of attribute comments
4 5 6 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 4 def comments @comments end |
- (Object) comments_hash_flag
Returns the value of attribute comments_hash_flag
6 7 8 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 6 def comments_hash_flag @comments_hash_flag end |
- (Object) comments_range
Returns the value of attribute comments_range
5 6 7 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 5 def comments_range @comments_range end |
- (Object) group
Returns the value of attribute group
5 6 7 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 5 def group @group end |
- (Object) tokens (readonly)
Returns the value of attribute tokens
4 5 6 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 4 def tokens @tokens end |
Instance Method Details
- (Object) first_line
15 16 17 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 15 def first_line to_s.split(/\n/)[0] end |
- (Object) inspect
26 27 28 29 30 31 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 26 def inspect l = line - 1 to_s(false).split(/\n/).map do |text| "\t#{l += 1}: #{text}" end.join("\n") end |
- (Fixnum) line
The first line of Ruby source
38 39 40 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 38 def line tokens.first.line_no end |
- (Range<Fixnum>) line_range
The first to last lines of Ruby source
44 45 46 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 44 def line_range tokens.first.line_no..tokens.last.line_no end |
- (Object) show
33 34 35 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 33 def show "\t #{line}: #{first_line}" end |
- (Object) to_s(include_block = true) Also known as: source
19 20 21 22 23 |
# File 'lib/yard/parser/ruby/legacy/statement.rb', line 19 def to_s(include_block = true) tokens.map do |token| RubyToken::TkBlockContents === token ? (include_block ? block.to_s : '') : token.text end.join end |