asciidoctor-dita-map 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11f4d701aaa5c98c2ed6d3f78393c695e60cf981b2332e65f7b6c86288cfa5aa
-  data.tar.gz: 2db0005558356a8578d9f0bf89c08140bd74becc1372eed2aa85fc78ae406438
+  metadata.gz: b3ca734004441a43e80c5537935c0bbbf2ff555b9ff00810a6f80f5f461003ad
+  data.tar.gz: f1f533b51dac4e4ebbcbf8632562c3caddb1a70bf5d1c7bbc1da73739ae97d07
 SHA512:
-  metadata.gz: f5684c9fe2027bf5b99b080feb850a0840598a55f0f8fd0dcef5281a18cbf8a895aaab00a906e94eeecdb0befa7fd600ab68f867b7edf2906128ced51078e6df
-  data.tar.gz: 38d6f1d08c260b6438535a47dc81d48e151a2997e46fc4b79b93a799a8d600b9dcb45550e702c1bf2f38cc5b2670ec8b39a2ba7a1b3fecf3f1bca5c53de25241
+  metadata.gz: 0bfff3d85f8c89f127af916d7d0c8c3c577e1cb2d53be274bc8c2d252af73f9dd157d231acc2385948bead240f19fb296fafe03eb6fadf2c670f18cfe9ba156f
+  data.tar.gz: 9058a374b8c72b5edf4397208ee3167a63154fc956b4206ef00b86739c91d52151e6223de1791e3e901289be59ac856eac12306dd8fe478018d3c36011127546

data/lib/dita-map/catalog.rb

@@ -30,11 +30,15 @@ class CatalogIncludeDirectives < Asciidoctor::Extensions::IncludeProcessor
 
   def process doc, reader, target, attributes
     offset = attributes['leveloffset'].to_i
+    chunk  = attributes['chunk'] or nil
+    toc    = attributes['toc'] or nil
 
     doc.catalog[:include_files] = [] unless doc.catalog[:include_files]
     doc.catalog[:include_files].append({
       :target => target,
-      :offset => offset
+      :offset => offset,
+      :chunk  => chunk,
+      :toc    => toc
     })
 
     reader

data/lib/dita-map/cli.rb

@@ -33,11 +33,14 @@ module AsciidoctorDitaMap
     def initialize name, argv
       @attr = []
       @opts = {
+        :chunk => true,
         :id => true,
         :navtitle => true,
         :output => false,
         :title => true,
+        :toc => true,
         :type => true,
+        :self => false,
         :verbose => false
       }
       @prep = []
@@ -67,6 +70,10 @@ module AsciidoctorDitaMap
           @prep.append file
         end
 
+        opt.on('-i', '--include-self', 'make the supplied file the toplevel topicref') do
+          @opts[:self] = true
+        end
+
         opt.separator ''
 
         opt.on('-I', '--no-id', 'do not generate the map id attribute') do
@@ -77,10 +84,18 @@ module AsciidoctorDitaMap
           @opts[:title] = false
         end
 
+        opt.on('-C', '--no-chunk', 'do not generate the chunk attribute') do
+          @opts[:chunk] = false
+        end
+
         opt.on('-N', '--no-navtitle', 'do not generate the navtitle attribute') do
           @opts[:navtitle] = false
         end
 
+        opt.on('-O', '--no-toc', 'do not generate the toc attribute') do
+          @opts[:toc] = false
+        end
+
         opt.on('-T', '--no-type', 'do not generate the type attribute') do
           @opts[:type] = false
         end
@@ -118,14 +133,31 @@ module AsciidoctorDitaMap
       return args
     end
 
-    def parse_topic input
-      doc = Asciidoctor.load input, safe: :secure, attributes: @attr
-      att = doc.attributes
+    def compose_mapref_attributes file_info, type
+      target_file         = file_info[:target].sub(/\.adoc$/, '.ditamap')
+      attributes          = { 'href' => target_file, 'format' => 'ditamap' }
+      attributes['type']  = type if @opts[:type]
+      attributes['chunk'] = file_info[:chunk] if @opts[:chunk] and file_info[:chunk]
+      attributes['toc']   = file_info[:toc] if @opts[:toc] and file_info[:toc]
 
