metanorma-iec 1.4.2 → 2.0.0

data/spec/metanorma/cleanup_spec.rb

@@ -0,0 +1,374 @@
+require "spec_helper"
+
+RSpec.describe Metanorma::Iec do
+  before(:all) do
+    @blank_hdr = blank_hdr_gen
+  end
+
+  it "moves note from TC/SC officers to metadata" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == {blank}
+
+      [NOTE]
+      .Note from TC/SC Officers
+      ====
+      This FDIS is the result of the discussion between the IEC SC21A experts WG 3 during the meeting held in
+      Chicago (USA) on April 9th
+
+      This document is also of interest for ISO/ TC114/ WG1 Requirements for Watch batteries
+      ====
+    INPUT
+    output = <<~OUTPUT
+          <iec-standard xmlns="https://www.metanorma.org/ns/iec" type="semantic" version="#{Metanorma::Iec::VERSION}">
+      <bibdata type="standard">
+        <contributor>
+          <role type="author"/>
+          <organization>
+            <name>International Electrotechnical Commission</name>
+            <abbreviation>IEC</abbreviation>
+          </organization>
+        </contributor>
+        <contributor>
+          <role type="publisher"/>
+          <organization>
+            <name>International Electrotechnical Commission</name>
+            <abbreviation>IEC</abbreviation>
+          </organization>
+        </contributor>
+        <language>en</language>
+        <script>Latn</script>
+        <status>
+          <stage abbreviation="PPUB">60</stage>
+          <substage abbreviation="PPUB">60</substage>
+        </status>
+        <copyright>
+          <from>#{Time.new.year}</from>
+          <owner>
+            <organization>
+              <name>International Electrotechnical Commission</name>
+              <abbreviation>IEC</abbreviation>
+            </organization>
+          </owner>
+        </copyright>
+        <ext>
+          <doctype>article</doctype>
+        <editorialgroup>
+          <technical-committee/>
+          <subcommittee/>
+          <workgroup/>
+        </editorialgroup>
+        <stagename>International standard</stagename>
+        <tc-sc-officers-note>
+        <p id='_'>
+          This FDIS is the result of the discussion between the IEC SC21A
+          experts WG 3 during the meeting held in Chicago (USA) on April 9th
+        </p>
+        <p id='_'>
+          This document is also of interest for ISO/ TC114/ WG1 Requirements for
+          Watch batteries
+        </p>
+      </tc-sc-officers-note>
+        </ext>
+      </bibdata>
+      #{boilerplate(Nokogiri::XML(BLANK_HDR + '</iec-standard>'))}
+                    <sections>
+               <clause id="_" inline-header="false" obligation="normative">
+
+             </clause>
+             </sections>
+             </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "removes empty text elements" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == {blank}
+    INPUT
+    output = <<~OUTPUT
+      #{@blank_hdr}
+             <sections>
+        <clause id="_" inline-header="false" obligation="normative">
+
+      </clause>
+      </sections>
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "keeps any initial boilerplate from terms and definitions" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      == Terms and Definitions
+
+      I am boilerplate
+
+      * So am I
+
+      === Time
+
+      This paragraph is extraneous
+    INPUT
+    output = <<~OUTPUT
+             #{@blank_hdr}
+                    <sections>
+               <terms id="_" obligation="normative"><title>Terms and definitions</title>
+               <p id="_">For the purposes of this document,
+             the following terms and definitions apply.</p>
+              #{TERMS_BOILERPLATE}
+      <p id='_'>I am boilerplate</p>
+      <ul id='_'>
+        <li>
+          <p id='_'>So am I</p>
+        </li>
+      </ul>
+             <term id="term-time">
+             <preferred><expression><name>Time</name></expression></preferred>
+               <definition><verbal-definition><p id="_">This paragraph is extraneous</p></verbal-definition></definition>
+             </term></terms>
+             </sections>
+             </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "strips type from xrefs" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      <<iso216>>
+
+      [bibliography]
+      == Clause
+      * [[[iso216,ISO 216]]], _Reference_
+    INPUT
+    output = <<~OUTPUT
+             #{@blank_hdr}
+             <preface>
+             <foreword id="_" obligation="informative">
+               <title>FOREWORD</title>
+               <p id="_">
+               <eref type="inline" bibitemid="iso216" citeas="ISO 216"/>
+             </p>
+             </foreword></preface><sections>
+             </sections><bibliography><references id="_" obligation="informative" normative="false">
+        <title>Bibliography</title>
+        <bibitem id="iso216" type="standard">
+        <title format="text/plain">Reference</title>
+        <docidentifier>ISO 216</docidentifier>
+        <docnumber>216</docnumber>
+        <contributor>
+          <role type="publisher"/>
+          <organization>
+            <name>International Organization for Standardization</name>
+            <abbreviation>ISO</abbreviation>
+          </organization>
+        </contributor>
+      </bibitem>
+      </references></bibliography>
+             </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "removes extraneous material from Normative References" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      [bibliography]
+      == Normative References
+
+      This is extraneous information
+
+      * [[[iso216,ISO 216]]], _Reference_
+    INPUT
+    output = <<~OUTPUT
+      #{@blank_hdr}
+      <sections></sections>
+      <bibliography><references id="_" obligation="informative" normative="true"><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="iso216" type="standard">
+         <title format="text/plain">Reference</title>
+         <docidentifier>ISO 216</docidentifier>
+         <docnumber>216</docnumber>
+         <contributor>
+           <role type="publisher"/>
+           <organization>
+             <name>International Organization for Standardization</name>
+             <abbreviation>ISO</abbreviation>
+           </organization>
+         </contributor>
+       </bibitem>
+      </references>
+      </bibliography>
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "inserts IDs into paragraphs" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      Paragraph
+    INPUT
+    output = <<~OUTPUT
+      #{@blank_hdr}
+      <sections>
+        <p id="_">Paragraph</p>
+      </sections>
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "inserts IDs into notes" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      [example]
+      ====
+      NOTE: This note has no ID
+      ====
+    INPUT
+    output = <<~OUTPUT
+      #{@blank_hdr}
+      <sections>
+        <example id="_">
+        <note id="_">
+        <p id="_">This note has no ID</p>
+      </note>
+      </example>
+      </sections>
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "moves footnotes inside figures" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      image::spec/examples/rice_images/rice_image1.png[]
+
+      footnote:[This is a footnote to a figure]
+
+      footnote:[This is another footnote to a figure]
+    INPUT
+    output = <<~OUTPUT
+      #{@blank_hdr}
+      <sections><figure id="_">
+        <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>
+      </fn><fn reference="b">
+        <p id="_">This is another footnote to a figure</p>
+      </fn></figure>
+
+      </sections>
+
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "defaults section obligations" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause
+      Text
+
+      [appendix]
+      == Clause
+
+      Text
+    INPUT
+    output = <<~OUTPUT
+      #{@blank_hdr}
+      <sections><clause id="_" inline-header="false" obligation="normative">
+        <title>Clause</title>
+        <p id="_">Text</p>
+      </clause>
+      </sections><annex id="_" inline-header="false" obligation="normative">
+        <title>Clause</title>
+        <p id="_">Text</p>
+      </annex>
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "extends clause levels past 5" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause1
+
+      === Clause2
+
+      ==== Clause3
+
+      ===== Clause4
+
+      ====== Clause 5
+
+      [level=6]
+      ====== Clause 6
+
+      [level=7]
+      ====== Clause 7A
+
+      [level=7]
+      ====== Clause 7B
+
+      [level=6]
+      ====== Clause 6B
+
+      ====== Clause 5B
+
+    INPUT
+    output = <<~OUTPUT
+          #{@blank_hdr}
+          <sections>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>Clause1</title>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>Clause2</title>
+        <clause id="_" inline-header="false" obligation="normative">
+        <title>Clause3</title>
+        <clause id="_" inline-header="false" obligation="normative"><title>Clause4</title><clause id="_" inline-header="false" obligation="normative">
+        <title>Clause 5</title>
+      <clause id="_" inline-header="false" obligation="normative">
+        <title>Clause 6</title>
+      <clause id="_" inline-header="false" obligation="normative">
+        <title>Clause 7A</title>
+      </clause><clause id="_" inline-header="false" obligation="normative">
+        <title>Clause 7B</title>
+      </clause></clause><clause id="_" inline-header="false" obligation="normative">
+        <title>Clause 6B</title>
+      </clause></clause>
+
+
+
+
+      <clause id="_" inline-header="false" obligation="normative">
+        <title>Clause 5B</title>
+      </clause></clause>
+      </clause>
+      </clause>
+      </clause>
+      </sections>
+      </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+end

