Class | Asciidoctor::AbstractNode |
In: |
lib/asciidoctor/abstract_node.rb
|
Parent: | Object |
Public: An abstract base class that provides state and methods for managing a node of AsciiDoc content. The state and methods on this class are comment to all content segments in an AsciiDoc document.
attributes | [R] | Public: Get the Hash of attributes for this node |
context | [R] | Public: Get the Symbol context for this node |
document | [R] | Public: Get the Asciidoctor::Document to which this node belongs |
id | [RW] | Public: Get/Set the id of this node |
node_name | [R] | Public: Get the String name of this node |
parent | [R] | Public: Get the element which is the parent of this node |
Public: Get the value of the specified attribute
Get the value for the specified attribute. First look in the attributes on this node and return the value of the attribute if found. Otherwise, if this node is a child of the Document node, look in the attributes of the Document node and return the value of the attribute if found. Otherwise, return the default value, which defaults to nil.
name - the String or Symbol name of the attribute to lookup default_val - the Object value to return if the attribute is not found (default: nil) inherit - a Boolean indicating whether to check for the attribute on the
AsciiDoctor::Document if not found on this node (default: false)
return the value of the attribute or the default value if the attribute is not found in the attributes of this node or the document node
Public: Check if the attribute is defined, optionally performing a comparison of its value if expected is not nil
Check if the attribute is defined. First look in the attributes on this node. If not found, and this node is a child of the Document node, look in the attributes of the Document node. If the attribute is found and a comparison value is specified (not nil), return whether the two values match. Otherwise, return whether the attribute was found.
name - the String or Symbol name of the attribute to lookup expect_val - the expected Object value of the attribute (default: nil) inherit - a Boolean indicating whether to check for the attribute on the
AsciiDoctor::Document if not found on this node (default: false)
return a Boolean indicating whether the attribute exists and, if a comparison value is specified, whether the value of the attribute matches the comparison value
Public: Get the Asciidoctor::Converter instance being used to convert the current Asciidoctor::Document.
Public: Generate a data URI that can be used to embed an image in the output document
First, and foremost, the target image path is cleaned if the document safe mode level is set to at least SafeMode::SAFE (a condition which is true by default) to prevent access to ancestor paths in the filesystem. The image data is then read and converted to Base64. Finally, a data URI is built which can be used in an image tag.
target_image - A String path to the target image asset_dir_key - The String attribute key used to lookup the directory where
the image is located (default: nil)
Returns A String data URI containing the content of the target image
Public: Read the image data from the specified URI and generate a data URI
The image data is read from the URI and converted to Base64. A data URI is constructed from the content_type header and Base64 data and returned, which can then be used in an image tag.
image_uri - The URI from which to read the image data. Can be http://, https:// or ftp:// cache_uri - A Boolean to control caching. When true, the open-uri-cached library
is used to cache the image for subsequent reads. (default: false)
Returns A data URI string built from Base64 encoded data read from the URI and the mime type specified in the Content Type header.
Public: Construct a reference or data URI to an icon image for the specified icon name.
If the ‘icon’ attribute is set on this block, the name is ignored and the value of this attribute is used as the target image path. Otherwise, construct a target image path by concatenating the value of the ‘iconsdir’ attribute, the icon name and the value of the ‘icontype’ attribute (defaulting to ‘png’).
The target image path is then passed through the image_uri() method. If the ‘data-uri’ attribute is set on the document, the image will be safely converted to a data URI.
The return value of this method can be safely used in an image tag.
name - The String name of the icon
Returns A String reference or data URI for an icon image
Public: Construct a URI reference or data URI to the target image.
If the target image is a URI reference, then leave it untouched.
The target image is resolved relative to the directory retrieved from the specified attribute key, if provided.
If the ‘data-uri’ attribute is set on the document, and the safe mode level is less than SafeMode::SECURE, the image will be safely converted to a data URI by reading it from the same directory. If neither of these conditions are satisfied, a relative path (i.e., URL) will be returned.
The return value of this method can be safely used in an image tag.
target_image - A String path to the target image asset_dir_key - The String attribute key used to lookup the directory where
the image is located (default: 'imagesdir')
Returns A String reference or data URI for the target image
Public: Check whether the specified String is a URI by matching it against the Asciidoctor::UriSniffRx regex.
@deprecated Use Helpers.uriish? instead
Public: Construct a URI reference to the target media.
If the target media is a URI reference, then leave it untouched.
The target media is resolved relative to the directory retrieved from the specified attribute key, if provided.
The return value can be safely used in a media tag (img, audio, video).
target - A String reference to the target media asset_dir_key - The String attribute key used to lookup the directory where
the media is located (default: 'imagesdir')
Returns A String reference for the target media
Public: Normalize the asset file or directory to a concrete and rinsed path
Delegates to normalize_system_path, with the start path set to the value of the base_dir instance variable on the Document object.
Public: Resolve and normalize a secure path from the target and start paths using the PathResolver.
See {PathResolver#system_path} for details.
The most important functionality in this method is to prevent resolving a path outside of the jail (which defaults to the directory of the source file, stored in the base_dir instance variable on Document) if the document safe level is set to SafeMode::SAFE or greater (a condition which is true by default).
target - the String target path start - the String start (i.e., parent) path jail - the String jail path to confine the resolved path opts - an optional Hash of options to control processing (default: {}):
* :recover is used to control whether the processor should auto-recover when an illegal path is encountered * :target_name is used in messages to refer to the path being resolved
raises a SecurityError if a jail is specified and the resolved path is outside the jail.
Returns the [String] path resolved from the start and target paths, with any parent references resolved and self references removed. If a jail is provided, this path will be guaranteed to be contained within the jail.
Public: Normalize the web path using the PathResolver.
See {PathResolver#web_path} for details about path resolution and encoding.
target - the String target path start - the String start (i.e, parent) path (optional, default: nil) preserve_uri_target - a Boolean indicating whether target should be preserved if contains a URI (default: true)
Returns the resolved [String] path
Public: A convenience method to check if the specified option attribute is enabled on the current node.
Check if the option is enabled. This method simply checks to see if the %name%-option attribute is defined on the current node.
name - the String or Symbol name of the option
return a Boolean indicating whether the option has been specified
Public: Read the contents of the file at the specified path. This method assumes that the path is safe to read. It checks that the file is readable before attempting to read it.
path - the String path from which to read the contents opts - a Hash of options to control processing (default: {})
* :warn_on_failure a Boolean that controls whether a warning is issued if the file cannot be read (default: false) * :normalize a Boolean that controls whether the lines are normalized and coerced to UTF-8 (default: false)
Returns the [String] content of the file at the specified path, or nil if the file does not exist.
Public: Resolve the URI or system path to the specified target, then read and return its contents
The URI or system path of the target is first resolved. If the resolved path is a URI, read the contents from the URI if the allow-uri-read attribute is set, enabling caching if the cache-uri attribute is also set. If the resolved path is not a URI, read the contents of the file from the file system. If the normalize option is set, the data will be normalized.
target - The URI or local path from which to read the data. opts - a Hash of options to control processing (default: {})
* :label the String label of the target to use in warning messages (default: 'asset') * :normalize a Boolean that indicates whether the data should be normalized (default: false) * :start the String relative base path to use when resolving the target (default: nil) * :warn_on_failure a Boolean that indicates whether warnings are issued if the target cannot be read (default: true)
Returns the contents of the resolved target or nil if the resolved target cannot be read — TODO refactor other methods in this class to use this method were possible (repurposing if necessary)
Public: A convenience method that returns the value of the reftext attribute with substitutions applied.
Public: Assign the value to the attribute name for the current node.
name - The String attribute name to assign value - The Object value to assign to the attribute (default: ’’) overwrite - A Boolean indicating whether to assign the attribute
if currently present in the attributes Hash (default: true)
Returns a [Boolean] indicating whether the assignment was performed