metanorma-iso 1.8.5 → 1.9.1

data/lib/isodoc/iso/isosts_convert.rb

@@ -1,31 +1,30 @@
 require "isodoc"
-require "mn2sts"
+require "mnconvert"
 
 module IsoDoc
   module Iso
-
     # A {Converter} implementation that generates HTML output, and a document
     # schema encapsulation of the document for validation
     #
     class IsoStsConvert < IsoDoc::XslfoPdfConvert
-      def initialize(options)
+      def initialize(_options)
         @libdir = File.dirname(__FILE__)
         @format = :isosts
         @suffix = "isosts.xml"
       end
 
-      def convert(input_filename, file = nil, debug = false, output_filename = nil)
-        file = File.read(input_filename, encoding: "utf-8") if file.nil?
-        docxml, filename, dir = convert_init(file, input_filename, debug)
-        /\.xml$/.match(input_filename) or
-          input_filename = Tempfile.open([filename, ".xml"], encoding: "utf-8") do |f|
-          f.write file
-          f.path
-        end
+      def convert(input_fname, file = nil, debug = false, output_fname = nil)
+        file = File.read(input_fname, encoding: "utf-8") if file.nil?
+        _, fname, dir = convert_init(file, input_fname, debug)
+        /\.xml$/.match(input_fname) or
+          input_fname = Tempfile.open([fname, ".xml"], encoding: "utf-8") do |f|
+            f.write file
+            f.path
+          end
         FileUtils.rm_rf dir
-        Mn2sts.convert(input_filename, output_filename || "#{filename}.#{@suffix}", iso: true)
+        MnConvert.convert(input_fname, output_fname || "#{fname}.#{@suffix}",
+                          MnConvert::InputFormat::MN, { output_format: :iso })
       end
     end
   end
 end
-

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -45,7 +45,7 @@ module IsoDoc
         prefix_name(node, " — ", lbl, "name")
       end
 
-      def eref_localities1_zh(target, type, from, to, n, delim)
+      def eref_localities1_zh(target, type, from, upto, node, delim)
         subsection = from&.text&.match(/\./)
         ret = if delim == ";"
                 ";"
@@ -53,32 +53,31 @@ module IsoDoc
                 type == "list" ? "" : delim
               end
         ret += " 第#{from.text}" if from
-        ret += "–#{to.text}" if to
+        ret += "–#{upto.text}" if upto
         loc = (@i18n.locality[type] || type.sub(/^locality:/, "").capitalize)
         ret += " #{loc}" unless subsection && type == "clause" ||
           type == "list" || target.match(/^IEV$|^IEC 60050-/) ||
-          n["droploc"] == "true"
+          node["droploc"] == "true"
         ret += ")" if type == "list"
         ret
       end
 
-      def eref_localities1(target, type, from, to, delim, n, lang = "en")
+      def eref_localities1(target, type, from, upto, delim, node, lang = "en")
         return "" if type == "anchor"
 
         subsection = from&.text&.match(/\./)
         type = type.downcase
         lang == "zh" and
-          return l10n(eref_localities1_zh(target, type, from, to, n, delim))
-        ret = if delim == ";"
-                ";"
+          return l10n(eref_localities1_zh(target, type, from, upto, node, delim))
+        ret = if delim == ";" then ";"
               else
                 type == "list" ? "" : delim
               end
-        ret += eref_locality_populate(type, n) unless subsection &&
+        ret += eref_locality_populate(type, node) unless subsection &&
           type == "clause" || type == "list" ||
           target.match(/^IEV$|^IEC 60050-/)
         ret += " #{from.text}" if from
-        ret += "–#{to.text}" if to
+        ret += "–#{upto.text}" if upto
         ret += ")" if type == "list"
         l10n(ret)
       end
@@ -113,6 +112,60 @@ module IsoDoc
         end
       end
 
