metanorma-ieee 0.0.1 → 0.0.4

data/lib/metanorma/ieee/front.rb

@@ -4,6 +4,9 @@ module Metanorma
       def metadata_committee(node, xml)
         return unless node.attr("committee") || node.attr("society")
 
+        node.attr("balloting-group") && !node.attr("balloting-group-type") and
+          node.set_attr("balloting-group-type", "individual")
+
         xml.editorialgroup do |a|
           committee_component("society", node, a)
           committee_component("balloting-group", node, a)
@@ -29,59 +32,6 @@ module Metanorma
         xml.docnumber node.attr("docnumber")
       end
 
-      def metadata_author(node, xml)
-        super
-        wg_members(node, xml)
-        bg_members(node, xml)
-        std_board_members(node, xml)
-      end
-
-      def metadata_editor(name, role, xml)
-        xml.contributor do |c|
-          c.role role, **{ type: "editor" }
-          c.person do |p|
-            p.name do |n|
-              n.completename name
-            end
-          end
-        end
-      end
-
-      def metadata_multi_editors(names, role, xml)
-        csv_split(names).each do |n|
-          metadata_editor(n, role, xml)
-        end
-      end
-
-      def wg_members(node, xml)
-        a = node.attr("wg_chair") and
-          metadata_editor(a, "Working Group Chair", xml)
-        a = node.attr("wg_vicechair") and
-          metadata_editor(a, "Working Group Vice-Chair", xml)
-        a = node.attr("wg_secretary") and
-          metadata_editor(a, "Working Group Secretary", xml)
-        a = node.attr("wg_members") and
-          metadata_multi_editors(a, "Working Group Member", xml)
-      end
-
-      def bg_members(node, xml)
-        a = node.attr("balloting_group_members") and
-          metadata_multi_editors(a, "Balloting Group Member", xml)
-      end
-
-      def std_board_members(node, xml)
-        a = node.attr("std_board_chair") and
-          metadata_editor(a, "Standards Board Chair", xml)
-        a = node.attr("std_board_vicechair") and
-          metadata_editor(a, "Standards Board Vice-Chair", xml)
-        a = node.attr("std_board_pastchair") and
-          metadata_editor(a, "Standards Board Past Chair", xml)
-        a = node.attr("std_board_secretary") and
-          metadata_editor(a, "Standards Board Secretary", xml)
-        a = node.attr("balloting_group_members") and
-          metadata_multi_editors(a, "Standards Board Member", xml)
-      end
-
       def metadata_publisher(node, xml)
         publishers = node.attr("publisher") || "IEEE"
         csv_split(publishers).each do |p|
@@ -112,9 +62,50 @@ module Metanorma
         end
       end
 
+      def metadata_status(node, xml)
+        status = node.attr("status") || node.attr("docstage") ||
+          (node.attr("draft") ? "developing" : "active")
+        xml.status do |s|
+          s.stage status
+        end
+      end
+
+      def datetypes
+        super + %w{feedback-ended}
+      end
+
+      def metadata_subdoctype(node, xml)
+        xml.subdoctype (node.attr("docsubtype") || "document")
+        s = node.attr("trial-use") and xml.trial_use s
+      end
+
       def org_abbrev
         { "Institute of Electrical and Electronic Engineers" => "IEEE" }
       end
+
+      def relaton_relations
+        super + %w(merges updates)
+      end
+
+      def metadata_ext(node, xml)
+        super
+        structured_id(node, xml)
+      end
+
+      def structured_id(node, xml)
+        return unless node.attr("docnumber")
+
+        xml.structuredidentifier do |i|
+          i.docnumber node.attr("docnumber")
+          i.agency "IEEE"
+          i.class_ doctype(node)
+          a = node.attr("edition") and i.edition a
+          a = node.attr("draft") and i.version a
+          a = node.attr("amendment-number") and i.amendment a
+          a = node.attr("corrigendum-number") and i.corrigendum a
+          a = node.attr("copyright-year") and i.year a
+        end
+      end
     end
   end
 end

