asciidoctor-xml-ast 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5787ab74943ac77f8d74feeacc44271123a213cc97ecf0b97c43eed74ac6b9d
+  data.tar.gz: 4a80b86fe5ede21a76b77aaef3c43636b6e51b842af0f635252c2349d4719713
+SHA512:
+  metadata.gz: c9a384773cbaa0b32d1a1b00fa77c811814b941a29e9c866618a695f8fa7e83cb390b2d6d1d28c2b3e75148e8867d7629888738964e3536f7f2423b5c569dcad
+  data.tar.gz: f7751122d0b16ce7e7e7890303b316188d433d310fd1a3ab874d1dd6472c6d528287a6b029d36a2d24732d1f0e1e9c22701e2f6a6a6a431b104c8e3323242b82

data/README.md

@@ -0,0 +1,54 @@
+# asciidoctor-ast-xml
+
+This repository implements an [Asciidoctor converter] to generate a XML file
+with the syntax nodes of a parsed document.
+
+## Usage
+
+The converter is available as a Ruby gem, and can be installed with the
+following command:
+
+```console
+$ gem install asciidoctor-ast-xml
+```
+
+Then, add the options `--require asciidoctor-ast-xml` and `--backend xml-ast`.
+For example:
+
+```console
+$ asciidoctor -r asciidoctor-ast-xml -b xml-ast document.adoc
+```
+
+In the previous command, the output will be in the `document.ast.xml` file.
+
+## Example
+
+The following document:
+
+```asciidoc
+= Lorem Ipsum
+
+== Dolor Sit Amet
+
+Cillum dolore eu *fugiat* nulla pariatur
+```
+
+Generates a XML like this:
+
+```xml
+<document title="Lorem Ipsum" ... >
+  <section id="_dolor_sit_amet" title="Dolor Sit Amet">
+    <paragraph>Cillum dolore eu <inline-quoted type="strong">fugiat</inline-quoted> nulla pariatur</paragraph>
+  </section>
+</document>
+```
+
+The `<document>` element contains a lot of attributes, which have been removed
+in this example so it is easier to read.
+
+The actual output is not indented. The previous example is formatted with [xmllint].
+
+
+
+[Asciidoctor converter]: https://docs.asciidoctor.org/asciidoctor/latest/convert/
+[xmllint]: https://gnome.pages.gitlab.gnome.org/libxml2/xmllint.html

data/lib/asciidoctor-xml-ast.rb

@@ -0,0 +1,70 @@
+require "cgi"
+
+class AstConverter
+  include Asciidoctor::Converter
+  register_for "xml-ast"
+
+  def initialize(*args)
+    super
+    outfilesuffix ".ast.xml"
+  end
+
+  def convert(node, transform = node.node_name)
+    element_name = transform.tr("_", "-")
+
+    # Element attributes.
+    attributes = []
+
+    %i(id target title type).each do |name|
+      if node.respond_to?(name) and value = node.send(name) and not value.nil?
+        value = CGI.escapeHTML(value.to_s)
+        attributes << %[ #{name}="#{value}"]
+      end
+    end
+
+    node.attributes.each_pair do |name, value|
+      if not value.nil?
+        value = CGI.escapeHTML(value.to_s)
+        attributes << %[ attr-#{name}="#{value}"]
+      end
+    end
+
+    # Element body.
+    result = []
+
+    result << "<#{element_name}#{attributes.join}>"
+
+    if node.respond_to?(:text)
+      result << node.text
+    end
+
+    if node.block?
+      append_content(result, node.content)
+    end
+
+    result << "</#{element_name}>"
+    result.join
+  end
+
+  def append_content(result, content)
+    case content
+    when Array
+      content.each do |i|
+        append_content(result, i)
+      end
+
+    when String
+      result << content
+
+    when Asciidoctor::AbstractNode
+      result << content.convert
+
+    when nil
+      # Nothing to add.
+
+    else
+      raise "Invalid content type: #{content.class}"
+
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-xml-ast
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ayosec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |2
+      Asciidoctor converter to generate a XML file with the syntax
+      nodes from a parsed document.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/asciidoctor-xml-ast.rb
+homepage: https://github.com/ayosec/asciidoctor-xml-ast
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Converter for Asciidoctor syntax to XML
+test_files: []