metanorma-standoc 1.1.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e60988dd72d65a660d97266b8e2a0afd786b619f97e7cf948e040a1b31f7d6fc
-  data.tar.gz: ef5405bcb35b0250cbfbbf30b092a4dd0f0cbaf4435edfab0b8dcf4ddd46cc14
+  metadata.gz: 30d5bcdf81251b8337ccbc89b87c995e53f2899277d814e6668f20c88b4cfd2e
+  data.tar.gz: 85b27e1f408c227f92aa9912e8937867583e25dfaec0fb05b7d644dff19fd514
 SHA512:
-  metadata.gz: e2af11f2fecbfa996d3fda092aabcfd3803117f98afdff33471e27182db1931359acb16379eaa29a998ae3667eea31e3622029cba4c110ab1daa6063d0cf9b2c
-  data.tar.gz: 3f19ae9393a94ceb2dd768f926f14f6ea798ae8be156f9aad3fa578d9eeb93e8e7d82a0f9af1d0eeefe53cb3e5bc4578cd3e959df268c06e0dbe4274dce1fc31
+  metadata.gz: 51cd7259dad7810f4496001fe1013ba6e88bb0cbc033babbba19ce545c3b9210abc7fb169aefc26c850db72493e5016316c6b60fa7f712c04872ff7a0b48bfad
+  data.tar.gz: 21c1588e83613777b5e25eb412eaf0d4cdaf82b927bdb4f824751af139585c4416a40779fe243505d180ea3db97c2647f393c4d73be09b06b540adba175d8e43

data/Gemfile

@@ -3,7 +3,5 @@ Encoding.default_internal = Encoding::UTF_8
 
 source "https://rubygems.org"
 
-gem 'vcr', git: 'https://github.com/vcr/vcr.git', ref: 'a0bb140184e8518baad640a705e04155911bf31f'
-
 # Specify your gem's dependencies in gemspec
 gemspec

data/Gemfile.lock

@@ -1,20 +1,14 @@
-GIT
-  remote: https://github.com/vcr/vcr.git
-  revision: a0bb140184e8518baad640a705e04155911bf31f
-  ref: a0bb140184e8518baad640a705e04155911bf31f
-  specs:
-    vcr (4.0.0)
-
 PATH
   remote: .
   specs:
-    metanorma-standoc (1.1.9)
+    metanorma-standoc (1.2.0)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
-      html2doc (~> 0.8.0)
+      html2doc (~> 0.8.11)
       iev (~> 0.2.1)
-      isodoc (~> 0.9.0)
-      relaton (~> 0.3.1)
+      isodoc (~> 0.10.0)
+      relaton (~> 0.4.0)
+      relaton-cli (~> 0.2.0)
       ruby-jing
       sterile (~> 1.0.14)
       unicode2latex (~> 0.0.1)
@@ -37,16 +31,12 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    ffi (1.9.25)
+    ffi (1.11.1)
     formatador (0.2.5)
     gb-agencies (0.0.5)
-    gbbib (0.4.4)
-      cnccs (~> 0.1.1)
-      gb-agencies (~> 0.0.1)
-      iso-bib-item (~> 0.4.2)
     guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -61,8 +51,8 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (0.3.9)
-    html2doc (0.8.10)
+    hashdiff (0.4.0)
+    html2doc (0.8.11)
       asciimath (~> 1.0.7)
       htmlentities (~> 4.3.4)
       image_size
@@ -72,32 +62,19 @@ GEM
       uuidtools
     htmlentities (4.3.4)
     httpclient (2.8.3)
-    iecbib (0.2.2)
-      addressable
-      iso-bib-item (~> 0.4.2)
-    ietfbib (0.4.6)
-      iso-bib-item (~> 0.4.2)
     iev (0.2.2)
       nokogiri
-    image_size (2.0.0)
-    iso-bib-item (0.4.5)
-      isoics (~> 0.1.6)
-      nokogiri (~> 1.8.4)
-      ruby_deep_clone (~> 0.8.0)
-    isobib (0.4.4)
-      algoliasearch
-      iecbib (~> 0.2.1)
-      iso-bib-item (~> 0.4.2)
-    isodoc (0.9.23)
+    image_size (2.0.1)
+    isodoc (0.10.0)
       asciimath
