metanorma-iso 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69530242f8dcfcd209289f65397818d2d73e69920a2588b1bfa4c30b712ada50
-  data.tar.gz: 72261437fe21d308b4c01e4ba3ce7f9fe15a5c3a35dce4828dc7b04e2c941df4
+  metadata.gz: 04b55e3ca534c69d32ca0f9379574e2ea64af41abdcfcd723532917cce1dbb11
+  data.tar.gz: 9a4910e86d2792bf82e863ed1d57cd0bd492667acc2eef5eaf0d7443b99fd730
 SHA512:
-  metadata.gz: 8a01d3c261513bddc48ce11f6b331ab025939d41e234a02e6e63cd39ef15c865af2a7f086768a38cbbecbec8aac76fabbb1ea5febcb3f4fb0852aab58ba7b794
-  data.tar.gz: d83d323c7e9ca83dc5afaead3e837da9bc952074a4f913f5eb28dce637d98ffce6f4e6206b96ff8ef3a05a585b8a75c2de215fae8a36dfae325c1b632a0cb68a
+  metadata.gz: cee47fc2106cf2573bb9c5d1198c230c0b9c1e350a8c12b5c1764eb683e058579619cbcb26c33a8cd4f838ccaccc7282ba1e990777d672c5b0b1269f0f950ce7
+  data.tar.gz: 4515aa0402dddc620a72837044e3c47a8864a2503109a57846037f96041f7a88d9c4dca652c7392b9ce1ab45d158922316d565b32b8c35a6dc2695b108da46c7

data/.github/workflows/rake.yml

@@ -16,17 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
@@ -35,49 +35,19 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
-      - if: matrix.os == 'macos-latest'
-        run: brew install autoconf automake libtool
-
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
-          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
-
-      - run: bundle config set path 'vendor/bundle'
-
-      - run: bundle install --jobs 4 --retry 3
-
-      - name: install plantuml ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        uses: nick-invision/retry@v1
-        with:
-          polling_interval_seconds: 5
-          timeout_minutes: 5
-          max_attempts: 3
-          command: >
-            sudo apt-get update -y && sudo bash -c 
-            "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
-
-      - if: matrix.os == 'macos-latest'
-        run: brew install plantuml
-
-      - if: matrix.os == 'windows-latest'
-        run: cinst -y plantuml
+      - uses: metanorma/metanorma-build-scripts/plantuml-setup-action@master
 
       - run: bundle exec rake
 
   tests-passed:
     needs: rake
     runs-on: ubuntu-latest
-    continue-on-error: true
     steps:
-      - name: Trigger tests passed event
-        uses: Sibz/github-status-action@v1
+      - uses: peter-evans/repository-dispatch@v1
         with:
-          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          context: 'tests-passed-successfully'
-          description: 'Tests passed successfully'
-          state: 'success'
-          sha: ${{ github.event.pull_request.head.sha || github.sha }}
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/lib/asciidoctor/iso/isodoc.rng

@@ -102,7 +102,7 @@
           </attribute>
         </optional>
         <oneOrMore>
-          <ref name="li"/>
+          <ref name="ul_li"/>
         </oneOrMore>
         <zeroOrMore>
           <ref name="note"/>
@@ -1716,4 +1716,26 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="ul_li">
+    <element name="li">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="uncheckedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="checkedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="BasicBlock"/>
+      </oneOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/iso/isostandard.rng

@@ -79,19 +79,6 @@
         </choice>
       </element>
     </define>
-    <define name="ul">
-      <element name="ul">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <oneOrMore>
-          <ref name="ul_li"/>
-        </oneOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </element>
-    </define>
     <define name="sections">
       <element name="sections">
         <zeroOrMore>
@@ -192,17 +179,6 @@
         </zeroOrMore>
       </element>
     </define>
-    <define name="definition">
-      <element name="definition">
-        <oneOrMore>
-          <choice>
-            <ref name="paragraph"/>
-            <ref name="figure"/>
-            <ref name="formula"/>
-          </choice>
-        </oneOrMore>
-      </element>
-    </define>
     <define name="annex">
       <element name="annex">
         <optional>
@@ -333,6 +309,11 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -341,6 +322,12 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
@@ -358,57 +345,6 @@
         </oneOrMore>
       </choice>
     </define>