data/lib/metanorma/ieee/ieee.rng

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns="https://www.metanorma.org/ns/ieee" xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns="https://www.metanorma.org/ns/ieee" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <!--
     Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
     we cannot have a new default namespace: we will end up with a grammar with two different
@@ -16,18 +16,37 @@
         <value>standard</value>
       </choice>
     </define>
+    <define name="stage">
+      <element name="stage">
+        <choice>
+          <value>developing</value>
+          <value>active</value>
+          <value>inactive</value>
+        </choice>
+      </element>
+    </define>
     <define name="editorialgroup">
       <element name="editorialgroup">
-        <ref name="society"/>
-        <ref name="balloting-group"/>
-        <ref name="working-group"/>
+        <optional>
+          <ref name="society"/>
+        </optional>
+        <optional>
+          <ref name="balloting-group"/>
+        </optional>
+        <optional>
+          <ref name="working-group"/>
+        </optional>
         <oneOrMore>
           <ref name="committee"/>
         </oneOrMore>
       </element>
     </define>
     <define name="DocumentSubtype">
-      <value>trial-use</value>
+      <choice>
+        <value>amendment</value>
+        <value>corrigendum</value>
+        <value>erratum</value>
+      </choice>
     </define>
     <define name="BibDataExtensionType">
       <optional>
@@ -36,14 +55,33 @@
       <optional>
         <ref name="docsubtype"/>
       </optional>
-      <ref name="editorialgroup"/>
+      <optional>
+        <ref name="trialuse"/>
+      </optional>
+      <optional>
+        <ref name="editorialgroup"/>
+      </optional>
       <zeroOrMore>
         <ref name="ics"/>
       </zeroOrMore>
     </define>
   </include>
+  <define name="BibliographicDateType" combine="choice">
+    <value>feecback-ended</value>
+  </define>
+  <define name="trialuse">
+    <element name="trial-use">
+      <data type="boolean"/>
+    </element>
+  </define>
   <define name="balloting-group">
     <element name="balloting-group">
+      <attribute name="type">
+        <choice>
+          <value>individual</value>
+          <value>entity</value>
+        </choice>
+      </attribute>
       <text/>
     </element>
   </define>

data/lib/metanorma/ieee/isodoc.rng

@@ -69,6 +69,17 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="AdmonitionType">
+      <choice>
+        <value>warning</value>
+        <value>note</value>
+        <value>tip</value>
+        <value>important</value>
+        <value>caution</value>
+        <value>statement</value>
+        <value>editorial</value>
+      </choice>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -116,6 +127,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="suppress_identifier">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <ref name="BibliographicItem"/>
       </element>
     </define>
@@ -1269,7 +1285,12 @@
   </define>
   <define name="span">
     <element name="span">
-      <attribute name="class"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
+      <optional>
+        <attribute name="style"/>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
@@ -2488,6 +2509,16 @@
           <text/>
         </element>
       </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
       <optional>
         <element name="language">
           <text/>

data/lib/metanorma/ieee/reqt.rng

@@ -108,7 +108,7 @@
     </element>
   </define>
   <define name="label">
-    <element name="label">
+    <element name="identifier">
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>

data/lib/metanorma/ieee/term_lookup_cleanup.rb

@@ -0,0 +1,11 @@
+module Metanorma
+  module IEEE
+    class TermLookupCleanup < Metanorma::Standoc::TermLookupCleanup
+      def remove_missing_ref_term(node, _target)
+        node.at("../xrefrender")&.remove
+        node.replace("<preferred><expression><name>#{node.children.to_xml}"\
+                     "</name></expression></preferred>")
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/validate.rb

@@ -14,76 +14,49 @@ module Metanorma
         super
         bibdata_validate(doc.root)
         title_validate(doc.root)
-        locality_erefs_validate(doc.root)
+        locality_validate(doc.root)
         bibitem_validate(doc.root)
-        listcount_validate(doc)
+        list_validate(doc)
         table_style(doc)
         figure_validate(doc)
+        amend_validate(doc)
       end
 
       def bibdata_validate(doc)
         doctype_validate(doc)
