metanorma-iso 1.10.6 → 2.0.3

data/lib/metanorma/iso/validate_title.rb

@@ -0,0 +1,105 @@
+require "metanorma-standoc"
+
+module Metanorma
+  module ISO
+    class Converter < Standoc::Converter
+      def title_lang_part(doc, part, lang)
+        doc.at("//bibdata/title[@type='title-#{part}' and @language='#{lang}']")
+      end
+
+      def title_intro_validate(root)
+        title_intro_en = title_lang_part(root, "intro", "en")
+        title_intro_fr = title_lang_part(root, "intro", "fr")
+        if title_intro_en.nil? && !title_intro_fr.nil?
+          @log.add("Style", title_intro_fr, "No English Title Intro!")
+        end
+        if !title_intro_en.nil? && title_intro_fr.nil?
+          @log.add("Style", title_intro_en, "No French Title Intro!")
+        end
+      end
+
+      def title_main_validate(root)
+        title_main_en = title_lang_part(root, "main", "en")
+        title_main_fr = title_lang_part(root, "main", "fr")
+        if title_main_en.nil? && !title_main_fr.nil?
+          @log.add("Style", title_main_fr, "No English Title!")
+        end
+        if !title_main_en.nil? && title_main_fr.nil?
+          @log.add("Style", title_main_en, "No French Title!")
+        end
+      end
+
+      def title_part_validate(root)
+        title_part_en = title_lang_part(root, "part", "en")
+        title_part_fr = title_lang_part(root, "part", "fr")
+        (title_part_en.nil? && !title_part_fr.nil?) &&
+          @log.add("Style", title_part_fr, "No English Title Part!")
+        (!title_part_en.nil? && title_part_fr.nil?) &&
+          @log.add("Style", title_part_en, "No French Title Part!")
+      end
+
+      # ISO/IEC DIR 2, 11.4
+      def title_subpart_validate(root)
+        docid = root.at("//bibdata/docidentifier[@type = 'ISO']")
+        subpart = /-\d+-\d+/.match docid
+        iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
+                      "organization[abbreviation = 'IEC' or "\
+                      "name = 'International Electrotechnical Commission']")
+        subpart && !iec and
+          @log.add("Style", docid, "Subpart defined on non-IEC document!")
+      end
+
+      # ISO/IEC DIR 2, 11.5.2
+      def title_names_type_validate(root)
+        doctypes = /International\sStandard | Technical\sSpecification |
+        Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
+        title_main_en = title_lang_part(root, "main", "en")
+        !title_main_en.nil? && doctypes.match(title_main_en.text) and
+          @log.add("Style", title_main_en, "Main Title may name document type")
+        title_intro_en = title_lang_part(root, "intro", "en")
+        !title_intro_en.nil? && doctypes.match(title_intro_en.text) and
+          @log.add("Style", title_intro_en,
+                   "Title Intro may name document type")
+      end
+
+      # ISO/IEC DIR 2, 22.2
+      def title_first_level_validate(root)
+        root.xpath(SECTIONS_XPATH).each do |s|
+          title = s&.at("./title")&.text || s.name
+          s.xpath("./clause | ./terms | ./references").each do |ss|
+            subtitle = ss.at("./title")
+            !subtitle.nil? && !subtitle&.text&.empty? or
+              @log.add("Style", ss,
+                       "#{title}: each first-level subclause must have a title")
+          end
+        end
+      end
+
+      # ISO/IEC DIR 2, 22.2
+      def title_all_siblings(xpath, label)
+        notitle = false
+        withtitle = false
+        xpath.each do |s|
+          title_all_siblings(s.xpath("./clause | ./terms | ./references"),
+                             s&.at("./title")&.text || s["id"])
+          subtitle = s.at("./title")
+          notitle = notitle || (!subtitle || subtitle.text.empty?)
+          withtitle = withtitle || (subtitle && !subtitle.text.empty?)
+        end
+        notitle && withtitle &&
+          @log.add("Style", nil,
+                   "#{label}: all subclauses must have a title, or none")
+      end
+
+      def title_validate(root)
+        title_intro_validate(root)
+        title_main_validate(root)
+        title_part_validate(root)
+        title_subpart_validate(root)
+        title_names_type_validate(root)
+        title_first_level_validate(root)
+        title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
+      end
+    end
+  end
+end

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "1.10.6".freeze
+    VERSION = "2.0.3".freeze
   end
 end

