Class: Macros4Cuke::Templating::Comment

Inherits:
Object
  • Object
show all
Defined in:
lib/macros4cuke/templating/comment.rb

Overview

Class used internally by the template engine. Represents a comment from a template. A static text is a text that is reproduced verbatim when rendering a template.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aSourceText) ⇒ Comment

Returns a new instance of Comment.

Parameters:

  • aSourceText (String) —

    A piece of text extracted from the template that must be rendered verbatim.



21
22
23
 
# File 'lib/macros4cuke/templating/comment.rb', line 21

def initialize(aSourceText)
  @source = aSourceText
end

Instance Attribute Details

#source ⇒ Object (readonly)

The comment as extracted from the original template.



16
17
18
 
# File 'lib/macros4cuke/templating/comment.rb', line 16

def source
  @source
end

Instance Method Details

#render(_, _) ⇒ String

Render the comment. Comments are rendered as empty text. This is necessary because Cucumber::RbSupport::RbWorld#steps complains when it sees a comment. This method has the same signature as the Engine#render method.

Returns:

  • (String) —

    Empty string ("as is")



30
31
32
 
# File 'lib/macros4cuke/templating/comment.rb', line 30

def render(_, _)
  return ''
end