metanorma-standoc 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3549faf588ef5ac25ac0f5fc7793fb1b8ec5f43b0e1cf6782c8db9858583b023
-  data.tar.gz: 191776185cad00c0691dab60a744a7d41cac34276b118d3440a4697e5f969043
+  metadata.gz: da7f659bff4d006bb019e303f8d6df764a6870e5ddf6b68d5a710fa160aae5dd
+  data.tar.gz: 65427fce326003810d75ca1fe4a004a117d9d6076f3c676930c8e286b140dd71
 SHA512:
-  metadata.gz: 44ae4a1c90f48a83a4d727d28534736d7c714a8abc3b6cf85f2eadab0c4834a8d47d61e852e1070301c50044677aeb774e74dc1eeb99b106d9e35ae7ce13d4c4
-  data.tar.gz: 698b0a2f29a7c4739234307995ef89da77185d1dd1d4da7511c8036f043f91a0d7ad6fc19eb2df9abf76fd31e712f2ea1a23a9136a1494c6749b3663aef40009
+  metadata.gz: '08993a10718efddd39418bb9af4018d55a9e6e0882d6d4cb39cbe8d0b274b4b419c9cb353e2f1606e4851d42b1e668cb8579c5a660bbd1ed651b32bd76823879'
+  data.tar.gz: aa26abdc106f10ea716c2bc98a811e5734cad920f70076dc392fb0ab2743e079cae42195483d81dc271494af8f60592fc7b9f16dfe28f6d39c03e4f6b63c8cb6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metanorma-standoc (1.3.0)
+    metanorma-standoc (1.3.1)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
       html2doc (~> 0.8.11)
@@ -16,8 +16,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     algoliasearch (1.26.1)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
@@ -65,13 +65,13 @@ GEM
     iev (0.2.2)
       nokogiri
     image_size (2.0.2)
-    isodoc (1.0.0)
+    isodoc (1.0.1)
       asciimath
       html2doc (~> 0.8.11)
       htmlentities (~> 4.3.4)
       liquid
       metanorma (~> 0.3.0)
-      nokogiri (>= 1)
+      nokogiri (>= 1.10.4)
       rake (~> 12.0)
       roman-numerals
       sassc (~> 2)
@@ -101,19 +101,19 @@ GEM
       shellany (~> 0.0)
     optout (0.0.2)
     parallel (1.17.0)
