metanorma-standoc 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06176e145f12bd799593297fca5b0820ae94de9b676f4b1003f4450fb1a6148e
-  data.tar.gz: 45a4c760ebed46439988ad8117cb4ce4dfe2fbddcd30c927b1283f52fbcb0049
+  metadata.gz: 3549faf588ef5ac25ac0f5fc7793fb1b8ec5f43b0e1cf6782c8db9858583b023
+  data.tar.gz: 191776185cad00c0691dab60a744a7d41cac34276b118d3440a4697e5f969043
 SHA512:
-  metadata.gz: 1c3a0df087934b281540c6ea2c64097fa156f549c9ce69d4a29c5ab5d1b2cc75ad6513196e21740c7ae61820e7b6d92dd074253856801438c254bb858689c646
-  data.tar.gz: 95e186a6532958595ab9796dd369155e4ddbc7217a6f64ba7865ad5d4acba5736593aa636ad17e59ab400eb350d1b6b9f223790dd83ecafdb9c80ca9a8e1712e
+  metadata.gz: 44ae4a1c90f48a83a4d727d28534736d7c714a8abc3b6cf85f2eadab0c4834a8d47d61e852e1070301c50044677aeb774e74dc1eeb99b106d9e35ae7ce13d4c4
+  data.tar.gz: 698b0a2f29a7c4739234307995ef89da77185d1dd1d4da7511c8036f043f91a0d7ad6fc19eb2df9abf76fd31e712f2ea1a23a9136a1494c6749b3663aef40009

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    metanorma-standoc (1.2.4)
+    metanorma-standoc (1.3.0)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
       html2doc (~> 0.8.11)
       iev (~> 0.2.1)
-      isodoc (~> 0.10.0)
+      isodoc (~> 1.0.0)
       relaton (~> 0.5.0)
       relaton-iev (~> 0.1.0)
       ruby-jing
@@ -65,7 +65,7 @@ GEM
     iev (0.2.2)
       nokogiri
     image_size (2.0.2)
-    isodoc (0.10.4)
+    isodoc (1.0.0)
       asciimath
       html2doc (~> 0.8.11)
       htmlentities (~> 4.3.4)
@@ -94,7 +94,7 @@ GEM
     mime-types-data (3.2019.0331)
     mini_portile2 (2.4.0)
     nenv (0.3.0)
-    nokogiri (1.10.3)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -113,16 +113,15 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton (0.5.0)
+    relaton (0.5.2)
       algoliasearch
       relaton-gb (~> 0.6.0)
       relaton-iec (~> 0.4.0)
       relaton-ietf (~> 0.6.0)
       relaton-iso (~> 0.6.0)
-      relaton-iso-bib (~> 0.3.0)
       relaton-itu (~> 0.3.0)
       relaton-nist (~> 0.3.0)
-    relaton-bib (0.3.3)
+    relaton-bib (0.3.5)
       addressable
       nokogiri (~> 1.10)
     relaton-gb (0.6.1)
@@ -132,20 +131,20 @@ GEM
     relaton-iec (0.4.2)
       addressable
       relaton-iso-bib (~> 0.3.0)
-    relaton-ietf (0.6.1)
+    relaton-ietf (0.6.2)
       relaton-bib (~> 0.3.0)
     relaton-iev (0.1.1)
       relaton (~> 0.5.0)
-    relaton-iso (0.6.2)
+    relaton-iso (0.6.3)
       relaton-iec (~> 0.4.0)
       relaton-iso-bib (~> 0.3.0)
-    relaton-iso-bib (0.3.2)
+    relaton-iso-bib (0.3.4)
       isoics (~> 0.1.6)
       relaton-bib (~> 0.3.0)
       ruby_deep_clone (~> 0.8.0)
-    relaton-itu (0.3.0)
+    relaton-itu (0.3.2)
       relaton-iso-bib (~> 0.3.0)
-    relaton-nist (0.3.0)
+    relaton-nist (0.3.2)
       relaton-bib (~> 0.3.0)
       rubyzip
     roman-numerals (0.3.0)
