metanorma-ieee 1.5.7 → 1.6.0

data/lib/metanorma/ieee/log.rb

@@ -0,0 +1,100 @@
+module Metanorma
+  module Ieee
+    class Converter
+      IEEE_LOG_MESSAGES = {
+        # rubocop:disable Naming/VariableNumber
+        "IEEE_2": { category: "Style",
+                    error: "%s is a 4-digit number in a table column with numbers broken up in threes",
+                    severity: 2 },
+        "IEEE_3": { category: "Style",
+                    error: "Expected title to start as: %s",
+                    severity: 2 },
+        "IEEE_4": { category: "Style",
+                    error: "Title contains uncapitalised word other than preposition",
+                    severity: 2 },
+        "IEEE_5": { category: "Document Attributes",
+                    error: "%s is not a recognised document type",
+                    severity: 2 },
+        "IEEE_6": { category: "Document Attributes",
+                    error: "%s is not a recognised document subtype",
+                    severity: 2 },
+        "IEEE_7": { category: "Document Attributes",
+                    error: "%s is not a recognised stage",
+                    severity: 2 },
+        "IEEE_8": { category: "Style",
+                    error: "Cross-reference contains range, should be separate cross-references",
+                    severity: 2 },
+        "IEEE_9": { category: "Style",
+                    error: "Undated reference %s should not contain specific elements",
+                    severity: 2 },
+        "IEEE_10": { category: "Style",
+                     error: "Normative reference %s is not dated.",
+                     severity: 2 },
+        "IEEE_11": { category: "Style",
+                     error: "Use ordered lists for lists more than two levels deep.",
+                     severity: 2 },
+        "IEEE_12": { category: "Style",
+                     error: "Ordered lists should not be more than five levels deep.",
+                     severity: 2 },
+        "IEEE_13": { category: "Style",
+                     error: "Image name %s is expected to be %s",
+                     severity: 2 },
+        #
+        "IEEE_15": { category: "Style",
+                     error: "More than one image in the table cell",
+                     severity: 2 },
+        "IEEE_16": { category: "Style",
+                     error: "Editorial instruction is missing from change",
+                     severity: 2 },
+        "IEEE_17": { category: "Style",
+                     error: "'Add' change description should start with _Insert_",
+                     severity: 2 },
+        "IEEE_18": { category: "Style",
+                     error: "'Delete' change description should start with _Delete_",
+                     severity: 2 },
+        "IEEE_19": { category: "Style",
+                     error: "'Modify' change description should start with _Change_ or _Replace_",
+                     severity: 2 },
+        "IEEE_20": { category: "Style",
+                     error: "'Modify' change description for change involving figure or equation should start with _Replace_",
+                     severity: 2 },
+        "IEEE_21": { category: "Style",
+                     error: "'Modify' change description for change not involving figure or equation should start with _Change_",
+                     severity: 2 },
+        "IEEE_22": { category: "Style",
+                     error: "Overview clause missing",
+                     severity: 2 },
+        "IEEE_23": { category: "Style",
+                     error: "Scope subclause missing",
+                     severity: 2 },
+        "IEEE_24": { category: "Style",
+                     error: "Word Usage subclause missing",
+                     severity: 2 },
+        "IEEE_25": { category: "Style",
+                     error: "Normative references missing",
+                     severity: 2 },
+        "IEEE_26": { category: "Style",
+                     error: "Definitions missing",
+                     severity: 2 },
+        "IEEE_27": { category: "Style",
+                     error: "(section sequencing) %s",
+                     severity: 2 },
+        "IEEE_28": { category: "Style",
+                     error: "Document must include (references) Normative References",
+                     severity: 2 },
+        #
+        "IEEE_30": { category: "Style",
+                     error: "subclause is only child",
+                     severity: 2 },
+        "IEEE_31": { category: "Style",
+                     error: "Bibliography must be either the first or the last document annex",
+                     severity: 2 },
+      }.freeze
+      # rubocop:enable Naming/VariableNumber
+
+      def log_messages
+        super.merge(IEEE_LOG_MESSAGES)
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/validate.rb

