RubyGems - metanorma-iso - Versions diffs - 1.3.22 → 1.3.27 - Mend

metanorma-iso 1.3.22 → 1.3.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (69) hide show

checksums.yaml +4 -4
data/.github/workflows/macos.yml +8 -7
data/.github/workflows/ubuntu.yml +8 -7
data/.github/workflows/windows.yml +8 -8
data/Gemfile +2 -0
data/lib/asciidoctor/iso/base.rb +22 -0
data/lib/asciidoctor/iso/biblio.rng +89 -32
data/lib/asciidoctor/iso/cleanup.rb +20 -3
data/lib/asciidoctor/iso/front.rb +16 -107
data/lib/asciidoctor/iso/front_id.rb +196 -0
data/lib/asciidoctor/iso/isodoc.rng +475 -2
data/lib/asciidoctor/iso/isostandard-amd.rng +98 -0
data/lib/asciidoctor/iso/isostandard.rng +12 -1
data/lib/asciidoctor/iso/macros.rb +21 -0
data/lib/asciidoctor/iso/reqt.rng +23 -0
data/lib/asciidoctor/iso/section.rb +18 -32
data/lib/asciidoctor/iso/term_lookup_cleanup.rb +87 -0
data/lib/asciidoctor/iso/validate.rb +41 -25
data/lib/asciidoctor/iso/validate_requirements.rb +1 -1
data/lib/asciidoctor/iso/validate_section.rb +2 -2
data/lib/asciidoctor/iso/validate_style.rb +6 -5
data/lib/asciidoctor/iso/validate_title.rb +1 -1
data/lib/isodoc/iso/base_convert.rb +77 -107
data/lib/isodoc/iso/html/header.html +10 -6
data/lib/isodoc/iso/html/html_iso_titlepage.html +27 -18
data/lib/isodoc/iso/html/isodoc.scss +53 -28
data/lib/isodoc/iso/html/scripts.html +23 -21
data/lib/isodoc/iso/html/style-human.scss +23 -0
data/lib/isodoc/iso/html/style-iso.scss +18 -0
data/lib/isodoc/iso/html/word_iso_intro.html +4 -0
data/lib/isodoc/iso/html/word_iso_titlepage.html +23 -2
data/lib/isodoc/iso/html/wordstyle.scss +80 -39
data/lib/isodoc/iso/html_convert.rb +7 -9
data/lib/isodoc/iso/iso.amendment.xsl +4597 -0
data/lib/isodoc/iso/iso.international-standard.xsl +4597 -0
data/lib/isodoc/iso/metadata.rb +71 -23
data/lib/isodoc/iso/pdf_convert.rb +39 -0
data/lib/isodoc/iso/sections.rb +66 -0
data/lib/isodoc/iso/sts_convert.rb +29 -0
data/lib/isodoc/iso/xref.rb +105 -0
data/lib/metanorma-iso.rb +2 -0
data/lib/metanorma/iso/processor.rb +16 -1
data/lib/metanorma/iso/version.rb +1 -1
data/metanorma-iso.gemspec +4 -1
data/spec/asciidoctor-iso/amd_spec.rb +726 -0
data/spec/asciidoctor-iso/base_spec.rb +38 -21
data/spec/asciidoctor-iso/blocks_spec.rb +6 -6
data/spec/asciidoctor-iso/cleanup_spec.rb +195 -174
data/spec/asciidoctor-iso/inline_spec.rb +2 -1
data/spec/asciidoctor-iso/macros_spec.rb +289 -0
data/spec/asciidoctor-iso/refs_spec.rb +8 -5
data/spec/asciidoctor-iso/section_spec.rb +8 -8
data/spec/assets/iso.xml +64 -1
data/spec/isodoc/amd_spec.rb +652 -0
data/spec/isodoc/blocks_spec.rb +112 -27
data/spec/isodoc/i18n_spec.rb +12 -20
data/spec/isodoc/inline_spec.rb +4 -4
data/spec/isodoc/iso_spec.rb +1 -1
data/spec/isodoc/metadata_spec.rb +92 -4
data/spec/isodoc/postproc_spec.rb +21 -120
data/spec/isodoc/ref_spec.rb +9 -9
data/spec/isodoc/section_spec.rb +36 -13
data/spec/isodoc/table_spec.rb +30 -30
data/spec/isodoc/terms_spec.rb +6 -6
data/spec/isodoc/xref_spec.rb +43 -37
data/spec/metanorma/processor_spec.rb +2 -2
data/spec/spec_helper.rb +11 -0
metadata +58 -5
data/asciidoctor-iso.gemspec.old +0 -50

data/lib/asciidoctor/iso/front_id.rb ADDED

