metanorma-itu 1.2.15 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb983ed512580a604a3c27ad83a232cebe458f4d5596a4a71f3dedfcb7810db
-  data.tar.gz: 2f75e990f258c04e5fc8415234b033c9f103bf3d359a2e545bf27b4cabf68877
+  metadata.gz: abe00a3be60da453e63ef90f89f6be09bbcd8219270d56f0f6fbdebe13a8c97c
+  data.tar.gz: 6fbdec84993231e9ebd5c715114233e87b76fe20ddaedc61aa1c7812049d1ee6
 SHA512:
-  metadata.gz: a209fa5be357695a99566411b459852154f5eafd065ce88f6b2bd8d6c32ce8a0720cd0ae1eca1c3881aa4a4590476cf135035804e6120445c2fdc22bd1fc451d
-  data.tar.gz: a8bc66759c3be7fe9e072c4e6947737781286c51930f766e314e69f53069c2292e6c505bbfc3e373a5c9c5f4b7c5ba46e5655bd23c45339616c7183bbd272757
+  metadata.gz: b365b22f8af65becbd4efed9d1307fc815d4ab5f030dfac299ea8d590de0831ebd26c8e1dd00d9317b43b25923bd103014f9c3ae10a2fbcfb5b72f19de323cdb
+  data.tar.gz: 5adbd13617676d55221644f2c4fd07ae62487bde807d48cea93ac2b9525261f6982e41da94da04dda4ba01cc9eeb08c75184cd9b619ce0e025200298a560173d

data/.gitignore

@@ -2,3 +2,5 @@
 .byebug_history
 .rspec_status
 coverage/
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,6 +1,12 @@
 # This project follows the Ribose OSS style guide.
 # https://github.com/riboseinc/oss-guides
 # All project-specific additions and overrides should be specified in this file.
-
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
+AllCops:
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4

data/lib/asciidoctor/itu/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -789,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">
@@ -1106,7 +1105,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

data/lib/asciidoctor/itu/cleanup.rb

@@ -24,12 +24,12 @@ module Asciidoctor
         end
       end
 
-      def insert_missing_sections(x)
-        insert_scope(x)
-        insert_norm_ref(x)
-        insert_terms(x)
-        insert_symbols(x)
-        insert_conventions(x)
+      def insert_missing_sections(xml)
+        insert_scope(xml)
+        insert_norm_ref(xml)
+        insert_terms(xml)
+        insert_symbols(xml)
+        insert_conventions(xml)
       end
 
       def add_id
@@ -109,8 +109,10 @@ module Asciidoctor
 
       def smartquotes_cleanup(xmldoc)
         return super if @smartquotes
+
         xmldoc.traverse do |n|
           next unless n.text?
+
           n.replace(HTMLEntities.new.encode(
             n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
             gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
@@ -175,6 +177,7 @@ module Asciidoctor
         return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
                            "@type = 'metanorma' or @type = 'ISSN' or @type = "\
                            "'ISBN')]")
+
         5
       end
 

data/lib/asciidoctor/itu/converter.rb

@@ -1,10 +1,9 @@
 require "asciidoctor"
 require "asciidoctor/standoc/converter"
 require "fileutils"
-require_relative "./front.rb"
-require_relative "./validate.rb"
-require_relative "./cleanup.rb"
-require_relative "./macros.rb"
+require_relative "./front"
+require_relative "./validate"
+require_relative "./cleanup"
 
 module Asciidoctor
   module ITU
@@ -17,12 +16,7 @@ module Asciidoctor
 
       register_for "itu"
 
-      Asciidoctor::Extensions.register do
-        inline_macro AddMacro
-        inline_macro DelMacro
-      end
-
-      def title_validate(root)
+      def title_validate(_root)
         nil
       end
 
@@ -54,14 +48,14 @@ module Asciidoctor
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", 
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter(node).convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", 
+        doc_converter(node).convert("#{@filename}.presentation.xml",
                                     nil, false, "#{@filename}.doc")
         node.attr("no-pdf") or
-          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+          pdf_converter(node)&.convert("#{@filename}.presentation.xml",
                                        nil, false, "#{@filename}.pdf")
       end
 
@@ -71,8 +65,8 @@ module Asciidoctor
                         File.join(File.dirname(__FILE__), "itu.rng"))
       end
 
