metanorma-iec 1.4.2 → 2.0.0

data/spec/metanorma/processor_spec.rb

@@ -2,20 +2,112 @@ require "spec_helper"
 require "metanorma"
 require "fileutils"
 
-#RSpec.describe Asciidoctor::Gb do
 RSpec.describe Metanorma::Iec::Processor do
-
   registry = Metanorma::Registry.instance
   registry.register(Metanorma::Iec::Processor)
   processor = registry.find_processor(:iec)
 
+  inputxml = <<~INPUT
+    <iec-standard xmlns="http://riboseinc.com/isoxml">
+    <bibdata type="standard">
+    <title language="en" format="text/plain" type="main">English</title>
+    <title language="en" format="text/plain" type="title-main">English</title>
+    <title language="fr" format="text/plain" type="main">French</title>
+    <title language="fr" format="text/plain" type="title-main">French</title>
+    <docidentifier type="ISO">ISO DIR 1</docidentifier><docidentifier type="iso-with-lang">ISO DIR 1(F)</docidentifier><docidentifier type="iso-reference">ISO DIR 1(F)</docidentifier>
+    <docnumber>1</docnumber>
+    <contributor>
+    <role type="author"/>
+    <organization>
+    <name>International Organization for Standardization</name>
+    <abbreviation>ISO</abbreviation>
+    </organization>
+    </contributor>
+    <contributor>
+    <role type="publisher"/>
+    <organization>
+    <name>International Organization for Standardization</name>
+    <abbreviation>ISO</abbreviation>
+    </organization>
+    </contributor>
+    <language>fr</language>
+    <script>Latn</script>
+    <status>
+    <stage abbreviation="IS">60</stage>
+    <substage>60</substage>
+    </status>
+    <copyright>
+    <from>2021</from>
+    <owner>
+    <organization>
+    <name>International Organization for Standardization</name>
+    <abbreviation>ISO</abbreviation>
+    </organization>
+    </owner>
+    </copyright>
+    <ext>
+    <doctype>directive</doctype>
+    <subdoctype>vocabulary</subdoctype>
+    <editorialgroup>
+    <technical-committee/>
+    <subcommittee/>
+    <workgroup/>
+    </editorialgroup>
+    <structuredidentifier>
+    <project-number>ISO 1</project-number>
+    </structuredidentifier>
+    <stagename>International standard</stagename>
+    </ext>
+    </bibdata>
+    <boilerplate>
+      <copyright-statement>
+        <clause>
+          <title>DOCUMENT PROT&#201;G&#201; PAR COPYRIGHT</title>
+              <p id="boilerplate-year">&#169; ISO 2021</p>
+
+      <p id="boilerplate-message">
+    Droits de reproduction r&#233;serv&#233;s. Sauf indication contraire, aucune partie de cette publication ne
+    peut &#234;tre reproduite ni utilis&#233;e sous quelque forme que ce soit et par aucun proc&#233;d&#233;, &#233;lectronique
+    ou m&#233;canique, y compris la photocopie, l&#8217;affichage sur l&#8217;internet ou sur un Intranet, sans
+    autorisation &#233;crite pr&#233;alable. Les demandes d&#8217;autorisation peuvent &#234;tre adress&#233;es &#224; l&#8217;ISO &#224;
+    l&#8217;adresse ci-apr&#232;s ou au comit&#233; membre de l&#8217;ISO dans le pays du demandeur.
+      </p>
+
+      <p id="boilerplate-address" align="left">
+        ISO copyright office<br/>
+        Ch. de Blandonnet 8 &#8226; CP 401<br/>
+        CH-1214 Vernier, Geneva, Switzerland<br/>
+        Tel.&#160;&#160;+ 41 22 749 01 11<br/>
+        Fax&#160;&#160;+ 41 22 749 09 47<br/>
+        Email: copyright@iso.org<br/>
+        Website: www.iso.org
+      </p>
+        <p id="boilerplate-place">
+        Publi&#233; en Suisse
+      </p>
+    </clause>
+      </copyright-statement>
+
+
+    </boilerplate>
+          <sections>
+            <terms id="H" obligation="normative"><title>1&#xA0; Terms, Definitions, Symbols and Abbreviated Terms</title>
+              <term id="J">
+                <name>1.1</name>
+                <preferred>Term2</preferred>
+              </term>
+            </terms>
+          </sections>
+        </iec-standard>
+  INPUT
+
   it "registers against metanorma" do
     expect(processor).not_to be nil
   end
 
   it "registers output formats against metanorma" do
     expect(processor.output_formats.sort.to_s).to be_equivalent_to <<~"OUTPUT"