-        # stage_validate(doc)
-        # substage_validate(doc)
+        stage_validate(doc)
       end
 
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
-        %w(standard recommended-practice guide
-           amendment technical-corrigendum).include? doctype or
+        %w(standard recommended-practice guide).include? doctype or
           @log.add("Document Attributes", nil,
                    "#{doctype} is not a recognised document type")
+        docsubtype = xmldoc&.at("//bibdata/ext/subdoctype")&.text or return
+        %w(amendment corrigendum erratum document).include? docsubtype or
+          @log.add("Document Attributes", nil,
+                   "#{docsubtype} is not a recognised document subtype")
       end
 
-      def title_validate(xml)
-        title_validate_type(xml)
-        title_validate_capitalisation(xml)
-      end
-
-      # Style Manual 11.3
-      def title_validate_type(xml)
-        title = xml.at("//bibdata/title") or return
-        draft = xml.at("//bibdata//draft")
-        type = xml.at("//bibdata/ext/doctype")
-        subtype = xml.at("//bibdata/ext/subdoctype")
-        target = draft ? "Draft " : ""
-        target += subtype ? "#{strict_capitalize_phrase(subtype.text)} " : ""
-        target += type ? "#{strict_capitalize_phrase(type.text)} " : ""
-        /^#{target}/.match?(title.text) or
-          @log.add("Style", title,
-                   "Expected title to start as: #{target}")
-      end
-
-      def strict_capitalize_phrase(str)
-        ret = str.split(/[ -]/).map do |w|
-          letters = w.chars
-          letters.first.upcase! unless /^[ -]/.match?(w)
-          letters.join
-        end.join(" ")
-        ret = "Trial-Use" if ret == "Trial Use"
-        ret
-      end
-
-      # Style Manual 11.3
-      def title_validate_capitalisation(xml)
-        title = xml.at("//bibdata/title") or return
-        found = false
-        title.text.split(/[ -]/).each do |w|
-          /^[[:upper:]]/.match?(w) or preposition?(w) or
-            found = true
-        end
-        found and @log.add("Style", title,
-                           "Title contains uncapitalised word other than preposition")
+      def stage_validate(xmldoc)
+        stage = xmldoc&.at("//bibdata/status/stage")&.text
+        %w(active inactive developing).include? stage or
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised stage")
       end
 
-      def preposition?(word)
-        %w(aboard about above across after against along amid among anti around
-           as at before behind below beneath beside besides between beyond but
-           by concerning considering despite down during except excepting
-           excluding following for from in inside into like minus near of off
-           on onto opposite outside over past per plus regarding round save
-           since than through to toward towards under underneath unlike until
-           up upon versus via with within without a an the).include?(word)
+      def locality_validate(root)
+        locality_range_validate(root)
+        locality_erefs_validate(root)
+      end
+
+      # Style manual 17.2 &c
+      def locality_range_validate(root)
+        root.xpath("//eref | xref").each do |e|
+          e.at(".//localityStack[@connective = 'from'] | .//referenceTo") and
+            @log.add("Style", e, "Cross-reference contains range, "\
+                                 "should be separate cross-references")
+        end
       end
 
       # Style manual 12.3.2
@@ -91,7 +64,7 @@ module Metanorma
         root.xpath("//eref[descendant::locality]").each do |t|
           if !/[:-](\d+{4})$/.match?(t["citeas"])
             @log.add("Style", t,
-                     "undated reference #{t['citeas']} should not contain "\
+                     "Undated reference #{t['citeas']} should not contain "\
                      "specific elements")
           end
         end
@@ -110,9 +83,30 @@ module Metanorma
         end
       end
 
+      def list_validate(doc)
+        listcount_validate(doc)
+        listdepth_validate(doc)
+      end
+
+      # Template provision of styles
+      def listdepth_validate(doc)
+        doc.xpath("//ul[.//ul//ul]").each do |u|
+          next unless u.ancestors("ul").empty?
+
+          @log.add("Style", u,
+                   "Use ordered lists for lists more than two levels deep.")
+        end
+        doc.xpath("//ol[.//ol//ol//ol//ol//ol]").each do |u|
+          next unless u.ancestors("ol").empty?
+
+          @log.add("Style", u,
+                   "Ordered lists should not be more than five levels deep.")
+        end
+      end
+
       # Style manual 13.3
       def listcount_validate(doc)
