metanorma-standoc 2.2.3.1 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46155f7c41f4ecd6a79e4395cd145f0f212a64c5bd27f93c8b861fbfcd57982
-  data.tar.gz: 93bbad048282ad00874a071bbd583c9189d64bf6f7901fe5bacd10c4156c91a6
+  metadata.gz: 12bb8cacaa61b510652a691e358e62e0e2e4f4ea1ac37dcff09f394b097051a9
+  data.tar.gz: 714fa0c071097b0817e3b95c5066fbd181634f1b7f09cff04e2c1e5eb45b385a
 SHA512:
-  metadata.gz: fd795c5f316556c3572c8d963d9d12f9cee6b91189ae288281d40133b09d10b6beeddb39ae1f6748b371b8a239844402cf843f4c796c69e9ab9a73900b0c0123
-  data.tar.gz: 21803610b86d6f62a7a3d86c9dc34a0c229777bd84ce612cbe916ebcacee95a1442f6a6a09c142e928827f1337063d1e691a950a9dd269c9acc07ab3c89419a3
+  metadata.gz: 4a45f4013300b1c263e7f99ff50605e3576157afaacb4710c7a1f9b14c2e1ac6a624737be9a87e6a4ca3205756451b9a7cacde8df4bc8491d508121d5e821772
+  data.tar.gz: 0c5bdb3f7a121998082b101488352bba31cad34abedf1f7fb1845cf25438c671545e3c65d09ec6a5bf06a075c8f311edbe4f61d210f470b1da009c71c8ea7627

data/lib/metanorma/standoc/base.rb

@@ -100,7 +100,8 @@ module Metanorma
         @lang = (node.attr("language") || "en")
         @script = (node.attr("script") ||
                    Metanorma::Utils.default_script(node.attr("language")))
-        @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
+        @locale = node.attr("locale")
+        @isodoc = isodoc(@lang, @script, @locale, node.attr("i18nyaml"))
         @i18n = @isodoc.i18n
       end
 

data/lib/metanorma/standoc/biblio.rng

@@ -73,8 +73,14 @@
       <text/>
     </element>
   </define>
-  <define name="script">
+  <define name="locale">
     <a:documentation>ISO-639</a:documentation>
+    <element name="locale">
+      <text/>
+    </element>
+  </define>
+  <define name="script">
+    <a:documentation>ISO-3166</a:documentation>
     <element name="script">
       <text/>
     </element>
@@ -93,6 +99,9 @@
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -136,6 +145,9 @@
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -650,6 +662,9 @@
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
+    <zeroOrMore>
+      <ref name="locale"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
@@ -741,6 +756,9 @@
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
+    <zeroOrMore>
+      <ref name="locale"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
@@ -854,6 +872,15 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="language"/>
+    </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
+    <optional>
+      <attribute name="script"/>
+    </optional>
     <data type="anyURI"/>
   </define>
   <define name="DateType">
@@ -882,6 +909,7 @@
       <value>vote-started</value>
       <value>vote-ended</value>
       <value>announced</value>
+      <value>stable-until</value>
     </choice>
   </define>
   <define name="bdate">
@@ -930,6 +958,9 @@
       <optional>
         <attribute name="language"/>
       </optional>
+      <optional>
+        <attribute name="locale"/>
+      </optional>
       <optional>
         <attribute name="script"/>
       </optional>

data/lib/metanorma/standoc/blocks.rb

@@ -174,7 +174,8 @@ module Metanorma
       end
 
       def figure_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node))
+          .merge(class: node.attr("class")))
       end
 
       def image(node)

data/lib/metanorma/standoc/cleanup_biblio.rb

@@ -110,7 +110,10 @@ module Metanorma
 
       def formattedref_spans(xmldoc)
         xmldoc.xpath("//bibitem[formattedref//span]").each do |b|
-          spans_to_bibitem(b, spans_preprocess(extract_content(b)))
+          spans = spans_preprocess(extract_content(b))
+          ret = spans_to_bibitem(spans)
+          spans[:type] and b["type"] = spans[:type]
+          b << ret
         end
       end
 
