metanorma-itu 0.2.8 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc42b5f0ce3f11b23b8bcd171e19342c3f2c237742e8084cb6545af5a56e954f
-  data.tar.gz: 73ae3b1e5cf914b8e715e1ccb14b0492819cbe811334cbfe7c5b24787490f5bd
+  metadata.gz: e18def3906b392a164e0fc200836e95217ec2c0689d4721bc64ef4e8c3a7cc0d
+  data.tar.gz: 1d0ca7d8a3840c579f554fe32208a5b12fa7b9de960e68d2aca824ca103ab030
 SHA512:
-  metadata.gz: 8f72656f8c80c6bff4e48aba41f45d0342fb6fc5e542eb0410908efb465862ba7f3b9dee3cc6ef4ef5175fa60fdb05570339d9718b99193f56d6b2e4818734b0
-  data.tar.gz: 13071d691ced638d57cb4085835b359e00a7851c6198739159ccb5e675b491e34983fba7a89c16e6a090a3172a9e6ef577b46c2df4948125b279d7b510223c61
+  metadata.gz: d38ceb1119b8a45cad531b4fdad23b3186c1a0765c3f263e6daebdb1632020549c8838fb89a9d9f73983dfe7cadc71facdaec6d5d334df76f5e5eb80c219f2ab
+  data.tar.gz: 015be0de1ece74eb7efb1edda36282cf1979eab4b08a9bb5eed74d28ca9ed288ce1b68fdf9547bef8932b64d5cb222d7a271d5972615e9b994b51bcc9ea7b6bb

data/.github/workflows/macos.yml

@@ -2,13 +2,14 @@
 # use ci-master https://github.com/metanorma/metanorma-build-scripts
 name: macos
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
     steps:
@@ -20,7 +21,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          sudo gem install bundler -v "~> 2" --force
+          sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
       - name: Use Node
         uses: actions/setup-node@v1

data/.github/workflows/ubuntu.yml

@@ -2,13 +2,14 @@
 # use ci-master https://github.com/metanorma/metanorma-build-scripts
 name: ubuntu
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
     steps:
@@ -20,7 +21,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          gem install bundler -v "~> 2"
+          gem install bundler 
           bundle install --jobs 4 --retry 3
       - name: Use Node
         uses: actions/setup-node@v1

data/.github/workflows/windows.yml

@@ -2,13 +2,14 @@
 # use ci-master https://github.com/metanorma/metanorma-build-scripts
 name: windows
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
     steps:
@@ -21,7 +22,7 @@ jobs:
       - name: Update gems
         shell: pwsh
         run: |
-          gem install bundler -v "~> 2"
+          gem install bundler 
           bundle config --local path vendor/bundle
           bundle update
           bundle install --jobs 4 --retry 3

data/README.adoc

@@ -1,11 +1,11 @@
 = metanorma-itu: Asciidoctor processor for ITU
 
 image:https://img.shields.io/gem/v/metanorma-itu.svg["Gem Version", link="https://rubygems.org/gems/metanorma-itu"]
-image:https://travis-ci.com/metanorma/metanorma-itu.svg?branch=master["Build Status", link="https://travis-ci.com/metanorma/metanorma-itu"]
+image:https://travis-ci.com/metanorma/metanorma-itu.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-itu"]
+image:https://ci.appveyor.com/api/projects/status/pl6lh4a9224ijbe1?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma-itu"]
 image:https://codeclimate.com/github/metanorma/metanorma-itu/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-itu"]
-image:https://ci.appveyor.com/api/projects/status/lo05dblngrgx2tlq?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/metanorma-itu"]
-
-WARNING: This gem is still under development.
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-itu.svg["Pull Requests", link="https://github.com/metanorma/metanorma-itu/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-itu/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-itu/releases"]
 
 == Functionality
 
@@ -66,7 +66,6 @@ See https://www.metanorma.com/author/itu/[Write ITU-T documents with Metanorma].
 
 == Examples
 
-* link:spec/examples/rfc6350.adoc[] is an Metanorma Asciidoctor version of https://tools.ietf.org/html/rfc6350[RFC 6350].
-* link:spec/examples/rfc6350.html[] is an HTML file generated from the Asciidoctor.
-* link:spec/examples/rfc6350.doc[] is a Word document generated from the Asciidoctor.
+* Example documents are avalable at the https://github.com/metanorma/mn-samples-itu[mn-samples-itu] repository.
+* Document templates are available at the https://github.com/metanorma/mn-templates-itu[mn-templates-itu] repository.
 

data/lib/asciidoctor/itu/basicdoc.rng

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-  <include href="biblio.rng"/>
-  <start>
-    <ref name="document"/>
-  </start>
+  <include href="biblio.rng">
+    <start>
+      <ref name="document"/>
+    </start>
+  </include>
   <define name="document">
     <element name="document">
       <optional>
