metanorma-ogc 1.3.6 → 1.4.1

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -20,15 +20,15 @@ module IsoDoc
 
       def preface_init_insert_pt(docxml)
         docxml.at(ns("//preface")) ||
-          docxml.at(ns("//sections")).
-          add_previous_sibling("<preface> </preface>").first
+          docxml.at(ns("//sections"))
+            .add_previous_sibling("<preface> </preface>").first
       end
 
       def submit_orgs_append_pt(docxml)
         docxml.at(ns("//introduction")) ||
-        docxml.at(ns("//foreword")) ||
-        docxml.at(ns("//preface/clause[@type = 'keywords']")) ||
-        docxml.at(ns("//preface/abstract"))
+          docxml.at(ns("//foreword")) ||
+          docxml.at(ns("//preface/clause[@type = 'keywords']")) ||
+          docxml.at(ns("//preface/abstract"))
       end
 
       def insert_security(docxml)
@@ -37,8 +37,8 @@ module IsoDoc
         if a = submit_orgs_append_pt(docxml)
           a.next = s
         else
-          preface_init_insert_pt(docxml)&.children&.first&.
-            add_previous_sibling(s)
+          preface_init_insert_pt(docxml)&.children&.first
+            &.add_previous_sibling(s)
         end
       end
 
@@ -46,33 +46,34 @@ module IsoDoc
         orgs = []
         docxml.xpath(ns(submittingorgs_path)).each { |org| orgs << org.text }
         return if orgs.empty?
+
         if a = submit_orgs_append_pt(docxml)
           a.next = submitting_orgs_clause(orgs)
         else
-          preface_init_insert_pt(docxml)&.children&.first&.
-            add_previous_sibling(submitting_orgs_clause(orgs))
+          preface_init_insert_pt(docxml)&.children&.first
+            &.add_previous_sibling(submitting_orgs_clause(orgs))
         end
       end
 
       def submitting_orgs_clause(orgs)
-        <<~END
-        <clause id="_#{UUIDTools::UUID.random_create}" type="submitting_orgs">
-        <title>Submitting Organizations</title>
-        <p>The following organizations submitted this Document to the
-           Open Geospatial Consortium (OGC):</p>
-         <ul>#{orgs.map { |m| "<li>#{m}</li>" }.join("\n")}</ul>
-         </clause>
-        END
-      end
-
-      def keyword_clause(kw)
-        <<~END
-        <clause id="_#{UUIDTools::UUID.random_create}" type="keywords">
-        <title>Keywords</title>
-        <p>The following are keywords to be used by search engines and
-            document catalogues.</p>
-        <p>#{kw.join(", ")}</p></clause>
-        END
+        <<~SUBMITTING
+          <clause id="_#{UUIDTools::UUID.random_create}" type="submitting_orgs">
+          <title>Submitting Organizations</title>
+          <p>The following organizations submitted this Document to the
+             Open Geospatial Consortium (OGC):</p>
+           <ul>#{orgs.map { |m| "<li>#{m}</li>" }.join("\n")}</ul>
+           </clause>
+        SUBMITTING
+      end
+
+      def keyword_clause(kwords)
+        <<~KEYWORDS
+          <clause id="_#{UUIDTools::UUID.random_create}" type="keywords">
+          <title>Keywords</title>
+          <p>The following are keywords to be used by search engines and
+              document catalogues.</p>
+          <p>#{kwords.join(', ')}</p></clause>
+        KEYWORDS
       end
 
       def insert_keywords(docxml)
@@ -81,28 +82,29 @@ module IsoDoc
         if abstract = docxml.at(ns("//preface/abstract"))
           abstract.next = keyword_clause(kw)
         else
-          preface_init_insert_pt(docxml)&.children&.first&.
-            add_previous_sibling(keyword_clause(kw))
+          preface_init_insert_pt(docxml)&.children&.first
+            &.add_previous_sibling(keyword_clause(kw))
         end
       end
 
-      def example1(f)
-        lbl = @xrefs.anchor(f['id'], :label, false) or return
-        prefix_name(f, "&nbsp;&mdash; ", l10n("#{@i18n.example} #{lbl}"), "name")
+      def example1(elem)
+        lbl = @xrefs.anchor(elem["id"], :label, false) or return
+        prefix_name(elem, "&nbsp;&mdash; ", l10n("#{@i18n.example} #{lbl}"),
+                    "name")
       end
 
