metanorma-itu 1.3.9 → 1.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12737ac0ba4d8fd85515b4c370ccab8fe12d1ab51f3c5fedcec3c42e72dbd925
-  data.tar.gz: d8994b2ddb5d16f89c52a61d6f4eb273149febc6789dfc1df9a65cfcafeee1a0
+  metadata.gz: 0da762646b3253c450a7c952b40b3c71a6f30ba371831b617167e2ea5ae8813c
+  data.tar.gz: daf355300a1de0a3c3a2920b9d5bcf52eb934890e29b33ef407263104ca6be97
 SHA512:
-  metadata.gz: f185faea621b1a4c0ed692c4683b15a14fe8b5ca5aaddd173b16db1d6d61eb9cbf355de886cbdcf90acb97a4cacb2178a9842f6c8d0d83c66e10310fd6bb6d03
-  data.tar.gz: d9b414079f9642a01ef663bc8f86c9770cc7031ec813dd4d4f5505532a2cdf6699be23ff3e1b7a7952967d72517e2ca199bc8f532fc10b659a39da96503a00f7
+  metadata.gz: 7227280e92249dd3dbc8b6c3fb566b709e3fde581b9d9a96d961b04081c76109f55380e14a90cbd812939caabc7c9ac861428ed3c308cb0e3612902e2cf6105a
+  data.tar.gz: 1009519227cf310c3c187c0f7c5536752098ca50e2a5f814712af1694bb56bddab71cd4a67aec589c46fbebc6a91504ac0c8719860af4ca4dd6c136e8d89b2f7

data/Gemfile

@@ -6,6 +6,6 @@ git_source(:github) { |repo| "https://github.com/#{repo}" }
 
 gemspec
 
-if File.exist? 'Gemfile.devel'
-  eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
+if File.exist? "Gemfile.devel"
+  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
 end

data/Rakefile

@@ -1,8 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'isodoc/gem_tasks'
+require "isodoc/gem_tasks"
 
 IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-  
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and
@@ -15,4 +15,3 @@ require "rubygems"
 require "bundler/setup"
 
 load Gem.bin_path("rspec-core", "rspec")
-

data/lib/asciidoctor/itu/basicdoc.rng

@@ -624,6 +624,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -634,6 +637,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -641,7 +647,12 @@
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -822,7 +833,9 @@
       <attribute name="alt"/>
     </optional>
     <ref name="CitationType"/>
-    <text/>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
   </define>
   <define name="hyperlink">
     <element name="link">
@@ -835,7 +848,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="xref">
@@ -849,7 +864,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="fn">

data/lib/asciidoctor/itu/cleanup.rb

@@ -1,17 +1,19 @@
 module Asciidoctor
   module ITU
     class Converter < Standoc::Converter
-      def sections_cleanup(x)
+      def sections_cleanup(xml)
         super
-        insert_missing_sections(x) unless @no_insert_missing_sections
-        insert_empty_clauses(x)
-        resolution_inline_header(x)
+        insert_missing_sections(xml) unless @no_insert_missing_sections
+        insert_empty_clauses(xml)
+        resolution_inline_header(xml)
       end
 
-      def resolution_inline_header(x)
-        return unless x&.at("//bibdata/ext/doctype")&.text == "resolution"
-        x.xpath("//clause//clause").each do |c|
-          next if title = c.at("./title") and !title&.text&.empty?
+      def resolution_inline_header(xml)
+        return unless xml&.at("//bibdata/ext/doctype")&.text == "resolution"
+
+        xml.xpath("//clause//clause").each do |c|
+          next if (title = c.at("./title")) && !title&.text&.empty?
+
           c["inline-header"] = true
         end
       end
@@ -36,67 +38,67 @@ module Asciidoctor
         %(id="_#{UUIDTools::UUID.random_create}")
       end
 