-      def style(n, t)
-        return
+      def style(_node, _text)
+        nil
       end
 
       def sectiontype_streamline(ret)
@@ -90,15 +84,16 @@ module Asciidoctor
       def sectiontype(node, level = true)
         ret = super
         hdr = sectiontype_streamline(node&.attr("heading")&.downcase)
-        return nil if ret == "terms and definitions" && 
+        return nil if ret == "terms and definitions" &&
           hdr != "terms and definitions" && node.level > 1
-        return nil if ret == "symbols and abbreviated terms" && 
+        return nil if ret == "symbols and abbreviated terms" &&
           hdr != "symbols and abbreviated terms" && node.level > 1
+
         ret
       end
 
       def term_def_subclause_parse(attrs, xml, node)
-        case clausetype = sectiontype1(node)
+        case sectiontype1(node)
         when "terms defined in this recommendation"
           term_def_parse(attrs.merge(type: "internal"), xml, node, false)
         when "terms defined elsewhere"
@@ -110,29 +105,38 @@ module Asciidoctor
 
       def metadata_keywords(node, xml)
         return unless node.attr("keywords")
-        node.attr("keywords").split(/,[ ]*/).sort.each_with_index do |kw, i|
-          xml.keyword (i == 0 ? kw.capitalize : kw)
+
+        node.attr("keywords").split(/, */).sort.each_with_index do |kw, i|
+          xml.keyword (i.zero? ? strict_capitalize(kw) : kw)
         end
       end
 
+      def strict_capitalize(str)
+        letters = str.split("")
+        letters.first.upcase!
+        letters.join
+      end
+
       def clause_parse(attrs, xml, node)
         node.option?("unnumbered") and attrs[:unnumbered] = true
-        case clausetype = sectiontype1(node)
+        case sectiontype1(node)
         when "conventions" then attrs = attrs.merge(type: "conventions")
-        when "history" 
+        when "history"
           attrs[:preface] and attrs = attrs.merge(type: "history")
-        when "source" 
+        when "source"
           attrs[:preface] and attrs = attrs.merge(type: "source")
         end
         super
       end
 
       def html_extract_attributes(node)
-        super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
+        super.merge(hierarchical_assets:
+                    node.attr("hierarchical-object-numbering"))
       end
 
       def doc_extract_attributes(node)
-        super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
+        super.merge(hierarchical_assets:
+                    node.attr("hierarchical-object-numbering"))
       end
 
       def presentation_xml_converter(node)

data/lib/asciidoctor/itu/front.rb

@@ -6,21 +6,24 @@ module Asciidoctor
   module ITU
     class Converter < Standoc::Converter
       def metadata_status(node, xml)
+        stage = (node.attr("status") || node.attr("docstage") || "published")
+        stage = "draft" if node.attributes.has_key?("draft")
         xml.status do |s|
-          s.stage (node.attributes.has_key?("draft") ? "draft" :
-                   (node.attr("status") || node.attr("docstage") || "published" ))
+          s.stage stage
         end
       end
 
+      def title_attr(type, lang = "en")
+        { language: lang, format: "text/plain", type: type }
+      end
+
       def title_english(node, xml)
-        at = { language: "en", format: "text/plain", type: "main" }
         a = node.attr("title") || node.attr("title-en")
-        xml.title **attr_code(at) do |t|
+        xml.title **attr_code(title_attr("main")) do |t|
           t << (Metanorma::Utils::asciidoc_sub(a) || node.title)
         end
         if a = node.attr("annextitle") || node.attr("annextitle-en")
-          at[:type] = "annex"
-          xml.title **attr_code(at) do |t|
+          xml.title **attr_code(title_attr("annex")) do |t|
             t << Metanorma::Utils::asciidoc_sub(a)
           end
         end
@@ -30,8 +33,9 @@ module Asciidoctor
         node.attributes.each do |k, v|
           next unless /^(annex)?title-(?<lang>.+)$/ =~ k
           next if lang == "en"