@@ -28,19 +28,16 @@ module Metanorma
       def doctype_validate(xmldoc)
         %w(standard recommended-practice guide whitepaper redline other)
           .include?(@doctype) or
-          @log.add("Document Attributes", nil,
-                   "#{@doctype} is not a recognised document type")
+          @log.add("IEEE_5", nil, params: [@doctype])
         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")
+          @log.add("IEEE_6", nil, params: [docsubtype])
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(draft approved superseded withdrawn).include? stage or
-          @log.add("Document Attributes", nil,
-                   "#{stage} is not a recognised stage")
+          @log.add("IEEE_7", nil, params: [stage])
       end
 
       def locality_validate(root)
@@ -52,8 +49,7 @@ module Metanorma
       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")
+            @log.add("IEEE_8", e)
         end
       end
 
@@ -61,9 +57,7 @@ module Metanorma
       def locality_erefs_validate(root)
         root.xpath("//eref[descendant::locality]").each do |t|
           if !/[:-](\d+{4})($|-\d\d)/.match?(t["citeas"])
-            @log.add("Style", t,
-                     "Undated reference #{t['citeas']} should not contain " \
-                     "specific elements")
+            @log.add("IEEE_9", t, params: [t["citeas"]])
           end
         end
       end
@@ -76,8 +70,7 @@ module Metanorma
       def normative_dated_refs(root)
         root.xpath("//references[@normative = 'true']/bibitem").each do |b|
           b.at(".//date") or
-            @log.add("Style", b,
-                     "Normative reference #{b.at('./@anchor')&.text} is not dated.")
+            @log.add("IEEE_10", b, params: [b.at("./@anchor")&.text])
         end
       end
 
@@ -91,14 +84,12 @@ module Metanorma
         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.")
+          @log.add("IEEE_11", u)
         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.")
+          @log.add("IEEE_12", u)
         end
       end
 
@@ -148,13 +139,12 @@ module Metanorma
         pref = image_name_prefix(xmldoc)
         (xmldoc.xpath("//figure") - xmldoc.xpath("//table//figure"))
           .each do |f|
-            (i = f.at("./image") and !i["src"]&.start_with?("data:")) or next
-            num = xrefs.anchor(f["id"], :label)
-            base = File.basename(i["src"], ".*")
-            base == "#{pref}_fig#{num}" or
-              @log.add("Style", i,
-                       "Image name #{base} is expected to be #{pref}_fig#{num}")
-          end
+          (i = f.at("./image") and !i["src"]&.start_with?("data:")) or next
+          num = xrefs.anchor(f["id"], :label)
+          base = File.basename(i["src"], ".*")
+          base == "#{pref}_fig#{num}" or
+            @log.add("IEEE_13", i, params: [base, "#{pref}_fig#{num}"])
+        end
       end
 
       # Style manual 17.2
@@ -172,8 +162,7 @@ module Metanorma
             num = tablefigurenumber(t, f, xrefs)
             base = File.basename(i["src"])
             base == num or
-              @log.add("Style", i,
-                       "Image name #{base} is expected to be #{num}")
+              @log.add("IEEE_13", i, params: [base, num])
           end
         end
       end
@@ -190,8 +179,7 @@ module Metanorma
       def table_figure_quantity_validate(xmldoc)
         xmldoc.xpath("//td[.//image] | //th[.//image]").each do |d|
           d.xpath(".//image").size > 1 and
-            @log.add("Style", d,
-                     "More than one image in the table cell")
+            @log.add("IEEE_15", d)
         end
       end
 
@@ -203,8 +191,7 @@ module Metanorma
             amend_validate1(a, desc.text.strip,
                             a.at("./newcontent//figure | " \
                                  "./newcontent//formula"))
-          else @log.add("Style", a,
-                        "Editorial instruction is missing from change")
+          else @log.add("IEEE_16", a)
           end
         end
       end
@@ -212,31 +199,21 @@ module Metanorma
       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_")
+          @log.add("IEEE_17", amend)
         when "delete" then /^Insert /.match?(description) or