@@ -176,9 +175,8 @@ GEM
     ruby_dep (1.5.0)
     rubyzip (1.2.3)
     safe_yaml (1.0.5)
-    sassc (2.0.1)
+    sassc (2.1.0)
       ffi (~> 1.9)
-      rake
     shellany (0.0.1)
     simplecov (0.17.0)
       docile (~> 1.1)

data/lib/asciidoctor/standoc/base.rb

@@ -116,8 +116,10 @@ module Asciidoctor
 
       def init_iev_caches(node)
         unless (@no_isobib_cache || @no_isobib)
-          @iev_globalname = global_ievcache_name unless node.attr("local-cache-only")
-          @iev_localname = local_ievcache_name(node.attr("local-cache") || node.attr("local-cache-only"))
+          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?

data/lib/asciidoctor/standoc/cleanup.rb

@@ -205,12 +205,6 @@ module Asciidoctor
         termdocsource_cleanup(xmldoc)
       end
 
-      def biblio_cleanup(xmldoc)
-        xmldoc.xpath("//references[references]").each do |t|
-          t.name = "clause"
-        end
-      end
-
       def empty_text_before_first_element(x)
         x.children.each do |c|
           if c.text?

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -75,6 +75,38 @@ module Asciidoctor
         end
       end
 
+      def biblio_reorder(xmldoc)
+        xmldoc.xpath("//references[title = 'Bibliography']").each do |r|
+          biblio_reorder1(r)
+        end
+      end
+
+      def biblio_reorder1(refs)
+        bib = sort_biblio(refs.xpath("./bibitem"))
+        refs.xpath("./bibitem").each { |b| b.remove }
+        bib.reverse.each do |b|
+        insert = refs.at("./title") and insert.next = b.to_xml or
+          refs.children.first.add_previous_sibling b.to_xml
+        end
+        refs.xpath("./references").each { |r| biblio_reorder1(r) }
+      end
+
+      def sort_biblio(bib)
+        bib
+      end
+
+      # default presuppose that all citations in biblio numbered
+      # consecutively, but that standards codes are preserved as is:
+      # only numeric references are renumbered
+      def biblio_renumber(xmldoc)
+        r = xmldoc.at("//references[title = 'Bibliography'] | "\
+                      "//clause[title = 'Bibliography'][.//bibitem]") or return
+        r.xpath(".//bibitem[not(ancestor::bibitem)]").each_with_index do |b, i|
+          docid = b.at("./docidentifier[@type = 'metanorma']") and
+            docid.children = "[#{i + 1}]"
+        end
+      end
+
       # move ref before p
       def ref_cleanup(xmldoc)
         xmldoc.xpath("//p/ref").each do |r|
@@ -91,6 +123,14 @@ module Asciidoctor
         end
       end
 
+      def biblio_cleanup(xmldoc)
+        biblio_reorder(xmldoc)
+        biblio_renumber(xmldoc)
+        xmldoc.xpath("//references[references]").each do |t|
+          t.name = "clause"
+        end
+      end
+
       def docid_prefix(prefix, docid)
         docid = "#{prefix} #{docid}" unless omit_docid_prefix(prefix)
         docid
@@ -122,50 +162,10 @@ module Asciidoctor
         end
       end
 
