metanorma-standoc 1.10.2 → 1.10.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca8e0e987187b1a9c3e36246671b4c8566746c6178034c55e0cba34164f64bbf
-  data.tar.gz: af58564b53587bff140ecec89f1ca9d2e051859befbcbabd9842ed3e84fda039
+  metadata.gz: 4de5b7f8779dae7c359b93ce364ffa7cc406156bf1437c7cdccb6595b7bd958a
+  data.tar.gz: c35902148b405e451af8487faff391b6eddbbd7b07cd2b6c8d565cd515e4515c
 SHA512:
-  metadata.gz: e711720551cfcfe47d425fcd3172c5bc07eb727dc9f08e2f9fe02cfa4edd1f9bffe5587b9a4215f470951149cc36a970ca669e217226a52fa812c07fb70ee1c5
-  data.tar.gz: acef9c690a20986928c0c26508787ba362022ee9970f35d9e9c4fe47c55aebf3a0dafac1e3d2c684bbecf602d0a750583948921bd65e04e791d462f20707448c
+  metadata.gz: 6e33b33321d6826a65257a3440c63218021d5d40b69fa58b268d0a2c5e8436aed951e05c7f44ab97c74b5ce916c25ad7040cc962cf38be15ee2ebaf0c6858529
+  data.tar.gz: f8f719f8062c3c71ebd2883617b984d7432134cb94da1be308e9ede34bf74def5be6267570c76ff9f248e628e443d6b71a60b9f71e1ba436b7c64eb2c2b25c13

data/lib/asciidoctor/standoc/base.rb

@@ -62,6 +62,12 @@ module Asciidoctor
         IsoDoc::HtmlConvert.new(html_extract_attributes(node))
       end
 
+      def pdf_converter(node)
+        return nil if node.attr("no-pdf")
+
+        IsoDoc::Standoc::PdfConvert.new(doc_extract_attributes(node))
+      end
+
       def doc_extract_attributes(node)
         attrs = {
           script: node.attr("script"),
@@ -114,11 +120,11 @@ module Asciidoctor
           node.attr("mn-keep-asciimath") != "false"
         @fontheader = default_fonts(node)
         @files_to_delete = []
-        if node.attr("docfile")
-          @filename = File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
-        else
-          @filename = ""
-        end
+        @filename = if node.attr("docfile")
+                      File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
+                    else
+                      ""
+                    end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
@@ -156,6 +162,8 @@ module Asciidoctor
                                      nil, false, "#{@filename}.html")
         doc_converter(node).convert("#{@filename}.presentation.xml",
                                     nil, false, "#{@filename}.doc")
+        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
+                                     nil, false, "#{@filename}.pdf")
       end
 
       def document(node)

data/lib/asciidoctor/standoc/blocks.rb

@@ -10,15 +10,17 @@ module Asciidoctor
       end
 
       def id_unnum_attrs(node)
-        attr_code( id: Metanorma::Utils::anchor_or_uuid(node),
+        attr_code(id: Metanorma::Utils::anchor_or_uuid(node),
                   unnumbered: node.option?("unnumbered") ? "true" : nil,
                   number: node.attr("number"),
-                  subsequence: node.attr("subsequence") )
+                  subsequence: node.attr("subsequence"))
       end
 
       def formula_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node).merge(
-          inequality: node.option?("inequality") ? "true" : nil)))
+        attr_code(id_unnum_attrs(node)
+          .merge(keep_attrs(node).merge(
+                   inequality: node.option?("inequality") ? "true" : nil,
+                 )))
       end
 
       def keep_attrs(node)
@@ -58,8 +60,8 @@ module Asciidoctor
           xml.figure **literal_attrs(node) do |f|
             figure_title(node, f)
             f.pre node.lines.join("\n"),
-              **attr_code(id: Metanorma::Utils::anchor_or_uuid,
-                          alt: node.attr("alt"))
+                  **attr_code(id: Metanorma::Utils::anchor_or_uuid,
+                              alt: node.attr("alt"))
           end
         end
       end
