metanorma-standoc 1.3.20 → 1.3.21

data/lib/asciidoctor/standoc/table.rb

@@ -7,7 +7,9 @@ module Asciidoctor
           unnumbered: node.option?("unnumbered") ? "true" : nil,
           subsequence: node.attr("subsequence"),
           alt: node.attr("alt"),
-          summary: node.attr("summary") }
+          summary: node.attr("summary"),
+          width: node.attr("width"),
+        }
       end
 
       def table(node)

data/lib/asciidoctor/standoc/utils.rb

@@ -30,27 +30,17 @@ module Asciidoctor
           docfile.nil? ? './' : Pathname.new(docfile).parent.to_s + '/'
         end
 
-        def current_location(n)
-          return "Line #{n.lineno}" if n.respond_to?(:lineno) &&
-            !n.lineno.nil? && !n.lineno.empty?
-          return "Line #{n.line}" if n.respond_to?(:line) &&
-            !n.line.nil?
-          return "ID #{n.id}" if n.respond_to?(:id) && !n.id.nil?
-          while !n.nil? &&
-              (!n.respond_to?(:level) || n.level.positive?) &&
-              (!n.respond_to?(:context) || n.context != :section)
-            n = n.parent
-            return "Section: #{n.title}" if n&.respond_to?(:context) &&
-              n&.context == :section
-          end
-          "??"
-        end
-
         def smartformat(n)
           n.gsub(/ --? /, " — ").
             gsub(/--/, "&#8212;").smart_format.gsub(/</, "&lt;").gsub(/>/, "&gt;")
         end
 
+        def endash_date(elem)
+          elem.traverse do |n|
+            n.text? and n.replace(n.text.gsub(/\s+--?\s+/, "&#8211;").gsub(/--/, "&#8211;"))
+          end
+        end
+
         # Set hash value using keys path
         # mod from https://stackoverflow.com/a/42425884
         def set_nested_value(hash, keys, new_val)
@@ -76,40 +66,7 @@ module Asciidoctor
           end
         end
 
-        def mn_code(code)
-          code.sub(/^\(/, "[").sub(/\).*$/, "]").sub(/^nofetch\((.+)\)$/, "\\1")
-        end
-
-        def emend_biblio(xml, code, title, usrlbl)
-          unless xml.at("/bibitem/docidentifier[not(@type = 'DOI')][text()]")
-            warn "ERROR: No document identifier retrieved for #{code}"
-            xml.root << "<docidentifier>#{code}</docidentifier>"
-          end
-          unless xml.at("/bibitem/title[text()]")
-            warn "ERROR: No title retrieved for #{code}"
-            xml.root << "<title>#{title || "(MISSING TITLE)"}</title>"
-          end
-          usrlbl and xml.at("/bibitem/docidentifier").next = 
-            "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
-        end
-
-        def endash_date(elem)
-          elem.traverse do |n|
-            n.text? and n.replace(n.text.gsub(/\s+--?\s+/, "&#8211;").gsub(/--/, "&#8211;"))
-          end
-        end
-
-        def smart_render_xml(x, code, title, usrlbl)
-          xstr = x.to_xml if x.respond_to? :to_xml
-          xml = Nokogiri::XML(xstr)
-          emend_biblio(xml, code, title, usrlbl)
-          xml.xpath("//date").each { |d| endash_date(d) }
-          xml.traverse do |n|
-            n.text? and n.replace(smartformat(n.text))
-          end
-          xml.to_xml.sub(/<\?[^>]+>/, "")
-        end
-
+=begin
         def warning(node, msg, text)
           return if @novalid
           warntext = "asciidoctor: WARNING"\
@@ -117,6 +74,7 @@ module Asciidoctor
           warntext += ": #{text}" if text
           warn warntext
         end
+=end
 
         def flatten_rawtext_lines(node, result)
           node.lines.each do |x|
@@ -222,7 +180,8 @@ module Asciidoctor
         type
       end
 
-      SUBCLAUSE_XPATH = "//clause[not(parent::sections)]".freeze
+      SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
+        "[not(ancestor::boilerplate)]".freeze
     end
   end
 end

data/lib/asciidoctor/standoc/validate.rb

@@ -25,24 +25,37 @@ module Asciidoctor
           @iev = init_iev or return
           iev = @iev.fetch(locality, xmldoc&.at("//language")&.text || "en") or next
           pref.include?(iev.downcase) or
-            warn %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}")
+            #warn %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}")
+          @log.add("Bibliography", t, %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}"))
         end
       end
 
       def content_validate(doc)
         section_validate(doc)
+        repeat_id_validate(doc.root)
         iev_validate(doc.root)
       end
 
+      def repeat_id_validate(doc)
+        ids = {}
+        doc.xpath("//*[@id]").each do |x|
+          if ids[x["id"]]
+          @log.add("Anchors", x, "Anchor #{x['id']} has already been used at line #{ids[x['id']]}")
+          else
+            ids[x["id"]] = x.line
+          end
+        end
+        end
+
       def schema_validate(doc, schema)
         Tempfile.open(["tmp", ".xml"], :encoding => 'UTF-8') do |f|
           begin
             f.write(doc.to_xml) 
             f.close
             errors = Jing.new(schema).validate(f.path)