-        doc.xpath("//clause | //annex").each do |c|
+        doc.xpath("//sections//clause | //annex").each do |c|
           next if c.xpath(".//ol").empty?
 
           ols = c.xpath(".//ol") -
@@ -127,6 +121,7 @@ module Metanorma
       def figure_validate(xmldoc)
         xrefs = xrefs(xmldoc)
         figure_name_validate(xmldoc, xrefs)
+        figure_name_style_validate(xmldoc)
         table_figure_name_validate(xmldoc, xrefs)
         table_figure_quantity_validate(xmldoc)
       end
@@ -159,10 +154,18 @@ module Metanorma
             num = xrefs.anchor(f["id"], :label)
             File.basename(i["src"], ".*") == "#{pref}_fig#{num}" or
               @log.add("Style", i,
-                       "image name #{i['src']} is expected to be #{pref}_fig#{num}")
+                       "Image name #{i['src']} is expected to be #{pref}_fig#{num}")
           end
       end
 
+      # Style manual 17.2
+      def figure_name_style_validate(docxml)
+        docxml.xpath("//figure/name").each do |td|
+          style_regex(/^(?<num>\p{Lower}\s*)/, "figure heading should be capitalised",
+                      td, td.text)
+        end
+      end
+
       def table_figure_name_validate(xmldoc, xrefs)
         xmldoc.xpath("//table[.//figure]").each do |t|
           xmldoc.xpath(".//figure").each do |f|
@@ -172,7 +175,7 @@ module Metanorma
             num = tablefigurenumber(t, f, xrefs)
             File.basename(i["src"]) == num or
               @log.add("Style", i,
-                       "image name #{i['src']} is expected to be #{num}")
+                       "Image name #{i['src']} is expected to be #{num}")
           end
         end
       end
@@ -193,6 +196,51 @@ module Metanorma
                      "More than one image in the table cell")
         end
       end
+
+      # Style manual 20.2.2
+      def amend_validate(xmldoc)
+        xmldoc.xpath("//amend").each do |a|
+          desc = a.at("./description")
+          if desc && !desc.text.strip.empty?
+            amend_validate1(a, desc.text.strip,
+                            a.at("./newcontent//figure | "\
+                                 "./newcontent//formula"))
+          else @log.add("Style", a,
+                        "Editorial instruction is missing from change")
+          end
+        end
+      end
+
+      def amend_validate1(amend, description, figure_or_formula)
+        case amend["change"]
+        when "add" then /^Insert /.match?(description) or
+          @log.add("Style", amend,
+                   "'Add' change description should start with _Insert_")
+        when "delete" then /^Insert /.match?(description) or
+          @log.add("Style", amend,
+                   "'Delete' change description should start with _Delete_")
+        when "modify"
+          amend_validate_modify(amend, description, figure_or_formula)
+        end
+      end
+
+      AMD_VALID_MOD = [
+        "'Modify' change description should start with _Change_ or _Replace_",
+        "'Modify' change description for change involving figure or equation "\
+        "should start with _Replace_",
+        "'Modify' change description for change not involving figure or "\
+        "equation should start with _Change_",
+      ].freeze
+
+      def amend_validate_modify(amend, description, figure_or_formula)
+        if !/^Change |^Replace/.match?(description)
+          @log.add("Style", amend, AMD_VALID_MOD[0])
+        elsif /^Change /.match?(description)
+          !figure_or_formula or @log.add("Style", amend, AMD_VALID_MOD[1])
+        else
+          figure_or_formula or @log.add("Style", amend, AMD_VALID_MOD[2])
+        end
+      end
     end
   end
 end

data/lib/metanorma/ieee/validate_section.rb

@@ -58,6 +58,7 @@ module Metanorma
         names, n = sections_sequence_validate_start(root)
         names, n = sections_sequence_validate_body(names, n)
         sections_sequence_validate_end(names, n)
+        bibliography_validate(root)
       end
 
       def sections_sequence_validate_start(root)
@@ -86,13 +87,6 @@ module Metanorma
         elem&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
                                  "Normative References")