-          type = /^annex/.match(k) ? "annex" : "main"
-          xml.title **attr_code(language: lang, format: "text/plain", type: type) do |t|
+
+          type = /^annex/.match?(k) ? "annex" : "main"
+          xml.title **attr_code(title_attr(type, lang)) do |t|
             t << Metanorma::Utils::asciidoc_sub(v)
           end
         end
@@ -40,15 +44,14 @@ module Asciidoctor
       def title(node, xml)
         super
         %w(subtitle amendment-title corrigendum-title).each do |t|
-        other_title_english(node, xml, t)
-        other_title_otherlangs(node, xml, t)
+          other_title_english(node, xml, t)
+          other_title_otherlangs(node, xml, t)
         end
       end
 
       def other_title_english(node, xml, type)
-        at = { language: "en", format: "text/plain", type: type.sub(/-title/, "") }
         a = node.attr(type) || node.attr("#{type}-en")
-        xml.title **attr_code(at) do |t|
+        xml.title **attr_code(title_attr(type.sub(/-title/, ""))) do |t|
           t << Metanorma::Utils::asciidoc_sub(a)
         end
       end
@@ -57,8 +60,9 @@ module Asciidoctor
         node.attributes.each do |k, v|
           next unless m = /^#{type}-(?<lang>.+)$/.match(k)
           next if m[:lang] == "en"
-          xml.title **attr_code(language: m[:lang], format: "text/plain",
-                                type: type.sub(/-title/, "")) do |t|
+
+          xml.title **attr_code(title_attr(type.sub(/-title/, ""),
+                                           m[:lang])) do |t|
             t << Metanorma::Utils::asciidoc_sub(v)
           end
         end
@@ -79,7 +83,7 @@ module Asciidoctor
 
       def metadata_committee1(node, xml, suffix)
         xml.editorialgroup do |a|
-          a.bureau ( node.attr("bureau#{suffix}") || "T" )
+          a.bureau ( node.attr("bureau#{suffix}") || "T")
           if node.attr("group#{suffix}")
             a.group **attr_code(type: node.attr("grouptype#{suffix}")) do |g|
               metadata_committee2(node, g, suffix, "")
@@ -119,27 +123,30 @@ module Asciidoctor
 
       def provisional_id(node, xml)
         return unless node.attr("provisional-name")
-        xml.docidentifier **{type: "ITU-provisional"} do |i|
+
+        xml.docidentifier **{ type: "ITU-provisional" } do |i|
           i << node.attr("provisional-name")
         end
       end
 
-      ITULANG = { "en" => "E", "fr" => "F", "ar" => "A", "es" => "S", "zh" => "C", "ru" => "R" }.freeze
+      ITULANG = { "en" => "E", "fr" => "F", "ar" => "A", "es" => "S",
+                  "zh" => "C", "ru" => "R" }.freeze
 
       def itu_id1(node, lang)
         bureau = node.attr("bureau") || "T"
         id = doctype(node) == "service-publication" ?
           @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber")) :
-          "ITU-#{bureau} #{node.attr("docnumber")}"
+          "ITU-#{bureau} #{node.attr('docnumber')}"
         id + (lang ? "-#{ITULANG[@lang]}" : "")
       end
 
       def itu_id(node, xml)
         return unless node.attr("docnumber")
-        xml.docidentifier **{type: "ITU"} do |i|
+
+        xml.docidentifier **{ type: "ITU" } do |i|
           i << itu_id1(node, false)
         end
-        xml.docidentifier **{type: "ITU-lang"} do |i|
+        xml.docidentifier **{ type: "ITU-lang" } do |i|
           i << itu_id1(node, true)
         end
         xml.docnumber { |i| i << node.attr("docnumber") }
@@ -147,8 +154,9 @@ module Asciidoctor
 
       def recommendation_id(node, xml)
         return unless node.attr("recommendationnumber")
+
         node.attr("recommendationnumber").split("/").each do |s|
-          xml.docidentifier **{type: "ITU-Recommendation"} do |i|
+          xml.docidentifier **{ type: "ITU-Recommendation" } do |i|
             i << s
           end
         end
@@ -171,11 +179,12 @@ module Asciidoctor
 
       def metadata_recommendationstatus(node, xml)
         return unless node.attr("recommendation-from")
