Class: Asciidoctor::AbstractNode

Inherits:
Object
  • Object
show all
Includes:
Logging, Substitutors
Defined in:
lib/asciidoctor/abstract_node.rb

Overview

all content segments in an AsciiDoc document.

Direct Known Subclasses

AbstractBlock, Inline, Table::Column

Constant Summary

Constants included from Substitutors

Substitutors::CAN, Substitutors::CGI, Substitutors::DEL, Substitutors::ESC_R_SB, Substitutors::HighlightedPassSlotRx, Substitutors::PASS_END, Substitutors::PASS_START, Substitutors::PLUS, Substitutors::PassSlotRx, Substitutors::QuotedTextSniffRx, Substitutors::RS, Substitutors::R_SB, Substitutors::SUB_GROUPS, Substitutors::SUB_HINTS, Substitutors::SUB_OPTIONS, Substitutors::SpecialCharsRx, Substitutors::SpecialCharsTr

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Substitutors

#apply_header_subs, #apply_normal_subs, #apply_reftext_subs, #apply_subs, #expand_subs, #extract_passthroughs, #highlight_source, #resolve_block_subs, #resolve_lines_to_highlight, #resolve_pass_subs, #resolve_subs, #restore_passthroughs, #sub_attributes, #sub_callouts, #sub_macros, #sub_post_replacements, #sub_quotes, #sub_replacements, #sub_source, #sub_specialchars

Methods included from Logging

#logger, #message_with_context

Constructor Details

#initialize(parent, context, opts = {}) ⇒ AbstractNode

Returns a new instance of AbstractNode.



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/asciidoctor/abstract_node.rb', line 29

def initialize parent, context, opts = {}
  # document is a special case, should refer to itself
  if context == :document
    @document = self
  elsif parent
    @document = (@parent = parent).document
  end
  @node_name = (@context = context).to_s
  # NOTE the value of the :attributes option may be nil on an Inline node
  @attributes = (attrs = opts[:attributes]) ? attrs.merge : {}
  @passthroughs = []
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Get the Hash of attributes for this node



12
13
14
 
# File 'lib/asciidoctor/abstract_node.rb', line 12

def attributes
  @attributes
end

#context ⇒ Object (readonly)

Get the Symbol context for this node



15
16
17
 
# File 'lib/asciidoctor/abstract_node.rb', line 15

def context
  @context
end

#document ⇒ Object (readonly)

Get the Asciidoctor::Document to which this node belongs



18
19
20
 
# File 'lib/asciidoctor/abstract_node.rb', line 18

def document
  @document
end

#id ⇒ Object

Get/Set the String id of this node



21
22
23
 
# File 'lib/asciidoctor/abstract_node.rb', line 21

def id
  @id
end

#node_name ⇒ Object (readonly)

Get the String name of this node



24
25
26
 
# File 'lib/asciidoctor/abstract_node.rb', line 24

def node_name
  @node_name
end

#parent ⇒ Object

Get the AbstractBlock parent element of this node



27
28
29
 
# File 'lib/asciidoctor/abstract_node.rb', line 27

def parent
  @parent
end

Instance Method Details

#add_role(name) ⇒ Boolean

Adds the given role directly to this node.

Returns:

  • (Boolean) —

    Returns a Boolean indicating whether the role was added.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/asciidoctor/abstract_node.rb', line 233