@@ -0,0 +1,196 @@
+require "date"
+require "nokogiri"
+require "htmlentities"
+require "json"
+require "pathname"
+require "open-uri"
+require "twitter_cldr"
+module Asciidoctor
+  module ISO
+    class Converter < Standoc::Converter
+      STAGE_ABBRS = {
+        "00": "PWI",
+        "10": "NWIP",
+        "20": "WD",
+        "30": "CD",
+        "40": "DIS",
+        "50": "FDIS",
+        "60": "IS",
+        "90": "(Review)",
+        "95": "(Withdrawal)",
+      }.freeze
+      STAGE_NAMES = {
+        "00": "Preliminary work item",
+        "10": "New work item proposal",
+        "20": "Working draft",
+        "30": "Committee draft",
+        "40": "Draft",
+        "50": "Final draft",
+        "60": "International standard",
+        "90": "Review",
+        "95": "Withdrawal",
+      }.freeze
+      def stage_abbr(stage, substage, doctype)
+        return nil if stage.to_i > 60
+        ret = STAGE_ABBRS[stage.to_sym]
+        ret = "PRF" if stage == "60" && substage == "00"
+        if %w(amendment technical-corrigendum technical-report
+          technical-specification).include?(doctype)
+          ret = "NP" if stage == "10"
+          ret = "AWI" if stage == "10" && substage == "99"
+          ret = "D" if stage == "40" and doctype == "amendment"
+          ret = "FD" if stage == "50" and
+            %w(amendment technical-corrigendum).include?(doctype)
+          ret = "D" if stage == "50" and
+            %w(technical-report technical-specification).include?(doctype)
+        end
+        ret
+      end
+      def stage_name(stage, substage, doctype, iteration = nil)
+        return "Proof" if stage == "60" && substage == "00"
+        ret = STAGE_NAMES[stage.to_sym]
+        if iteration && %w(20 30).include?(stage)
+          prefix  = iteration.to_i.localize(@lang.to_sym).
+            to_rbnf_s("SpelloutRules", "spellout-ordinal")
+          ret = "#{prefix.capitalize} #{ret.downcase}"
+        end
+        ret
+      end
+      def metadata_id(node, xml)
+        iso_id(node, xml)
+        node&.attr("tc-docnumber")&.split(/,\s*/)&.each do |n|
+          xml.docidentifier(n, **attr_code(type: "iso-tc"))
+        end
+        xml.docnumber node&.attr("docnumber")
+      end
+      def iso_id(node, xml)
+        return unless !@amd && node.attr("docnumber") ||
+          @amd && node.attr("updates")
+        dn = iso_id1(node)
+        dn1 = id_stage_prefix(dn, node, false)
+        dn2 = id_stage_prefix(dn, node, true)
+        xml.docidentifier dn1, **attr_code(type: "ISO")
+        xml.docidentifier id_langsuffix(dn1, node),
+          **attr_code(type: "iso-with-lang")
+        xml.docidentifier id_langsuffix(dn2, node),
+          **attr_code(type: "iso-reference")
+      end
+      def iso_id1(node)
+        if @amd
+          dn = node.attr("updates")
+          return add_amd_parts(dn, node)
+        else
+          part, subpart = node&.attr("partnumber")&.split(/-/)
+          return add_id_parts(node.attr("docnumber"), part, subpart)
+        end
+      end
+      def add_amd_parts(dn, node)
+        a = node.attr("amendment-number")
+        c = node.attr("corrigendum-number")
+        case node.attr("doctype")
+        when "amendment"
+          "#{dn}/Amd #{node.attr('amendment-number')}"
+        when "technical-corrigendum"
+          "#{dn}/Cor.#{node.attr('corrigendum-number')}"
+        end
+      end
+      def id_langsuffix(dn, node)
+        lang = node.attr("language") || "en"
+        suffix = case lang
+                 when "en" then "(E)"
+                 when "fr" then "(F)"
+                 else
+                   "(X)"
+                 end
+        "#{dn}#{suffix}"
+      end
+      def structured_id(node, xml)
+        return unless node.attr("docnumber")
+        part, subpart = node&.attr("partnumber")&.split(/-/)
+        xml.structuredidentifier do |i|
+          i.project_number node.attr("docnumber"),
+            **attr_code(part: part, subpart: subpart,
+                        amendment: node.attr("amendment-number"),
+                        corrigendum: node.attr("corrigendum-number"),
+                        origyr: node.attr("created-date"))
+        end
+      end
+      def add_id_parts(dn, part, subpart)
+        dn += "-#{part}" if part
+        dn += "-#{subpart}" if subpart
+        dn
+      end
+      def id_stage_abbr(stage, substage, node)
+        ret = IsoDoc::Iso::Metadata.new("en", "Latn", {}).
+          status_abbrev(stage_abbr(stage, substage, node.attr("doctype")),
+                        substage, node.attr("iteration"),
+                        node.attr("draft"), node.attr("doctype"))
+        if %w(amendment technical-corrigendum amendment
+          technical-corrigendum).include?(node.attr("doctype"))
+          ret = ret + " " unless %w(40 50).include?(stage)
+        end
+        ret
+      end
+      def id_stage_prefix(dn, node, force_year)
+        stage = get_stage(node)
+        typeabbr = get_typeabbr(node)
+        if stage && (stage.to_i < 60)
+          dn = unpub_stage_prefix(dn, stage, typeabbr, node)
+        elsif typeabbr && !@amd then dn = "/#{typeabbr}#{dn}"
+        end
+        (force_year || !(stage && (stage.to_i < 60))) and
+          dn = id_add_year(dn, node)
+        dn
+      end
+      def unpub_stage_prefix(dn, stage, typeabbr, node)
+        abbr = id_stage_abbr(stage, get_substage(node), node)
+        %w(40 50).include?(stage) && i = node.attr("iteration") and
+          itersuffix = ".#{i}"
+        return dn if abbr.nil? || abbr.empty? # prefixes added in cleanup
+        return "/#{abbr}#{typeabbr} #{dn}#{itersuffix}" unless @amd
+        a = dn.split(%r{/})
+        a[-1] = "#{abbr}#{a[-1]}#{itersuffix}"
+        a.join("/")
+      end
+      def id_add_year(dn, node)
+        year = node.attr("copyright-year")
+        @amd and year ||= node.attr("updated-date")&.sub(/-.*$/, "")
+        dn += ":#{year}" if year
+        dn
+      end
+      def get_stage(node)
+        stage = node.attr("status") || node.attr("docstage") || "60"
+      end
+      def get_substage(node)
+        stage = get_stage(node)
+        node.attr("docsubstage") || ( stage == "60" ? "60" : "00" )
+      end
+      def get_typeabbr(node)
+        case node.attr("doctype")
+        when "technical-report" then "TR "
+        when "technical-specification" then "TS "
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/isodoc.rng CHANGED

