metanorma-standoc 1.4.2 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3fe7b42105c2a89fb897699fde276f7b4cee0602de41f6edcd2f81ad5cbd2a3
-  data.tar.gz: 442a50e5a3633c41b95cd9ac223976448c5f7ee5c4932034ddf81a939cfa1f80
+  metadata.gz: 910ada4e6d4f62c6106391e3ec0de46a7ba4a9d5362bb103cd80ee0b2acef9dc
+  data.tar.gz: de8546c035da0236faa4a6ca5df9b0f54f16806d09386793f359e55b69884212
 SHA512:
-  metadata.gz: b11e454cf7ffdb63e00a2a2df8ae8a2fec586546a35363c3b64cdb32dca70717f50462ee29ee0c3b292bf07f6ff5bad80611160a91dd9f22f7d776b39ab01134
-  data.tar.gz: 1c0fc47083cc3d87e467d94a648f6deed8e2a79ca8eec87ec25ab8c62728fe2c85a809b991acd7776172e484a5886697f046451d79535d967cc0dd2dcfafe2a6
+  metadata.gz: 422e64b66f95fa4c49727687c446bd3f79bc09aa0609b352bd68cc659ff06bf57243ed410e4baa8f0cb501f101212d305a756b41548fcee7e877135aea22e1f3
+  data.tar.gz: 97d6e164975997ecc396376abdaf2edad43c1f4fbfa601dbbc5f2f4d465747164350f500aaadc05f9fd6ed1e499925df7d74626fcde21a0578feeb50d607b84e

data/.github/workflows/macos.yml

@@ -29,10 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
       - name: Install LaTeXML
         run: |
           brew install libxml2 cpanminus
@@ -41,9 +37,6 @@ jobs:
       - name: Install PlantUML
         run: |
           brew install plantuml
-      - name: Install puppeteer
-        run: |
-          npm -g i puppeteer
       - name: Update gems
         run: |
           sudo gem install bundler --force

data/.github/workflows/ubuntu.yml

@@ -29,10 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
       - name: Update gems
         run: |
           gem install bundler
@@ -42,13 +38,12 @@ jobs:
           sudo snap install latexml --edge
           echo "::add-path::/snap/bin"
       - name: Install PlantUML
-        run: |
-          curl -L https://raw.githubusercontent.com/metanorma/plantuml-install/master/ubuntu.sh | sudo bash
-      - name: Install puppeteer
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libgbm1
-          npm install -g puppeteer@3.0.1
+        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"
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/windows.yml

@@ -29,10 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '10.x'
       - name: Install MN Windows dependencies
         shell: pwsh
         run: |
@@ -50,10 +46,6 @@ jobs:
           refreshenv
           set PATH=C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;%PATH%
           where latexmlmath
-      - name: Install puppeteer
-        shell: pwsh
-        run: |
-          npm -g i puppeteer
       - name: Run specs
         shell: pwsh
         run: |

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 Rails:
   Enabled: true

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/lib/asciidoctor/standoc/base.rb

@@ -14,22 +14,6 @@ module Asciidoctor
       XML_ROOT_TAG = "standard-document".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
 
-      Asciidoctor::Extensions.register do
-        preprocessor Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor
-        preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
-        preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
-        inline_macro Asciidoctor::Standoc::AltTermInlineMacro
-        inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
-        inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
-        inline_macro Asciidoctor::Standoc::InheritInlineMacro
-        inline_macro Asciidoctor::Standoc::HTML5RubyMacro
-        inline_macro Asciidoctor::Standoc::ConceptInlineMacro
-        block Asciidoctor::Standoc::ToDoAdmonitionBlock
-        treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
-        block Asciidoctor::Standoc::PlantUMLBlockMacro
-        block Asciidoctor::Standoc::PseudocodeBlockMacro
-      end
-
       def xml_root_tag
         self.class::XML_ROOT_TAG
       end
@@ -117,6 +101,7 @@ module Asciidoctor
         @filename = node.attr("docfile") ?
           File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
         @localdir = Utils::localdir(node)
+        @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
         @no_isobib = node.attr("no-isobib")
         @bibdb = nil
@@ -126,9 +111,10 @@ module Asciidoctor
         @log = Asciidoctor::Standoc::Log.new
         init_bib_caches(node)
         init_iev_caches(node)
-        lang = (node.attr("language") || "en")
-        script = (node.attr("script") || "en")
-        i18n_init(lang, script)
+        @lang = (node.attr("language") || "en")
+        @script = (node.attr("script") || "Latn")
+        @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
+        @i18n = @isodoc.i18n
       end
 
       def default_fonts(node)