-      def recommendation1(f, type)
-        type = recommendation_class_label(f)
-        label = f&.at(ns("./label"))&.text
-        if inject_crossreference_reqt?(f, label)
+      def recommendation1(elem, _type)
+        type = recommendation_class_label(elem)
+        label = elem&.at(ns("./label"))&.text
+        if inject_crossreference_reqt?(elem, label)
           n = @xrefs.anchor(@xrefs.reqtlabels[label], :xref, false)
           lbl = (n.nil? ? type : n)
-          f&.at(ns("./title"))&.remove # suppress from display if embedded
+          elem&.at(ns("./title"))&.remove # suppress from display if embedded
         else
-          n = @xrefs.anchor(f['id'], :label, false)
+          n = @xrefs.anchor(elem["id"], :label, false)
           lbl = (n.nil? ? type : l10n("#{type} #{n}"))
         end
-        prefix_name(f, "", lbl, "name")
+        prefix_name(elem, "", lbl, "name")
       end
 
       # embedded reqts xref to top level reqts via label lookup
@@ -126,23 +128,29 @@ module IsoDoc
         end
       end
 
-      def annex1(f)
-        lbl = @xrefs.anchor(f['id'], :label)
-        if t = f.at(ns("./title"))
+      def annex1(elem)
+        lbl = @xrefs.anchor(elem["id"], :label)
+        if t = elem.at(ns("./title"))
           t.children = "<strong>#{t.children.to_xml}</strong>"
         end
-        prefix_name(f, "<br/>", lbl, "title")
+        prefix_name(elem, "<br/>", lbl, "title")
       end
 
       def clause(docxml)
         super
         docxml.xpath(ns("//foreword | //preface/abstract | "\
-                        "//submitters | //introduction | //acknowledgements")).
-                       each do |f|
+                        "//submitters | //introduction | //acknowledgements"))
+          .each do |f|
           clause1(f)
         end
       end
 
+      def clause1(elem)
+        return if elem.name == "terms" && elem.parent.name == "annex"
+
+        super
+      end
+
       def block(docxml)
         super
         recommendation_to_table(docxml)
@@ -166,4 +174,3 @@ module IsoDoc
     end
   end
 end
-

data/lib/isodoc/ogc/reqt.rb

@@ -8,17 +8,26 @@ module IsoDoc
         return "recommendtest" if node["type"] == "abstracttest"
         return "recommendclass" if node["type"] == "class"
         return "recommendclass" if node["type"] == "conformanceclass"
+
         "recommend"
       end
 
+      def recommend_class?(node)
+        %w(recommendtest recommendclass recommend).include? node["type"]
+      end
+
       def recommendation_class(node)
-        node["type"] == "recommendtest" ?
-          "RecommendationTestTitle" : "RecommendationTitle"
+        if node["type"] == "recommendtest"
+          "RecommendationTestTitle"
+        else
+          "RecommendationTitle"
+        end
       end
 
-      def recommendation_header(r)
-        h = r.add_child("<thead><tr><th scope='colgroup' colspan='2'></th></tr></thead>")
-        recommendation_name(r, h.at(ns(".//th")))
+      def recommendation_header(recommend)
+        h = recommend.add_child("<thead><tr><th scope='colgroup' colspan='2'>"\
+                                "</th></tr></thead>")
+        recommendation_name(recommend, h.at(ns(".//th")))
       end
 
       def recommendation_name(node, out)
@@ -27,7 +36,7 @@ module IsoDoc
           name.children.each { |n| b << n }
           b << l10n(":")
         end
-        if title =  node&.at(ns("./title"))&.remove
+        if title = node&.at(ns("./title"))&.remove
           b << l10n(" ") if name
           title.children.each { |n| b << n }
         end
@@ -41,20 +50,53 @@ module IsoDoc
       end
 
       def recommendation_attributes1(node)
-        out = []
+        out = recommendation_attributes1_head(node, [])
+        out = recommendation_attributes1_component(node, out)
+        node.xpath(ns("./classification")).each do |c|
+          line = recommendation_attr_keyvalue(c, "tag", "value") and out << line
+        end
+        out
+      end
+
+      def recommendation_attributes1_head(node, out)
         oblig = node["obligation"] and out << ["Obligation", oblig]