-      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
+      return attributes
+    end
+
+    def compose_topicref_attributes file_info, title, type
+      target_file            = file_info[:target].sub(/\.adoc$/, '.dita')
+      attributes             = { 'href' => target_file }
+      attributes['navtitle'] = title if @opts[:navtitle] and title
+      attributes['type']     = type if @opts[:type] and type and ['concept', 'reference', 'task'].include? type
+      attributes['chunk']    = file_info[:chunk] if @opts[:chunk] and file_info[:chunk]
+      attributes['toc']      = file_info[:toc] if @opts[:toc] and file_info[:toc]
+
+      return attributes
+    end
+
+    def get_content_type attributes
+      document_type  = attributes['_mod-docs-content-type'] ? attributes['_mod-docs-content-type'].downcase : nil
+      document_type  = attributes['_content-type'] ? attributes['_content-type'].downcase : nil unless document_type
+      document_type  = attributes['_module-type'] ? attributes['_module-type'].downcase : nil unless document_type
 
       if document_type
         document_type.sub!(/^assembly$/, 'concept')
@@ -133,9 +165,18 @@ module AsciidoctorDitaMap
       end
 
       unless ['concept', 'reference', 'task', 'map', 'attributes', 'snippet'].include? document_type
-        document_type = nil
+        return nil
       end
 
+      return document_type
+    end
+
+    def parse_topic input
+      doc = Asciidoctor.load input, safe: :secure, attributes: @attr
+
+      document_title = doc.title ? doc.title.gsub(/<[^>]*>/, '') : nil
+      document_type  = get_content_type doc.attributes
+
       return document_title, document_type
     end
 
@@ -147,38 +188,51 @@ module AsciidoctorDitaMap
       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
+      map_id    = doc.id ? doc.id.gsub(/["']/, '') : nil
+      map_title = doc.title ? doc.title.gsub(/<[^>]*>/, '') : nil
+      map_type  = get_content_type doc.attributes
+
+      info = {
+        :id    => map_id,
+        :title => map_title,
+        :type  => map_type
+      }
 
-      return include_files, document_title, document_id
+      return include_files, info
     end
 
-    def convert_map input, base_dir, prepended = ''
+    def convert_map input, base_dir, prepended = '', file = nil
       result = ''
 
-      include_files, map_title, document_id = parse_map prepended + input, base_dir
+      include_files, map = 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 })
+      if map[:id] and @opts[:id]
+        xml_root  = xml.add_element('map', { 'id' => map[: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
+      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 }]
+      if @opts[:self] and file
+        attributes = compose_topicref_attributes({ :target => file }, map[:title], map[:type])
+        xml_self   = xml_root.add_element('topicref', attributes)
+        stack      = [{ :offset => 0, :element => xml_self }]
+      else
+        stack      = [{ :offset => 0, :element => xml_root }]
+      end
 
-      include_files.each do |file|
-        target      = file[:target]
-        offset      = file[:offset]
+      include_files.each do |file_info|
+        target      = file_info[:target]
+        offset      = file_info[:offset]
         last_offset = stack.last[:offset]
         full_path   = base_dir + target
 
@@ -209,17 +263,10 @@ module AsciidoctorDitaMap
         xml_parent = stack.last[:element]
 
         if include_type == 'map'
-          file_name          = target.sub(/\.adoc$/, '.ditamap')
-          attributes         = { 'href' => file_name, 'format' => 'ditamap' }
-          attributes['type'] = include_type if @opts[:type]
-
+          attributes  = compose_mapref_attributes file_info, include_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]
-
+          attributes  = compose_topicref_attributes file_info, include_title, include_type
           xml_element = xml_parent.add_element('topicref', attributes)
         end
 
@@ -254,7 +301,11 @@ module AsciidoctorDitaMap
           output   = @opts[:output] ? @opts[:output] : Pathname.new(file).sub_ext('.ditamap').to_s
         end
 
-        result = convert_map input, base_dir, prepended
+        if @opts[:self] and file != $stdin
+          result = convert_map input, base_dir, prepended, file
+        else
+          result = convert_map input, base_dir, prepended
+        end
 
         if output == $stdout
           $stdout.write result

data/lib/dita-map/version.rb

@@ -24,5 +24,5 @@
 # frozen_string_literal: true
 
 module AsciidoctorDitaMap
-  VERSION     = '0.9.0'
+  VERSION     = '0.9.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-dita-map
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Jaromir Hradilek
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Convert an AsciiDoc file to a DITA map
 test_files: []