metanorma-iho 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b584b6fa781275652a98ee3029be04d052719fc33eaa7462b51775ee6fc08d
-  data.tar.gz: ac2f2a77f10fd8b4ac1064805beaea4887647d3415ef4b9f88786a5e00fe4d7f
+  metadata.gz: 74009f28ae0e8d7d53ae1ba871d3d343cb343e2c907455d50507de29ef3824d9
+  data.tar.gz: 25ec650bf51cdcbb5fab99d9ba8716dcd25b2b301f05f384daf55efa19aa3e1d
 SHA512:
-  metadata.gz: fad6047649865379a781e21425b19a7751a286d31ea491196161d4d498cc1bc6c5b7eedd50e9c44fb73aae47cb5408a2120f76069c6ef35e3df64e0039efb14b
-  data.tar.gz: 485504744f7aff4dcb26ee6da3f95086b671c60e92c2ceac1cd878a6333be248e9168bfdb556c558583b002b04365178cdd67750bc1e0b49a33f5404786a9c57
+  metadata.gz: 7aa71c58b70bf5a1cf8f3c3b5f6c4a6606f2fafbb5683719b3601e3485a81ce297f7f1f1bcfc551b867999636824825ba8e2d357360e8019e3d1b73eaae17482
+  data.tar.gz: 5551240737a8d2ec9f765fcf4db38b33916c81ae0a3f8ca977f6418fa29793d1cda0ec3e943c5aea94337760bc5e6b0fca29a8b86929a062fde7302f551062ed

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,14 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
-Rails:
-  Enabled: true
+  TargetRubyVersion: 2.5

data/lib/asciidoctor/iho/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/iho/converter.rb

@@ -1,5 +1,5 @@
 require "asciidoctor/standoc/converter"
-require 'asciidoctor/generic/converter'
+require "asciidoctor/generic/converter"
 
 module Asciidoctor
   module IHO
@@ -7,8 +7,8 @@ module Asciidoctor
     # schema encapsulation of the document for validation
     #
     class Converter < Asciidoctor::Generic::Converter
-      XML_ROOT_TAG = 'iho-standard'.freeze
-      XML_NAMESPACE = 'https://www.metanorma.org/ns/iho'.freeze
+      XML_ROOT_TAG = "iho-standard".freeze
+      XML_NAMESPACE = "https://www.metanorma.org/ns/iho".freeze
 
       register_for "iho"
 
@@ -33,7 +33,7 @@ module Asciidoctor
         M: "Miscellaneous",
         P: "Periodic",
         S: "Standards and Specifications",
-      }
+      }.freeze
 
       def metadata_series(node, xml)
         series = node.attr("series") or return
@@ -59,7 +59,8 @@ module Asciidoctor
 
       def metadata_committee(node, xml)
         unless node.attr("workgroup")
-          @log.add("AsciiDoc Input", nil, "Missing workgroup attribute for document")
+          @log.add("AsciiDoc Input", nil,
+                   "Missing workgroup attribute for document")
           return
         end
         metadata_committee1(node, xml)
@@ -75,7 +76,7 @@ module Asciidoctor
           end
         end
         i = 2
-        while node.attr("workgroup_#{i}") do
+        while node.attr("workgroup_#{i}")
           xml.editorialgroup do |a|
             a.committee do |n|
               n.abbreviation node.attr("committee_#{i}").upcase
@@ -102,6 +103,7 @@ module Asciidoctor
 
       def pdf_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::IHO::PdfConvert.new(html_extract_attributes(node))
       end
 

data/lib/asciidoctor/iho/iho.rng

@@ -36,6 +36,9 @@
       <optional>
         <ref name="doctype"/>
       </optional>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <zeroOrMore>
         <ref name="editorialgroup"/>
       </zeroOrMore>

data/lib/asciidoctor/iho/isodoc.rng

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -543,6 +548,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -876,8 +884,28 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="pagebreak">
+      <element name="pagebreak">
+        <optional>
+          <attribute name="orientation">
+            <choice>
+              <value>landscape</value>
+              <value>portrait</value>
+            </choice>
+          </attribute>
+        </optional>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="docsubtype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -943,8 +971,170 @@
       <ref name="permission"/>
       <ref name="imagemap"/>
       <ref name="svgmap"/>
+      <ref name="inputform"/>
+    </choice>
+  </define>
+  <define name="inputform">
+    <element name="form">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="name"/>
+      <attribute name="action"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="TextElement"/>
+          <ref name="FormInput"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="FormInput">
+    <choice>
+      <ref name="input"/>
+      <ref name="formlabel"/>
+      <ref name="select"/>
+      <ref name="textarea"/>
+    </choice>
+  </define>
+  <define name="InputType">
+    <choice>
+      <value>button</value>
+      <value>checkbox</value>
+      <value>date</value>
+      <value>file</value>
+      <value>password</value>
+      <value>radio</value>
+      <value>submit</value>
+      <value>text</value>
     </choice>
   </define>
+  <define name="input">
+    <element name="input">
+      <attribute name="type">
+        <ref name="InputType"/>
+      </attribute>
+      <optional>
+        <attribute name="checked">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="readonly">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="maxlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="minlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
+  <define name="formlabel">
+    <element name="label">
+      <attribute name="for">
+        <data type="IDREF"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="select">
+    <element name="select">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="multiple">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="size">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="option"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="option">
+    <element name="option">
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="textarea">
+    <element name="textarea">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="rows">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="cols">
+          <data type="int"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
   <define name="bibliography">
     <element name="bibliography">
       <oneOrMore>
@@ -1017,9 +1207,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>

data/lib/isodoc/iho/base_convert.rb