-    parser (2.6.3.0)
+    parser (2.6.4.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rainbow (3.0.0)
     rake (12.3.3)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton (0.5.2)
+    relaton (0.5.3)
       algoliasearch
       relaton-gb (~> 0.6.0)
       relaton-iec (~> 0.4.0)
@@ -124,18 +124,18 @@ GEM
     relaton-bib (0.3.5)
       addressable
       nokogiri (~> 1.10)
-    relaton-gb (0.6.1)
+    relaton-gb (0.6.2)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
       relaton-iso-bib (~> 0.3.0)
-    relaton-iec (0.4.2)
+    relaton-iec (0.4.3)
       addressable
       relaton-iso-bib (~> 0.3.0)
-    relaton-ietf (0.6.2)
+    relaton-ietf (0.6.3)
       relaton-bib (~> 0.3.0)
     relaton-iev (0.1.1)
       relaton (~> 0.5.0)
-    relaton-iso (0.6.3)
+    relaton-iso (0.6.4)
       relaton-iec (~> 0.4.0)
       relaton-iso-bib (~> 0.3.0)
     relaton-iso-bib (0.3.4)
@@ -144,7 +144,7 @@ GEM
       ruby_deep_clone (~> 0.8.0)
     relaton-itu (0.3.2)
       relaton-iso-bib (~> 0.3.0)
-    relaton-nist (0.3.2)
+    relaton-nist (0.3.3)
       relaton-bib (~> 0.3.0)
       rubyzip
     roman-numerals (0.3.0)
@@ -175,7 +175,7 @@ GEM
     ruby_dep (1.5.0)
     rubyzip (1.2.3)
     safe_yaml (1.0.5)
-    sassc (2.1.0)
+    sassc (2.2.0)
       ffi (~> 1.9)
     shellany (0.0.1)
     simplecov (0.17.0)
@@ -192,7 +192,7 @@ GEM
     unicode2latex (0.0.2)
     uuidtools (2.1.5)
     vcr (5.0.0)
-    webmock (3.6.2)
+    webmock (3.7.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/lib/asciidoctor/standoc/base.rb

@@ -101,6 +101,9 @@ module Asciidoctor
         @datauriimage = node.attr("data-uri-image")
         init_bib_caches(node)
         init_iev_caches(node)
+        lang = (node.attr("language") || "en")
+        script = (node.attr("script") || "en")
+        i18n_init(lang, script)
       end
 
       def init_bib_caches(node)

data/lib/asciidoctor/standoc/blocks.rb

@@ -29,16 +29,6 @@ module Asciidoctor
         result
       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|
-            o << node.content
-          end
-        end.join("\n")
-      end
-
       def literal(node)
         noko do |xml|
           xml.figure **id_attr(node) do |f|
@@ -161,48 +151,6 @@ module Asciidoctor
         end.join("\n")
       end
 
-      def req_classif_parse(classif)
-        ret = []
-        classif.split(/;\s*/).each do |c|
-          c1 = c.split(/:\s*/)
-          next unless c1.size == 2
-          c1[1].split(/,\s*/).each { |v| ret << [ c1[0], v ] }
-        end
-        ret
-      end
-
-      def requirement_classification(classif, ex)
-        req_classif_parse(classif).each do |r|
-          ex.classification do |c|
-            c.tag r[0]
-            c.value r[1]
-          end
-        end
-      end
-
-      def reqt_attributes(node)
-        {
-          id: Utils::anchor_or_uuid,
-          unnumbered: node.option?("unnumbered") ? "true" : nil,
-          obligation: node.attr("obligation"),
-          filename: node.attr("filename")
-        }
-      end
-
-      def requirement(node, obligation)
-        classif = node.attr("classification")
-        noko do |xml|
-          xml.send obligation, **attr_code(reqt_attributes(node)) do |ex|
-            ex.title node.title if node.title
-            ex.label node.attr("label") if node.attr("label")
-            ex.subject node.attr("subject") if node.attr("subject")
-            ex.inherit node.attr("inherit") if node.attr("inherit")
-            requirement_classification(classif, ex) if classif
-            wrap_in_para(node, ex)
-          end
-        end.join("\n")
-      end
-
       def preamble(node)
         noko do |xml|
           xml.foreword do |xml_abstract|
@@ -254,7 +202,6 @@ module Asciidoctor
         end.join("")
       end
 
-
       def paragraph(node)
         return termsource(node) if node.role == "source"
         attrs = { align: node.attr("align"),

data/lib/asciidoctor/standoc/cleanup.rb

@@ -7,6 +7,7 @@ require "pp"
 require_relative "./cleanup_block.rb"
 require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
+require_relative "./cleanup_boilerplate.rb"
 require "relaton_iev"
 
 module Asciidoctor
@@ -57,6 +58,7 @@ module Asciidoctor
         bookmark_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
         requirement_cleanup(xmldoc)
+        boilerplate_cleanup(xmldoc)
         xmldoc
       end
 

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -0,0 +1,66 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def external_terms_boilerplate(sources)
+        IsoDoc::Function::I18n::l10n(
+          @external_terms_boilerplate.gsub(/%/, sources || "???"),
+          @lang, @script)
+      end
+
+      def internal_external_terms_boilerplate(sources)
+        IsoDoc::Function::I18n::l10n(
+          @internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
+          @lang, @script)
+      end
+
+      def term_defs_boilerplate(div, source, term, preface, isodoc)
+        div.next = @term_def_boilerplate
+        source.each { |s| @anchors[s["bibitemid"]] or
+                      warn "term source #{s['bibitemid']} not referenced" }
+        if source.empty? && term.nil?
+          div.next = @no_terms_boilerplate
+        else
+          div.next = term_defs_boilerplate_cont(source, term, isodoc)
+        end
+      end
+
+      def term_defs_boilerplate_cont(src, term, isodoc)
+        sources = isodoc.sentence_join(src.map do |s|
+          %{<eref bibitem="#{s['bibitemid']}"/>}
+        end)
+        if src.empty? then @internal_terms_boilerplate
+        elsif term.nil? then external_terms_boilerplate(sources)
+        else
+          internal_external_terms_boilerplate(sources)
+        end
+      end
+
+      def norm_ref_preface(f)
+      refs = f.elements.select do |e|
+        ["reference", "bibitem"].include? e.name
+      end
+      f.at("./title").next =
+        "<p>#{(refs.empty? ? @norm_empty_pref : @norm_with_refs_pref)}</p>"
+    end
+
+      TERM_CLAUSE = "//sections/terms | "\
+        "//sections/clause[descendant::terms]".freeze
+
+      NORM_REF = "//bibliography/references[title = 'Normative References' or "\
+        "title = 'Normative references']".freeze
+
+      def boilerplate_cleanup(xmldoc)
+        isodoc = IsoDoc::Convert.new({})
+        @lang = xmldoc&.at("//bibdata/language")&.text
+        @script = xmldoc&.at("//bibdata/script")&.text
+        isodoc.i18n_init(@lang, @script)
+        f = xmldoc.at(self.class::TERM_CLAUSE) and
+          term_defs_boilerplate(f.at("./title"),
+                                xmldoc.xpath(".//termdocsource"),
+                                f.at(".//term"), f.at(".//p"), isodoc)
+        f = xmldoc.at(self.class::NORM_REF) and
+        norm_ref_preface(f)
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -116,8 +116,7 @@ module Asciidoctor
       end
 
       def normref_cleanup(xmldoc)
-        q = "//references[title = 'Normative References']"
-        r = xmldoc.at(q) || return
+        r = xmldoc.at(NORM_REF) || return
         r.elements.each do |n|
           n.remove unless ["title", "bibitem"].include? n.name
         end

data/lib/asciidoctor/standoc/converter.rb

@@ -11,6 +11,8 @@ require "asciidoctor/standoc/table"
 require "asciidoctor/standoc/validate"
 require "asciidoctor/standoc/utils"
 require "asciidoctor/standoc/cleanup"
+require "asciidoctor/standoc/i18n"
+require "asciidoctor/standoc/reqt"
 require_relative "./macros.rb"
 
 module Asciidoctor
@@ -29,6 +31,7 @@ module Asciidoctor
       include ::Asciidoctor::Standoc::Section
       include ::Asciidoctor::Standoc::Table
       include ::Asciidoctor::Standoc::Utils
+      include ::Asciidoctor::Standoc::I18n
       include ::Asciidoctor::Standoc::Cleanup
       include ::Asciidoctor::Standoc::Validate
 

data/lib/asciidoctor/standoc/front.rb

@@ -192,7 +192,7 @@ module Asciidoctor
       end
 
       def relation_normalise(type)
-        type.sub(/-by$/, "By").sub(/-of$/, "Of")
+        type.sub(/-by$/, "By").sub(/-of$/, "Of").sub(/-from$/, "From")
       end
 
       def metadata_getrelation(node, xml, type)

data/lib/asciidoctor/standoc/i18n.rb

@@ -0,0 +1,38 @@
+require "yaml"
+
+module Asciidoctor
+  module Standoc
+    module I18n
+        def load_yaml(lang, script)
+          if @i18nyaml then YAML.load_file(@i18nyaml)
+          elsif lang == "en"
+            YAML.load_file(File.join(File.dirname(__FILE__),
+                                     "../../asciidoctor-yaml/i18n-en.yaml"))
+          elsif lang == "fr"
+            YAML.load_file(File.join(File.dirname(__FILE__),
+                                     "../../asciidoctor-yaml/i18n-fr.yaml"))
+          elsif lang == "zh" && script == "Hans"
+            YAML.load_file(File.join(File.dirname(__FILE__),
+                                     "../../asciidoctor-yaml/i18n-zh-Hans.yaml"))
+          else
+            YAML.load_file(File.join(File.dirname(__FILE__),
+                                     "../../asciidoctor-yaml/i18n-en.yaml"))
+          end
+        end
+
+        def i18n_init(lang, script)
+          @lang = lang
+          @script = script
+          y = load_yaml(lang, script)
+          @term_def_boilerplate = y["term_def_boilerplate"] || ""
+          @no_terms_boilerplate = y["no_terms_boilerplate"] || ""
+          @internal_terms_boilerplate = y["internal_terms_boilerplate"] || ""
+          @norm_with_refs_pref = y["norm_with_refs_pref"] || ""
+          @norm_empty_pref = y["norm_empty_pref"] || ""
+          @external_terms_boilerplate = y["external_terms_boilerplate"] || ""
+          @internal_external_terms_boilerplate =
+            y["internal_external_terms_boilerplate"] || ""
+        end
+      end
+    end
+  end

data/lib/asciidoctor/standoc/reqt.rb

@@ -0,0 +1,62 @@
+require "htmlentities"
+require "uri"
+require "mime/types"
+require "base64"
+
+module Asciidoctor
+  module Standoc
+    module Blocks
+      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|
+            o << node.content
+          end
+        end.join("\n")
+      end
+
+      def req_classif_parse(classif)
+        ret = []
+        classif.split(/;\s*/).each do |c|
+          c1 = c.split(/:\s*/)
+          next unless c1.size == 2
+          c1[1].split(/,\s*/).each { |v| ret << [ c1[0], v ] }
+        end
+        ret
+      end
+
+      def requirement_classification(classif, ex)
+        req_classif_parse(classif).each do |r|
+          ex.classification do |c|
+            c.tag r[0]
+            c.value r[1]
+          end
+        end
+      end
+
+      def reqt_attributes(node)
+        {
+          id: Utils::anchor_or_uuid,
+          unnumbered: node.option?("unnumbered") ? "true" : nil,
+          obligation: node.attr("obligation"),
+          filename: node.attr("filename")
+        }
+      end
+
+      def requirement(node, obligation)
+        classif = node.attr("classification")
+        noko do |xml|
+          xml.send obligation, **attr_code(reqt_attributes(node)) do |ex|
+            ex.title node.title if node.title
+            ex.label node.attr("label") if node.attr("label")
+            ex.subject node.attr("subject") if node.attr("subject")
+            ex.inherit node.attr("inherit") if node.attr("inherit")
+            requirement_classification(classif, ex) if classif
+            wrap_in_para(node, ex)
+          end
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/asciidoctor-yaml/i18n-en.yaml

@@ -0,0 +1,20 @@
+term_def_boilerplate: 
+no_terms_boilerplate: |
+          <p>No terms and definitions are listed in this document.</p>
+internal_terms_boilerplate: |
+        <p>For the purposes of this document, 
+            the following terms and definitions apply.</p>
+norm_with_refs_pref: 
+      The following documents are referred to in the text in such a way
+      that some or all of their content constitutes requirements of this
+      document. For dated references, only the edition cited applies.
+      For undated references, the latest edition of the referenced
+      document (including any amendments) applies.
+norm_empty_pref: 
+          There are no normative references in this document.
+external_terms_boilerplate: |
+          <p>For the purposes of this document, 
+            the terms and definitions given in % apply.</p>
+internal_external_terms_boilerplate: |
+          <p>For the purposes of this document, the terms and definitions 
+            given in % and the following apply.</p>

data/lib/asciidoctor-yaml/i18n-fr.yaml

@@ -0,0 +1,13 @@
+term_def_boilerplate: 
+no_terms_boilerplate: |
+          <p>Aucun terme n'est defini dans le présent document.</p>
+internal_terms_boilerplate: |
+         <p>Pour les besoins du présent document, les termes et définitions suivants s'appliquent.</p>
+norm_with_refs_pref: 
+     Les documents suivants cités dans le texte constituent, pour tout ou partie de leur contenu, des exigences du présent document. Pour les références datées, seule l’édition citée s'applique. Pour les références non datées, la dernière édition du document de référence s'applique (y compris les éventuels amendements).
+norm_empty_pref: 
+          Le présent document ne contient aucune référence normative.
+external_terms_boilerplate: |
+          <p>Pour les besoins du présent document, les termes et définitions de % s'appliquent.</p>
+internal_external_terms_boilerplate: |
+          <p>Pour les besoins du présent document, les termes et définitions de % ainsi que les suivants, s'appliquent.</p>

data/lib/asciidoctor-yaml/i18n-zh-Hans.yaml

@@ -0,0 +1,15 @@
+term_def_boilerplate: 
+no_terms_boilerplate: |
+          <p>本文件不提供术语和定义。</p>
+internal_terms_boilerplate: |
+          <p>下列术语和定义适用于本文件。</p>
+norm_with_refs_pref: 
+          下列文件对于本文件的应用是必不可少的。
+          凡是注日期的引用文件，仅注日期的版本适用于本文件。
+          凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。
+norm_empty_pref: 
+          本文件并没有规范性引用文件。
+external_terms_boilerplate: |
+          <p>% 界定的术语和定义适用于本文件。</p>
+internal_external_terms_boilerplate: |
+          <p>% 界定的以及下列术语和定义适用于本文件。</p>

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-    VERSION = "1.3.0".freeze
+    VERSION = "1.3.1".freeze
   end
 end

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -315,6 +315,7 @@ RSpec.describe Asciidoctor::Standoc do
        <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
+         <p>For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
          <termnote id="_">
@@ -341,6 +342,7 @@ RSpec.describe Asciidoctor::Standoc do
               <sections>
   <terms id="_" obligation="normative">
   <title>Terms and definitions</title>
+         <p>No terms and definitions are listed in this document.</p>
   <clause id="_" inline-header="false" obligation="normative">
   <title>Term1</title>
   <note id="_">
@@ -367,7 +369,9 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
               #{BLANK_HDR}
               <sections>
-  <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><term id="_">
+  <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
+<p>For the purposes of this document, the following terms and definitions apply.</p>
+<term id="_">
   <preferred>Term1</preferred>
 </term>
 <definitions id="_">
@@ -493,6 +497,7 @@ RSpec.describe Asciidoctor::Standoc do
       <sections>
   <terms id="_" obligation="normative">
   <title>Terms and definitions</title>
+<p>For the purposes of this document, the following terms and definitions apply.</p>
   <term id="_">
   <preferred>Term1</preferred>
 
@@ -520,6 +525,7 @@ RSpec.describe Asciidoctor::Standoc do
 <sections> 
   <terms id="_" obligation="normative">  
   <title>Terms and definitions</title>  
+<p>No terms and definitions are listed in this document.</p>
   <clause id="_" inline-header="false" obligation="normative">   
   <title>Term1</title>   
   <example id="_">    
@@ -546,7 +552,8 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
               #{BLANK_HDR}
 <sections> 
-  <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><term id="_">   
+  <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
+<p>For the purposes of this document, the following terms and definitions apply.</p><term id="_">   
   <preferred>Term1</preferred>   
 </term>  
 <definitions id="_">   
@@ -806,7 +813,8 @@ RSpec.describe Asciidoctor::Standoc do
       #{BLANK_HDR}
        <sections>
          <terms id="_" obligation="normative">
-         <title>Terms and definitions</title>
+         <title>Terms and definitions</title><p>For the purposes of this document,
+       the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
          <termsource status="identical">
@@ -833,6 +841,8 @@ RSpec.describe Asciidoctor::Standoc do
             <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
+         <p>For the purposes of this document,
+       the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
          <termsource status="modified">