metanorma-iso 1.10.5 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a8f44a84f1173e2b495a6ccb50683b6b17454ec8408b740a1adb56b3c05e4a2
-  data.tar.gz: 6efb198dffa92685545a865310668345cbc20f6b6a08e79d1b63cbda0961aa27
+  metadata.gz: ef810ff6a80b7f991baeea2dd6f59f0f775ae33fd61e118d8658ea2c3c8d3179
+  data.tar.gz: b7b137372e0a4d74373f83a5c902d595061d2421a86863b3c934459a4f88de51
 SHA512:
-  metadata.gz: c848159c457326d7cd76a3000721b063d16febbd3f7db96a673a666c0fe8abddcc0c0ef6bc330a4d0be85a09b101e22dda9d954e9b7ae4c331cd698168c827a6
-  data.tar.gz: d1b9dd77f0e81ec1aa9e0415d83026bab80a59dd205fd0d0cd2349e0e41b5a22078928120f9e373f220391a50d17b10320577d18796a7973792f503f63eca89f
+  metadata.gz: ff07cad24919df83b2a7f827056eacb722b2e63b02164d28adef6ab6b43a64e9c5df0f828518b31eea5e2dbf741f89b16289b0660d116ed9cf9ff74be808390b
+  data.tar.gz: 553648a7a66607ea74d515ff3442161e6897ac5e38f75e0cb69ce54ae8fcc6fefd94e71ac4963c2caa6d1778b5c6e04ac63294312d5a2471387f5e8352f729ba

data/.github/workflows/rake.yml

@@ -1,5 +1,3 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: rake
 
 on:
@@ -10,34 +8,6 @@ on:
 
 jobs:
   rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@master
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - uses: metanorma/metanorma-build-scripts/plantuml-setup-action@master
-
-      - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: tests-passed
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+    uses: metanorma/metanorma-build-scripts/.github/workflows/plantuml-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.gitignore

@@ -11,3 +11,29 @@ spec/examples/rice.xml
 spec/examples/rice_files/
 
 .rubocop-https--*
+
+/Gemfile.devel
+/Gemfile.lock
+/spec/assets/iso.doc
+/spec/assets/iso.html
+/spec/assets/iso.pdf
+/test.doc
+/test.err
+/test.html
+/test.iso.sts.xml
+/test.pdf
+/test.presentation.xml
+/test.sts.xml
+/test.xml
+/test_alt.html
+/xref_error.adoc
+/xref_error.alt.html
+/xref_error.doc
+/xref_error.err
+/xref_error.html
+/xref_error.iso.sts.xml
+/xref_error.pdf
+/xref_error.presentation.xml
+/xref_error.rxl
+/xref_error.sts.xml
+/xref_error.xml

data/Makefile

@@ -14,7 +14,7 @@ TRANG_JAR := $(TOOLS_DIR)/trang.jar
 XSDVIPATH := $(TOOLS_DIR)/xsdvi.jar
 XSLT_FILE := $(TOOLS_DIR)/xs3pxsl
 XSLT_FILE_MERGE := $(TOOLS_DIR)/xsdmerge.xsl
-RNG_FILE_SRC := lib/asciidoctor/iso/isostandard.rng
+RNG_FILE_SRC := lib/metanorma/iso/isostandard.rng
 XSD_FILE_DEST := ${CURDIR}/xsd_doc/isostandard.xsd
 
 all: $(TXT) $(HTML) $(XML) $(NITS)

data/lib/asciidoctor/iso/base.rb

@@ -1,70 +1,3 @@
-require "date"
-require "nokogiri"
-require "json"
-require "pathname"
-require "open-uri"
-require "isodoc"
-require "fileutils"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/base"
 