@@ -15,30 +15,32 @@ module IsoDoc
         super
       end
 
-      def std_bibitem_entry(list, b, ordinal, biblio)
-        list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+      def std_bibitem_entry(list, bib, ordinal, biblio)
+        list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
           prefix_bracketed_ref(ref, "[#{ordinal}]")
-          standard_citation(ref, b)
+          standard_citation(ref, bib)
         end
       end
 
-      def nodes_to_span(n)
+      def nodes_to_span(node)
         noko do |xml|
           xml.span do |s|
-            n&.children&.each { |x| parse(x, s) }
+            node&.children&.each { |x| parse(x, s) }
           end
         end.join("")
       end
 
       def multiplenames_and(names)
-        return "" if names.length == 0
+        return "" if names.empty?
         return names[0] if names.length == 1
         return "#{names[0]} and #{names[1]}" if names.length == 2
+
         names[0..-2].join(", ") + " and #{names[-1]}"
       end
 
-      def extract_publisher(b)
-        c = b.xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
+      def extract_publisher(bib)
+        c = bib
+          .xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
         abbrs = []
         names = []
         c&.each do |c1|
@@ -47,63 +49,55 @@ module IsoDoc
           names << nodes_to_span(n)
         end
         return [nil, nil] if names.empty?
-        return [multiplenames_and(names), (abbrs.map { |x| x.text }).join("/")]
+
+        [multiplenames_and(names), abbrs.map(&:text).join("/")]
       end
 
-      def inline_bibitem_ref_code(b)
-        id = b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
-                     "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
-        id ||= b.at(ns("./docidentifier[not(@type = 'metanorma')]"))
+      def inline_bibitem_ref_code(bib)
+        id = bib.at(ns("./docidentifier[not(@type = 'DOI' or "\
+                       "@type = 'metanorma' or @type = 'ISSN' or "\
+                       "@type = 'ISBN' or @type = 'rfc-anchor')]"))
+        id ||= bib.at(ns("./docidentifier[not(@type = 'metanorma')]"))
         return [nil, id, nil] if id
-        id = Nokogiri::XML::Node.new("docidentifier", b.document)
+
+        id = Nokogiri::XML::Node.new("docidentifier", bib.document)
         id << "(NO ID)"
         [nil, id, nil]
       end
 
-      def extract_edition(b)
-        b&.at(ns("./edition"))&.text
+      def extract_edition(bib)
+        bib&.at(ns("./edition"))&.text
       end
 
-      def extract_uri(b)
-        b.at(ns("./uri"))
+      def extract_uri(bib)
+        bib.at(ns("./uri"))
       end
 
       def omit_docid_prefix(prefix)
         return true if prefix == "IHO"
+
         super
       end
 
       def render_identifier(id)
-        if !id[1].nil? and id[1]["type"] == "IHO"
+        if !id[1].nil? && (id[1]["type"] == "IHO")
           id[1].children = id[1].text.sub(/^IHO /, "")
         end
         super
       end
 
-      def extract_publisher(b)
-        c = b.xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
-        abbrs = []
-        names = []
-        c&.each do |c1|
-          n = c1.at(ns("./organization/name")) or next
-          abbrs << (c1.at(ns("./organization/abbreviation")) || n)
-          names << nodes_to_span(n)
-        end
-        return [nil, nil] if names.empty?
-        return [multiplenames_and(names), (abbrs.map { |x| x.text }).join("/")]
-      end
+      def extract_author(bib)
+        c = bib.xpath(ns("./contributor[role/@type = 'author']"))
+        c = bib.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
+        return extract_publisher(bib)[0] if c.empty?
 
-      def extract_author(b)
-        c = b.xpath(ns("./contributor[role/@type = 'author']"))
-        c = b.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
-        return extract_publisher(b)[0] if c.empty?
         c.map do |c1|
           c1&.at(ns("./organization/name"))&.text || extract_person_name(c1)
         end.reject { |e| e.nil? || e.empty? }.join(", ")
       end
 
-      def extract_person_name(b)
-        p = b.at(ns("./person/name")) or return
+      def extract_person_name(bib)
+        p = bib.at(ns("./person/name")) or return
         c = p.at(ns("./completename")) and return c.text
         s = p&.at(ns("./surname"))&.text or return
         i = p.xpath(ns("./initial")) and
@@ -113,25 +107,25 @@ module IsoDoc
         front ? "#{s} #{front}" : s
       end
 
-      def is_iho?(b)
-        extract_publisher(b)[1] == "IHO"
+      def iho?(bib)
+        extract_publisher(bib)[1] == "IHO"
       end
 
       # [{number}] {docID} edition {edition}: {title}, {author/organization}
-      def standard_citation(out, b)
-        if ftitle = b.at(ns("./formattedref"))
+      def standard_citation(out, bib)
+        if ftitle = bib.at(ns("./formattedref"))
           ftitle&.children&.each { |n| parse(n, out) }
         else
-          id = render_identifier(inline_bibitem_ref_code(b))
+          id = render_identifier(inline_bibitem_ref_code(bib))
           out << id[1] if id[1]
-          ed = extract_edition(b) if is_iho?(b)
+          ed = extract_edition(bib) if iho?(bib)
           out << " edition #{ed}" if ed
           out << ": " if id[1] || ed
-          iso_title(b)&.children&.each { |n| parse(n, out) }
+          iso_title(bib)&.children&.each { |n| parse(n, out) }
           out << ", "
-          author = extract_author(b)
+          author = extract_author(bib)
           out << author
-          u = extract_uri(b)
+          u = extract_uri(bib)
           out << " (<a href='#{u.text}'>#{u.text}</a>)" if u
         end
       end