def add_role name
  if (val = @attributes['role'])
    # NOTE center + include? is faster than split + include?
    if %( #{val} ).include? %( #{name} )
      false
    else
      @attributes['role'] = %(#{val} #{name})
      true
    end
  else
    @attributes['role'] = name
    true
  end
end

#attr(name, default_value = nil, fallback_name = nil) ⇒ Object

Get the value of the specified attribute. If the attribute is not found on this node, fallback_name is set, and this node is not the Document node, get the value of the specified attribute from the Document node.

Look for the specified attribute in the attributes on this node and return the value of the attribute, if found. Otherwise, if fallback_name is set (default: same as name) and this node is not the Document node, look for that attribute on the Document node and return its value, if found. Otherwise, return the default value (default: nil).

Parameters:

  • name —

    The String or Symbol name of the attribute to resolve.

  • default_value (defaults to: nil) —

    The Object value to return if the attribute is not found (default: nil).

  • fallback_name (defaults to: nil) —

    The String or Symbol of the attribute to resolve on the Document if the attribute is not found on this node (default: same as name).

Returns:

  • (Object) —

    Returns the Object value (typically a String) of the attribute or default_value if the attribute is not found.



88
89
90
 
# File 'lib/asciidoctor/abstract_node.rb', line 88

def attr name, default_value = nil, fallback_name = nil
  @attributes[name.to_s] || (fallback_name && @parent && @document.attributes[(fallback_name == true ? name : fallback_name).to_s] || default_value)
end

#attr?(name, expected_value = nil, fallback_name = nil) ⇒ Boolean

Check if the specified attribute is defined using the same logic as #attr, optionally performing a comparison with the expected value if specified.

Look for the specified attribute in the attributes on this node. If not found, fallback_name is specified (default: same as name), and this node is not the Document node, look for that attribute on the Document node. In either case, if the attribute is found, and the comparison value is truthy, return whether the two values match. Otherwise, return whether the attribute was found.

Parameters:

  • name —

    The String or Symbol name of the attribute to resolve.

  • expected_value (defaults to: nil) —

    The expected Object value of the attribute (default: nil).

  • fallback_name (defaults to: nil) —

    The String or Symbol of the attribute to resolve on the Document if the attribute is not found on this node (default: same as name).

Returns:

  • (Boolean) —

    Returns a Boolean indicating whether the attribute exists and, if a truthy comparison value is specified, whether the value of the attribute matches the comparison value.



107
108
109
110
111
112
113
 
# File 'lib/asciidoctor/abstract_node.rb', line 107

def attr? name, expected_value = nil, fallback_name = nil
  if expected_value
    expected_value == (@attributes[name.to_s] || (fallback_name && @parent ? @document.attributes[(fallback_name == true ? name : fallback_name).to_s] : nil))
  else
    (@attributes.key? name.to_s) || (fallback_name && @parent ? (@document.attributes.key? (fallback_name == true ? name : fallback_name).to_s) : false)
  end
end

#block? ⇒ Boolean

Returns whether this Asciidoctor::AbstractNode is an instance of Block

Returns:

  • (Boolean) —

    Returns

Raises:

  • (::NotImplementedError) 


45
46
47
48
49
 
# File 'lib/asciidoctor/abstract_node.rb', line 45

def block?
  # :nocov:
  raise ::NotImplementedError
  # :nocov:
end

#converter ⇒ Object

Get the Asciidoctor::Converter instance being used to convert the current Asciidoctor::Document.



62
63
64
 
# File 'lib/asciidoctor/abstract_node.rb', line 62

def converter
  @document.converter
end

#enabled_options ⇒ Set

Retrieve the Set of option names that are enabled on this node

Returns:

  • (Set) —

    Returns a Set of option names



169
170
171
 
# File 'lib/asciidoctor/abstract_node.rb', line 169

def enabled_options
  ::Set.new.tap {|accum| @attributes.each_key {|k| accum << (k.slice 0, k.length - 7) if k.to_s.end_with? '-option' } }
end

#generate_data_uri(target_image, asset_dir_key = nil) ⇒ A

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.

Parameters:

  • target_image —

    A String path to the target image

  • asset_dir_key (defaults to: nil) —

    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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/asciidoctor/abstract_node.rb', line 366

def generate_data_uri target_image, asset_dir_key = nil
  if (ext = Helpers.extname target_image, nil)
    mimetype = ext == '.svg' ? 'image/svg+xml' : %(image/#{ext.slice 1, ext.length})
  else
    mimetype = 'application/octet-stream'
  end

  if asset_dir_key
    image_path = normalize_system_path target_image, (@document.attr asset_dir_key), nil, target_name: 'image'
  else
    image_path = normalize_system_path target_image
  end

  if ::File.readable? image_path
    # NOTE pack 'm0' is equivalent to Base64.strict_encode64
    %(data:#{mimetype};base64,#{[(::File.binread image_path)].pack 'm0'})
  else
    logger.warn %(image to embed not found or not readable: #{image_path})
    %(data:#{mimetype};base64,)
    # uncomment to return 1 pixel white dot instead
    #'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='
  end
end

#generate_data_uri_from_uri(image_uri, cache_uri = false) ⇒ A

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.

Parameters:

  • image_uri —

    The URI from which to read the image data. Can be http://, https:// or ftp://

  • cache_uri (defaults to: false) —

    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.



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/asciidoctor/abstract_node.rb', line 402

def generate_data_uri_from_uri image_uri, cache_uri = false
  if cache_uri
    # caching requires the open-uri-cached gem to be installed
    # processing will be automatically aborted if these libraries can't be opened
    Helpers.require_library 'open-uri/cached', 'open-uri-cached'
  elsif !RUBY_ENGINE_OPAL
    # autoload open-uri
    ::OpenURI
  end

  begin
    mimetype, bindata = ::OpenURI.open_uri(image_uri, URI_READ_MODE) {|f| [f.content_type, f.read] }
    # NOTE pack 'm0' is equivalent to Base64.strict_encode64
    %(data:#{mimetype};base64,#{[bindata].pack 'm0'})
  rescue
    logger.warn %(could not retrieve image data from URI: #{image_uri})
    image_uri
    # uncomment to return empty data (however, mimetype needs to be resolved)
    #%(data:#{mimetype}:base64,)
    # uncomment to return 1 pixel white dot instead
    #'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='
  end
end

#has_role?(name) ⇒ Boolean

Checks if the specified role is present in the list of roles for this node.

Parameters:

  • name —

    The String name of the role to find.

Returns:

  • (Boolean) —

    Returns a Boolean indicating whether this node has the specified role.



216
217
218
219
 
# File 'lib/asciidoctor/abstract_node.rb', line 216

def has_role? name
  # NOTE center + include? is faster than split + include?
  (val = @attributes['role']) ? (%( #{val} ).include? %( #{name} )) : false
end

#icon_uri(name) ⇒ A

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.

Parameters:

  • name —

    The String name of the icon

Returns:

  • (A) —

    String reference or data URI for an icon image



292
293
294
295
296
297
298
299
300
301
 
# File 'lib/asciidoctor/abstract_node.rb', line 292

def icon_uri name
  if attr? 'icon'
    icon = attr 'icon'
    # QUESTION should we be adding the extension if the icon is an absolute URI?
    icon = %(#{icon}.#{@document.attr 'icontype', 'png'}) unless Helpers.extname? icon
  else
    icon = %(#{name}.#{@document.attr 'icontype', 'png'})
  end
  image_uri icon, 'iconsdir'
end

#image_uri(target_image, asset_dir_key = 'imagesdir') ⇒ A

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.

Parameters:

  • target_image —

    A String path to the target image

  • asset_dir_key (defaults to: 'imagesdir') —

    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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/asciidoctor/abstract_node.rb', line 322

def image_uri target_image, asset_dir_key = 'imagesdir'
  if (doc = @document).safe < SafeMode::SECURE && (doc.attr? 'data-uri')
    if ((Helpers.uriish? target_image) && (target_image = Helpers.encode_spaces_in_uri target_image)) ||
        (asset_dir_key && (images_base = doc.attr asset_dir_key) && (Helpers.uriish? images_base) &&
        (target_image = normalize_web_path target_image, images_base, false))
      (doc.attr? 'allow-uri-read') ? (generate_data_uri_from_uri target_image, (doc.attr? 'cache-uri')) : target_image
    else
      generate_data_uri target_image, asset_dir_key
    end
  else
    normalize_web_path target_image, (asset_dir_key ? (doc.attr asset_dir_key) : nil)
  end
end

#inline? ⇒ Boolean

Returns whether this Asciidoctor::AbstractNode is an instance of Inline

Returns:

  • (Boolean) —

    Returns

Raises:

  • (::NotImplementedError) 


54
55
56
57
58
 
# File 'lib/asciidoctor/abstract_node.rb', line 54

def inline?
  # :nocov:
  raise ::NotImplementedError
  # :nocov:
end

#is_uri?(str) ⇒ Boolean

Deprecated.

Do not use this in new code, and replace it when updating old code.

Check whether the specified String is a URI by matching it against the Asciidoctor::UriSniffRx regex.

In use by Asciidoctor PDF

@deprecated Use Helpers.uriish? instead

Returns:

  • (Boolean) 


564
565
566
 
# File 'lib/asciidoctor/abstract_node.rb', line 564

def is_uri? str
  Helpers.uriish? str
end

#media_uri(target, asset_dir_key = 'imagesdir') ⇒ A

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).

Parameters:

  • target —

    A String reference to the target media

  • asset_dir_key (defaults to: 'imagesdir') —

    The String attribute key used to lookup the directory where the media is located (default: ‘imagesdir’)

Returns:

  • (A) —

    String reference for the target media



350
351
352
 
# File 'lib/asciidoctor/abstract_node.rb', line 350

def media_uri target, asset_dir_key = 'imagesdir'
  normalize_web_path target, (asset_dir_key ? (@document.attr asset_dir_key) : nil)
end

#normalize_asset_path(asset_ref, asset_name = 'path', autocorrect = true) ⇒ Object

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.



430
431
432
 
# File 'lib/asciidoctor/abstract_node.rb', line 430

def normalize_asset_path asset_ref, asset_name = 'path', autocorrect = true
  normalize_system_path asset_ref, @document.base_dir, nil, target_name: asset_name, recover: autocorrect
end

#normalize_system_path(target, start = nil, jail = nil, opts = {}) ⇒ String

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).

Parameters:

  • target —

    the String target path

  • start (defaults to: nil) —

    the String start (i.e., parent) path

  • jail (defaults to: nil) —

    the String jail path to confine the resolved path

  • opts (defaults to: {}) —

    an optional Hash of options to control processing (default: {}): * :recover is used to control whether the processor should automatically 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:

  • (String) —

    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.



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/asciidoctor/abstract_node.rb', line 459

def normalize_system_path target, start = nil, jail = nil, opts = {}
  if (doc = @document).safe < SafeMode::SAFE
    if start
      start = ::File.join doc.base_dir, start unless doc.path_resolver.root? start
    else
      start = doc.base_dir
    end
  else
    start ||= doc.base_dir
    jail ||= doc.base_dir
  end
  doc.path_resolver.system_path target, start, jail, opts
end

#normalize_web_path(target, start = nil, preserve_uri_target = true) ⇒ String

Normalize the web path using the PathResolver.

See PathResolver#web_path for details about path resolution and encoding.

Parameters:

  • target —

    the String target path

  • start (defaults to: nil) —

    the String start (i.e, parent) path (optional, default: nil)

  • preserve_uri_target (defaults to: true) —

    a Boolean indicating whether target should be preserved if contains a URI (default: true)

Returns:

  • (String) —

    Returns the resolved String path



482
483
484
485
486
487
488
 
# File 'lib/asciidoctor/abstract_node.rb', line 482

def normalize_web_path target, start = nil, preserve_uri_target = true
  if preserve_uri_target && (Helpers.uriish? target)
    Helpers.encode_spaces_in_uri target
  else
    @document.path_resolver.web_path target, start
  end
end

#option?(name) ⇒ Boolean

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.

Parameters:

  • name —

    the String or Symbol name of the option

  • return —

    a Boolean indicating whether the option has been specified

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/asciidoctor/abstract_node.rb', line 150

def option? name
  @attributes[%(#{name}-option)] ? true : false
end

#read_asset(path, opts = {}) ⇒ String

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.

Parameters:

  • path —

    the String path from which to read the contents

  • opts (defaults to: {}) —

    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:

  • (String) —

    Returns the String content of the file at the specified path, or nil if the file does not exist.



503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/asciidoctor/abstract_node.rb', line 503

def read_asset path, opts = {}
  # remap opts for backwards compatibility
  opts = { warn_on_failure: (opts != false) } unless ::Hash === opts
  if ::File.readable? path
    # QUESTION should we chomp content if normalize is false?
    opts[:normalize] ? ((Helpers.prepare_source_string ::File.read path, mode: FILE_READ_MODE).join LF) : (::File.read path, mode: FILE_READ_MODE)
  elsif opts[:warn_on_failure]
    logger.warn %(#{(attr 'docfile') || '<stdin>'}: #{opts[:label] || 'file'} does not exist or cannot be read: #{path})
    nil
  end
end

#read_contents(target, opts = {}) ⇒ Object

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.

Parameters:

  • target —

    The URI or local path from which to read the data.

  • opts (defaults to: {}) —

    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) * :warn_if_empty a Boolean that indicates whether a warning is issued if contents of target is empty (default: false)

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)



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/asciidoctor/abstract_node.rb', line 532

def read_contents target, opts = {}
  doc = @document
  if (Helpers.uriish? target) || ((start = opts[:start]) && (Helpers.uriish? start) &&
      (target = doc.path_resolver.web_path target, start))
    if doc.attr? 'allow-uri-read'
      Helpers.require_library 'open-uri/cached', 'open-uri-cached' if doc.attr? 'cache-uri'
      begin
        if opts[:normalize]
          contents = (Helpers.prepare_source_string ::OpenURI.open_uri(target, URI_READ_MODE) {|f| f.read }).join LF
        else
          contents = ::OpenURI.open_uri(target, URI_READ_MODE) {|f| f.read }
        end
      rescue
        logger.warn %(could not retrieve contents of #{opts[:label] || 'asset'} at URI: #{target}) if opts.fetch :warn_on_failure, true
      end
    elsif opts.fetch :warn_on_failure, true
      logger.warn %(cannot retrieve contents of #{opts[:label] || 'asset'} at URI: #{target} (allow-uri-read attribute not enabled))
    end
  else
    target = normalize_system_path target, opts[:start], nil, target_name: (opts[:label] || 'asset')
    contents = read_asset target, normalize: opts[:normalize], warn_on_failure: (opts.fetch :warn_on_failure, true), label: opts[:label]
  end
  logger.warn %(contents of #{opts[:label] || 'asset'} is empty: #{target}) if contents && opts[:warn_if_empty] && contents.empty?
  contents
end

#reftext ⇒ Object

A convenience method that returns the value of the reftext attribute with substitutions applied.



265
266
267
 
# File 'lib/asciidoctor/abstract_node.rb', line 265

def reftext
  (val = @attributes['reftext']) ? (apply_reftext_subs val) : nil
end

#reftext? ⇒ Boolean

A convenience method that checks if the reftext attribute is defined.

Returns:

  • (Boolean) 


270
271
272
 
# File 'lib/asciidoctor/abstract_node.rb', line 270

def reftext?
  @attributes.key? 'reftext'
end

#remove_attr(name) ⇒ String

Remove the attribute from the current node.

Parameters:

  • name —

    The String attribute name to remove

Returns:

  • (String) —

    Returns the previous String value, or nil if the attribute was not present.



137
138
139
 
# File 'lib/asciidoctor/abstract_node.rb', line 137

def remove_attr name
  @attributes.delete name
end

#remove_role(name) ⇒ Boolean

Removes the given role directly from this node.

Returns:

  • (Boolean) —

    Returns a Boolean indicating whether the role was removed.



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/asciidoctor/abstract_node.rb', line 251

def remove_role name
  if (val = @attributes['role']) && ((val = val.split).delete name)
    if val.empty?
      @attributes.delete 'role'
    else
      @attributes['role'] = val.join ' '
    end
    true
  else
    false
  end
end

#role ⇒ String

Retrieves the space-separated String role for this node.

Returns:

  • (String) —

    Returns the role as a space-separated String.



189
190
191
 
# File 'lib/asciidoctor/abstract_node.rb', line 189

def role
  @attributes['role']
end

#role=(names) ⇒ Object

Sets the value of the role attribute on this node.

Parameters:

  • names —

    A single role name, a space-separated String of role names, or an Array of role names

Returns:

  • the specified String role name or Array of role names



226
227
228
 
# File 'lib/asciidoctor/abstract_node.rb', line 226

def role= names
  @attributes['role'] = (::Array === names) ? (names.join ' ') : names
end

#role?(expected_value = nil) ⇒ Boolean

Checks if the role attribute is set on this node and, if an expected value is given, whether the space-separated role matches that value.

Parameters:

  • expected_value (defaults to: nil) —

    The expected String value of the role (optional, default: nil)

Returns:

  • (Boolean) —

    Returns a Boolean indicating whether the role attribute is set on this node and, if an expected value is given, whether the space-separated role matches that value.



207
208
209
 
# File 'lib/asciidoctor/abstract_node.rb', line 207

def role? expected_value = nil
  expected_value ? expected_value == @attributes['role'] : (@attributes.key? 'role')
end

#roles ⇒ Array

Retrieves the String role names for this node as an Array.

Returns:

  • (Array) —

    Returns the role names as a String Array, which is empty if the role attribute is absent on this node.



196
197
198
 
# File 'lib/asciidoctor/abstract_node.rb', line 196

def roles
  (val = @attributes['role']) ? val.split : []
end

#set_attr(name, value = '', overwrite = true) ⇒ Boolean

Assign the value to the attribute name for the current node.

Parameters:

  • name —

    The String attribute name to assign

  • value (defaults to: '') —

    The Object value to assign to the attribute (default: ”)

  • overwrite (defaults to: true) —

    A Boolean indicating whether to assign the attribute if currently present in the attributes Hash (default: true)

Returns:

  • (Boolean) —

    Returns a Boolean indicating whether the assignment was performed



123
124
125
126
127
128
129
130
 
# File 'lib/asciidoctor/abstract_node.rb', line 123

def set_attr name, value = '', overwrite = true
  if overwrite == false && (@attributes.key? name)
    false
  else
    @attributes[name] = value
    true
  end
end

#set_option(name) ⇒ void

This method returns an undefined value.

Set the specified option on this node.

This method sets the specified option on this node by setting the <name>-option attribute.

Parameters:

  • name —

    the String name of the option



161
162
163
164
 
# File 'lib/asciidoctor/abstract_node.rb', line 161

def set_option name # rubocop:disable Naming/AccessorMethodName
  @attributes[%(#{name}-option)] = ''
  nil
end

#update_attributes(new_attributes) ⇒ Hash

Update the attributes of this node with the new values in the attributes argument.

If an attribute already exists with the same key, it’s value will be overwritten.

Parameters:

  • new_attributes —

    A Hash of additional attributes to assign to this node.

Returns:

  • (Hash) —

    Returns the updated attributes Hash on this node.



182
183
184
 
# File 'lib/asciidoctor/abstract_node.rb', line 182

def update_attributes new_attributes
  @attributes.update new_attributes
end