asciidoctor-dita-topic 1.4.2 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 309a32eee2e59c3b1ef187bfbf1a36a87777c49834aae48c5c4889313638ab53
-  data.tar.gz: 4653870065c2f971cdaefa3c372c30bb3d22ee20cc88c0daf54f30b912eb8f21
+  metadata.gz: 717dd58c267369873a2fe78ec88ee18e1c8ff50c308a292374cb63cca102b14d
+  data.tar.gz: 3d6721ed5f09341567e887b90090e98fa6598050902f6ea52b606b08a1563459
 SHA512:
-  metadata.gz: 99037921c854d2a292fb3d973373cdc2e89e5a99d76b98755e20a0f9e7e8dc5b096530428c0a2e629b73e0344840537e89ef4e50815f1e30243b72b5ff16ea18
-  data.tar.gz: eca7844a1bfb3f1afea7dbbdfe4b78d0ffbedd6927f8c180615ffa11d899a1c0832ca181321d94ea8615ec4aecddf77c3d941e5b4a11cc18dac6a256cc913c9a
+  metadata.gz: 4f33bcd097400cc12f089794f09b4cbef47b7177f50fe1d6e076415b90abfb70d6ba39c9b4c93fdea33ac722913497ed8dc4f3c79f20646adce45c6b7b4e0a6b
+  data.tar.gz: ab89f66595f1724d584cbac39c07940920254b0264b275d8d026745e0824d60565bdc69f2a34aed03a047ce5f5a72af968faba956d8bc3a32b4dcd939f8199cf

data/lib/dita-topic/cli.rb

@@ -22,6 +22,7 @@
 # OTHER DEALINGS IN THE SOFTWARE.
 
 require 'optparse'
+require 'pathname'
 require 'asciidoctor'
 require_relative 'version'
 require_relative '../dita-topic'
@@ -30,7 +31,12 @@ module AsciidoctorDitaTopic
   class Cli
     def initialize name, argv
       @attr = ['experimental']
-      @opts = {:output => true, :includes => true, :standalone => true}
+      @opts = {
+        :output => false,
+        :includes => true,
+        :standalone => true,
+        :map => false
+      }
       @prep = []
       @name = name
       @args = self.parse_args argv
@@ -38,18 +44,28 @@ module AsciidoctorDitaTopic
 
     def parse_args argv
       parser = OptionParser.new do |opt|
-        opt.banner  = "Usage: #{@name} [OPTION...] FILE...\n"
+        opt.banner  = "Usage: #{@name} [OPTION...] [FILE...]\n"
         opt.banner += "       #{@name} -h|-v\n\n"
 
-        opt.on('-o', '--out-file FILE', 'output file; by default, the output file name is based on the input file') do |output|
+        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', 'document attribute to set in the form of name, name!, or name=value pair') do |value|
+        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.on('-p', '--prepend-file FILE', 'file to prepend to all input files') do |file|
+        opt.on('-s', '--no-header-footer', 'disable enclosing the content in <topic> and generating <title>') do
+          @opts[:standalone] = false
+        end
+
+        opt.separator ''
+
+        opt.on('-m', '--dita-map', 'generate a DITA map instead of a topic') do
+          @opts[:map] = true
+        end
+
+        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
 
@@ -60,10 +76,6 @@ module AsciidoctorDitaTopic
           @opts[:includes] = false
         end
 
-        opt.on('-s', '--no-header-footer', 'disable enclosing the content in <topic> and generating <title>') do
-          @opts[:standalone] = false
-        end
-
         opt.separator ''
 
         opt.on('-l', '--author-line', 'enable processing of author lines as metadata') do
@@ -113,6 +125,89 @@ module AsciidoctorDitaTopic
       return args
     end
 