data/lib/metanorma-iso.rb

@@ -1,5 +1,5 @@
 require "asciidoctor" unless defined? Asciidoctor::Converter
-require_relative "asciidoctor/iso/converter"
+require_relative "metanorma/iso/converter"
 require_relative "metanorma/iso/version"
 require_relative "isodoc/iso/html_convert"
 require_relative "isodoc/iso/word_convert"

data/metanorma-iso.gemspec

@@ -29,7 +29,7 @@ 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 "metanorma-standoc", "~> 1.11.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.0.0"
   spec.add_dependency "mnconvert", "~> 1.14"
   spec.add_dependency "ruby-jing"
   spec.add_dependency "tokenizer", "~> 0.3.0"

data/spec/isodoc/ref_spec.rb

@@ -272,6 +272,7 @@ RSpec.describe IsoDoc do
             </note>
             <bibitem id="ISO3696" type="standard">
               <title format="text/plain">Water for analytical laboratory use</title>
+              <docidentifier type='metanorma-ordinal'>[1]</docidentifier>
               <docidentifier type="ISO">ISO 3696</docidentifier>
               <contributor>
                 <role type="publisher"/>
@@ -294,6 +295,7 @@ RSpec.describe IsoDoc do
             </bibitem>
             <bibitem id="ref11">
               <title>Internet Calendaring and Scheduling Core Object Specification (iCalendar)</title>
+              <docidentifier type='metanorma-ordinal'>[2]</docidentifier>
               <docidentifier type="IETF">IETF RFC 10</docidentifier>
             </bibitem>
             <bibitem id="ref12">
@@ -361,7 +363,7 @@ RSpec.describe IsoDoc do
                 <p>
                   <span class="note_label">NOTE</span>&#160; This is another annotation of document ISSN.</p>
               </div>
-              <p class="Biblio" id="ISO3696">[3]&#160; ISO 3696,
+              <p class="Biblio" id="ISO3696">[1]&#160; ISO 3696,
                 <i>Water for analytical laboratory use</i></p>
               <p class="Biblio" id="ref10">[10]&#160; <span style="font-variant:small-caps;">Standard No I.C.C 167</span>
                  .
@@ -369,7 +371,7 @@ RSpec.describe IsoDoc do
                 (see
                 <a href="http://www.icc.or.at">http://www.icc.or.at</a>
                 )</p>
-              <p class="Biblio" id="ref11">[5]&#160; IETF RFC 10,
+              <p class="Biblio" id="ref11">[2]&#160; IETF RFC 10,
                 <i>Internet Calendaring and Scheduling Core Object Specification (iCalendar)</i></p>
               <p class="Biblio" id="ref12">Citn&#160; IETF RFC 20, CitationWorks. 2019.
                 <i>How to cite a reference</i>

data/spec/isodoc/xref_spec.rb

@@ -1373,7 +1373,7 @@ RSpec.describe IsoDoc do
             <title depth="1">1
               <tab/>
               Scope</title>
-            <ol id="N">
+            <ol id="N" type="alphabet">
               <li>
                 <p>A</p>
               </li>
@@ -1388,12 +1388,12 @@ RSpec.describe IsoDoc do
               Widgets</title>
             <clause id="widgets1" inline-header="true">
               <title>3.1</title>
-              <ol id="note1">
+              <ol id="note1" type="alphabet">
                 <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83f">These results are based on a study carried out on three different
                           types of kernel.
                         </p>
               </ol>