+      def concept(docxml)
+        docxml.xpath(ns("//terms//concept")).each_with_object({}) do |f, m|
+          concept_term(f, m)
+        end
+        docxml.xpath(ns("//concept")).each do |node|
+          concept_render(node, node["ital"] || "false", node["ref"] || "false")
+        end
+      end
+
+      def concept_term(node, seen)
+        term = node&.at(ns("./refterm"))&.to_xml
+        if term && seen[term]
+          concept_render(node, node["ital"] || "false", node["ref"] || "false")
+        else concept_render(node, node["ital"] || "true", node["ref"] || "true")
+        end
+        seen[term] = true if term
+        seen
+      end
+
+      def concept1_ref(node, ref)
+        if r = node.at(ns("./xref | ./eref | ./termref"))
+          return r.remove if ref == "false"
+
+          r.name == "termref" and
+            r.replace(@i18n.term_defined_in.sub(/%/, r.to_xml)) or
+            r.replace("(#{r.to_xml})")
+        end
+      end
+
+      def concept1(node)
+        node.replace(node&.at(ns("./renderterm"))&.children ||
+                     node&.at(ns("./refterm"))&.children ||
+                     node.children)
+      end
+
+      # we're assuming terms and clauses in the right place for display,
+      # to cope with multiple terms sections
+
+      def display_order(docxml)
+        i = 0
+        i = display_order_xpath(docxml, "//preface/*", i)
+        i = display_order_at(docxml, "//clause[@type = 'scope']", i)
+        i = display_order_at(docxml, @xrefs.klass.norm_ref_xpath, i)
+        # i = display_order_at(docxml, "//sections/terms | "\
+        # "//sections/clause[descendant::terms]", i)
+        # i = display_order_at(docxml, "//sections/definitions", i)
+        # i = display_order_xpath(docxml, @xrefs.klass.middle_clause(docxml), i)
+        i = display_order_xpath(docxml, "//sections/clause[not(@type = 'scope')] | "\
+                                "//sections/terms | //sections/definitions", i)
+        i = display_order_xpath(docxml, "//annex", i)
+        i = display_order_xpath(docxml, @xrefs.klass.bibliography_xpath, i)
+        display_order_xpath(docxml, "//indexsect", i)
+      end
+
       include Init
     end
   end

data/lib/isodoc/iso/sts_convert.rb

@@ -1,9 +1,8 @@
 require "isodoc"
-require "mn2sts"
+require "mnconvert"
 
 module IsoDoc
   module Iso
-
     class StsConvert < IsoDoc::XslfoPdfConvert
       def initialize(_options) # rubocop:disable Lint/MissingSuper
         @libdir = File.dirname(__FILE__)
@@ -14,14 +13,14 @@ module IsoDoc
       def convert(in_fname, file = nil, debug = false, out_fname = nil)
         file = File.read(in_fname, encoding: "utf-8") if file.nil?
         _docxml, filename, dir = convert_init(file, in_fname, debug)
-        unless /\.xml$/.match?(in_fname)
+        /\.xml$/.match?(in_fname) or
           in_fname = Tempfile.open([filename, ".xml"], encoding: "utf-8") do |f|
             f.write file
             f.path
           end
-        end
         FileUtils.rm_rf dir
-        Mn2sts.convert(in_fname, out_fname || "#{filename}.#{@suffix}")
+        MnConvert.convert(in_fname, out_fname || "#{filename}.#{@suffix}",
+                          MnConvert::InputFormat::MN)
       end
     end
   end

data/lib/isodoc/iso/xref.rb

@@ -8,7 +8,7 @@ module IsoDoc
         if @klass.amd(doc)
           initial_anchor_names_amd(doc)
         else
-          super
+          initial_anchor_names1(doc)
         end
         introduction_names(doc.at(ns("//introduction")))
       end
@@ -26,6 +26,22 @@ module IsoDoc
         termexample_anchor_names(doc)
       end
 
