metanorma-itu 1.0.18 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f73d7454cb02fbc95efe4d8deb62e8f19f01eba49a9cd73403f3948f5eec053
-  data.tar.gz: f87b4616dd0b0e48423efc44a5cc7115d1d4841f3aaf4ba1549f5dd0f02fe8fa
+  metadata.gz: c4a8298c94b775bf0894357ab7885d198d4aad3da9893b45f610ff27cde287bc
+  data.tar.gz: 10411a7522e3bf6a4b4a523125b037fc75470d2bfa7918215742c81cae2d6a6b
 SHA512:
-  metadata.gz: 4483e1f5ba81d0677d38cb74c691104d4900653a896eda40d0d2abe5f60a2a14a764b02c1b3ebc31d0b1b43d2451f50e7df91d975b088cc435c9dac25835581f
-  data.tar.gz: cc0a4617299d46730aeede48cf50fba13dc0b65a649879af55199ecf37b941419100692c964cfeab8e63ce78f4f4845a8b38ad6c450ecff28fab05a398358207
+  metadata.gz: 6c497e515e567f5b92710c254570562db5d9c99d5f1b7299e818f1d27d66e51dd676e9b37deb0cb82376db08a8a249dd711418addc17b5052d78c3bba69cd479
+  data.tar.gz: 0d691088240f6ff1fa63ecb92a8137e35d10d32d5e4d823695e3937c8caedc4e1837523ec4015de48088a439131391e69bddb4db18ffef7f0865765483f715bf

data/.github/workflows/macos.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           sudo gem install bundler --force

data/.github/workflows/ubuntu.yml

@@ -31,7 +31,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           gem install bundler
@@ -39,15 +38,19 @@ jobs:
       - name: Run specs
         run: |
           bundle exec rake
-      - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
+      - name: Trigger repositories
+        if: matrix.ruby == '2.6'
         env:
-          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
-          GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
         run: |
           curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
-          for repo in $DEPENDENT_REPOS
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $REPOS
           do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
           done

data/.github/workflows/windows.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         shell: pwsh
         run: |

data/Rakefile

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

data/lib/asciidoctor/itu/cleanup.rb

@@ -4,6 +4,7 @@ module Asciidoctor
       def sections_cleanup(x)
         super
         insert_missing_sections(x) unless @no_insert_missing_sections
+        insert_empty_clauses(x)
       end
 
       def table_cleanup(xmldoc)
@@ -22,15 +23,20 @@ module Asciidoctor
         insert_conventions(x)
       end
 
+      def add_id
+        %(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
-        unless x.at("//sections/clause/title[text() = 'Scope']")
-          ins.previous = "<clause><title>Scope</title><p>"\
-            "#{@labels['clause_empty']}</p></clause>"
+        unless x.at("//sections/clause[@type = 'scope']")
+          ins.previous =
+            "<clause type='scope' #{add_id}><title>#{@i18n.scope}</title><p>"\
+            "#{@i18n.clause_empty}</p></clause>"
         end
         x&.at("//sentinel")&.remove
       end
@@ -41,19 +47,16 @@ module Asciidoctor
           "<bibliography><sentinel/></bibliography>"
         ins = x.at("//bibliography").elements.first
         unless x.at("//bibliography/references[@normative = 'true']")
-          #ins.previous = "<references normative='true'><title>References</title><p>"\
-          #  "#{@labels['clause_empty']}</p></references>"
-          ins.previous = "<references normative='true'><title>References</title>"\
-            "</references>"
+          ins.previous = "<references #{add_id} normative='true'>"\
+            "<title>#{@i18n.normref}</title></references>"
         end
         x&.at("//sentinel")&.remove
       end
 
       def insert_terms(x)
-        ins =  x.at("//sections/clause/title[text() = 'Scope']/..")
+        ins =  x.at("//sections/clause[@type = 'scope']")
         unless x.at("//sections//terms")
-          ins.next = "<terms><title>Definitions</title><p>"\
-            "#{@labels['clause_empty']}</p></terms>"
+          ins.next = "<terms #{add_id}><title>#{@i18n.termsdef}</title></terms>"
         end
       end
 
@@ -61,112 +64,142 @@ module Asciidoctor
         ins =  x.at("//sections/terms") ||
           x.at("//sections/clause[descendant::terms]")
         unless x.at("//sections//definitions")
-          ins.next = "<definitions><title>Abbreviations and acronyms</title><p>"\
-            "#{@labels['clause_empty']}</p></definitions>"
+          ins.next = "<definitions #{add_id}>"\
+            "<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/title[text() = 'Conventions']")
-          ins.next = "<clause id='_#{UUIDTools::UUID.random_create}'>"\
-          "<title>Conventions</title><p>"\
-          "#{@labels['clause_empty']}</p></clause>"
-          end
-          end
-
-          def cleanup(xmldoc)
-          symbols_cleanup(xmldoc)
-          super
-          obligations_cleanup(xmldoc)
-          xmldoc
-          end
-
-          def smartquotes_cleanup(xmldoc)
-          return super if @smartquotes
-          xmldoc.traverse do |n|
+        unless x.at("//sections/clause[@type = 'conventions']")
+          ins.next = "<clause #{add_id} type='conventions'>"\
+            "<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|
+          insert_empty_clauses1(c, @i18n.clause_empty)
+        end
+        x.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
+        ins.next = "<p>#{text}</p>"
+      end
+
+      def cleanup(xmldoc)
+        symbols_cleanup(xmldoc)
+        super
+        obligations_cleanup(xmldoc)
+        xmldoc
+      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
+        xmldoc
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc)
+      end
+
+      def terms_extract(div)
+        internal = div.at("./terms[@type = 'internal']/title")
+        external = div.at("./terms[@type = 'external']/title")
+        [internal, external]
+      end
+
+      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>"
+        internal and internal&.next_element == nil and
+          internal.next = "<p>#{@i18n.no_terms_boilerplate}</p>"
+        external&.next_element&.name == "term" and
+          external.next = "<p>#{@i18n.external_terms_boilerplate}</p>"
+        external and external&.next_element == nil and
+          external.next = "<p>#{@i18n.no_terms_boilerplate}</p>"
+        !internal and !external and
+          %w(term terms).include? div&.next_element&.name and
+          div.next = "<p>#{@i18n.term_def_boilerplate}</p>"
+      end
+
+      def section_names_terms_cleanup(x)
+        super
+        replace_title(
+          x, "//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)
+      end
+
+      def symbols_cleanup(xmldoc)
+        sym = xmldoc.at("//definitions/title")
+        sym and sym&.next_element&.name == "dl" and
+          sym.next = "<p>#{@i18n.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
+        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
 
-        # 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}"
+      def sort_biblio(bib)
+        bib.sort do |a, b|
+          sort_biblio_key(a) <=> sort_biblio_key(b)
         end
+      end
 
-        def biblio_reorder(xmldoc)
-          xmldoc.xpath("//references").each do |r|
-            biblio_reorder1(r)
-          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 normref_cleanup(xmldoc)
-          super
-          r = xmldoc.at(NORM_REF) || return
-          title = r.at("./title") and
-            title.content = "References"
+      def biblio_reorder(xmldoc)
+        xmldoc.xpath("//references").each do |r|
+          biblio_reorder1(r)
         end
       end
     end
   end
+end

data/lib/asciidoctor/itu/converter.rb

@@ -53,21 +53,15 @@ module Asciidoctor
         end.join("\n")
       end
 
-      def document(node)
-        init(node)
-        ret1 = makexml(node)
-        ret = ret1.to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
-          filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
-            gsub(%r{^.*/}, "")
-          File.open(filename, "w") { |f| f.write(ret) }
-          html_converter(node).convert filename unless node.attr("nodoc")
-          word_converter(node).convert filename unless node.attr("nodoc")
-          pdf_converter(node).convert filename unless node.attr("nodoc")
-        end
-        @log.write(@localdir + @filename + ".err") unless @novalid
-        @files_to_delete.each { |f| FileUtils.rm f }
-        ret
+      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", 
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert(@filename + ".presentation.xml", 
+                                    nil, false, "#{@filename}.doc")
+        pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                     nil, false, "#{@filename}.pdf")
       end
 
       def validate(doc)
