asciidoctor-dita-map 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 785383f1b9ac91dfff356c6ccfce6568a16af5c805715d24d294f8539d019d89
+  data.tar.gz: 0be9258a03b8cff762cd30aae0657b6d105636b1a92334ed456ae68f57eabf1b
+SHA512:
+  metadata.gz: d9dcb68378da10bd98c006524283da2741f32028988dcd2236ecaef3e5933e44a333f8502d8656e94c29dffff1373b542ed2efc75b48e6130d35cd5722395ac9
+  data.tar.gz: c550422cc1932cc96c952c26a978d48d7788a8b5c9700ad3c51c1f544f29407d780fc5c13a25b06b11e78ae4b7b0751ab26caecf01020c449d94397b10b4d6db

data/AUTHORS

@@ -0,0 +1 @@
+Jaromir Hradilek <jhradilek@gmail.com>

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2026 Jaromir Hradilek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+# dita-map
+
+**dita-map** is a command line utility that converts a single AsciiDoc file to a DITA map.
+
+## Copyright
+
+Copyright © 2026 Jaromir Hradilek
+
+This program is free software, released under the terms of the MIT license. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

data/bin/dita-map

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# Copyright (C) 2026 Jaromir Hradilek
+
+# MIT License
+#
+# Permission  is hereby granted,  free of charge,  to any person  obtaining
+# a copy of  this software  and associated documentation files  (the "Soft-
+# ware"),  to deal in the Software  without restriction,  including without
+# limitation the rights to use,  copy, modify, merge,  publish, distribute,
+# sublicense, and/or sell copies of the Software,  and to permit persons to
+# whom the Software is furnished to do so,  subject to the following condi-
+# tions:
+#
+# The above copyright notice  and this permission notice  shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS
+# OR IMPLIED,  INCLUDING BUT NOT LIMITED TO  THE WARRANTIES OF MERCHANTABI-
+# LITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
+# SHALL THE AUTHORS OR COPYRIGHT HOLDERS  BE LIABLE FOR ANY CLAIM,  DAMAGES
+# OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM,  OUT OF OR IN CONNECTION WITH  THE SOFTWARE  OR  THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+require (cli = File.absolute_path '../lib/dita-map/cli.rb', __dir__) ? cli : 'dita-map/cli'
+
+begin
+  name = File.basename($0)
+  converter = AsciidoctorDitaMap::Cli.new name, ARGV
+  converter.run
+rescue OptionParser::InvalidArgument, OptionParser::InvalidOption, OptionParser::MissingArgument => error
+  abort "#{name}: #{error.message}"
+rescue Interrupt
+  exit 130
+end

data/lib/dita-map/catalog.rb

@@ -0,0 +1,43 @@
+# Copyright (C) 2026 Jaromir Hradilek
+
+# MIT License
+#
+# Permission  is hereby granted,  free of charge,  to any person  obtaining
+# a copy of  this software  and associated documentation files  (the "Soft-
+# ware"),  to deal in the Software  without restriction,  including without
+# limitation the rights to use,  copy, modify, merge,  publish, distribute,
+# sublicense, and/or sell copies of the Software,  and to permit persons to
+# whom the Software is furnished to do so,  subject to the following condi-
+# tions:
+#
+# The above copyright notice  and this permission notice  shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS
+# OR IMPLIED,  INCLUDING BUT NOT LIMITED TO  THE WARRANTIES OF MERCHANTABI-
+# LITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
+# SHALL THE AUTHORS OR COPYRIGHT HOLDERS  BE LIABLE FOR ANY CLAIM,  DAMAGES
+# OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM,  OUT OF OR IN CONNECTION WITH  THE SOFTWARE  OR  THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+require 'asciidoctor'
+
+class CatalogIncludeDirectives < Asciidoctor::Extensions::IncludeProcessor
+  def handles? target
+    target.end_with? '.adoc', '.asciidoc', '.asc', '.ad'
+  end
+
+  def process doc, reader, target, attributes
+    offset = attributes['leveloffset'].to_i
+
+    doc.catalog[:include_files] = [] unless doc.catalog[:include_files]
+    doc.catalog[:include_files].append({
+      :target => target,
+      :offset => offset
+    })
+
+    reader
+  end
+end
+

data/lib/dita-map/cli.rb

