metanorma-standoc 1.9.4 → 1.10.0

data/lib/asciidoctor/standoc/isodoc.rng

@@ -955,7 +955,24 @@
   <define name="concept">
     <element name="concept">
       <optional>
-        <attribute name="term"/>
+        <element name="refterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="renderterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
       </optional>
       <choice>
         <ref name="eref"/>

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -4,8 +4,8 @@ module Asciidoctor
       # 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 = 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)
@@ -15,7 +15,7 @@ module Asciidoctor
         nil
       end
 
-      def self.run umlfile, outfile
+      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
@@ -29,9 +29,9 @@ module Asciidoctor
       # 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
+      def self.generate_file(parent, reader)
         localdir = Metanorma::Utils::localdir(parent.document)
-        imagesdir = parent.document.attr('imagesdir')
+        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
@@ -40,7 +40,7 @@ module Asciidoctor
         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!"
+        # 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.
@@ -51,21 +51,21 @@ module Asciidoctor
         imagesdir ? filename : File.join(path, filename)
       end
 
-      def self.save_plantuml parent, reader, localdir
+      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|
+        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|
+      def self.generate_attrs(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
@@ -81,19 +81,17 @@ module Asciidoctor
       def abort(parent, reader, attrs, msg)
         warn msg
         attrs["language"] = "plantuml"
-        create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }
+        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
+        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

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -1,3 +1,5 @@
+require "csv"
+
 module Asciidoctor
   module Standoc
     class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
@@ -36,46 +38,54 @@ module Asciidoctor
       end
     end
 
-     # Macro to transform `term[X,Y]` into em, termxref xml
     class TermRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :term
-      name_positional_attributes 'name', 'termxref'
+      name_positional_attributes "name", "termxref"
       using_format :short
 
       def process(_parent, _target, attrs)
-        termref = attrs['termxref'] || attrs['name']
-        "<em>#{attrs['name']}</em> (<termxref>#{termref}</termxref>)"
+        termref = attrs["termxref"] || attrs["name"]
+        "<concept><termxref>#{attrs['name']}</termxref>"\
+          "<renderterm>#{termref}</renderterm><xrefrender/></concept>"
       end
     end
 
+    # Possibilities:
+    # {{<<id>>, term}}
+    # {{<<id>>, term, text}}
+    # {{<<termbase:id>>, term}}
+    # {{<<termbase:id>>, term, text}}
+    # {{term}} equivalent to term:[term]
+    # {{term, text}} equivalent to term:[term, text]
+    # text may optionally be followed by crossreference-rendering, options=""
     class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :concept
-      name_positional_attributes "id", "word", "term"
-      # match %r{concept:(?<target>[^\[]*)\[(?<content>|.*?[^\\])\]$}
       match /\{\{(?<content>|.*?[^\\])\}\}/
       using_format :short
 
-      # deal with locality attrs and their disruption of positional attrs
-      def preprocess_attrs(attrs)
-        attrs.delete("term") if attrs["term"] && !attrs["word"]
-        attrs.delete(3) if attrs[3] == attrs["term"]
-        a = attrs.keys.reject { |k| k.is_a?(String) || [1, 2].include?(k) }
-        attrs["word"] ||= attrs[a[0]] if !a.empty?
-        attrs["term"] ||= attrs[a[1]] if a.length > 1
-        attrs
+      def preprocess_attrs(target)
+        m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/.match(target)
+        ret = { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;$/, "") }
+        m2 = /^(?<rest>.*)(?<opt>,option=.+)?$/.match(m[:rest].sub(/^,/, ""))
+        ret[:opt] = m2[:opt]&.sub(/^,option=/, "")
+        attrs = CSV.parse_line(m2[:rest]) || []
+        ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
+                  xrefrender: attrs[2])
       end
 