-            warn "Valid!" if errors.none?
+            warn "Syntax Valid!" if errors.none?
             errors.each do |error|
-              warn "#{error[:message]} @ #{error[:line]}:#{error[:column]}"
+              @log.add("Syntax", "XML Line #{"%06d" % error[:line]}:#{error[:column]}", error[:message])
             end
           rescue Jing::Error => e
             abort "Jing failed with error: #{e}"

data/lib/asciidoctor/standoc/validate_section.rb

@@ -14,16 +14,17 @@ module Asciidoctor
           callouts = x.elements.select { |e| e.name == "callout" }
           annotations = x.elements.select { |e| e.name == "annotation" }
           if callouts.size != annotations.size
-            warn "#{x['id']}: mismatch of callouts and annotations"
+            #warn "#{x['id']}: mismatch of callouts and annotations"
+        @log.add("Asciidoctor Input", x, "mismatch of callouts and annotations")
           end
         end
       end
 
       def style_warning(node, msg, text = nil)
-        return if @novalid
-        w = "ISO style: WARNING (#{Utils::current_location(node)}): #{msg}"
+        w = msg
         w += ": #{text}" if text
-        warn w
+        #warn w
+        @log.add("Style Warning", node, w)
       end
 
       def asset_title_style(root)

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.20".freeze
+   VERSION = "1.3.21".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 1.0.0"
+  spec.add_dependency "isodoc", "~> 1.0.20"
   spec.add_dependency "iev", "~> 0.2.1"
   spec.add_dependency "relaton", "~> 0.10.0"
   spec.add_dependency "relaton-iev", "~> 0.1.0"
@@ -47,7 +47,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "= 0.54.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "metanorma", "~> 0.3.0"
   spec.add_development_dependency "vcr", "~> 5.0.0"
   spec.add_development_dependency "webmock"
   #spec.add_development_dependency "relaton-iec"

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -449,7 +449,7 @@ RSpec.describe Asciidoctor::Standoc do
       OUTPUT
   end
 
-  it "removes extraneous material from Normative References" do
+  it "removes initial extraneous material from Normative References" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
       [bibliography]
@@ -458,6 +458,8 @@ RSpec.describe Asciidoctor::Standoc do
       This is extraneous information
 
       * [[[iso216,ISO 216]]], _Reference_
+
+      This is also extraneous information
     INPUT
       #{BLANK_HDR}
       <sections></sections>
@@ -473,12 +475,85 @@ RSpec.describe Asciidoctor::Standoc do
            </organization>
          </contributor>
        </bibitem>
+       <p id='_'>This is also extraneous information</p>
       </references>
       </bibliography>
       </standard-document>
     OUTPUT
   end
 
+    it "sorts references with their notes in Bibliography" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+      [bibliography]
+      == Bibliography
+
+      This is extraneous information
+
+      * [[[iso216,ISO 216]]], _Reference_
+
+      NOTE: ABC
+
+      NOTE: DEF
+
+      This is further extraneous information
+
+      NOTE: GHI
+
+      * [[[iso216,ISO 215]]], _Reference_
+
+      NOTE: JKL
+
+      This is also extraneous information
+    INPUT
+      #{BLANK_HDR}
+      <sections> </sections>
+         <bibliography>
+           <references id='_' obligation='informative'>
+             <title>Bibliography</title>
+             <p id='_'>This is extraneous information</p>
+             <bibitem id='iso216' type='standard'>
+               <title format='text/plain'>Reference</title>
+               <docidentifier>ISO 216</docidentifier>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <name>ISO</name>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <note id='_'>
+               <p id='_'>ABC</p>
+             </note>
+             <note id='_'>
+               <p id='_'>DEF</p>
+             </note>
+             <bibitem id='iso216' type='standard'>
+               <title format='text/plain'>Reference</title>
+               <docidentifier>ISO 215</docidentifier>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <name>ISO</name>
+                 </organization>
+               </contributor>
+             </bibitem>
+             <note id='_'>
+               <p id='_'>JKL</p>
+             </note>
+             <p id='_'>
+               This is further extraneous information
+               <note id='_'>
+                 <p id='_'>GHI</p>
+               </note>
+             </p>
+             <p id='_'>This is also extraneous information</p>
+           </references>
+         </bibliography>
+       </standard-document>
+    OUTPUT
+end
+
   it "inserts IDs into paragraphs" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
@@ -689,6 +764,7 @@ RSpec.describe Asciidoctor::Standoc do
   it "moves footnotes inside figures" do
     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
+      .Figuretitle.footnote:[xyz]
       image::spec/examples/rice_images/rice_image1.png[]
 
       footnote:[This is a footnote to a figure]
@@ -699,6 +775,12 @@ RSpec.describe Asciidoctor::Standoc do
     INPUT
        #{BLANK_HDR}
        <sections><figure id="_">
+       <name>
+  Figuretitle.
+  <fn reference='1'>
+    <p id='_'>xyz</p>
+  </fn>
+</name>
          <image src="spec/examples/rice_images/rice_image1.png" id="_" mimetype="image/png" height="auto" width="auto"/>
        <fn reference="a">
          <p id="_">This is a footnote to a figure</p>