@@ -85,65 +79,42 @@ module Asciidoctor
         when "definitions" then "terms and definitions"
         when "abbreviations and acronyms" then "symbols and abbreviated terms"
         when "references" then "normative references"
+        when "terms defined elsewhere" then "terms and definitions"
+        when "terms defined in this recommendation" then "terms and definitions"
         else
           super
         end
       end
 
-      def term_def_title(toplevel, node)
-        return node.title unless toplevel
-        "Definitions"
-      end
-
-      def terms_extract(div)
-        internal = nil
-        external = nil
-        div.parent.xpath("./terms/title").each do |t|
-          case t&.text&.downcase
-          when "terms defined elsewhere" then external = t
-          when "terms defined in this recommendation" then internal = t
-          end
+      def term_def_subclause_parse(attrs, xml, node)
+        case clausetype = sectiontype1(node)
+        when "terms defined in this recommendation"
+          term_def_parse(attrs.merge(type: "internal"), xml, node, false)
+        when "terms defined elsewhere"
+          term_def_parse(attrs.merge(type: "external"), xml, node, false)
+        else
+          super
         end
-        [internal, external]
-      end
-
-      def term_defs_boilerplate(div, source, term, preface, isodoc)
-        internal, external = terms_extract(div)
-        internal&.next_element&.name == "term" and
-          internal.next = "<p>#{@internal_terms_boilerplate}</p>"
-        internal and internal&.next_element == nil and
-          internal.next = "<p>#{@no_terms_boilerplate}</p>"
-        external&.next_element&.name == "term" and
-          external.next = "<p>#{@external_terms_boilerplate}</p>"
-        external and external&.next_element == nil and
-          external.next = "<p>#{@no_terms_boilerplate}</p>"
-        !internal and !external and
-          %w(term terms).include? div&.next_element&.name and
-          div.next = "<p>#{@term_def_boilerplate}</p>"
-      end
-
-      def load_yaml(lang, script)
-        y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            elsif lang == "en"
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            else
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            end
-        @symbols_boilerplate = y["symbols_boilerplate"] || ""
-        super.merge(y)
-      end
-
-      def i18n_init(lang, script)
-        super
       end
 
-       def metadata_keywords(node, xml)
+      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)
         end
       end
 
+      def clause_parse(attrs, xml, node)
+        case clausetype = sectiontype1(node)
+        when "conventions" then attrs = attrs.merge(type: "conventions")
+        when "history" 
+          attrs[:preface] and attrs = attrs.merge(type: "history")
+        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"))
       end
@@ -152,6 +123,10 @@ module Asciidoctor
         super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
       end
 
+      def presentation_xml_converter(node)
+        IsoDoc::ITU::PresentationXMLConvert.new(html_extract_attributes(node))
+      end
+
       def html_converter(node)
         IsoDoc::ITU::HtmlConvert.new(html_extract_attributes(node))
       end
@@ -160,7 +135,7 @@ module Asciidoctor
         IsoDoc::ITU::PdfConvert.new(html_extract_attributes(node))
       end
 
-      def word_converter(node)
+      def doc_converter(node)
         IsoDoc::ITU::WordConvert.new(doc_extract_attributes(node))
       end
     end