-=begin
-      # converts generic IEV citation to citation of IEC 60050-n
-      # assumes IEV citations are of form
-      # <eref type="inline" bibitemid="a" citeas="IEC 60050">
-      # <locality type="clause"><referenceFrom>101-01-01</referenceFrom></locality></eref>
-      def linksIev2iec60050part(xmldoc)
-        parts = Set.new()
-        xmldoc.xpath("//eref[@citeas = 'IEC 60050:2011'] | "\
-                     "//origin[@citeas = 'IEC 60050:2011']").each do |x|
-          cl = x&.at("./locality[@type = 'clause']/referenceFrom")&.text || next
-          m = /^(\d+)/.match cl || next
-          parts << m[0]
-          x["citeas"] = x["citeas"].sub(/60050/, "60050-#{m[0]}")
-          x["bibitemid"] = "IEC60050-#{m[0]}"
-        end
-        parts
-      end
-
-      # replace generic IEV reference with references to all extracted
-      # IEV parts
-      def refsIev2iec60050part(xmldoc, parts, iev)
-        new_iev = ""
-        parts.sort.each do |p|
-          hit = @bibdb&.fetch("IEC 60050-#{p}", nil, keep_year: true) || next
-          new_iev += hit.to_xml.sub(/ id="[^"]+"/, %{ id="IEC60050-#{p}"})
-          date = hit.date[0].on.year
-          xmldoc.xpath("//*[@citeas = 'IEC 60050-#{p}:2011']").each do |x|
-            x["citeas"] = x["citeas"].sub(/:2011$/, ":#{date}")
-          end
-        end
-        iev.replace(new_iev)
-      end
-
-      # call after xref_cleanup and origin_cleanup
-      def iev_cleanup(xmldoc)
-        iev = xmldoc.at("//bibitem[docidentifier = 'IEC 60050:2011']") || return
-        parts = linksIev2iec60050part(xmldoc)
-        refsIev2iec60050part(xmldoc, parts, iev)
-      end
-=end
-
       def ref_dl_cleanup(xmldoc)
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
+          #warn bib
           bibitemxml = RelatonBib::BibliographicItem.new(
             RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
@@ -202,7 +202,8 @@ module Asciidoctor
         return nil if dtd.children.empty?
         dtd.at("./dl") and return dl_bib_extract(dtd)
         elems = dtd.remove.elements
-        return p_unwrap(dtd) unless elems.size == 1 && %w(ol ul).include?(elems[0].name)
+        return p_unwrap(dtd) unless elems.size == 1 &&
+          %w(ol ul).include?(elems[0].name)
         ret = []
         elems[0].xpath("./li").each do |li|
           ret << p_unwrap(li)
@@ -211,8 +212,7 @@ module Asciidoctor
       end
 
       def add_to_hash(bib, key, val)
-        bib[key] = bib[key].is_a?(Array) ?  (bib[key] << val) :
-          bib[key].nil? ?  val : [bib[key], val]
+        Utils::set_nested_value(bib, key.split(/\./), val)
       end
 
       # definition list, with at most one level of unordered lists

data/lib/asciidoctor/standoc/front.rb

@@ -87,7 +87,8 @@ module Asciidoctor
               end
             end
             node.attr("email#{suffix}") and p.email node.attr("email#{suffix}")
-            node.attr("contributor-uri#{suffix}") and p.uri node.attr("contributor-uri#{suffix}")
+            node.attr("contributor-uri#{suffix}") and
+              p.uri node.attr("contributor-uri#{suffix}")
           end
         end
       end
@@ -144,7 +145,8 @@ module Asciidoctor
         node.attr("html-uri") && xml.uri(node.attr("html-uri"), type: "html")
         node.attr("pdf-uri") && xml.uri(node.attr("pdf-uri"), type: "pdf")
         node.attr("doc-uri") && xml.uri(node.attr("doc-uri"), type: "doc")
-        node.attr("relaton-uri") && xml.uri(node.attr("relaton-uri"), type: "relaton")
+        node.attr("relaton-uri") && xml.uri(node.attr("relaton-uri"),
+                                            type: "relaton")
       end
 
       def metadata_date1(node, xml, type)
@@ -266,7 +268,8 @@ module Asciidoctor
         ["en"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at) do |t|
-            t << asciidoc_sub(node.attr("title") || node.attr("title-en") || node.title)
+            t << asciidoc_sub(node.attr("title") || node.attr("title-en") ||
+                              node.title)
           end
         end
       end

data/lib/asciidoctor/standoc/inline.rb

@@ -107,7 +107,8 @@ module Asciidoctor
           xml.stem math, **{ type: "MathML" }
         elsif style == :latexmath
           latex_cmd = Metanorma::Standoc::Requirements[:latexml].cmd
-          latexmlmath_input = Unicode2LaTeX::unicode2latex(text).gsub(/'/, '\\').gsub(/\n/, " ")
+          latexmlmath_input =
+            Unicode2LaTeX::unicode2latex(text).gsub(/'/, '\\').gsub(/\n/, " ")
           latex = IO.popen(latex_cmd, "r+", external_encoding: "UTF-8") do |io|
             io.write(latexmlmath_input)
             io.close_write

data/lib/asciidoctor/standoc/macros.rb

@@ -49,7 +49,8 @@ module Asciidoctor
       def process parent, reader, attrs
         attrs['name'] = 'todo'
         attrs['caption'] = 'TODO'
-        create_block parent, :admonition, reader.lines, attrs, content_model: :compound
+        create_block parent, :admonition, reader.lines, attrs,
+          content_model: :compound
       end
     end
 
@@ -88,6 +89,9 @@ module Asciidoctor
         fn = save_plantuml parent, reader, localdir
         umlfile = Pathname.new(localdir) + "plantuml" + "#{fn}.pml"
         system "plantuml #{umlfile}"
+        # sleep need for windows because dot works in separate process and plantuml process may
+        # finish erlier then dot, as result png file maybe not created yet after plantuml finish
+        sleep(2) if Gem.win_platform?
         outfile = parent.image_uri("#{fn}.png")
         if outfile == "#{fn}.png" 
           (Pathname.new("plantuml") + "#{fn}.png").to_s
@@ -105,9 +109,8 @@ module Asciidoctor
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
         fn ||= UUIDTools::UUID.random_create
         path = Pathname.new(localdir) + "plantuml"
-        FileUtils.mkdir_p path.to_s # "#{localdir}/plantuml"
-        #File.open("#{localdir}plantuml/#{fn}.pml", "w") { |f| f.write src }
-        File.open((path + "#{fn}.pml").to_s, "w") { |f| f.write src }
+        path.mkpath()
+        (path + "#{fn}.pml").write(src)
         fn
       end
 
@@ -136,7 +139,8 @@ module Asciidoctor
           warn "PlantUML not installed"
           # attrs.delete(1) : remove the style attribute
           attrs["language"] = "plantuml"
-          create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }
+          create_listing_block parent, reader.source,
+            attrs.reject { |k, v| k == 1 }
         end
       end
     end

data/lib/asciidoctor/standoc/ref.rb

@@ -42,12 +42,13 @@ module Asciidoctor
       end
 
       def docid(t, code)
-        type, code1 = @bibdb&.docid_type(code) unless /^\[\d+\]$/.match(code)
-        t.docidentifier (code1 || code), **attr_code(type: type)
+        type, code1 = /^\[\d+\]$/.match(code) ? ["metanorma", code] :
+          @bibdb&.docid_type(code) || [nil, code]
+        t.docidentifier code1, **attr_code(type: type)
       end
 
       def isorefmatches(xml, m)
-        ref = fetch_ref xml, m[:code], m[:year]
+        ref = fetch_ref xml, m[:code], m[:year], title: m[:text]
         return use_my_anchor(ref, m[:anchor]) if ref
         xml.bibitem **attr_code(ref_attributes(m)) do |t|
           t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
@@ -60,7 +61,8 @@ module Asciidoctor
       end
 
       def isorefmatches2(xml, m)
-        ref = fetch_ref xml, m[:code], nil, no_year: true, note: m[:fn]
+        ref = fetch_ref xml, m[:code], nil, no_year: true, note: m[:fn],
+          title: m[:text]
         return use_my_anchor(ref, m[:anchor]) if ref
         xml.bibitem **attr_code(ref_attributes(m)) do |t|
           t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
@@ -87,7 +89,7 @@ module Asciidoctor
         hasyr =  m.names.include?("year") && m[:year] != "--"
         noyr =  m.names.include?("year") && m[:year] == "--"
         ref = fetch_ref xml, m[:code], hasyr ? m[:year] : nil, 
-          all_parts: true, no_year: noyr
+          all_parts: true, no_year: noyr, text: m[:text]
         return use_my_anchor(ref, m[:anchor]) if ref
         xml.bibitem(**attr_code(ref_attributes(m))) do |t|
           t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
@@ -96,7 +98,6 @@ module Asciidoctor
           iso_publisher(t, m[:code])
           m.names.include?("fn") && m[:fn] and
             t.note(**plaintxt) { |p| p << "ISO DATE: #{m[:fn]}" }
-          #t.allparts "true"
           t.extent **{ type: 'part' } do |e|
             e.referenceFrom "all"
           end
@@ -107,7 +108,7 @@ module Asciidoctor
         return nil if opts[:no_year]
         hit = @bibdb&.fetch(code, year, opts) 
         return nil if hit.nil?
-        xml.parent.add_child(Utils::smart_render_xml(hit))
+        xml.parent.add_child(Utils::smart_render_xml(hit, code, opts[:title]))
         xml
       rescue RelatonBib::RequestError
         warn "Could not retrieve #{code}: no access to online site"
@@ -131,7 +132,7 @@ module Asciidoctor
         end
         unless m[:code] && /^\d+$/.match(m[:code])
           ref = fetch_ref xml, m[:code], 
-            m.names.include?("year") ? m[:year] : nil, {}
+            m.names.include?("year") ? m[:year] : nil, { title: m[:text] }
           return use_my_anchor(ref, m[:anchor]) if ref
         end
         refitem_render(xml, m)

data/lib/asciidoctor/standoc/reqt.rng

@@ -87,7 +87,7 @@
     </element>
   </define>
   <define name="reqinherit">
-    <element name="subject">
+    <element name="inherit">
       <text/>
     </element>
   </define>

data/lib/asciidoctor/standoc/utils.rb

@@ -43,12 +43,48 @@ module Asciidoctor
             gsub(/--/, "&#8212;").smart_format.gsub(/</, "&lt;").gsub(/>/, "&gt;")
         end
 
-        def smart_render_xml(x)
+        # Set hash value using keys path
+        # mod from https://stackoverflow.com/a/42425884
+        def set_nested_value(hash, keys, new_val)
+          key = keys[0]
+          if keys.length == 1
+            hash[key] = hash[key].is_a?(Array) ?  (hash[key] << new_val) :
+              hash[key].nil? ?  new_val : [hash[key], new_val]
+            return hash
+          end
+          if hash[key].is_a?(Array)
+            hash[key][-1] = {} if hash[key][-1].nil?
+            set_nested_value(hash[key][-1], keys[1..-1], new_val)
+          elsif hash[key].nil? || hash[key].empty?
+            hash[key] = {}
+            set_nested_value(hash[key], keys[1..-1], new_val)
+          elsif hash[key].is_a?(Hash) && !hash[key][keys[1]]
+            set_nested_value(hash[key], keys[1..-1], new_val)
+          elsif !hash[key][keys[1]]
+            hash[key] = [hash[key], {}]
+            set_nested_value(hash[key][-1], keys[1..-1], new_val)
+          else
+            set_nested_value(hash[key], keys[1..-1], new_val)
+          end
+        end
+
+        def emend_biblio(xml, code, title)
+          unless xml.at("/bibitem/docidentifier[not(@type = 'DOI')][text()]")
+            warn "ERROR: No document identifier retrieved for #{code}"
+            xml.root << "<docidentifier>#{code}</docidentifier>"
+          end
+          unless xml.at("/bibitem/title[text()]")
+            warn "ERROR: No title retrieved for #{code}"
+            xml.root << "<title>#{title || "(MISSING TITLE)"}</title>"
+          end
+        end
+
+        def smart_render_xml(x, code, title)
           xstr = x.to_xml if x.respond_to? :to_xml
           xml = Nokogiri::XML(xstr)
+          emend_biblio(xml, code, title)
           xml.traverse do |n|
-            next unless n.text?
-            n.replace(smartformat(n.text))
+            n.text? and n.replace(smartformat(n.text))
           end
           xml.to_xml.sub(/<\?[^>]+>/, "")
         end