+    def convert_map file, input, output
+      if file == $stdin
+        base_dir = Pathname.new(Dir.pwd).expand_path
+        offset   = 0
+      else
+        base_dir = Pathname.new(file).dirname.expand_path
+        file     = Pathname.new(file).sub_ext('.dita').basename
+        offset   = 1
+      end
+
+      doc        = Asciidoctor.load input, backend: 'dita-topic', safe: :unsafe, attributes: @attr, base_dir: base_dir, sourcemap: true
+      sections   = doc.find_by context: :section
+
+      return unless sections
+
+      title      = (sections.first.level == 0 and sections.first.title) ? sections.first.title : false
+
+      if @opts[:standalone]
+        result   = ["<?xml version='1.0' encoding='utf-8' ?>"]
+        result  << %(<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">)
+        result  << %(<map>)
+        result  << %(  <title>#{title}</title>) if title
+      else
+        result   = []
+      end
+
+      last_level = 0
+      last_file  = ''
+
+      sections.each_index do |i|
+        section  = sections[i]
+        level    = section.level
+        title    = section.title.gsub(/"|<[^>]*>|[<>]/, '')
+        filename = section.file ? Pathname.new(section.file).sub_ext('.dita').relative_path_from(base_dir) : Pathname.new(file)
+        current  = last_level
+
+        next if filename == last_file
+
+        while current > level
+          current -= 1
+          result << '  ' * (current + offset) + %(</topicref>)
+        end
+
+        if level - last_level > 1
+          warn "WARNING: #{filename.basename}: line #{section.lineno}: section title out of sequence: expected level #{last_level + 1}, got level #{level}"
+          level = last_level + 1
+        end
+
+        indent  = '  ' * (level + offset)
+        parent  = (sections[i + 1] and sections[i + 1].level > level) ? true : false
+        result << indent + %(<topicref href="#{filename}" navtitle="#{title}"#{parent ? '>' : ' />'}) unless filename == $stdin
+
+        last_level = level
+        last_file  = filename
+      end
+
+      while last_level > 0
+        last_level -= 1
+        break if last_level == 0 and file == $stdin
+        result << '  ' * (last_level + offset) + %(</topicref>)
+      end
+
+      if @opts[:standalone]
+        result << %(</map>)
+      end
+
+      if output == $stdout
+        $stdout.write result.join("\n")
+      else
+        File.write output, result.join("\n")
+      end
+    end
+
+    def convert_topic file, input, output
+      if file == $stdin
+        base_dir = Pathname.new(Dir.pwd).expand_path
+      else
+        base_dir = Pathname.new(file).dirname.expand_path
+      end
+
+      Asciidoctor.convert input, backend: 'dita-topic', standalone: @opts[:standalone], safe: :unsafe, attributes: @attr, to_file: output, base_dir: base_dir
+    end
+
     def run
       prepended = ''
 
@@ -124,15 +219,20 @@ module AsciidoctorDitaTopic
       @args.each do |file|
         if file == $stdin
           input  = $stdin.read
-          output = (@opts[:output] == true) ? $stdout : @opts[:output]
+          output = @opts[:output] ? @opts[:output] : $stdout
         else
+          suffix = @opts[:map] ? '.ditamap' : '.dita'
           input  = File.read(file)
-          output = (@opts[:output] == true) ? Pathname.new(file).sub_ext('.dita').to_s : @opts[:output]
+          output = @opts[:output] ? @opts[:output] : Pathname.new(file).sub_ext(suffix)
         end
 
         input.gsub!(Asciidoctor::IncludeDirectiveRx, '//\&') unless @opts[:includes]
 
-        Asciidoctor.convert prepended + input, backend: 'dita-topic', standalone: @opts[:standalone], safe: :unsafe, attributes: @attr, to_file: output
+        if @opts[:map]
+          convert_map file, prepended + input, output
+        else
+          convert_topic file, prepended + input, output
+        end
       end
     end
   end

data/lib/dita-topic/version.rb

@@ -24,5 +24,5 @@
 # frozen_string_literal: true
 
 module AsciidoctorDitaTopic
-  VERSION     = '1.4.2'
+  VERSION     = '1.4.4'
 end

data/lib/dita-topic.rb

@@ -203,7 +203,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Process individual list items:
     node.items.each do |terms, description|
       # Compose the metadata attributes:
-      metadata, terms[0].text = extract_attributes terms[0].text
+      metadata = extract_attributes terms[0].text
 
       # Open the definition entry:
       result << %(<dlentry#{metadata}>)
@@ -534,16 +534,16 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Process individual list items:
     node.items.each do |item|
       # Compose the metadata attributes:
-      metadata, text = extract_attributes item.text
+      metadata = extract_attributes item.text
       metadata = compose_metadata item.role if item.role
 
       # Check if the list item contains multiple block elements:
       if item.blocks?
-        result << %(<li#{compose_id item.id}#{metadata}>#{text})
+        result << %(<li#{compose_id item.id}#{metadata}>#{item.text})
         result << item.content
         result << %(</li>)
       else
-        result << %(<li#{compose_id item.id}#{metadata}>#{text}</li>)
+        result << %(<li#{compose_id item.id}#{metadata}>#{item.text}</li>)
       end
     end
 
@@ -709,7 +709,7 @@ class DitaTopic < Asciidoctor::Converter::Base
       # Process each row:
       rows.each do |row|
         # Compose the metadata attributes:
-        metadata, row[0].text = extract_attributes row[0].text
+        metadata = extract_attributes row[0].text
 
         # Open the row:
         result << %(<row#{metadata}>)
@@ -777,7 +777,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Process individual list items:
     node.items.each do |item|
       # Compose the metadata attributes:
-      metadata, text = extract_attributes item.text
+      metadata = extract_attributes item.text
       metadata = compose_metadata item.role if item.role
 
       # Check if the list item is part of a checklist:
@@ -789,11 +789,11 @@ class DitaTopic < Asciidoctor::Converter::Base
 
       # Check if the list item contains multiple block elements:
       if item.blocks?
-        result << %(<li#{compose_id item.id}#{metadata}>#{check_box}#{text})
+        result << %(<li#{compose_id item.id}#{metadata}>#{check_box}#{item.text})
         result << item.content
         result << %(</li>)
       else
-        result << %(<li#{compose_id item.id}#{metadata}>#{check_box}#{text}</li>)
+        result << %(<li#{compose_id item.id}#{metadata}>#{check_box}#{item.text}</li>)
       end
     end
 
@@ -864,7 +864,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Process individual list items:
     node.items.each do |terms, description|
       # Compose the metadata attributes:
-      metadata, terms[0].text = extract_attributes terms[0].text
+      metadata = extract_attributes terms[0].text
 
       # Open the list item:
       result << %(<li#{metadata}>)
@@ -907,7 +907,7 @@ class DitaTopic < Asciidoctor::Converter::Base
     # Process individual list items:
     node.items.each do |terms, description|
       # Compose the metadata attributes:
-      metadata, terms[0].text = extract_attributes terms[0].text
+      metadata = extract_attributes terms[0].text
 
       # Open the table row:
       result << %(<row#{metadata}>)
@@ -1076,9 +1076,9 @@ class DitaTopic < Asciidoctor::Converter::Base
   def extract_attributes text
     # Extract metadata attributes from an empty ph element:
     if /^\s*<ph(?<attributes> [^>]+)><\/ph>\s*/ =~ text
-      return attributes, text.sub(/^\s*<ph[^>]+><\/ph>\s*/, '')
+      return attributes
     else
-      return '', text
+      return ''
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-topic
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.4
 platform: ruby
 authors:
 - Jaromir Hradilek