-      def insert_scope(x)
-        x.at("./*/sections") or
-          x.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
-          "<sections><sentinel/></sections>"
-        x.at("./*/sections/*") or x.at("./*/sections") << "<sentinel/>"
-        ins = x.at("//sections").elements.first
-        x.at("//sections/clause[@type = 'scope']") or
+      def insert_scope(xml)
+        xml.at("./*/sections") or
+          xml.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
+            "<sections><sentinel/></sections>"
+        xml.at("./*/sections/*") or xml.at("./*/sections") << "<sentinel/>"
+        ins = xml.at("//sections").elements.first
+        xml.at("//sections/clause[@type = 'scope']") or
           ins.previous =
             "<clause type='scope' #{add_id}><title>#{@i18n.scope}</title><p>"\
             "#{@i18n.clause_empty}</p></clause>"
-        x&.at("//sentinel")&.remove
+        xml&.at("//sentinel")&.remove
       end
 
-      def insert_norm_ref(x)
-        x.at("//bibliography") or
-          x.at("./*/annex[last()] | ./*/sections").next =
-          "<bibliography><sentinel/></bibliography>"
-        ins = x.at("//bibliography").elements.first
-        x.at("//bibliography/references[@normative = 'true']") or
+      def insert_norm_ref(xml)
+        xml.at("//bibliography") or
+          xml.at("./*/annex[last()] | ./*/sections").next =
+            "<bibliography><sentinel/></bibliography>"
+        ins = xml.at("//bibliography").elements.first
+        xml.at("//bibliography/references[@normative = 'true']") or
           ins.previous = "<references #{add_id} normative='true'>"\
-          "<title>#{@i18n.normref}</title></references>"
-        x&.at("//sentinel")&.remove
+                         "<title>#{@i18n.normref}</title></references>"
+        xml&.at("//sentinel")&.remove
       end
 
-      def insert_terms(x)
-        ins =  x.at("//sections/clause[@type = 'scope']")
-        x.at("//sections//terms") or
+      def insert_terms(xml)
+        ins = xml.at("//sections/clause[@type = 'scope']")
+        xml.at("//sections//terms") or
           ins.next = "<terms #{add_id}><title>#{@i18n.termsdef}</title></terms>"
       end
 
-      def insert_symbols(x)
-        ins =  x.at("//sections/terms") ||
-          x.at("//sections/clause[descendant::terms]")
-        unless x.at("//sections//definitions")
+      def insert_symbols(xml)
+        ins =  xml.at("//sections/terms") ||
+          xml.at("//sections/clause[descendant::terms]")
+        unless xml.at("//sections//definitions")
           ins.next = "<definitions #{add_id}>"\
-            "<title>#{@i18n.symbolsabbrev}</title></definitions>"
+                     "<title>#{@i18n.symbolsabbrev}</title></definitions>"
         end
       end
 
-      def insert_conventions(x)
-        ins =  x.at("//sections//definitions") ||
-          x.at("//sections/clause[descendant::definitions]")
-        unless x.at("//sections/clause[@type = 'conventions']")
+      def insert_conventions(xml)
+        ins =  xml.at("//sections//definitions") ||
+          xml.at("//sections/clause[descendant::definitions]")
+        unless xml.at("//sections/clause[@type = 'conventions']")
           ins.next = "<clause #{add_id} type='conventions'>"\
-            "<title>#{@i18n.conventions}</title><p>"\
-            "#{@i18n.clause_empty}</p></clause>"
+                     "<title>#{@i18n.conventions}</title><p>"\
+                     "#{@i18n.clause_empty}</p></clause>"
         end
       end
 
-      def insert_empty_clauses(x)
-        x.xpath("//terms[not(./term)][not(.//terms)]").each do |c|
+      def insert_empty_clauses(xml)
+        xml.xpath("//terms[not(./term)][not(.//terms)]").each do |c|
           insert_empty_clauses1(c, @i18n.clause_empty)
         end
