metanorma-gb 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50ae7327f236ecb70d2b98d3f9f0ea1ab142712089e9062ebd680561f2c40a2e
-  data.tar.gz: b3b36dab86dbbaa96e215e276f60a80c81e268f2f305b40948a19afd6428630a
+  metadata.gz: a326bf40f513d695ec5b2e5c7dafa563de377ce6c3a1da84f721b60db3f29977
+  data.tar.gz: 77adddf3a6c12e3d57e40d8dcf9a646794ef16fb6e4abc5a930b31746ae664c9
 SHA512:
-  metadata.gz: 2b6993e4a7030025b09f98bb5f0c16f998533cddd4916ee0ea8dc4a5be22dca7301c2eca96a64c2348d75490e43f1bbdf1df577aa0a6f19e98e7515d4172dcaf
-  data.tar.gz: e03ae570fd22b11928d5c8bcbd50c25b017269da85e926a96db586d0e38d55bc9407de81a9720e23f5f087a9814602a34420abf8369c399d10f6e0367211d70b
+  metadata.gz: f221356ae97fc691544be1296f4bcaa48032ee8cce37d629f12e78b00eae4e0a7cce961acad2502101e4650a26b5649f548d8adfedd18e8ac450fada42ac091a
+  data.tar.gz: a03f8e0e1910bec1450504f40162cf9a5ac6c1537059217ab30f22278653712d0583810c295c583f714a32093fe22eaf615d74c6b3d0e61afc430e93304a14c8

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/.gitignore

@@ -3,7 +3,5 @@ coverage/
 .rspec_status
 .tmp.xml
 gb-issuer-default.gif
-gb.css
-htmlstyle.css
 test.html
 test.xml

data/Gemfile

@@ -3,7 +3,6 @@ Encoding.default_internal = Encoding::UTF_8
 
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}" }
-
 gemspec
 
 if File.exist? 'Gemfile.devel'

data/Rakefile

@@ -1,6 +1,23 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+module IsoDoc
+  module GemTasks
+    module_function
+
+    def fonts_placeholder
+      <<~TEXT
+        $bodyfont: '{{bodyfont}}';
+        $headerfont: '{{headerfont}}';
+        $monospacefont: '{{monospacefont}}';
+        $titlefont: '{{titlefont}}';
+      TEXT
+    end
+  end
+end
+
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/asciidoctor/gb/cleanup.rb

