Class: Aef::Hosts::Comment

Inherits:

Element

• Object
• Element
• Aef::Hosts::Comment

show all

Defined in:

lib/aef/hosts/comment.rb

Overview

Instance Attribute Summary (collapse)

• - (String) comment

  The comment.

Attributes inherited from Element

#cache

Instance Method Summary (collapse)

• - (String) generate_string(options = {}) protected

  Defines the algorithm to generate a String representation from scratch.

• - (Comment) initialize(comment, options = {}) constructor

  Initializes a comment.

• - (String) inspect

  A String representation for debugging purposes.

Methods inherited from Element

#cache_filled?, #cache_string, #invalidate_cache!, #to_s

38
39
40
41
42
43
44
45

# File 'lib/aef/hosts/comment.rb', line 38

def initialize(comment, options = {})
  validate_options(options, :cache)
  
  raise ArgumentError, 'Comment cannot be empty' unless comment

  @comment = comment.to_s
  @cache   = options[:cache].to_s unless options[:cache].nil?
end

31
32
33

# File 'lib/aef/hosts/comment.rb', line 31

def comment
  @comment
end

66
67
68

# File 'lib/aef/hosts/comment.rb', line 66

def generate_string(options = {})
  "##{comment}\n"
end

57
58
59

# File 'lib/aef/hosts/comment.rb', line 57

def inspect
  generate_inspect(self, :comment, :cache)
end