metanorma-standoc 1.5.3 → 1.6.4

data/lib/asciidoctor/standoc/converter.rb

@@ -1,4 +1,7 @@
 require "asciidoctor"
+require "fontist"
+require "fontist/manifest/install"
+require "metanorma/util"
 require "metanorma/standoc/version"
 require "asciidoctor/standoc/base"
 require "asciidoctor/standoc/front"
@@ -23,8 +26,10 @@ module Asciidoctor
       Asciidoctor::Extensions.register do
         preprocessor Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor
         preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
-        preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
-        preprocessor Asciidoctor::Standoc::Json2TextPreprocessor
+        preprocessor Metanorma::Plugin::Datastruct::Json2TextPreprocessor
+        preprocessor Metanorma::Plugin::Datastruct::Yaml2TextPreprocessor
+        preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
+        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
         inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
@@ -32,9 +37,12 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::HTML5RubyMacro
         inline_macro Asciidoctor::Standoc::ConceptInlineMacro
         inline_macro Asciidoctor::Standoc::AutonumberInlineMacro
+        inline_macro Asciidoctor::Standoc::VariantInlineMacro
+        inline_macro Asciidoctor::Standoc::FootnoteBlockInlineMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro
+        block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
         block Asciidoctor::Standoc::PseudocodeBlockMacro
       end
 
@@ -61,6 +69,8 @@ module Asciidoctor
         basebackend "html"
         outfilesuffix ".xml"
         @libdir = File.dirname(self.class::_file || __FILE__)
+
+        install_fonts(opts)
       end
 
       class << self
@@ -73,7 +83,52 @@ module Asciidoctor
 
       # path to isodoc assets in child gems
       def html_doc_path(file)
-        File.join(@libdir, File.join("../../isodoc/html", file))
+        File.join(@libdir, "../../isodoc/html", file)
+      end
+
+      def flavor_name
+        self.class.name.split("::")&.[](-2).downcase
+      end
+
+      def fonts_manifest
+        File.expand_path(File.join(@libdir, "../../metanorma/", flavor_name, "fonts_manifest.yaml"))
+      end
+
+      def install_fonts(options={})
+        if options[:no_install_fonts]
+          Metanorma::Util.log("[fontist] Skip font installation because" \
+            " --no-install-fonts argument passed", :debug)
+          return
+        end
+
+        if fonts_manifest.nil? || !File.exist?(fonts_manifest)
+          Metanorma::Util.log("[fontist] Skip font installation because" \
+            " font manifest file doesn't exists/defined", :debug)
+          return
+        end
+
+        begin
+          Fontist::Manifest::Install.call(
+            fonts_manifest,
+            confirmation: options[:agree_to_terms] ? "yes" : "no"
+          )
+        rescue Fontist::Errors::LicensingError
+          if !options[:agree_to_terms]
+            Metanorma::Util.log("[fontist] --agree-to-terms option missing." \
+              " You must accept font licenses to install fonts.", :debug)
+          elsif options[:continue_without_fonts]
+            Metanorma::Util.log("[fontist] Processing will continue without" \
+              " fonts installed", :debug)
+          else
+            Metanorma::Util.log("[fontist] Aborting without proper fonts" \
+              " installed", :fatal)
+          end
+        rescue Fontist::Errors::NonSupportedFontError
+          flavor = flavor_name || "cli"
+          Metanorma::Util.log("[fontist] '#{font}' font is not supported. " \
+            "Please go to github.com/metanorma/metanorma-#{flavor}/issues" \
+            " to report this issue.", :info)
+        end
       end
 
       alias_method :embedded, :content

data/lib/asciidoctor/standoc/front.rb

@@ -17,6 +17,11 @@ module Asciidoctor
         xml.docnumber node.attr("docnumber")
       end
 
+      def metadata_other_id(node, xml)
+        a = node.attr("isbn") and xml.docidentifier a, type: "ISBN"
+        a = node.attr("isbn10") and xml.docidentifier a, type: "ISBN10"
+      end
+
       def metadata_version(node, xml)
         xml.edition node.attr("edition") if node.attr("edition")
         xml.version do |v|
@@ -27,7 +32,7 @@ module Asciidoctor
 
       def metadata_status(node, xml)
         xml.status do |s|
-          s.stage ( node.attr("status") || node.attr("docstage") || "published" )
+          s.stage (node.attr("status") || node.attr("docstage") || "published")
           node.attr("docsubstage") and s.substage node.attr("docsubstage")
           node.attr("iteration") and s.iteration node.attr("iteration")
         end
