metanorma-standoc 1.11.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd9e01037065cfbc5d497224c5d6ed6ac5088cd4b4df6f404e08a7c552abcf9
-  data.tar.gz: 7eefde1d2046eedbce2c46c8841059210480a43cdea3656bbfd7cfbb068df1b1
+  metadata.gz: f6821b17f6ce6a902c1413023414907d3fca23e9831c8f30eb2b9239577481e2
+  data.tar.gz: 88ab1712fe03b4f927240dd6237fe353353dd8cbd46f3a62f602b91493d93535
 SHA512:
-  metadata.gz: 3fcf00d490fa157fdae4029bd261b1d2b3caf09b2d9a7d8e25c67cc0f4e7a474b6baadfedd1f8b9c90d63a8cad59184bafc237500f46cca83364ffd61dc60914
-  data.tar.gz: afb262667567181815daf62ba580d124874d1bba843ff6cda2c39a861acf6ec246c04766d8e5822ae3dd77326e22d687cbb255a0562644f1fb07f97f39c67416
+  metadata.gz: ff45bc86d56ac270f2a91dcbd3473b91f4051466aea45cc8c0c5af607241dbebc9f54e7628bee5009a05b5d59704940312c64a8fa274c922dbcb4cc0d3a66280
+  data.tar.gz: 636e2808978f3f227ce50906b47180d3d96baf4fa667166a086be67cc1a5310b240f0c5dede99715faea6f99b8124739a1ab6a75a9784e6a5f90827c15595b4e

data/.github/workflows/rake.yml

@@ -10,34 +10,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

@@ -12,3 +12,26 @@ spec/examples/rice_files/
 Gemfile.lock
 
 .rubocop-https--*
+
+/.err
+/action_schemaexpg1.svg
+/action_schemaexpg2.svg
+/address_class_profile.presentation.xml
+/address_component_profile.presentation.xml
+/blank_definition_profile.presentation.xml
+/common_models_diagram.presentation.xml
+/plantuml/
+/relaton/
+/spec/assets/lutaml/
+/spec/assets/plantuml*.png
+/spec/assets/xref_error.*
+/test.doc
+/test.err
+/test.html
+/test.pdf
+/test.presentation.xml
+/test.xml
+/test.xml.abort
+/test/
+/top_down_diagram.presentation.xml
+/xref_error.*

data/lib/asciidoctor/standoc/base.rb

@@ -1,146 +1,3 @@
-require "date"
-require "nokogiri"
-require "htmlentities"
-require "json"
-require "pathname"
-require "isodoc"
-require "relaton"
-require "fileutils"
-require "metanorma-utils"
-require "isodoc/xslfo_convert"
-require_relative "render"
+require "asciidoctor/standoc/deprecated"
+require "metanorma/standoc/base"
 
