metanorma-iec 2.1.11 → 2.1.13

data/spec/metanorma/section_spec.rb

@@ -1,348 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Metanorma::Iec do
-  before(:all) do
-    @blank_hdr = blank_hdr_gen
-  end
-
-  it "processes sections" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-      .Foreword
-
-      Text
-
-      == Introduction
-
-      === Introduction Subsection
-
-      == Scope
-
-      Text
-
-      == Normative References
-
-      == Terms and Definitions
-
-      === Term1
-
-      == Terms, Definitions, Symbols and Abbreviated Terms
-
-      === Normal Terms
-
-      ==== Term2
-
-      === Symbols and Abbreviated Terms
-
-      == Symbols and Abbreviated Terms
-
-      == Clause 4
-
-      === Introduction
-
-      === Clause 4.2
-
-      == Terms and Definitions
-
-      [appendix]
-      == Annex
-
-      === Annex A.1
-
-      [%appendix]
-      === Appendix 1
-
-      == Bibliography
-
-      === Bibliography Subsection
-    INPUT
-    output = <<~OUTPUT
-                  #{@blank_hdr}
-             <preface><foreword id="_" obligation="informative">
-               <title>FOREWORD</title>
-               <p id="_">Text</p>
-             </foreword><introduction id="_" obligation="informative">
-      <title>INTRODUCTION</title><clause id="_" inline-header="false" obligation="informative">
-               <title>Introduction Subsection</title>
-             </clause>
-             </introduction></preface><sections>
-             <clause id="_" obligation="normative" type="scope" inline-header='false'>
-               <title>Scope</title>
-               <p id="_">Text</p>
-             </clause>
-
-             <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}
-               <term id="term-Term1">
-               <preferred><expression><name>Term1</name></expression></preferred>
-             </term>
-             </terms>
-             <clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><terms id="_" obligation="normative">
-               <title>Normal Terms</title>
-               <term id="term-Term2">
-               <preferred><expression><name>Term2</name></expression></preferred>
-             </term>
-             </terms>
-             <definitions id="_" obligation="normative"><title>Symbols and abbreviated terms</title></definitions></clause>
-             <definitions id="_" obligation="normative"><title>Symbols and abbreviated terms</title></definitions>
-             <clause id="_" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="_" inline-header="false" obligation="normative">
-               <title>Introduction</title>
-             </clause>
-             <clause id="_" inline-header="false" obligation="normative">
-               <title>Clause 4.2</title>
-             </clause></clause>
-             <clause id="_" inline-header="false" obligation="normative">
-                <title>Terms and Definitions</title>
-             </clause>
-
-
-             </sections><annex id="_" inline-header="false" obligation="normative">
-               <title>Annex</title>
-               <clause id="_" inline-header="false" obligation="normative">
-               <title>Annex A.1</title>
-             </clause>
-             <appendix id="_" inline-header="false" obligation="normative">
-                <title>Appendix 1</title>
-             </appendix></annex><bibliography><references id="_" obligation="informative" normative="true">
-               <title>Normative references</title><p id="_">There are no normative references in this document.</p>
-             </references><clause id="_" obligation="informative">
-               <title>Bibliography</title>
-               <references id="_" obligation="informative" normative="false">
-               <title>Bibliography Subsection</title>
-             </references>
-             </clause>
-             </bibliography>
-             </iec-standard>
-    OUTPUT
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes sections with title attributes" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-      .Foreword
-
-      Text
-
-      [heading=introduction]
-      == Εισαγωγή
-
-      === Introduction Subsection
-
-      [heading=scope]
-      == Σκοπός
-
-      Text
-
-      [heading=normative references]
-      == Κανονιστικές Παραπομπές
-
-      [heading=terms and definitions]
-      == Όροι και Ορισμοί
-
-      === Term1
-
-      [heading="terms, definitions, symbols and abbreviated terms"]
-      == Όροι, Ορισμοί, Σύμβολα και Συντομογραφίες
-
-      === Normal Terms
-
-      ==== Term2
-
-      [heading=symbols and abbreviated terms]
-      === Σύμβολα και Συντομογραφίες
-
-      [heading=symbols and abbreviated terms]
-      == Σύμβολα και Συντομογραφίες
-
-      == Clause 4
-
-      === Introduction
-
-      === Clause 4.2
-
-      [appendix]
-      == Annex
-
-      === Annex A.1
-
-      [%appendix]
-      === Appendx 1
-
-      [heading=bibliography]
-      == Βιβλιογραφία
-
-      === Bibliography Subsection
-    INPUT
-    output = <<~OUTPUT
-                  #{@blank_hdr}
-             <preface>
-             <foreword id="_" obligation="informative">
-               <title>FOREWORD</title>
-               <p id="_">Text</p>
-             </foreword>
-             <introduction id="_" obligation="informative">
-      <title>INTRODUCTION</title><clause id="_" inline-header="false" obligation="informative">
-               <title>Introduction Subsection</title>
-             </clause>
-             </introduction>
-             </preface>
-             <sections>
-             <clause id="_" obligation="normative" type="scope" inline-header='false'>
-               <title>Scope</title>
-               <p id="_">Text</p>
-             </clause>
-             <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}
-               <term id="term-Term1">
-               <preferred><expression><name>Term1</name></expression></preferred>
-             </term>
-             </terms>
-             <clause id='_' obligation='normative'>
-                   <title>Terms, definitions, symbols and abbreviated terms</title>
-                   <terms id='_' obligation='normative'>
-                     <title>Normal Terms</title>
-                     <term id='term-Term2'>
-                       <preferred><expression><name>Term2</name></expression></preferred>
-                     </term>
-                   </terms>
-                   <definitions id='_' obligation="normative">
-                     <title>Symbols and abbreviated terms</title>
-                   </definitions>
-                 </clause>
-                 <definitions id='_' obligation="normative">
-                   <title>Symbols and abbreviated terms</title>
-                 </definitions>
-                 <clause id='_' inline-header='false' obligation='normative'>
-                   <title>Clause 4</title>
-                   <clause id='_' inline-header='false' obligation='normative'>
-                     <title>Introduction</title>
-                   </clause>
-                   <clause id='_' inline-header='false' obligation='normative'>
-                     <title>Clause 4.2</title>
-                   </clause>
-                 </clause>
-               </sections>
-               <annex id='_' inline-header='false' obligation='normative'>
-                 <title>Annex</title>
-                 <clause id='_' inline-header='false' obligation='normative'>
-                   <title>Annex A.1</title>
-                 </clause>
-                 <appendix id='_' inline-header='false' obligation='normative'>
-                   <title>Appendx 1</title>
-                 </appendix>
-               </annex>
-               <bibliography>
-                 <references id='_' obligation='informative' normative="true">
-                   <title>Normative references</title>
-                   <p id="_">There are no normative references in this document.</p>
-                 </references>
-                 <clause id='_' obligation='informative'>
-                   <title>Bibliography</title>
-                   <references id='_' obligation='informative' normative="false">
-                     <title>Bibliography Subsection</title>
-                   </references>
-                 </clause>
-               </bibliography>
-             </iec-standard>
-    OUTPUT
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes section obligations" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-      [obligation=informative]
-      == Clause 1
-
-      === Clause 1a
-
-      [obligation=normative]
-      == Clause 2
-
-      [appendix,obligation=informative]
-      == Annex
-    INPUT
-    output = <<~OUTPUT
-            #{@blank_hdr}
-      <sections><clause id="_" inline-header="false" obligation="informative">
-        <title>Clause 1</title>
-        <clause id="_" inline-header="false" obligation="informative">
-        <title>Clause 1a</title>
-      </clause>
-      </clause>
-      <clause id="_" inline-header="false" obligation="normative">
-        <title>Clause 2</title>
-      </clause>
-      </sections><annex id="_" inline-header="false" obligation="informative">
-        <title>Annex</title>
-      </annex>
-      </iec-standard>
-    OUTPUT
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes inline headers" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-      == Clause 1
-
-      [%inline-header]
-      === Clause 1a
-
-      [appendix]
-      == Annex A
-
-      [%inline-header]
-      === Clause Aa
-    INPUT
-    output = <<~OUTPUT
-            #{@blank_hdr}
-      <sections><clause id="_" inline-header="false" obligation="normative">
-        <title>Clause 1</title>
-        <clause id="_" inline-header="true" obligation="normative">
-        <title>Clause 1a</title>
-      </clause>
-      </clause>
-      </sections><annex id="_" inline-header="false" obligation="normative">
-        <title>Annex A</title>
-        <clause id="_" inline-header="true" obligation="normative">
-        <title>Clause Aa</title>
-      </clause>
-      </annex>
-      </iec-standard>
-    OUTPUT
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
-  it "processes blank headers" do
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-      == Clause 1
-
-      === {blank}
-
-    INPUT
-    output = <<~OUTPUT
-            #{@blank_hdr}
-      <sections>
-        <clause id="_" inline-header="false" obligation="normative">
-        <title>Clause 1</title>
-        <clause id="_" inline-header="false" obligation="normative">
-      </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/validate_spec.rb

