metanorma-standoc 1.0.7 → 1.0.8

data/lib/asciidoctor/standoc/utils.rb

@@ -5,7 +5,7 @@ require "json"
 require "pathname"
 require "open-uri"
 require "uuidtools"
-require "pp"
+require "sterile"
 
 module Asciidoctor
   module Standoc
@@ -32,6 +32,18 @@ module Asciidoctor
           "??"
         end
 
+        def smart_render_xml(x)
+          xstr = x.to_xml if x.respond_to? :to_xml
+          xml = Nokogiri::XML(xstr)
+          xml.traverse do |n|
+            next unless n.text?
+            n.replace(n.text.gsub(/ -- /, " — ").
+                      gsub(/--/, "—").gsub(/\.\.\./, "…").
+                      smart_format)
+          end
+          xml.to_xml.sub(/<\?[^>]+>/, "")
+        end
+
         def warning(node, msg, text)
           return if @novalid
           warntext = "asciidoctor: WARNING"\

data/lib/metanorma/standoc/processor.rb

@@ -21,8 +21,8 @@ module Metanorma
         "Metanorma::Standoc #{Metanorma::Standoc::VERSION}/IsoDoc #{IsoDoc::VERSION}"
       end
 
-      def input_to_isodoc(file)
-        Metanorma::Input::Asciidoc.new.process(file, @asciidoctor_backend)
+      def input_to_isodoc(file, filename)
+        Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
       end
 
       def output(isodoc_node, outname, format, options={})

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-    VERSION = "1.0.7".freeze
+    VERSION = "1.0.8".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 0.9.0"
   spec.add_dependency "iev", "~> 0.2.0"
-  spec.add_dependency "relaton", "~> 0.2.2"
+  spec.add_dependency "relaton", "~> 0.3.0"
+  spec.add_dependency "sterile"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "byebug"
@@ -43,7 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "metanorma", "~> 0.2.6"
-  spec.add_development_dependency "isobib", "~> 0.3.0"
-  spec.add_development_dependency "ietfbib", "~> 0.4.0"
-  spec.add_development_dependency "iecbib", "~> 0.1.1"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

data/spec/asciidoctor-standoc/base_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require "fileutils"
 
 RSpec.describe Asciidoctor::Standoc do
   it "has a version number" do
@@ -16,7 +17,7 @@ RSpec.describe Asciidoctor::Standoc do
   end
 
   it "converts a blank document" do