-module Asciidoctor
-  module Standoc
-    module Base
-      XML_ROOT_TAG = "standard-document".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
-      FONTS_MANIFEST = "fonts-manifest".freeze
-
-      def xml_root_tag
-        self.class::XML_ROOT_TAG
-      end
-
-      def xml_namespace
-        self.class::XML_NAMESPACE
-      end
-
-      def init(node)
-        @fn_number ||= 0
-        @draft = false
-        @refids = Set.new
-        @anchors = {}
-        @internal_eref_namespaces = []
-        @draft = node.attributes.has_key?("draft")
-        @novalid = node.attr("novalid")
-        @smartquotes = node.attr("smartquotes") != "false"
-        @keepasciimath = node.attr("mn-keep-asciimath") &&
-          node.attr("mn-keep-asciimath") != "false"
-        @fontheader = default_fonts(node)
-        @files_to_delete = []
-        @filename = if node.attr("docfile")
-                      File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
-                    else ""
-                    end
-        @localdir = Metanorma::Utils::localdir(node)
-        @output_dir = outputdir node
-        @no_isobib_cache = node.attr("no-isobib-cache")
-        @no_isobib = node.attr("no-isobib")
-        @index_terms = node.attr("index-terms")
-        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
-        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
-        @bibdb = nil
-        @seen_headers = []
-        @datauriimage = node.attr("data-uri-image") != "false"
-        @boilerplateauthority = node.attr("boilerplate-authority")
-        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
-        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
-        @log = Metanorma::Utils::Log.new
-        init_bib_caches(node)
-        init_iev_caches(node)
-        @lang = (node.attr("language") || "en")
-        @script = (node.attr("script") ||
-                   Metanorma::Utils.default_script(node.attr("language")))
-        @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
-        @i18n = @isodoc.i18n
-      end
-
-      def document(node)
-        init(node)
-        ret = makexml(node).to_xml(encoding: "US-ASCII", indent: 2)
-        outputs(node, ret) unless node.attr("nodoc") || !node.attr("docfile")
-        clean_exit
-        ret
-      rescue StandardError => e
-        @log.add("Fatal Error", nil, e.message)
-        clean_exit
-        raise e
-      end
-
-      def version
-        flavour = self.class.name.sub(/::Converter$/, "").sub(/^.+::/, "")
-        Metanorma.versioned(Metanorma, flavour)[-1]::VERSION
-      end
-
-      def clean_exit
-        @log.write("#{@output_dir}#{@filename}.err") unless @novalid
-
-        @files_to_delete.each { |f| FileUtils.rm f }
-      end
-
-      def clean_abort(msg, file = nil)
-        file and
-          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(file) }
-        clean_exit
-        abort(msg)
-      end
-
-      def makexml1(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>",
-                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
-        result << noko { |ixml| front node, ixml }
-        result << noko { |ixml| middle node, ixml }
-        result << "</#{xml_root_tag}>"
-        textcleanup(result)
-      end
-
-      def makexml(node)
-        result = makexml1(node)
-        ret1 = cleanup(Nokogiri::XML(result))
-        ret1.root.add_namespace(nil, xml_namespace)
-        validate(ret1) unless @novalid
-        ret1
-      end
-
-      def draft?
-        @draft
-      end
-
-      def doctype(node)
-        node.attr("doctype")&.gsub(/\s+/, "-")&.downcase
-      end
-
-      def front(node, xml)
-        xml.bibdata **attr_code(type: "standard") do |b|
-          metadata node, b
-        end
-      end
-
-      def middle(node, xml)
-        xml.sections do |s|
-          s << node.content if node.blocks?
-        end
-      end
-
-      private
-
-      def outputdir(node)
-        if node.attr("output_dir").nil_or_empty?
-          Metanorma::Utils::localdir(node)
-        else
-          File.join(node.attr("output_dir"), "")
-        end
-      end
-    end
-  end
-end

data/lib/asciidoctor/standoc/blocks.rb

@@ -1,239 +1,3 @@
-require "htmlentities"
-require "uri" if /^2\./.match?(RUBY_VERSION)
-require_relative "./blocks_notes"
+require "asciidoctor/standoc/deprecated"
+require "metanorma/standoc/blocks"
 
-module Asciidoctor
-  module Standoc
-    module Blocks
-      def id_attr(node = nil)
-        { id: Metanorma::Utils::anchor_or_uuid(node),
-          tag: node&.attr("tag"),
-          "multilingual-rendering": node&.attr("multilingual-rendering") }
-      end
-
-      def id_unnum_attrs(node)
-        attr_code(id_attr(node).merge(
-                    unnumbered: node.option?("unnumbered") ? "true" : nil,
-                    number: node.attr("number"),
-                    subsequence: node.attr("subsequence"),
-                  ))
-      end
-
-      def formula_attrs(node)
-        attr_code(id_unnum_attrs(node)
-          .merge(keep_attrs(node).merge(
-                   inequality: node.option?("inequality") ? "true" : nil,
-                 )))
-      end
-
-      def keep_attrs(node)
-        { "keep-with-next": node.attr("keep-with-next"),
-          "keep-lines-together": node.attr("keep-lines-together") }
-      end
-
-      # We append each contained block to its parent
-      def open(node)
-        role = node.role || node.attr("style")
-        reqt_subpart(role) and return requirement_subpart(node)
-        role == "form" and return form(node)
-        role == "definition" and return termdefinition(node)
-        result = []
-        node.blocks.each do |b|
-          result << send(b.context, b)
-        end
-        result
-      end
-
-      def form(node)
-        noko do |xml|
-          xml.form **attr_code(id_attr(node)
-            .merge(class: node.attr("class"),
-                   name: node.attr("name"), action: node.attr("action"))) do |f|
-            f << node.content
-          end
-        end
-      end
-
-      def literal_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)))
-      end
-
-      def literal(node)
-        noko do |xml|
-          xml.figure **literal_attrs(node) do |f|
-            figure_title(node, f)
-            f.pre node.lines.join("\n"),
-                  **attr_code(id: Metanorma::Utils::anchor_or_uuid,
-                              alt: node.attr("alt"))
-          end
-        end
-      end
-
-      # NOTE: html escaping is performed by Nokogiri
-      def stem(node)
-        noko do |xml|
-          xml.formula **formula_attrs(node) do |s|
-            stem_parse(node.lines.join("\n"), s, node.style.to_sym)
-          end
-        end
-      end
-
-      def term_example(node)
-        noko do |xml|
-          xml.termexample **attr_code(id_attr(node)) do |ex|
-            wrap_in_para(node, ex)
-          end
-        end.join("\n")
-      end
-
-      def example(node)
-        return term_example(node) if in_terms?
-
-        role = node.role || node.attr("style")
-        %w(recommendation requirement permission).include?(role) and
-          return requirement(node, role)
-        return pseudocode_example(node) if role == "pseudocode"
-        return svgmap_example(node) if role == "svgmap"
-        return form(node) if role == "form"
-        return termdefinition(node) if role == "definition"
-
-        reqt_subpart(role) and return requirement_subpart(node)
-        example_proper(node)
-      end
-
-      def svgmap_attrs(node)
-        attr_code(id_attr(node)
-          .merge(id: node.id,
-                 unnumbered: node.option?("unnumbered") ? "true" : nil,
-                 number: node.attr("number"),
-                 subsequence: node.attr("subsequence"))
-        .merge(keep_attrs(node)))
-      end
-
-      def svgmap_example(node)
-        noko do |xml|
-          xml.svgmap **attr_code(svgmap_attrs(node).merge(
-                                   src: node.attr("src"), alt: node.attr("alt"),
-                                 )) do |ex|
-            figure_title(node, ex)
-            ex << node.content
-          end
-        end.join("\n")
-      end
-
-      # prevent A's and other subs inappropriate for pseudocode
-      def pseudocode_example(node)
-        node.blocks.each { |b| b.remove_sub(:replacements) }
-        noko do |xml|
-          xml.figure **example_attrs(node).merge(class: "pseudocode") do |ex|
-            figure_title(node, ex)
-            wrap_in_para(node, ex)
-          end
-        end.join("\n")
-      end
-
-      def example_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
-      end
-
-      def example_proper(node)
-        noko do |xml|
-          xml.example **example_attrs(node) do |ex|
-            node.title.nil? or ex.name { |name| name << node.title }
-            wrap_in_para(node, ex)
-          end
-        end.join("\n")
-      end
-
-      def figure_title(node, out)
-        return if node.title.nil?
-
-        out.name { |name| name << node.title }
-      end
-
-      def figure_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
-      end
-
-      def image(node)
-        noko do |xml|
-          xml.figure **figure_attrs(node) do |f|
-            figure_title(node, f)
-            f.image **image_attributes(node)
-          end
-        end
-      end
-
-      def para_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)
-          .merge(align: node.attr("align"),
-                 variant_title: node.role == "variant-title" ? true : nil,
-                 type: node.attr("type"))))
-      end
-
-      def paragraph(node)
-        return termsource(node) if node.role == "source"
-
-        noko do |xml|
-          xml.p **para_attrs(node) do |xml_t|
-            xml_t << node.content
-          end
-        end.join("\n")
-      end
-
-      def quote_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node))
-          .merge(align: node.attr("align")))
-      end
-
-      def quote_attribution(node, out)
-        if node.attr("citetitle")
-          m = /^(?<cite>[^,]+)(,(?<text>.*$))?$/m.match node.attr("citetitle")
-          out.source **attr_code(target: m[:cite], type: "inline") do |s|
-            s <<  m[:text]
-          end
-        end
-        node.attr("attribution") and
-          out.author { |a| a << node.attr("attribution") }
-      end
-
-      def quote(node)
-        noko do |xml|
-          xml.quote **quote_attrs(node) do |q|
-            quote_attribution(node, q)
-            wrap_in_para(node, q)
-          end
-        end.join("\n")
-      end
-
-      def listing_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)
-                  .merge(lang: node.attr("language"),
-                         unnumbered: node.option?("unnumbered") ? "true" : nil,
-                         number: node.attr("number"),
-                         filename: node.attr("filename"))))
-      end
-
-      # NOTE: html escaping is performed by Nokogiri
-      def listing(node)
-        fragment = ::Nokogiri::XML::Builder.new do |xml|
-          xml.sourcecode **listing_attrs(node) do |s|
-            figure_title(node, s)
-            s << node.content
-          end
-        end
-        fragment.to_xml(encoding: "US-ASCII", save_with:
-                        Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
-      end
-
-      def pass(node)
-        noko do |xml|
-          xml.passthrough **attr_code(formats:
-                                      node.attr("format") || "metanorma") do |p|
-            p << HTMLEntities.new.encode(node.content, :basic, :hexadecimal)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -1,101 +1,3 @@
-module Asciidoctor
-  module Standoc
-    module Blocks
-      def termnote_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)
-          .merge(
-            unnumbered: node.attr("unnumbered"),
-            number: node.attr("number"),
-            subsequence: node.attr("subsequence"),
-            "keep-separate": node.attr("keep-separate"),
-          )))
-      end
+require "asciidoctor/standoc/deprecated"
+require "metanorma/standoc/blocks_notes"
 
