metanorma-iec 1.0.2 → 1.0.7

data/lib/isodoc/iec/metadata.rb

@@ -4,66 +4,17 @@ require "metanorma-iso"
 module IsoDoc
   module Iec
     class  Metadata < IsoDoc::Iso::Metadata
-      STAGE_ABBRS = {
-        "00" => {"00" => "PWI"},
-        "10" => {"00" => "PNW"},
-        "20" => {"00" => "ANW", "98" => "CAN", "99" => "ACD"},
-        "30" => {"00" => "CD", "20" => "CD", "92" => "BWG", "97" => "MERGED", "98" => "DREJ", "99" => "A2CD"},
-        "35" => {"00" => "CD", "20" => "CD", "91" => "CDM", "92" => "ACD", "99" => "ACDV"},
-        "40" => {"00" => "CCDV", "20" => "CCDV", "91" => "CDVM", "92" => "NCDV", "93" => "NADIS", "95" => "ADISSB", "99" => "ADIS"},
-        "50" => {"00" => "RFDIS", "20" => "CFDIS", "92" => "NFDIS", "95" => "APUBSB", "99" => "APUB"},
-        "60" => {"00" => "BPUB", "60" => "PPUB"},
-        "90" => {"00" => "RR", "92" => "RR"},
-        "92" => {"00" => "AMW", "20" => "AMW"},
-        "95" => {"00" => "WPUB", "99" => "WPUB"},
-        "99" => {"00" => "DELPUB", "60" => "DELPUB"},
-      }.freeze
-
-      def stage_abbr(stage)
-        ret = STAGE_ABBRS.dig(stage, "00") || "??"
-        ret = "PPUB" if stage == "60"
-        ret
-      end
-
-      def status_abbrev1(stage, substage, iter, doctype, draft)
-        return "" unless stage
-        abbr = STAGE_ABBRS.dig(stage, substage) || "??"
-        if stage == "35" && substage == "92"
-          iter = (iter.to_i + 1) % "02"
-        end
-        case doctype
-        when "technical-report"
-          stage = "ADTR" if stage == "40" && substage == "99"
-          stage = "CDTR" if stage == "50" && substage == "20"
-          stage = "DTRM" if stage == "50" && substage == "92"
-        when "technical-specification"
-          stage = "ADTS" if stage == "40" && substage == "99"
-          stage = "CDTS" if stage == "50" && substage == "20"
-          stage = "DTSM" if stage == "50" && substage == "92"
-        when "interpretation-sheet"
-          stage = "RDISH" if stage == "50" && substage == "00"
-          stage = "CDISH" if stage == "50" && substage == "20"
-        when "publicly-available-specification"
-          stage = "CDPAS" if stage == "50" && substage == "20"
-        end
-        abbr = abbr.sub(/CD$/, "#{iter}CD") if iter
-        abbr
-      end
-
       def docstatus(isoxml, _out)
         docstatus = isoxml.at(ns("//bibdata/status/stage"))
+        substage = isoxml.at(ns("//bibdata/status/substage"))
         set(:unpublished, false)
         if docstatus
           set(:stage, docstatus.text)
           set(:stage_int, docstatus.text.to_i)
           set(:unpublished, unpublished(docstatus.text))
-          set(:statusabbr, status_abbrev1(docstatus.text,
-                                          isoxml&.at(ns("//bibdata/status/substage"))&.text,
-                                          isoxml&.at(ns("//bibdata/status/iteration"))&.text,
-                                          isoxml&.at(ns("//bibdata/ext/doctype"))&.text,
-                                          isoxml&.at(ns("//version/draft"))&.text))
+          set(:statusabbr, substage["abbreviation"])
           unpublished(docstatus.text) and
-            set(:stageabbr, stage_abbr(docstatus.text))
+            set(:stageabbr, docstatus["abbreviation"])
         end
         revdate = isoxml.at(ns("//version/revision-date"))
         set(:revdate, revdate&.text)

data/lib/isodoc/iec/pdf_convert.rb

