metanorma-standoc 1.3.13 → 1.3.14

data/lib/asciidoctor/standoc/macros.rb

@@ -40,6 +40,36 @@ module Asciidoctor
       end
     end
 
+    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"] and !attrs["word"]
+        attrs.delete(3) if attrs[3] == attrs["term"]
+        a = attrs.keys.reject { |k| k.is_a? String or [1, 2].include? k }
+        attrs["word"] ||= attrs[a[0]] if a.length() > 0
+        attrs["term"] ||= attrs[a[1]] if a.length() > 1
+        attrs
+      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>}
+      end
+    end
+
     class PseudocodeBlockMacro < Asciidoctor::Extensions::BlockProcessor
       use_dsl
       named :pseudocode
@@ -47,16 +77,15 @@ module Asciidoctor
 
       def init_indent(s)
         /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
-        prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0").gsub(/ /, "\u00a0")
+        prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0").
+          gsub(/ /, "\u00a0")
         prefix + suffix
       end
 
       def supply_br(lines)
         lines.each_with_index do |l, i|
-          next if l.empty?
-          next if l.match(/ \+$/)
-          next if i == lines.size - 1
-          next if i < lines.size - 1 && lines[i+1].empty?
+          next if l.empty? || l.match(/ \+$/)
+          next if i == lines.size - 1 || i < lines.size - 1 && lines[i+1].empty?
           lines[i] += " +"
         end
         lines
@@ -69,8 +98,7 @@ module Asciidoctor
       def process parent, reader, attrs
         attrs['role'] = 'pseudocode'
         lines = reader.lines.map { |m| prevent_smart_quotes(init_indent(m)) }
-        create_block(parent, :example, 
-                     supply_br(lines),
+        create_block(parent, :example, supply_br(lines),
                      attrs, content_model: :compound)
       end
     end
@@ -79,7 +107,6 @@ module Asciidoctor
       use_dsl
       named :ruby
       parse_content_as :text
-
       option :pos_attrs, %w(rpbegin rt rpend)
 
       def process(parent, target, attributes)
@@ -87,17 +114,18 @@ module Asciidoctor
         rpend = ')'
         if attributes.size == 1 and attributes.key?("text")
           rt = attributes["text"]
-        elsif attributes.size == 2 and attributes.key?(1) and attributes.key?("rpbegin")
+        elsif attributes.size == 2 and attributes.key?(1) and
+          attributes.key?("rpbegin")
           # for example, html5ruby:楽聖少女[がくせいしょうじょ]
-          rt = attributes[1]
-          rt ||= ""
+          rt = attributes[1] || ""
         else
           rpbegin = attributes['rpbegin']
           rt = attributes['rt']
           rpend = attributes['rpend']
         end
 
-        %(<ruby>#{target}<rp>#{rpbegin}</rp><rt>#{rt}</rt><rp>#{rpend}</rp></ruby>)
+        "<ruby>#{target}<rp>#{rpbegin}</rp><rt>#{rt}</rt>"\
+          "<rp>#{rpend}</rp></ruby>"
       end
     end
 
@@ -143,25 +171,30 @@ module Asciidoctor
         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)
-        fn = save_plantuml parent, reader, localdir
-        umlfile = Pathname.new(localdir) + "plantuml" + "#{fn}.pml"
-        system "plantuml #{umlfile}"
-        # sleep need for windows because dot works in separate process and plantuml process may
-        # finish erlier then dot, as result png file maybe not created yet after plantuml finish
-        until !Gem.win_platform? || File.exist?(Pathname.new(localdir) + "plantuml" + "#{fn}.png")
-          sleep(1)
-        end
-        outfile = parent.image_uri("#{fn}.png")
-        if outfile == "#{fn}.png"
-          (Pathname.new("plantuml") + "#{fn}.png").to_s
-        else
-          FileUtils.mv (Pathname.new(localdir) + "plantuml" + "#{fn}.png").to_s,
-            (Pathname.new(localdir) + outfile).to_s
-          (Pathname.new("#{fn}.png")).to_s
-        end
+        umlfile, outfile = save_plantuml parent, reader, localdir
+        run(umlfile, outfile) or return
+        path = Pathname.new(localdir) + "plantuml"
+        path.mkpath()
+        File.exist?(path) && File.writable?(path) or return
+        FileUtils.cp outfile, path
+        umlfile.unlink
+        File.join(path,File.basename(outfile))
       end
 
       def self.save_plantuml parent, reader, localdir
@@ -169,11 +202,11 @@ module Asciidoctor
         reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
           src = "@startuml\n#{src}\n@enduml\n"
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
-        fn ||= UUIDTools::UUID.random_create
-        path = Pathname.new(localdir) + "plantuml"
-        path.mkpath()
-        (path + "#{fn}.pml").write(src)
-        fn
+        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
@@ -191,19 +224,20 @@ module Asciidoctor
       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)