@@ -0,0 +1,258 @@
+# Copyright (C) 2026 Jaromir Hradilek
+
+# MIT License
+#
+# Permission  is hereby granted,  free of charge,  to any person  obtaining
+# a copy of  this software  and associated documentation files  (the "Soft-
+# ware"),  to deal in the Software  without restriction,  including without
+# limitation the rights to use,  copy, modify, merge,  publish, distribute,
+# sublicense, and/or sell copies of the Software,  and to permit persons to
+# whom the Software is furnished to do so,  subject to the following condi-
+# tions:
+#
+# The above copyright notice  and this permission notice  shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS
+# OR IMPLIED,  INCLUDING BUT NOT LIMITED TO  THE WARRANTIES OF MERCHANTABI-
+# LITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
+# SHALL THE AUTHORS OR COPYRIGHT HOLDERS  BE LIABLE FOR ANY CLAIM,  DAMAGES
+# OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM,  OUT OF OR IN CONNECTION WITH  THE SOFTWARE  OR  THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+require 'optparse'
+require 'pathname'
+require 'asciidoctor'
+require 'rexml/document'
+require_relative 'catalog'
+require_relative 'version'
+
+module AsciidoctorDitaMap
+  class Cli
+    def initialize name, argv
+      @attr = []
+      @opts = {
+        :id => true,
+        :navtitle => true,
+        :output => false,
+        :title => true,
+        :type => true
+      }
+      @prep = []
+      @name = name
+      @args = self.parse_args argv
+    end
+
+    def parse_args argv
+      parser = OptionParser.new do |opt|
+        opt.banner  = "Usage: #{@name} [OPTION...] [FILE...]\n"
+        opt.banner += "       #{@name} -h|-v\n\n"
+
+        opt.on('-o', '--out-file FILE', 'specify the output file; by default, the output file name is based on the input file') do |output|
+          @opts[:output] = (output.strip == '-') ? $stdout : output
+        end
+
+        opt.on('-a', '--attribute ATTRIBUTE', 'set a document attribute in the form of name, name!, or name=value pair; can be supplied multiple times') do |value|
+          @attr.append value
+        end
+
+        opt.separator ''
+
+        opt.on('-p', '--prepend-file FILE', 'prepend a file to all input files; can be supplied multiple times') do |file|
+          raise OptionParser::InvalidArgument, "not a file: #{file}" unless File.exist? file and File.file? file
+          raise OptionParser::InvalidArgument, "file not readable: #{file}" unless File.readable? file
+
+          @prep.append file
+        end
+
+        opt.separator ''
+
+        opt.on('-I', '--no-id', 'do not generate the map id attribute') do
+          @opts[:id] = false
+        end
+
+        opt.on('-M', '--no-maptitle', 'do not generate the map title') do
+          @opts[:title] = false
+        end
+
+        opt.on('-N', '--no-navtitle', 'do not generate the navtitle attribute') do
+          @opts[:navtitle] = false
+        end
+
+        opt.on('-T', '--no-type', 'do not generate the type attribute') do
+          @opts[:type] = false
+        end
+
+        opt.separator ''
+
+        opt.on('-h', '--help', 'display this help and exit') do
+          puts opt
+          exit
+        end
+
+        opt.on('-v', '--version', 'display version information and exit') do
+          puts "#{@name} #{VERSION}"
+          exit
+        end
+      end
+
+      args = parser.parse argv
+
+      if args.length == 0 or args[0].strip == '-'
+        return [$stdin]
+      end
+
+      args.each do |file|
+        raise OptionParser::InvalidArgument, "not a file: #{file}" unless File.exist? file and File.file? file
+        raise OptionParser::InvalidArgument, "file not readable: #{file}" unless File.readable? file
+      end
+
+      return args
+    end
+
+    def parse_topic input
+      doc = Asciidoctor.load input, safe: :secure, attributes: @attr
+      att = doc.attributes
+
+      document_title = doc.title ? doc.title.gsub(/<[^>]*>/, '') : nil
+      document_type  = att['_mod-docs-content-type'] ? att['_mod-docs-content-type'].downcase : nil
+      document_type  = att['_content-type'] ? att['_content-type'].downcase : nil unless document_type
+      document_type  = att['_module-type'] ? att['_module-type'].downcase : nil unless document_type
+
+      if document_type
+        document_type.sub!(/^assembly$/, 'concept')
+        document_type.sub!(/^procedure$/, 'task')
+      end
+
+      unless ['concept', 'reference', 'task', 'map'].include? document_type
+        document_type = nil
+      end
+
+      return document_title, document_type
+    end
+
+
+    def parse_map input, base_dir
+      Asciidoctor::Extensions.register do
+        include_processor CatalogIncludeDirectives
+      end
+
+      doc = Asciidoctor.load input, safe: :safe, catalog_assets: true, attributes: @attr, base_dir: base_dir
+
+      include_files  = doc.catalog[:include_files] ? doc.catalog[:include_files] : []
+      document_title = doc.title ? doc.title.gsub(/<[^>]*>/, '') : nil
+      document_id    = doc.id ? doc.id.gsub(/["']/, '') : nil
+
+      return include_files, document_title, document_id
+    end
+
+    def convert_map input, base_dir, prepended = ''
+      result = ''
+
+      include_files, map_title, document_id = parse_map prepended + input, base_dir
+
+      xml = REXML::Document.new
+      xml.context[:attribute_quote] = :quote
+      xml << REXML::XMLDecl.new('1.0', 'utf-8')
+      xml << REXML::DocType.new('map', 'PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd"')
+
+      if document_id and @opts[:id]
+        xml_root  = xml.add_element('map', { 'id' => document_id })
+      else
+        xml_root  = xml.add_element('map')
+      end
+
+      if map_title and @opts[:title]
+        xml_title = xml_root.add_element('title')
+        xml_title.text = map_title
+      end
+
+      stack = [{ :offset => 0, :element => xml_root }]
+
+      include_files.each do |file|
+        target      = file[:target]
+        offset      = file[:offset]
+        last_offset = stack.last[:offset]
+
+        if offset == 0
+          warn "#{@name}: warning: Invalid leveloffset - expected 1, got 0: #{target}"
+          offset = 1
+        elsif offset > last_offset and offset - last_offset > 1
+          expected_offset = last_offset + 1
+          warn "#{@name}: warning: Invalid leveloffset - expected #{expected_offset}, got #{offset}: #{target}"
+          offset = expected_offset
+        end
+
+        while stack.last[:offset] >= offset
+          stack.pop
+        end
+
+        xml_parent   = stack.last[:element]
+
+        if @opts[:navtitle] or @opts[:type]
+          begin
+            include_title, include_type = parse_topic prepended + File.read(base_dir + target)
+          rescue
+            warn "#{@name}: warning: Unable to read included file: #{base_dir + target}"
+            include_title, include_type = nil, nil
+          end
+        end
+
+        if include_type == 'map'
+          file_name          = target.sub(/\.adoc$/, '.ditamap')
+          attributes         = { 'href' => file_name, 'format' => 'ditamap' }
+          attributes['type'] = include_type if @opts[:type]
+
+          xml_element = xml_parent.add_element('mapref', attributes)
+        else
+          file_name = target.sub(/\.adoc$/, '.dita')
+          attributes             = { 'href' => file_name }
+          attributes['navtitle'] = include_title if include_title and @opts[:navtitle]
+          attributes['type']     = include_type if include_type and @opts[:type]
+
+          xml_element = xml_parent.add_element('topicref', attributes)
+        end
+
+        stack.push ({ :offset => offset, :element => xml_element })
+      end
+
+      formatter = REXML::Formatters::Pretty.new(2, true)
+      formatter.compact = true
+      formatter.write(xml, result)
+
+      result << "\n"
+
+      return result
+    end
+
+    def run
+      prepended = ''
+
+      @prep.each do |file|
+        prepended << File.read(file)
+        prepended << "\n"
+      end
+
+      @args.each do |file|
+        if file == $stdin
+          base_dir = Pathname.new(Dir.pwd).expand_path
+          input    = $stdin.read
+          output   = @opts[:output] ? @opts[:output] : $stdout
+        else
+          base_dir = Pathname.new(file).dirname.expand_path
+          input    = File.read(file)
+          output   = @opts[:output] ? @opts[:output] : Pathname.new(file).sub_ext('.ditamap').to_s
+        end
+
+        result = convert_map input, base_dir, prepended
+
+        if output == $stdout
+          $stdout.write result
+        else
+          File.write output, result
+        end
+      end
+    end
+  end
+end

data/lib/dita-map/version.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2026 Jaromir Hradilek
+
+# MIT License
+#
+# Permission  is hereby granted,  free of charge,  to any person  obtaining
+# a copy of  this software  and associated documentation files  (the "Soft-
+# ware"),  to deal in the Software  without restriction,  including without
+# limitation the rights to use,  copy, modify, merge,  publish, distribute,
+# sublicense, and/or sell copies of the Software,  and to permit persons to
+# whom the Software is furnished to do so,  subject to the following condi-
+# tions:
+#
+# The above copyright notice  and this permission notice  shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND,  EXPRESS
+# OR IMPLIED,  INCLUDING BUT NOT LIMITED TO  THE WARRANTIES OF MERCHANTABI-
+# LITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
+# SHALL THE AUTHORS OR COPYRIGHT HOLDERS  BE LIABLE FOR ANY CLAIM,  DAMAGES
+# OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM,  OUT OF OR IN CONNECTION WITH  THE SOFTWARE  OR  THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+# frozen_string_literal: true
+
+module AsciidoctorDitaMap
+  VERSION     = '0.1.0'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-dita-map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaromir Hradilek
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.26
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.26
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.3.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.27'
+description: A command line utility that converts a single AsciiDoc file to a DITA
+  map.
+email: jhradilek@gmail.com
+executables:
+- dita-map
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- LICENSE
+- README.md
+- bin/dita-map
+- lib/dita-map/catalog.rb
+- lib/dita-map/cli.rb
+- lib/dita-map/version.rb
+homepage: https://github.com/jhradilek/asciidoctor-dita-map
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jhradilek/asciidoctor-dita-map
+  bug_tracker_uri: https://github.com/jhradilek/asciidoctor-dita-map/issues
+  documentation_uri: https://github.com/jhradilek/asciidoctor-dita-map/blob/main/README.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Convert an AsciiDoc file to a DITA map
+test_files: []