@@ -0,0 +1,31 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Iec
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class PdfConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def convert(filename, file = nil, debug = false)
+        file = File.read(filename, encoding: "utf-8") if file.nil?
+        docxml, outname_html, dir = convert_init(file, filename, debug)
+        /\.xml$/.match(filename) or
+          filename = Tempfile.open([outname_html, ".xml"], encoding: "utf-8") do |f|
+          f.write file
+          f.path
+        end
+        FileUtils.rm_rf dir
+        ::Metanorma::Output::XslfoPdf.new.convert(
+          filename, outname_html + ".pdf",
+          File.join(@libdir, "iec.international-standard.xsl"))
+      end
+    end
+  end
+end

data/lib/metanorma-iec.rb

@@ -3,6 +3,7 @@ require_relative "asciidoctor/iec/converter"
 require_relative "metanorma/iec/version"
 require "isodoc/iec/html_convert"
 require "isodoc/iec/word_convert"
+require "isodoc/iec/pdf_convert"
 require "isodoc/iec/metadata"
 
 if defined? Metanorma

data/lib/metanorma/iec/processor.rb

@@ -2,6 +2,14 @@ require "metanorma/processor"
 
 module Metanorma
   module Iec
+    def self.fonts_used
+      {
+        html: ["Arial", "Times New Roman", "HanSans", "Courier New"],
+        doc: ["Arial", "Times New Roman", "HanSans", "Courier New"],
+        pdf: ["Arial", "Times New Roman", "HanSans", "Courier New"],
+      }
+    end
+
     class Processor < Metanorma::Processor
 
       def initialize
@@ -13,7 +21,8 @@ module Metanorma
       def output_formats
         super.merge(
           html: "html",
-          doc: "doc"
+          doc: "doc",
+          pdf: "pdf"
         )
       end
 
@@ -31,6 +40,8 @@ module Metanorma
           IsoDoc::Iec::HtmlConvert.new(options).convert(outname, isodoc_node)
         when :doc
           IsoDoc::Iec::WordConvert.new(options).convert(outname, isodoc_node)
+        when :pdf
+          IsoDoc::Iec::PdfConvert.new(options).convert(outname, isodoc_node)
         else
           super
         end

data/lib/metanorma/iec/version.rb

@@ -1,6 +1,6 @@
 module Metanorma
   module Iec
-    VERSION = "1.0.2"
+    VERSION = "1.0.7"
   end
 end
 

data/spec/asciidoctor-iec/base_spec.rb

@@ -123,8 +123,8 @@ RSpec.describe Asciidoctor::Iec do
          <language>en</language>
          <script>Latn</script>
          <status>
-           <stage>10</stage>
-           <substage>20</substage>
+           <stage abbreviation="NWIP">10</stage>
+           <substage abbreviation="??">20</substage>
            <iteration>3</iteration>
          </status>
          <copyright>
@@ -159,6 +159,7 @@ RSpec.describe Asciidoctor::Iec do
 <structuredidentifier>
   <project-number part="1">IEC 1000</project-number>
 </structuredidentifier>
+<stagename>New work item proposal</stagename>
        </ext>
        </bibdata>
        #{UNPUBLISHED_BOILERPLATE}
@@ -234,8 +235,8 @@ RSpec.describe Asciidoctor::Iec do
          <language>el</language>
          <script>Grek</script>
          <status>
-           <stage>30</stage>
-           <substage>99</substage>
+           <stage abbreviation="CD">30</stage>
+           <substage abbreviation="A22CD">99</substage>
            <iteration>2</iteration>
          </status>
          <copyright>
@@ -274,6 +275,7 @@ RSpec.describe Asciidoctor::Iec do
          <structuredidentifier>
            <project-number part="1" subpart="1">ISO/IEC/IETF 1000</project-number>
          </structuredidentifier>
+         <stagename>Committee draft</stagename>
          </ext>
        </bibdata>
     #{UNPUBLISHED_BOILERPLATE.sub(/IEC #{Date.today.year}/, "ISO/IEC/IETF 2001")}
@@ -355,8 +357,8 @@ RSpec.describe Asciidoctor::Iec do
   <language>en</language>
   <script>Latn</script>
   <status>
-    <stage>50</stage>
-    <substage>00</substage>
+    <stage abbreviation="FDIS">50</stage>
+    <substage abbreviation="RFDIS">00</substage>
   </status>
   <copyright>
     <from>#{Date.today.year}</from>
