metanorma-standoc 1.3.17 → 1.3.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4647d414467e7326fb0d0d30ee3ac79ad4f3f4a8a2e7d4ffa0948db689781db3
-  data.tar.gz: ca6d428a27678a89ff8188162046216a7f4f0efe450488d36b158319a91e45a0
+  metadata.gz: 29fb2b3bd1b2182033a91de521a848994d54d41592d3c1f850572fd9e4ab6bd5
+  data.tar.gz: 1cdecf3c34899fb71b342eafdf16a249e399e35c5382d41fc5965e2870b80988
 SHA512:
-  metadata.gz: 97847d11b89413d948324766bda68e416defdb35fd6fed828d6e3bcda8e67fe626a3d14054edce3d580af83c465c786b1a1c11e24585d15054d0cb01d9952bc2
-  data.tar.gz: 30e844b147945676fa516f98955f878d6b9442c3875f3edcea6ef27a6908a15bc15fedcd26a76619c3068f9f534820db419704abdcb7d2e5562a68dc4a77f9e8
+  metadata.gz: 61be98b3231edd09a06711527c2c482cf276fc57bc09eaa10f83316574a9c13aba58b16ab32df29879ffe821d908dc6ad5ea72673328a440da232bd769c8b912
+  data.tar.gz: 9f41b2ccbb3e865c7b738a67d00f26c7ddd5230e67af501fc696fb5b80793e933dcd56b08f21e56fab318ad877af77a0c24cce2e454aac85dd1f8d3febc8793a

data/.github/workflows/macos.yml

@@ -29,8 +29,8 @@ jobs:
       - name: Install LaTeXML
         run: |
           # https://github.com/Homebrew/homebrew-core/issues/44950
-          curl -L https://cpanmin.us | perl - --sudo App::cpanminus
-          env PATH=$(brew --prefix perl)/bin:$PATH cpanm --sudo --notest LaTeXML@0.8.4
+          brew install cpanminus
+          cpanm --notest XML::LibXSLT@1.96 LaTeXML@0.8.4
       - name: Install PlantUML
         run: |
           brew install plantuml

data/.github/workflows/ubuntu.yml

@@ -28,7 +28,7 @@ jobs:
           node-version: '10.x'
       - name: Update gems
         run: |
-          gem install bundler 
+          gem install bundler
           bundle install --jobs 4 --retry 3
       - name: Install LaTeXML
         run: |

data/.github/workflows/windows.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Update gems
         shell: pwsh
         run: |
-          gem install bundler 
+          gem install bundler
           bundle config --local path vendor/bundle
           bundle update
           bundle install --jobs 4 --retry 3

data/lib/asciidoctor/standoc/base.rb

@@ -12,7 +12,7 @@ module Asciidoctor
   module Standoc
     module Base
       XML_ROOT_TAG = "standard-document".freeze
-      XML_NAMESPACE = "https://www.metanorma.com/ns/standoc".freeze
+      XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
 
       Asciidoctor::Extensions.register do
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro

data/lib/asciidoctor/standoc/blocks.rb

@@ -206,8 +206,9 @@ module Asciidoctor
       def quote_attribution(node, out)
         if node.attr("citetitle")
           m = /^(?<cite>[^,]+)(,(?<text>.*$))?$/m.match node.attr("citetitle")
-          out.source m[:text],
-            **attr_code(target: m[:cite], type: "inline")
+          out.source **attr_code(target: m[:cite], type: "inline") do |s|
+            s <<  m[:text]
+          end
         end
         if node.attr("attribution")
           out.author { |a| a << node.attr("attribution") }

data/lib/asciidoctor/standoc/cleanup.rb

@@ -43,6 +43,7 @@ module Asciidoctor
         normref_cleanup(xmldoc)
         biblio_cleanup(xmldoc)
         reference_names(xmldoc)
+        symbols_cleanup(xmldoc)
         xref_cleanup(xmldoc)
         origin_cleanup(xmldoc)
         concept_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -51,8 +51,7 @@ module Asciidoctor
 
       def boilerplate_isodoc(xmldoc)
         x = xmldoc.dup