-        elem = names&.shift
-        elem&.at("./self::references[@normative = 'false']") ||
-          @log.add("Style", elem,
-                   "Final section must be (references) Bibliography")
-        names.empty? ||
-          @log.add("Style", elem,
-                   "There are sections after the final Bibliography")
       end
 
       # Style manual 13.1
@@ -114,6 +108,19 @@ module Metanorma
           @log.add("Style", nil, "#{location}: subclause is only child")
         end
       end
+
+      # Style manual 19.1
+      def bibliography_validate(root)
+        bib = root.at("//references[@normative = 'false']") or return
+        if annex = bib.at(".//ancestor::annex")
+          prec = annex.xpath("./preceding-sibling::annex")
+          foll = annex.xpath("./following-sibling::annex")
+          valid = prec.empty? || foll.empty?
+        else valid = false
+        end
+        valid or @log.add("Style", bib, "Bibliography must be either the first "\
+                                        "or the last document annex")
+      end
     end
   end
 end

data/lib/metanorma/ieee/validate_style.rb

@@ -68,13 +68,17 @@ module Metanorma
                     "unit is needed on both value and tolerance", node, text)
       end
 
-      # Style manual 16.3.2
+      # Style manual 16.2, 16.3.2
       def table_style(docxml)
         docxml.xpath("//td").each do |td|
           style_regex(/^(?<num>[\u2212-]?[0-9]{5,}[.0-9]*|-?[0-9]+\.[0-9]{5,})$/,
                       "number in table not broken up in threes", td, td.text)
         end
         docxml.xpath("//table").each { |t| table_style_columns(t) }
+        docxml.xpath("//table/name | //th").each do |td|
+          style_regex(/^(?<num>\p{Lower}\S*)/, "table heading should be capitalised",
+                      td, td.text)
+        end
       end
 
       # deliberately doing naive, ignoring rowspan
@@ -102,6 +106,59 @@ module Metanorma
           end
         end
         ret.map { |x| x.is_a?(Array) ? x : [] }
+      end
+
+            def title_validate(xml)
+        title_validate_type(xml)
+        title_validate_capitalisation(xml)
+      end
+
+      # Style Manual 11.3
+      def title_validate_type(xml)
+        title = xml.at("//bibdata/title") or return
+        draft = xml.at("//bibdata//draft")
+        type = xml.at("//bibdata/ext/doctype")
+        subtype = xml.at("//bibdata/ext/subdoctype")
+        subtype = "" if subtype == "document"
+        trial = xml.at("//bibdata/ext/trial-use[text() = 'true']")
+        target = draft ? "Draft " : ""
+        target += trial ? "Trial-Use " : ""
+        target += type ? "#{strict_capitalize_phrase(type.text)} " : ""
+        /^#{target}/.match?(title.text) or
+          @log.add("Style", title,
+                   "Expected title to start as: #{target}")
+      end
+
+      def strict_capitalize_phrase(str)
+        ret = str.split(/[ -]/).map do |w|
+          letters = w.chars
+          letters.first.upcase! unless /^[ -]/.match?(w)
+          letters.join
+        end.join(" ")
+        ret = "Trial-Use" if ret == "Trial Use"
+        ret
+      end
+
+      # Style Manual 11.3
+      def title_validate_capitalisation(xml)
+        title = xml.at("//bibdata/title") or return
+        found = false
+        title.text.split(/[ -]/).each do |w|
+          /^[[:upper:]]/.match?(w) or preposition?(w) or
+            found = true
+        end
+        found and @log.add("Style", title,
+                           "Title contains uncapitalised word other than preposition")
+      end
+
+      def preposition?(word)
+        %w(aboard about above across after against along amid among anti around
+           as at before behind below beneath beside besides between beyond but
+           by concerning considering despite down during except excepting
+           excluding following for from in inside into like minus near of off
+           on onto opposite outside over past per plus regarding round save
+           since than through to toward towards under underneath unlike until
+           up upon versus via with within without a an the).include?(word)
       end
     end
   end

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module IEEE
-    VERSION = "0.0.1".freeze
+    VERSION = "0.0.4".freeze
   end
 end