@@ -95,20 +97,21 @@ module Asciidoctor
       end
 
       def svgmap_attrs(node)
-        attr_code( { id: node.id,
-                     unnumbered: node.option?("unnumbered") ? "true" : nil,
-                     number: node.attr("number"),
-                     subsequence: node.attr("subsequence") }.
-        merge(keep_attrs(node)))
+        attr_code({ id: node.id,
+                    unnumbered: node.option?("unnumbered") ? "true" : nil,
+                    number: node.attr("number"),
+                    subsequence: node.attr("subsequence") }
+        .merge(keep_attrs(node)))
       end
 
       def svgmap_example(node)
         noko do |xml|
           xml.svgmap **attr_code(svgmap_attrs(node).merge(
-            src: node.attr("src"), alt: node.attr("alt"))) do |ex|
-              figure_title(node, ex)
-              ex << node.content
-            end
+                                   src: node.attr("src"), alt: node.attr("alt"),
+                                 )) do |ex|
+            figure_title(node, ex)
+            ex << node.content
+          end
         end.join("\n")
       end
 
@@ -136,9 +139,10 @@ module Asciidoctor
         end.join("\n")
       end
 
-      def figure_title(node, f)
+      def figure_title(node, out)
         return if node.title.nil?
-        f.name { |name| name << node.title }
+
+        out.name { |name| name << node.title }
       end
 
       def figure_attrs(node)
@@ -149,15 +153,15 @@ module Asciidoctor
         noko do |xml|
           xml.figure **figure_attrs(node) do |f|
             figure_title(node, f)
