metanorma-standoc 1.3.28 → 1.4.3

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -0,0 +1,124 @@
+module Asciidoctor
+  module Standoc
+    module Section
+      def in_biblio?
+        @biblio
+      end
+
+      def in_norm_ref?
+        @norm_ref
+      end
+
+      def bibliography_parse(attrs, xml, node)
+        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
+        node.attr("style") == "bibliography" or
+          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
+        @biblio = true
+        xml.references **attr_code(attrs.merge(normative: false)) do |xml_section|
+          title = node.level == 1 ? "Bibliography" : node.title
+          xml_section.title { |t| t << title }
+          xml_section << node.content
+        end
+        @biblio = false
+      end
+
+      def bibitem_parse(attrs, xml, node)
+        norm_ref = @norm_ref
+        biblio = @biblio
+        @biblio = false
+        @norm_ref = false
+        clause_parse(attrs, xml, node)
+        @biblio = biblio
+        @norm_ref = norm_ref
+      end
+
+      def norm_ref_parse(attrs, xml, node)
+        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
+        node.attr("style") == "bibliography" or
+          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
+        @norm_ref = true
+        xml.references **attr_code(attrs.merge(normative: true)) do |xml_section|
+          xml_section.title { |t| t << "Normative References" }
+          xml_section << node.content
+        end
+        @norm_ref = false
+      end
+
+      def global_ievcache_name
+        "#{Dir.home}/.iev/cache"
+      end
+
+      def local_ievcache_name(cachename)
+        return nil if cachename.nil?
+        cachename += "_iev" unless cachename.empty?
+        cachename = "iev" if cachename.empty?
+        "#{cachename}/cache"
+      end
+
+      def fetch_ref(xml, code, year, **opts)
+        return nil if opts[:no_year]
+        code = code.sub(/^\([^)]+\)/, "")
+        hit = @bibdb&.fetch(code, year, opts)
+        return nil if hit.nil?
+        xml.parent.add_child(smart_render_xml(hit, code, opts[:title],
+                                              opts[:usrlbl]))
+        xml
+      rescue RelatonBib::RequestError
+        @log.add("Bibliography", nil, "Could not retrieve #{code}: "\
+                 "no access to online site")
+        nil
+      end
+
+      def emend_biblio(xml, code, title, usrlbl)
+        unless xml.at("/bibitem/docidentifier[not(@type = 'DOI')][text()]")
+          @log.add("Bibliography", nil,
+                   "ERROR: No document identifier retrieved for #{code}")
+          xml.root << "<docidentifier>#{code}</docidentifier>"
+        end
+        unless xml.at("/bibitem/title[text()]")
+          @log.add("Bibliography", nil,
+                   "ERROR: No title retrieved for #{code}")
+          xml.root << "<title>#{title || "(MISSING TITLE)"}</title>"
+        end
+        usrlbl and xml.at("/bibitem/docidentifier").next =
+          "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
+      end
+
+      def smart_render_xml(x, code, title, usrlbl)
+        xstr = x.to_xml if x.respond_to? :to_xml
+        xml = Nokogiri::XML(xstr)
+        emend_biblio(xml, code, title, usrlbl)
+        xml.xpath("//date").each { |d| Utils::endash_date(d) }
+        xml.traverse do |n|
+          n.text? and n.replace(Utils::smartformat(n.text))
+        end
+        xml.to_xml.sub(/<\?[^>]+>/, "")
+      end
+
+      def init_bib_caches(node)
+        return if @no_isobib
+        global = !@no_isobib_cache && !node.attr("local-cache-only")
+        local = node.attr("local-cache") || node.attr("local-cache-only")
+        local = nil if @no_isobib_cache
+        @bibdb = Relaton::DbCache.init_bib_caches(
+          local_cache: local,
+          flush_caches: node.attr("flush-caches"),
+          global_cache: global)
+      end
+
+      def init_iev_caches(node)
+        unless (@no_isobib_cache || @no_isobib)
+          node.attr("local-cache-only") or
+            @iev_globalname = global_ievcache_name
+          @iev_localname = local_ievcache_name(node.attr("local-cache") ||
+                                               node.attr("local-cache-only"))
+          if node.attr("flush-caches")
+            FileUtils.rm_f @iev_globalname unless @iev_globalname.nil?
+            FileUtils.rm_f @iev_localname unless @iev_localname.nil?
+          end
+        end
+        #@iev = Iev::Db.new(globalname, localname) unless @no_isobib
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/reqt.rb

@@ -6,11 +6,15 @@ require "base64"
 module Asciidoctor
   module Standoc
     module Blocks
+      def reqt_subpart_attrs(node)
+        attr_code(keep_attrs(node).merge(exclude: node.option?("exclude"),
+                                     type: node.attr("type")))
+      end
+
       def requirement_subpart(node)
         name = node.role || node.attr("style")
         noko do |xml|