@@ -1,56 +0,0 @@
-require "spec_helper"
-require "fileutils"
-
-RSpec.describe Metanorma::Iec do
-  context "when xref_error.adoc compilation" do
-    around do |example|
-      FileUtils.rm_f "spec/assets/xref_error.err"
-      example.run
-      Dir["spec/assets/xref_error*"].each do |file|
-        next if file.match?(/adoc$/)
-
-        FileUtils.rm_f(file)
-      end
-    end
-
-    it "generates error file" do
-      expect do
-        mock_pdf
-        Metanorma::Compile
-          .new
-          .compile("spec/assets/xref_error.adoc", type: "iec", no_install_fonts: true)
-      end.to(change { File.exist?("spec/assets/xref_error.err") }
-              .from(false).to(true))
-    end
-  end
-
-  it "Warns of illegal doctype" do
-    FileUtils.rm_f "test.err"
-    Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)
-      = Document title
-      Author
-      :docfile: test.adoc
-      :nodoc:
-      :no-isobib:
-      :doctype: pizza
-
-      text
-    INPUT
-    expect(File.read("test.err")).to include "pizza is not a recognised document type"
-  end
-
-  it "Warns of illegal function" do
-    FileUtils.rm_f "test.err"
-    Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)
-      = Document title
-      Author
-      :docfile: test.adoc
-      :nodoc:
-      :no-isobib:
-      :function: pizza
-
-      text
-    INPUT
-    expect(File.read("test.err")).to include "pizza is not a recognised document function"
-  end
-end

