metanorma-ogc 1.0.3 → 1.0.8

data/lib/isodoc/ogc/pdf_convert.rb

@@ -1,96 +1,37 @@
 require_relative "base_convert"
-require "fileutils"
 require "isodoc"
-require_relative "metadata"
 
 module IsoDoc
   module Ogc
     # A {Converter} implementation that generates PDF HTML output, and a
     # document schema encapsulation of the document for validation
-    class PdfConvert < IsoDoc::PdfConvert
+    class PdfConvert < IsoDoc::XslfoPdfConvert
       def initialize(options)
         @libdir = File.dirname(__FILE__)
         super
-        #FileUtils.cp html_doc_path('logo.jpg'), "logo.jpg"
-        #@files_to_delete << "logo.jpg"
       end
 
-      def default_fonts(options)
-        {
-          bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Overpass",sans-serif'),
-          headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Overpass",sans-serif'),
-          monospacefont: '"Space Mono",monospace'
-        }
+      def pdf_stylesheet(docxml)
+        doctype = docxml&.at(ns("//bibdata/ext/doctype"))&.text
+        doctype = "other" unless %w(abstract-specification-topic best-practice
+        change-request-supporting-document community-practice community-standard 
+        discussion-paper engineering-report policy reference-model release-notes 
+        standard user-guide test-suite white-paper).include? doctype
+        "ogc.#{doctype}.xsl"
       end
 
-      def default_file_locations(_options)
-        {
-          htmlstylesheet: html_doc_path("htmlstyle.scss"),
-          htmlcoverpage: html_doc_path("html_ogc_titlepage.html"),
-          htmlintropage: html_doc_path("html_ogc_intro.html"),
-          scripts_pdf: html_doc_path("scripts.pdf.html"),
-        }
-      end
-
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      end
-
-      def googlefonts
-        <<~HEAD.freeze
-    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet" />
-    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet" />
-    <link href="https://fonts.googleapis.com/css?family=Teko:300,400,500" rel="stylesheet">
-        HEAD
-      end
-
-      def admonition_class(node)
-        case node["type"]
-        when "important" then "Admonition.Important"
-        when "warning" then "Admonition.Warning"
-        else
-          "Admonition"
+      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, pdf_stylesheet(docxml)))
       end
-
-      def make_body(xml, docxml)
-        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
-        xml.body **body_attr do |body|
-          make_body1(body, docxml)
-          make_body2(body, docxml)
-          make_body3(body, docxml)
-        end
-      end
-
-      def html_toc(docxml)
-        docxml
-      end
-
-      def make_body3(body, docxml)
-        body.div **{ class: "main-section" } do |div3|
-          @prefacenum = 0
-          boilerplate docxml, div3
-          abstract docxml, div3
-          keywords docxml, div3
-          foreword docxml, div3
-          introduction docxml, div3
-          submittingorgs docxml, div3
-          submitters docxml, div3
-          preface docxml, div3
-          acknowledgements docxml, div3
-          middle docxml, div3
-          footnotes div3
-          comments div3
-        end
-      end
-
-       def authority_cleanup(docxml)
-        authority_cleanup1(docxml, "contact")
-        super
-      end
-
-      include BaseConvert
     end
   end
 end
-

data/lib/isodoc/ogc/reqt.rb

@@ -1,38 +1,49 @@
 require "isodoc"
-require_relative "metadata"
-require "fileutils"
+require_relative "reqt_xref"
 
 module IsoDoc
   module Ogc
     module BaseConvert
       def recommend_class(node)
         return "recommendtest" if node["type"] == "verification"
+        return "recommendtest" if node["type"] == "abstracttest"
         return "recommendclass" if node["type"] == "class"
+        return "recommendclass" if node["type"] == "conformanceclass"
         "recommend"
       end
 
       def recommend_table_attr(node)