-        subj = node&.at(ns("./subject"))&.remove&.children and out << [rec_subj(node), subj]
+        subj = node&.at(ns("./subject"))&.remove&.children and
+          out << [rec_subj(node), subj]
         node.xpath(ns("./inherit")).each do |i|
           out << ["Dependency", i.remove.children]
         end
-        node.xpath(ns("./classification")).each do |c|
-          line = recommendation_attr_keyvalue(c, "tag", "value") and out << line
+        out
+      end
+
+      def strict_capitalize_phrase(str)
+        str.split(/ /).map do |w|
+          letters = w.chars
+          letters.first.upcase!
+          letters.join
+        end.join(" ")
+      end
+
+      def recommendation_attributes1_component(node, out)
+        node.xpath(ns("./component[not(@class = 'part')]")).each do |c|
+          out << case c["class"]
+                 when "test-purpose" then ["Test Purpose", c.remove.children]
+                 when "test-method" then ["Test Method", c.remove.children]
+                 else [strict_capitalize_phrase(c["class"]), c.remove.children]
+                 end
+        end
+        node.xpath(ns("./component[@class = 'part']")).each_with_index do |c, i|
+          out << [(i + "A".ord).chr.to_s, c.remove.children]
         end
         out
       end
 
       def rec_subj(node)
-        node["type"] == "recommendclass" ?  "Target Type" : "Subject"
+        case node["type_original"]
+        when "class" then "Target Type"
+        when "conformanceclass" then "Requirements Class"
+        when "verification", "abstracttest" then "Requirement"
+        else "Subject"
+        end
       end
 
       def recommendation_attr_keyvalue(node, key, value)
@@ -72,13 +114,16 @@ module IsoDoc
       end
 
       def preserve_in_nested_table?(node)
-        return true if %w(recommendation requirement permission table).include?(node.name)
+        return true if %w(recommendation requirement permission
+                          table).include?(node.name)
+
         false
       end
 
       def requirement_component_parse(node, out)
         node.remove
         return if node["exclude"] == "true"
+
         node.elements.size == 1 && node.first_element_child.name == "dl" and
           return reqt_dl(node.first_element_child, out)
         b = out.add_child("<tr><td colspan='2'></td></tr>").first
@@ -99,6 +144,7 @@ module IsoDoc
       def recommendation_base(node, klass)
         node.name = "table"
         node["class"] = klass
+        node["type_original"] = node["type"]
         node["type"] = recommend_class(node)
       end
 
@@ -110,8 +156,10 @@ module IsoDoc
         recommendation_attributes(node, b)
         node.elements.each do |n|
           next if %w(thead tbody).include?(n.name)
+
           requirement_component_parse(n, b)
         end
+        node.delete("type_original")
       end
 
       def recommendation_to_table(docxml)
@@ -128,25 +176,26 @@ module IsoDoc
       end
 
       # table nested in table: merge label and caption into a single row
-      def requirement_table_cleanup1(x, y)
-        x.delete("colspan")
-        x.delete("scope")
-        y.delete("colspan")
-        y.delete("scope")
-        x.name = "td"
-        p = x.at(ns("./p[@class = 'RecommendationTitle']")) and
+      def requirement_table_cleanup1(outer, inner)
+        outer.delete("colspan")
+        outer.delete("scope")
+        inner.delete("colspan")
+        inner.delete("scope")
+        outer.name = "td"
+        p = outer.at(ns("./p[@class = 'RecommendationTitle']")) and
           p.delete("class")
-        x.parent << y.dup
-        y.parent.remove
+        outer.parent << inner.dup
+        inner.parent.remove
       end
 
       def requirement_table_cleanup(docxml)
-        docxml.xpath(ns("//table[@type = 'recommendclass']/tbody/tr/td/table")).each do |t|
+        docxml.xpath(ns("//table[@type = 'recommendclass']/tbody/tr/td/table"))
+          .each do |t|
           x = t.at(ns("./thead")) and x.replace(x.children)
           x = t.at(ns("./tbody")) and x.replace(x.children)
           x = t.at(ns("./tfoot")) and x.replace(x.children)