data/spec/metanorma/iev_spec.rb

@@ -0,0 +1,248 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Metanorma::Iec do
+  before(:all) do
+    @boilerplate = boilerplate(Nokogiri::XML("#{BLANK_HDR}</iec-standard>"))
+  end
+
+  it "generates reference boilerplate for IEV" do
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      [bibliography]
+      == Normative References
+
+      * [[[A,B]]], _TITLE_
+    INPUT
+    output = <<~OUTPUT
+      <?xml version='1.0' encoding='UTF-8'?>
+             <iec-standard xmlns='https://www.metanorma.org/ns/iec' type="semantic" version="#{Metanorma::Iec::VERSION}">
+               <bibdata type='standard'>
+                 <docidentifier type='ISO'>IEC 60050 ED 1</docidentifier>
+                 <docnumber>60050</docnumber>
+                 <contributor>
+                   <role type='author'/>
+                   <organization>
+                     <name>International Electrotechnical Commission</name>
+                     <abbreviation>IEC</abbreviation>
+                   </organization>
+                 </contributor>
+                 <contributor>
+                   <role type='publisher'/>
+                   <organization>
+                     <name>International Electrotechnical Commission</name>
+                     <abbreviation>IEC</abbreviation>
+                   </organization>
+                 </contributor>
+                 <language>en</language>
+                 <script>Latn</script>
+                 <status>
+                   <stage abbreviation="PPUB">60</stage>
+                   <substage abbreviation="PPUB">60</substage>
+                 </status>
+                 <copyright>
+                   <from>#{Time.now.year}</from>
+                   <owner>
+                     <organization>
+                       <name>International Electrotechnical Commission</name>
+                       <abbreviation>IEC</abbreviation>
+                     </organization>
+                   </owner>
+                 </copyright>
+                 <ext>
+                   <doctype>article</doctype>
+                            <subdoctype>vocabulary</subdoctype>
+                   <editorialgroup>
+                     <technical-committee/>
+                     <subcommittee/>
+                     <workgroup/>
+                   </editorialgroup>
+                   <structuredidentifier>
+                     <project-number>IEC 60050</project-number>
+                   </structuredidentifier>
+                         <stagename>International standard</stagename>
+                 </ext>
+               </bibdata>
+               #{@boilerplate}
+               <sections> </sections>
+               <bibliography>
+                 <references id='_' obligation='informative' normative="true">
+                   <title>Normative references</title>
+                   <p id='_'>There are no normative references in this document.</p>
+                   <bibitem id='A'>
+                     <formattedref format='application/x-isodoc+xml'>
+                       <em>TITLE</em>
+                     </formattedref>
+                     <docidentifier>B</docidentifier>
+                   </bibitem>
+                 </references>
+               </bibliography>
+             </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "generates terms boilerplate for IEV" do
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      == Terms and definitions
+      === General
+      ==== Term 1
+    INPUT
+    output = <<~OUTPUT
+      <iec-standard xmlns='https://www.metanorma.org/ns/iec' type="semantic" version="#{Metanorma::Iec::VERSION}">
+        <bibdata type='standard'>
+          <docidentifier type='ISO'>IEC 60050 ED 1</docidentifier>
+          <docnumber>60050</docnumber>
+          <contributor>
+            <role type='author'/>
+            <organization>
+              <name>International Electrotechnical Commission</name>
+              <abbreviation>IEC</abbreviation>
+            </organization>
+          </contributor>
+          <contributor>
+            <role type='publisher'/>
+            <organization>
+              <name>International Electrotechnical Commission</name>
+              <abbreviation>IEC</abbreviation>
+            </organization>
+          </contributor>
+          <language>en</language>
+          <script>Latn</script>
+          <status>
+            <stage abbreviation="PPUB">60</stage>
+            <substage abbreviation="PPUB">60</substage>
+          </status>
+          <copyright>
+            <from>#{Time.now.year}</from>
+            <owner>
+              <organization>
+                <name>International Electrotechnical Commission</name>
+                <abbreviation>IEC</abbreviation>
+              </organization>
+            </owner>
+          </copyright>
+          <ext>
+            <doctype>article</doctype>
+                            <subdoctype>vocabulary</subdoctype>
+            <editorialgroup>
+              <technical-committee/>
+              <subcommittee/>
+              <workgroup/>
+            </editorialgroup>
+            <structuredidentifier>
+              <project-number>IEC 60050</project-number>
+            </structuredidentifier>
+            <stagename>International standard</stagename>
+          </ext>
+        </bibdata>
+                 #{@boilerplate}
+        <sections>
+          <clause id='_' obligation='normative'>
+            <title>Terms and definitions</title>
+            <terms id='_' obligation='normative'>
+              <title>General</title>
+              <term id='term-term-1'>
+                <preferred><expression><name>Term 1</name></expression></preferred>
+              </term>
+            </terms>
+          </clause>
+        </sections>
+      </iec-standard>
+
+    OUTPUT
+  end
+
+  it "uses IEV introduction title" do
+    input = <<~INPUT
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      == Introduction
+
+      Text
+    INPUT
+    output = <<~OUTPUT
+      <?xml version='1.0' encoding='UTF-8'?>
+      <iec-standard xmlns='https://www.metanorma.org/ns/iec' type="semantic" version="#{Metanorma::Iec::VERSION}">
+           <bibdata type='standard'>
+             <docidentifier type='ISO'>IEC 60050 ED 1</docidentifier>
+             <docnumber>60050</docnumber>
+             <contributor>
+               <role type='author'/>
+               <organization>
+                 <name>International Electrotechnical Commission</name>
+                 <abbreviation>IEC</abbreviation>
+               </organization>
+             </contributor>
+             <contributor>
+               <role type='publisher'/>
+               <organization>
+                 <name>International Electrotechnical Commission</name>
+                 <abbreviation>IEC</abbreviation>
+               </organization>
+             </contributor>
+             <language>en</language>
+             <script>Latn</script>
+             <status>
+               <stage abbreviation='PPUB'>60</stage>
+               <substage abbreviation='PPUB'>60</substage>
+             </status>
+             <copyright>
+               <from>#{Time.now.year}</from>
+               <owner>
+                 <organization>
+                   <name>International Electrotechnical Commission</name>
+                   <abbreviation>IEC</abbreviation>
+                 </organization>
+               </owner>
+             </copyright>
+             <ext>
+               <doctype>article</doctype>
+                        <subdoctype>vocabulary</subdoctype>
+               <editorialgroup>
+                 <technical-committee/>
+                 <subcommittee/>
+                 <workgroup/>
+               </editorialgroup>
+               <structuredidentifier>
+                 <project-number>IEC 60050</project-number>
+               </structuredidentifier>
+               <stagename>International standard</stagename>
+             </ext>
+           </bibdata>
+           #{@boilerplate}
+           <preface>
+             <introduction id='_' obligation='informative'>
+               <title>INTRODUCTION<br/>Principles and rules followed</title>
+                 <p id='_'>Text</p>
+               </introduction>
+             </preface>
+             <sections> </sections>
+           </iec-standard>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+end

data/spec/{asciidoctor → metanorma}/inline_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe Asciidoctor::Iec do
+RSpec.describe Metanorma::Iec do
    before(:all) do
   @blank_hdr = blank_hdr_gen
 end

data/spec/{asciidoctor → metanorma}/lists_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe Asciidoctor::Iec do
+RSpec.describe Metanorma::Iec do
    before(:all) do
   @blank_hdr = blank_hdr_gen
 end