asciidoctor-iso 0.7.0 → 0.7.1

data/lib/asciidoctor/iso/table.rb

@@ -24,8 +24,6 @@ module Asciidoctor
       def table_name(node, xml_table)
         if node.title?
           xml_table.name node.title
-        else
-          style_warning(node, "Table should have title", nil)
         end
       end
 
@@ -34,7 +32,6 @@ module Asciidoctor
           thd << cell.content
         else
           thd << cell.text
-          style(cell, cell.text)
         end
       end
 

data/lib/asciidoctor/iso/utils.rb

@@ -19,6 +19,8 @@ module Asciidoctor
         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?) &&

data/lib/asciidoctor/iso/validate.rb

@@ -75,8 +75,8 @@ module Asciidoctor
         notitle = false
         withtitle = false
         xpath.each do |s|
-          sublabel = s&.at("./title")&.text || s["id"]
-          title_all_siblings(s.xpath("./subsection | ./terms"), sublabel)
+          title_all_siblings(s.xpath("./subsection | ./terms"),
+                             s&.at("./title")&.text || s["id"])
           subtitle = s.at("./title")
           notitle = notitle || (!subtitle || subtitle.text.empty?)
           withtitle = withtitle || !subtitle&.text&.empty?

data/lib/asciidoctor/iso/validate_section.rb

@@ -8,6 +8,9 @@ module Asciidoctor
         normref_validate(doc.root)
         symbols_validate(doc.root)
         sections_sequence_validate(doc.root)
+        section_style(doc.root)
+        sourcecode_style(doc.root)
+        asset_style(doc.root)
       end
 
       def foreword_validate(root)
@@ -51,7 +54,7 @@ module Asciidoctor
 
       # spec of permissible section sequence
       # we skip normative references, it goes to end of list