-      html2doc (~> 0.8.6)
+      html2doc (~> 0.8.11)
       htmlentities (~> 4.3.4)
       liquid
       metanorma (~> 0.3.0)
       nokogiri (>= 1)
       rake (~> 12.0)
       roman-numerals
-      sassc (~> 1.12.1)
+      sassc (~> 2)
       thread_safe
       uuidtools
     isoics (0.1.7)
@@ -117,8 +94,6 @@ GEM
     mime-types-data (3.2019.0331)
     mini_portile2 (2.3.0)
     nenv (0.3.0)
-    nistbib (0.1.3)
-      relaton-bib (~> 0.1.0)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     notiffany (0.1.1)
@@ -132,36 +107,64 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.3)
+    public_suffix (3.1.0)
     rainbow (3.0.0)
     rake (12.3.2)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton (0.3.4)
+    relaton (0.4.0)
+      algoliasearch
+      relaton-gb (~> 0.5.0)
+      relaton-iec (~> 0.3.0)
+      relaton-ietf (~> 0.5.0)
+      relaton-iso (~> 0.5.0)
+      relaton-iso-bib (~> 0.2.0)
+      relaton-itu (~> 0.2.0)
+      relaton-nist (~> 0.2.0)
+    relaton-bib (0.2.1)
+      addressable
+      nokogiri (~> 1.8.4)
+    relaton-cli (0.2.0)
+      liquid
+      relaton (~> 0.4)
+      thor
+    relaton-gb (0.5.0)
+      cnccs (~> 0.1.1)
+      gb-agencies (~> 0.0.1)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iec (0.3.0)
+      addressable
+      relaton-iso-bib (~> 0.2.0)
+    relaton-ietf (0.5.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iso (0.5.0)
       algoliasearch
-      gbbib (~> 0.4.0)
-      iecbib (~> 0.2.0)
-      ietfbib (~> 0.4.2)
-      iso-bib-item (~> 0.4.2)
-      isobib (~> 0.4.0)
-      nistbib (~> 0.1.1)
-    relaton-bib (0.1.1)
+      relaton-iec (~> 0.3.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iso-bib (0.2.1)
+      isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
+      relaton-bib (~> 0.2.0)
+      ruby_deep_clone (~> 0.8.0)
+    relaton-itu (0.2.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-nist (0.2.0)
+      relaton-bib (~> 0.2.0)
     roman-numerals (0.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     rubocop (0.54.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -171,18 +174,13 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-jing (0.0.1)
       optout (>= 0.0.2)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
     ruby_deep_clone (0.8.0)
     ruby_dep (1.5.0)
     safe_yaml (1.0.5)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    sassc (1.12.1)
-      ffi (~> 1.9.6)
-      sass (>= 3.3.0)
+    sassc (2.0.1)
+      ffi (~> 1.9)
+      rake
     shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -194,13 +192,14 @@ GEM
     thor (0.20.3)
     thread_safe (0.3.6)
     timecop (0.9.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.6.0)
     unicode2latex (0.0.2)
     uuidtools (2.1.5)
-    webmock (3.5.1)
+    vcr (5.0.0)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -218,7 +217,7 @@ DEPENDENCIES
   rubocop (= 0.54.0)
   simplecov (~> 0.15)
   timecop (~> 0.9)
-  vcr!
+  vcr (~> 5.0.0)
   webmock
 
 BUNDLED WITH

data/lib/asciidoctor/standoc/base.rb

@@ -5,7 +5,6 @@ require "json"
 require "pathname"
 require "open-uri"
 require "pp"
-require "sass"
 require "isodoc"
 require "relaton"
 require "fileutils"
@@ -106,15 +105,14 @@ module Asciidoctor
       end
 
       def init_bib_caches(node)
-        unless (@no_isobib_cache || @no_isobib)
-          globalname = global_bibliocache_name unless node.attr("local-cache-only")
-          localname = local_bibliocache_name(node.attr("local-cache") || node.attr("local-cache-only"))
-          if node.attr("flush-caches")
-            FileUtils.rm_f globalname unless globalname.nil?
-            FileUtils.rm_f localname unless localname.nil?
-          end
-        end        
-        @bibdb = Relaton::Db.new(globalname, localname) unless @no_isobib
+        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)
@@ -177,7 +175,7 @@ module Asciidoctor
       end
 
       def front(node, xml)
-        xml.bibdata **attr_code(type: doctype(node)) do |b|
+        xml.bibdata **attr_code(type: "standard") do |b|
           metadata node, b
         end
       end

data/lib/asciidoctor/standoc/biblio.rng

@@ -35,7 +35,28 @@
   </define>
   <define name="status">
     <element name="status">
-      <ref name="LocalizedString"/>
+      <ref name="stage"/>
+      <optional>
+        <ref name="substage"/>
+      </optional>
+      <optional>
+        <ref name="iteration"/>
+      </optional>
+    </element>
+  </define>
+  <define name="stage">
+    <element name="stage">
+      <text/>
+    </element>
+  </define>
+  <define name="substage">
+    <element name="substage">
+      <text/>
+    </element>
+  </define>
+  <define name="iteration">
+    <element name="iteration">
+      <text/>
     </element>
   </define>
   <define name="language">
@@ -523,9 +544,9 @@
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
-    <optional>
+    <zeroOrMore>
       <ref name="abstract"/>
-    </optional>
+    </zeroOrMore>
     <optional>
       <ref name="status"/>
     </optional>

data/lib/asciidoctor/standoc/blocks.rb

@@ -10,11 +10,17 @@ module Asciidoctor
         { id: Utils::anchor_or_uuid(node) }
       end
 
+      def id_unnum_attr(node)
+        attr_code( id: Utils::anchor_or_uuid(node),
+                  unnumbered: node.option?("unnumbered") ? "true" : nil )
+      end
+
       # open block is a container of multiple blocks,
       # treated as a single block.
       # We append each contained block to its parent
       def open(node)
-        Utils::reqt_subpart(node.attr("style")) and
+        role = node.role || node.attr("style")
+        Utils::reqt_subpart(role) and
           return requirement_subpart(node)
         result = []
         node.blocks.each do |b|
@@ -24,7 +30,7 @@ module Asciidoctor
       end
 
       def requirement_subpart(node)
-        name = node.attr("style")
+        name = node.role || node.attr("style")
         noko do |xml|
           xml.send name, **attr_code(exclude: node.option?("exclude"),
                                      type: node.attr("type")) do |o|
@@ -46,7 +52,7 @@ module Asciidoctor
       def stem(node)
         stem_content = node.lines.join("\n")
         noko do |xml|
-          xml.formula **id_attr(node) do |s|
+          xml.formula **id_unnum_attr(node) do |s|
             stem_parse(stem_content, s, node.style.to_sym)
           end
         end
@@ -144,11 +150,12 @@ module Asciidoctor
 
       def example(node)
         return term_example(node) if in_terms?
-        return requirement(node, "recommendation") if node.attr("style") == "recommendation"
-        return requirement(node, "requirement") if node.attr("style") == "requirement"
-        return requirement(node, "permission") if node.attr("style") == "permission"
+        role = node.role || node.attr("style")
+        return requirement(node, "recommendation") if role == "recommendation"
+        return requirement(node, "requirement") if role == "requirement"
+        return requirement(node, "permission") if role == "permission"
         noko do |xml|
-          xml.example **id_attr(node) do |ex|
+          xml.example **id_unnum_attr(node) do |ex|
             wrap_in_para(node, ex)
           end
         end.join("\n")
@@ -176,6 +183,7 @@ module Asciidoctor
       def reqt_attributes(node)
         {
           id: Utils::anchor_or_uuid,
+          unnumbered: node.option?("unnumbered") ? "true" : nil,
           obligation: node.attr("obligation"),
           filename: node.attr("filename")
         }
@@ -233,7 +241,7 @@ module Asciidoctor
 
       def image(node)
         noko do |xml|
-          xml.figure **id_attr(node) do |f|
+          xml.figure **id_unnum_attr(node) do |f|
             figure_title(node, f)
             f.image **attr_code(image_attributes(node))
           end

data/lib/asciidoctor/standoc/cleanup.rb

@@ -36,6 +36,7 @@ module Asciidoctor
         figure_cleanup(xmldoc)
         ref_cleanup(xmldoc)
         note_cleanup(xmldoc)
+        ref_dl_cleanup(xmldoc)
         normref_cleanup(xmldoc)
         biblio_cleanup(xmldoc)
         reference_names(xmldoc)

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -1,4 +1,5 @@
 require "set"
+require "relaton-cli"
 
 module Asciidoctor
   module Standoc
@@ -122,7 +123,7 @@ module Asciidoctor
       end
 
       # converts generic IEV citation to citation of IEC 60050-n
-      # assumes IEV citations are of form 
+      # 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)
@@ -159,6 +160,84 @@ module Asciidoctor
         parts = linksIev2iec60050part(xmldoc)
         refsIev2iec60050part(xmldoc, parts, iev)
       end
+
+      def ref_dl_cleanup(xmldoc)
+        xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
+          bib = dl_bib_extract(c) or next
+          b = Nokogiri::XML::Node.new('bibitem', xmldoc)
+          b["id"] = bib["ref"]&.strip
+          b["type"] = bib["doctype"]&.strip
+          b << %Q[<title format="text/plain">#{bib['title']}</title>]
+          #b << extract_from_p("docidentifier", bib, "docidentifier")
+
+          b << %Q[<docidentifier>#{bib['docidentifier']}</docidentifier>]
+
+          Array(bib["publisher"]).each do |name|
+            b << %Q[<contributor><role type="publisher"/><organization>
+          <name>#{name}</name>
+          </organization></contributor>]
+            #{extract_from_p("publisher", bib, "name")}
+          end
+
+          Array(bib["author"]).each do |name|
+            b << %Q[<contributor><role type="author"/><person>
+          <name><completename>#{name}</completename></name>
+          </person></contributor>]
+          end
+          c.replace(b)
+        end
+      end
+
+      def ref_dl_cleanup(xmldoc)
+        xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
+          bib = dl_bib_extract(c) or next
+          bibitemxml = Relaton::Bibdata.new(bib).to_xml or next
+          # TODO move this into relaton-cli
+          bibitem = Nokogiri::XML(bibitemxml)
+          bibitem.root.name = "bibitem"
+          bibitem.root["id"] = bib["ref"]&.strip
+          bibitem.root["type"] = bib["doctype"]&.strip
+          c.replace(bibitem.root)
+        end
+      end
+
+      def extract_from_p(tag, bib, key)
+        return unless bib[tag]
+        "<#{key}>#{bib[tag].at('p').children}</#{key}>"
+      end
+
+      # if the content is a single paragraph, replace it with its children
+      def p_unwrap(p)
+        elems = p.elements
+        if elems.size == 1 && elems[0].name == "p"
+          elems[0].children.to_xml
+        else
+          p.to_xml
+        end
+      end
+
+      def dd_bib_extract(dtd)
+        elems = dtd.remove.elements
+        return p_unwrap(dtd) unless elems.size == 1 && elems[0].name == "ol"
+        ret = []
+        elems[0].xpath("./li").each do |li|
+          ret << p_unwrap(li)
+        end
+        ret
+      end
+
+      # definition list, with at most one level of unordered lists
+      def dl_bib_extract(c)
+        dl = c.at("./dl") or return
+        bib = {}
+        key = ""
+        dl.xpath("./dt | ./dd").each do |dtd|
+          key = dtd.text if dtd.name == "dt"
+          bib[key] = dd_bib_extract(dtd) if dtd.name == "dd"
+        end
+        bib["title"] = c.at("./title").remove.children
+        bib
+      end
     end
   end
 end