@@ -377,6 +379,7 @@ RSpec.describe Asciidoctor::Iec do
     <structuredidentifier>
       <project-number>IEC 1000</project-number>
     </structuredidentifier>
+    <stagename>Final draft international standard</stagename>
   </ext>
 </bibdata>
 #{UNPUBLISHED_BOILERPLATE}
@@ -418,8 +421,8 @@ OUTPUT
   <language>en</language>
   <script>Latn</script>
   <status>
-    <stage>60</stage>
-    <substage>60</substage>
+    <stage abbreviation="PPUB">60</stage>
+    <substage abbreviation="PPUB">60</substage>
   </status>
   <copyright>
     <from>#{Date.today.year}</from>
@@ -440,6 +443,7 @@ OUTPUT
     <structuredidentifier>
       <project-number>IEC 1000</project-number>
     </structuredidentifier>
+    <stagename>International standard</stagename>
   </ext>
 </bibdata>
 #{BOILERPLATE}
@@ -482,8 +486,8 @@ OUTPUT
   <language>en</language>
   <script>Latn</script>
   <status>
-    <stage>60</stage>
-    <substage>00</substage>
+    <stage abbreviation="PPUB">60</stage>
+    <substage abbreviation="BPUB">00</substage>
   </status>
   <copyright>
     <from>#{Date.today.year}</from>
@@ -504,6 +508,7 @@ OUTPUT
     <structuredidentifier>
       <project-number>IEC 1000</project-number>
     </structuredidentifier>
+    <stagename>International standard</stagename>
   </ext>
 </bibdata>
 #{BOILERPLATE}