-        if 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
-        else
-          warn "PlantUML not installed"
-          # attrs.delete(1) : remove the style attribute
-          attrs["language"] = "plantuml"
-          create_listing_block parent, reader.source,
-            attrs.reject { |k, v| k == 1 }
-        end
+        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

data/lib/asciidoctor/standoc/reqt.rb

@@ -54,7 +54,9 @@ module Asciidoctor
             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")
-            ex.inherit node.attr("inherit") if node.attr("inherit")
+            node&.attr("inherit")&.split(/;\s*/)&.each do |i|
+              ex.inherit i
+            end
             requirement_classification(classif, ex) if classif
             wrap_in_para(node, ex)
           end

data/lib/asciidoctor/standoc/reqt.rng

@@ -54,9 +54,9 @@
     <optional>
       <ref name="subject"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="reqinherit"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="classification"/>
     </zeroOrMore>

data/lib/asciidoctor/standoc/validate.rb

@@ -39,7 +39,6 @@ module Asciidoctor
           begin
             f.write(doc.to_xml) 
             f.close
-            #File.open(".tmp.xml", "w:UTF-8") { |f| f.write(doc.to_xml) }
             errors = Jing.new(schema).validate(f.path)
             warn "Valid!" if errors.none?
             errors.each do |error|
@@ -57,11 +56,12 @@ module Asciidoctor
       # any attributes from FormattedString instances (which can contain
       # xs:any markup, and are signalled with @format) before validation.
       def formattedstr_strip(doc)
-        doc.xpath("//*[@format]").each do |n|
+        doc.xpath("//*[@format] | //stem | //bibdata//description | "\
+                  "//formattedref | //bibdata//note | //bibdata/abstract | "\
+                  "//bibitem/abstract | //bibitem/note").each do |n|
           n.elements.each do |e|
             e.traverse do |e1|
-              next unless e1.element?
-              e1.each { |k, _v| e.delete(k) }
+              e1.element? and e1.each { |k, _v| e1.delete(k) }
             end
           end
         end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-    VERSION = "1.3.13".freeze
+    VERSION = "1.3.14".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 1.0.0"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "relaton", "~> 0.6.0"
+  spec.add_dependency "relaton", "~> 0.7.0"
   spec.add_dependency "relaton-iev", "~> 0.1.0"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"

data/spec/asciidoctor-standoc/base_spec.rb

@@ -365,8 +365,8 @@ RSpec.describe Asciidoctor::Standoc do
          </contributor>
          <language>el</language>
          <script>Grek</script>
-         <abstract><p id="_">This is the abstract of the document</p>
-<p id="_">This is the second paragraph of the abstract of the document.</p></abstract>
+         <abstract><p>This is the abstract of the document</p>
+         <p>This is the second paragraph of the abstract of the document.</p></abstract>
          <status><stage>published</stage></status>
          <copyright>
            <from>#{Date.today.year}</from>

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -312,7 +312,7 @@ RSpec.describe Asciidoctor::Standoc do
        <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
          <termnote id="_">
@@ -339,7 +339,7 @@ RSpec.describe Asciidoctor::Standoc do
               <sections>
   <terms id="_" obligation="normative">
   <title>Terms and definitions</title>
-         <p>No terms and definitions are listed in this document.</p>
+         <p id="_">No terms and definitions are listed in this document.</p>
   <clause id="_" inline-header="false" obligation="normative">
   <title>Term1</title>
   <note id="_">
@@ -367,7 +367,7 @@ RSpec.describe Asciidoctor::Standoc do
               #{BLANK_HDR}
               <sections>
   <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
-<p>For the purposes of this document, the following terms and definitions apply.</p>
+<p id="_">For the purposes of this document, the following terms and definitions apply.</p>
 <term id="_">
   <preferred>Term1</preferred>
 </term>
@@ -499,7 +499,7 @@ RSpec.describe Asciidoctor::Standoc do
       <sections>
   <terms id="_" obligation="normative">
   <title>Terms and definitions</title>
