metanorma-standoc 1.10.8 → 1.11.2

data/lib/asciidoctor/standoc/utils.rb

@@ -40,10 +40,9 @@ module Asciidoctor
       end
 
       def attr_code(attributes)
-        attributes = attributes.reject { |_, val| val.nil? }.map
-        attributes.map do |k, v|
-          [k, (v.is_a? String) ? HTMLEntities.new.decode(v) : v]
-        end.to_h
+        attributes.compact.transform_values do |v|
+          v.is_a?(String) ? HTMLEntities.new.decode(v) : v
+        end
       end
 
       # if the contents of node are blocks, output them to out;
@@ -56,7 +55,7 @@ module Asciidoctor
       end
 
       SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
-        "[not(ancestor::boilerplate)]".freeze
+                        "[not(ancestor::boilerplate)]".freeze
 
       def isodoc(lang, script, i18nyaml = nil)
         conv = html_converter(EmptyAttr.new)
@@ -67,29 +66,43 @@ module Asciidoctor
 
       def default_script(lang)
         case lang
-        when "ar", "fa"
-          "Arab"
-        when "ur"
-          "Aran"
-        when "ru", "bg"
-          "Cyrl"
-        when "hi"
-          "Deva"
-        when "el"
-          "Grek"
-        when "zh"
-          "Hans"
-        when "ko"
-          "Kore"
-        when "he"
-          "Hebr"
-        when "ja"
-          "Jpan"
+        when "ar", "fa" then "Arab"
+        when "ur" then "Aran"
+        when "ru", "bg" then "Cyrl"
+        when "hi" then "Deva"
+        when "el" then "Grek"
+        when "zh" then "Hans"
+        when "ko" then "Kore"
+        when "he" then "Hebr"
+        when "ja" then "Jpan"
         else
           "Latn"
         end
       end
 
+      def dl_to_attrs(elem, dlist, name)
+        e = dlist.at("./dt[text()='#{name}']") or return
+        val = e.at("./following::dd/p") || e.at("./following::dd") or return
+        elem[name] = val.text
+      end
+
+      def dl_to_elems(ins, elem, dlist, name)
+        a = elem.at("./#{name}[last()]")
+        ins = a if a
+        dlist.xpath("./dt[text()='#{name}']").each do |e|
+          v = e.at("./following::dd")
+          e = v.elements and e.size == 1 && e.first.name == "p" and v = e.first
+          v.name = name
+          ins.next = v
+          ins = ins.next
+        end
+        ins
+      end
+
+      def term_expr(elem)
+        "<expression><name>#{elem}</name></expression>"
+      end
+
       class EmptyAttr
         def attr(_any_attribute)
           nil

data/lib/asciidoctor/standoc/validate.rb

@@ -7,7 +7,7 @@ require "iev"
 module Asciidoctor
   module Standoc
     module Validate
-      SOURCELOCALITY = "./termsource/origin//locality[@type = 'clause']/"\
+      SOURCELOCALITY = "./origin//locality[@type = 'clause']/"\
                        "referenceFrom".freeze
 
       def init_iev
@@ -21,18 +21,25 @@ module Asciidoctor
       def iev_validate(xmldoc)
         @iev = init_iev or return
         xmldoc.xpath("//term").each do |t|
-          /^IEC 60050-/.match(t&.at("./termsource/origin/@citeas")&.text) &&
-            loc = t.xpath(SOURCELOCALITY)&.text or next
-          iev = @iev.fetch(loc, xmldoc&.at("//language")&.text || "en") or next
-          pref = t.xpath("./preferred").inject([]) do |m, x|
-            m << x&.text&.downcase
+          t.xpath(".//termsource").each do |src|
+            (/^IEC 60050-/.match(src&.at("./origin/@citeas")&.text) &&
+          loc = src.xpath(SOURCELOCALITY)&.text) or next
+            iev_validate1(t, loc, xmldoc)
           end