-            f.image **(image_attributes(node))
+            f.image **image_attributes(node)
           end
         end
       end
 
       def para_attrs(node)
         attr_code(keep_attrs(node)
-          .merge(align: node.attr("align"), 
-        id: Metanorma::Utils::anchor_or_uuid(node)))
+          .merge(align: node.attr("align"),
+                 id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
@@ -172,8 +176,8 @@ module Asciidoctor
 
       def quote_attrs(node)
         attr_code(keep_attrs(node)
-          .merge(align: node.attr("align"), 
-        id: Metanorma::Utils::anchor_or_uuid(node)))
+          .merge(align: node.attr("align"),
+                 id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)
@@ -189,7 +193,7 @@ module Asciidoctor
 
       def quote(node)
         noko do |xml|
-          xml.quote **(quote_attrs(node)) do |q|
+          xml.quote **quote_attrs(node) do |q|
             quote_attribution(node, q)
             wrap_in_para(node, q)
           end
@@ -197,18 +201,18 @@ module Asciidoctor
       end
 
       def listing_attrs(node)
-        attr_code(keep_attrs(node).
-                  merge(lang: node.attr("language"),
-                        id: Metanorma::Utils::anchor_or_uuid(node),
-                        unnumbered: node.option?("unnumbered") ? "true" : nil,
-                        number: node.attr("number"),
-                        filename: node.attr("filename")))
+        attr_code(keep_attrs(node)
+                  .merge(lang: node.attr("language"),
+                         id: Metanorma::Utils::anchor_or_uuid(node),
+                         unnumbered: node.option?("unnumbered") ? "true" : nil,
+                         number: node.attr("number"),
+                         filename: node.attr("filename")))
       end
 
       # NOTE: html escaping is performed by Nokogiri
       def listing(node)
         fragment = ::Nokogiri::XML::Builder.new do |xml|
-          xml.sourcecode **(listing_attrs(node)) do |s|
+          xml.sourcecode **listing_attrs(node) do |s|
             figure_title(node, s)
             s << node.content
           end
@@ -219,7 +223,7 @@ module Asciidoctor
 
       def pass(node)
         noko do |xml|
-          xml.passthrough **attr_code(formats: 
+          xml.passthrough **attr_code(formats:
                                       node.attr("format") || "metanorma") do |p|
             p << HTMLEntities.new.encode(node.content, :basic, :hexadecimal)
           end

data/lib/asciidoctor/standoc/cleanup.rb

@@ -62,6 +62,7 @@ module Asciidoctor
         bibdata_cleanup(xmldoc)
         svgmap_cleanup(xmldoc)
         boilerplate_cleanup(xmldoc)
+        toc_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
         variant_cleanup(xmldoc)
         para_cleanup(xmldoc)
@@ -84,6 +85,30 @@ module Asciidoctor
       end
 
       def smartquotes_cleanup1(xmldoc)
+        uninterrupt_quotes_around_xml(xmldoc)
+        dumb2smart_quotes(xmldoc)
+      end
+
+      # "abc<tag/>", def => "abc",<tag/> def
+      def uninterrupt_quotes_around_xml(xmldoc)
+        xmldoc.xpath("//*[following::text()[1]"\
+                     "[starts-with(., '\"') or starts-with(., \"'\")]]")
+          .each do |x|
+          next if !x.ancestors("pre, tt, sourcecode, stem, figure").empty?
+          uninterrupt_quotes_around_xml1(x)
+        end
+      end
+
+      def uninterrupt_quotes_around_xml1(elem)
+        prev = elem.at(".//preceding::text()[1]") or return
+        /\S$/.match?(prev.text) or return
+        foll = elem.at(".//following::text()[1]")
+        m = /^(["'][[:punct:]]*)(\s|$)/.match(HTMLEntities.new.decode(foll&.text)) or return
+        foll.content = foll.text.sub(/^(["'][[:punct:]]*)/, "")
+        prev.content = "#{prev.text}#{m[1]}"
+      end
+
+      def dumb2smart_quotes(xmldoc)
         (xmldoc.xpath("//*[child::text()]") - xmldoc.xpath(IGNORE_DUMBQUOTES))
           .each do |x|
           x.children.each do |n|
@@ -166,6 +191,42 @@ module Asciidoctor
           end
         end
       end
+
+      def toc_cleanup(xmldoc)
+        xmldoc.xpath("//p[toc]").each do |x|
+          x.xpath("./toc").reverse.each do |t|
+            x.next = t
+          end
+          x.remove if x.text.strip.empty?
+        end
+        xmldoc.xpath("//toc").each { |t| toc_cleanup1(t, xmldoc) }
+      end
+
+      def toc_index(toc, xmldoc)
+        depths = toc.xpath("./toc-xpath").each_with_object({}) do |x, m|
+          m[x.text] = x["depth"]
+        end
+        depths.keys.each_with_object([]) do |key, arr|
+          xmldoc.xpath(key).each do |x|
+            arr << { text: x.children.to_xml, depth: depths[key].to_i,
+                     target: x.xpath("(./ancestor-or-self::*/@id)[last()]")[0].text,
+                     line: x.line }
+          end
+        end.sort_by { |a| a[:line] }
+      end
+
+      def toc_cleanup1(toc, xmldoc)
+        depth = 1
+        ret = ""
+        toc_index(toc, xmldoc).each do |x|
+          if depth > x[:depth] then ret += "</ul></li>" * (depth - x[:depth])
+          elsif depth < x[:depth] then ret += "<li><ul>" * (x[:depth] - depth)
+          end
+          ret += "<li><xref target='#{x[:target]}'>#{x[:text]}</xref></li>"
+          depth = x[:depth]
+        end
+        toc.children = "<ul>#{ret}</ul>"
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -7,8 +7,11 @@ module Asciidoctor
       def para_cleanup(xmldoc)
         ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
          "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
-         "//note[not(ancestor::bibitem or ancestor::table or ancestor::bibdata)]"
-        ].each { |w| inject_id(xmldoc, w) }
+         "//note[not(ancestor::bibitem or ancestor::table or ancestor::bibdata)]"].each do |w|
+          inject_id(
+            xmldoc, w
+          )
+        end
       end
 
       def inject_id(xmldoc, path)
@@ -205,7 +208,7 @@ module Asciidoctor
       def safe_noko(text, doc)
         Nokogiri::XML::Text.new(text, doc).to_xml(
           encoding: "US-ASCII",
-          save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+          save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION,
         )
       end
 

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -1,40 +1,41 @@
 module Asciidoctor
   module Standoc
     module Cleanup
-      def requirement_cleanup(reqt)
-        requirement_descriptions(reqt)
-        requirement_inherit(reqt)
+      def requirement_cleanup(xmldoc)
+        requirement_metadata(xmldoc)
+        requirement_descriptions(xmldoc)
+        requirement_inherit(xmldoc)
       end
 
-      def requirement_inherit(reqt)
-        reqt.xpath("//requirement | //recommendation | //permission")
-          .each do |r|
+      REQRECPER = "//requirement | //recommendation | //permission".freeze
+
+      def requirement_inherit(xmldoc)
+        xmldoc.xpath(REQRECPER).each do |r|
           ins = r.at("./classification") ||
             r.at("./description | ./measurementtarget | ./specification | "\
                  "./verification | ./import | ./description | ./requirement | "\
-                 "./recommendation | ./permission")
+                 "./recommendation | ./permission | ./component")
           r.xpath("./*//inherit").each { |i| ins.previous = i }
         end
       end
 
-      def requirement_descriptions(reqt)
-        reqt.xpath("//requirement | //recommendation | //permission")
-          .each do |r|
+      def requirement_descriptions(xmldoc)
+        xmldoc.xpath(REQRECPER).each do |r|
           r.children.each do |e|
             unless e.element? && (reqt_subpart(e.name) ||
                 %w(requirement recommendation permission).include?(e.name))
-              t = Nokogiri::XML::Element.new("description", reqt)
+              t = Nokogiri::XML::Element.new("description", r)
               e.before(t)
               t.children = e.remove
             end
           end
-          requirement_cleanup1(r)
+          requirement_description_cleanup1(r)
         end
       end
 
-      def requirement_cleanup1(reqt)
+      def requirement_description_cleanup1(reqt)
         while d = reqt.at("./description[following-sibling::*[1]"\
-            "[self::description]]")
+                          "[self::description]]")
           n = d.next.remove
           d << n.children
         end
@@ -42,6 +43,50 @@ module Asciidoctor
           r.replace("\n")
         end
       end
+
+      def requirement_metadata(xmldoc)
+        xmldoc.xpath(REQRECPER).each do |r|
+          dl = r&.at("./dl[@metadata = 'true']")&.remove or next
+          requirement_metadata1(r, dl)
+        end
+      end
+
+      def requirement_metadata1(reqt, dlist)
+        unless ins = reqt.at("./title")
+          reqt.children.first.previous = " "
+          ins = reqt.children.first
+        end
+        %w(label subject inherit).each do |a|
+          ins = reqt_dl_to_elems(ins, reqt, dlist, a)
+        end
+        reqt_dl_to_classif(ins, reqt, dlist)
+      end
+
+      def reqt_dl_to_elems(ins, reqt, dlist, name)
+        if a = reqt.at("./#{name}[last()]")
+          ins = a
+        end
+        dlist.xpath("./dt[text()='#{name}']").each do |e|
+          val = e.at("./following::dd/p") || e.at("./following::dd")
+          val.name = name
+          ins.next = val
+          ins = ins.next
+        end
+        ins
+      end
+
+      def reqt_dl_to_classif(ins, reqt, dlist)
+        if a = reqt.at("./classification[last()]")
+          ins = a
+        end
+        dlist.xpath("./dt[text()='classification']").each do |e|
+          val = e.at("./following::dd/p") || e.at("./following::dd")
+          req_classif_parse(val.text).each do |r|
+            ins.next = "<classification><tag>#{r[0]}</tag>"\
+                       "<value>#{r[1]}</value></classification>"
+          end
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/converter.rb

@@ -27,6 +27,7 @@ module Asciidoctor
         preprocessor Metanorma::Plugin::Datastruct::Yaml2TextPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
+        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
         inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
@@ -47,6 +48,9 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::FormTextareaMacro
         inline_macro Asciidoctor::Standoc::FormSelectMacro
         inline_macro Asciidoctor::Standoc::FormOptionMacro
+        inline_macro Asciidoctor::Standoc::ToCInlineMacro
+        inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
+        block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro

data/lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'erb'
-require 'asciidoctor/standoc/datamodel/plantuml_renderer'
+require "erb"
+require "asciidoctor/standoc/datamodel/plantuml_renderer"
 
 module Asciidoctor
   module Standoc
     module Datamodel
       class DiagramPreprocessor < Asciidoctor::Extensions::Preprocessor
-        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/
-        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/
-        MARCO_REGEXP = /\[datamodel_diagram,([^,]+),?(.+)?\]/
-        TEMPLATES_PATH = File.expand_path('../views/datamodel', __dir__).freeze
+        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/.freeze
+        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
+        MARCO_REGEXP = /\[datamodel_diagram,([^,]+),?(.+)?\]/.freeze
+        TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
         # search document for block `datamodel_diagram`
         #  read include derectives that goes after that in block and transform
         #  into plantuml block
@@ -33,7 +33,7 @@ module Asciidoctor
         end
 
         def parse_datamodel_marco(yaml_path, include_path, document)
-          include_path ||= File.join(File.dirname(yaml_path), '..', 'models')
+          include_path ||= File.join(File.dirname(yaml_path), "..", "models")
           include_path = yaml_relative_path(include_path, document)
           yaml_relative_to_doc_path = yaml_relative_path(yaml_path, document)
           view_hash = YAML.safe_load(File.read(yaml_relative_to_doc_path))
@@ -43,7 +43,7 @@ module Asciidoctor
         end
 
         def yaml_relative_path(file_path, document)
-          docfile = document.attributes['docfile'] || '.'
+          docfile = document.attributes["docfile"] || "."
           docfile_directory = File.dirname(docfile)
           document.path_resolver.system_path(file_path, docfile_directory)
         end
@@ -51,11 +51,11 @@ module Asciidoctor
         def import_format(include_path, import_name, values)
           include_content = File.read(File.join(
                                         include_path,
-                                        "#{import_name}.yml"
-          ))
+                                        "#{import_name}.yml",
+                                      ))
           content = YAML.safe_load(include_content)
           if values
-            content['skipSection'] = values['skipSection']
+            content["skipSection"] = values["skipSection"]
           end
           content
         end
@@ -63,36 +63,37 @@ module Asciidoctor
         def format_import_directives(imports, include_path)
           imports
             .each_with_object({}) do |(import_name, values), res|
-              full_model_name = import_name.split('/').join
+              full_model_name = import_name.split("/").join
               content = import_format(include_path, import_name, values)
-              res[content['name'] || full_model_name] = content
+              res[content["name"] || full_model_name] = content
             end.compact
         end
 
         def prepare_view_hash(view_hash, all_imports)
           view_hash.merge!(
-            'classes' => model_type(all_imports, 'class'),
-            'enums' => model_type(all_imports, 'enum'),
-            'relations' => view_hash['relations'] || [],
-            'fidelity' => (view_hash['fidelity'] || {})
-                          .merge!('classes' => model_type(all_imports, 'class'))
+            "classes" => model_type(all_imports, "class"),
+            "enums" => model_type(all_imports, "enum"),
+            "relations" => view_hash["relations"] || [],
+            "fidelity" => (view_hash["fidelity"] || {})
+                          .merge!("classes" => model_type(all_imports,
+                                                          "class")),
           )
         end
 
         def model_type(imports, type)
           imports
             .select do |_name, elem|
-              elem['modelType'] == type
+              elem["modelType"] == type
             end
         end
 
         def plantuml_representations(view_hash, view_path, include_path)
           yaml_directory = File.dirname(view_path)
-          all_imports = format_import_directives(view_hash['imports'],
+          all_imports = format_import_directives(view_hash["imports"],
                                                  include_path)
           prepare_view_hash(view_hash, all_imports)
           Asciidoctor::Datamodel::PlantumlRenderer
-            .new(view_hash, File.join(yaml_directory, '..'))
+            .new(view_hash, File.join(yaml_directory, ".."))
             .render
             .split("\n")
         end