@@ -158,7 +144,7 @@ module Asciidoctor
       end
 
       def clean_exit
-        @log.write(@localdir + @filename + ".err") unless @novalid
+        @log.write(@output_dir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
@@ -184,7 +170,7 @@ module Asciidoctor
       end
 
       def doctype(node)
-        node.attr("doctype")
+        node.attr("doctype")&.gsub(/\s+/, "-")&.downcase
       end
 
       def front(node, xml)
@@ -243,6 +229,14 @@ module Asciidoctor
           end
         end.join("\n")
       end
+
+      private
+
+      def outputdir(node)
+        if node.attr("output_dir").nil_or_empty? then Utils::localdir(node)
+        else File.join(node.attr("output_dir"), "")
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup.rb

@@ -71,6 +71,7 @@ module Asciidoctor
         para_cleanup(xmldoc)
         empty_element_cleanup(xmldoc)
         img_cleanup(xmldoc)
+        anchor_cleanup(xmldoc)
         xmldoc
       end
 

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -2,25 +2,25 @@ module Asciidoctor
   module Standoc
     module Cleanup
       def external_terms_boilerplate(sources)
-        IsoDoc::Function::I18n::l10n(
-          @external_terms_boilerplate.gsub(/%/, sources || "???"),
+        @i18n.l10n(
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
           @lang, @script)
       end
 
       def internal_external_terms_boilerplate(sources)
-        IsoDoc::Function::I18n::l10n(
-          @internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
+        @i18n.l10n(
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
           @lang, @script)
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
-        div.next = @term_def_boilerplate
+        a = @i18n.term_def_boilerplate and div.next = a
         source.each do |s|
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
         end
         if source.empty? && term.nil?
-          div.next = @no_terms_boilerplate
+          div.next = @i18n.no_terms_boilerplate
         else
           div.next = term_defs_boilerplate_cont(source, term, isodoc)
         end
@@ -30,7 +30,7 @@ module Asciidoctor
         sources = isodoc.sentence_join(src.map do |s|
           %{<eref bibitemid="#{s['bibitemid']}"/>}
         end)
-        if src.empty? then @internal_terms_boilerplate
+        if src.empty? then @i18n.internal_terms_boilerplate
         elsif term.nil? then external_terms_boilerplate(sources)
         else
           internal_external_terms_boilerplate(sources)
@@ -42,7 +42,7 @@ module Asciidoctor
         ["reference", "bibitem"].include? e.name
       end
       f.at("./title").next =
-        "<p>#{(refs.empty? ? @norm_empty_pref : @norm_with_refs_pref)}</p>"
+        "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
     end
 
       TERM_CLAUSE = "//sections/terms | "\
@@ -54,13 +54,9 @@ module Asciidoctor
         x = xmldoc.dup
         x.root.add_namespace(nil, self.class::XML_NAMESPACE)
         xml = Nokogiri::XML(x.to_xml)
-        conv = html_converter(EmptyAttr.new)
-        @lang = xmldoc&.at("//bibdata/language")&.text
-        @script = xmldoc&.at("//bibdata/script")&.text
-        conv.i18n_init(@lang, @script)
-        conv.metadata_init(@lang, @script, conv.labels)
-        conv.info(xml, nil)
-        conv
+        @isodoc ||= isodoc(@lang, @script)
+        @isodoc.info(xml, nil)
+        @isodoc
       end
 
       def boilerplate_cleanup(xmldoc)
@@ -83,15 +79,6 @@ module Asciidoctor
         preface.previous = b
       end
 
-      class EmptyAttr
-        def attr(_x)
-          nil
-        end
-        def attributes
-          {}
-        end
-      end
-
       def boilerplate_file(xmldoc)
         File.join(@libdir, "boilerplate.xml")
       end

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -117,7 +117,8 @@ module Asciidoctor
       def concept_termbase_cleanup(x)
         text = x&.children&.first&.remove&.text
         termbase, key = x["key"].split(/:/, 2)
-        x.add_child(%(<termref base="#{termbase}" target="#{key}">#{text}</termref>))
+        x.add_child(%(<termref base="#{termbase}" target="#{key}">) + 
+                    "#{text}</termref>")
       end
 
       def concept_xref_cleanup(x)
@@ -129,6 +130,61 @@ module Asciidoctor
         x.children = "<eref>#{x.children.to_xml}</eref>"
         extract_localities(x.first_element_child)
       end
+
+      NAMECHAR = "\u0000-\u0022\u0024\u002c\u002f\u003a-\u0040\\u005b-\u005e"\
+        "\u0060\u007b-\u00b6\u00b8-\u00bf\u00d7\u00f7\u037e\u2000-\u200b"\
+        "\u200e-\u203e\u2041-\u206f\u2190-\u2bff\u2ff0-\u3000".freeze
+      #"\ud800-\uf8ff\ufdd0-\ufdef\ufffe-\uffff".freeze
+      NAMESTARTCHAR = "\\u002d\u002e\u0030-\u0039\u00b7\u0300-\u036f"\
+        "\u203f-\u2040".freeze
+
+      def to_ncname(s)
+        start = s[0]
+        ret1 = %r([#{NAMECHAR}#]).match(start) ? "_" :
+          (%r([#{NAMESTARTCHAR}#]).match(start) ? "_#{start}" : start)
+        ret = ret1 + s[1..-1].gsub(%r([#{NAMECHAR}#]), "_")
+        ret
+      end
+
+      def to_xreftarget(s)
+        return to_ncname(s) unless /^[^#]+#.+$/.match(s)
+          /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ s
+        pref = pref.gsub(%r([#{NAMECHAR}]), "_")
+        suff = suff.gsub(%r([#{NAMECHAR}]), "_")
+        "#{pref}##{suff}"
+      end
+
+      IDREF = "//*/@id | //review/@from | //review/@to | "\
+        "//callout/@target | //citation/@bibitemid | //eref/@bibitemid".freeze
+
+      def anchor_cleanup(x)
+        anchor_cleanup1(x)
+        xreftarget_cleanup(x)
+      end
+
+      def anchor_cleanup1(x)
+        x.xpath(IDREF).each do |s|
+          if (ret = to_ncname(s.value)) != (orig = s.value)
+            s.value = ret
+            output = s.parent.dup
+            output.children.remove
+            @log.add("Anchors", s.parent, "normalised identifier in #{output} "\
+                     "from #{orig}")
+          end
+        end
+      end
+
+      def xreftarget_cleanup(x)
+        x.xpath("//xref/@target").each do |s|
+          if (ret = to_xreftarget(s.value)) != (orig = s.value)
+            s.value = ret
+            output = s.parent.dup
+            output.children.remove
+            @log.add("Anchors", s.parent, "normalised identifier in #{output} "\
+                     "from #{orig}")
+          end
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -50,7 +50,8 @@ module Asciidoctor
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
         r = xmldoc.at("//references[@normative = 'false'] | "\
-                      "//clause[.//references[@normative = 'false']]") or return
+                      "//clause[.//references[@normative = 'false']] | "\
+                      "//annex[.//references[@normative = 'false']]") or return
         r.xpath(".//bibitem[not(ancestor::bibitem)]").each_with_index do |b, i|
           next unless docid = b.at("./docidentifier[@type = 'metanorma']")
           next unless  /^\[\d+\]$/.match(docid.text)
@@ -132,15 +133,17 @@ module Asciidoctor
       end
 
       def validate_ref_dl(bib, c)
-        unless bib["id"]
+        id = bib["id"]
+        id ||= c["id"] unless /^_/.match(c["id"]) # do not accept implicit id
+        unless id
           @log.add("Anchors", c, "The following reference is missing "\
-                              "an anchor:\n" + c.to_xml)
+                   "an anchor:\n" + c.to_xml)
           return
         end
-        bib["title"] or @log.add("Bibliography", c, "Reference #{bib['id']} "\
-                                "is missing a title")
-        bib["docid"] or @log.add("Bibliography", c, "Reference #{bib['id']} "\
-                                "is missing a document identifier (docid)")
+        bib["title"] or @log.add("Bibliography", c, "Reference #{id} "\
+                                 "is missing a title")
+        bib["docid"] or @log.add("Bibliography", c, "Reference #{id} "\
+                                 "is missing a document identifier (docid)")
       end
 
       def extract_from_p(tag, bib, key)
@@ -200,7 +203,9 @@ module Asciidoctor
         end
         if !nested and c.at("./title")
           title = c.at("./title").remove.children.to_xml
-          bib["title"] = bib["title"] ? Array(bib["title"]) : []
+          bib["title"] = [bib["title"]] if bib["title"].is_a? Hash
+          bib["title"] = [bib["title"]] if bib["title"].is_a? String
+          bib["title"] = [] unless bib["title"]
           bib["title"] << title if !title.empty?
         end
         bib

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -39,6 +39,7 @@ module Asciidoctor
           dupabstract.traverse { |n| n.remove_attribute("id") }
           dupabstract.remove_attribute("language")
           dupabstract.remove_attribute("script")
+          dupabstract&.at("./title")&.remove
           bibabstract.next = dupabstract
         end
       end
@@ -105,6 +106,7 @@ module Asciidoctor
       def sections_cleanup(x)
         sections_order_cleanup(x)
         sections_level_cleanup(x)
+        sections_names_cleanup(x)
       end
 
       def obligations_cleanup(x)
@@ -118,15 +120,15 @@ module Asciidoctor
         (s = x.at("//introduction")) && s["obligation"] = "informative"
         (s = x.at("//acknowledgements")) && s["obligation"] = "informative"
         x.xpath("//references").each { |r| r["obligation"] = "informative" }
-        x.xpath("//preface//clause").each { |r| r["obligation"] = "informative" }
+        x.xpath("//preface//clause").each do |r|
+          r["obligation"] = "informative"
+        end
       end
 
       def obligations_cleanup_norm(x)
-        (s = x.at("//clause[title = 'Scope']")) && s["obligation"] = "normative"
-        (s = x.at("//clause[title = 'Symbols and Abbreviated Terms']")) &&
-          s["obligation"] = "normative"
+        (s = x.at("//clause[@type = 'scope']")) && s["obligation"] = "normative"
         x.xpath("//terms").each { |r| r["obligation"] = "normative" }
-        x.xpath("//symbols-abbrevs").each { |r| r["obligation"] = "normative" }
+        x.xpath("//definitions").each { |r| r["obligation"] = "normative" }
       end
 
       def obligations_cleanup_inherit(x)
@@ -139,16 +141,98 @@ module Asciidoctor
       end
 
       def clausebefore_cleanup(xmldoc)
+        preface_clausebefore_cleanup(xmldoc)
+        sections_clausebefore_cleanup(xmldoc)
+      end
+
+       def preface_clausebefore_cleanup(xmldoc)
+        return unless xmldoc.at("//preface")
+        unless ins = xmldoc.at("//preface").children.first
+          xmldoc.at("//preface") << " "
+          ins = xmldoc.at("//preface").children.first
+        end
+        xmldoc.xpath("//preface//*[@beforeclauses = 'true']").each do |x|
+          x.delete("beforeclauses")
+          ins.previous = x.remove
+        end
+      end
+
+      def sections_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//sections")
         unless ins = xmldoc.at("//sections").children.first
           xmldoc.at("//sections") << " "
           ins = xmldoc.at("//sections").children.first
         end
-        xmldoc.xpath("//*[@beforeclauses = 'true']").each do |x|
+        xmldoc.xpath("//sections//*[@beforeclauses = 'true']").each do |x|
           x.delete("beforeclauses")
           ins.previous = x.remove
         end
       end
+
+      def get_or_make_title(node)
+          unless node.at("./title")
+            if node.children.empty?
+              node << "<title/>"
+            else
+              node.children.first.previous = "<title/>"
+            end
+          end
+          node.at("./title")
+      end
+
+      def replace_title(doc, xpath, text, first = false)
+        return unless text
+        doc.xpath(xpath).each_with_index do |node, i|
+          next if first && !i.zero?
+          title = get_or_make_title(node)
+          fn = title.xpath("./fn")
+          fn.each { |n| n.remove }
+          title.content = text
+          fn.each { |n| title << n }
+        end
+      end
+
+      def sections_names_cleanup(x)
+        replace_title(x, "//clause[@type = 'scope']", @i18n&.scope)
+        replace_title(x, "//preface//abstract", @i18n&.abstract)
+        replace_title(x, "//foreword", @i18n&.foreword)
+        replace_title(x, "//introduction", @i18n&.introduction)
+        replace_title(x, "//acknowledgements", @i18n&.acknowledgements)
+        section_names_refs_cleanup(x)
+        section_names_terms_cleanup(x)
+      end
+
+      def section_names_refs_cleanup(x)
+        replace_title(x, "//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(x, "//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      NO_SYMABBR = "[.//definitions[not(@type)]]"
+      SYMABBR = "[.//definitions[@type = 'symbols']"\
+        "[@type = 'abbreviated_terms']]".freeze
+      SYMnoABBR = "[.//definitions[@type = 'symbols']"\
+        "[not(@type = 'abbreviated_terms')]]".freeze
+      ABBRnoSYM = "[.//definitions[not(@type = 'symbols')]"\
+        "[@type = 'abbreviated_terms']]".freeze
+
+      def section_names_terms_cleanup(x)
+        replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']", @i18n&.abbrev)
+        replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(x, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(x, "//terms#{SYMABBR} | //clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(x, "//terms#{NO_SYMABBR} | //clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(
+          x, "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true)
+      end
     end
   end
 end