-        x.xpath("//definitions[not(./dl)]").each do |c|
+        xml.xpath("//definitions[not(./dl)]").each do |c|
           insert_empty_clauses1(c, @i18n.clause_empty)
         end
       end
 
-      def insert_empty_clauses1(c, text)
-        c.at("./p") and return
-        ins = c.at("./title") or return
+      def insert_empty_clauses1(clause, text)
+        clause.at("./p") and return
+        ins = clause.at("./title") or return
         ins.next = "<p>#{text}</p>"
       end
 
@@ -114,14 +116,14 @@ module Asciidoctor
           next unless n.text?
 
           n.replace(HTMLEntities.new.encode(
-            n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
-            gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
+                      n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'")
+                      .gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic
+                    ))
         end
         xmldoc
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-      end
+      def termdef_boilerplate_cleanup(xmldoc); end
 
       def terms_extract(div)
         internal = div.at("./terms[@type = 'internal']/title")
@@ -129,7 +131,7 @@ module Asciidoctor
         [internal, external]
       end
 
-      def term_defs_boilerplate(div, source, term, preface, isodoc)
+      def term_defs_boilerplate(div, _source, _term, _preface, _isodoc)
         internal, external = terms_extract(div.parent)
         internal&.next_element&.name == "term" and
           internal.next = "<p>#{@i18n.internal_terms_boilerplate}</p>"
@@ -144,16 +146,20 @@ module Asciidoctor
           div.next = "<p>#{@i18n.term_def_boilerplate}</p>"
       end
 
-      def section_names_terms_cleanup(x)
+      def section_names_terms_cleanup(xml)
         super
         replace_title(
-          x, "//terms[@type = 'internal'] | "\
-          "//clause[./terms[@type = 'internal']][not(./terms[@type = 'external'])]", 
-          @i18n&.internal_termsdef)
+          xml, "//terms[@type = 'internal'] | "\
+               "//clause[./terms[@type = 'internal']]"\
+               "[not(./terms[@type = 'external'])]",
+          @i18n&.internal_termsdef
+        )
         replace_title(
-          x, "//terms[@type = 'external'] | "\
-          "//clause[./terms[@type = 'external']][not(./terms[@type = 'internal'])]", 
-          @i18n&.external_termsdef)
+          xml, "//terms[@type = 'external'] | "\
+               "//clause[./terms[@type = 'external']]"\
+               "[not(./terms[@type = 'internal'])]",
+          @i18n&.external_termsdef
+        )
       end
 
       def symbols_cleanup(xmldoc)
@@ -193,12 +199,11 @@ module Asciidoctor
       # then title
       def sort_biblio_key(bib)
         pubclass = pub_class(bib)
-        num = bib&.at("./docnumber")&.text
         id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
                      "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
         metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match(metaid)
-        type = id['type'] if id
+        abbrid = metaid unless /^\[\d+\]$/.match?(metaid)
+        type = id["type"] if id
         title = bib&.at("./title[@type = 'main']")&.text ||
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text
         "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"

data/lib/asciidoctor/itu/converter.rb

@@ -1,6 +1,7 @@
 require "asciidoctor"
 require "asciidoctor/standoc/converter"
 require "fileutils"
+require "metanorma-utils"
 require_relative "./front"
 require_relative "./validate"
 require_relative "./cleanup"
@@ -107,16 +108,11 @@ module Asciidoctor
         return unless node.attr("keywords")
 
         node.attr("keywords").split(/, */).sort.each_with_index do |kw, i|
-          xml.keyword (i.zero? ? strict_capitalize(kw) : kw)
+          kw_out = i.zero? ? Metanorma::Utils.strict_capitalize_first(kw) : kw
+          xml.keyword kw_out
         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 sectiontype1(node)

data/lib/asciidoctor/itu/front.rb

@@ -1,6 +1,7 @@
 require "asciidoctor"
 require "asciidoctor/standoc/converter"
 require "fileutils"
+require_relative "./front_id"
 
 module Asciidoctor
   module ITU