@@ -138,6 +143,7 @@ module Asciidoctor
         title node, xml
         metadata_source(node, xml)
         metadata_id(node, xml)
+        metadata_other_id(node, xml)
         metadata_date(node, xml)
         metadata_author(node, xml)
         metadata_publisher(node, xml)
@@ -180,8 +186,8 @@ module Asciidoctor
         ["en"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at) do |t|
-            t << (Utils::asciidoc_sub(node.attr("title") || node.attr("title-en")) ||
-                  node.title)
+            t << (Utils::asciidoc_sub(node.attr("title") ||
+                                      node.attr("title-en")) || node.title)
           end
         end
       end

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -21,22 +21,45 @@ module Asciidoctor
         end
       end
 
-      def organization(org, orgname)
+      def organization(org, orgname, node = nil, default_org = nil)
+        abbrevs = org_abbrev
+        n = abbrevs.invert[orgname] and orgname = n
         org.name orgname
+        default_org and a = node.attr("subdivision") and org.subdivision a
+        abbr = org_abbrev[orgname]
+        default_org && b = node.attr("subdivision-abbr") and abbr = b
+        abbr and org.abbreviation abbr
+        default_org and org_address(node, org)
+      end
+
+      def org_address(node, p)
+        node.attr("pub-address") and p.address do |ad|
+          ad.formattedAddress do |f|
+            f << node.attr("pub-address").gsub(/ \+\n/, "<br/>")
+          end
+        end
+        node.attr("pub-phone") and p.phone node.attr("pub-phone")
+        node.attr("pub-fax") and p.phone node.attr("pub-fax"), **{type: "fax"}
+        node.attr("pub-email") and p.email node.attr("pub-email")
+        node.attr("pub-uri") and p.uri node.attr("pub-uri")
       end
 
       # , " => ," : CSV definition does not deal with space followed by quote
       # at start of field
       def csv_split(s, delim = ",")
-        CSV.parse_line(s&.gsub(/, "(?!")/, ',"'), liberal_parsing: true,
-                       col_sep: delim)&.map { |x| x.strip }
+        CSV.parse_line(s&.gsub(/, "(?!")/, ',"'),
+                       liberal_parsing: true,
+                       col_sep: delim)&.compact&.map { |x| x.strip }
       end
 
       def metadata_author(node, xml)
-        csv_split(node.attr("publisher") || default_publisher || "")&.each do |p|
+        csv_split(node.attr("publisher") || default_publisher || "")&.
+          each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
-            c.organization { |a| organization(a, p) }
+            c.organization do |a|
+              organization(a, p, node, !node.attr("publisher"))  
+            end
           end
         end
         personal_author(node, xml)
@@ -95,7 +118,9 @@ module Asciidoctor
             abbr = node.attr("affiliation_abbrev#{suffix}") and
               o.abbreviation abbr
             node.attr("address#{suffix}") and o.address do |ad|
-              ad.formattedAddress node.attr("address#{suffix}")
+              ad.formattedAddress do |f|
+                f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
+              end
             end
           end
         end
@@ -105,24 +130,31 @@ module Asciidoctor
         nil
       end
 
+      def org_abbrev
+        { }
+      end
+
       def metadata_publisher(node, xml)
         publishers = node.attr("publisher") || default_publisher || return
         csv_split(publishers)&.each do |p|
           xml.contributor do |c|
             c.role **{ type: "publisher" }
-            c.organization { |a| organization(a, p) }
+            c.organization do |a|
+              organization(a, p, node, !node.attr("publisher"))
+            end
           end
         end
       end
 
       def metadata_copyright(node, xml)
-        publishers = node.attr("copyright-holder") || node.attr("publisher") || 
-          default_publisher || "-"
-        csv_split(publishers)&.each do |p|
+        pub = node.attr("copyright-holder") || node.attr("publisher")
+        csv_split(pub || default_publisher || "-")&.each do |p|
           xml.copyright do |c|
             c.from (node.attr("copyright-year") || Date.today.year)
             p.match(/[A-Za-z]/).nil? or c.owner do |owner|
-              owner.organization { |o| organization(o, p) }
+              owner.organization do |a|
+                organization(a, p, node, !pub)
+              end
             end
           end
         end

data/lib/asciidoctor/standoc/inline.rb

@@ -33,18 +33,28 @@ module Asciidoctor
       end
 
       def inline_anchor_xref(node)