-          pref.include?(iev.downcase) or
-            @log.add("Bibliography", t, %(Term "#{pref[0]}" does not match ) +
-                     %(IEV #{loc} "#{iev}"))
         end
       end
 
+      def iev_validate1(term, loc, xmldoc)
+        iev = @iev.fetch(loc,
+                         xmldoc&.at("//language")&.text || "en") or return
+        pref = term.xpath("./preferred//name").inject([]) do |m, x|
+          m << x&.text&.downcase
+        end
+        pref.include?(iev.downcase) or
+          @log.add("Bibliography", term, %(Term "#{pref[0]}" does not match ) +
+                   %(IEV #{loc} "#{iev}"))
+      end
+
       def content_validate(doc)
         @fatalerror = []
         xref_validate(doc)
@@ -40,7 +47,8 @@ module Asciidoctor
         norm_ref_validate(doc)
         repeat_id_validate(doc.root)
         iev_validate(doc.root)
-        concept_validate(doc)
+        concept_validate(doc, "concept", "refterm")
+        concept_validate(doc, "related", "preferred//name")
         @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
       end
 
@@ -57,19 +65,20 @@ module Asciidoctor
         found and @fatalerror << "Numeric reference in normative references"
       end
 
-      def concept_validate(doc)
+      def concept_validate(doc, tag, refterm)
         found = false
-        doc.xpath("//concept/xref").each do |x|
+        doc.xpath("//#{tag}/xref").each do |x|
           next if doc.at("//term[@id = '#{x['target']}']")
           next if doc.at("//definitions//dt[@id = '#{x['target']}']")
 
-          ref = x&.at("../refterm")&.text
+          ref = x&.at("../#{refterm}")&.text
           @log.add("Anchors", x,
-                   "Concept #{ref} is pointing to "\
+                   "#{tag.capitalize} #{ref} is pointing to "\
                    "#{x['target']}, which is not a term or symbol")
           found = true
         end
-        found and @fatalerror << "Concept not cross-referencing term or symbol"
+        found and
+          @fatalerror << "#{tag.capitalize} not cross-referencing term or symbol"
       end
 
       def repeat_id_validate1(ids, elem)
@@ -103,7 +112,7 @@ module Asciidoctor
       def schema_validate1(file, doc, schema)
         file.write(doc.to_xml)
         file.close
-        errors = Jing.new(schema).validate(file.path)
+        errors = Jing.new(schema, encoding: "UTF-8").validate(file.path)
         warn "Syntax Valid!" if errors.none?
         errors.each do |e|
           @log.add("Metanorma XML Syntax",

data/lib/isodoc/html/htmlstyle.css

@@ -492,7 +492,7 @@ h3 {
   font-size: 1.1em;
   font-weight: 100; }
 
-.TermNum, .Terms, .AltTerms {
+.TermNum {
   color: #C70039;
   font-weight: 100; }
 

data/lib/isodoc/html/htmlstyle.scss

@@ -185,7 +185,7 @@ p.document-stage {
     font-weight: 100;
   }
 
-  .TermNum, .Terms, .AltTerms {
+  .TermNum {
     color: #C70039;
     font-weight: 100;
   }

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.10.8".freeze
+    VERSION = "1.11.2".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
-  spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "isodoc", "~> 1.7.0"
+  spec.add_dependency "iev", "~> 0.3.0"
+  spec.add_dependency "isodoc", "~> 1.8.0"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"
@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
 
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

data/spec/asciidoctor/base_spec.rb

@@ -959,14 +959,15 @@ QU1FOiB0ZXN0Cgo=
 
   it "process mn2pdf attributes" do
     node = Nokogiri::XML("<fake/>").at("fake")
-    node["mn2pdf-font-manifest-file"] = "passed/as/font/manifest/to/mn2pdf.jar"
+    node[Asciidoctor::Standoc::Base::FONTS_MANIFEST] =
+      "passed/as/font/manifest/to/mn2pdf.jar"
 
     options = Asciidoctor::Standoc::Converter
       .new(:standoc, header_footer: true)
       .doc_extract_attributes(node)
 
-    expect(options.dig(:mn2pdf, :font_manifest_file))
-      .to eq(node["mn2pdf-font-manifest-file"])
+    expect(options.dig(:mn2pdf, :font_manifest))
+      .to eq(node[Asciidoctor::Standoc::Base::FONTS_MANIFEST])
   end
 
   private

data/spec/asciidoctor/blocks_spec.rb

@@ -353,10 +353,11 @@ RSpec.describe Asciidoctor::Standoc do
              <title>Terms and definitions</title>
              <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
              <term id='term-term1'>
-               <preferred>Term1</preferred>
+               <preferred><expression><name>Term1</name></expression></preferred>
                <definition>
+                 <verbal-definition>
                  <p id='_'>first definition</p>
-                 <termsource status='identical'>
+                 <termsource status='identical' type="authoritative">
                    <origin bibitemid='ISO2191' type='inline' citeas=''>
                      <localityStack>
                        <locality type='section'>
@@ -365,10 +366,12 @@ RSpec.describe Asciidoctor::Standoc do
                      </localityStack>
                    </origin>
                  </termsource>
+                 </verbal-definition>
                </definition>
                <definition>
+               <verbal-definition>
                  <p id='_'>second definition</p>
-                 <termsource status='identical'>
+                 <termsource status='identical' type="authoritative">
                    <origin bibitemid='ISO2191' type='inline' citeas=''>
                      <localityStack>
                        <locality type='section'>
@@ -377,11 +380,12 @@ RSpec.describe Asciidoctor::Standoc do
                      </localityStack>
                    </origin>
                  </termsource>
+                 </verbal-definition>
                </definition>
                <termnote id='_'>
                  <p id='_'>This is a note</p>
                </termnote>
-               <termsource status='identical'>
+               <termsource status='identical' type="authoritative">
                  <origin bibitemid='ISO2191' type='inline' citeas=''>
                    <localityStack>
                      <locality type='section'>
@@ -420,7 +424,7 @@ RSpec.describe Asciidoctor::Standoc do
               <title>Terms and definitions</title>
               <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
               <term id="term-term1">
-              <preferred>Term1</preferred>
+              <preferred><expression><name>Term1</name></expression></preferred>
               <termnote id="_">
               <p id="_">This is a note</p>
             </termnote>
@@ -495,7 +499,7 @@ RSpec.describe Asciidoctor::Standoc do
         <terms id="_" obligation="normative"><title>Terms, definitions and symbols</title>
       <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
       <term id="term-term1">
-        <preferred>Term1</preferred>
+        <preferred><expression><name>Term1</name></expression></preferred>
       </term>
       <definitions id="_" obligation="normative" type="symbols">
         <title>Symbols</title>
@@ -510,6 +514,59 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "processes nested terms" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      [.term]
+      === Term1
+
+      definition
+
+      NOTE: Note 1
+
+      ==== Term11
+      definition2
+
+      NOTE: Note 2
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+                <sections>
+           <clause id='_' obligation='normative'>
+             <title>Terms and definitions</title>
+             <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
+             <terms id='_' obligation='normative'>
+               <title>Term1</title>
+               <p id='_'>definition</p>
+               <note id='_'>
+                 <p id='_'>Note 1</p>
+               </note>
+               <term id='term-term11'>
+                 <preferred>
+                   <expression>
+                     <name>Term11</name>
+                   </expression>
+                 </preferred>
+                 <definition>
+                   <verbal-definition>
+                     <p id='_'>definition2</p>
+                   </verbal-definition>
+                 </definition>
+                 <termnote id='_'>
+                   <p id='_'>Note 2</p>
+                 </termnote>
+               </term>
+             </terms>
+           </clause>
+         </sections>
+       </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes notes" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
@@ -653,7 +710,7 @@ RSpec.describe Asciidoctor::Standoc do
         <title>Terms and definitions</title>
       <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
         <term id="term-term1">
-        <preferred>Term1</preferred>
+        <preferred><expression><name>Term1</name></expression></preferred>
       <termexample id="ABC" tag='X' multilingual-rendering='common'>
         <p id="_">This is an example</p>
       </termexample></term>
@@ -713,7 +770,7 @@ RSpec.describe Asciidoctor::Standoc do
       <sections>
         <terms id="_" obligation="normative"><title>Terms, definitions and symbols</title>
       <p id="_">For the purposes of this document, the following terms and definitions apply.</p><term id="term-term1">
-        <preferred>Term1</preferred>
+        <preferred><expression><name>Term1</name></expression></preferred>
       </term>
       <definitions id="_" obligation="normative" type="symbols">
         <title>Symbols</title>
@@ -1010,6 +1067,50 @@ RSpec.describe Asciidoctor::Standoc do
     INPUT
     expect(strip_guid(Asciidoctor.convert(input, *OPTIONS)))
       .to include '<image src="data:image/png;base64'
+
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :data-uri-image: true
+
+      .Split-it-right sample divider
+      image::spec/examples/rice_images/rice_image1.png[]
+    INPUT
+    expect(strip_guid(Asciidoctor.convert(input, *OPTIONS)))
+      .to include '<image src="data:image/png;base64'
+
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :data-uri-image: false
+
+      .Split-it-right sample divider
+      image::spec/examples/rice_images/rice_image1.png[]
+    INPUT
+    expect(strip_guid(Asciidoctor.convert(input, *OPTIONS)))
+      .not_to include '<image src="data:image/png;base64'
+
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+
+      .Split-it-right sample divider
+      image::spec/examples/rice_images/rice_image1.png[]
+    INPUT
+    expect(strip_guid(Asciidoctor.convert(input, *OPTIONS)))
+      .to include '<image src="data:image/png;base64'
   end
 
   it "accepts attributes on paragraphs" do
@@ -1124,6 +1225,8 @@ RSpec.describe Asciidoctor::Standoc do
 
       === Term1
 
+      Definition 0
+
       [.source]
       <<ISO2191,section=1>>
 
@@ -1150,15 +1253,16 @@ RSpec.describe Asciidoctor::Standoc do
                <title>Terms and definitions</title><p id="_">For the purposes of this document,
              the following terms and definitions apply.</p>
                <term id="term-term1">
-               <preferred>Term1</preferred>
-               <termsource status="identical">
+               <preferred><expression><name>Term1</name></expression></preferred>
+               <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
+               <termsource status="identical" type="authoritative">
                <origin bibitemid="ISO2191" type="inline" citeas="">
                <localityStack>
               <locality type="section"><referenceFrom>1</referenceFrom></locality>
               </localityStack>
               </origin>
              </termsource>
-             <termsource status="identical">
+             <termsource status="identical" type="authoritative">
                <origin bibitemid="ISO2191" type="inline" citeas="" case='capital' droploc='true'>
                <localityStack>
               <locality type="section"><referenceFrom>1</referenceFrom></locality>
@@ -1167,21 +1271,23 @@ RSpec.describe Asciidoctor::Standoc do
              </termsource>
              </term>
              <term id='term-term2'>
-        <preferred>Term2</preferred>
+        <preferred><expression><name>Term2</name></expression></preferred>
         <definition>
+        <verbal-definition>
           <p id='_'>Definition</p>
+          </verbal-definition>
         </definition>
-        <termsource status='identical'>
+        <termsource status='identical' type="authoritative">
           <origin citeas=''>
             <termref base='IEV' target='xyz'/>
           </origin>
         </termsource>
-        <termsource status='identical'>
+        <termsource status='identical' type="authoritative">
           <origin citeas=''>
             <termref base='IEV' target='xyz'/>
           </origin>
         </termsource>
-        <termsource status='identical'>
+        <termsource status='identical' type="authoritative">
           <origin citeas=''>
             <termref base='IEV' target='xyz'/>
           </origin>
@@ -1202,6 +1308,8 @@ RSpec.describe Asciidoctor::Standoc do
 
       === Term1
 
+      Definition 0
+
       [.source]
       <<ISO2191,section=1>>, with adjustments
 
@@ -1220,8 +1328,9 @@ RSpec.describe Asciidoctor::Standoc do
                <p id="_">For the purposes of this document,
              the following terms and definitions apply.</p>
                <term id="term-term1">
-               <preferred>Term1</preferred>
-               <termsource status="modified">
+               <preferred><expression><name>Term1</name></expression></preferred>
+               <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
+               <termsource status="modified" type="authoritative">
                <origin bibitemid="ISO2191" type="inline" citeas="">
                <localityStack>
               <locality type="section"><referenceFrom>1</referenceFrom></locality>
@@ -1233,11 +1342,11 @@ RSpec.describe Asciidoctor::Standoc do
              </termsource>
              </term>
              <term id='term-term2'>
-        <preferred>Term2</preferred>
-        <definition>
+        <preferred><expression><name>Term2</name></expression></preferred>
+        <definition><verbal-definition>
           <p id='_'>Definition</p>
-        </definition>
-        <termsource status='modified'>
+        </verbal-definition></definition>
+        <termsource status='modified' type="authoritative">
           <origin citeas=''>
             <termref base='IEV' target='xyz'/>
           </origin>
@@ -1254,6 +1363,78 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+
+    it "processes term source attributes" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      === Term1
+
+      Definition 0
+
+      [.source,status=generalisation]
+      <<ISO2191,section=1>>, with adjustments
+
+      === Term2
+
+      Definition
+
+      [.source,type=lineage]
+      {{<<IEV:xyz>>}}, with adjustments
+    INPUT
+    output = <<~OUTPUT
+            #{BLANK_HDR}
+              <sections>
+    <terms id='_' obligation='normative'>
+      <title>Terms and definitions</title>
+      <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
+      <term id='term-term1'>
+        <preferred>
+          <expression>
+            <name>Term1</name>
+          </expression>
+        </preferred>
+        <definition><verbal-definition><p id='_'>Definition 0</p></verbal-definition></definition>
+        <termsource status='generalisation' type='authoritative'>
+          <origin bibitemid='ISO2191' type='inline' citeas=''>
+            <localityStack>
+              <locality type='section'>
+                <referenceFrom>1</referenceFrom>
+              </locality>
+            </localityStack>
+          </origin>
+          <modification>
+            <p id='_'>with adjustments</p>
+          </modification>
+        </termsource>
+      </term>
+      <term id='term-term2'>
+        <preferred>
+          <expression>
+            <name>Term2</name>
+          </expression>
+        </preferred>
+        <definition><verbal-definition>
+          <p id='_'>Definition</p>
+        </verbal-definition></definition>
+        <termsource status='modified' type='lineage'>
+          <origin citeas=''>
+            <termref base='IEV' target='xyz'/>
+          </origin>
+          <modification>
+            <p id='_'>with adjustments</p>
+          </modification>
+        </termsource>
+      </term>
+    </terms>
+  </sections>
+            </standard-document>
+OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes recommendation" do
     input = <<~"INPUT"
       #{ASCIIDOC_BLANK_HDR}

data/spec/asciidoctor/cleanup_sections_spec.rb

@@ -28,8 +28,8 @@ RSpec.describe Asciidoctor::Standoc do
         </li>
       </ul>
              <term id="term-time">
-             <preferred>Time</preferred>
-               <definition><p id="_">This paragraph is extraneous</p></definition>
+             <preferred><expression><name>Time</name></expression></preferred>
+               <definition><verbal-definition><p id="_">This paragraph is extraneous</p></verbal-definition></definition>
              </term></terms>
              </sections>
              </standard-document>
@@ -521,7 +521,7 @@ RSpec.describe Asciidoctor::Standoc do
                    </title>
                    <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
                    <term id='term-term1'>
-                     <preferred>Term1</preferred>
+                     <preferred><expression><name>Term1</name></expression></preferred>
                    </term>
                  </terms>
                  <clause id='_' inline-header='false' obligation='normative'>
@@ -796,7 +796,7 @@ RSpec.describe Asciidoctor::Standoc do
                     <title>Terms and definitions</title>
                     <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
                     <term id='term-term1'>
-                      <preferred>Term1</preferred>
+                      <preferred><expression><name>Term1</name></expression></preferred>
                     </term>
                   </terms>
                   <clause id='_' inline-header='false' obligation='normative'>
@@ -1033,7 +1033,7 @@ RSpec.describe Asciidoctor::Standoc do
                       s’appliquent.
                     </p>
                     <term id='term-term1'>
-                      <preferred>Term1</preferred>
+                      <preferred><expression><name>Term1</name></expression></preferred>
                     </term>
                   </terms>
                   <clause id='_' inline-header='false' obligation='normative'>
@@ -1267,7 +1267,7 @@ RSpec.describe Asciidoctor::Standoc do
                     <title>术语和定义</title>
                     <p id='_'>下列术语和定义适用于本文件。</p>
                     <term id='term-term1'>
-                      <preferred>Term1</preferred>
+                      <preferred><expression><name>Term1</name></expression></preferred>
                     </term>
                   </terms>
                   <clause id='_' inline-header='false' obligation='normative'>
@@ -1501,7 +1501,7 @@ RSpec.describe Asciidoctor::Standoc do
                     <title>Terms and definitions</title>
                     <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
                     <term id='term-term1'>
-                      <preferred>Term1</preferred>
+                      <preferred><expression><name>Term1</name></expression></preferred>
                     </term>
                   </terms>
                   <clause id='_' inline-header='false' obligation='normative'>