metanorma-standoc 1.10.4 → 1.10.4.1

data/lib/isodoc/pdf_convert.rb

@@ -0,0 +1,20 @@
+require "isodoc"
+
+module IsoDoc
+  module Standoc
+
+    # 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 pdf_stylesheet(docxml)
+          "base.standard.xsl"
+      end
+    end
+  end
+end

data/lib/metanorma-standoc.rb

@@ -1,4 +1,5 @@
 require "asciidoctor" unless defined? Asciidoctor::Converter
+require_relative "isodoc/pdf_convert"
 require_relative "asciidoctor/standoc/converter"
 require_relative "metanorma/standoc/version"
 require "asciidoctor/extensions"

data/lib/metanorma/standoc/processor.rb

@@ -13,6 +13,7 @@ module Metanorma
         super.merge(
           html: "html",
           doc: "doc",
+          pdf: "pdf",
         )
       end
 
@@ -29,12 +30,15 @@ module Metanorma
         when :html
           options = options
             .merge(htmlstylesheet: html_path("htmlstyle.scss"),
-                  htmlcoverpage: html_path("html_titlepage.html"))
+                   htmlcoverpage: html_path("html_titlepage.html"))
           IsoDoc::HtmlConvert.new(options)
             .convert(inname, isodoc_node, nil, outname)
         when :doc
           IsoDoc::WordConvert.new(options)
             .convert(inname, isodoc_node, nil, outname)
+        when :pdf
+          IsoDoc::Standoc::PdfConvert.new(options)
+            .convert(inname, isodoc_node, nil, outname)
         when :presentation
           IsoDoc::PresentationXMLConvert.new(options)
             .convert(inname, isodoc_node, nil, outname)

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.10.4".freeze
+    VERSION = "1.10.4.1".freeze
   end
 end

data/spec/asciidoctor/base_spec.rb

@@ -35,6 +35,7 @@ RSpec.describe Asciidoctor::Standoc do
     expect(xmlpp(Asciidoctor.convert(input, *OPTIONS)))
       .to be_equivalent_to xmlpp(output)
     expect(File.exist?("test.doc")).to be true
+    expect(File.exist?("test.pdf")).to be true
     expect(File.exist?("htmlstyle.css")).to be false
   end
 
@@ -45,6 +46,7 @@ RSpec.describe Asciidoctor::Standoc do
       Author
       :docfile: test.adoc
       :novalid:
+      :no-pdf:
       :language: ar
     INPUT
     output = <<~OUTPUT
@@ -887,6 +889,7 @@ RSpec.describe Asciidoctor::Standoc do
       Author
       :docfile: test.adoc
       :novalid:
+      :no-pdf:
       :scripts: spec/assets/scripts.html
     INPUT
     html = File.read("test.html", encoding: "utf-8")
@@ -899,6 +902,7 @@ RSpec.describe Asciidoctor::Standoc do
       = Document title
       Author
       :docfile: test.adoc
+      :no-pdf:
       :novalid:
       :script: Hans
       :body-font: Zapf Chancery
@@ -934,6 +938,7 @@ RSpec.describe Asciidoctor::Standoc do
       Author
       :docfile: test.adoc
       :novalid:
+      :no-pdf:
       :script: Hans
       :body-font: Zapf Chancery
       :header-font: Comic Sans
@@ -974,6 +979,7 @@ QU1FOiB0ZXN0Cgo=
     Asciidoctor.convert(<<~"INPUT", *OPTIONS)
       = Document title
       Author
+      :no-pdf:
       :docfile: test.adoc
       :doctype: standard
       :encoding: utf-8

data/spec/asciidoctor/cleanup_sections_spec.rb

@@ -1357,7 +1357,7 @@ RSpec.describe Asciidoctor::Standoc do
 
   it "processes section names, internationalisation file" do
     input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR.sub(/:nodoc:/, ':i18nyaml: spec/assets/i18n.yaml')}
+      #{ASCIIDOC_BLANK_HDR.sub(/:nodoc:/, ":no-pdf:\n:i18nyaml: spec/assets/i18n.yaml")}
       .Foreword
 
       Text

data/spec/asciidoctor/cleanup_spec.rb