-          @log.add("Style", amend,
-                   "'Delete' change description should start with _Delete_")
+          @log.add("IEEE_18", amend)
         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])
+          @log.add("IEEE_19", amend)
         elsif /^Change /.match?(description)
-          !figure_or_formula or @log.add("Style", amend, AMD_VALID_MOD[1])
+          !figure_or_formula or @log.add("IEEE_20", amend)
         else
-          figure_or_formula or @log.add("Style", amend, AMD_VALID_MOD[2])
+          figure_or_formula or @log.add("IEEE_21", amend)
         end
       end
     end

data/lib/metanorma/ieee/validate_section.rb

@@ -13,15 +13,17 @@ module Metanorma
 
       def sections_presence_validate(root)
         root.at("//sections/clause[@type = 'overview']") or
-          @log.add("Style", nil, "Overview clause missing")
+          @log.add("IEEE_22", nil)
         root.at("//sections/clause[@type = 'overview']/clause[@type = 'scope']") or
-          @log.add("Style", nil, "Scope subclause missing")
+          @log.add("IEEE_23", nil)
         root.at("//sections/clause[@type = 'overview']/clause[@type = 'word-usage']") or
-          @log.add("Style", nil, "Word Usage subclause missing")
+          @log.add("IEEE_24", nil)
+        # ID = IEEE_24
         root.at("//references[@normative = 'true']") or
-          @log.add("Style", nil, "Normative references missing")
+          @log.add("IEEE_25", nil)
+        # ID = IEEE_25
         root.at("//terms") or
-          @log.add("Style", nil, "Definitions missing")
+          @log.add("IEEE_26", nil)
       end
 
       def seqcheck(names, msg, accepted)
@@ -30,7 +32,7 @@ module Metanorma
 
         test = accepted.map { |a| n.at(a) }
         if test.all?(&:nil?)
-          @log.add("Style", nil, msg)
+          @log.add("IEEE_27", nil, params: [msg])
         end
         names
       end
@@ -79,13 +81,11 @@ module Metanorma
         while elem&.name == "annex"
           elem = names.shift
           if elem.nil?
-            @log.add("Style", nil, "Document must include (references) "\
-                                   "Normative References")
+            @log.add("IEEE_28", nil)
           end
         end
         elem&.at("./self::references[@normative = 'true']") ||
-          @log.add("Style", nil, "Document must include (references) "\
-                                 "Normative References")
+          @log.add("IEEE_28", nil)
       end
 
       # Style manual 13.1
@@ -100,7 +100,7 @@ module Metanorma
       def onlychild_clause_validate(root)
         root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
           c.xpath("../clause").size == 1 or next
-          @log.add("Style", c, "subclause is only child")
+          @log.add("IEEE_30", c)
         end
       end
 
@@ -113,8 +113,7 @@ module Metanorma
           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")
+        valid or @log.add("IEEE_31", bib)
       end
     end
   end

data/lib/metanorma/ieee/validate_style.rb

@@ -30,7 +30,7 @@ module Metanorma
 
         w = msg
         w += ": #{text}" if text
-        @log.add("Style", node, w)
+        @log.add("STANDOC_48", node, params: [w])
       end
 
       def style(node, text)
@@ -91,9 +91,7 @@ module Metanorma
 
           col.each do |x|
             /^[0-9. ]+$/.match?(x) && /\d{4}/.match?(x) and
-              @log.add("Style", table,
-                       "#{x} is a 4-digit number in a table column with " \
-                       "numbers broken up in threes")
+              @log.add("IEEE_2", table, params: [x])
           end
         end
       end
@@ -122,8 +120,7 @@ module Metanorma
         target += trial ? "Trial-Use " : ""
         target += @doctype ? "#{strict_capitalize_phrase(@doctype)} " : ""
         /^#{target}/.match?(title.text) or
-          @log.add("Style", title,
-                   "Expected title to start as: #{target}")
+          @log.add("IEEE_3", title, params: [target])
       end
 
       def strict_capitalize_phrase(str)