-          xml.send name, **attr_code(exclude: node.option?("exclude"),
-                                     type: node.attr("type")) do |o|
+          xml.send name, **reqt_subpart_attrs(node) do |o|
             o << node.content
           end
         end
@@ -35,22 +39,23 @@ module Asciidoctor
         end
       end
 
-      def reqt_attributes(node)
-        {
+      def reqt_attrs(node)
+        attr_code(keep_attrs(node).merge(id_unnum_attrs(node)).merge(
           id: Utils::anchor_or_uuid(node),
           unnumbered: node.option?("unnumbered") ? "true" : nil,
+          number: node.attr("number"),
           subsequence: node.attr("subsequence"),
           obligation: node.attr("obligation"),
           filename: node.attr("filename"),
           type: node.attr("type"),
           model: node.attr("model"),
-        }
+        ))
       end
 
       def requirement(node, obligation)
         classif = node.attr("classification")
         noko do |xml|
-          xml.send obligation, **attr_code(reqt_attributes(node)) do |ex|
+          xml.send obligation, **reqt_attrs(node) do |ex|
             node.title and ex.title { |t| t << node.title }
             node.attr("label") and ex.label { |l| l << node.attr("label") }
             node.attr("subject") and ex.subject { |s| s << node.attr("subject") }

data/lib/asciidoctor/standoc/reqt.rng

@@ -30,9 +30,22 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="subsequence"/>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
@@ -141,6 +154,16 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/asciidoctor/standoc/section.rb

@@ -1,5 +1,6 @@
 require "htmlentities"
 require "uri"
+require_relative "ref_sect"
 
 module Asciidoctor
   module Standoc
@@ -8,18 +9,10 @@ module Asciidoctor
       @term_def = false
       @norm_ref = false
 
-      def in_biblio?
-        @biblio
-      end
-
       def in_terms?
         @term_def
       end
 
-      def in_norm_ref?
-        @norm_ref
-      end
-
       def sectiontype(node, level = true)
         ret = node&.attr("heading")&.downcase ||
           node.title.gsub(/<[^>]+>/, "").downcase
@@ -41,9 +34,7 @@ module Asciidoctor
           "terms, definitions and abbreviated terms"
           "terms and definitions"
         when "symbols and abbreviated terms",
-          "symbols",
-          "abbreviated terms",
-          "abbreviations"
+          "symbols", "abbreviated terms", "abbreviations"
           "symbols and abbreviated terms"
         else
           ret
@@ -148,19 +139,6 @@ module Asciidoctor
         end
       end
 
-      def bibliography_parse(attrs, xml, node)
-        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
-        node.attr("style") == "bibliography" or
-          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
-        @biblio = true
-        xml.references **attr_code(attrs.merge(normative: false)) do |xml_section|
-          title = node.level == 1 ? "Bibliography" : node.title
-          xml_section.title { |t| t << title }
-          xml_section << node.content
-        end
-        @biblio = false
-      end
-
       def nonterm_symbols_parse(attrs, xml, node)
         @definitions = false
         clause_parse(attrs, xml, node)
@@ -236,28 +214,6 @@ module Asciidoctor
         end
       end
 
-      def bibitem_parse(attrs, xml, node)
-        norm_ref = @norm_ref
-        biblio = @biblio
-        @biblio = false
-        @norm_ref = false
-        clause_parse(attrs, xml, node)
-        @biblio = biblio
-        @norm_ref = norm_ref
-      end
-
-      def norm_ref_parse(attrs, xml, node)
-        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
-        node.attr("style") == "bibliography" or
-          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
-        @norm_ref = true
-        xml.references **attr_code(attrs.merge(normative: true)) do |xml_section|
-          xml_section.title { |t| t << "Normative References" }
-          xml_section << node.content
-        end
-        @norm_ref = false
-      end
-
       def introduction_parse(attrs, xml, node)
         xml.introduction **attr_code(attrs) do |xml_section|
           xml_section.title { |t| t << "Introduction" }

data/lib/asciidoctor/standoc/table.rb

@@ -2,14 +2,15 @@ module Asciidoctor
   module Standoc
     module Table
       def table_attrs(node)
-        { id: Utils::anchor_or_uuid(node),
+        keep_attrs(node).merge( id: Utils::anchor_or_uuid(node),
           headerrows: node.attr("headerrows"),
           unnumbered: node.option?("unnumbered") ? "true" : nil,
+          number: node.attr("number"),
           subsequence: node.attr("subsequence"),
           alt: node.attr("alt"),
           summary: node.attr("summary"),
           width: node.attr("width"),
-        }
+        )
       end
 
       def table(node)

data/lib/asciidoctor/standoc/validate.rb

@@ -25,7 +25,6 @@ module Asciidoctor
           @iev = init_iev or return
           iev = @iev.fetch(locality, xmldoc&.at("//language")&.text || "en") or next
           pref.include?(iev.downcase) or