-    [[:doc, "doc"], [:html, "html"], [:pdf, "pdf"], [:presentation, "presentation.xml"], [:rxl, "rxl"], [:xml, "xml"]]
+      [[:doc, "doc"], [:html, "html"], [:pdf, "pdf"], [:presentation, "presentation.xml"], [:rxl, "rxl"], [:sts, "sts.xml"], [:xml, "xml"]]
     OUTPUT
   end
 
@@ -24,53 +116,56 @@ RSpec.describe Metanorma::Iec::Processor do
   end
 
   it "generates IsoDoc XML from a blank document" do
-    expect(xmlpp(strip_guid(processor.input_to_isodoc(<<~"INPUT", nil)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-    #{ASCIIDOC_BLANK_HDR}
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
     INPUT
-    #{blank_hdr_gen}
-<sections/>
-</iec-standard>
+    output = <<~OUTPUT
+          #{blank_hdr_gen}
+      <sections/>
+      </iec-standard>
     OUTPUT
+    expect(xmlpp(strip_guid(processor.input_to_isodoc(input, nil))))
+      .to be_equivalent_to xmlpp(output)
   end
 
   it "generates HTML from IsoDoc XML" do
     FileUtils.rm_f "test.xml"
-    processor.output(<<~"INPUT", "test.xml", "test.html", :html)
-               <iec-standard xmlns="http://riboseinc.com/isoxml">
-       <sections>
-       <terms id="H" obligation="normative"><title>1<tab/>Terms, Definitions, Symbols and Abbreviated Terms</title>
-         <term id="J">
-         <name>1.1</name>
-         <preferred>Term2</preferred>
-       </term>
-        </terms>
-        </sections>
-        </iec-standard>
-    INPUT
-    expect(xmlpp(File.read("test.html", encoding: "utf-8").gsub(%r{^.*<main}m, "<main").gsub(%r{</main>.*}m, "</main>"))).to be_equivalent_to xmlpp(<<~"OUTPUT")
-           <main class="main-section"><button onclick="topFunction()" id="myBtn" title="Go to top">Top</button>
-              <br />
- <p class="zzSTDTitle1">INTERNATIONAL ELECTROTECHNICAL COMMISSION</p>
- <p class="zzSTDTitle1">____________</p>
- <p class="zzSTDTitle1">&#xA0;</p>
- <p class="zzSTDTitle1">
-   <b></b>
- </p>
- <p class="zzSTDTitle1">&#xA0;</p>
- <div id="">
-   <h1 class="ForewordTitle" id="toc0">FOREWORD</h1>
-   <div class="boilerplate_legal"></div>
- </div>
- <p class="zzSTDTitle1">
-   <b></b>
- </p>
- <p class="zzSTDTitle1">&#xA0;</p>
-             <div id="H"><h1 id="toc1">1&#xA0; Terms, Definitions, Symbols and Abbreviated Terms</h1>
-       <h2 class="TermNum" id="J">1.1</h2>
-         <p class="Terms" style="text-align:left;">Term2</p>
-       </div>
-           </main>
-    OUTPUT
+    FileUtils.rm_f "test.html"
+    processor.output(inputxml, "test.xml", "test.html", :html)
+    expect(xmlpp(File.read("test.html", encoding: "utf-8")
+      .gsub(%r{^.*<main}m, "<main")
+      .gsub(%r{</main>.*}m, "</main>")))
+      .to be_equivalent_to xmlpp(<<~"OUTPUT")
+                  <main class="main-section"><button onclick="topFunction()" id="myBtn" title="Go to top">Top</button>
+                     <br />
+        <p class="zzSTDTitle1">COMMISSION ELECTROTECHNIQUE INTERNATIONALE</p>
+        <p class="zzSTDTitle1">____________</p>
+        <p class="zzSTDTitle1">&#xA0;</p>
+        <p class="zzSTDTitle1">
+          <b>French</b>
+        </p>
+        <p class="zzSTDTitle1">&#xA0;</p>
+        <div id="">
+          <h1 class="ForewordTitle" id="toc0">AVANT-PROPOS</h1>
+          <div class="boilerplate_legal"></div>
+        </div>
+        <p class="zzSTDTitle1">
+          <b>French</b>
+        </p>
+        <p class="zzSTDTitle1">&#xA0;</p>
+                    <div id="H"><h1 id="toc1">1&#xA0; Terms, Definitions, Symbols and Abbreviated Terms</h1>
+              <h2 class="TermNum" id="J">1.1</h2>
+                <p class="Terms" style="text-align:left;">Term2</p>
+              </div>
+                  </main>
+      OUTPUT
   end
 
+  it "generates STS from Metanorma XML" do
+    FileUtils.rm_f "test.xml"
+    FileUtils.rm_f "test.sts.xml"
+    File.open("test.xml", "w") { |f| f.write inputxml }
+    processor.output(inputxml, "test.xml", "test.sts.xml", :sts)
+    expect(File.exist?("test.sts.xml")).to be true
+  end
 end

data/spec/{asciidoctor → metanorma}/section_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}/validate_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "fileutils"
 
-RSpec.describe Asciidoctor::Iec do
+RSpec.describe Metanorma::Iec do
   context "when xref_error.adoc compilation" do
     around do |example|
       FileUtils.rm_f "spec/assets/xref_error.err"

data/spec/spec_helper.rb

@@ -27,7 +27,7 @@ end
 
 def metadata(xml)
   xml.sort.to_h.delete_if do |_k, v|
-    v.nil? || v.respond_to?(:empty?) && v.empty?
+    v.nil? || (v.respond_to?(:empty?) && v.empty?)
   end
 end
 
@@ -105,24 +105,23 @@ VALIDATING_BLANK_HDR = <<~"HDR".freeze
 HDR
 
 TERMS_BOILERPLATE = <<~"BOILERPLATE".freeze
-           <p id="_">ISO and IEC maintain terminological databases for use in
-           standardization at the following addresses:</p>
-  #{'         '}
-            <ul id="_">
-            <li> <p id="_">IEC Electropedia: available at
-            <link target="http://www.electropedia.org"/>
-            </p> </li>#{' '}
-                    <li> <p id="_">ISO Online browsing platform: available at
-              <link target="http://www.iso.org/obp"/></p> </li>
-    </ul>
+         <p id="_">ISO and IEC maintain terminological databases for use in
+         standardization at the following addresses:</p>
+          <ul id="_">
+          <li> <p id="_">IEC Electropedia: available at
+          <link target="http://www.electropedia.org"/>
+          </p> </li>
+                  <li> <p id="_">ISO Online browsing platform: available at
+            <link target="http://www.iso.org/obp"/></p> </li>
+  </ul>
 BOILERPLATE
 
 def boilerplate(xmldoc)
   file = File.read(
-    File.join(File.dirname(__FILE__), "..", "lib", "asciidoctor", "iec",
+    File.join(File.dirname(__FILE__), "..", "lib", "metanorma", "iec",
               "iec_intro_en.xml"), encoding: "utf-8"
   )
-  conv = Asciidoctor::Iec::Converter.new(nil, backend: :iec,
+  conv = Metanorma::Iec::Converter.new(nil, backend: :iec,
                                               header_footer: true)
   conv.init(Asciidoctor::Document.new([]))
   ret = Nokogiri::XML(
@@ -169,7 +168,6 @@ BLANK_HDR = <<~"HDR".freeze
     </copyright>
     <ext>
       <doctype>article</doctype>
-      <horizontal>false</horizontal>
     <editorialgroup>
       <technical-committee/>
       <subcommittee/>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iec
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-iso
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: ruby-jing
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -212,16 +212,6 @@ files:
 - README.adoc
 - Rakefile
 - bin/rspec
-- lib/asciidoctor/iec/basicdoc.rng
-- lib/asciidoctor/iec/biblio.rng
-- lib/asciidoctor/iec/converter.rb
-- lib/asciidoctor/iec/front.rb
-- lib/asciidoctor/iec/iec.rng
-- lib/asciidoctor/iec/iec_intro_en.xml
-- lib/asciidoctor/iec/iec_intro_fr.xml
-- lib/asciidoctor/iec/isodoc.rng
-- lib/asciidoctor/iec/isostandard.rng
-- lib/asciidoctor/iec/reqt.rng
 - lib/isodoc/iec/base_convert.rb
 - lib/isodoc/iec/html/header.html
 - lib/isodoc/iec/html/html_iec_intro.html
@@ -249,17 +239,19 @@ files:
 - lib/isodoc/iec/xref.rb
 - lib/metanorma-iec.rb
 - lib/metanorma/iec.rb
+- lib/metanorma/iec/basicdoc.rng
+- lib/metanorma/iec/biblio.rng
+- lib/metanorma/iec/converter.rb
+- lib/metanorma/iec/front.rb
+- lib/metanorma/iec/iec.rng
+- lib/metanorma/iec/iec_intro_en.xml
+- lib/metanorma/iec/iec_intro_fr.xml
+- lib/metanorma/iec/isodoc.rng
+- lib/metanorma/iec/isostandard.rng
 - lib/metanorma/iec/processor.rb
+- lib/metanorma/iec/reqt.rng
 - lib/metanorma/iec/version.rb
 - metanorma-iec.gemspec
-- spec/asciidoctor/base_spec.rb
-- spec/asciidoctor/blocks_spec.rb
-- spec/asciidoctor/cleanup_spec.rb
-- spec/asciidoctor/iev_spec.rb
-- spec/asciidoctor/inline_spec.rb
-- spec/asciidoctor/lists_spec.rb
-- spec/asciidoctor/section_spec.rb
-- spec/asciidoctor/validate_spec.rb
 - spec/assets/header.html
 - spec/assets/html.css
 - spec/assets/iso.xml
@@ -277,7 +269,15 @@ files:
 - spec/isodoc/ref_spec.rb
 - spec/isodoc/section_spec.rb
 - spec/isodoc/terms_spec.rb
+- spec/metanorma/base_spec.rb
+- spec/metanorma/blocks_spec.rb
+- spec/metanorma/cleanup_spec.rb
+- spec/metanorma/iev_spec.rb
+- spec/metanorma/inline_spec.rb
+- spec/metanorma/lists_spec.rb
 - spec/metanorma/processor_spec.rb
+- spec/metanorma/section_spec.rb
+- spec/metanorma/validate_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/metanorma/metanorma-iec
 licenses:
@@ -298,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: metanorma-iec lets you write IEC standards in AsciiDoc.

data/lib/asciidoctor/iec/converter.rb

@@ -1,105 +0,0 @@
-require "asciidoctor"
-require "metanorma-iso"
-require_relative "./front.rb"
-
-module Asciidoctor
-  module Iec
-    class Converter < ISO::Converter
-      XML_ROOT_TAG = "iec-standard".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/iec".freeze
-
-      register_for "iec"
-
-      def init(node)
-        super
-        @is_iev = node.attr("docnumber") == "60050"
-      end
-
-      def boilerplate_file(x_orig)
-        lang = case x_orig&.at("//bibdata/language")&.text
-               when "fr" then "fr"
-               else
-                 "en"
-               end
-        File.join(@libdir, "iec_intro_#{lang}.xml")
-      end
-
-      def doctype_validate(xmldoc)
-        doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
-        %w(international-standard technical-specification technical-report 
-        publicly-available-specification international-workshop-agreement 
-        guide interpretation-sheet).include? doctype or
-        @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
-        if function = xmldoc&.at("//bibdata/ext/function")&.text
-          %w(emc quality-assurance safety environment).include? function or 
-            @log.add("Document Attributes", nil, "#{function} is not a recognised document function")
-        end
-      end
-
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "iec.rng"))
-      end
-
-      def html_converter(node)
-        node.nil? ? IsoDoc::Iec::HtmlConvert.new({}) :
-          IsoDoc::Iec::HtmlConvert.new(html_extract_attributes(node))
-      end
-
-      def doc_converter(node)
-        node.nil? ? IsoDoc::Iec::WordConvert.new({}) :
-          IsoDoc::Iec::WordConvert.new(doc_extract_attributes(node))
-      end
-
-      def pdf_converter(node)
-        return if node.attr("no-pdf")
-        node.nil? ? IsoDoc::Iec::PdfConvert.new({}) :
-          IsoDoc::Iec::PdfConvert.new(doc_extract_attributes(node))
-      end
-
-      def presentation_xml_converter(node)
-        node.nil? ? IsoDoc::Iec::PresentationXMLConvert.new({}) :
-          IsoDoc::Iec::PresentationXMLConvert.new(doc_extract_attributes(node))
-      end
-
-      def norm_ref_preface(f)
-        return super unless @is_iev
-        f.at("./title").next =
-          "<p>#{@i18n.norm_empty_pref}</p>"
-      end
-
-      def term_defs_boilerplate(div, source, term, preface, isodoc)
-        return super unless @is_iev
-      end
-
-      def sts_converter(node)
-      end
-
-      def sections_names_cleanup(x)
-        super
-        @is_iev and replace_title(x, "//introduction", @i18n&.introduction_iev)
-      end
-
-      def note(n)
-        if n.title == "Note from TC/SC Officers"
-          noko do |xml|
-            xml.tc_sc_officers_note do |c|
-              wrap_in_para(n, c)
-            end
-          end.join("\n")
-        else
-          super
-        end
-      end
-
-      def note_cleanup(xmldoc)
-        super
-        n = xmldoc.at("//tc-sc-officers-note") and xmldoc.at("//bibdata/ext").add_child(n.remove)
-      end
-
-      def image_name_validate(xmldoc)
-      end
-    end
-  end
-end