-        m = /^(?<case>capital%|lowercase%)?(?<fn>fn(:\s*(?<text>.*))?)?$/.match node.text
-        casing = m.nil? ? nil : m[:case]&.sub(/%$/, "")
-        f = (m.nil? || m[:fn].nil?) ? "inline" : "footnote"
-        c = (!m.nil? && (!m[:fn].nil? || !m[:case].nil?)) ? m[:text] : node.text
-        t = node.target.gsub(/^#/, "").gsub(%r{(\.xml|\.adoc)(#.*$)}, "\\2")
         noko do |xml|
-          xml.xref **attr_code(target: t, type: f, case: casing) do |x|
+          attrs = inline_anchor_xref_attrs(node)
+          c = attrs[:text]
+          attrs.delete(:text) unless c.nil?
+          xml.xref **attr_code(attrs) do |x|
             x << c
           end
         end.join
       end
 
+      def inline_anchor_xref_attrs(node)
+        m = /^(?<drop>droploc%)?(?<case>capital%|lowercase%)?(?<drop2>droploc%)?
+          (?<fn>fn(:\s*(?<text>.*))?)?$/x.match node.text
+        casing = m.nil? ? nil : m[:case]&.sub(/%$/, "")
+        droploc = m.nil? ? nil : ((m[:drop].nil? && m[:drop2].nil?) ? nil: true)
+        f = (m.nil? || m[:fn].nil?) ? "inline" : "footnote"
+        c = (!m.nil? && (%i[case fn drop drop2].any? { |x| !m[x].nil? })) ?
+          m[:text] : node.text
+        t = node.target.gsub(/^#/, "").gsub(%r{(\.xml|\.adoc)(#.*$)}, "\\2")
+        { target: t, type: f, case: casing, droploc: droploc, text: c }
+      end
+
       def inline_anchor_link(node)
         contents = node.text
         contents = "" if node.target.gsub(%r{^mailto:}, "") == node.text
@@ -106,40 +116,8 @@ module Asciidoctor
         HTMLEntities.new.encode(text, :basic, :hexadecimal).
           gsub(/&amp;gt;/, ">").gsub(/\&amp;lt;/, "<").gsub(/&amp;amp;/, "&").
           gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&").
-          gsub(/&quot;/, '"').gsub(/&#xa;/, "\n")
-      end
-
-=begin
-      def latex_run1(lxm_input, cmd)
-        IO.popen(cmd, "r+", external_encoding: "UTF-8") do |io|
-          io.write(lxm_input)
-          io.close_write
-          io.read
-        end
-      end
-
-      def latex_run(lxm_input)
-        results = nil
-        Metanorma::Standoc::Requirements[:latexml].cmd.each_with_index do |cmd, i|
-          warn "Retrying with #{cmd}" if i > 0
-          results = latex_run1(lxm_input, cmd)
-          if $CHILD_STATUS.to_i.zero?
-            warn "Success!" if i > 0
-            break
-          end
-        end
-        $CHILD_STATUS.to_i.zero? ? results : nil
-      end
-
-      def latex_parse(text)
-        lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(text))
-        results = latex_run(lxm_input)
-        results.nil? and
-          @log.add('Math', nil,
-                   "latexmlmath failed to process equation:\n#{lxm_input}")
-        results&.sub(%r{<math ([^>]+ )?display="block"}, "<math \\1")
+          gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
       end
-=end
 
       def latex_parse(text)
         lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(text))
@@ -163,7 +141,7 @@ module Asciidoctor
             s.parent.children = math
           end
         else
-          xml.stem text, **{ type: "AsciiMath" }
+          xml.stem text&.gsub(/\&amp;#/, "&#"), **{ type: "AsciiMath" }
         end
       end
 

data/lib/asciidoctor/standoc/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -42,7 +50,6 @@
     </define>
     <define name="xref">
       <element name="xref">
-        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
           <data type="string">
             <param name="pattern">\i\c*|\c+#\c+</param>
@@ -64,6 +71,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -137,6 +149,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -859,6 +876,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -880,7 +904,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -1153,49 +1177,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">
@@ -1481,11 +1463,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>

data/lib/asciidoctor/standoc/lists.rb

@@ -55,7 +55,7 @@ module Asciidoctor
 
       def ol_attrs(node)
         attr_code(keep_attrs(node).merge(id: Utils::anchor_or_uuid(node),
-                  type: olist_style(node.style)))
+                                         type: olist_style(node.style)))
       end
 
       def olist(node)
@@ -87,7 +87,9 @@ module Asciidoctor
       end
 
       def dl_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)))
+        attr_code(keep_attrs(node).
+                  merge(id: Utils::anchor_or_uuid(node),
+                        key: node.option?("key") ? "true" : nil))
       end
 
       def dlist(node)