-        attr_code(id: node["id"], 
-                  class: recommend_class(node),
+        attr_code(id: node["id"], class: recommend_class(node),
                   style: "border-collapse:collapse;border-spacing:0;")
       end
 
       REQ_TBL_ATTR =
         { style: "vertical-align:top;", class: "recommend" }.freeze
 
+      def recommendation_class(node)
+        %w(verification abstracttest).include?(node["type"]) ?
+                  "RecommendationTestTitle" : "RecommendationTitle"
+      end
+
       def recommendation_name(node, out, type)
         label, title, lbl = recommendation_labels(node)
-        out.p **{ class: node["type"] == "verification" ?
-                  "RecommendationTestTitle" : "RecommendationTitle" }  do |b|
-          lbl = anchor(node['id'], :label, false)
-          b << (lbl.nil? ? l10n("#{type}:") : l10n("#{type} #{lbl}:"))
-          if title
-            b << " "
-            title.children.each { |n| parse(n,b) }
+        out.p **{ class: recommendation_class(node) } do |b|
+          if inject_crossreference_reqt?(node, label)
+            lbl = anchor(@reqtlabels[label.text], :xref, false)
+            b << (lbl.nil? ? l10n("#{type}:") : l10n("#{lbl}:"))
+          else
+            b << (lbl.nil? ? l10n("#{type}:") : l10n("#{type} #{lbl}:"))
           end
+          recommendation_name1(title, node, label, b)
         end
       end
 
+      def recommendation_name1(title, node, label, b)
+        return unless  title && !inject_crossreference_reqt?(node, label)
+        b << " "
+        title.children.each { |n| parse(n,b) }
+      end
+
       def recommend_title(node, out)
         label = node.at(ns("./label")) or return
         out.tr do |tr|
@@ -44,27 +55,52 @@ module IsoDoc
         end
       end
 
+      # embedded reqts xref to top level reqts via label lookup
+      def inject_crossreference_reqt?(node, label)
+        !node.ancestors("requirement, recommendation, permission").empty? &&
+          @reqtlabels[label&.text]
+      end
+
       def recommendation_attributes1(node)
         out = []
         oblig = node["obligation"] and out << ["Obligation", oblig]
-        subj = node&.at(ns("./subject"))&.text and
-          out << [node["type"] == "class" ? "Target Type" : "Subject", subj]
-        node.xpath(ns("./inherit")).each { |i| out << ["Dependency", i.text] }
+        subj = node&.at(ns("./subject"))&.text and out << [rec_subj(node), subj]
+        node.xpath(ns("./inherit")).each do |i|
+          out << recommendation_attr_parse(i, "Dependency")
+        end
         node.xpath(ns("./classification")).each do |c|
-          tag = c.at(ns("./tag")) or next
-          value = c.at(ns("./value")) or next
-          out << [tag.text.capitalize, value.text]
+          line = recommendation_attr_keyvalue(c, "tag", "value") and out << line
         end
         out
       end
 
+      def rec_subj(node)
+        %w(class conformanceclass).include?(node["type"]) ?
+          "Target Type" : "Subject"
+      end
+
+      def recommendation_attr_parse(node, label)
+        text = noko do |xml|
+          node.children.each { |n| parse(n, xml) }
+        end.join
+        [label, text]
+      end
+
+      def recommendation_attr_keyvalue(node, key, value)
+        tag = node.at(ns("./#{key}")) or return nil
+        value = node.at(ns("./#{value}")) or return nil
+        [tag.text.capitalize, value.text]
+      end
+
       def recommendation_attributes(node, out)
-        ret = recommendation_attributes1(node)
-        return if ret.empty?
-        ret.each do |i|
+        recommendation_attributes1(node).each do |i|
           out.tr do |tr|
-            tr.td i[0], **REQ_TBL_ATTR
-            tr.td i[1], **REQ_TBL_ATTR
+            tr.td **REQ_TBL_ATTR do |td|
+              td << i[0]
+            end
+            tr.td **REQ_TBL_ATTR do |td|
+              td << i[1] 
+            end
           end
         end
       end
@@ -118,107 +154,31 @@ module IsoDoc
       end
 
       def recommendation_parse(node, out)
-        label = case node["type"]
-                when "verification" then @labels["recommendationtest"]
-                when "class" then @labels["recommendationclass"]
-                else
-                  @recommendation_lbl
-                end
-        recommendation_parse1(node, out, label)
+        recommendation_parse0(node, out, "recommendation")
       end
 
-      def requirement_parse(node, out)
-        label = case node["type"]
-                when "verification" then @labels["requirementtest"]
-                when "class" then @labels["requirementclass"]
-                else
-                  @requirement_lbl
-                end
-        recommendation_parse1(node, out, label)
-      end
-
-      def permission_parse(node, out)
+      def recommendation_parse0(node, out, r)
         label = case node["type"]
-                when "verification" then @labels["permissiontest"]
-                when "class" then @labels["permissionclass"]
-                else
-                  @permission_lbl
+                when "verification" then @labels["#{r}test"]
+                when "class" then @labels["#{r}class"]
+                when "abstracttest" then @labels["abstracttest"]
+                when "conformanceclass" then @labels["conformanceclass"]
+                else 
+                  case r
+                  when "recommendation" then @recommendation_lbl
+                  when "requirement" then @requirement_lbl
+                  when "permission" then @permission_lbl
+                  end
                 end
         recommendation_parse1(node, out, label)
       end
 
-      FIRST_LVL_REQ = IsoDoc::Function::XrefGen::FIRST_LVL_REQ
-
-      def sequential_permission_names(clause, klass, label)
-        c = ::IsoDoc::Function::XrefGen::Counter.new
-        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-          id = c.increment(t).print
-          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
-          sequential_permission_children(t, id)
-        end
-      end
-
-      def sequential_permission_children(t, id)
-        sequential_permission_names1(t, id, "permission[not(@type = 'verification' or @type = 'class')]", @permission_lbl)
-        sequential_permission_names1(t, id, "requirement[not(@type = 'verification' or @type = 'class')]", @requirement_lbl)
-        sequential_permission_names1(t, id, "recommendation[not(@type = 'verification' or @type = 'class')]", @recommendation_lbl)
-        sequential_permission_names1(t, id, "permission[@type = 'verification']", @labels["permissiontest"])
-        sequential_permission_names1(t, id, "requirement[@type = 'verification']", @labels["requirementtest"])
-        sequential_permission_names1(t, id, "recommendation[@type = 'verification']", @labels["recommendationtest"])
-        sequential_permission_names1(t, id, "permission[@type = 'class']", @labels["permissionclass"])
-        sequential_permission_names1(t, id, "requirement[@type = 'class']", @labels["requirementclass"])
-        sequential_permission_names1(t, id, "recommendation[@type = 'class']", @labels["recommendationclass"])
-      end
-
-      def sequential_permission_names1(block, lbl, klass, label)
-        c = ::IsoDoc::Function::XrefGen::Counter.new
-        block.xpath(ns("./#{klass}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-          id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
-          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
-          sequential_permission_children(t, id)
-        end
+      def requirement_parse(node, out)
+        recommendation_parse0(node, out, "requirement")
       end
 
-      def sequential_asset_names(clause)
-        sequential_table_names(clause)
-        sequential_figure_names(clause)
-        sequential_formula_names(clause)
-        sequential_permission_names(clause, "permission[not(@type = 'verification' or @type = 'class')]", @permission_lbl)
-        sequential_permission_names(clause, "requirement[not(@type = 'verification' or @type = 'class')]", @requirement_lbl)
-        sequential_permission_names(clause, "recommendation[not(@type = 'verification' or @type = 'class')]", @recommendation_lbl)
-        sequential_permission_names(clause, "permission[@type = 'verification']", @labels["permissiontest"])
-        sequential_permission_names(clause, "requirement[@type = 'verification']", @labels["requirementtest"])
-        sequential_permission_names(clause, "recommendation[@type = 'verification']", @labels["recommendationtest"])
-        sequential_permission_names(clause, "permission[@type = 'class']", @labels["permissionclass"])
-        sequential_permission_names(clause, "requirement[@type = 'class']", @labels["requirementclass"])
-        sequential_permission_names(clause, "recommendation[@type = 'class']", @labels["recommendationclass"])
-      end
-
-      def hierarchical_asset_names(clause, num)
-        hierarchical_table_names(clause, num)
-        hierarchical_figure_names(clause, num)
-        hierarchical_formula_names(clause, num)
-        hierarchical_permission_names(clause, num, "permission[not(@type = 'verification' or @type = 'class')]", @permission_lbl)
-        hierarchical_permission_names(clause, num, "requirement[not(@type = 'verification' or @type = 'class')]", @requirement_lbl)
-        hierarchical_permission_names(clause, num, "recommendation[not(@type = 'verification' or @type = 'class')]", @recommendation_lbl)
-        hierarchical_permission_names(clause, num, "permission[@type = 'verification']", @labels["permissiontest"])
-        hierarchical_permission_names(clause, num, "requirement[@type = 'verification']", @labels["requirementtest"])
-        hierarchical_permission_names(clause, num, "recommendation[@type = 'verification']", @labels["recommendationtest"])
-        hierarchical_permission_names(clause, num, "permission[@type = 'class']", @labels["permissionclass"])
-        hierarchical_permission_names(clause, num, "requirement[@type = 'class']", @labels["requirementclass"])
-        hierarchical_permission_names(clause, num, "recommendation[@type = 'class']", @labels["recommendationclass"])
-      end
-
-      def hierarchical_permission_names(clause, num, klass, label)
-        c = ::IsoDoc::Function::XrefGen::Counter.new
-        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
-          next if t["id"].nil? || t["id"].empty?
-          lbl = "#{num}#{hiersep}#{c.increment(t).print}"
-          @anchors[t["id"]] = anchor_struct(lbl, t, label, klass, t["unnumbered"])
-          sequential_permission_children(t, lbl)
-        end
+      def permission_parse(node, out)
+        recommendation_parse0(node, out, "permission")
       end
     end
   end

data/lib/isodoc/ogc/reqt_xref.rb

@@ -0,0 +1,96 @@
+module IsoDoc
+  module Ogc
+    module BaseConvert
+      FIRST_LVL_REQ = IsoDoc::Function::XrefGen::FIRST_LVL_REQ
+
+      def sequential_permission_names(clause, klass, label)
+        c = ::IsoDoc::Function::XrefGen::Counter.new
+        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          id = c.increment(t).print
+          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
+          l = t.at(ns("./label"))&.text and @reqtlabels[l] = t["id"]
+          sequential_permission_children(t, id)
+        end
+      end
+
+      def req_class_paths
+        { "class" => "@type = 'class'", 
+          "test" => "@type = 'verification'", 
+          "" => "not(@type = 'verification' or @type = 'class' or "\
+          "@type = 'abstracttest' or @type = 'conformanceclass')", }
+      end
+
+      def req_class_paths2
+        { "abstracttest" => "@type = 'abstracttest'",
+          "conformanceclass" => "@type = 'conformanceclass'", }
+      end
+
+      def sequential_permission_children(t, id)
+        req_class_paths.each do |k, v|
+          %w(permission requirement recommendation).each do |r|
+            sequential_permission_names1(t, id, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names1(t, id, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names1(t, id, "#{r}[#{v}]", @labels["#{r}#{k}"])
+          end
+        end
+        req_class_paths2.each do |k, v|
+          sequential_permission_names1(t, id, "*[#{v}]", @labels[k])
+        end
+      end
+
+      def sequential_permission_names1(block, lbl, klass, label)
+        c = ::IsoDoc::Function::XrefGen::Counter.new
+        block.xpath(ns("./#{klass}")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
+          @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
+          sequential_permission_children(t, id)
+        end
+      end
+
+      def sequential_asset_names(clause)
+        sequential_table_names(clause)
+        sequential_figure_names(clause)
+        sequential_formula_names(clause)
+        req_class_paths.each do |k, v|
+          %w(permission requirement recommendation).each do |r|
+            sequential_permission_names(clause, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names(clause, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            sequential_permission_names(clause, "#{r}[#{v}]", @labels["#{r}#{k}"])
+          end
+        end
+        req_class_paths2.each do |k, v|
+          sequential_permission_names(clause, "*[#{v}]", @labels[k])
+        end
+      end
+
+      def hierarchical_asset_names(clause, num)
+        hierarchical_table_names(clause, num)
+        hierarchical_figure_names(clause, num)
+        hierarchical_formula_names(clause, num)
+        req_class_paths.each do |k, v|
+          %w(permission requirement recommendation).each do |r|
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]", @labels["#{r}#{k}"])
+            hierarchical_permission_names(clause, num, "#{r}[#{v}]",  @labels["#{r}#{k}"])
+          end
+        end
+        req_class_paths2.each do |k, v|
+          hierarchical_permission_names(clause, num, "*[#{v}]", @labels[k])
+        end
+      end
+
+      def hierarchical_permission_names(clause, num, klass, label)
+        c = ::IsoDoc::Function::XrefGen::Counter.new
+        clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
+          next if t["id"].nil? || t["id"].empty?
+          lbl = "#{num}#{hiersep}#{c.increment(t).print}"
+          @anchors[t["id"]] = anchor_struct(lbl, t, label, klass, t["unnumbered"])
+          l = t.at(ns("./label"))&.text and @reqtlabels[l] = t["id"]
+          sequential_permission_children(t, lbl)
+        end
+      end
+    end
+  end
+end