@@ -51,9 +52,9 @@
     <optional>
       <ref name="section-title"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="BasicBlock"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="note"/>
     </zeroOrMore>
@@ -283,6 +284,9 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
       <optional>
         <ref name="tname"/>
       </optional>
@@ -341,11 +345,6 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="tclass">
-    <element name="name">
-      <text/>
-    </element>
-  </define>
   <define name="thead">
     <element name="thead">
       <ref name="tr"/>
@@ -515,19 +514,22 @@
         <attribute name="subsequence"/>
       </optional>
       <optional>
-        <ref name="source"/>
+        <attribute name="class"/>
       </optional>
       <optional>
-        <ref name="tname"/>
+        <ref name="source"/>
       </optional>
       <optional>
-        <ref name="tclass"/>
+        <ref name="tname"/>
       </optional>
       <choice>
         <ref name="image"/>
         <ref name="video"/>
         <ref name="audio"/>
         <ref name="pre"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
         <zeroOrMore>
           <ref name="figure"/>
         </zeroOrMore>
@@ -565,6 +567,7 @@
       <ref name="pagebreak"/>
       <ref name="bookmark"/>
       <ref name="image"/>
+      <ref name="index"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -689,6 +692,17 @@
       <empty/>
     </element>
   </define>
+  <define name="index">
+    <element name="index">
+      <attribute name="primary"/>
+      <optional>
+        <attribute name="secondary"/>
+      </optional>
+      <optional>
+        <attribute name="tertiary"/>
+      </optional>
+    </element>
+  </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/itu/biblio.rng

@@ -33,6 +33,9 @@
       <param name="pattern">([\+\-]?\d{4})((-?)((0[1-9]|1[0-2])((-?)([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6]))))?</param>
     </data>
   </define>
+  <start>
+    <ref name="bibitem"/>
+  </start>
   <define name="status">
     <element name="status">
       <ref name="stage"/>
@@ -275,10 +278,12 @@
   </define>
   <define name="organization">
     <element name="organization">
-      <ref name="orgname"/>
-      <optional>
+      <oneOrMore>
+        <ref name="orgname"/>
+      </oneOrMore>
+      <zeroOrMore>
         <ref name="subdivision"/>
-      </optional>
+      </zeroOrMore>
       <optional>
         <ref name="abbreviation"/>
       </optional>
@@ -354,6 +359,9 @@
   </define>
   <define name="phone">
     <element name="phone">
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <text/>
     </element>
   </define>
@@ -1021,6 +1029,8 @@
       <value>correctedBy</value>
       <value>revises</value>
       <value>revisedBy</value>
+      <value>describes</value>
+      <value>describedBy</value>
     </choice>
   </define>
   <define name="docrelation">

data/lib/asciidoctor/itu/cleanup.rb

@@ -0,0 +1,118 @@
+module Asciidoctor
+  module ITU
+    class Converter < Standoc::Converter
+      def sections_cleanup(x)
+        super
+        x.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+      end
+
+      def cleanup(xmldoc)
+        symbols_cleanup(xmldoc)
+        super
+      end
+
+      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))
+        end
+        xmldoc
+      end
+
+      def termdef_cleanup(xmldoc)
+        xmldoc.xpath("//term/preferred").each do |p|
+          if ["terms defined elsewhere",
+              "terms defined in this recommendation"].include? p.text.downcase
+            p.name = "title"
+            p.parent.name = "terms"
+          end
+        end
+        super
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc)
+      end
+
+      def symbols_cleanup(xmldoc)
+        sym = xmldoc.at("//definitions/title")
+        sym and sym&.next_element&.name == "dl" and
+          sym.next = "<p>#{@symbols_boilerplate}</p>"
+      end
+
+      PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
+
+      def pub_class(bib)
+        return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ITU']")
+        return 1 if bib.at("#{PUBLISHER}[name = 'International Telecommunication Union']")
+        return 2 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
+        return 2 if bib.at("#{PUBLISHER}[name = 'International Organization "\
+                           "for Standardization']")
+        return 3 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
+        return 3 if bib.at("#{PUBLISHER}[name = 'International "\
+                           "Electrotechnical Commission']")
+        return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
+                           "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
+        5
+      end
+
+      def sort_biblio(bib)
+        bib.sort do |a, b|
+          sort_biblio_key(a) <=> sort_biblio_key(b)
+        end
+      end
+
+      # sort by: doc class (ITU, ISO, IEC, other standard (not DOI &c), other
+      # then standard class (docid class other than DOI &c)
+      # then alphanumeric doc id (not DOI &c)
+      # 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
+        title = bib&.at("./title[@type = 'main']")&.text ||
+          bib&.at("./title")&.text || bib&.at("./formattedref")&.text
+        "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"
+      end
+
+      def biblio_reorder(xmldoc)
+        xmldoc.xpath("//references").each do |r|
+          biblio_reorder1(r)
+        end
+      end
+
+      def boilerplate_cleanup(xmldoc)
+        super
+        initial_boilerplate(xmldoc)
+      end
+
+      def initial_boilerplate(x)
+        return if x.at("//boilerplate")
+        preface = x.at("//preface") || x.at("//sections") || x.at("//annex") ||
+          x.at("//references") || return
+        preface.previous = boilerplate(x)
+      end
+
+       def boilerplate(x_orig)
+        x = x_orig.dup
+        # TODO variable
+        x.root.add_namespace(nil, Metanorma::ITU::DOCUMENT_NAMESPACE)
+        x = Nokogiri::XML(x.to_xml)
+        conv = IsoDoc::ITU::HtmlConvert.new({})
+        conv.metadata_init("en", "Latn", {})
+        conv.info(x, nil)
+        file = @boilerplateauthority ? "#{@localdir}/#{@boilerplateauthority}" :
+          File.join(File.dirname(__FILE__), "itu_intro.xml")
+          conv.populate_template((File.read(file, encoding: "UTF-8")), nil)
+      end
+    end
+  end
+end