+      def initial_anchor_names1(doc)
+        doc.xpath(ns("//preface/*")).each { |c| c.element? and preface_names(c) }
+        # potentially overridden in middle_section_asset_names()
+        sequential_asset_names(doc.xpath(ns("//preface/*")))
+        n = Counter.new
+        n = section_names(doc.at(ns("//clause[@type = 'scope']")), n, 1)
+        n = section_names(doc.at(ns(@klass.norm_ref_xpath)), n, 1)
+        doc.xpath(ns("//sections/clause[not(@type = 'scope')] | "\
+                     "//sections/terms | //sections/definitions")).each do |c|
+          n = section_names(c, n, 1)
+        end
+        middle_section_asset_names(doc)
+        termnote_anchor_names(doc)
+        termexample_anchor_names(doc)
+      end
+
       # we can reference 0-number clauses in introduction
       def introduction_names(clause)
         return if clause.nil?

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "1.8.5".freeze
+    VERSION = "1.9.1".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -29,9 +29,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.add_dependency "isodoc", "~> 1.6.2"
-  spec.add_dependency "metanorma-standoc", "~> 1.9.0"
-  spec.add_dependency "mn2sts", "~> 1.8.0"
+  spec.add_dependency "isodoc", "~> 1.7.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.10.0"
+  spec.add_dependency "mnconvert", "~> 1.8.0"
   spec.add_dependency "ruby-jing"
   spec.add_dependency "tokenizer", "~> 0.3.0"
   spec.add_dependency "twitter_cldr"

data/spec/asciidoctor/blocks_spec.rb

@@ -48,11 +48,11 @@ RSpec.describe Asciidoctor::ISO do
                 <mi>r</mi>
                 <mo>=</mo>
                 <mn>1</mn>
-                <mi>%</mi>
+                <mo>%</mo>
                 <mi>r</mi>
                 <mo>=</mo>
                 <mn>1</mn>
-                <mi>%</mi>
+                <mo>%</mo>
               </math>
             </stem>
           </formula>

data/spec/asciidoctor/cleanup_spec.rb

@@ -230,11 +230,11 @@ RSpec.describe Asciidoctor::ISO do
                 <mi>r</mi>
                 <mo>=</mo>
                 <mn>1</mn>
-                <mi>%</mi>
+                <mo>%</mo>
                 <mi>r</mi>
                 <mo>=</mo>
                 <mn>1</mn>
-                <mi>%</mi>
+                <mo>%</mo>
               </math>
             </stem>
             <note id="_">

data/spec/asciidoctor/section_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 RSpec.describe Asciidoctor::ISO do
   it "processes sections" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       == Foreword
 
@@ -56,6 +56,7 @@ RSpec.describe Asciidoctor::ISO do
 
       === Bibliography Subsection
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR}
         <preface>
           <foreword id="_" obligation="informative">
@@ -151,10 +152,12 @@ RSpec.describe Asciidoctor::ISO do
         </bibliography>
       </iso-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes section obligations" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       [obligation=informative]
       == Clause 1
@@ -167,6 +170,7 @@ RSpec.describe Asciidoctor::ISO do
       [appendix,obligation=informative]
       == Annex
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR}
         <sections>
           <clause id="_" inline-header="false" obligation="informative">
@@ -184,10 +188,12 @@ RSpec.describe Asciidoctor::ISO do
         </annex>
       </iso-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes inline headers" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       == Clause 1
 
@@ -200,6 +206,7 @@ RSpec.describe Asciidoctor::ISO do
       [%inline-header]
       === Clause Aa
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR}
         <sections>
           <clause id="_" inline-header="false" obligation="normative">
@@ -217,16 +224,19 @@ RSpec.describe Asciidoctor::ISO do
         </annex>
       </iso-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes blank headers" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
       == Clause 1
 
       === {blank}
 
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR}
         <sections>
           <clause id="_" inline-header="false" obligation="normative">