data/spec/spec_helper.rb

@@ -1,305 +0,0 @@
-require "simplecov"
-SimpleCov.start do
-  add_filter "/spec/"
-end
-
-require "bundler/setup"
-require "asciidoctor"
-require "metanorma-iec"
-require "rspec/matchers"
-require "equivalent-xml"
-require "metanorma"
-require "metanorma/iec"
-require "iev"
-require "rexml/document"
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end
-
-def metadata(xml)
-  xml.sort.to_h.delete_if do |_k, v|
-    v.nil? || (v.respond_to?(:empty?) && v.empty?)
-  end
-end
-
-def strip_guid(xml)
-  xml.gsub(%r{ id="_[^"]+"}, ' id="_"').gsub(%r{ target="_[^"]+"},
-                                             ' target="_"')
-end
-
-def xmlpp(xml)
-  c = HTMLEntities.new
-  xml &&= xml.split(/(&\S+?;)/).map do |n|
-    if /^&\S+?;$/.match?(n)
-      c.encode(c.decode(n), :hexadecimal)
-    else n
-    end
-  end.join
-  s = ""
-  f = REXML::Formatters::Pretty.new(2)
-  f.compact = true
-  f.write(REXML::Document.new(xml), s)
-  s
-end
-
-OPTIONS = [backend: :iec, header_footer: true, agree_to_terms: true].freeze
-
-ASCIIDOC_BLANK_HDR = <<~"HDR".freeze
-  = Document title
-  Author
-  :docfile: test.adoc
-  :nodoc:
-  :novalid:
-  :no-isobib:
-
-HDR
-
-ISOBIB_BLANK_HDR = <<~"HDR".freeze
-  = Document title
-  Author
-  :docfile: test.adoc
-  :nodoc:
-  :novalid:
-  :no-isobib-cache:
-
-HDR
-
-FLUSH_CACHE_ISOBIB_BLANK_HDR = <<~"HDR".freeze
-  = Document title
-  Author
-  :docfile: test.adoc
-  :nodoc:
-  :novalid:
-  :flush-caches:
-
-HDR
-
-CACHED_ISOBIB_BLANK_HDR = <<~"HDR".freeze
-  = Document title
-  Author
-  :docfile: test.adoc
-  :nodoc:
-  :novalid:
-
-HDR
-
-LOCAL_CACHED_ISOBIB_BLANK_HDR = <<~"HDR".freeze
-  = Document title
-  Author
-  :docfile: test.adoc
-  :nodoc:
-  :novalid:
-  :local-cache:
-
-HDR
-
-VALIDATING_BLANK_HDR = <<~"HDR".freeze
-  = Document title
-  Author
-  :docfile: test.adoc
-  :nodoc:
-  :no-isobib:
-
-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>
-BOILERPLATE
-
-def boilerplate(xmldoc)
-  file = File.read(
-    File.join(File.dirname(__FILE__), "..", "lib", "metanorma", "iec",
-              "iec_intro_en.xml"), encoding: "utf-8"
-  )
-  conv = Metanorma::Iec::Converter.new(nil, backend: :iec,
-                                              header_footer: true)
-  conv.init(Asciidoctor::Document.new([]))
-  ret = Nokogiri::XML(
-    conv.boilerplate_isodoc(xmldoc).populate_template(file, nil)
-    .gsub(/<p>/, "<p id='_'>")
-    .gsub(/<ol>/, "<ol id='_'>"),
-  )
-  conv.smartquotes_cleanup(ret)
-  HTMLEntities.new.decode(ret.to_xml)
-end
-
-BLANK_HDR = <<~"HDR".freeze
-  <?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">
-    <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>standard</doctype>
-    <editorialgroup>
-      <agency>IEC</agency>
-    </editorialgroup>
-    <stagename>International standard</stagename>
-    </ext>
-  </bibdata>
-HDR
-
-def blank_hdr_gen
-  <<~"HDR"
-    #{BLANK_HDR}
-    #{boilerplate(Nokogiri::XML("#{BLANK_HDR}</iec-standard>"))}
-  HDR
-end
-
-IEC_TITLE = <<~TITLE.freeze
-  <p class="zzSTDTitle1">INTERNATIONAL ELECTROTECHNICAL COMMISSION</p>
-              <p class="zzSTDTitle1">____________</p>
-              <p class="zzSTDTitle1">&#160;</p>
-              <p class="zzSTDTitle1">
-                <b/>
-              </p>
-              <p class="zzSTDTitle1">&#160;</p>
-TITLE
-
-IEC_TITLE1 = <<~TITLE.freeze
-  <p class="zzSTDTitle1">
-    <b/>
-  </p>
-  <p class="zzSTDTitle1">&#160;</p>
-TITLE
-
-HTML_HDR = <<~HDR.freeze
-  <html xmlns:epub="http://www.idpf.org/2007/ops" lang="en">
-    <head/>
-    <body lang="en">
-      <div class="title-section">
-        <p>&#160;</p>
-      </div>
-      <br/>
-      <div class="prefatory-section">
-        <p>&#160;</p>
-      </div>
-      <br/>
-      <div class="main-section">
-       <br/>
-       #{IEC_TITLE}
-HDR
-
-WORD_HDR = <<~HDR.freeze
-  <html xmlns:epub="http://www.idpf.org/2007/ops">
-     <head>
-       <title>test</title>
-     </head>
-    <body lang="EN-US" link="blue" vlink="#954F72">
-      <div class="WordSection1">
-        <p>&#160;</p>
-      </div>
-      <p><br clear="all" class="section"/></p>
-      <div class="WordSection2">
-        <p>&#160;</p>
-      </div>
-      <p><br clear="all" class="section"/></p>
-      <div class="WordSection3">
-HDR
-
-def stub_fetch_ref(**opts)
-  xml = ""
-
-  hit = double("hit")
-  expect(hit).to receive(:[]).with("title") do
-    Nokogiri::XML(xml).at("//docidentifier").content
-  end.at_least(:once)
-
-  hit_instance = double("hit_instance")
-  expect(hit_instance).to receive(:hit).and_return(hit).at_least(:once)
-  expect(hit_instance).to receive(:to_xml) do |builder, opt|
-    expect(builder).to be_instance_of Nokogiri::XML::Builder
-    expect(opt).to eq opts
-    builder << xml
-  end.at_least :once
-
-  hit_page = double("hit_page")
-  expect(hit_page).to receive(:first).and_return(hit_instance).at_least :once
-
-  hit_pages = double("hit_pages")
-  expect(hit_pages).to receive(:first).and_return(hit_page).at_least :once
-
-  expect(Isobib::IsoBibliography).to receive(:search)
-    .and_wrap_original do |search, *args|
-    code = args[0]
-    expect(code).to be_instance_of String
-    xml = get_xml(search, code, opts)
-    hit_pages
-  end.at_least :once
-end
-
-def mock_pdf
-  allow(::Mn2pdf).to receive(:convert) do |url, output, _c, _d|
-    FileUtils.cp(url.gsub(/"/, ""), output.gsub(/"/, ""))
-  end
-end
-
-private
-
-def get_xml(search, code, opts)
-  c = code.gsub(%r{[/\s:-]}, "_").sub(%r{_+$}, "").downcase
-  o = opts.keys.join "_"
-  file = "spec/examples/#{[c, o].join '_'}.xml"
-  if File.exist? file
-    File.read file
-  else
-    result = search.call(code)
-    hit = result&.first&.first
-    xml = hit.to_xml nil, opts
-    File.write file, xml
-    xml
-  end
-end
-
-def mock_open_uri(code)
-  # expect(OpenURI).to receive(:open_uri).and_wrap_original do |m, *args|
-  expect(Iev).to receive(:get).with(code, "en") do |m, *args|
-    file = "spec/examples/#{code.tr('-', '_')}.html"
-    File.write file, m.call(*args).read unless File.exist? file
-    File.read file
-  end.at_least :once
-end