asciidoctor 1.5.8 → 2.0.0.rc.1

data/lib/asciidoctor/converter/base.rb

@@ -1,59 +0,0 @@
-# encoding: UTF-8
-module Asciidoctor
-  module Converter; end # required for Opal
-
-  # An abstract base class for defining converters that can be used to convert
-  # {AbstractNode} objects in a parsed AsciiDoc document to a backend format
-  # such as HTML or DocBook.
-  #
-  # Concrete subclasses must implement the {#convert} method and, optionally,
-  # the {#convert_with_options} method.
-  class Converter::Base
-    include Logging
-    include Converter
-  end
-
-  # An abstract base class for built-in {Converter} classes.
-  # Does not inherit from Converter.
-  class Converter::BuiltIn
-    include Logging
-
-    def initialize backend, opts = {}
-    end
-
-    # Public: Converts the specified {AbstractNode} using the specified
-    # transform and optionally additional options (when not empty).
-    #
-    # CAUTION: Method that handles the specified transform *may not* accept the
-    # second argument with additional options, in which case an {ArgumentError}
-    # is raised if the given +opts+ Hash is not nil. The additional options are
-    # used in template-based backends to access convert helper methods such as
-    # outline.
-    #
-    # See {Converter#convert} for more details.
-    #
-    # Returns the [String] result of conversion
-    def convert node, transform = nil, opts = {}
-      transform ||= node.node_name
-      opts.empty? ? (send transform, node) : (send transform, node, opts)
-    end
-
-    alias handles? respond_to?
-
-    # Public: Returns the converted content of the {AbstractNode}.
-    #
-    # Returns the converted [String] content of the {AbstractNode}.
-    def content node
-      node.content
-    end
-
-    alias pass content
-
-    # Public: Skips conversion of the {AbstractNode}.
-    #
-    # Returns [NilClass]
-    def skip node
-      nil
-    end
-  end
-end

data/lib/asciidoctor/converter/docbook45.rb