-      def process(parent, _target, attr)
-        attr = preprocess_attrs(attr)
-        localities = attr.keys.reject { |k| %w(id word term).include? k }.
-          reject { |k| k.is_a? Numeric }.
-          map { |k| "#{k}=#{attr[k]}" }.join(",")
-        text = [localities, attr["word"]].reject{ |k| k.nil? || k.empty? }.
-          join(",")
-        out = Asciidoctor::Inline.new(parent, :quoted, text).convert
-        %{<concept key="#{attr['id']}" term="#{attr['term']}">#{out}</concept>}
+      def process(parent, target, _attrs)
+        attrs = preprocess_attrs(target)
+        termout = Asciidoctor::Inline.new(parent, :quoted, attrs[:term]).convert
+        wordout = Asciidoctor::Inline.new(parent, :quoted, attrs[:word]).convert
+        xrefout = Asciidoctor::Inline.new(parent, :quoted,
+                                          attrs[:xrefrender]).convert
+        attrs[:id] and return "<concept key='#{attrs[:id]}'><refterm>"\
+          "#{termout}</refterm><renderterm>#{wordout}</renderterm>"\
+          "<xrefrender>#{xrefout}</xrefrender></concept>"
+        "<concept><termxref>#{termout}</termxref><renderterm>#{wordout}"\
+          "</renderterm><xrefrender>#{xrefout}</xrefrender></concept>"
       end
     end
   end

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -3,8 +3,6 @@
 module Asciidoctor
   module Standoc
     # Intelligent term lookup xml modifier
-    # Lookup all `term` and `calause` tags and replace `termxref` tags with
-    # `xref`:target tag
     class TermLookupCleanup
       AUTOMATIC_GENERATED_ID_REGEXP = /\A_/.freeze
       EXISTING_TERM_REGEXP = /\Aterm-/.freeze
@@ -41,7 +39,9 @@ module Asciidoctor
             remove_missing_ref(node, target)
             next
           end
-          modify_ref_node(node, target)
+          x = node.at("../xrefrender")
+          modify_ref_node(x, target)
+          node.name = "refterm"
         end
       end
 
@@ -49,20 +49,18 @@ module Asciidoctor
         log.add("AsciiDoc Input", node,
                 %(Error: Term reference in `term[#{target}]` missing: \
                 "#{target}" is not defined in document))
-        term_name_node = node.previous.previous
-        term_name_node.remove
-        term_name_node.name = "strong"
-        term_name_node.children.first.content =
-          %(term "#{term_name_node.text}" not resolved)
-        node.add_previous_sibling(term_name_node)
-        node.remove
+        node.name = "strong"
+        node.at("../xrefrender").remove
+        display = node&.at("../renderterm")&.remove&.children
+        display = [] if display.nil? || display&.to_xml == node.text
+        d = display.empty? ? "" : ", display <tt>#{display.to_xml}</tt>"
+        node.children = "term <tt>#{node.text}</tt>#{d} "\
+          "not resolved via ID <tt>#{target}</tt>"
       end
 
       def modify_ref_node(node, target)
         node.name = "xref"
         node["target"] = termlookup[target]
-        node.children.remove
-        node.remove_attribute("defaultref")
       end
 
       def replace_automatic_generated_ids_terms

data/lib/asciidoctor/standoc/terms.rb

@@ -105,7 +105,7 @@ module Asciidoctor
       end
 
       TERM_REFERENCE_RE_STR = <<~REGEXP.freeze
-        ^(?<xref><(xref|concept)[^>]+>([^<]*</(xref|concept)>)?)
+        ^(?<xref><(xref|concept)[^>]+>(.*?</(xref|concept)>)?)
                (,\s(?<text>.*))?
         $
       REGEXP

data/lib/asciidoctor/standoc/validate.rb

@@ -19,10 +19,10 @@ module Asciidoctor
       end
 
       def iev_validate(xmldoc)
+        @iev = init_iev or return
         xmldoc.xpath("//term").each do |t|
           /^IEC 60050-/.match(t&.at("./termsource/origin/@citeas")&.text) &&
             loc = t.xpath(SOURCELOCALITY)&.text or next
-          @iev = init_iev or return
           iev = @iev.fetch(loc, xmldoc&.at("//language")&.text || "en") or next
           pref = t.xpath("./preferred").inject([]) do |m, x|
             m << x&.text&.downcase
@@ -38,6 +38,7 @@ module Asciidoctor
         norm_ref_validate(doc)
         repeat_id_validate(doc.root)
         iev_validate(doc.root)
+        concept_validate(doc)
       end
 
       def norm_ref_validate(doc)
@@ -54,6 +55,20 @@ module Asciidoctor
           clean_abort("Numeric reference in normative references", doc.to_xml)
       end
 
+      def concept_validate(doc)
+        found = false
+        doc.xpath("//concept/xref").each do |x|
+          next if doc.at("//term[@id = '#{x['target']}']")
+
+          ref = x&.at("../refterm")&.text
+          @log.add("Anchors", x, "Concept #{ref} is pointing to "\
+                   "#{x['target']}, which is not a term")
+          found = true
+        end
+        found and
+          clean_abort("Concept not cross-referencing term", doc.to_xml)
+      end
+
       def repeat_id_validate1(ids, elem)
         if ids[elem["id"]]
           @log.add("Anchors", elem, "Anchor #{elem['id']} has already been "\
@@ -78,13 +93,11 @@ module Asciidoctor
 
       def schema_validate(doc, schema)
         Tempfile.open(["tmp", ".xml"], encoding: "UTF-8") do |f|
-          begin
-            schema_validate1(f, doc, schema)
-          rescue Jing::Error => e
-            clean_abort("Jing failed with error: #{e}", doc.to_xml)
-          ensure
-            f.close!
-          end
+          schema_validate1(f, doc, schema)
+        rescue Jing::Error => e
+          clean_abort("Jing failed with error: #{e}", doc.to_xml)
+        ensure
+          f.close!
         end
       end
 

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.9.4".freeze
+    VERSION = "1.10.0".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "isodoc", "~> 1.6.2"
+  spec.add_dependency "isodoc", "~> 1.7.0"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"

data/spec/asciidoctor/blocks_spec.rb

@@ -1051,13 +1051,13 @@ RSpec.describe Asciidoctor::Standoc do
       Definition
 
       [.source]
-      {{IEV:xyz}}
+      {{<<IEV:xyz>>}}
 
       [.source]
-      {{IEV:xyz,t1}}
+      {{<<IEV:xyz>>,t1}}
 
       [.source]
-      {{IEV:xyz,t1,t2}}
+      {{<<IEV:xyz>>,t1,t2}}
     INPUT
     output = <<~OUTPUT
             #{BLANK_HDR}
@@ -1094,12 +1094,12 @@ RSpec.describe Asciidoctor::Standoc do
         </termsource>
         <termsource status='identical'>
           <origin citeas=''>
-            <termref base='IEV' target='xyz'>t1</termref>
+            <termref base='IEV' target='xyz'/>
           </origin>
         </termsource>
         <termsource status='identical'>
           <origin citeas=''>
-            <termref base='IEV' target='xyz'>t1</termref>
+            <termref base='IEV' target='xyz'/>
           </origin>
         </termsource>
       </term>
@@ -1126,7 +1126,7 @@ RSpec.describe Asciidoctor::Standoc do
       Definition
 
       [.source]
-      {{IEV:xyz}}, with adjustments
+      {{<<IEV:xyz>>}}, with adjustments
     INPUT
     output = <<~OUTPUT
             #{BLANK_HDR}

data/spec/asciidoctor/cleanup_spec.rb

@@ -1618,11 +1618,42 @@ RSpec.describe Asciidoctor::Standoc do
       </standard-document>
     INPUT
     output = <<~OUTPUT
-             #{BLANK_HDR}
-             <sections>
-             <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mfrac><mn>1</mn><mi>r</mi></mfrac></math></stem>
+      #{BLANK_HDR}
+      <sections>
+      <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><mfrac><mn>1</mn><mi>r</mi></mfrac></math></stem>
       </sections>
-             </standard-document>
+      </standard-document>
+    OUTPUT
+    expect(Asciidoctor::Standoc::Converter.new(nil, *OPTIONS)
+      .cleanup(Nokogiri::XML(input)).to_xml)
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "removes nested bibitem IDs" do
+    input = <<~INPUT
+      #{BLANK_HDR}
+      <bibliography>
+        <references normative="true"><title>Normative</title>
+        <bibitem id="A">
+          <relation type="includes">
+            <bibitem id="B"/>
+          </relation>
+        </bibitem>
+      </bibliography>
+      </standard-document>
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+      <bibliography>
+        <references normative="true"><title>Normative</title>
+        <bibitem id="A">
+          <relation type="includes">
+            <bibitem id="B"/>
+          </relation>
+        </bibitem>
+      </references>
+      </bibliography>
+      </standard-document>
     OUTPUT
     expect(Asciidoctor::Standoc::Converter.new(nil, *OPTIONS)
       .cleanup(Nokogiri::XML(input)).to_xml)
@@ -1879,7 +1910,7 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "sorts symbols lists" do
+  it "sorts symbols lists #1" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}
 
@@ -1943,7 +1974,7 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "sorts symbols lists" do
+  it "sorts symbols lists #2" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}