@@ -0,0 +1,130 @@
+module Asciidoctor
+  module Gb
+    class Converter < ISO::Converter
+      def termdef_cleanup(xmldoc)
+        super
+        # TODO this should become variant tag
+        localisedstr(xmldoc)
+      end
+
+      ROMAN_TEXT = /\s*[a-z\u00c0-\u00d6\u00d8-\u00f0\u0100-\u0240]/i
+      HAN_TEXT = /\s*[\u4e00-\u9fff]+/
+
+      LOCALISED_ELEMS = "//admitted | //deprecates | //preferred | //prefix | "\
+        "//initial | //addition | //surname | //forename | //name | "\
+        "//abbreviation | //role/description | //affiliation/description | "\
+        "//bibdata/item | //bibitem/title | //bibdata/formattedref | "\
+        "//bibitem/formattedref | //bibdata/note | //bibitem/note | "\
+        "//bibdata/abstract | //bibitem/note ".freeze
+
+      MUST_LOCALISE_ELEMS = %w{admitted deprecates preferred}.freeze
+
+      def localisedstr(xmldoc)
+        xmldoc.xpath(LOCALISED_ELEMS).each do |zh|
+          if zh.at("./string")
+            extract_localisedstrings(zh)
+          elsif MUST_LOCALISE_ELEMS.include? zh.name
+            duplicate_localisedstrings(zh)
+          end
+        end
+      end
+
+      # element consists solely of localised strings, with no attributes
+      def extract_localisedstrings(elem)
+        elem.xpath("./string").each do |s|
+          s.name = elem.name
+        end
+        elem.replace(elem.children)
+      end
+
+      def text_clean(text)
+        text.gsub(/^\s*/, "").gsub(/</, "&lt;").gsub(/>/, "&gt;")
+      end
+
+      def duplicate_localisedstrings(zh)
+        en = zh.dup.remove
+        zh.after(en).after(" ")
+        zh["language"] = "zh"
+        en["language"] = "en"
+        en.traverse do |c|
+          c.text? && c.content = text_clean(c.text.gsub(HAN_TEXT, ""))
+        end
+        zh.traverse do |c|
+          c.text? && c.content = text_clean(c.text.gsub(ROMAN_TEXT, ""))
+        end
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc)
+        return if @keepboilerplate
+        super
+      end
+
+      def cleanup(xmldoc)
+        lang = xmldoc.at("//language")&.text
+        @agencyclass = GbAgencies::Agencies.new(lang, {}, "")
+        super
+        contributor_cleanup(xmldoc)
+        xmldoc
+      end
+
+      def docidentifier_cleanup(xmldoc)
+        id = xmldoc.at("//bibdata/docidentifier[@type = 'gb']") or return
+        scope = xmldoc.at("//gbscope")&.text
+        prefix = xmldoc.at("//gbprefix")&.text
+        mand = xmldoc.at("//gbmandate")&.text || "mandatory"
+        idtext = @agencyclass.docidentifier(scope, prefix, mand, nil, id.text)
+        id.content = idtext&.gsub(/\&#x2002;/, " ")
+        id = xmldoc.at("//bibdata/ext/structuredidentifier/"\
+                       "project-number") or return
+        idtext = @agencyclass.docidentifier(scope, prefix, mand, nil, id.text)
+        id.content = idtext&.gsub(/\&#x2002;/, " ")
+      end
+
+      def committee_cleanup(xmldoc)
+        xmldoc.xpath("//gbcommittee").each do |c|
+          xmldoc.at("//bibdata/contributor").next =
+            "<contributor><role type='technical-committee'/><organization>"\
+            "<name>#{c.text}</name></organization></contributor>"
+        end
+      end
+
+      def agency_value(issuer, scope, prefix, mandate)
+        agency = issuer.content
+        agency == "GB" and
+          agency = @agencyclass.standard_agency1(scope, prefix, mandate)
+        agency = "GB" if agency.nil? || agency.empty?
+        agency
+      end
+
+      def contributor_cleanup(xmldoc)
+        issuer = xmldoc.at("//bibdata/contributor[role/@type = 'issuer']/"\
+                           "organization/name")
+        scope = xmldoc.at("//gbscope")&.text
+        prefix = xmldoc.at("//gbprefix")&.text
+        mandate = xmldoc.at("//gbmandate")&.text || "mandatory"
+        agency = agency_value(issuer, scope, prefix, mandate)
+        owner = xmldoc.at("//copyright/owner/organization/name")
+        owner.content = agency
+        issuer.content = agency
+        committee_cleanup(xmldoc)
+      end
+
+      def omit_docid_prefix(prefix)
+        IsoDoc::Gb::HtmlConvert.new({}).omit_docid_prefix(prefix)
+      end
+
+      def boilerplate_cleanup(xmldoc)
+        isodoc = boilerplate_isodoc(xmldoc)
+        initial_boilerplate(xmldoc, isodoc)
+        return if @keepboilerplate
+        xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
+          term_defs_boilerplate(f.at("./title"),
+                                xmldoc.xpath(".//termdocsource"),
+                                f.at(".//term"), f.at(".//p"), isodoc)
+        end
+        f = xmldoc.at(self.class::NORM_REF) and
+          norm_ref_preface(f)
+      end
+    end
+  end
+end

data/lib/asciidoctor/gb/converter.rb

@@ -1,6 +1,5 @@
 require "asciidoctor"
 require "asciidoctor/iso/converter"
-require "metanorma/gb/version"
 require "isodoc/gb/common"
 require "isodoc/gb/word_convert"
 require "isodoc/gb/pdf_convert"
@@ -9,6 +8,7 @@ require "gb_agencies"
 require_relative "./section_input.rb"
 require_relative "./front.rb"
 require_relative "./validate.rb"
+require_relative "cleanup.rb"
 require "fileutils"
 
 module Asciidoctor
@@ -61,6 +61,7 @@ module Asciidoctor
       end
 
       def pdf_converter(node)
+        return nil if node.attr("no-pdf")
         node.nil? ? IsoDoc::Gb::PdfConvert.new({}) :
           IsoDoc::Gb::PdfConvert.new(doc_extract_attributes(node))
       end
@@ -73,62 +74,15 @@ module Asciidoctor
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert(@filename + ".xml")
-        html_compliant_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}_compliant.html")
-        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 termdef_cleanup(xmldoc)
-        super
-        localisedstr(xmldoc)
-      end
-
-      ROMAN_TEXT = /\s*[a-z\u00c0-\u00d6\u00d8-\u00f0\u0100-\u0240]/i
-      HAN_TEXT = /\s*[\u4e00-\u9fff]+/
-
-      LOCALISED_ELEMS = "//admitted | //deprecates | //preferred | //prefix | "\
-        "//initial | //addition | //surname | //forename | //name | "\
-        "//abbreviation | //role/description | //affiliation/description | "\
-        "//bibdata/item | //bibitem/title | //bibdata/formattedref | "\
-        "//bibitem/formattedref | //bibdata/note | //bibitem/note | "\
-        "//bibdata/abstract | //bibitem/note ".freeze
-
-      MUST_LOCALISE_ELEMS = %w{admitted deprecates preferred}.freeze
-
-      def localisedstr(xmldoc)
-        xmldoc.xpath(LOCALISED_ELEMS).each do |zh|
-          if zh.at("./string")
-            extract_localisedstrings(zh)
-          elsif MUST_LOCALISE_ELEMS.include? zh.name
-            duplicate_localisedstrings(zh)
-          end
-        end
-      end
-
-      # element consists solely of localised strings, with no attributes
-      def extract_localisedstrings(elem)
-        elem.xpath("./string").each do |s|
-          s.name = elem.name
-        end
-        elem.replace(elem.children)
-      end
-
-      def text_clean(text)
-        text.gsub(/^\s*/, "").gsub(/</, "&lt;").gsub(/>/, "&gt;")
-      end
-
-      def duplicate_localisedstrings(zh)
-        en = zh.dup.remove
-        zh.after(en).after(" ")
-        zh["language"] = "zh"
-        en["language"] = "en"
-        en.traverse do |c|
-          c.text? && c.content = text_clean(c.text.gsub(HAN_TEXT, ""))
-        end
-        zh.traverse do |c|
-          c.text? && c.content = text_clean(c.text.gsub(ROMAN_TEXT, ""))
-        end
+        html_compliant_converter(node).
+          convert(@filename + ".presentation.xml", 
+                  nil, false, "#{@filename}_compliant.html")
+        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 inline_quoted(node)
@@ -148,11 +102,6 @@ module Asciidoctor
         super
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-        return if @keepboilerplate
-        super
-      end
-
       GBCODE = "((AQ|BB|CB|CH|CJ|CY|DA|DB|DL|DZ|EJ|FZ|GA|GH|GM|GY|HB|HG|"\
         "HJ|HS|HY|JB|JC|JG|JR|JT|JY|LB|LD|LS|LY|MH|MT|MZ|NY|QB|QC|QJ|"\
         "QZ|SB|SC|SH|SJ|SN|SY|TB|TD|TJ|TY|WB|WH|WJ|WM|WS|WW|XB|YB|YC|"\
@@ -185,71 +134,12 @@ module Asciidoctor
           super
       end
 
-      def cleanup(xmldoc)
-        lang = xmldoc.at("//language")&.text
-        @agencyclass = GbAgencies::Agencies.new(lang, {}, "")
+      def init(node)
+        node.attr("language") or node.set_attr("language", "zh")
+        node.attr("script") or
+          node.set_attr("script", node.attr("language") == "zh" ?
+                        "Hans" : "Latn")
         super
-        contributor_cleanup(xmldoc)
-        xmldoc
-      end
-
-      def docidentifier_cleanup(xmldoc)
-        id = xmldoc.at("//bibdata/docidentifier[@type = 'gb']") or return
-        scope = xmldoc.at("//gbscope")&.text
-        prefix = xmldoc.at("//gbprefix")&.text
-        mand = xmldoc.at("//gbmandate")&.text || "mandatory"
-        idtext = @agencyclass.docidentifier(scope, prefix, mand, nil, id.text)
-        id.content = idtext&.gsub(/\&#x2002;/, " ")
-        id = xmldoc.at("//bibdata/ext/structuredidentifier/"\
-                       "project-number") or return
-        idtext = @agencyclass.docidentifier(scope, prefix, mand, nil, id.text)
-        id.content = idtext&.gsub(/\&#x2002;/, " ")
-      end
-
-      def committee_cleanup(xmldoc)
-        xmldoc.xpath("//gbcommittee").each do |c|
-          xmldoc.at("//bibdata/contributor").next =
-            "<contributor><role type='technical-committee'/><organization>"\
-            "<name>#{c.text}</name></organization></contributor>"
-        end
-      end
-
-      def agency_value(issuer, scope, prefix, mandate)
-        agency = issuer.content
-        agency == "GB" and
-          agency = @agencyclass.standard_agency1(scope, prefix, mandate)
-        agency = "GB" if agency.nil? || agency.empty?
-        agency
-      end
-
-      def contributor_cleanup(xmldoc)
-        issuer = xmldoc.at("//bibdata/contributor[role/@type = 'issuer']/"\
-                           "organization/name")
-        scope = xmldoc.at("//gbscope")&.text
-        prefix = xmldoc.at("//gbprefix")&.text
-        mandate = xmldoc.at("//gbmandate")&.text || "mandatory"
-        agency = agency_value(issuer, scope, prefix, mandate)
-        owner = xmldoc.at("//copyright/owner/organization/name")
-        owner.content = agency
-        issuer.content = agency
-        committee_cleanup(xmldoc)
-      end
-
-      def omit_docid_prefix(prefix)
-        IsoDoc::Gb::HtmlConvert.new({}).omit_docid_prefix(prefix)
-      end
-
-      def boilerplate_cleanup(xmldoc)
-        isodoc = boilerplate_isodoc(xmldoc)
-        initial_boilerplate(xmldoc, isodoc)
-        return if @keepboilerplate
-        xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
-          term_defs_boilerplate(f.at("./title"),
-                                xmldoc.xpath(".//termdocsource"),
-                                f.at(".//term"), f.at(".//p"), isodoc)
-        end
-        f = xmldoc.at(self.class::NORM_REF) and
-          norm_ref_preface(f)
       end
     end
   end

data/lib/asciidoctor/gb/front_id.rb

@@ -1,7 +1,7 @@
 module Asciidoctor
   module Gb
     class Converter < ISO::Converter
-            STAGE_ABBRS_CN = {
+      STAGE_ABBRS_CN = {
         "00": "新工作项目建议",
         "10": "新工作项目",
         "20": "标准草案工作组讨论稿",
@@ -15,7 +15,7 @@ module Asciidoctor
 
       def stage_name(stage, substage)
         return "Proof" if stage == "60" && substage == "00"
-        @language == "en" ?
+        @lang == "en" ?
           STAGE_NAMES[stage.to_sym] : STAGE_ABBRS_CN[stage.to_sym]
       end
 
@@ -43,7 +43,7 @@ module Asciidoctor
 
       def id_stage_prefix(dn, node)
         if node.attr("docstage") && node.attr("docstage").to_i < 60
-          abbr = IsoDoc::Gb::Metadata.new("en", "Latn", {}).
+          abbr = IsoDoc::Gb::Metadata.new("en", "Latn", @i18n).
             status_abbrev(node.attr("docstage"), nil, node.attr("iteration"),
                           node.attr("draft"), node.attr("doctype"))
           dn = "/#{abbr} #{dn}" # prefixes added in cleanup

data/lib/asciidoctor/gb/isodoc.rng

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>