@@ -236,10 +246,12 @@ RSpec.describe Asciidoctor::ISO do
         </sections>
       </iso-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes terms & definitions with external source" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
       Foreword
@@ -250,6 +262,7 @@ RSpec.describe Asciidoctor::ISO do
       === Term1
 
     INPUT
+    output = <<~OUTPUT
         #{BLANK_HDR.sub(/<boilerplate>/, '<termdocsource bibitemid="iso1234"/><termdocsource bibitemid="iso5678"/><boilerplate>')}
         <preface>
           <foreword id="_" obligation="informative">
@@ -285,10 +298,12 @@ RSpec.describe Asciidoctor::ISO do
         </sections>
       </iso-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes empty terms & definitions" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
       Foreword
@@ -297,6 +312,7 @@ RSpec.describe Asciidoctor::ISO do
 
 
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR}
         <preface>
           <foreword id="_" obligation="informative">
@@ -331,10 +347,12 @@ RSpec.describe Asciidoctor::ISO do
       </iso-standard>
 
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "processes empty terms & definitions with external source" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
       Foreword
@@ -343,6 +361,7 @@ RSpec.describe Asciidoctor::ISO do
       == Terms and Definitions
 
     INPUT
+    output = <<~OUTPUT
       #{BLANK_HDR.sub(/<boilerplate>/, '<termdocsource bibitemid="iso1234"/><termdocsource bibitemid="iso5678"/><boilerplate>')}
         <preface>
           <foreword id="_" obligation="informative">
@@ -375,5 +394,107 @@ RSpec.describe Asciidoctor::ISO do
         </sections>
       </iso-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "ignores multiple terms & definitions in default documents" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Terms and Definitions
+
+      == Clause
+
+      [heading=terms and definitions]
+      == More terms
+
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+               <sections>
+           <terms id='_' obligation='normative'>
+             <title>Terms and definitions</title>
+             <p id='_'>No terms and definitions are listed in this document.</p>
+             <p id='_'>
+               ISO and IEC maintain terminological databases for use in standardization
+               at the following addresses:
+             </p>
+             <ul id='_'>
+               <li>
+                 <p id='_'>
+                   ISO Online browsing platform: available at
+                   <link target='http://www.iso.org/obp'/>
+                 </p>
+               </li>
+               <li>
+                 <p id='_'>
+                   IEC Electropedia: available at
+                   <link target='http://www.electropedia.org'/>
+                 </p>
+               </li>
+             </ul>
+           </terms>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+           </clause>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>More terms</title>
+           </clause>
+         </sections>
+       </iso-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "permits multiple terms & definitions in vocabulary documents" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR.sub(/:nodoc:/, ":nodoc:\n:docsubtype: vocabulary")}
+
+      == Terms and Definitions
+
+      == Clause
+
+      [heading=terms and definitions]
+      == More terms
+
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR.sub(%r{<doctype>article</doctype>}, "<doctype>article</doctype><subdoctype>vocabulary</subdoctype>")}
+               <sections>
+           <terms id='_' obligation='normative'>
+             <title>Terms and definitions</title>
+             <p id='_'>No terms and definitions are listed in this document.</p>
+             <p id='_'>
+               ISO and IEC maintain terminological databases for use in standardization
+               at the following addresses:
+             </p>
+             <ul id='_'>
+               <li>
+                 <p id='_'>
+                   ISO Online browsing platform: available at
+                   <link target='http://www.iso.org/obp'/>
+                 </p>
+               </li>
+               <li>
+                 <p id='_'>
+                   IEC Electropedia: available at
+                   <link target='http://www.electropedia.org'/>
+                 </p>
+               </li>
+             </ul>
+           </terms>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+           </clause>
+           <terms id='_' obligation='normative'>
+             <title>More terms</title>
+           </terms>
+         </sections>
+       </iso-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
   end
 end