+
         xml.recommendationstatus do |s|
           s.from node.attr("recommendation-from")
           s.to node.attr("recommendation-to") if node.attr("recommendation-to")
           if node.attr("approval-process")
-            s.approvalstage **{process: node.attr("approval-process")} do |a|
+            s.approvalstage **{ process: node.attr("approval-process") } do |a|
               a << node.attr("approval-status")
             end
           end
@@ -188,6 +197,7 @@ module Asciidoctor
 
       def structured_id(node, xml)
         return unless node.attr("docnumber")
+
         xml.structuredidentifier do |i|
           i.bureau node.attr("bureau") || "T"
           i.docnumber node.attr("docnumber")
@@ -198,7 +208,8 @@ module Asciidoctor
       end
 
       def metadata_techreport(node, xml)
-        a = node.attr("meeting") and metadata_meeting(a, node.attr("meeting-acronym"), xml)
+        a = node.attr("meeting") and
+          metadata_meeting(a, node.attr("meeting-acronym"), xml)
         a = node.attr("meeting-place") and xml.meeting_place a
         a = node.attr("meeting-date") and metadata_meeting_date(a, xml)
         a = node.attr("intended-type") and xml.intended_type a
@@ -233,6 +244,7 @@ module Asciidoctor
 
       def metadata_ext(node, xml)
         metadata_doctype(node, xml)
+        metadata_subdoctype(node, xml)
         metadata_committee(node, xml)
         metadata_ics(node, xml)
         metadata_recommendationstatus(node, xml)

data/lib/asciidoctor/itu/isodoc.rng

@@ -86,6 +86,35 @@
         <text/>
       </element>
     </define>
+    <define name="erefType">
+      <optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="citeas"/>
+      <attribute name="type">
+        <ref name="ReferenceFormat"/>
+      </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
+      <optional>
+        <attribute name="case">
+          <choice>
+            <value>capital</value>
+            <value>lowercase</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="droploc">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="CitationType"/>
+      <text/>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -775,6 +804,90 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="em">
+      <element name="em">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strong">
+      <element name="strong">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="tt">
+      <element name="tt">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="keyword">
+      <element name="keyword">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strike">
+      <element name="strike">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="underline">
+      <element name="underline">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="smallcap">
+      <element name="smallcap">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="pagebreak">
+      <element name="pagebreak">
+        <optional>
+          <attribute name="orientation">
+            <choice>
+              <value>landscape</value>
+              <value>portrait</value>
+            </choice>
+          </attribute>
+        </optional>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="colgroup">
@@ -793,7 +906,35 @@
     <value>internal</value>
   </define>
   <define name="TextElement" combine="choice">
-    <ref name="concept"/>
+    <choice>
+      <ref name="concept"/>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
   </define>
   <define name="concept">
     <element name="concept">
@@ -814,8 +955,170 @@
       <ref name="permission"/>
       <ref name="imagemap"/>
       <ref name="svgmap"/>
+      <ref name="inputform"/>
+    </choice>
+  </define>
+  <define name="inputform">
+    <element name="form">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="name"/>
+      <attribute name="action"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="TextElement"/>
+          <ref name="FormInput"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="FormInput">
+    <choice>
+      <ref name="input"/>
+      <ref name="formlabel"/>
+      <ref name="select"/>
+      <ref name="textarea"/>
+    </choice>
+  </define>
+  <define name="InputType">
+    <choice>
+      <value>button</value>
+      <value>checkbox</value>
+      <value>date</value>
+      <value>file</value>
+      <value>password</value>
+      <value>radio</value>
+      <value>submit</value>
+      <value>text</value>
     </choice>
   </define>
+  <define name="input">
+    <element name="input">
+      <attribute name="type">
+        <ref name="InputType"/>
+      </attribute>
+      <optional>
+        <attribute name="checked">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="readonly">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="maxlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="minlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
+  <define name="formlabel">
+    <element name="label">
+      <attribute name="for">
+        <data type="IDREF"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="select">
+    <element name="select">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="multiple">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="size">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="option"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="option">
+    <element name="option">
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="textarea">
+    <element name="textarea">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="rows">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="cols">
+          <data type="int"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
   <define name="bibliography">
     <element name="bibliography">
       <oneOrMore>
@@ -888,9 +1191,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>