-            #warn %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}")
           @log.add("Bibliography", t, %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}"))
         end
       end
@@ -38,14 +37,20 @@ module Asciidoctor
 
       def repeat_id_validate(doc)
         ids = {}
+        crash = false
         doc.xpath("//*[@id]").each do |x|
           if ids[x["id"]]
-          @log.add("Anchors", x, "Anchor #{x['id']} has already been used at line #{ids[x['id']]}")
+            @log.add("Anchors", x, "Anchor #{x['id']} has already been used at line #{ids[x['id']]}")
+            crash = true
           else
             ids[x["id"]] = x.line
           end
         end
+        if crash
+          clean_exit
+          abort("Cannot deal with multiple instances of same ID")
         end
+      end
 
       def schema_validate(doc, schema)
         Tempfile.open(["tmp", ".xml"], :encoding => 'UTF-8') do |f|
@@ -58,6 +63,7 @@ module Asciidoctor
               @log.add("Syntax", "XML Line #{"%06d" % error[:line]}:#{error[:column]}", error[:message])
             end
           rescue Jing::Error => e
+            clean_exit
             abort "Jing failed with error: #{e}"
           ensure
             f.close!

data/lib/asciidoctor/standoc/validate_section.rb

@@ -14,7 +14,6 @@ module Asciidoctor
           callouts = x.elements.select { |e| e.name == "callout" }
           annotations = x.elements.select { |e| e.name == "annotation" }
           if callouts.size != annotations.size
-            #warn "#{x['id']}: mismatch of callouts and annotations"
         @log.add("AsciiDoc Input", x, "mismatch of callouts and annotations")
           end
         end
@@ -23,7 +22,6 @@ module Asciidoctor
       def style_warning(node, msg, text = nil)
         w = msg
         w += ": #{text}" if text
-        #warn w
         @log.add("Style Warning", node, w)
       end
 

data/lib/asciidoctor/standoc/views/datamodel/model_representation.adoc.erb

@@ -0,0 +1,30 @@
+
+[yaml2text,<%= model_path %>,definition]
+----
+
+=== {definition.name || "<%= file_name %>"}
+{definition.definition}
+
+{if definition.attributes}
+.{definition.name || "<%= file_name %>"} attributes
+|===
+|Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
+
+{definition.attributes&.*,key,EOK}
+|{key} |{definition.attributes[key].definition || "TODO: enum " + key.to_s + "'s definition"} |{definition.attributes[key]&.cardinality&.min == 0 ? "O" : "M"} |{definition.attributes[key]&.cardinality&.max == "*" ? "N" : "1"} |{definition.attributes[key].origin ? "<<" + definition.attributes[key].origin.to_s + ">>" : ""}`{definition.attributes[key].type}`
+{EOK}
+|===
+{end}
+
+{if definition['values']}
+.{definition.name || "<%= file_name %>"} values
+|===
+|Name |Definition
+
+{definition['values']&.*,key,EOK}
+|{key} |{definition['values'][key].definition}
+{EOK}
+|===
+{end}
+
+----

data/lib/asciidoctor/standoc/views/datamodel/plantuml_representation.adoc.erb

@@ -0,0 +1,20 @@
+[plantuml,title=<%= diagram_caption %>]
+....
+@startuml
+
+<%= diagram_options_yml_to_plantuml %>
+
+<%= class_groups_yml_to_plantuml %>
+
+<%= imports_yml_to_plantuml %>
+
+<%= class_defs_yml_to_plantuml %>
+
+<%= class_relations_yml_to_plantuml %>
+
+<%= fidelity_yml_to_plantuml %>
+
+<%= bottom_yml_to_plantuml %>
+
+@enduml
+....

data/lib/metanorma/standoc/processor.rb

@@ -21,16 +21,14 @@ module Metanorma
         "Metanorma::Standoc #{Metanorma::Standoc::VERSION}/IsoDoc #{IsoDoc::VERSION}"
       end
 
-      def input_to_isodoc(file, filename)
-        Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
-      end
-
-      def output(isodoc_node, outname, format, options={})
+      def output(isodoc_node, inname, outname, format, options={})
         case format
         when :html
-          IsoDoc::HtmlConvert.new(options).convert(outname, isodoc_node)
+          IsoDoc::HtmlConvert.new(options).convert(inname, isodoc_node, nil, outname)
         when :doc
-          IsoDoc::WordConvert.new(options).convert(outname, isodoc_node)
+          IsoDoc::WordConvert.new(options).convert(inname, isodoc_node, nil, outname)
+        when :presentation
+          IsoDoc::PresentationXMLConvert.new(options).convert(inname, isodoc_node, nil, outname)
         else
           super
         end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.28".freeze
+   VERSION = "1.4.3".freeze
   end
 end