-    system "rm -f test.doc"
+    FileUtils.rm_f "test.doc"
     expect(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
       = Document title
       Author
@@ -119,11 +120,22 @@ RSpec.describe Asciidoctor::Standoc do
       :language: el
       :script: Grek
       :publisher: IEC,IETF,ISO
+      :uri: A
+      :xml-uri: B
+      :html-uri: C
+      :pdf-uri: D
+      :doc-uri: E
+      :relaton-uri: F
     INPUT
            <?xml version="1.0" encoding="UTF-8"?>
        <standard-document xmlns="http://riboseinc.com/isoxml">
        <bibdata type="article">
-
+         <source>A</source>
+         <source type="xml">B</source>
+         <source type="html">C</source>
+         <source type="pdf">D</source>
+         <source type="doc">E</source>
+         <source type="relaton">F</source>
          <docidentifier>
            <project-number part="1" subpart="1">ISO/IEC/IETF 1000</project-number>
          </docidentifier>
@@ -200,7 +212,7 @@ RSpec.describe Asciidoctor::Standoc do
   end
 
   it "reads scripts into blank HTML document" do
-    system "rm -f test.html"
+    FileUtils.rm_f "test.html"
     Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
       = Document title
       Author
@@ -213,7 +225,7 @@ RSpec.describe Asciidoctor::Standoc do
   end
 
   it "uses specified fonts and assets in HTML" do
-    system "rm -f test.html"
+    FileUtils.rm_f "test.html"
     Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
       = Document title
       Author
@@ -238,7 +250,7 @@ RSpec.describe Asciidoctor::Standoc do
   end
 
   it "uses specified fonts and assets in Word" do
-    system "rm -f test.doc"
+    FileUtils.rm_f "test.doc"
     Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
       = Document title
       Author

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -1,5 +1,6 @@
 require "spec_helper"
 require "iecbib"
+require "fileutils"
 
 RSpec.describe Asciidoctor::Standoc do
   it "removes empty text elements" do
@@ -806,132 +807,169 @@ r = 1 %</stem>
   end
 
   it "separates IEV citations by top-level clause" do
-    system "mv ~/.iev.pstore ~/.iev.pstore1"
-    system "rm test.iev.pstore"
-    system "mv ~/.relaton-bib.pstore ~/.relaton-bib.pstore1"
-    system "rm test.relaton.pstore"
-    mock_iecbib_get_iec60050_102_01
-    mock_iecbib_get_iec60050_103_01
-    mock_iev
+    FileUtils.rm_rf File.expand_path("~/.relaton-bib.pstore1")
+    FileUtils.mv File.expand_path("~/.relaton-bib.pstore"), File.expand_path("~/.relaton-bib.pstore1"), force: true
+    FileUtils.rm_rf File.expand_path("~/.iev.pstore1")
+    FileUtils.mv File.expand_path("~/.iev.pstore"), File.expand_path("~/.iev.pstore1"), force: true
+    FileUtils.rm_rf "test.relaton.pstore"
+    FileUtils.rm_rf "test.iev.pstore"
+    # mock_iecbib_get_iec60050_102_01
+    # mock_iecbib_get_iec60050_103_01
+    # mock_iev
+    VCR.use_cassette "separates_iev_citations_by_top_level_clause" do
     expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
-    #{CACHED_ISOBIB_BLANK_HDR}
+      #{CACHED_ISOBIB_BLANK_HDR}
 
-    [bibliography]
-    == Normative References
-    * [[[iev,IEV]]], _iev_
-
-    == Terms and definitions
-    === Automation1
+      [bibliography]
+      == Normative References
+      * [[[iev,IEV]]], _iev_
 
-    [.source]
-    <<iev,clause="103-01-02">>
+      == Terms and definitions
+      === Automation1
 
-    === Automation2
+      [.source]
+      <<iev,clause="103-01-02">>
 
-    [.source]
-    <<iev,clause="102-01-02">>
+      === Automation2
 
-    === Automation3
+      [.source]
+      <<iev,clause="102-01-02">>
 
-    [.source]
-    <<iev,clause="103-01-02">>
-    INPUT
-        #{BLANK_HDR}
+      === Automation3
 
-        <sections>
-       <terms id="_" obligation="normative"><title>Terms and definitions</title><term id="_">
-         <preferred>Automation1</preferred>
-         <termsource status="identical">
-         <origin bibitemid="IEC60050-103" type="inline" citeas="IEC 60050-103:2009"><locality type="clause"><referenceFrom>103-01-02</referenceFrom></locality></origin>
-       </termsource>
-       </term>
-       <term id="_">
-         <preferred>Automation2</preferred>
-         <termsource status="identical">
-         <origin bibitemid="IEC60050-102" type="inline" citeas="IEC 60050-102:2007"><locality type="clause"><referenceFrom>102-01-02</referenceFrom></locality></origin>
-       </termsource>
-       </term>
-       <term id="_">
-         <preferred>Automation3</preferred>
-         <termsource status="identical">
-         <origin bibitemid="IEC60050-103" type="inline" citeas="IEC 60050-103:2009"><locality type="clause"><referenceFrom>103-01-02</referenceFrom></locality></origin>
-       </termsource>
-       </term></terms></sections><bibliography><references id="_" obligation="informative">
-         <title>Normative References</title>
-         <bibitem type="international-standard" id="IEC60050-102">
-         <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
-         <docidentifier>IEC 60050-102:2007</docidentifier>
-         <date type="published">
-           <on>2007</on>
-         </date>
-         <contributor>
-           <role type="publisher"/>
-           <organization>
-             <name>International Electrotechnical Commission</name>
-             <abbreviation>IEC</abbreviation>
-             <uri>www.iec.ch</uri>
-           </organization>
-         </contributor>
-         <language>en</language>
-         <language>fr</language>
-         <script>Latn</script>
-         <status>
-           <stage>60</stage>
-         </status>
-         <copyright>
-           <from>2018</from>
-           <owner>
-             <organization>
-               <name>International Electrotechnical Commission</name>
-               <abbreviation>IEC</abbreviation>
-               <uri>www.iec.ch</uri>
-             </organization>
-           </owner>
-         </copyright>
-       </bibitem><bibitem type="international-standard" id="IEC60050-103">
-         <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
-         <docidentifier>IEC 60050-103:2009</docidentifier>
-         <date type="published">
-           <on>2009</on>
-         </date>
-         <contributor>
-           <role type="publisher"/>
-           <organization>
-             <name>International Electrotechnical Commission</name>
-             <abbreviation>IEC</abbreviation>
-             <uri>www.iec.ch</uri>
-           </organization>
-         </contributor>
-         <language>en</language>
-         <language>fr</language>
-         <script>Latn</script>
-         <status>
-           <stage>60</stage>
-         </status>
-         <copyright>
-           <from>2018</from>
-           <owner>
-             <organization>
-               <name>International Electrotechnical Commission</name>
-               <abbreviation>IEC</abbreviation>
-               <uri>www.iec.ch</uri>
-             </organization>
-           </owner>
-         </copyright>
-       </bibitem>
-       </references></bibliography>
-       </standard-document>
+      [.source]
+      <<iev,clause="103-01-02">>
+      INPUT
+          #{BLANK_HDR}
+
+          <sections>
+        <terms id="_" obligation="normative"><title>Terms and definitions</title><term id="_">
+          <preferred>Automation1</preferred>
+          <termsource status="identical">
+          <origin bibitemid="IEC60050-103" type="inline" citeas="IEC 60050-103:2009"><locality type="clause"><referenceFrom>103-01-02</referenceFrom></locality></origin>
+        </termsource>
+        </term>
+        <term id="_">
+          <preferred>Automation2</preferred>
+          <termsource status="identical">
+          <origin bibitemid="IEC60050-102" type="inline" citeas="IEC 60050-102:2007"><locality type="clause"><referenceFrom>102-01-02</referenceFrom></locality></origin>
+        </termsource>
+        </term>
+        <term id="_">
+          <preferred>Automation3</preferred>
+          <termsource status="identical">
+          <origin bibitemid="IEC60050-103" type="inline" citeas="IEC 60050-103:2009"><locality type="clause"><referenceFrom>103-01-02</referenceFrom></locality></origin>
+        </termsource>
+        </term></terms></sections><bibliography><references id="_" obligation="informative">
+          <title>Normative References</title>
+          <bibitem type="international-standard" id="IEC60050-102">
+          <fetched>#{Date.today}</fetched>
+          <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary -- Part 102: Mathematics -- General concepts and linear algebra</title>
+          <uri type="src">https://webstore.iec.ch/publication/160</uri>
+          <uri type="obp">/preview/info_iec60050-102%7Bed1.0%7Db.pdf</uri>
+          <docidentifier type="IEC">IEC 60050-102:2007</docidentifier>
+          <date type="published">
+            <on>2007</on>
+          </date>
+          <contributor>
+            <role type="publisher"/>
+            <organization>
+              <name>International Electrotechnical Commission</name>
+              <abbreviation>IEC</abbreviation>
+              <uri>www.iec.ch</uri>
+            </organization>
+          </contributor>
+          <edition>1.0</edition>
+          <language>en</language>
+          <script>Latn</script>
+          <abstract format="plain" language="en" script="Latn">This part of IEC 60050 gives the general mathematical terminology used in the fields of electricity, electronics and telecommunications, together with basic concepts in linear algebra. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Another part will deal with functions. It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
+          <status>
+            <stage>60</stage>
+            <substage>60</substage>
+          </status>
+          <copyright>
+            <from>2007</from>
+            <owner>
+              <organization>
+              <name>International Electrotechnical Commission</name>
+              <abbreviation>IEC</abbreviation>
+              <uri>www.iec.ch</uri>
+              </organization>
+            </owner>
+          </copyright>
+          <editorialgroup>
+            <technical-committee number="1" type="technicalCommittee">TC 1 - Terminology</technical-committee>
+          </editorialgroup>
+          <ics>
+            <code>01.040.07</code>
+            <text>Natural and applied sciences (Vocabularies)</text>
+          </ics>
+          <ics>
+            <code>07.020</code>
+            <text>Mathematics</text>
+          </ics>
+        </bibitem><bibitem type="international-standard" id="IEC60050-103">
+          <fetched>#{Date.today}</fetched>
+          <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary -- Part 103: Mathematics -- Functions </title>
+          <uri type="src">https://webstore.iec.ch/publication/161</uri>
+          <uri type="obp">/preview/info_iec60050-103%7Bed1.0%7Db.pdf</uri>
+          <docidentifier type="IEC">IEC 60050-103:2009</docidentifier>
+          <date type="published">
+            <on>2009</on>
+          </date>
+          <contributor>
+            <role type="publisher"/>
+            <organization>
+            <name>International Electrotechnical Commission</name>
+<abbreviation>IEC</abbreviation>
+<uri>www.iec.ch</uri>
+            </organization>
+          </contributor>
+          <edition>1.0</edition>
+          <language>en</language>
+          <script>Latn</script>
+          <abstract format="plain" language="en" script="Latn">IEC 60050-103:2009 gives the terminology relative to functions of one or more variables. Together with IEC 60050-102, it covers the mathematical terminology used in the fields of electricity, electronics and telecommunications. It maintains a clear distinction between mathematical concepts and physical concepts, even if some terms are used in both cases. Mathematical symbols are generally in accordance with IEC 60027-1 and ISO 80000-2. This standard cancels and replaces Sections 101-13, 101-14 and 101-15 of International Standard IEC 60050-101:1998. It has the status of a horizontal standard in accordance with IEC Guide 108.</abstract>
+          <status>
+            <stage>60</stage>
+            <substage>60</substage>
+          </status>
+          <copyright>
+            <from>2009</from>
+            <owner>
+              <organization>
+              <name>International Electrotechnical Commission</name>
+<abbreviation>IEC</abbreviation>
+<uri>www.iec.ch</uri>
+              </organization>
+            </owner>
+          </copyright>
+          <editorialgroup>
+            <technical-committee number="1" type="technicalCommittee">TC 1 - Terminology</technical-committee>
+          </editorialgroup>
+          <ics>
+            <code>01.040.07</code>
+            <text>Natural and applied sciences (Vocabularies)</text>
+          </ics>
+          <ics>
+            <code>07.020</code>
+            <text>Mathematics</text>
+          </ics>
+        </bibitem>
+        </references></bibliography>
+        </standard-document>
   OUTPUT
-  system "mv ~/.iev.pstore1 ~/.iev.pstore"
-      system "rm ~/.relaton-bib.pstore"
-    system "mv ~/.relaton-bib.pstore1 ~/.relaton-bib.pstore"
+    end
+    FileUtils.rm_rf File.expand_path("~/.iev.pstore")
+    FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev.pstore"), force: true
+    FileUtils.rm_rf File.expand_path("~/.relaton-bib.pstore")
+    FileUtils.mv File.expand_path("~/.relaton-bib.pstore1"), File.expand_path("~/.relaton-bib.pstore"), force: true
   end
 
   private
 
     def mock_iecbib_get_iec60050_103_01
       expect(Iecbib::IecBibliography).to receive(:get).with("IEC 60050-103", nil, {keep_year: true}) do
-      IsoBibItem.from_xml(<<~"OUTPUT")
+      IsoBibItem::XMLParser.from_xml(<<~"OUTPUT")
       <bibitem type="international-standard" id="IEC60050-103">
          <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
          <docidentifier>IEC 60050-103:2009</docidentifier>
@@ -969,7 +1007,7 @@ end
 
     def mock_iecbib_get_iec60050_102_01
       expect(Iecbib::IecBibliography).to receive(:get).with("IEC 60050-102", nil, {keep_year: true}) do
-      IsoBibItem.from_xml(<<~"OUTPUT")
+      IsoBibItem::XMLParser.from_xml(<<~"OUTPUT")
       <bibitem type="international-standard" id="IEC60050-102">
          <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
          <docidentifier>IEC 60050-102:2007</docidentifier>
@@ -1007,7 +1045,7 @@ end
 
     def mock_iev
       expect(Iecbib::IecBibliography).to receive(:get).with("IEV", nil, {}) do
-      IsoBibItem.from_xml(<<~"OUTPUT")
+      IsoBibItem::XMLParser.from_xml(<<~"OUTPUT")
       <bibitem type="international-standard" id="IEC60050:2001">
          <title format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
          <docidentifier>IEC 60050:2011</docidentifier>

data/spec/asciidoctor-standoc/inline_spec.rb

@@ -147,13 +147,21 @@ RSpec.describe Asciidoctor::Standoc do
       expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
       Hello!footnote:[Footnote text]
+
+      == Title footnote:[Footnote text 2]
     INPUT
             #{BLANK_HDR}
-       <sections>
+              <preface><foreword obligation="informative">
+         <title>Foreword</title>
          <p id="_">Hello!<fn reference="1">
          <p id="_">Footnote text</p>
        </fn></p>
-       </sections>
+       </foreword></preface><sections>
+       <clause id="_" inline-header="false" obligation="normative">
+         <title>Title<fn reference="2">
+         <p id="_">Footnote text 2</p>
+       </fn></title>
+       </clause></sections>
        </standard-document>
     OUTPUT
   end