@@ -53,9 +53,96 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="case">
+            <choice>
+              <value>capital</value>
+              <value>lowercase</value>
+            </choice>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
+    <define name="ul">
+      <element name="ul">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <attribute name="type">
+          <choice>
+            <value>roman</value>
+            <value>alphabet</value>
+            <value>arabic</value>
+            <value>roman_upper</value>
+            <value>alphabet_upper</value>
+          </choice>
+        </attribute>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="dl">
+      <element name="dl">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="dt"/>
+          <ref name="dd"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="example">
       <element name="example">
         <attribute name="id">
@@ -69,6 +156,19 @@
         <optional>
           <attribute name="subsequence"/>
         </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -89,6 +189,296 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="table">
+      <element name="table">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <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>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </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>
+    <define name="figure">
+      <element name="figure">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <optional>
+          <ref name="source"/>
+        </optional>
+        <optional>
+          <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>
+        </choice>
+        <zeroOrMore>
+          <ref name="fn"/>
+        </zeroOrMore>
+        <optional>
+          <ref name="dl"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="sourcecode">
+      <element name="sourcecode">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="lang"/>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout"/>
+          </choice>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="annotation"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="formula">
+      <element name="formula">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="inequality">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <ref name="stem"/>
+        <optional>
+          <ref name="dl"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="ParagraphType">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <optional>
+        <attribute name="align">
+          <ref name="Alignments"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-with-next">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-lines-together">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="note"/>
+      </zeroOrMore>
+    </define>
+    <define name="paragraph-with-footnote">
+      <element name="p">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="align">
+            <ref name="Alignments"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <choice>
+            <ref name="TextElement"/>
+            <ref name="fn"/>
+          </choice>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="quote">
+      <element name="quote">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="alignment">
+            <ref name="Alignments"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="quote-source"/>
+        </optional>
+        <optional>
+          <ref name="quote-author"/>
+        </optional>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
       <optional>
@@ -129,6 +519,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -154,6 +547,30 @@
         <attribute name="id">
           <data type="ID"/>
         </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="type"/>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -305,6 +722,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="concept"/>
+  </define>
+  <define name="concept">
+    <element name="concept">
+      <optional>
+        <attribute name="term"/>
+      </optional>
+      <choice>
+        <ref name="eref"/>
+        <ref name="xref"/>
+        <ref name="termref"/>
+      </choice>
+    </element>
+  </define>
   <define name="BasicBlock" combine="choice">
     <choice>
       <ref name="requirement"/>
@@ -884,7 +1316,36 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
-      <ref name="paragraph"/>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
+      <optional>
+        <attribute name="subsequence"/>
+      </optional>
+      <optional>
+        <attribute name="keep-with-next">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-lines-together">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <choice>
+          <ref name="paragraph"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="formula"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="termexample">
@@ -911,7 +1372,10 @@
   </define>
   <define name="origin">
     <element name="origin">
-      <ref name="erefType"/>
+      <choice>
+        <ref name="erefType"/>
+        <ref name="termref"/>
+      </choice>
     </element>
   </define>
   <define name="modification">
@@ -919,6 +1383,15 @@
       <ref name="paragraph"/>
     </element>
   </define>
+  <define name="termref">
+    <element name="termref">
+      <attribute name="base"/>
+      <attribute name="target"/>
+      <optional>
+        <text/>
+      </optional>
+    </element>
+  </define>
   <define name="structuredidentifier">
     <element name="structuredidentifier">
       <optional>