-module Asciidoctor
-  module ISO
-    class Converter < Standoc::Converter
-      XML_ROOT_TAG = "iso-standard".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/iso".freeze
-
-      def html_converter(node)
-        IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node))
-      end
-
-      def html_converter_alt(node)
-        IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node)
-                                     .merge(alt: true))
-      end
-
-      def doc_converter(node)
-        IsoDoc::Iso::WordConvert.new(doc_extract_attributes(node))
-      end
-
-      def pdf_converter(node)
-        return nil if node.attr("no-pdf")
-
-        IsoDoc::Iso::PdfConvert.new(pdf_extract_attributes(node))
-      end
-
-      def sts_converter(node)
-        return nil if node.attr("no-pdf")
-
-        IsoDoc::Iso::StsConvert.new(html_extract_attributes(node))
-      end
-
-      def presentation_xml_converter(node)
-        IsoDoc::Iso::PresentationXMLConvert.new(html_extract_attributes(node))
-      end
-
-      def init(node)
-        super
-        @amd = %w(amendment technical-corrigendum).include? doctype(node)
-        @vocab = node.attr("docsubtype") == "vocabulary"
-      end
-
-      def ol_attrs(node)
-        attr_code(keep_attrs(node)
-                  .merge(id: ::Metanorma::Utils::anchor_or_uuid(node)))
-      end
-
-      def outputs(node, ret)
-        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert("#{@filename}.xml")
-        html_converter_alt(node).convert("#{@filename}.presentation.xml",
-                                         nil, false, "#{@filename}_alt.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")
-        # sts_converter(node)&.convert(@filename + ".xml")
-      end
-    end
-  end
-end

data/lib/asciidoctor/iso/cleanup.rb

@@ -1,176 +1,3 @@
-require "date"
-require "nokogiri"
-require "htmlentities"
-require "json"
-require "pathname"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/cleanup"
 
-module Asciidoctor
-  module ISO
-    class Converter < Standoc::Converter
-      PRE_NORMREF_FOOTNOTES = "//preface//fn | "\
-                              "//clause[@type = 'scope']//fn".freeze
-
-      NORMREF_FOOTNOTES =
-        "//references[@normative = 'true']//fn".freeze
-
-      POST_NORMREF_FOOTNOTES =
-        "//sections//clause[not(@type = 'scope')]//fn | "\
-        "//annex//fn | "\
-        "//references[@normative = 'false']//fn".freeze
-
-      def other_footnote_renumber(xmldoc)
-        seen = {}
-        i = 0
-        [PRE_NORMREF_FOOTNOTES, NORMREF_FOOTNOTES,
-         POST_NORMREF_FOOTNOTES].each do |xpath|
-          xmldoc.xpath(xpath).each do |fn|
-            i, seen = other_footnote_renumber1(fn, i, seen)
-          end
-        end
-      end
-
-      def id_prefix(prefix, id)
-        # we're just inheriting the prefixes from parent doc
-        return id.text if @amd
-
-        prefix.join("/") + (id.text.match?(%{^/}) ? "" : " ") + id.text
-      end
-
-      def get_id_prefix(xmldoc)
-        prefix = []
-        xmldoc.xpath("//bibdata/contributor[role/@type = 'publisher']"\
-                     "/organization").each do |x|
-          x1 = x.at("abbreviation")&.text || x.at("name")&.text
-          (x1 == "ISO" and prefix.unshift("ISO")) or prefix << x1
-        end
-        prefix
-      end
-
-      # ISO as a prefix goes first
-      def docidentifier_cleanup(xmldoc)
-        prefix = get_id_prefix(xmldoc)
-        id = xmldoc.at("//bibdata/docidentifier[@type = 'ISO']") or return
-        id.content = id_prefix(prefix, id)
-        id = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") and
-          id.content = id_prefix(prefix, id)
-        id = xmldoc.at("//bibdata/docidentifier[@type = 'iso-with-lang']") and
-          id.content = id_prefix(prefix, id)
-        id = xmldoc.at("//bibdata/docidentifier[@type = 'iso-reference']") and
-          id.content = id_prefix(prefix, id)
-      end
-
-      def format_ref(ref, type)
-        ref = ref.sub(/ \(All Parts\)/i, "")
-        super
-      end
-
-      TERM_CLAUSE =
-        "//sections//terms | "\
-        "//sections//clause[descendant::terms][not(descendant::definitions)]"
-          .freeze
-
-      PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
-
-      OTHERIDS = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or "\
-                 "@type = 'ISBN'".freeze
-
-      def pub_class(bib)
-        return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
-        return 1 if bib.at("#{PUBLISHER}[name = 'International Organization "\
-                           "for Standardization']")
-        return 2 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
-        return 2 if bib.at("#{PUBLISHER}[name = 'International "\
-                           "Electrotechnical Commission']")
-        return 3 if bib.at("./docidentifier[@type][not(#{OTHERIDS})]")
-
-        4
-      end
-
-      def sort_biblio(bib)
-        bib.sort do |a, b|
-          sort_biblio_key(a) <=> sort_biblio_key(b)
-        end
-      end
-
-      # TODO sort by authors
-      # sort by: doc class (ISO, IEC, other standard (not DOI &c), other
-      # then standard class (docid class other than DOI &c)
-      # then docnumber if present, numeric sort
-      #      else alphanumeric metanorma id (abbreviation)
-      # then doc part number if present, numeric sort
-      # then 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(#{OTHERIDS})]")
-        metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match?(metaid)
-        /\d-(?<partid>\d+)/ =~ id&.text
-        type = id["type"] if id
-        title = bib&.at("./title[@type = 'main']")&.text ||
-          bib&.at("./title")&.text || bib&.at("./formattedref")&.text
-        "#{pubclass} :: #{type} :: "\
-          "#{num.nil? ? abbrid : sprintf('%09d', num.to_i)} :: "\
-          "#{sprintf('%09d', partid.to_i)} :: #{id&.text} :: #{title}"
-      end
-
-      def sections_cleanup(xml)
-        super
-        return unless @amd
-
-        xml.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
-      def boilerplate_file(_xmldoc)
-        file = @lang == "fr" ? "boilerplate-fr.xml" : "boilerplate.xml"
-        File.join(@libdir, file)
-      end
-
-      def footnote_cleanup(xmldoc)
-        unpub_footnotes(xmldoc)
-        super
-      end
-
-      def unpub_footnotes(xmldoc)
-        xmldoc.xpath("//bibitem/note[@type = 'Unpublished-Status']").each do |n|
-          id = n.parent["id"]
-          e = xmldoc.at("//eref[@bibitemid = '#{id}']") or next
-          fn = n.children.to_xml
-          n&.elements&.first&.name == "p" or fn = "<p>#{fn}</p>"
-          e.next = "<fn>#{fn}</fn>"
-        end
-      end
-
-      def bibitem_cleanup(xmldoc)
-        super
-        unpublished_note(xmldoc)
-      end
-
-      def unpublished_note(xmldoc)
-        xmldoc.xpath("//bibitem[not(note[@type = 'Unpublished-Status'])]")
-          .each do |b|
-          next if pub_class(b) > 2
-          next unless (s = b.at("./status/stage")) && (s.text.to_i < 60)
-
-          id = b.at("docidentifier").text
-          b.at("./language | ./script | ./abstract | ./status")
-            .previous = %(<note type="Unpublished-Status">
-                          <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>)
-        end
-      end
-
-      def termdef_boilerplate_insert(xmldoc, isodoc, once = false)
-        once = true
-        super
-      end
-
-      def term_defs_boilerplate_cont(src, term, isodoc)
-        @vocab and src.empty? and return
-        super
-      end
-    end
-  end
-end

