Class: Sbuilder::TemplateContextReader

Inherits:
TemplateReader show all
Extended by:
Forwardable
Includes:
Utils::MyLogger
Defined in:
lib/sbuilder/mustache/template_reader_context.rb

Overview

Use setup configuration to render only templates, which are reachable for setup entry points (getEntryPoints + getSetupPossibilities + getModelInvariants + getSetupAssumes).

Implementation overrides ‘whitelist’ method in ‘TemplateReader’. uses ‘Sbuilder::ParserFacade’ to parse TLA+ snippets, and resolve modules to put in whitelist’. ‘show_template` - method overrides default ’show-all’ method in parent class, and says true only for templates, which are reachable for entry points.

Constant Summary collapse

PROGNAME = 
nil

Constants included from Utils::MyLogger

Utils::MyLogger::LOGFILE

Instance Attribute Summary collapse

Attributes inherited from TemplateReader

#controller, #partials, #template_paths, #templates

Constructor && configure collapse

Override default `show_template` in parent class collapse

Methods included from Utils::MyLogger

#getLogger, #logfile

Methods inherited from TemplateReader

#filtered_template, #get_template, #get_template_filepath

Constructor Details

#initialize(controller, options = {}) ⇒ TemplateContextReader

Constructor method



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/sbuilder/mustache/template_reader_context.rb', line 61

def initialize( controller, options={} )
  super( controller, options )
  @logger = getLogger( PROGNAME, options )
  @logger.info( "#{__method__} created, options='#{options}" )

  # Init object providing access to parser resolver
  @parserFacade = controller.factory.createParserFacade

  @options = options

end

Instance Attribute Details

#options ⇒ Object (readonly)

Attributes



47
48
49
 
# File 'lib/sbuilder/mustache/template_reader_context.rb', line 47

def options
  @options
end

#parserFacade ⇒ Object (readonly) 



54
55
56
 
# File 'lib/sbuilder/mustache/template_reader_context.rb', line 54

def parserFacade
  @parserFacade
end

#setupName ⇒ Object (readonly)

setup being currently generated



51
52
53
 
# File 'lib/sbuilder/mustache/template_reader_context.rb', line 51

def setupName
  @setupName
end

Instance Method Details

#setSetupName(setupName) ⇒ Object

Controller uses this method to inform template reader of the setup currently being processed.



77
78
79
80
 
# File 'lib/sbuilder/mustache/template_reader_context.rb', line 77

def setSetupName( setupName )
  @logger.info( "#{__method__} setupName=#{setupName}" )
  @setupName = setupName
end

#show_template(name) ⇒ boolean

Overridden from super class. Wrapper around check actual check routine to simplify logging.

Parameters:

  • name (String) —

    of template to check

Returns:

  • (boolean) —

    true when shown normally,else false



117
118
119
120
121
 
# File 'lib/sbuilder/mustache/template_reader_context.rb', line 117

def show_template( name )
  ret = show_template_do( name )
  @logger.info( "#{__method__}: check show=#{name}-#{ret[1]} -> #{ret[0]}" )            
  ret[0]
end