-      SEQ = 
+      SEQ =
         [
           {
             msg: "Initial section must be (content) Foreword",
@@ -71,9 +74,9 @@ module Asciidoctor
             "Terms and Definitions",
             val: [
               { tag: "terms", title: "Terms and Definitions" },
-              { 
+              {
                 tag: "terms",
-                title: "Terms, Definitions, Symbols and Abbreviated Terms"
+                title: "Terms, Definitions, Symbols and Abbreviated Terms",
               },
             ],
           },
@@ -103,7 +106,8 @@ module Asciidoctor
           return
         end
         n[:tag] == "clause" ||
-          warn("ISO style: Document must contain clause after Terms and Definitions")
+          warn("ISO style: Document must contain clause after "\
+               "Terms and Definitions")
         n == { tag: "clause", title: "Scope" } &&
           warn("ISO style: Scope must occur before Terms and Definitions")
         n = names.shift || return
@@ -132,6 +136,60 @@ module Asciidoctor
         names.empty? ||
           warn("ISO style: There are sections after the final Bibliography")
       end
+
+      NORM_ISO_WARN = "non-ISO/IEC reference not expected as normative".freeze
+      SCOPE_WARN = "Scope contains subsections: should be succint".freeze
+
+      def section_style(root)
+        foreword_style(root.at("//foreword"))
+        introduction_style(root.at("//introduction"))
+        scope_style(root.at("//clause[title = 'Scope']"))
+        scope = root.at("//clause[title = 'Scope']/subsection")
+        scope.nil? || style_warning(scope, SCOPE_WARN, nil)
+      end
+
+      def sourcecode_style(root)
+        root.xpath("//sourcecode").each do |x|
+          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"
+          end
+        end
+      end
+
+      ASSETS_TO_STYLE =
+        "//termsource | //formula | //termnote | //p | //li[not(p)] | "\
+        "//dt | //dd[not(p)] | //td[not(p)] | //th[not(p)]".freeze
+
+      NORM_BIBITEMS =
+        "//references[title = 'Normative References']/bibitem".freeze
+
+      def asset_title_style(root)
+        root.xpath("//figure[image][not(title)]").each do |node|
+          style_warning(node, "Figure should have title", nil)
+        end
+        root.xpath("//table[not(title)]").each do |node|
+          style_warning(node, "Table should have title", nil)
+        end
+      end
+
+      def norm_bibitem_style(root)
+        root.xpath(NORM_BIBITEMS).each do |b|
+          if b.at(Cleanup::ISO_PUBLISHER_XPATH).nil?
+            Utils::warning(b, NORM_ISO_WARN, b.text)
+          end
+        end
+      end
+
+      def asset_style(root)
+        root.xpath("//example | //termexample").each { |e| example_style(e) }
+        root.xpath("//note").each { |e| note_style(e) }
+        root.xpath("//fn").each { |e| footnote_style(e) }
+        root.xpath(ASSETS_TO_STYLE).each { |e| style(e, extract_text(e)) }
+        asset_title_style(root)
+        norm_bibitem_style(root)
+      end
     end
   end
 end

data/lib/asciidoctor/iso/validate_style.rb

@@ -5,38 +5,47 @@ require "pp"
 module Asciidoctor
   module ISO
     module Validate
-      def foreword_style(node, text)
+      def extract_text(node)
+        return "" if node.nil?
+        node1 = node.dup
+        node1.xpath("//link | //locality").each(&:remove)
+        ret = ""
+        node1.traverse { |x| ret += x.text if x.text? }
+        ret
+      end
+
+      def foreword_style(node)
         return if @novalid
-        style_no_guidance(node, text, "Foreword")
+        style_no_guidance(node, extract_text(node), "Foreword")
       end
 
-      def scope_style(node, text)
+      def scope_style(node)
         return if @novalid
-        style_no_guidance(node, text, "Scope")
+        style_no_guidance(node, extract_text(node), "Scope")
       end
 
-      def introduction_style(node, text)
+      def introduction_style(node)
         return if @novalid
-        r = requirement(text)
+        r = requirement(extract_text(node))
         style_warning(node, "Introduction may contain requirement", r) if r
       end
 
-      def termexample_style(node, text)
+      def example_style(node)
         return if @novalid
-        style_no_guidance(node, text, "Term Example")
-        style(node, text)
+        style_no_guidance(node, extract_text(node), "Term Example")
+        style(node, extract_text(node))
       end
 
-      def note_style(node, text)
+      def note_style(node)
         return if @novalid
-        style_no_guidance(node, text, "Note")
-        style(node, text)
+        style_no_guidance(node, extract_text(node), "Note")
+        style(node, extract_text(node))
       end
 
-      def footnote_style(node, text)
+      def footnote_style(node)
         return if @novalid
-        style_no_guidance(node, text, "Footnote")
-        style(node, text)
+        style_no_guidance(node, extract_text(node), "Footnote")
+        style(node, extract_text(node))
       end
 
       def style_warning(node, msg, text)

data/lib/asciidoctor/iso/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module ISO
-    VERSION = "0.7.0".freeze
+    VERSION = "0.7.1".freeze
   end
 end

data/spec/asciidoctor-iso/base_spec.rb

@@ -89,13 +89,15 @@ RSpec.describe Asciidoctor::ISO do
          <contributor>
            <role type="author"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
          <language>en</language>
@@ -108,7 +110,8 @@ RSpec.describe Asciidoctor::ISO do
            <from>2001</from>
            <owner>
              <organization>
-               <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
              </organization>
            </owner>
          </copyright>
@@ -141,13 +144,16 @@ RSpec.describe Asciidoctor::ISO do
       :tc-docnumber: 2000
       :language: el
       :script: Grek
+      :publisher: IEC,IETF
     INPUT
            <?xml version="1.0" encoding="UTF-8"?>
        <iso-standard xmlns="http://riboseinc.com/isoxml">
        <bibdata type="article">
          <title>
+
          </title>
          <title>
+
          </title>
          <docidentifier>
            <project-number part="1" subpart="1">1000</project-number>
@@ -156,13 +162,25 @@ RSpec.describe Asciidoctor::ISO do
          <contributor>
            <role type="author"/>
            <organization>
-             <name>ISO</name>
+             <name>IEC</name>
+           </organization>
+         </contributor>
+         <contributor>
+           <role type="author"/>
+           <organization>
+             <name>IETF</name>
            </organization>
          </contributor>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>IEC</name>
+           </organization>
+         </contributor>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>IETF</name>
            </organization>
          </contributor>
          <language>el</language>
@@ -175,7 +193,15 @@ RSpec.describe Asciidoctor::ISO do
            <from>2018</from>
            <owner>
              <organization>
-               <name>ISO</name>
+               <name>IEC</name>
+             </organization>
+           </owner>
+         </copyright>
+         <copyright>
+           <from>2018</from>
+           <owner>
+             <organization>
+               <name>IETF</name>
              </organization>
            </owner>
          </copyright>

data/spec/asciidoctor-iso/blocks_spec.rb

@@ -28,6 +28,11 @@ RSpec.describe Asciidoctor::ISO do
       r = 1 % 
       r = 1 % 
       ++++
+
+      [stem]
+      ++++
+      <mml:math><mml:msub xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math"> <mml:mrow> <mml:mrow> <mml:mi mathvariant="bold-italic">F</mml:mi> </mml:mrow> </mml:mrow> <mml:mrow> <mml:mrow> <mml:mi mathvariant="bold-italic">&#x0391;</mml:mi> </mml:mrow> </mml:mrow> </mml:msub> </mml:math>
+      ++++
     INPUT
             #{BLANK_HDR}
        <sections>
@@ -35,6 +40,11 @@ RSpec.describe Asciidoctor::ISO do
          <stem type="AsciiMath">r = 1 %
        r = 1 %</stem>
        </formula>
+
+       <formula id="_">
+         <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><msub> <mrow> <mrow> <mi mathvariant="bold-italic">F</mi> </mrow> </mrow> <mrow> <mrow> <mi mathvariant="bold-italic">Α</mi> </mrow> </mrow> </msub> </math></stem>
+       </stem>
+       </formula>
        </sections>
        </iso-standard>
     OUTPUT

data/spec/asciidoctor-iso/cleanup_spec.rb

@@ -122,25 +122,27 @@ RSpec.describe Asciidoctor::ISO do
     OUTPUT
   end
 
-  it "moves notes inside preceding blocks, if they are not at clause end" do
+  it "moves notes inside preceding blocks, if they are not at clause end, and the blocks are not delimited" do
     expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
-      [source,ruby]
-      [1...x].each do |y|
-        puts y
-      end
+      [stem]
+      ++++
+      r = 1 % 
+      r = 1 % 
+      ++++
 
-      NOTE: That loop does not do much
+      NOTE: That formula does not do much
 
       Indeed.
     INPUT
        #{BLANK_HDR}
-       <sections><sourcecode id="_">[1...x].each do |y|
-         puts y
-       end<note id="_">
-         <p id="_">That loop does not do much</p>
-       </note></sourcecode>
-     
+    <sections><formula id="_">
+  <stem type="AsciiMath">r = 1 %
+r = 1 %</stem>
+<note id="_">
+  <p id="_">That formula does not do much</p>
+</note></formula>
+
        <p id="_">Indeed.</p></sections>
        </iso-standard>
     OUTPUT
@@ -188,11 +190,14 @@ RSpec.describe Asciidoctor::ISO do
          <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
          <docidentifier>ISO 216</docidentifier>
-         <date type="published">2001</date>
+         <date type="published">
+           <from>2001</from>
+         </date>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
        </bibitem>
@@ -225,7 +230,8 @@ RSpec.describe Asciidoctor::ISO do
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
        </bibitem>
@@ -309,7 +315,8 @@ RSpec.describe Asciidoctor::ISO do
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
        </bibitem></references>
@@ -640,11 +647,12 @@ RSpec.describe Asciidoctor::ISO do
          <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
          <docidentifier>ISO 123</docidentifier>
-         <date type="published">--</date>
+         <date type="published"><from>--</from></date>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
          <note format="text/plain" reference="2">ISO DATE: The standard is in press</note>

data/spec/asciidoctor-iso/inline_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe Asciidoctor::ISO do
       super^script^
       sub~script~
       stem:[a_90]
+      stem:[<mml:math><mml:msub xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math"> <mml:mrow> <mml:mrow> <mml:mi mathvariant="bold-italic">F</mml:mi> </mml:mrow> </mml:mrow> <mml:mrow> <mml:mrow> <mml:mi mathvariant="bold-italic">&#x391;</mml:mi> </mml:mrow> </mml:mrow> </mml:msub> </mml:math>]
       [alt]#alt#
       [deprecated]#deprecated#
       [domain]#domain#
@@ -28,6 +29,7 @@ RSpec.describe Asciidoctor::ISO do
        super<sup>script</sup>
        sub<sub>script</sub>
        <stem type="AsciiMath">a_90</stem>
+       <stem type="MathML"><math xmlns="http://www.w3.org/1998/Math/MathML"><msub> <mrow> <mrow> <mi mathvariant="bold-italic">F</mi> </mrow> </mrow> <mrow> <mrow> <mi mathvariant="bold-italic">Α</mi> </mrow> </mrow> </msub> </math></stem>
        <admitted>alt</admitted>
        <deprecates>deprecated</deprecates>
        <domain>domain</domain>

data/spec/asciidoctor-iso/lists_spec.rb

@@ -173,6 +173,7 @@ RSpec.describe Asciidoctor::ISO do
 
      INPUT
              #{BLANK_HDR}
+             <sections>
               <ul id="id1">
          <li id="id2">
            <p id="_">List item</p>

data/spec/asciidoctor-iso/refs_spec.rb

@@ -19,7 +19,8 @@ RSpec.describe Asciidoctor::ISO do
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
        </bibitem>
@@ -55,26 +56,52 @@ RSpec.describe Asciidoctor::ISO do
     OUTPUT
   end
 
-  it "processes dated ISO reference" do
+  it "processes dated ISO reference and joint ISO/IEC references" do
     expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
       [bibliography]
       == Normative References
 
-      * [[[iso123,ISO 123:1066]]] _Standard_
+      * [[[iso123,ISO/IEC 123:1066]]] _Standard_
+      * [[[iso124,ISO 124:1066-1067]]] _Standard_
     INPUT
        #{BLANK_HDR}
               <sections>
-              </sections><references id="_" obligation="informative">
+         
+       </sections><references id="_" obligation="informative">
          <title>Normative References</title>
          <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
-         <docidentifier>ISO 123</docidentifier>
-         <date type="published">1066</date>
+         <docidentifier>ISO/IEC 123</docidentifier>
+         <date type="published">
+           <from>1066</from>
+         </date>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+               <name>International Organization for Standardization</name>
+    <abbreviation>ISO</abbreviation>
+  </organization>
+</contributor>
+<contributor>
+  <role type="publisher"/>
+  <organization>
+    <name>IEC</name>
+           </organization>
+         </contributor>
+       </bibitem>
+         <bibitem id="iso124" type="standard">
+         <title format="text/plain">Standard</title>
+         <docidentifier>ISO 124</docidentifier>
+         <date type="published">
+           <from>1066</from>
+           <to>1067</to>
+         </date>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
        </bibitem>
@@ -98,11 +125,14 @@ RSpec.describe Asciidoctor::ISO do
          <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
          <docidentifier>ISO 123</docidentifier>
-         <date type="published">--</date>
+         <date type="published">
+           <from>--</from>
+         </date>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
          <note format="text/plain" reference="1">ISO DATE: The standard is in press</note>
@@ -128,11 +158,14 @@ RSpec.describe Asciidoctor::ISO do
          <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
          <docidentifier>ISO 123:All Parts</docidentifier>
-         <date type="published">1066</date>
+         <date type="published">
+           <from>1066</from>
+         </date>
          <contributor>
            <role type="publisher"/>
            <organization>
-             <name>ISO</name>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
            </organization>
          </contributor>
        </bibitem>