data/lib/asciidoctor/itu/converter.rb

@@ -3,6 +3,7 @@ require "asciidoctor/standoc/converter"
 require "fileutils"
 require_relative "./front.rb"
 require_relative "./validate.rb"
+require_relative "./cleanup.rb"
 require_relative "./macros.rb"
 
 module Asciidoctor
@@ -12,16 +13,22 @@ module Asciidoctor
     # schema encapsulation of the document for validation
     #
     class Converter < Standoc::Converter
+      register_for "itu"
+
       Asciidoctor::Extensions.register do
-        block PseudocodeBlockMacro
+        inline_macro AddMacro
+        inline_macro DelMacro
       end
 
-      register_for "itu"
-
       def title_validate(root)
         nil
       end
 
+      def init(node)
+        super
+        @smartquotes = node.attr("smartquotes") == "true"
+      end
+
       def makexml(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>\n<itu-standard>"]
         @draft = node.attributes.has_key?("draft")
@@ -36,31 +43,20 @@ module Asciidoctor
       end
 
       def doctype(node)
-        node.attr("doctype") || "recommendation"
-      end
-
-       def example(node)
-        role = node.role || node.attr("style")
-        return pseudocode_example(node) if role == "pseudocode"
-        super
+        ret = node.attr("doctype") || "recommendation"
+        ret = "recommendation" if ret == "article"
+        ret
       end
 
-      def pseudocode_example(node)
+      def olist(node)
         noko do |xml|
-          xml.figure **{id: Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
-                        type: "pseudocode"} do |ex|
-            figure_title(node, ex)
-            wrap_in_para(node, ex)
+          xml.ol **attr_code(id: Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+                             class: node.attr("class")) do |xml_ol|
+            node.items.each { |item| li(xml_ol, item) }
           end
         end.join("\n")
       end
 
-      def init_indent(s)
-        /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
-        prefix = prefix.gsub(/\t/, "&#xa0;&#xa0;&#xa0;&#xa0;").gsub(/ /, "&#xa0;")
-        prefix + suffix
-      end
-
       def clause_parse(attrs, xml, node)
         attrs[:preface] = true if node.attr("style") == "preface"
         super
@@ -101,18 +97,6 @@ module Asciidoctor
                         File.join(File.dirname(__FILE__), "itu.rng"))
       end
 
-      def sections_cleanup(x)
-        super
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
-      def cleanup(xmldoc)
-        symbols_cleanup(xmldoc)
-        super
-      end
-
       def style(n, t)
         return
       end
@@ -170,20 +154,6 @@ module Asciidoctor
         "Definitions"
       end
 
-      def termdef_cleanup(xmldoc)
-        xmldoc.xpath("//term/preferred").each do |p|
-          if ["terms defined elsewhere",
-              "terms defined in this recommendation"].include? p.text.downcase
-            p.name = "title"
-            p.parent.name = "terms"
-          end
-        end
-        super
-      end
-
-      def termdef_boilerplate_cleanup(xmldoc)
-      end
-
       def terms_extract(div)
         internal = nil
         external = nil
@@ -213,12 +183,6 @@ module Asciidoctor
 
       NORM_REF = "//bibliography/references[title = 'References']".freeze
 
-      def symbols_cleanup(xmldoc)
-        sym = xmldoc.at("//definitions/title")
-        sym and sym&.next_element&.name == "dl" and
-          sym.next = "<p>#{@symbols_boilerplate}</p>"
-      end
-
       def load_yaml(lang, script)
         y = if @i18nyaml then YAML.load_file(@i18nyaml)
             elsif lang == "en"