-<p>For the purposes of this document, the following terms and definitions apply.</p>
+<p id="_">For the purposes of this document, the following terms and definitions apply.</p>
   <term id="_">
   <preferred>Term1</preferred>
 
@@ -527,7 +527,7 @@ RSpec.describe Asciidoctor::Standoc do
 <sections> 
   <terms id="_" obligation="normative">  
   <title>Terms and definitions</title>  
-<p>No terms and definitions are listed in this document.</p>
+<p id="_">No terms and definitions are listed in this document.</p>
   <clause id="_" inline-header="false" obligation="normative">   
   <title>Term1</title>   
   <example id="_">    
@@ -555,7 +555,7 @@ RSpec.describe Asciidoctor::Standoc do
               #{BLANK_HDR}
 <sections> 
   <terms id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
-<p>For the purposes of this document, the following terms and definitions apply.</p><term id="_">   
+<p id="_">For the purposes of this document, the following terms and definitions apply.</p><term id="_">   
   <preferred>Term1</preferred>   
 </term>  
 <definitions id="_">   
@@ -910,7 +910,7 @@ RSpec.describe Asciidoctor::Standoc do
       #{BLANK_HDR}
        <sections>
          <terms id="_" obligation="normative">
-         <title>Terms and definitions</title><p>For the purposes of this document,
+         <title>Terms and definitions</title><p id="_">For the purposes of this document,
        the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
@@ -938,7 +938,7 @@ RSpec.describe Asciidoctor::Standoc do
             <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document,
+         <p id="_">For the purposes of this document,
        the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
@@ -958,7 +958,7 @@ RSpec.describe Asciidoctor::Standoc do
         it "processes recommendation" do
     input = <<~"INPUT"
       #{ASCIIDOC_BLANK_HDR}
-      [.recommendation,label="/ogc/recommendation/wfs/2",subject="user",inherit="/ss/584/2015/level/1",options="unnumbered",type=verification,model=ogc]
+      [.recommendation,label="/ogc/recommendation/wfs/2",subject="user",inherit="/ss/584/2015/level/1; /ss/584/2015/level/2",options="unnumbered",type=verification,model=ogc]
       ====
       I recommend this
       ====
@@ -970,6 +970,7 @@ RSpec.describe Asciidoctor::Standoc do
   <label>/ogc/recommendation/wfs/2</label>
 <subject>user</subject>
 <inherit>/ss/584/2015/level/1</inherit>
+<inherit>/ss/584/2015/level/2</inherit>
   <description><p id="_">I recommend this</p></description>
 </recommendation>
        </sections>

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -157,7 +157,7 @@ RSpec.describe Asciidoctor::Standoc do
               <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_"><preferred><stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><msub><mi>t</mi><mn>90</mn></msub></math></stem></preferred><admitted><stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><msub><mi>t</mi><mn>91</mn></msub></math></stem></admitted>
        <definition><p id="_">Time</p></definition></term>
        </terms>
@@ -185,7 +185,7 @@ RSpec.describe Asciidoctor::Standoc do
               <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Tempus</preferred>
          <domain>relativity</domain><definition><p id="_"> Time</p></definition>
@@ -228,7 +228,7 @@ RSpec.describe Asciidoctor::Standoc do
               <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_"><preferred><stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><msub><mi>t</mi><mn>90</mn></msub></math></stem></preferred><definition><formula id="_"> 
          <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><msub><mi>t</mi><mi>A</mi></msub></math></stem> 
        </formula>
@@ -256,7 +256,7 @@ RSpec.describe Asciidoctor::Standoc do
        #{BLANK_HDR}
               <sections>
          <terms id="_" obligation="normative"><title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
 
        <term id="_">
        <preferred>Time</preferred>
@@ -436,7 +436,7 @@ RSpec.describe Asciidoctor::Standoc do
        <sections>
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_">
          <preferred>Term1</preferred>
          <termsource status="identical">
@@ -871,7 +871,7 @@ RSpec.describe Asciidoctor::Standoc do
        <sections>
        <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_"><preferred>Term</preferred>
 
 
@@ -994,7 +994,7 @@ RSpec.describe Asciidoctor::Standoc do
 
           <sections>
         <terms id="_" obligation="normative"><title>Terms and definitions</title>
-         <p>For the purposes of this document, the following terms and definitions apply.</p>
+         <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          <term id="_">
           <preferred>Automation1</preferred>
           <termsource status="identical">
