Class: TRuby::DocsExampleExtractor::CodeExample

Inherits:
Struct
  • Object
show all
Defined in:
lib/t_ruby/docs_example_extractor.rb

Overview

Represents an extracted code example

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code

Returns:

  • the current value of code



18
19
20
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 18

def code
  @code
end

#file_path ⇒ Object

Returns the value of attribute file_path

Returns:

  • the current value of file_path



18
19
20
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 18

def file_path
  @file_path
end

#language ⇒ Object

Returns the value of attribute language

Returns:

  • the current value of language



18
19
20
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 18

def language
  @language
end

#line_number ⇒ Object

Returns the value of attribute line_number

Returns:

  • the current value of line_number



18
19
20
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 18

def line_number
  @line_number
end

#metadata ⇒ Object

Returns the value of attribute metadata

Returns:

  • the current value of metadata



18
19
20
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 18

def metadata
  @metadata
end

Instance Method Details

#rbs? ⇒ Boolean

Returns:



34
35
36
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 34

def rbs?
  language == "rbs"
end

#ruby? ⇒ Boolean

Returns:



30
31
32
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 30

def ruby?
  language == "ruby"
end

#should_compile? ⇒ Boolean

Returns:



42
43
44
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 42

def should_compile?
  !metadata&.include?("no-compile")
end

#should_typecheck? ⇒ Boolean

Returns:



46
47
48
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 46

def should_typecheck?
  !metadata&.include?("no-typecheck")
end

#should_verify? ⇒ Boolean

Returns:



38
39
40
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 38

def should_verify?
  !metadata&.include?("skip-verify")
end

#trb? ⇒ Boolean

Returns:



26
27
28
 
# File 'lib/t_ruby/docs_example_extractor.rb', line 26

def trb?
  %w[trb t-ruby].include?(language)
end