@@ -120,13 +123,19 @@ module Metanorma
 
       def extract_spans(bib)
         bib.xpath("./formattedref//span").each_with_object([]) do |s, m|
-          keys = s["class"].split(".", 2)
-          m << { key: keys[0], type: keys[1],
-                 val: s.children.to_xml }
-          (s["class"] == "type" and s.remove) or s.replace(s.children)
+          next if s.at("./ancestor::span")
+
+          extract_spans1(s, m)
         end
       end
 
+      def extract_spans1(span, acc)
+        keys = span["class"].split(".", 2)
+        acc << { key: keys[0], type: keys[1],
+                 val: span.children.to_xml }
+        (span["class"] == "type" and span.remove) or span.replace(span.children)
+      end
+
       def extract_docid(bib)
         bib.xpath("./docidentifier").each_with_object([]) do |d, m|
           m << { key: "docid", type: d["type"], val: d.text }
@@ -134,21 +143,61 @@ module Metanorma
         end
       end
 
+      def empty_span_hash
+        { contrib: [], docid: [], uri: [], date: [], extent: {}, in: {} }
+      end
+
       def spans_preprocess(spans)
-        ret = { contributor: [], docid: [], uri: [], date: [] }
-        spans.each do |s|
-          case s[:key]
-          when "uri", "docid"
-            ret[s[:key].to_sym] << { type: s[:type], val: s[:val] }
-          when "pubyear" then ret[:date] << { type: "published", val: s[:val] }
-          when "pubplace", "title", "type" then ret[s[:key].to_sym] = s[:val]
-          when "publisher"
-            ret[:contributor] << { role: "publisher", entity: "organization",
-                                   name: s[:val] }
-          when "surname", "initials", "givenname", "formatted-initials"
-            ret[:contributor] = spans_preprocess_contrib(s, ret[:contributor])
-          end
+        ret = empty_span_hash
+        spans.each { |s| span_preprocess1(s, ret) }
+        host_rearrange(ret)
+      end
+
+      def span_preprocess1(span, ret)
+        case span[:key]
+        when "uri", "docid"
+          ret[span[:key].to_sym] << { type: span[:type], val: span[:val] }
+        when "date"
+          ret[span[:key].to_sym] << { type: span[:type] || "published",
+                                      val: span[:val] }
+        when "pages", "volume", "issue"
+          ret[:extent][span[:key].to_sym] ||= []
+          ret[:extent][span[:key].to_sym] << span[:val]
+        when "pubplace", "title", "type", "series"
+          ret[span[:key].to_sym] = span[:val]
+        when "in_title"
+          ret[:in][:title] = span[:val]
+        when "publisher"
+          ret[:contrib] << { role: "publisher", entity: "organization",
+                             name: span[:val] }
+        when "surname", "initials", "givenname", "formatted-initials"
+          ret[:contrib] = spans_preprocess_contrib(span, ret[:contrib])
+        when "organization"
+          ret[:contrib] = spans_preprocess_org(span, ret[:contrib])
+        when "in_surname", "in_initials", "in_givenname",
+          "in_formatted-initials"
+          ret[:in][:contrib] ||= []
+          span[:key].sub!(/^in_/, "")
+          ret[:in][:contrib] =
+            spans_preprocess_contrib(span, ret[:in][:contrib])
+        when "in_organization"
+          ret[:in][:contrib] ||= []
+          span[:key].sub!(/^in_/, "")
+          ret[:in][:contrib] =
+            spans_preprocess_org(span, ret[:in][:contrib])
         end
+      end
+
+      def host_rearrange(ret)
+        ret[:in][:title] or return ret
+        ret[:in].merge!(empty_span_hash, { type: "misc" }) { |_, old, _| old }
+
+        %i(series).each do |k|
+          ret[:in][k] = ret[k]
+          ret.delete(k)
+        end
+        /^in/.match?(ret[:type]) and ret[:in][:type] =
+                                       ret[:type].sub(/^in/, "")
         ret
       end
 
@@ -169,16 +218,55 @@ module Metanorma
           contrib[-1][:role] != (span[:type] || "author")
       end
 