@@ -331,36 +331,36 @@ RSpec.describe Asciidoctor::Standoc do
       ....
     INPUT
     output = <<~OUTPUT
-      #{BLANK_HDR}
-             <sections>
-                        <p id='_'>
-           &#8220;ppt&#8221;,
-           <index>
-             <primary>ppt</primary>
-           </index>
-         </p>
-         <p id='_'>
-           &#8220;ppm&#8221;,
-           <index>
-             <primary>ppm</primary>
-           </index>
-            &#8220;ppt&#8221;
-           <index>
-             <primary>ppt</primary>
-           </index>
-         </p>
-         <p id='_'>
-  &#8220;ppm
-  <index>
-    <primary>ppm</primary>
-  </index>
-  &#8220;&#160;
-</p>
-<figure id='_'>
-  <pre id='_'>((ppm))",</pre>
-</figure>
-      </sections>
-      </standard-document>
+            #{BLANK_HDR}
+                   <sections>
+                              <p id='_'>
+                 &#8220;ppt&#8221;,
+                 <index>
+                   <primary>ppt</primary>
+                 </index>
+               </p>
+               <p id='_'>
+                 &#8220;ppm&#8221;,
+                 <index>
+                   <primary>ppm</primary>
+                 </index>
+                  &#8220;ppt&#8221;
+                 <index>
+                   <primary>ppt</primary>
+                 </index>
+               </p>
+               <p id='_'>
+        &#8220;ppm
+        <index>
+          <primary>ppm</primary>
+        </index>
+        &#8220;&#160;
+      </p>
+      <figure id='_'>
+        <pre id='_'>((ppm))",</pre>
+      </figure>
+            </sections>
+            </standard-document>
     OUTPUT
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
@@ -2100,6 +2100,90 @@ RSpec.describe Asciidoctor::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "moves metadata deflist to correct location" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause
+
+      [.requirement,subsequence="A",inherit="/ss/584/2015/level/1 &amp; /ss/584/2015/level/2"]
+      ====
+      [%metadata]
+      model:: ogc
+      type:: class
+      label:: http://www.opengis.net/spec/waterml/2.0/req/xsd-xml-rules[*req/core*]
+      subject:: Encoding of logical models
+      inherit:: urn:iso:dis:iso:19156:clause:7.2.2
+      inherit:: urn:iso:dis:iso:19156:clause:8
+      inherit:: http://www.opengis.net/doc/IS/GML/3.2/clause/2.4
+      inherit:: O&M Abstract model, OGC 10-004r3, clause D.3.4
+      inherit:: http://www.opengis.net/spec/SWE/2.0/req/core/core-concepts-used
+      inherit:: <<ref2>>
+      inherit:: <<ref3>>
+      classification:: priority:P0
+      classification:: domain:Hydrology,Groundwater
+      classification:: control-class:Technical
+      obligation:: recommendation,requirement
+
+      I recommend this
+      ====
+    INPUT
+    output = <<~OUTPUT
+            #{BLANK_HDR}
+            <sections>
+        <clause id='_' inline-header='false' obligation='normative'>
+          <title>Clause</title>
+          <requirement id='_' subsequence='A'>
+            <label>
+              <link target='http://www.opengis.net/spec/waterml/2.0/req/xsd-xml-rules'>
+                <strong>req/core</strong>
+              </link>
+            </label>
+            <subject>Encoding of logical models</subject>
+            <inherit>/ss/584/2015/level/1 &amp; /ss/584/2015/level/2</inherit>
+            <inherit>urn:iso:dis:iso:19156:clause:7.2.2</inherit>
+            <inherit>urn:iso:dis:iso:19156:clause:8</inherit>
+            <inherit>
+              <link target='http://www.opengis.net/doc/IS/GML/3.2/clause/2.4'/>
+            </inherit>
+            <inherit>O&amp;M Abstract model, OGC 10-004r3, clause D.3.4</inherit>
+            <inherit>
+              <link target='http://www.opengis.net/spec/SWE/2.0/req/core/core-concepts-used'/>
+            </inherit>
+            <inherit>
+              <xref target='ref2'/>
+            </inherit>
+            <inherit>
+              <xref target='ref3'/>
+            </inherit>
+            <classification>
+              <tag>control-class</tag>
+              <value>Technical</value>
+            </classification>
+            <classification>
+              <tag>domain</tag>
+              <value>Groundwater</value>
+            </classification>
+            <classification>
+              <tag>domain</tag>
+              <value>Hydrology</value>
+            </classification>
+            <classification>
+              <tag>priority</tag>
+              <value>P0</value>
+            </classification>
+            <description>
+              <p id='_'>I recommend this</p>
+            </description>
+          </requirement>
+        </clause>
+      </sections>
+            </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "moves inherit macros to correct location" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/asciidoctor/validate_spec.rb

