Class: Arrow::Template::Directive

Inherits:

Node

• Object
• Object
• Node
• Arrow::Template::Directive

Includes:

PluginFactory

Defined in:

lib/arrow/template/nodes.rb

Overview

The abstract directive superclass. Instances of derivatives of this class define template behaviour and content.

Direct Known Subclasses

AttributeDirective, ElseDirective, ImportDirective, IncludeDirective, SetDirective

Constant Summary

SVNRev =

SVN Revision

%q$Rev$

SVNId =

SVN Id

%q$Id$

Constants included from HTMLUtilities

HTMLUtilities::ARRAY_HTML_CONTAINER, HTMLUtilities::HASH_HTML_CONTAINER, HTMLUtilities::HASH_PAIR_HTML, HTMLUtilities::IMMEDIATE_OBJECT_HTML_CONTAINER, HTMLUtilities::IVAR_HTML_FRAGMENT, HTMLUtilities::OBJECT_HTML_CONTAINER, HTMLUtilities::THREAD_DUMP_KEY

Instance Attribute Summary

Attributes inherited from Node

#type

Class Method Summary

• .create(tag, parser, state) ⇒ Object

  Factory method: overridden from PluginFactory.create to pass the name into constructors for parsing context.

• .derivativeDirs ⇒ Object

  Return the list of subdirectories to search for template nodes.

Instance Method Summary

• #initialize(type, parser, state) ⇒ Directive constructor

  Initialize a new Directive with the given type (the directive name), parser (Arrow::Template::Parser), and state (Arrow::Template::Parser::State object).

• #inspect ⇒ Object

  Return a human-readable version of the object suitable for debugging messages.

• #render(template, scope) ⇒ Object

  Render the directive as a String and return it.

• #to_html ⇒ Object

  Return an HTML fragment that can be used to represent the node symbolically in a web-based introspection interface.

Methods inherited from Node

#add_to_template, #is_rendering_node?, #to_a, #to_s

Methods included from HTMLUtilities

escape_html, make_html_for_object, make_object_html_wrapper

Methods inherited from Object

deprecate_class_method, deprecate_method, inherited

Constructor Details

#initialize(type, parser, state) ⇒ Directive

Initialize a new Directive with the given type (the directive name), parser (Arrow::Template::Parser), and state (Arrow::Template::Parser::State object).

# File 'lib/arrow/template/nodes.rb', line 280

def initialize( type, parser, state )
	super( type )
	self.parse_directive_contents( parser, state )
end

Class Method Details

.create(tag, parser, state) ⇒ Object

Factory method: overridden from PluginFactory.create to pass the name into constructors for parsing context.

# File 'lib/arrow/template/nodes.rb', line 268

def self::create( tag, parser, state )
	super( tag, tag, parser, state )
end

.derivativeDirs ⇒ Object

Return the list of subdirectories to search for template nodes.

# File 'lib/arrow/template/nodes.rb', line 261

def self::derivativeDirs
	["arrow/template"]
end

Instance Method Details

#inspect ⇒ Object

Return a human-readable version of the object suitable for debugging messages.

# File 'lib/arrow/template/nodes.rb', line 302

def inspect
	%Q{<%s Directive>} % [ @type.capitalize ]
end

#render(template, scope) ⇒ Object

Render the directive as a String and return it.

# File 'lib/arrow/template/nodes.rb', line 291

def render( template, scope )
	rary = []
	rary << template.render_comment( self.inspect ) if
		template._config[:debuggingComments]

	return rary
end

#to_html ⇒ Object

Return an HTML fragment that can be used to represent the node symbolically in a web-based introspection interface.

# File 'lib/arrow/template/nodes.rb', line 309

def to_html

	if block_given?
		callback = Proc.new
		super( &callback )
	else
		fields = instance_variables.sort.collect {|ivar|
			val = instance_variable_get( ivar )
			%q{<span class="ivar"><em>%s:</em> %s</span>} %
				[ ivar, self.escape_html(val) ]
		}

		super { fields.join(", ") }
	end
end