@@ -707,7 +789,7 @@ RSpec.describe Asciidoctor::Standoc do
        </fn></figure>
        <p id='_'>
   A
-  <fn reference='1'>
+  <fn reference='2'>
     <p id='_'>This is a third footnote</p>
   </fn>
 </p>
@@ -1579,6 +1661,86 @@ it "sorts symbols lists" do
   OUTPUT
 end
 
+it "moves inherit macros to correct location" do
+  expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+  #{ASCIIDOC_BLANK_HDR}
+
+  == Clause
+
+  [.requirement,subsequence="A",inherit="/ss/584/2015/level/1 &amp; /ss/584/2015/level/2"]
+  .Title
+  ====
+  inherit:[A]
+  inherit:[B]
+  I recommend this
+  ====
+
+  [.requirement,subsequence="A",classification="X:Y"]
+  .Title
+  ====
+  inherit:[A]
+  I recommend this
+  ====
+
+  [.requirement,subsequence="A"]
+  .Title
+  ====
+  inherit:[A]
+  I recommend this
+  ====
+
+  [.requirement,subsequence="A"]
+  .Title
+  ====
+  inherit:[A]
+  ====
+
+
+  INPUT
+  #{BLANK_HDR}
+  <sections>
+    <clause id='_' inline-header='false' obligation='normative'>
+      <title>Clause</title>
+      <requirement id='_' subsequence='A'>
+        <title>Title</title>
+        <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
+        <inherit>A</inherit>
+        <inherit>B</inherit>
+        <description>
+          <p id='_'> I recommend this</p>
+        </description>
+      </requirement>
+      <requirement id='_' subsequence='A'>
+        <title>Title</title>
+        <inherit>A</inherit>
+        <classification>
+          <tag>X</tag>
+          <value>Y</value>
+        </classification>
+        <description>
+          <p id='_'> I recommend this</p>
+        </description>
+      </requirement>
+      <requirement id='_' subsequence='A'>
+        <title>Title</title>
+        <inherit>A</inherit>
+        <description>
+          <p id='_'> I recommend this</p>
+        </description>
+      </requirement>
+      <requirement id='_' subsequence='A'>
+        <title>Title</title>
+        <inherit>A</inherit>
+        <description>
+          <p id='_'> </p>
+        </description>
+      </requirement>
+    </clause>
+  </sections>
+</standard-document>
+OUTPUT
+end
+
 
   private
 

data/spec/asciidoctor-standoc/lists_spec.rb

@@ -8,6 +8,10 @@ RSpec.describe Asciidoctor::Standoc do
       * List 2
       * List 3
 
+      * [*] checked
+      * [x] also checked
+      * [ ] not checked
+
       . List A
       . List B
       . List C
@@ -17,42 +21,51 @@ RSpec.describe Asciidoctor::Standoc do
 
     INPUT
     expect(xmlpp(strip_guid(output))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-            #{BLANK_HDR}
-       <sections>
-         <ul id="_">
-         <li>
-           <p id="_">List 1</p>
-         </li>
-         <li>
-           <p id="_">List 2</p>
-         </li>
-         <li>
-           <p id="_">List 3</p>
-           <ol id="_" type="arabic">
-         <li>
-           <p id="_">List A</p>
-         </li>
-         <li>
-           <p id="_">List B</p>
-         </li>
-         <li>
-           <p id="_">List C</p>
-           <dl id="_">
-         <dt>List D</dt>
-         <dd>
-           <p id="_">List E</p>
-         </dd>
-         <dt>List F</dt>
-         <dd>
-           <p id="_">List G</p>
-         </dd>
-       </dl>
-         </li>
-       </ol>
-         </li>
-       </ul>
-       </sections>
-       </standard-document>
+  #{BLANK_HDR}
+  <sections>
+    <ul id='_'>
+      <li>
+        <p id='_'>List 1</p>
+      </li>
+      <li>
+        <p id='_'>List 2</p>
+      </li>
+      <li>
+        <p id='_'>List 3</p>
+      </li>
+      <li uncheckedcheckbox='false' checkedcheckbox='true'>
+        <p id='_'>checked</p>
+      </li>
+      <li uncheckedcheckbox='false' checkedcheckbox='true'>
+        <p id='_'>also checked</p>
+      </li>
+      <li uncheckedcheckbox='true' checkedcheckbox='false'>
+        <p id='_'>not checked</p>
+        <ol id='_' type='arabic'>
+          <li>
+            <p id='_'>List A</p>
+          </li>
+          <li>
+            <p id='_'>List B</p>
+          </li>
+          <li>
+            <p id='_'>List C</p>
+            <dl id='_'>
+              <dt>List D</dt>
+              <dd>
+                <p id='_'>List E</p>
+              </dd>
+              <dt>List F</dt>
+              <dd>
+                <p id='_'>List G</p>
+              </dd>
+            </dl>
+          </li>
+        </ol>
+      </li>
+    </ul>
+  </sections>
+</standard-document>
     OUTPUT
   end