@@ -22,6 +22,7 @@ RSpec.describe Asciidoctor::Standoc do
         Author
         :docfile: test.adoc
         :nodoc:
+        :no-pdf:
 
         [[abc]]
         == Clause 1
@@ -258,6 +259,7 @@ RSpec.describe Asciidoctor::Standoc do
       = Document title
       Author
       :docfile: test.adoc
+      :no-pdf:
 
       [bibliography]
       == Normative References
@@ -285,6 +287,7 @@ RSpec.describe Asciidoctor::Standoc do
       = Document title
       Author
       :docfile: test.adoc
+      :no-pdf:
 
       [bibliography]
       == Normative References
@@ -443,6 +446,7 @@ RSpec.describe Asciidoctor::Standoc do
       = Document title
       Author
       :docfile: test.adoc
+      :no-pdf:
 
       footnoteblock:[id1]
 

data/spec/examples/datamodel/address_class_profile.adoc

@@ -1,4 +1,5 @@
 = Document title
 Author
+:no-pdf:
 
 [datamodel_attributes_table,models/models/AddressClassProfile.yml]

data/spec/examples/datamodel/address_component_profile.adoc

@@ -1,4 +1,5 @@
 = Document title
 Author
+:no-pdf:
 
 [datamodel_attributes_table,models/models/AddressComponentProfile.yml]

data/spec/examples/datamodel/blank_definition_profile.adoc

@@ -1,4 +1,5 @@
 = Document title
 Author
+:no-pdf:
 
 [datamodel_attributes_table,models/models/SignatureBlankDefinition.yml]

data/spec/examples/datamodel/common_models_diagram.adoc

@@ -1,4 +1,5 @@
 = Document title
 Author
+:no-pdf:
 
-[datamodel_diagram,models/views/CommonModels.yml]
+[datamodel_diagram,models/views/CommonModels.yml]

data/spec/examples/datamodel/top_down_diagram.adoc

@@ -1,4 +1,5 @@
 = Document title
 Author
+:no-pdf:
 
-[datamodel_diagram,models/views/TopDown.yml]
+[datamodel_diagram,models/views/TopDown.yml]

data/spec/metanorma/processor_spec.rb

@@ -3,7 +3,6 @@ require "metanorma"
 require "fileutils"
 
 RSpec.describe Metanorma::Standoc::Processor do
-
   registry = Metanorma::Registry.instance
   registry.register(Metanorma::Standoc::Processor)
   processor = registry.find_processor(:standoc)
@@ -14,7 +13,7 @@ RSpec.describe Metanorma::Standoc::Processor do
 
   it "registers output formats against metanorma" do
     expect(processor.output_formats.sort.to_s).to be_equivalent_to <<~"OUTPUT"
-    [[:doc, "doc"], [:html, "html"], [:presentation, "presentation.xml"], [:rxl, "rxl"], [:xml, "xml"]]
+      [[:doc, "doc"], [:html, "html"], [:pdf, "pdf"], [:presentation, "presentation.xml"], [:rxl, "rxl"], [:xml, "xml"]]
     OUTPUT
   end
 
@@ -25,68 +24,69 @@ RSpec.describe Metanorma::Standoc::Processor do
 
   it "generates IsoDoc XML from a blank document" do
     expect(processor.input_to_isodoc(<<~"INPUT", "test")).to be_equivalent_to <<~"OUTPUT"
-    #{ASCIIDOC_BLANK_HDR}
+      #{ASCIIDOC_BLANK_HDR}
     INPUT