-      def spans_to_bibitem(bib, spans)
+      def spans_preprocess_org(span, contrib)
+        contrib << { role: span[:type] || "author", entity: "organization",
+                     name: span[:val] }
+        contrib
+      end
+
+      def spans_to_bibitem(spans)
         ret = ""
         spans[:title] and ret += "<title>#{spans[:title]}</title>"
+        ret += spans_to_bibitem_docid(spans)
+        spans[:contrib].each { |s| ret += span_to_contrib(s) }
+        spans[:series] and
+          ret += "<series><title>#{spans[:series]}</title></series>"
+        spans[:pubplace] and ret += "<place>#{spans[:pubplace]}</place>"
+        ret += spans_to_bibitem_host(spans)
+        ret + spans_to_bibitem_extent(spans[:extent])
+      end
+
+      def spans_to_bibitem_host(spans)
+        return "" if spans[:in].empty?
+
+        ret =
+          "<relation type='includedIn'><bibitem type='#{spans[:in][:type]}'>"
+        spans[:in].delete(:type)
+        ret + "#{spans_to_bibitem(spans[:in])}</bibitem></relation>"
+      end
+
+      def spans_to_bibitem_docid(spans)
+        ret = ""
         spans[:uri].each { |s| ret += span_to_docid(s, "uri") }
         spans[:docid].each { |s| ret += span_to_docid(s, "docidentifier") }
         spans[:date].each { |s| ret += span_to_docid(s, "date") }
-        spans[:contributor].each { |s| ret += span_to_contrib(s) }
-        spans[:pubplace] and ret += "<place>#{spans[:place]}</place>"
-        spans[:type] and bib["type"] = spans[:type]
-        bib << ret
+        ret
+      end
+
+      def spans_to_bibitem_extent(spans)
+        ret = ""
+        { volume: "volume", issue: "issue", pages: "page" }.each do |k, v|
+          spans[k]&.each { |s| ret += span_to_extent(s, v) }
+        end
+        ret
+      end
+
+      def span_to_extent(span, key)
+        values = span.split(/[-–]/)
+        ret = "<extent type='#{key}'><referenceFrom>#{values[0]}</referenceFrom>"
+        values[1] and
+          ret += "<referenceTo>#{values[1]}</referenceTo>"
+        "#{ret}</extent>"
       end
 
       def span_to_docid(span, key)

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -4,7 +4,7 @@ module Metanorma
       def external_terms_boilerplate(sources)
         @i18n.l10n(
           @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
-          @lang, @script
+          @lang, @script, @locale
         )
       end
 
@@ -64,7 +64,7 @@ module Metanorma
         x = xmldoc.dup
         x.root.add_namespace(nil, self.class::XML_NAMESPACE)
         xml = Nokogiri::XML(x.to_xml)
-        @isodoc ||= isodoc(@lang, @script)
+        @isodoc ||= isodoc(@lang, @script, @locale)
         @isodoc.info(xml, nil)
         @isodoc
       end

data/lib/metanorma/standoc/front.rb

@@ -95,6 +95,7 @@ module Metanorma
 
       def metadata_language(node, xml)
         xml.language (node.attr("language") || "en")
+        l = node.attr("locale") and xml.locale l
       end
 
       def metadata_script(node, xml)

data/lib/metanorma/standoc/isodoc.rng

@@ -205,6 +205,15 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="style">
+            <choice>
+              <value>basic</value>
+              <value>full</value>
+              <value>short</value>
+            </choice>
+          </attribute>
+        </optional>
         <ref name="XrefBody"/>
       </element>
     </define>

data/lib/metanorma/standoc/macros_plantuml.rb

@@ -1,21 +1,22 @@
 module Metanorma
   module Standoc
     class PlantUMLBlockMacroBackend
-      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
       def self.plantuml_installed?
-        cmd = "plantuml"
-        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
-        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
-          exts.each do |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return exe if File.executable?(exe) && !File.directory?(exe)
-          end
+        unless which("plantuml")
+          raise "PlantUML not installed"
+        end
+      end
+
+      def self.plantuml_bin
+        if Gem.win_platform? || which("plantumlc")
+          "plantumlc"
+        else
+          "plantuml"
         end
-        raise "PlantUML not installed"
       end
 
       def self.run(umlfile, outfile)