data/lib/asciidoctor/iso/converter.rb

@@ -1,18 +1,3 @@
-require "asciidoctor"
-require "metanorma-standoc"
-require "metanorma/iso/version"
-require "asciidoctor/iso/base"
-require "asciidoctor/iso/front"
-require "asciidoctor/iso/section"
-require "asciidoctor/iso/validate"
-require "asciidoctor/iso/cleanup"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/converter"
 
-module Asciidoctor
-  module ISO
-    # A {Converter} implementation that generates ISO output, and a document
-    # schema encapsulation of the document for validation
-    class Converter < ::Asciidoctor::Standoc::Converter
-      register_for "iso"
-    end
-  end
-end

data/lib/asciidoctor/iso/deprecated.rb

@@ -0,0 +1,5 @@
+warn "Please replace your references to Asciidoctor::ISO with Metanorma::ISO and your instances of require 'asciidoctor/iso' with require 'metanorma/iso'"
+
+exit 127 if ENV['METANORMA_DEPRECATION_FAIL']
+
+Asciidoctor::ISO = Metanorma::ISO unless defined? Asciidoctor::ISO

data/lib/asciidoctor/iso/front.rb

@@ -1,170 +1,3 @@
-require "date"
-require "nokogiri"
-require "htmlentities"
-require "json"
-require "pathname"
-require "open-uri"
-require_relative "front_id"
+require "asciidoctor/iso/deprecated"
+require "metanorma/iso/front"
 