-        # TODO variable
-        x.root.add_namespace(nil, "http://riboseinc.com/isoxml")
+        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

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -4,6 +4,7 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
+require "mathml2asciimath"
 
 module Asciidoctor
   module Standoc
@@ -190,6 +191,41 @@ module Asciidoctor
         term_children_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc)
       end
+
+      # Indices sort after letter but before any following
+      # letter (x, x_m, x_1, xa); we use colon to force that sort order.
+      # Numbers sort *after* letters; we use thorn to force that sort order.
+      def symbol_key(x)
+        key = x.dup
+        key.xpath("//*[local-name() = 'math']").each do |m|
+          m.replace(MathML2AsciiMath.m2a(m.to_xml))
+        end
+        ret = Nokogiri::XML(MathML2AsciiMath.m2a(key.to_xml))
+        HTMLEntities.new.decode(ret.text).strip.
+          gsub(/[[:punct]]|[_^]/, ":\\0").gsub(/`/, "").
+          gsub(/[0-9]+/, "þ\\0")
+      end
+
+      def extract_symbols_list(dl)
+        dl_out = []
+        dl.xpath("./dt | ./dd").each do |dtd|
+          if dtd.name == "dt"
+            dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
+          else
+            dl_out.last[:dd] = dtd.remove
+          end
+        end
+        dl_out
+      end
+
+      def symbols_cleanup(docxml)
+        docxml.xpath("//definitions/dl").each do |dl|
+          dl_out = extract_symbols_list(dl)
+          dl_out.sort! { |a, b| a[:key] <=> b[:key] }
+          dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
+        end
+        docxml
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/converter.rb

@@ -52,7 +52,6 @@ module Asciidoctor
       end
 
       def self.inherited( k )
-        #k._file = caller.first[/^[^:]+/]
         k._file = caller_locations.first.absolute_path
       end
 

data/lib/asciidoctor/standoc/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<grammar ns="https://www.metanorma.com/ns/standoc" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<grammar ns="https://www.metanorma.org/ns/standoc" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <!-- include "biblio.rnc" { } -->
   <include href="basicdoc.rng">

data/lib/asciidoctor/standoc/macros.rb

@@ -1,6 +1,7 @@
 require "asciidoctor/extensions"
 require "fileutils"
 require "uuidtools"
+require_relative "./macros_plantuml.rb"
 
 module Asciidoctor
   module Standoc
@@ -156,106 +157,5 @@ module Asciidoctor
         end
       end
     end
-
-    class PlantUMLBlockMacroBackend
-      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
-      def self.plantuml_installed?
-        cmd = "plantuml"
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-          exts.each do |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return exe if File.executable?(exe) && !File.directory?(exe)
-          end
-        end
-        nil
-      end
-
-      def self.run umlfile, outfile
-        system "plantuml #{umlfile.path}" or (warn $? and return false)
-        i = 0
-        until !Gem.win_platform? || File.exist?(outfile) || i == 15
-          sleep(1)
-          i += 1
-        end
-        File.exist?(outfile)
-      end
-
-      # if no :imagesdir: leave image file in plantuml
-      # sleep need for windows because dot works in separate process and
-      # plantuml process may finish earlier then dot, as result png file
-      # maybe not created yet after plantuml finish
-      def self.generate_file parent, reader
-        localdir = Utils::localdir(parent.document)
-
-        imagesdir = parent.document.attr('imagesdir')
-        umlfile, outfile = save_plantuml parent, reader, localdir
-
-        # TODO: this should raise failure if there is no image output!!
-        run(umlfile, outfile) or return
-        umlfile.unlink
-
-        path = Pathname.new(localdir) + (imagesdir || "plantuml")
-        path.mkpath
-
-        # TODO: this should raise failure if the destination path already exists!
-        File.exist?(path) or return
-
-        # TODO: this should raise failure if the destination path is not writable!
-        File.writable?(path) or return
-
-        # Warning for Heisenbug: metanorma/metanorma-standoc#187
-        # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
-        # This is why we need to copy and then unlink.
-        filename = File.basename(outfile.to_s)
-        FileUtils.cp(outfile, path) && outfile.unlink
-
-        imagesdir ? filename : File.join(path, filename)
-      end
-
-      def self.save_plantuml parent, reader, localdir
-        src = reader.source
-        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
-          src = "@startuml\n#{src}\n@enduml\n"
-        /^@startuml (?<fn>[^\n]+)\n/ =~ src
-        Tempfile.open(["plantuml", ".pml"], :encoding => "utf-8") do |f|
-          f.write(src)
-          [f, File.join(File.dirname(f.path),
-                        (fn || File.basename(f.path, ".pml")) + ".png")]
-        end
-      end
-
-      def self.generate_attrs attrs
-        through_attrs = %w(id align float title role width height alt).
-          inject({}) do |memo, key|
-          memo[key] = attrs[key] if attrs.has_key? key
-          memo
-        end
-      end
-    end
-
-    class PlantUMLBlockMacro < Asciidoctor::Extensions::BlockProcessor
-      use_dsl
-      named :plantuml
-      on_context :literal
-      parse_content_as :raw
-
-      def abort(parent, reader, attrs, msg)
-        # TODO: Abort should really raise an error
-        warn msg
-        attrs["language"] = "plantuml"
-        create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }
-      end
-
-      def process(parent, reader, attrs)
-        PlantUMLBlockMacroBackend.plantuml_installed? or
-          return abort(parent, reader, attrs, "PlantUML not installed")
-        filename = PlantUMLBlockMacroBackend.generate_file(parent, reader) or
-          return abort(parent, reader, attrs, "Failed to process PlantUML")
-        through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
-        through_attrs["target"] = filename
-        create_image_block parent, through_attrs
-      end
-    end
   end
 end

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -0,0 +1,100 @@
+module Asciidoctor
+  module Standoc
+    class PlantUMLBlockMacroBackend
+      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+      def self.plantuml_installed?
+        cmd = "plantuml"
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          end
+        end
+        raise "PlantUML not installed"
+        nil
+      end
+
+      def self.run umlfile, outfile
+        system "plantuml #{umlfile.path}" or (warn $? and return false)
+        i = 0
+        until !Gem.win_platform? || File.exist?(outfile) || i == 15
+          sleep(1)
+          i += 1
+        end
+        File.exist?(outfile)
+      end
+
+      # if no :imagesdir: leave image file in plantuml
+      # sleep need for windows because dot works in separate process and
+      # plantuml process may finish earlier then dot, as result png file
+      # maybe not created yet after plantuml finish
+      def self.generate_file parent, reader
+        localdir = Utils::localdir(parent.document)
+        imagesdir = parent.document.attr('imagesdir')
+        umlfile, outfile = save_plantuml parent, reader, localdir
+        run(umlfile, outfile) or raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
+        umlfile.unlink
+
+        path = Pathname.new(localdir) + (imagesdir || "plantuml")
+        File.writable?(localdir) or raise "Destination path #{path} not writable for PlantUML!"
+        path.mkpath
+        File.writable?(path) or raise "Destination path #{path} not writable for PlantUML!"
+        #File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
+
+        # Warning: metanorma/metanorma-standoc#187
+        # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
+        # This is why we need to copy and then unlink.
+        filename = File.basename(outfile.to_s)
+        FileUtils.cp(outfile, path) && outfile.unlink
+
+        imagesdir ? filename : File.join(path, filename)
+      end
+
+      def self.save_plantuml parent, reader, localdir
+        src = reader.source
+        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
+          src = "@startuml\n#{src}\n@enduml\n"
+        /^@startuml (?<fn>[^\n]+)\n/ =~ src
+        Tempfile.open(["plantuml", ".pml"], :encoding => "utf-8") do |f|
+          f.write(src)
+          [f, File.join(File.dirname(f.path),
+                        (fn || File.basename(f.path, ".pml")) + ".png")]
+        end
+      end
+
+      def self.generate_attrs attrs
+        through_attrs = %w(id align float title role width height alt).
+          inject({}) do |memo, key|
+          memo[key] = attrs[key] if attrs.has_key? key
+          memo
+        end
+      end
+    end
+
+    class PlantUMLBlockMacro < Asciidoctor::Extensions::BlockProcessor
+      use_dsl
+      named :plantuml
+      on_context :literal
+      parse_content_as :raw
+
+      def abort(parent, reader, attrs, msg)
+        warn msg
+        attrs["language"] = "plantuml"
+        create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }
+      end
+
+      def process(parent, reader, attrs)
+        begin
+          PlantUMLBlockMacroBackend.plantuml_installed?
+          filename = PlantUMLBlockMacroBackend.generate_file(parent, reader)
+          through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
+          through_attrs["target"] = filename
+          create_image_block parent, through_attrs
+        rescue StandardError => e
+          abort(parent, reader, attrs, e.message)
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/reqt.rb

@@ -29,8 +29,8 @@ module Asciidoctor
       def requirement_classification(classif, ex)
         req_classif_parse(classif).each do |r|
           ex.classification do |c|
-            c.tag r[0]
-            c.value r[1]
+            c.tag { |t| t << r[0] }
+            c.value { |v| v << r[1] }
           end
         end
       end
@@ -51,11 +51,11 @@ module Asciidoctor
         classif = node.attr("classification")
         noko do |xml|
           xml.send obligation, **attr_code(reqt_attributes(node)) do |ex|
-            ex.title node.title if node.title
-            ex.label node.attr("label") if node.attr("label")
-            ex.subject node.attr("subject") if node.attr("subject")
+            node.title and ex.title { |t| t << node.title }
+            node.attr("label") and ex.label { |l| l << node.attr("label") }
+            node.attr("subject") and ex.subject { |s| s << node.attr("subject") }
             node&.attr("inherit")&.split(/;\s*/)&.each do |i|
-              ex.inherit i
+              ex.inherit { |inh| inh << i }
             end
             requirement_classification(classif, ex) if classif
             wrap_in_para(node, ex)

data/lib/asciidoctor/standoc/utils.rb

@@ -77,8 +77,8 @@ module Asciidoctor
         end
 
         def mn_code(code)
-        code.sub(/^\(/, "[").sub(/\).*$/, "]").sub(/^nofetch\((.+)\)$/, "\\1")
-      end
+          code.sub(/^\(/, "[").sub(/\).*$/, "]").sub(/^nofetch\((.+)\)$/, "\\1")
+        end
 
         def emend_biblio(xml, code, title, usrlbl)
           unless xml.at("/bibitem/docidentifier[not(@type = 'DOI')][text()]")

data/lib/asciidoctor/standoc/validate_section.rb

@@ -5,6 +5,7 @@ module Asciidoctor
     module Validate
       def section_validate(doc)
         sourcecode_style(doc.root)
+        hanging_para_style(doc.root)
         asset_style(doc.root)
       end
 
@@ -18,7 +19,7 @@ module Asciidoctor
         end
       end
 
-      def style_warning(node, msg, text)
+      def style_warning(node, msg, text = nil)
         return if @novalid
         w = "ISO style: WARNING (#{Utils::current_location(node)}): #{msg}"
         w += ": #{text}" if text
@@ -37,6 +38,15 @@ module Asciidoctor
       def asset_style(root)
         asset_title_style(root)
       end
+
+      def hanging_para_style(root)
+        root.xpath("//clause | //annex | //foreword | //introduction | "\
+                   "//acknowledgements").each do |c|
+          next unless c.at("./clause")
+          next if c.elements.select { |n| n.name != "clause" }.empty?
+          style_warning(c, "Hanging paragraph in clause")
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.17".freeze
+   VERSION = "1.3.18".freeze
   end
 end