@@ -537,23 +542,8 @@ OUTPUT
     INPUT
     html = File.read("test.html", encoding: "utf-8")
     expect(html).to match(%r[\bpre[^{]+\{[^{]+font-family: "Courier New", monospace;]m)
-    expect(html).to match(%r[blockquote[^{]+\{[^{]+font-family: "Cambria", serif;]m)
-    expect(html).to match(%r[\.h2Annex[^{]+\{[^{]+font-family: "Cambria", serif;]m)
-  end
-
-  it "uses default fonts for alt doc" do
-    FileUtils.rm_f "test_alt.html"
-    Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)
-      = Document title
-      Author
-      :docfile: test.adoc
-      :novalid:
-      :no-isobib:
-    INPUT
-    html = File.read("test_alt.html", encoding: "utf-8")
-    expect(html).to match(%r[\bpre[^{]+\{[^{]+font-family: "Space Mono", monospace;]m)
-    expect(html).to match(%r[blockquote[^{]+\{[^{]+font-family: "Lato", sans-serif;]m)
-    expect(html).to match(%r[\.h2Annex[^{]+\{[^{]+font-family: "Lato", sans-serif;]m)
+    expect(html).to match(%r[blockquote[^{]+\{[^{]+font-family: "Arial", sans-serif;]m)
+    expect(html).to match(%r[\.h2Annex[^{]+\{[^{]+font-family: "Arial", sans-serif;]m)
   end
 
   it "uses Chinese fonts" do

data/spec/asciidoctor-iec/blocks_spec.rb

@@ -113,7 +113,7 @@ RSpec.describe Asciidoctor::Iec do
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          #{TERMS_BOILERPLATE}
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termnote id="_">
          <p id="_">This is a note</p>
@@ -224,7 +224,7 @@ RSpec.describe Asciidoctor::Iec do
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          #{TERMS_BOILERPLATE}
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termexample id="_">
          <p id="_">This is an example</p>
@@ -352,7 +352,7 @@ RSpec.describe Asciidoctor::Iec do
       #{BLANK_HDR}
        <sections>
          <quote id="_">
-         <source type="inline" bibitemid="ISO7301" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></source>
+         <source type="inline" bibitemid="ISO7301" citeas=""><localityStack><locality type="section"><referenceFrom>1</referenceFrom></locality></localityStack></source>
          <author>ISO</author>
          <p id="_">Block quotation</p>
        </quote>
@@ -426,10 +426,14 @@ RSpec.describe Asciidoctor::Iec do
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          #{TERMS_BOILERPLATE}
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termsource status="identical">
-         <origin bibitemid="ISO2191" type="inline" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></origin>
+         <origin bibitemid="ISO2191" type="inline" citeas="">
+         <localityStack>
+        <locality type="section"><referenceFrom>1</referenceFrom></locality>
+         </localityStack>
+        </origin>
        </termsource>
        </term>
        </terms>
@@ -454,10 +458,14 @@ RSpec.describe Asciidoctor::Iec do
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          #{TERMS_BOILERPLATE}
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termsource status="modified">
-         <origin bibitemid="ISO2191" type="inline" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></origin>
+         <origin bibitemid="ISO2191" type="inline" citeas="">
+         <localityStack>
+        <locality type="section"><referenceFrom>1</referenceFrom></locality>
+         </localityStack>
+        </origin>
          <modification>
            <p id="_">with adjustments</p>
          </modification>

data/spec/asciidoctor-iec/cleanup_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe Asciidoctor::Iec do
          <p id="_">For the purposes of this document, 
        the following terms and definitions apply.</p>
         #{TERMS_BOILERPLATE}
-         <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>
+         <term id="term-t90"><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>
        </sections>
@@ -70,7 +70,7 @@ RSpec.describe Asciidoctor::Iec do
          <p id="_">For the purposes of this document, 
        the following terms and definitions apply.</p>
         #{TERMS_BOILERPLATE}
-         <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="_">
+         <term id="term-t90"><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><p id="_">This paragraph is extraneous</p></definition>
        </term>
@@ -100,7 +100,7 @@ RSpec.describe Asciidoctor::Iec do
        the following terms and definitions apply.</p>
         #{TERMS_BOILERPLATE}
 
-       <term id="_">
+       <term id="term-time">
        <preferred>Time</preferred>
          <definition><p id="_">This paragraph is extraneous</p></definition>
        </term></terms>
@@ -126,11 +126,12 @@ RSpec.describe Asciidoctor::Iec do
          <eref type="inline" bibitemid="iso216" citeas="ISO 216"/>
        </p>
        </foreword></preface><sections>
-       </sections><bibliography><references id="_" obligation="informative">
+       </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>
@@ -160,10 +161,14 @@ RSpec.describe Asciidoctor::Iec do
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
          #{TERMS_BOILERPLATE}
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termsource status="identical">
-         <origin bibitemid="ISO2191" type="inline" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></origin>
+         <origin bibitemid="ISO2191" type="inline" citeas="">
+         <localityStack>
+        <locality type="section"><referenceFrom>1</referenceFrom></locality>
+         </localityStack>
+        </origin>
        </termsource>
        </term>
        </terms>
@@ -184,11 +189,12 @@ RSpec.describe Asciidoctor::Iec do
     INPUT
       #{BLANK_HDR}
       <sections></sections>
-      <bibliography><references id="_" obligation="informative"><title>Normative References</title>
+      <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>

data/spec/asciidoctor-iec/iev_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Asciidoctor::Iec do
+  it "generates reference boilerplate for IEV" do
+     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      [bibliography]
+      == Normative References
+
+      * [[[A,B]]], _TITLE_
+    INPUT
+<?xml version='1.0' encoding='UTF-8'?>
+       <iec-standard xmlns='https://www.metanorma.org/ns/iec'>
+         <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>2020</from>
+             <owner>
+               <organization>
+                 <name>International Electrotechnical Commission</name>
+                 <abbreviation>IEC</abbreviation>
+               </organization>
+             </owner>
+           </copyright>
+           <ext>
+             <doctype>article</doctype>
+             <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
+  end
+
+      it "generates terms boilerplate for IEV" do
+     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      == Terms and definitions
+      === General
+      ==== Term 1
+INPUT
+<iec-standard xmlns='https://www.metanorma.org/ns/iec'>
+  <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>2020</from>
+      <owner>
+        <organization>
+          <name>International Electrotechnical Commission</name>
+          <abbreviation>IEC</abbreviation>
+        </organization>
+      </owner>
+    </copyright>
+    <ext>
+      <doctype>article</doctype>
+      <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>Term 1</preferred>
+        </term>
+      </terms>
+    </clause>
+  </sections>
+</iec-standard>
+
+OUTPUT
+  end
+end