-    <define name="table">
-      <element name="table">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <optional>
-          <attribute name="width"/>
-        </optional>
-        <optional>
-          <attribute name="unnumbered">
-            <data type="boolean"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="number"/>
-        </optional>
-        <optional>
-          <attribute name="subsequence"/>
-        </optional>
-        <optional>
-          <attribute name="alt"/>
-        </optional>
-        <optional>
-          <attribute name="summary"/>
-        </optional>
-        <optional>
-          <attribute name="uri">
-            <data type="anyURI"/>
-          </attribute>
-        </optional>
-        <optional>
-          <ref name="colgroup"/>
-        </optional>
-        <optional>
-          <ref name="tname"/>
-        </optional>
-        <optional>
-          <ref name="thead"/>
-        </optional>
-        <ref name="tbody"/>
-        <optional>
-          <ref name="tfoot"/>
-        </optional>
-        <zeroOrMore>
-          <ref name="table-note"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="dl"/>
-        </optional>
-      </element>
-    </define>
   </include>
   <!-- end overrides -->
   <!--
@@ -533,28 +469,6 @@
       <ref name="Clause-Section"/>
     </element>
   </define>
-  <define name="ul_li">
-    <element name="li">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="uncheckedcheckbox">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="checkedcheckbox">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
-    </element>
-  </define>
   <define name="stagename">
     <element name="stagename">
       <text/>

data/lib/asciidoctor/iso/validate.rb

@@ -209,6 +209,7 @@ module Asciidoctor
       def image_name_validate(xmldoc)
         prefix = image_name_prefix(xmldoc) or return
         xmldoc.xpath("//image").each do |i|
+          next if i["src"].start_with?("data:")
           if /^ISO_\d+_/.match(File.basename(i["src"]))
           elsif /^(SL)?#{prefix}fig/.match(File.basename(i["src"]))
             image_name_validate1(i, prefix)

data/lib/isodoc/iso/base_convert.rb

@@ -152,6 +152,17 @@ module IsoDoc
           name and name.children.each { |n| parse(n, div) }
         end
       end
+
+      def middle(isoxml, out)
+        super
+        indexsect isoxml, out
+      end
+
+      def indexsect(isoxml, out)
+        isoxml.xpath(ns("//indexsect")).each do |i|
+          clause_parse(i, out)
+        end
+      end
     end
   end
 end

data/lib/isodoc/iso/i18n-en.yaml

@@ -14,3 +14,7 @@ price_based_on: Price based on % pages
 under_preparation: Under preparation. (Stage at the time of publication %).
 table_of_contents: Contents
 date: Date
+index: Index
+see: see
+see_also: see also
+

data/lib/isodoc/iso/i18n-fr.yaml

@@ -13,3 +13,7 @@ reference_number: Numéro de référence
 price_based_on: Prix basé sur % pages
 under_preparation: En cours d'élaboration. (Stade au moment de la publication %).
 date: Date
+index: Index
+see: voir
+see_also: voir aussi
+

data/lib/isodoc/iso/i18n-zh-Hans.yaml

@@ -11,3 +11,7 @@ reference_number: 参考编号
 price_based_on: 价格基于%页
 under_preparation: 制定中（出版时最新状态为%）
 date: 日期
+index: 索引
+see: 见
+see_also: 另见
+

data/lib/isodoc/iso/index.rb