@@ -1,93 +0,0 @@
-# encoding: UTF-8
-require 'asciidoctor/converter/docbook5'
-
-module Asciidoctor
-  # A built-in {Converter} implementation that generates DocBook 4.5 output
-  # consistent with the docbook45 backend from AsciiDoc Python.
-  class Converter::DocBook45Converter < Converter::DocBook5Converter
-    def admonition node
-      # address a bug in the DocBook 4.5 DTD
-      if node.parent.context == :example
-        %(<para>
-#{super}
-</para>)
-      else
-        super
-      end
-    end
-
-    def olist node
-      result = []
-      num_attribute = node.style ? %( numeration="#{node.style}") : ''
-      start_attribute = (node.attr? 'start') ? %( override="#{node.attr 'start'}") : ''
-      result << %(<orderedlist#{common_attributes node.id, node.role, node.reftext}#{num_attribute}>)
-      result << %(<title>#{node.title}</title>) if node.title?
-      node.items.each_with_index do |item, idx|
-        result << (idx == 0 ? %(<listitem#{start_attribute}>) : '<listitem>')
-        result << %(<simpara>#{item.text}</simpara>)
-        result << item.content if item.blocks?
-        result << '</listitem>'
-      end
-      result << %(</orderedlist>)
-      result.join LF
-    end
-
-    def inline_anchor node
-      case node.type
-      when :ref
-        %(<anchor#{common_attributes node.target, nil, node.text}/>)
-      when :xref
-        if (path = node.attributes['path'])
-          # QUESTION should we use refid as fallback text instead? (like the html5 backend?)
-          %(<ulink url="#{node.target}">#{node.text || path}</ulink>)
-        else
-          linkend = node.attributes['fragment'] || node.target
-          (text = node.text) ? %(<link linkend="#{linkend}">#{text}</link>) : %(<xref linkend="#{linkend}"/>)
-        end
-      when :link
-        %(<ulink url="#{node.target}">#{node.text}</ulink>)
-      when :bibref
-        target = node.target
-        %(<anchor#{common_attributes target, nil, "[#{target}]"}/>[#{target}])
-      end
-    end
-
-    def author_tag author
-      result = []
-      result << '<author>'
-      result << %(<firstname>#{author.firstname}</firstname>) if author.firstname
-      result << %(<othername>#{author.middlename}</othername>) if author.middlename
-      result << %(<surname>#{author.lastname}</surname>) if author.lastname
-      result << %(<email>#{author.email}</email>) if author.email
-      result << '</author>'
-      result.join LF
-    end
-
-    def common_attributes id, role = nil, reftext = nil
-      res = id ? %( id="#{id}") : ''
-      res = %(#{res} role="#{role}") if role
-      res = %(#{res} xreflabel="#{reftext}") if reftext
-      res
-    end
-
-    def doctype_declaration root_tag_name
-      %(<!DOCTYPE #{root_tag_name} PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">)
-    end
-
-    def document_info_tag doc, info_tag_prefix
-      super doc, info_tag_prefix, true
-    end
-
-    def lang_attribute_name
-      'lang'
-    end
-
-    def document_ns_attributes doc
-      if (ns = doc.attr 'xmlns')
-        ns.empty? ? ' xmlns="http://docbook.org/ns/docbook"' : %( xmlns="#{ns}")
-      else
-        ''
-      end
-    end
-  end
-end

data/lib/asciidoctor/converter/factory.rb

@@ -1,226 +0,0 @@
-# encoding: UTF-8
-module Asciidoctor
-  module Converter
-    # A factory for instantiating converters that are used to convert a
-    # {Document} (i.e., a parsed AsciiDoc tree structure) or {AbstractNode} to
-    # a backend format such as HTML or DocBook. {Factory Converter::Factory} is
-    # the primary entry point for creating, registering and accessing
-    # converters.
-    #
-    # {Converter} objects are instantiated by passing a String backend name
-    # and, optionally, an options Hash to the {Factory#create} method. The
-    # backend can be thought of as an intent to convert a document to a
-    # specified format. For example:
-    #
-    #   converter = Asciidoctor::Converter::Factory.create 'html5', :htmlsyntax => 'xml'
-    #
-    # Converter objects are thread safe. They only survive the lifetime of a single conversion.
-    #
-    # A singleton instance of {Factory Converter::Factory} can be accessed
-    # using the {Factory.default} method. This instance maintains the global
-    # registry of statically registered converters. The registery includes
-    # built-in converters for {Html5Converter HTML 5}, {DocBook5Converter
-    # DocBook 5} and {DocBook45Converter DocBook 4.5}, as well as any custom
-    # converters that have been discovered or explicitly registered.
-    #
-    # If the {https://rubygems.org/gems/concurrent-ruby concurrent-ruby} gem is
-    # installed, access to the default factory is guaranteed to be thread safe.
-    # Otherwise, a warning is issued to the user.
-    class Factory
-      @__default__ = nil
-      class << self
-
-        # Public: Retrieves a singleton instance of {Factory Converter::Factory}.
-        #
-        # If the concurrent-ruby gem is installed, the registry of converters is
-        # initialized as a Concurrent::Hash. Otherwise, a warning is issued and
-        # the registry of converters is initialized using a normal Hash.
-        #
-        # initialize_singleton - A Boolean to indicate whether the singleton should
-        #                        be initialized if it has not already been created.
-        #                        If false, and a singleton has not been previously
-        #                        initialized, a fresh instance is returned.
-        #
-        # Returns the default [Factory] singleton instance
-        def default initialize_singleton = true
-          return @__default__ || new unless initialize_singleton
-          # FIXME this assignment itself may not be thread safe; may need to use a helper here
-          @__default__ ||= begin
-            unless defined? ::Concurrent::Hash
-              # NOTE dynamic require is ignored by Opal
-              require ::RUBY_MIN_VERSION_1_9 ? 'concurrent/hash' : 'asciidoctor/core_ext/1.8.7/concurrent/hash'
-            end
-            new ::Concurrent::Hash.new
-          rescue ::LoadError
-            include Logging unless include? Logging
-            logger.warn 'gem \'concurrent-ruby\' is not installed. This gem is recommended when registering custom converters.'
-            new
-          end
-        end
-
-        # Public: Register a custom converter in the global converter factory to
-        # handle conversion to the specified backends. If the backend value is an
-        # asterisk, the converter is used to handle any backend that does not have
-        # an explicit converter.
-        #
-        # converter - The Converter class to register
-        # backends  - A String Array of backend names that this converter should
-        #             be registered to handle (optional, default: ['*'])
-        #
-        # Returns nothing
-        def register converter, backends = ['*']
-          default.register converter, backends
-        end
-
-        # Public: Lookup the custom converter for the specified backend in the
-        # global factory.
-        #
-        # This method does not resolve the built-in converters.
-        #
-        # backend - The String backend name
-        #
-        # Returns the [Converter] class registered to convert the specified backend
-        # or nil if no match is found
-        def resolve backend
-          default.resolve backend
-        end
-
-        # Public: Lookup the converter for the specified backend in the global
-        # factory and instantiate it, forwarding the Hash of options to the
-        # constructor of the converter class.
-        #
-        # If the custom converter is not found, an attempt will be made to find
-        # and instantiate a built-in converter.
-        #
-        # backend - The String backend name
-        # opts - A Hash of options to pass to the converter
-        #
-        # Returns an instance of [Converter] for converting the specified backend or
-        # nil if no match is found.
-        def create backend, opts = {}
-          default.create backend, opts
-        end
-
-        # Public: Retrieve the global Hash of custom Converter classes keyed by backend.
-        #
-        # Returns the the global [Hash] of custom Converter classes
-        def converters
-          default.converters
-        end
-
-        # Public: Unregister all Converter classes in the global factory.
-        #
-        # Returns nothing
-        def unregister_all
-          default.unregister_all
-        end
-      end
-
-      # Public: Get the Hash of Converter classes keyed by backend name
-      attr_reader :converters
-
-      def initialize converters = nil
-        @converters = converters || {}
-        @star_converter = nil
-      end
-
-      # Public: Register a custom converter with this factory to handle conversion
-      # to the specified backends. If the backend value is an asterisk, the
-      # converter is used to handle any backend that does not have an explicit
-      # converter.
-      #
-      # converter - The Converter class to register
-      # backends  - A String Array of backend names that this converter should
-      #             be registered to handle (optional, default: ['*'])
-      #
-      # Returns nothing
-      def register converter, backends = ['*']
-        backends.each do |backend|
-          @converters[backend] = converter
-          if backend == '*'
-            @star_converter = converter
-          end
-        end
-        nil
-      end
-
-      # Public: Lookup the custom converter registered with this factory to handle
-      # the specified backend.
-      #
-      # backend - The String backend name
-      #
-      # Returns the [Converter] class registered to convert the specified backend
-      # or nil if no match is found
-      def resolve backend
-        @converters && (@converters[backend] || @star_converter)
-      end
-
-      # Public: Unregister all Converter classes that are registered with this
-      # factory.
-      #
-      # Returns nothing
-      def unregister_all
-        @converters.clear
-        @star_converter = nil
-      end
-
-      # Public: Create a new Converter object that can be used to convert the
-      # {AbstractNode} (typically a {Document}) to the specified String backend.
-      # This method accepts an optional Hash of options that are passed to the
-      # converter's constructor.
-      #
-      # If a custom Converter is found to convert the specified backend, it is
-      # instantiated (if necessary) and returned immediately. If a custom
-      # Converter is not found, an attempt is made to resolve a built-in
-      # converter. If the `:template_dirs` key is found in the Hash passed as the
-      # second argument, a {CompositeConverter} is created that delegates to a
-      # {TemplateConverter} and, if resolved, the built-in converter. If the
-      # `:template_dirs` key is not found, the built-in converter is returned
-      # or nil if no converter is resolved.
-      #
-      # backend - the String backend name
-      # opts    - an optional Hash of options that get passed on to the converter's
-      #           constructor. If the :template_dirs key is found in the options
-      #           Hash, this method returns a {CompositeConverter} that delegates
-      #           to a {TemplateConverter}. (optional, default: {})
-      #
-      # Returns the [Converter] object
-      def create backend, opts = {}
-        if (converter = resolve backend)
-          base_converter = ::Class === converter ? (converter.new backend, opts) : converter
-          return base_converter unless Converter::BackendInfo === base_converter && base_converter.supports_templates?
-        else
-          case backend
-          when 'html5'
-            # NOTE .to_s hides require from Opal
-            require 'asciidoctor/converter/html5'.to_s unless defined? ::Asciidoctor::Converter::Html5Converter
-            base_converter = Html5Converter.new backend, opts
-          when 'docbook5'
-            # NOTE .to_s hides require from Opal
-            require 'asciidoctor/converter/docbook5'.to_s unless defined? ::Asciidoctor::Converter::DocBook5Converter
-            base_converter = DocBook5Converter.new backend, opts
-          when 'docbook45'
-            # NOTE .to_s hides require from Opal
-            require 'asciidoctor/converter/docbook45'.to_s unless defined? ::Asciidoctor::Converter::DocBook45Converter
-            base_converter = DocBook45Converter.new backend, opts
-          when 'manpage'
-            # NOTE .to_s hides require from Opal
-            require 'asciidoctor/converter/manpage'.to_s unless defined? ::Asciidoctor::Converter::ManPageConverter
-            base_converter = ManPageConverter.new backend, opts
-          end
-        end
-
-        return base_converter unless opts.key? :template_dirs
-
-        # NOTE .to_s hides require from Opal
-        require 'asciidoctor/converter/template'.to_s unless defined? ::Asciidoctor::Converter::TemplateConverter
-        template_converter = TemplateConverter.new backend, opts[:template_dirs], opts
-
-        # NOTE .to_s hides require from Opal
-        require 'asciidoctor/converter/composite'.to_s unless defined? ::Asciidoctor::Converter::CompositeConverter
-        # QUESTION should we omit the composite converter if built_in_converter is nil?
-        CompositeConverter.new backend, template_converter, base_converter
-      end
-    end
-  end
-end

data/lib/asciidoctor/core_ext/1.8.7/base64/strict_encode64.rb

@@ -1,6 +0,0 @@
-# Educate Ruby 1.8.7 about the Base64#strict_encode64 method.
-module Base64
-  def strict_encode64 bin
-    (self.encode64 bin).delete %(\n)
-  end
-end

data/lib/asciidoctor/core_ext/1.8.7/concurrent/hash.rb

@@ -1,5 +0,0 @@
-require 'thread_safe'
-
-module Concurrent
-  Hash = ::ThreadSafe::Cache
-end

data/lib/asciidoctor/core_ext/1.8.7/hash/key.rb

@@ -1,4 +0,0 @@
-# Educate Ruby 1.8.7 about the Hash#key method.
-class Hash
-  alias key index
-end

data/lib/asciidoctor/core_ext/1.8.7/io/binread.rb

@@ -1,6 +0,0 @@
-def IO.binread name, length = nil, offset = 0
-  File.open name, 'rb' do |f|
-    f.seek offset unless offset == 0
-    length ? (f.read length) : f.read
-  end
-end unless IO.respond_to? :binread

data/lib/asciidoctor/core_ext/1.8.7/io/write.rb

@@ -1,5 +0,0 @@
-def IO.write name, string, offset = 0, opts = nil
-  File.open name, 'w' do |f|
-    f.write string
-  end
-end unless IO.respond_to? :write

data/lib/asciidoctor/core_ext/1.8.7/string/chr.rb

@@ -1,6 +0,0 @@
-# Educate Ruby 1.8.7 about the String#chr method.
-class String
-  def chr
-    slice 0, 1
-  end unless method_defined? :chr
-end

data/lib/asciidoctor/core_ext/1.8.7/string/limit_bytesize.rb

@@ -1,29 +0,0 @@
-if RUBY_ENGINE_JRUBY
-  class String
-    # Safely truncate the string to the specified number of bytes.
-    # If a multibyte char gets split, the dangling fragment is removed.
-    def limit_bytesize size
-      return self unless size < bytesize
-      result = (unpack %(a#{size}))[0]
-      begin
-        result.unpack 'U*'
-      rescue ::ArgumentError
-        result.chop!
-        retry
-      end
-      result
-    end unless method_defined? :limit_bytesize
-  end
-else
-  class String
-    ValidTrailingCharRx = /.$/u
-    # Safely truncate the string to the specified number of bytes.
-    # If a multibyte char gets split, the dangling fragment is removed.
-    def limit_bytesize size
-      return self unless size < bytesize
-      result = (unpack %(a#{size}))[0]
-      result.chop! until result.empty? || (ValidTrailingCharRx.match? result)
-      result
-    end unless method_defined? :limit_bytesize
-  end
-end