-              <ol id="note2">
+              <ol id="note2" type="alphabet">
                 <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83a">These results are based on a study carried out on three different
                           types of kernel.
                         </p>
@@ -1407,7 +1407,7 @@ RSpec.describe IsoDoc do
             <br/>(informative)</title>
           <clause id="annex1a" inline-header="true">
             <title>A.1</title>
-            <ol id="AN">
+            <ol id="AN" type="alphabet">
               <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83f">These results are based on a study carried out on three different
                         types of kernel.
                       </p>
@@ -1415,12 +1415,12 @@ RSpec.describe IsoDoc do
           </clause>
           <clause id="annex1b" inline-header="true">
             <title>A.2</title>
-            <ol id="Anote1">
+            <ol id="Anote1" type="alphabet">
               <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83f">These results are based on a study carried out on three different
                         types of kernel.
                       </p>
             </ol>
-            <ol id="Anote2">
+            <ol id="Anote2" type="alphabet">
               <p id="_f06fd0d1-a203-4f3d-a515-0bdba0f8d83a">These results are based on a study carried out on three different
                         types of kernel.
                       </p>
@@ -1513,7 +1513,7 @@ RSpec.describe IsoDoc do
         <sections>
           <clause id='scope' type='scope' displayorder='2'>
             <title depth='1'>1<tab/>Scope</title>
-            <ol id='N1'>
+            <ol id='N1' type="alphabet">
               <li id='N'>
                 <p>A</p>
               </li>
@@ -1523,12 +1523,12 @@ RSpec.describe IsoDoc do
           <clause id='widgets' displayorder='4'>
           <title depth='1'>3<tab/>Widgets</title>
             <clause inline-header="true" id='widgets1'><title>3.1</title>
-              <ol id='note1l'>
+              <ol id='note1l' type="alphabet">
                 <li id='note1'>
                   <p>A</p>
                 </li>
               </ol>
-              <ol id='note2l'>
+              <ol id='note2l' type="alphabet">
                 <li id='note2'>
                   <p>A</p>
                 </li>
@@ -1538,19 +1538,19 @@ RSpec.describe IsoDoc do
         </sections>
         <annex id='annex1'  displayorder='5'><title><strong>Annex A</strong><br/>(informative)</title>
           <clause inline-header="true" id='annex1a'><title>A.1</title>
-            <ol id='ANl'>
+            <ol id='ANl' type="alphabet">
               <li id='AN'>
                 <p>A</p>
               </li>
             </ol>
           </clause>
           <clause inline-header="true" id='annex1b'><title>A.2</title>
-            <ol id='Anote1l'>
+            <ol id='Anote1l' type="alphabet">
               <li id='Anote1'>
                 <p>A</p>
               </li>
             </ol>
-            <ol id='Anote2l'>
+            <ol id='Anote2l' type="alphabet">
               <li id='Anote2'>
                 <p>A</p>
               </li>
@@ -1633,22 +1633,22 @@ RSpec.describe IsoDoc do
         <sections>
           <clause id='scope' type='scope' displayorder='2'>
             <title depth='1'>1<tab/>Scope</title>
-            <ol id='N1'>
+            <ol id='N1' type="alphabet">
               <li id='N'>
                 <p>A</p>
-                <ol>
+                <ol type="arabic">
                   <li id='note1'>
                     <p>A</p>
-                    <ol>
+                    <ol type="roman">
                       <li id='note2'>
                         <p>A</p>
-                        <ol>
+                        <ol type="alphabet_upper">
                           <li id='AN'>
                             <p>A</p>
-                            <ol>
+                            <ol type="roman_upper">
                               <li id='Anote1'>
                                 <p>A</p>
-                                <ol>
+                                <ol type="alphabet">
                                   <li id='Anote2'>
                                     <p>A</p>
                                   </li>

data/spec/{asciidoctor → metanorma}/amd_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe Asciidoctor::ISO do
+RSpec.describe Metanorma::ISO do
   it "processes amendment sections" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", *OPTIONS)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{AMD_BLANK_HDR}