module Asciidoctor::Helpers

Public Class Methods

encode_uri(str) click to toggle source

Public: Encode a string for inclusion in a URI

str - the string to encode

returns an encoded version of the str

# File lib/asciidoctor/helpers.rb, line 29
def self.encode_uri(str)
  str.gsub(REGEXP[:uri_encode_chars]) do
    match = $&
    buf = ''
    match.each_byte do |c|
      buf << sprintf('%%%02X', c)
    end
    buf
  end
end
mkdir_p(dir) click to toggle source
# File lib/asciidoctor/helpers.rb, line 40
def self.mkdir_p(dir)
  unless File.directory? dir
    parent_dir = File.dirname(dir)
    if !File.directory?(parent_dir = File.dirname(dir)) && parent_dir != '.'
      mkdir_p(parent_dir)
    end
    Dir.mkdir(dir)
  end
end
require_library(name) click to toggle source

Internal: Prior to invoking Kernel#require, issues a warning urging a manual require if running in a threaded environment.

name - the String name of the library to require.

returns false if the library is detected on the load path or the return value of delegating to Kernel#require

# File lib/asciidoctor/helpers.rb, line 10
def self.require_library(name)
  if Thread.list.size > 1
    main_script = "#{name}.rb"
    main_script_path_segment = "/#{name}.rb"
    if !$LOADED_FEATURES.detect {|p| p == main_script || p.end_with?(main_script_path_segment) }.nil?
      return false
    else
      warn "WARN: asciidoctor is autoloading '#{name}' in threaded environment. " +
         "The use of an explicit require '#{name}' statement is recommended."
    end
  end
  require name
end