Class: Aef::Hosts::Element Abstract

Inherits:

Object

• Object
• Aef::Hosts::Element

show all

Defined in:

lib/aef/hosts/element.rb

Overview

Instance Attribute Summary (collapse)

• - (String, ...) cache readonly

  Cached String representation.

Instance Method Summary (collapse)

• - (true, false) cache_filled?

  Tells if a String representation is cached or not.

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

  Defines the algorithm to construct the String representation from cache.

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

  Defines the algorithm to generate a String representation from scratch.

• - (String) inspect

  A String representation for debugging purposes.

• - (Aef::Hosts::Element) invalidate_cache!

  Deletes the cached String representation.

• - (Object) to_s(options = {})

  Provides a String representation of the element.

36
37
38

# File 'lib/aef/hosts/element.rb', line 36

def cache
  @cache
end

50
51
52

# File 'lib/aef/hosts/element.rb', line 50

def cache_filled?
  @cache ? true : false
end

101
102
103

# File 'lib/aef/hosts/element.rb', line 101

def cache_string(options = {})
  @cache.dup
end

94
95
96

# File 'lib/aef/hosts/element.rb', line 94

def generate_string(options = {})
  raise NotImplementedError
end

57
58
59

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

def inspect
  generate_inspect(self, :cache)
end

41
42
43
44
45

# File 'lib/aef/hosts/element.rb', line 41

def invalidate_cache!
  @cache = nil

  self
end

70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# File 'lib/aef/hosts/element.rb', line 70

def to_s(options = {})
  validate_options(options, :force_generation, :linebreak_encoding)

  string = ''

  if !cache_filled? || options[:force_generation]
    string << generate_string(options)
  else
    string << cache_string(options)
  end

  if options[:linebreak_encoding]
    string = Aef::Linebreak.encode(string, options[:linebreak_encoding])
  end

  string
end