-        system "plantuml #{umlfile.path}" or (warn $? and return false)
+        system "#{plantuml_bin} #{umlfile.path}" or (warn $? and return false)
         i = 0
         until !Gem.win_platform? || File.exist?(outfile) || i == 15
           sleep(1)
@@ -84,6 +85,18 @@ module Metanorma
           memo
         end
       end
+
+      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+      def self.which(cmd)
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          end
+        end
+        nil
+      end
     end
 
     class PlantUMLBlockMacro < Asciidoctor::Extensions::BlockProcessor

data/lib/metanorma/standoc/render.rb

@@ -30,6 +30,7 @@ module Metanorma
           tocrecommendations: @tocrecommendations,
           fonts: node.attr("fonts"),
           fontlicenseagreement: node.attr("font-license-agreement"),
+          localizenumber: node.attr("localize-number"),
         }
       end
 

data/lib/metanorma/standoc/term_lookup_cleanup.rb

@@ -42,7 +42,8 @@ module Metanorma
           refterm = n.at("./refterm") or next
           p = @termlookup[:secondary2primary][refterm.text] and
             refterm.children = p
-          refterm.replace("<preferred><expression><name>#{refterm.children.to_xml}"\
+          refterm.replace("<preferred><expression>"\
+                          "<name>#{refterm.children.to_xml}"\
                           "</name></expression></preferred>")
         end
       end
@@ -69,33 +70,51 @@ module Metanorma
 
       def remove_missing_ref(node, target)
         if node.at("./parent::concept[@type = 'symbol']")
+          log.add("AsciiDoc Input", node,
+                  remove_missing_ref_msg(node, target, :symbol))
           remove_missing_ref_symbol(node, target)
         else
+          log.add("AsciiDoc Input", node,
+                  remove_missing_ref_msg(node, target, :term))
           remove_missing_ref_term(node, target)
         end
       end
 
+      def remove_missing_ref_msg(node, target, type)
+        type == :symbol and return <<~LOG
+          Error: Symbol reference in `symbol[#{target}]` missing: "#{target}" is not defined in document
+        LOG
+        ret = <<~LOG
+          Error: Term reference to `#{target}` missing: "#{target}" is not defined in document
+        LOG
+        remove_missing_ref_msg1(node, target, ret)
+      end
+
+      def remove_missing_ref_msg1(node, target, ret)
+        target2 = "_#{target.downcase.gsub(/-/, '_')}"
+        if node.document.at("//*[@id = '#{target}']")&.name == "terms" ||
+            node.document.at("//*[@id = '#{target2}']")&.name == "terms"
+          ret.strip!
+          ret += ". Did you mean to point to a subterm?"
+        end
+        ret
+      end
+
       def remove_missing_ref_term(node, target)
-        log.add("AsciiDoc Input", node,
-                %(Error: Term reference to `#{target}` missing: \
-                "#{target}" is not defined in document))
         node.name = "strong"
-        node&.at("../xrefrender")&.remove
-        display = node&.at("../renderterm")&.remove&.children
-        display = [] if display.nil? || display&.to_xml == node.text
+        node.at("../xrefrender")&.remove
+        display = node.at("../renderterm")&.remove&.children
+        display = [] if display.nil? || display.to_xml == node.text
         d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
         node.children = "term <tt>#{node.text}</tt>#{d} "\
                         "not resolved via ID <tt>#{target}</tt>"
       end
 
       def remove_missing_ref_symbol(node, target)
-        log.add("AsciiDoc Input", node,
-                %(Error: Symbol reference in `symbol[#{target}]` missing: \
-                "#{target}" is not defined in document))
         node.name = "strong"
-        node&.at("../xrefrender")&.remove
-        display = node&.at("../renderterm")&.remove&.children
-        display = [] if display.nil? || display&.to_xml == node.text
+        node.at("../xrefrender")&.remove
+        display = node.at("../renderterm")&.remove&.children
+        display = [] if display.nil? || display.to_xml == node.text
         d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
         node.children = "symbol <tt>#{node.text}</tt>#{d} "\
                         "not resolved via ID <tt>#{target}</tt>"

data/lib/metanorma/standoc/utils.rb

@@ -36,10 +36,10 @@ module Metanorma
       SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
                         "[not(ancestor::boilerplate)]".freeze
 
-      def isodoc(lang, script, i18nyaml = nil)
+      def isodoc(lang, script, locale, i18nyaml = nil)
         conv = presentation_xml_converter(EmptyAttr.new)
-        i18n = conv.i18n_init(lang, script, i18nyaml)
-        conv.metadata_init(lang, script, i18n)
+        i18n = conv.i18n_init(lang, script, locale, i18nyaml)
+        conv.metadata_init(lang, script, locale, i18n)
         conv
       end
 

data/lib/metanorma/standoc/validate.rb

@@ -77,15 +77,24 @@ module Metanorma
           next if doc.at("//term[@id = '#{x['target']}']")
           next if doc.at("//definitions//dt[@id = '#{x['target']}']")
 
-          @log.add("Anchors", x,
-                   "#{tag.capitalize} #{x&.at("../#{refterm}")&.text} is "\
-                   "pointing to #{x['target']}, which is not a term or symbol")
+          @log.add("Anchors", x, concept_validate_msg(doc, tag, refterm, x))
           found = true
         end
         found and
           @fatalerror << "#{tag.capitalize} not cross-referencing term or symbol"
       end
 
+      def concept_validate_msg(doc, tag, refterm, xref)
+        ret = <<~LOG
+          #{tag.capitalize} #{xref.at("../#{refterm}")&.text} is pointing to #{xref['target']}, which is not a term or symbol
+        LOG
+        if doc.at("//*[@id = '#{xref['target']}']")&.name == "terms"
+          ret = ret.strip
+          ret += ". Did you mean to point to a subterm?"
+        end
+        ret
+      end
+
       def repeat_id_validate1(ids, elem)
         if ids[elem["id"]]
           @log.add("Anchors", elem, "Anchor #{elem['id']} has already been "\

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.2.3.1".freeze
+    VERSION = "2.2.5".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 2.2.3"
+  spec.add_dependency "isodoc", "~> 2.3.1"
   spec.add_dependency "metanorma"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml"
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "mn-requirements", "~> 0.1.3"
+  spec.add_dependency "mn-requirements", "~> 0.1.4"
   spec.add_dependency "pngcheck"
   spec.add_dependency "relaton-cli", "~> 1.13.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"

data/spec/metanorma/base_spec.rb

@@ -6,6 +6,13 @@ RSpec.describe Metanorma::Standoc do
     expect(Metanorma::Standoc::VERSION).not_to be nil
   end
 
+  it "applies Asciidoctor substitutions" do
+    expect(Metanorma::Utils.asciidoc_sub("A -- B"))
+      .to eq "A — B"
+    expect(Metanorma::Utils.asciidoc_sub("*A* stem:[x]"))
+      .to eq "<strong>A</strong> <stem type=\"AsciiMath\">x</stem>"
+  end
+
   it "processes named entities" do
     FileUtils.rm_f "test.doc"
     input = <<~INPUT
@@ -554,6 +561,7 @@ RSpec.describe Metanorma::Standoc do
       :tc-docnumber: 2000
       :language: el
       :script: Grek
+      :locale: CY
       :publisher: IEC;IETF;ISO
       :uri: A
       :xml-uri: B
@@ -689,6 +697,7 @@ RSpec.describe Metanorma::Standoc do
                      <revision-date>2000-01</revision-date>
                    </version>
                    <language>el</language>
+                   <locale>CY</locale>
                    <script>Grek</script>
                    <abstract><p>This is the abstract of the document</p>
                    <p>This is the second paragraph of the abstract of the document.</p></abstract>
@@ -780,7 +789,7 @@ RSpec.describe Metanorma::Standoc do
 
     INPUT
     output = <<~OUTPUT
-          <standard-document xmlns="https://www.metanorma.org/ns/standoc"  type="semantic" version="#{Metanorma::Standoc::VERSION}">
+      <standard-document xmlns="https://www.metanorma.org/ns/standoc"  type="semantic" version="#{Metanorma::Standoc::VERSION}">
         <bibdata type='standard'>
           <title language='en' format='text/plain'>Document title</title>
           <contributor>