@@ -13,6 +14,10 @@ module Asciidoctor
         end
       end
 
+      def relaton_relations
+        super + %w(complements)
+      end
+
       def title_attr(type, lang = "en")
         { language: lang, format: "text/plain", type: type }
       end
@@ -109,55 +114,6 @@ module Asciidoctor
         end
       end
 
-      def metadata_id(node, xml)
-        provisional_id(node, xml)
-        itu_id(node, xml)
-        recommendation_id(node, xml)
-      end
-
-      def provisional_id(node, xml)
-        return unless node.attr("provisional-name")
-
-        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
-
-      def itu_id1(node, lang)
-        bureau = node.attr("bureau") || "T"
-        id = if doctype(node) == "service-publication"
-               @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber"))
-             else
-               "ITU-#{bureau} #{node.attr('docnumber')}"
-             end
-        id + (lang ? "-#{ITULANG[@lang]}" : "")
-      end
-
-      def itu_id(node, xml)
-        return unless node.attr("docnumber")
-
-        xml.docidentifier **{ type: "ITU" } do |i|
-          i << itu_id1(node, false)
-        end
-        xml.docidentifier **{ type: "ITU-lang" } do |i|
-          i << itu_id1(node, true)
-        end
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
-      def recommendation_id(node, xml)
-        return unless node.attr("recommendationnumber")
-
-        node.attr("recommendationnumber").split("/").each do |s|
-          xml.docidentifier **{ type: "ITU-Recommendation" } do |i|
-            i << s
-          end
-        end
-      end
-
       def metadata_series(node, xml)
         node.attr("series") and
           xml.series **{ type: "main" } do |s|
@@ -191,18 +147,6 @@ module Asciidoctor
         xml.ip_notice_received (node.attr("ip-notice-received") || "false")
       end
 
-      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")
-          a = node.attr("annexid") and i.annexid a
-          a = node.attr("amendment-number") and i.amendment a
-          a = node.attr("corrigendum-number") and i.corrigendum a
-        end
-      end
-
       def metadata_techreport(node, xml)
         a = node.attr("meeting") and
           metadata_meeting(a, node.attr("meeting-acronym"), xml)

data/lib/asciidoctor/itu/front_id.rb

@@ -0,0 +1,67 @@
+module Asciidoctor
+  module ITU
+    class Converter < Standoc::Converter
+      def metadata_id(node, xml)
+        provisional_id(node, xml)
+        itu_id(node, xml)
+        recommendation_id(node, xml)
+      end
+
+      def provisional_id(node, xml)
+        return unless node.attr("provisional-name")
+
+        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
+
+      def itu_id1(node, lang)
+        bureau = node.attr("bureau") || "T"
+        id = if doctype(node) == "service-publication"
+               @i18n.annex_to_itu_ob_abbrev.sub(/%/,
+                                                node.attr("docnumber"))
+             else
+               "ITU-#{bureau} #{node.attr('docnumber')}"
+             end
+        id + (lang ? "-#{ITULANG[@lang]}" : "")
+      end
+
+      def itu_id(node, xml)
+        return unless node.attr("docnumber")
+
+        xml.docidentifier **{ type: "ITU" } do |i|
+          i << itu_id1(node, false)
+        end
+        xml.docidentifier **{ type: "ITU-lang" } do |i|
+          i << itu_id1(node, true)
+        end
+        xml.docnumber { |i| i << node.attr("docnumber") }
+      end
+
+      def recommendation_id(node, xml)
+        return unless node.attr("recommendationnumber")
+
+        node.attr("recommendationnumber").split("/").each do |s|
+          xml.docidentifier **{ type: "ITU-Recommendation" } do |i|
+            i << s
+          end
+        end
+      end
+
+      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")
+          a = node.attr("annexid") and i.annexid a
+          a = node.attr("amendment-number") and i.amendment a
+          a = node.attr("corrigendum-number") and i.corrigendum a
+        end
+      end
+    end
+  end
+end