@@ -144,8 +141,7 @@ module Metanorma
           /^[[:upper:]]/.match?(w) or preposition?(w) or
             found = true
         end
-        found and @log.add("Style", title,
-                           "Title contains uncapitalised word other than preposition")
+        found and @log.add("IEEE_4", title)
       end
 
       def preposition?(word)

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ieee
-    VERSION = "1.5.7".freeze
+    VERSION = "1.6.0".freeze
   end
 end

data/lib/relaton/render/config.yml

@@ -16,17 +16,17 @@ extenttemplate:
   misc: "{{ volume }}, {{issue}}, {{ page }}, {{ duration }}"
 template:
   # skip authoritative_identifier, it is inserted in front of formattedref within metanorma
-  standard: "{{ title }}{% if home_standard %}{%else%}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %}{% endif %}."
-  article: "{{creatornames}}, “{{title}},” <em>{{ series }}</em>, {{ extent }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
-  book: "{{creatornames}}, <em>{{title}}</em>, {{ edition }}, {{place}}: {{publisher}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
+  standard: "{{ title }}{% if home_standard %}{%else%}$$$ {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: '$$$ ' }}{% endif %}{% endif %}{% endif %}$$$"
+  article: "{{creatornames}}$$$ “{{title}}$$$|” <em>{{ series }}</em>$$$ {{ extent }}$$$ {{ date }}$$$ {{ labels['viewed'] }}_{{date_accessed}}$$$ {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: '$$$ ' }}{% endif %}{% endif %} $$$"
+  book: "{{creatornames}}$$$ <em>{{title}}</em>$$$ {{ edition }}$$$ {{place}}: {{publisher}}$$$ {{date}}$$$ {{ labels['viewed'] }}_{{date_accessed}}$$$ {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: '$$$ ' }}{% endif %}{% endif %} $$$"
   techreport: book
   booklet: book
   manual: book
   proceedings: book
-  inproceedings: "{{ creatornames }}, “{{ title }},” <em>{{host_title}}</em>, {{place}}, {{extent}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
-  inbook: "{{ creatornames }}, “{{ title }},” {{ labels['in'] }} {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>, {{place}}: {{publisher}}, {{date}}, {{extent}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
+  inproceedings: "{{ creatornames }}$$$ “{{ title }}$$$|” <em>{{host_title}}</em>$$$ {{place}}$$$ {{extent}}$$$ {{date}}$$$ {{ labels['viewed'] }}_{{date_accessed}}$$$ {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: '$$$ ' }}{% endif %}{% endif %} $$$"
+  inbook: "{{ creatornames }}$$$ “{{ title }}$$$|” {{ labels['in'] }} {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>$$$ {{place}}: {{publisher}}$$$ {{date}}$$$ {{extent}}$$$ {{ labels['viewed'] }}_{{date_accessed}}$$$ {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: '$$$ ' }}{% endif %}{% endif %} $$$"
   incollection: inbook
-  thesis: "{{ creatornames }} , “{{ title }},” {{ medium | capitalize }}, {{ publisher }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
+  thesis: "{{ creatornames }} $$$ “{{ title }}$$$|” {{ medium | capitalize }}$$$ {{ publisher }}$$$ {{ date }}$$$ {{ labels['viewed'] }}_{{date_accessed}}$$$ {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: '$$$ ' }}{% endif %}{% endif %} $$$"
   unpublished: thesis
   misc: thesis
   website: thesis

data/metanorma-ieee.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 3.1.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.2.0"
   spec.add_dependency "mnconvert", "~> 1.20"
   spec.add_dependency "pubid"
 
@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "openssl"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: mnconvert
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -328,6 +342,7 @@ files:
 - lib/metanorma/ieee/ieee-footnotes.yaml
 - lib/metanorma/ieee/ieee.rng
 - lib/metanorma/ieee/isodoc.rng
+- lib/metanorma/ieee/log.rb
 - lib/metanorma/ieee/processor.rb
 - lib/metanorma/ieee/relaton-ieee.rng
 - lib/metanorma/ieee/reqt.rng