-module Asciidoctor
-  module ISO
-    class Converter < Standoc::Converter
-      def metadata_ext(node, xml)
-        super
-        structured_id(node, xml)
-        xml.stagename stage_name(get_stage(node), get_substage(node),
-                                 doctype(node), node.attr("iteration"))
-        @amd && a = node.attr("updates-document-type") and
-          xml.updates_document_type a
-      end
-
-      def metadata_subdoctype(node, xml)
-        super
-        a = node.attr("horizontal") and xml.horizontal a
-      end
-
-      def org_abbrev
-        { "International Organization for Standardization" => "ISO",
-          "International Electrotechnical Commission" => "IEC" }
-      end
-
-      def metadata_author(node, xml)
-        publishers = node.attr("publisher") || "ISO"
-        csv_split(publishers).each do |p|
-          xml.contributor do |c|
-            c.role **{ type: "author" }
-            c.organization do |a|
-              organization(a, p, false, node, !node.attr("publisher"))
-            end
-          end
-        end
-      end
-
-      def metadata_publisher(node, xml)
-        publishers = node.attr("publisher") || "ISO"
-        csv_split(publishers).each do |p|
-          xml.contributor do |c|
-            c.role **{ type: "publisher" }
-            c.organization do |a|
-              organization(a, p, true, node, !node.attr("publisher"))
-            end
-          end
-        end
-      end
-
-      def metadata_copyright(node, xml)
-        publishers = node.attr("copyright-holder") || node.attr("publisher") ||
-          "ISO"
-        csv_split(publishers).each do |p|
-          xml.copyright do |c|
-            c.from (node.attr("copyright-year") || Date.today.year)
-            c.owner do |owner|
-              owner.organization do |o|
-                organization(
-                  o, p, true, node,
-                  !(node.attr("copyright-holder") || node.attr("publisher"))
-                )
-              end
-            end
-          end
-        end
-      end
-
-      def metadata_status(node, xml)
-        stage = get_stage(node)
-        substage = get_substage(node)
-        xml.status do |s|
-          s.stage stage, **attr_code(abbreviation: cover_stage_abbr(node))
-          s.substage substage
-          node.attr("iteration") && (s.iteration node.attr("iteration"))
-        end
-      end
-
-      def metadata_committee(node, xml)
-        xml.editorialgroup do |a|
-          committee_component("technical-committee", node, a)
-          committee_component("subcommittee", node, a)
-          committee_component("workgroup", node, a)
-          node.attr("secretariat") && a.secretariat(node.attr("secretariat"))
-        end
-      end
-
-      def title_intro(node, xml, lang, at)
-        return unless node.attr("title-intro-#{lang}")
-
-        xml.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
-        end
-      end
-
-      def title_main(node, xml, lang, at)
-        xml.title **attr_code(at.merge(type: "title-main")) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
-        end
-      end
-
-      def title_part(node, xml, lang, at)
-        return unless node.attr("title-part-#{lang}")
-
-        xml.title(**attr_code(at.merge(type: "title-part"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
-        end
-      end
-
-      def title_amd(node, xml, lang, at)
-        return unless node.attr("title-amendment-#{lang}")
-
-        xml.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(
-            node.attr("title-amendment-#{lang}"),
-          )
-        end
-      end
-
-      def title_full(node, xml, lang, at)
-        title = node.attr("title-main-#{lang}")
-        intro = node.attr("title-intro-#{lang}")
-        part = node.attr("title-part-#{lang}")
-        amd = node.attr("title-amendment-#{lang}")
-        title = "#{intro} -- #{title}" if intro
-        title = "#{title} -- #{part}" if part
-        title = "#{title} -- #{amd}" if amd && @amd
-        xml.title **attr_code(at.merge(type: "main")) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(title)
-        end
-      end
-
-      def title(node, xml)
-        ["en", "fr"].each do |lang|
-          at = { language: lang, format: "text/plain" }
-          title_full(node, xml, lang, at)
-          title_intro(node, xml, lang, at)
-          title_main(node, xml, lang, at)
-          title_part(node, xml, lang, at)
-          title_amd(node, xml, lang, at) if @amd
-        end
-      end
-
-      def relaton_relations
-        super + %w(obsoletes successor-of manifestation-of related annotation-of)
-      end
-
-      def relaton_relation_descriptions
-        super.merge(
-          "amends" => "updates", "revises" => "updates",
-          "replaces" => "obsoletes",
-          "supersedes" => "obsoletes",
-          "corrects" => "updates",
-          "informatively-cited-in" => "isCitedIn",
-          "informatively-cites" => "cites",
-          "normatively-cited in" => "isCitedIn",
-          "normatively-cites" => "cites",
-          "identical-adopted-from" => "adoptedFrom",
-          "modified-adopted-from" => "adoptedFrom",
-          "related-directive" => "related",
-          "related-mandate" => "related",
-        )
-      end
-    end
-  end
-end