@@ -1052,6 +1052,7 @@ RSpec.describe Asciidoctor::Standoc do
               </organization>
             </owner>
           </copyright>
+          <place>Geneva</place>
         </bibitem><bibitem type="standard" id="IEC60050-103">
           <fetched>#{Date.today}</fetched>
           <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
@@ -1089,6 +1090,7 @@ RSpec.describe Asciidoctor::Standoc do
               </organization>
             </owner>
           </copyright>
+          <place>Geneva</place>
         </bibitem>
         </references></bibliography>
         </standard-document>
@@ -1331,7 +1333,7 @@ OUTPUT
       <sections>
 
 </sections><bibliography><references id="_" obligation="informative">
-  <title>Normative References</title><p>There are no normative references in this document.</p>
+  <title>Normative References</title><p id="_">There are no normative references in this document.</p>
 </references></bibliography>
 </standard-document>
       OUTPUT
@@ -1350,7 +1352,7 @@ OUTPUT
     <sections>
 
        </sections><bibliography><references id="_" obligation="informative">
-         <title>Normative References</title><p>The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
+         <title>Normative References</title><p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
          <bibitem id="a">
          <formattedref format="application/x-isodoc+xml">A</formattedref>
          <docidentifier>b</docidentifier>
@@ -1379,7 +1381,7 @@ it "inserts boilerplate before empty Normative References in French" do
     <sections>
 
 </sections><bibliography><references id="_" obligation="informative">
-  <title>Normative References</title><p>Le présent document ne contient aucune référence normative.</p>
+  <title>Normative References</title><p id="_">Le présent document ne contient aucune référence normative.</p>
 </references></bibliography>
 </standard-document>
       OUTPUT
@@ -1425,7 +1427,7 @@ it "removes bibdata bibitem IDs" do
   <bibliography>
     <references id='_' obligation='informative'>
       <title>Normative References</title>
-      <p>There are no normative references in this document.</p>
+      <p id="_">There are no normative references in this document.</p>
     </references>
   </bibliography>
 </standard-document>

data/spec/asciidoctor-standoc/inline_spec.rb

@@ -220,7 +220,7 @@ text, including <strong><em>nest</em></strong>ed markup.</p>
 
        </sections><bibliography><references id="_" obligation="informative">
          <title>Normative References</title>
-         <p>The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
+         <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
          <bibitem id="ISO712">
          <formattedref format="application/x-isodoc+xml">Reference</formattedref>
          <docidentifier>x</docidentifier>

data/spec/asciidoctor-standoc/isobib_cache_spec.rb

@@ -90,6 +90,7 @@ EOS
              <formattedref format="text/plain">ISO 124:2011</formattedref>
            </bibitem>
          </relation>
+         <place>Geneva</place>
          <ext>
            <doctype>international-standard</doctype>
            <editorialgroup>
@@ -257,6 +258,7 @@ EOS
              <formattedref format="text/plain">ISO 123:1985</formattedref>
            </bibitem>
          </relation>
+         <place>Geneva</place>
          <ext>
            <doctype>international-standard</doctype>
            <editorialgroup>
@@ -368,7 +370,7 @@ EOS
     db = Relaton::Db.new "#{Dir.home}/.relaton/cache", nil
     entry = db.load_entry("ISO(ISO 123:2001)")
     expect(entry).to include("<fetched>#{Date.today.to_s}</fetched>")
-    expect(entry).to be_equivalent_to(ISO_123_DATED)  
+    expect(xmlpp(entry)).to be_equivalent_to(xmlpp(ISO_123_DATED))
 
     FileUtils.rm_rf File.expand_path("~/.relaton/cache")
     FileUtils.rm_rf File.expand_path("~/.iev/cache")
@@ -557,7 +559,7 @@ EOS
     entry = db.load_entry("ISO(ISO 124:2014)")
     #expect(db.fetched("ISO(ISO 124:2014)")).to eq(Date.today.to_s)
     expect(entry).to include("<fetched>#{Date.today.to_s}</fetched>")
-    expect(entry).to be_equivalent_to(ISO_124_DATED) 
+    expect(xmlpp(entry)).to be_equivalent_to(xmlpp(ISO_124_DATED))
 
     FileUtils.rm_rf File.expand_path("~/.relaton/cache")
     FileUtils.mv File.expand_path("~/.relaton-bib.pstore1"), File.expand_path("~/.relaton/cache"), force: true