-    #{BLANK_HDR}
-<sections/>
-</iso-standard>
+          #{BLANK_HDR}
+      <sections/>
+      </iso-standard>
     OUTPUT
   end
 
   it "generates HTML from IsoDoc XML" do
     FileUtils.rm_f "test.html"
     processor.output(<<~"INPUT", "test.xml", "test.html", :html)
-               <iso-standard xmlns="http://riboseinc.com/isoxml">
-       <sections>
-       <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
-         <term id="J">
-         <preferred>Term2</preferred>
-       </term>
-        </terms>
-        </sections>
-        </iso-standard>
+              <iso-standard xmlns="http://riboseinc.com/isoxml">
+      <sections>
+      <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
+        <term id="J">
+        <preferred>Term2</preferred>
+      </term>
+       </terms>
+       </sections>
+       </iso-standard>
     INPUT
-    expect(File.read("test.html", encoding: "utf-8").gsub(%r{^.*<main}m, "<main").gsub(%r{</main>.*}m, "</main>")).to be_equivalent_to <<~"OUTPUT"
-           <main class="main-section"><button onclick="topFunction()" id="myBtn" title="Go to top">Top</button>
-             <p class="zzSTDTitle1"></p>
-             <div id="H"><h1>Terms, Definitions, Symbols and Abbreviated Terms</h1><h2 class="TermNum" id="J"></h2>
-         <p class="Terms" style="text-align:left;">Term2</p>
-       </div>
-           </main>
-    OUTPUT
+    expect(File.read("test.html", encoding: "utf-8").gsub(%r{^.*<main}m, "<main").gsub(
+             %r{</main>.*}m, "</main>"
+           )).to be_equivalent_to <<~"OUTPUT"
+                 <main class="main-section"><button onclick="topFunction()" id="myBtn" title="Go to top">Top</button>
+                   <p class="zzSTDTitle1"></p>
+                   <div id="H"><h1>Terms, Definitions, Symbols and Abbreviated Terms</h1><h2 class="TermNum" id="J"></h2>
+               <p class="Terms" style="text-align:left;">Term2</p>
+             </div>
+                 </main>
+           OUTPUT
   end
 
-    it "generates HTML from IsoDoc XML" do
+  it "generates HTML from IsoDoc XML" do
     FileUtils.rm_f "test.doc"
     processor.output(<<~"INPUT", "test.xml", "test.doc", :doc)
-               <iso-standard xmlns="http://riboseinc.com/isoxml">
-       <sections>
-       <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
-         <term id="J">
-         <preferred>Term2</preferred>
-       </term>
-        </terms>
-        </sections>
-        </iso-standard>
+              <iso-standard xmlns="http://riboseinc.com/isoxml">
+      <sections>
+      <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
+        <term id="J">
+        <preferred>Term2</preferred>
+      </term>
+       </terms>
+       </sections>
+       </iso-standard>
     INPUT
-    expect(File.read("test.doc", encoding: "utf-8")).to match(/Terms, Definitions, Symbols and Abbreviated Terms/)
-    end
+    expect(File.read("test.doc",
+                     encoding: "utf-8")).to match(/Terms, Definitions, Symbols and Abbreviated Terms/)
+  end
 
-    it "generates XML from IsoDoc XML" do
+  it "generates XML from IsoDoc XML" do
     FileUtils.rm_f "test.xml"
     processor.output(<<~"INPUT", "test.xml", "test.xml", :xml)
-               <iso-standard xmlns="http://riboseinc.com/isoxml">
-       <sections>
-       <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
-         <term id="J">
-         <preferred>Term2</preferred>
-       </term>
-        </terms>
-        </sections>
-        </iso-standard>
-      INPUT
-        expect(File.exist?("test.xml")).to be true
-
-    end
-
+              <iso-standard xmlns="http://riboseinc.com/isoxml">
+      <sections>
+      <terms id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title>
+        <term id="J">
+        <preferred>Term2</preferred>
+      </term>
+       </terms>
+       </sections>
+       </iso-standard>
+    INPUT
+    expect(File.exist?("test.xml")).to be true
+  end
 end