-          if x = t.at(ns("./tr/th[@colspan = '2']")) and
-              y = t.at(ns("./tr/td[@colspan = '2']"))
+          if (x = t.at(ns("./tr/th[@colspan = '2']"))) &&
+              (y = t.at(ns("./tr/td[@colspan = '2']")))
             requirement_table_cleanup1(x, y)
           end
           t.parent.parent.replace(t.children)

data/lib/isodoc/ogc/word_convert.rb

@@ -15,7 +15,7 @@ module IsoDoc
         super
       end
 
-      def default_fonts(options)
+      def default_fonts(_options)
         {
           bodyfont: '"Times New Roman",serif',
           headerfont: '"Times New Roman",serif',
@@ -27,7 +27,7 @@ module IsoDoc
         }
       end
 
-      def default_file_locations(options)
+      def default_file_locations(_options)
         {
           wordstylesheet: html_doc_path("wordstyle.scss"),
           standardstylesheet: html_doc_path("ogc.scss"),
@@ -40,7 +40,7 @@ module IsoDoc
       end
 
       def convert1(docxml, filename, dir)
-        if docxml&.at(ns('//bibdata/ext/doctype'))&.text == "white-paper"
+        if docxml&.at(ns("//bibdata/ext/doctype"))&.text == "white-paper"
           @wordstylesheet_name = html_doc_path("wordstyle_wp.scss")
           @standardstylesheet_name = html_doc_path("ogc_wp.scss")
           @wordcoverpage = html_doc_path("word_ogc_titlepage_wp.html")
@@ -86,7 +86,7 @@ module IsoDoc
                           <span lang="EN-GB"><span
         style='mso-element:field-begin'></span><span
         style='mso-spacerun:yes'>&#xA0;</span>TOC
-        \\h \\z \\t &quot;RecommendationTitle,recommendationtitle&quot; 
+        \\h \\z \\t &quot;RecommendationTitle,recommendationtitle&quot;#{' '}
         <span style='mso-element:field-separator'></span></span>
       TOC
 
@@ -117,7 +117,7 @@ module IsoDoc
           toc += word_toc_entry(1, header_strip(h))
         end
         toc.sub(/(<p class="MsoToc1">)/,
-                %{\\1#{WORD_TOC_TABLE_PREFACE1}}) +  WORD_TOC_SUFFIX1
+                %{\\1#{WORD_TOC_TABLE_PREFACE1}}) + WORD_TOC_SUFFIX1
       end
 
       def make_FigureWordToC(docxml)
@@ -126,7 +126,7 @@ module IsoDoc
           toc += word_toc_entry(1, header_strip(h))
         end
         toc.sub(/(<p class="MsoToc1">)/,
-                %{\\1#{WORD_TOC_FIGURE_PREFACE1}}) +  WORD_TOC_SUFFIX1
+                %{\\1#{WORD_TOC_FIGURE_PREFACE1}}) + WORD_TOC_SUFFIX1
       end
 
       def make_RecommendationWordToC(docxml)
@@ -135,7 +135,7 @@ module IsoDoc
           toc += word_toc_entry(1, header_strip(h))
         end
         toc.sub(/(<p class="MsoToc1">)/,
-                %{\\1#{WORD_TOC_RECOMMENDATION_PREFACE1}}) +  WORD_TOC_SUFFIX1
+                %{\\1#{WORD_TOC_RECOMMENDATION_PREFACE1}}) + WORD_TOC_SUFFIX1
       end
 
       def make_body2(body, docxml)
@@ -179,10 +179,11 @@ module IsoDoc
         x = "//div[@class = 'boilerplate-copyright']/div[1]/p[not(@class)]"
         docxml.xpath(x).each { |p| p["align"] = "center" }
         return unless @doctype == "white-paper"
-        docxml.xpath("//div[@class = 'boilerplate-copyright']//p[not(@class)]").
-          each { |p| p["class"] = "license" }
-        docxml.xpath("//div[@class = 'boilerplate-legal']//p[not(@class)]").
-          each { |p| p["class"] = "license" }
+
+        docxml.xpath("//div[@class = 'boilerplate-copyright']//p[not(@class)]")
+          .each { |p| p["class"] = "license" }
+        docxml.xpath("//div[@class = 'boilerplate-legal']//p[not(@class)]")
+          .each { |p| p["class"] = "license" }
       end
 
       def word_term_cleanup(docxml)
@@ -199,7 +200,7 @@ module IsoDoc
           style_update(tr, "background:#A5A5A5;")
         end
         docxml.xpath("//table[@class = 'recommend']/tbody").each do |tr|
-          tr.xpath("./tr").each_slice(2) do |tr1, tr2|
+          tr.xpath("./tr").each_slice(2) do |_tr1, tr2|
             tr2 && style_update(tr2, "background:#C9C9C9;")
           end
         end

data/lib/isodoc/ogc/xref.rb

@@ -24,6 +24,7 @@ module IsoDoc
           @anchors[t["id"]] = anchor_struct(id, t, label, klass,
                                             t["unnumbered"])
           l = t.at(ns("./label"))&.text and @reqtlabels[l] = t["id"]
+          permission_parts(t, label, klass)
           sequential_permission_children(t, id)
         end
       end
@@ -32,7 +33,7 @@ module IsoDoc
         { "class" => "@type = 'class'",
           "test" => "@type = 'verification'",
           "" => "not(@type = 'verification' or @type = 'class' or "\
-          "@type = 'abstracttest' or @type = 'conformanceclass')" }
+                "@type = 'abstracttest' or @type = 'conformanceclass')" }
       end
 
       def req_class_paths2
@@ -40,15 +41,27 @@ module IsoDoc
           "conformanceclass" => "@type = 'conformanceclass'" }
       end
 
-      def sequential_permission_children(t, id)
+      def permission_parts(block, label, klass)
+        block.xpath(ns("./component[@class = 'part']"))
+          .each_with_index do |c, i|
+          next if c["id"].nil? || c["id"].empty?
+
+          @anchors[c["id"]] = anchor_struct((i + "A".ord).chr.to_s, c, label,
+                                            klass, c["unnumbered"])
+        end
+      end
+
+      REQS = %w(permission requirement recommendation).freeze
+
+      def sequential_permission_children(block, idx)
         req_class_paths.each do |k, v|
-          %w(permission requirement recommendation).each do |r|
-            sequential_permission_names1(t, id, "#{r}[#{v}]",
+          REQS.each do |r|
+            sequential_permission_names1(block, idx, "#{r}[#{v}]",
                                          @labels["#{r}#{k}"])
           end
         end
         req_class_paths2.each do |k, v|
-          sequential_permission_names1(t, id, "*[#{v}]", @labels[k])
+          sequential_permission_names1(block, idx, "*[#{v}]", @labels[k])
         end
       end
 
@@ -60,6 +73,7 @@ module IsoDoc
           id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
           @anchors[t["id"]] = anchor_struct(id, t, label, klass,
                                             t["unnumbered"])
+          permission_parts(t, label, klass)
           sequential_permission_children(t, id)
         end
       end
@@ -69,7 +83,7 @@ module IsoDoc
         sequential_figure_names(clause)
         sequential_formula_names(clause)
         req_class_paths.each do |k, v|
-          %w(permission requirement recommendation).each do |r|
+          REQS.each do |r|
             sequential_permission_names(clause, "#{r}[#{v}]",
                                         @labels["#{r}#{k}"])
           end
@@ -84,7 +98,7 @@ module IsoDoc
         hierarchical_figure_names(clause, num)
         hierarchical_formula_names(clause, num)
         req_class_paths.each do |k, v|
-          %w(permission requirement recommendation).each do |r|
+          REQS.each do |r|
             hierarchical_permission_names(clause, num, "#{r}[#{v}]",
                                           @labels["#{r}#{k}"])
           end
@@ -103,51 +117,54 @@ module IsoDoc
           @anchors[t["id"]] = anchor_struct(lbl, t, label, klass,
                                             t["unnumbered"])
           l = t.at(ns("./label"))&.text and @reqtlabels[l] = t["id"]
+          permission_parts(t, label, klass)
           sequential_permission_children(t, lbl)
         end
       end
 
-      def initial_anchor_names(d)
-        @prefacenum = 0
-        preface_names_numbered(d.at(ns("//preface/abstract")))
-        preface_names_numbered(d.at(ns("//preface/clause[@type = 'keywords']")))
-        preface_names_numbered(d.at(ns("//foreword")))
-        preface_names_numbered(d.at(ns("//introduction")))
-        preface_names_numbered(d.at(ns("//preface/clause[@type = 'security']")))
-        preface_names_numbered(d.at(ns("//preface/clause"\
-                                       "[@type = 'submitting_orgs']")))
-        preface_names_numbered(d.at(ns("//submitters")))
-        d.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
-                   "@type = 'submitting_orgs' or @type = 'security')]")).each do |c|
-          preface_names_numbered(c)
-        end
-        preface_names_numbered(d.at(ns("//acknowledgements")))
-        sequential_asset_names(d.xpath(ns(
-                                         "//preface/abstract | //foreword | //introduction | "\
-                                         "//submitters | //acknowledgements | //preface/clause",
-                                       )))
+      def initial_anchor_names(doc)
+        preface_anchor_names(doc)
         n = Counter.new
-        n = section_names(d.at(ns("//clause[@type = 'scope']")), n, 1)
-        n = section_names(d.at(ns("//clause[@type = 'conformance']")), n, 1)
-        n = section_names(d.at(ns(@klass.norm_ref_xpath)), n, 1)
+        n = section_names(doc.at(ns("//clause[@type = 'scope']")), n, 1)
+        n = section_names(doc.at(ns("//clause[@type = 'conformance']")), n, 1)
+        n = section_names(doc.at(ns(@klass.norm_ref_xpath)), n, 1)
         n = section_names(
-          d.at(ns("//sections/terms | //sections/clause[descendant::terms]")),
+          doc.at(ns("//sections/terms | //sections/clause[descendant::terms]")),
           n, 1
         )
-        n = section_names(d.at(ns("//sections/definitions")), n, 1)
-        middle_section_asset_names(d)
-        clause_names(d, n)
-        termnote_anchor_names(d)
-        termexample_anchor_names(d)
+        n = section_names(doc.at(ns("//sections/definitions")), n, 1)
+        middle_section_asset_names(doc)
+        clause_names(doc, n)
+        termnote_anchor_names(doc)
+        termexample_anchor_names(doc)
+      end
+
+      def preface_anchor_names(doc)
+        @prefacenum = 0
+        ["//preface/abstract", "//preface/clause[@type = 'keywords']",
+         "//foreword", "//introduction", "//preface/clause[@type = 'security']",
+         "//preface/clause[@type = 'submitting_orgs']",
+         "//submitters"].each do |path|
+          preface_names_numbered(doc.at(ns(path)))
+        end
+        doc.xpath(ns("//preface/clause[not(@type = 'keywords' or "\
+                     "@type = 'submitting_orgs' or @type = 'security')]"))
+          .each { |c| preface_names_numbered(c) }
+        preface_names_numbered(doc.at(ns("//acknowledgements")))
+        sequential_asset_names(
+          doc.xpath(ns("//preface/abstract | //foreword | //introduction | "\
+                       "//submitters | //acknowledgements | //preface/clause")),
+        )
       end
 
-      def middle_section_asset_names(d)
-        middle_sections = "//clause[@type = 'scope' or @type = 'conformance'] "\
-          "| //foreword | //introduction | //preface/abstract | "\
-          "//submitters | //acknowledgements | //preface/clause | "\
+      def middle_section_asset_names(doc)
+        middle_sections =
+          "//clause[@type = 'scope' or @type = 'conformance'] | //foreword | "\
+          "//introduction | //preface/abstract | //submitters | "\
+          "//acknowledgements | //preface/clause | "\
           " #{@klass.norm_ref_xpath} | //sections/terms | "\
           "//sections/definitions | //clause[parent::sections]"
-        sequential_asset_names(d.xpath(ns(middle_sections)))
+        sequential_asset_names(doc.xpath(ns(middle_sections)))
       end
 
       def preface_names_numbered(clause)
@@ -192,7 +209,7 @@ module IsoDoc
         super
         return unless @klass.ogc_draft_ref?(ref)
 
-        @anchors[ref["id"]] = { xref: @anchors[ref["id"]][:xref] + " (draft)" }
+        @anchors[ref["id"]] = { xref: "#{@anchors[ref['id']][:xref]}  (draft)" }
       end
     end
   end