-      def note_attrs(node)
-        attr_code(
-          termnote_attrs(node).merge(
-            type: node.attr("type"),
-            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
-          ),
-        )
-      end
-
-      def sidebar_attrs(node)
-        todo_attrs(node).merge(
-          attr_code(
-            from: node.attr("from"),
-            to: node.attr("to") || node.attr("from"),
-          ),
-        )
-      end
-
-      def sidebar(node)
-        return unless draft?
-
-        noko do |xml|
-          xml.review **sidebar_attrs(node) do |r|
-            wrap_in_para(node, r)
-          end
-        end
-      end
-
-      def todo_attrs(node)
-        date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T00:00:00Z" unless /T/.match? date
-        attr_code(id_attr(node)
-          .merge(reviewer: node.attr("reviewer") || node.attr("source") ||
-                 "(Unknown)",
-                 date: date))
-      end
-
-      def todo(node)
-        noko do |xml|
-          xml.review **todo_attrs(node) do |r|
-            wrap_in_para(node, r)
-          end
-        end
-      end
-
-      def termnote(node)
-        noko do |xml|
-          xml.termnote **termnote_attrs(node) do |ex|
-            wrap_in_para(node, ex)
-          end
-        end.join("\n")
-      end
-
-      def note(node)
-        noko do |xml|
-          xml.note **note_attrs(node) do |c|
-            wrap_in_para(node, c)
-          end
-        end.join("\n")
-      end
-
-      def admonition_attrs(node)
-        name = node.attr("name")
-        a = node.attr("type") and ["danger", "safety precautions"].each do |t|
-          name = t if a.casecmp(t).zero?
-        end
-        attr_code(keep_attrs(node).merge(id_attr(node)
-          .merge(
-            type: name,
-            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
-          )))
-      end
-
-      def admonition(node)
-        return termnote(node) if in_terms?
-        return note(node) if node.attr("name") == "note"
-        return todo(node) if node.attr("name") == "todo"
-
-        noko do |xml|
-          xml.admonition **admonition_attrs(node) do |a|
-            node.title.nil? or a.name { |name| name << node.title }
-            wrap_in_para(node, a)
-          end
-        end.join("\n")
-      end
-    end
-  end
-end