@@ -0,0 +1,139 @@
+module IsoDoc
+  module Iso
+    class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
+      def index(docxml)
+        unless docxml.at(ns("//index"))
+          docxml.xpath(ns("//indexsect")).each { |i| i.remove }
+          return
+        end
+        i = docxml.at(ns("//indexsect")) ||
+          docxml.root.add_child("<indexsect #{add_id}><title>#{@i18n.index}</title></indexsect>").first
+        index = sort_indexterms(docxml.xpath(ns("//index")), docxml.xpath(ns("//index-xref[@also = 'false']")),
+                                docxml.xpath(ns("//index-xref[@also = 'true']")))
+        index1(docxml, i, index)
+      end
+
+      def index1(docxml, i, index)
+        c = i.add_child("<ul></ul>").first
+        index.keys.sort.each do |k|
+          #c = i.add_child "<clause #{add_id}><title>#{k}</title><ul></ul></clause>"
+          words = index[k].keys.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+          words.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+            #c.first.at(ns("./ul")).add_child index_entries(words, index[k], w)
+            c.add_child index_entries(words, index[k], w)
+          end
+        end
+        @xrefs.bookmark_anchor_names(docxml.xpath(ns(@xrefs.sections_xpath)))
+      end
+
+      def sortable(s)
+        HTMLEntities.new.decode(Nokogiri::XML.fragment(s).text)
+      end
+
+      def index_entries_opt
+        { xref_lbl: ", ", see_lbl: ", #{see_lbl}", also_lbl: ", #{also_lbl}" }
+      end
+
+      def index_entries(words, index, primary)
+        ret = index_entries_head(words[primary], index.dig(words[primary], nil, nil), index_entries_opt)
+        words2 = index[words[primary]]&.keys&.reject { |k| k.nil?}&.each_with_object({}) { |w, v| v[w.downcase] = w }
+        unless words2.empty?
+          ret += "<ul>"
+          words2.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+            ret += index_entries2(words2, index[words[primary]], w)
+          end
+          ret += "</ul>"
+        end
+        ret + "</li>"
+      end
+
+      def index_entries2(words, index, secondary)
+        ret = index_entries_head(words[secondary], index.dig(words[secondary], nil), index_entries_opt)
+        words3 = index[words[secondary]]&.keys&.reject { |k| k.nil?}&.each_with_object({}) { |w, v| v[w.downcase] = w }
+        unless words3.empty?
+          ret += "<ul>"
+          words3.keys.localize(@lang.to_sym).sort.to_a.each do |w|
+            ret += (index_entries_head(words3[w], index[words[secondary]][words3[w]], index_entries_opt) + "</li>")
+          end
+          ret += "</ul>"
+        end
+        ret + "</li>"
+      end
+
+      def index_entries_head(head, entries, opt)
+        ret = "<li>#{head}"
+        xref = entries&.dig(:xref)&.join(", ")
+        see_sort = entries&.dig(:see)&.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+        see = see_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map { |k| see_sort[k] }&.join(", ")
+        also_sort = entries&.dig(:also)&.each_with_object({}) { |w, v| v[sortable(w).downcase] = w }
+        also = also_sort&.keys&.localize(@lang.to_sym)&.sort&.to_a&.map { |k| also_sort[k] }&.join(", ")
+        ret += "#{opt[:xref_lbl]} #{xref}" if xref
+        ret += "#{opt[:see_lbl]} #{see}" if see
+        ret += "#{opt[:also_lbl]} #{also}" if also
+        ret
+      end
+
+      def see_lbl
+        @lang == "en" ? @i18n.see : "<em>#{@i18n.see}</em>"
+      end
+
+      def also_lbl
+        @lang == "en" ? @i18n.see_also : "<em>#{@i18n.see_also}</em>"
+      end
+
+      def sort_indexterms(terms, see, also)
+        index = extract_indexterms(terms)
+        index = extract_indexsee(index, see, :see)
+        index = extract_indexsee(index, also, :also)
+        index.keys.sort.each_with_object({}) do |k, v|
+          v[sortable(k)[0].upcase.transliterate] ||= {}
+          v[sortable(k)[0].upcase.transliterate][k] = index[k]
+        end
+      end
+
+      def extract_indexsee(v, terms, label)
+        terms.each_with_object(v) do |t, v|
+          term = t&.at(ns("./primary"))&.children&.to_xml
+          term2 = t&.at(ns("./secondary"))&.children&.to_xml
+          term3 = t&.at(ns("./tertiary"))&.children&.to_xml
+          v[term] ||= {}
+          v[term][term2] ||= {}
+          v[term][term2][term3] ||= {}
+          v[term][term2][term3][label] ||= []
+          v[term][term2][term3][label] << t&.at(ns("./target"))&.children&.to_xml
+          t.remove
+        end
+      end
+
+      def xml_encode_attr(s)
+        HTMLEntities.new.encode(s, :basic, :hexadecimal).gsub(/\&#x([^;]+);/) { |x| "&#x#{$1.upcase};" }
+      end
+
+      # attributes are decoded into UTF-8, elements in extract_indexsee are still in entities
+      def extract_indexterms(terms)
+        terms.each_with_object({}) do |t, v|
+          term = t&.at(ns("./primary"))&.children&.to_xml
+          term2 = t&.at(ns("./secondary"))&.children&.to_xml
+          term3 = t&.at(ns("./tertiary"))&.children&.to_xml
+          index2bookmark(t)
+          v[term] ||= {}
+          v[term][term2] ||= {}
+          v[term][term2][term3] ||= {}
+          v[term][term2][term3][:xref] ||= []
+          to = t["to"] ? "to='#{t['to']}' " : ""
+          v[term][term2][term3][:xref] << "<xref target='#{t['id']}' #{to}pagenumber='true'/>"
+        end
+      end
+
+      def index2bookmark(t)
+        t.name = "bookmark"
+        t.children.each { |x| x.remove }
+        t["id"] = "_#{UUIDTools::UUID.random_create}"
+      end
+    end
+  end
+end