metanorma-iso 2.8.7 → 2.8.8

data/lib/isodoc/iso/metadata.rb

@@ -67,6 +67,7 @@ module IsoDoc
       # French titles in the same document
       PART_LABEL = { en: "Part", fr: "Partie", ru: "Часть" }.freeze
       AMD_LABEL = { en: "AMENDMENT", fr: "AMENDMENT", ru: "ПОПРАВКА" }.freeze
+      ADD_LABEL = { en: "ADDENDUM", fr: "ADDITIF", ru: "ДОПОЛНЕНИЕ" }.freeze
       CORR_LABEL = { en: "TECHNICAL CORRIGENDUM",
                      fr: "RECTIFICATIF TECHNIQUE",
                      ru: "ТЕХНИЧЕСКОЕ ИСПРАВЛЕНИЕ" }.freeze
@@ -93,6 +94,10 @@ module IsoDoc
         "#{self.class::AMD_LABEL[lang.to_sym]} #{titlenums[:amd]}"
       end
 
+      def add_prefix(titlenums, lang)
+        "#{self.class::ADD_LABEL[lang.to_sym]} #{titlenums[:add]}"
+      end
+
       def corr_prefix(titlenums, lang)
         "#{self.class::CORR_LABEL[lang.to_sym]} #{titlenums[:corr]}"
       end
@@ -115,6 +120,7 @@ module IsoDoc
         { part: isoxml.at(ns("#{prefix}/@part")),
           subpart: isoxml.at(ns("#{prefix}/@subpart")),
           amd: isoxml.at(ns("#{prefix}/@amendment")),
+          add: isoxml.at(ns("#{prefix}/@addendum")),
           corr: isoxml.at(ns("#{prefix}/@corrigendum")) }
       end
 
@@ -126,6 +132,8 @@ module IsoDoc
           part: isoxml.at(ns("//bibdata/title[@type='title-part' and " \
                              "@language='#{lang}']")),
           amd: isoxml.at(ns("//bibdata/title[@type='title-amd' and " \
+                            "@language='#{lang}']")),
+          add: isoxml.at(ns("//bibdata/title[@type='title-add' and " \
                             "@language='#{lang}']")) }
       end
 
@@ -146,6 +154,8 @@ module IsoDoc
         set(:doctitleamdlabel, amd_prefix(tn, lang)) if tn[:amd]
         set(:doctitleamd, tp[:amd].children.to_xml) if tp[:amd]
         set(:doctitlecorrlabel, corr_prefix(tn, lang)) if tn[:corr]
+        set(:doctitleaddlabel, add_prefix(tn, lang)) if tn[:add]
+        set(:doctitleadd, tp[:add].children.to_xml) if tp[:add]
       end
 
       def subtitle(isoxml, _out)
@@ -161,6 +171,8 @@ module IsoDoc
         tp[:part] and set(:docsubtitlepart, tp[:part].children.to_xml)
         set(:docsubtitleamdlabel, amd_prefix(tn, lang)) if tn[:amd]
         set(:docsubtitleamd, tp[:amd].children.to_xml) if tp[:amd]
+        set(:docsubtitleaddlabel, add_prefix(tn, lang)) if tn[:add]
+        set(:docsubtitleadd, tp[:add].children.to_xml) if tp[:add]
         set(:docsubtitlecorrlabel, corr_prefix(tn, lang)) if tn[:corr]
       end
 

data/lib/metanorma/iso/base.rb

@@ -8,7 +8,7 @@ require "fileutils"
 require_relative "processor"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       XML_ROOT_TAG = "iso-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/iso".freeze
@@ -83,12 +83,12 @@ module Metanorma
 
       def document_scheme(node)
         r = node.attr("document-scheme") and return r
-        r = node.attr("copyright-year")&.to_i or return "2024"
+        r = node.attr("copyright-year")&.to_i or return DOCUMENT_SCHEMES[-1]
         DOCUMENT_SCHEMES.each_index do |i|
           i.zero? and next
           r < DOCUMENT_SCHEMES[i] and return DOCUMENT_SCHEMES[i - 1].to_s
         end
-        "2024"
+        DOCUMENT_SCHEMES[-1]
       end
 
       def outputs(node, ret)

data/lib/metanorma/iso/biblio-standoc.rng

@@ -72,6 +72,9 @@ standards defining organization, and that is rendered in a distinct manner</a:do
 from other documents in the same doctype</a:documentation>
       </ref>
     </optional>
+    <ref name="flavor">
+      <a:documentation>Flavour of Metanorma used to process this document</a:documentation>
+    </ref>
     <optional>
       <ref name="editorialgroup">
         <a:documentation>Groups associated with the production of the standards document, typically within
@@ -113,6 +116,16 @@ a standards definition organization</a:documentation>
   <define name="DocumentSubtype">
     <text/>
   </define>
+  <define name="flavor">
+    <element name="flavor">
+      <ref name="MetanormaFlavor"/>
+    </element>
+  </define>
+  <define name="MetanormaFlavor">
+    <a:documentation>This is in fact an enum, as of this writing: standoc iso generic ietf ieee itu nist ogc csa cc iho ribose jis iec bsi bipm plateau.
+However we prefer not to hardcode it, given ongoing extension.</a:documentation>
+    <text/>
+  </define>
   <define name="editorialgroup">
     <a:documentation>A group associated with the production of the standards document, typically within
 a standards definition organization</a:documentation>

data/lib/metanorma/iso/biblio.rng

@@ -1382,18 +1382,7 @@ Applies whether the resource has already been created or not, and whether it is
   <define name="bdate">
     <a:documentation>Significant date in the lifecycle of the bibliographic item, including its production and its access</a:documentation>
     <element name="date">
-      <attribute name="type">
-        <a:documentation>The phase of the production of or access to a bibliographic item</a:documentation>
-        <choice>
-          <ref name="BibliographicDateType"/>
-          <text/>
-        </choice>
-      </attribute>
-      <optional>
-        <attribute name="text">
-          <a:documentation>An optional textual description of the date, especially when a Gregorian date is not applicable</a:documentation>
-        </attribute>
-      </optional>
+      <ref name="bDateAttributes"/>
       <optional>
         <choice>
           <group>
@@ -1416,6 +1405,20 @@ Applies whether the resource has already been created or not, and whether it is
       </optional>
     </element>
   </define>
+  <define name="bDateAttributes">
+    <attribute name="type">
+      <a:documentation>The phase of the production of or access to a bibliographic item</a:documentation>
+      <choice>
+        <ref name="BibliographicDateType"/>
+        <text/>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="text">
+        <a:documentation>An optional textual description of the date, especially when a Gregorian date is not applicable</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="docidentifier">
     <a:documentation>An identifier of a bibliographic item in an international standard scheme</a:documentation>
     <element name="docidentifier">
@@ -1884,6 +1887,10 @@ Detailed in https://www.relaton.org/model/relations/</a:documentation>
       <value>hasAnnotation</value>
       <value>draftOf</value>
       <value>hasDraft</value>
+      <value>preliminaryDraftOf</value>
+      <value>hasPreliminaryDraft</value>
+      <value>revisionDraftOf</value>
+      <value>hasRevisionDraft</value>
       <value>editionOf</value>
       <value>hasEdition</value>
       <value>updates</value>

data/lib/metanorma/iso/cleanup.rb

@@ -1,7 +1,7 @@
 require_relative "cleanup_biblio"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       PRE_NORMREF_FOOTNOTES = "//preface//fn | " \
                               "//clause[@type = 'scope']//fn".freeze

data/lib/metanorma/iso/cleanup_biblio.rb

@@ -1,9 +1,9 @@
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
-      def id_prefix(prefix, id)
+      def id_prefix(prefix, id, amd: false)
         # we're just inheriting the prefixes from parent doc
-        @amd and return id.text
+        amd and return id.text
         prefix.join("/") + (id.text.match?(%{^/}) ? "" : " ") + id.text
       end
 
@@ -16,10 +16,12 @@ module Metanorma
       end
 
       # ISO as a prefix goes first
-      def docidentifier_cleanup(xmldoc)
-        prefix = get_id_prefix(xmldoc)
-        id = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") and
-          id.content = id_prefix(prefix, id)
+      def docidentifier_cleanup(xml)
+        prefix = get_id_prefix(xml)
+        amd = @amd || xml.at("//bibdata/ext/doctype")&.text == "addendum"
+        id = xml.at("//bibdata/ext/structuredidentifier/project-number") and
+          id.content =
+            id_prefix(prefix, id, amd:)
       end
 
       def format_ref(ref, type)

data/lib/metanorma/iso/converter.rb

@@ -8,7 +8,7 @@ require "metanorma/iso/validate"
 require "metanorma/iso/cleanup"
 
 module Metanorma
-  module ISO
+  module Iso
     # A {Converter} implementation that generates ISO output, and a document
     # schema encapsulation of the document for validation
     class Converter < ::Metanorma::Standoc::Converter

data/lib/metanorma/iso/front.rb

@@ -8,7 +8,7 @@ require_relative "front_id"
 require_relative "front_contributor"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def metadata_ext(node, xml)
         super
@@ -47,7 +47,7 @@ module Metanorma
         end
       end
 
-      def metadata_subdoctype(node, xml)
+      def metadata_flavor(node, xml)
         super
         a = node.attr("horizontal") and xml.horizontal a
       end
@@ -71,10 +71,9 @@ module Metanorma
       end
 
       def title_intro(node, xml, lang, at)
-        return unless node.attr("title-intro-#{lang}")
-
+        t = node.attr("title-intro-#{lang}") or return
         xml.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(t)
         end
       end
 
@@ -85,20 +84,23 @@ module Metanorma
       end
 
       def title_part(node, xml, lang, at)
-        return unless node.attr("title-part-#{lang}")
-
+        t = node.attr("title-part-#{lang}") or return
         xml.title(**attr_code(at.merge(type: "title-part"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(t)
         end
       end
 
       def title_amd(node, xml, lang, at)
-        return unless node.attr("title-amendment-#{lang}")
-
+        t = node.attr("title-amendment-#{lang}") or return
         xml.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(
-            node.attr("title-amendment-#{lang}"),
-          )
+          t1 << Metanorma::Utils::asciidoc_sub(t)
+        end
+      end
+
+      def title_add(node, xml, lang, at)
+        t = node.attr("title-addendum-#{lang}") or return
+        xml.title(**attr_code(at.merge(type: "title-add"))) do |t1|
+          t1 << Metanorma::Utils::asciidoc_sub(t)
         end
       end
 
@@ -107,9 +109,11 @@ module Metanorma
         intro = node.attr("title-intro-#{lang}")
         part = node.attr("title-part-#{lang}")
         amd = node.attr("title-amendment-#{lang}")
+        add = node.attr("title-addendum-#{lang}")
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
         title = "#{title} -- #{amd}" if amd && @amd
+        title = "#{title} -- #{add}" if amd && node.attr("addendum-number")
         xml.title **attr_code(at.merge(type: "main")) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(title)
         end
@@ -123,12 +127,13 @@ module Metanorma
           title_main(node, xml, lang, at)
           title_part(node, xml, lang, at)
           title_amd(node, xml, lang, at) if @amd
+          title_add(node, xml, lang, at) if node.attr("addendum-number")
         end
       end
 
       def relaton_relations
         super + %w(obsoletes successor-of manifestation-of related
-                   annotation-of)
+                   annotation-of has-draft)
       end
 
       def relaton_relation_descriptions

data/lib/metanorma/iso/front_contributor.rb

@@ -1,5 +1,5 @@
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       # def home_agency
       # "ISO"

data/lib/metanorma/iso/front_id.rb

@@ -5,7 +5,7 @@ require "pubid-cen"
 require "pubid-iec"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def metadata_id(node, xml)
         if id = node.attr("docidentifier")
@@ -27,6 +27,7 @@ module Metanorma
       # document's type, eg. :tr, :ts, :amd, :cor, Type.new(:tr)
       def get_typeabbr(node, amd: false)
         node.attr("amendment-number") and return :amd
+        node.attr("addendum-number") and return :add
         node.attr("corrigendum-number") and return :cor
         DOCTYPE2HASHID[doctype(node).to_sym]
       end
@@ -100,7 +101,8 @@ module Metanorma
       def iso_id_params_add(node)
         stage = iso_id_stage(node)
         ret = { number: node.attr("amendment-number") ||
-          node.attr("corrigendum-number"),
+          node.attr("corrigendum-number") ||
+          node.attr("addendum-number"),
                 year: iso_id_year(node),
                 iteration: node.attr("iteration") }
         iso_id_stage_populate(ret, node, stage)
@@ -139,7 +141,8 @@ module Metanorma
 
       def iso_id_params_resolve(params, params2, node, orig_id)
         if orig_id && (node.attr("amendment-number") ||
-            node.attr("corrigendum-number"))
+            node.attr("corrigendum-number") ||
+                      node.attr("addendum-number"))
           %i(unpublished part).each { |x| params.delete(x) }
           params2[:base] = orig_id
         elsif orig_id &&
@@ -221,6 +224,7 @@ module Metanorma
             part:, subpart:,
             amendment: node.attr("amendment-number"),
             corrigendum: node.attr("corrigendum-number"),
+            addendum: node.attr("addendum-number"),
             origyr: node.attr("created-date")
           ))
         end

data/lib/metanorma/iso/processor.rb

@@ -3,7 +3,6 @@ require "metanorma/processor"
 module Metanorma
   module Iso
     class Processor < Metanorma::Processor
-
       def initialize # rubocop:disable Lint/MissingSuper
         @short = :iso
         @input_format = :asciidoc
@@ -22,7 +21,7 @@ module Metanorma
       end
 
       def version
-        "Metanorma::ISO #{Metanorma::ISO::VERSION}"
+        "Metanorma::Iso #{Metanorma::Iso::VERSION}"
       end
 
       def fonts_manifest
@@ -38,12 +37,12 @@ module Metanorma
       end
 
       def use_presentation_xml(ext)
-        return true if [:html_alt, :sts, :isosts].include?(ext)
+        return true if %i[html_alt sts isosts].include?(ext)
 
         super
       end
 
-      def output(isodoc_node, inname, outname, format, options={})
+      def output(isodoc_node, inname, outname, format, options = {})
         options_preprocess(options)
         case format
         when :html
@@ -71,7 +70,6 @@ module Metanorma
           super
         end
       end
-
     end
   end
 end

data/lib/metanorma/iso/relaton-iso.rng

@@ -9,6 +9,7 @@
       <optional>
         <ref name="docsubtype"/>
       </optional>
+      <ref name="flavor"/>
       <optional>
         <ref name="horizontal"/>
       </optional>
@@ -103,6 +104,7 @@
         <value>technical-corrigendum</value>
         <value>directive</value>
         <value>committee-document</value>
+        <value>addendum</value>
       </choice>
     </define>
     <define name="DocumentSubtype">

data/lib/metanorma/iso/section.rb

@@ -2,7 +2,7 @@ require "htmlentities"
 require "uri" if /^2\./.match?(RUBY_VERSION)
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def clause_parse(attrs, xml, node)
         node.option? "appendix" and return appendix_parse(attrs, xml, node)

data/lib/metanorma/iso/validate.rb

@@ -10,7 +10,7 @@ require "jing"
 require "iev"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def isosubgroup_validate(root)
         root.xpath("//technical-committee/@type").each do |t|
@@ -139,7 +139,8 @@ module Metanorma
       def doctype_validate(_xmldoc)
         %w(international-standard technical-specification technical-report
            publicly-available-specification international-workshop-agreement
-           guide amendment technical-corrigendum committee-document recommendation)
+           guide amendment technical-corrigendum committee-document addendum
+           recommendation)
           .include? @doctype or
           @log.add("Document Attributes", nil,
                    "#{@doctype} is not a recognised document type")

data/lib/metanorma/iso/validate_image.rb

@@ -1,5 +1,5 @@
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       # DRG directives 3.7; but anticipated by standoc
       def subfigure_validate(xmldoc)

data/lib/metanorma/iso/validate_list.rb

@@ -1,5 +1,5 @@
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-lists
       def listcount_validate(doc)

data/lib/metanorma/iso/validate_requirements.rb

@@ -1,7 +1,7 @@
 require "metanorma-standoc"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       REQUIREMENT_RE_STR = <<~REGEXP.freeze
         \\b

data/lib/metanorma/iso/validate_section.rb

@@ -1,7 +1,7 @@
 require "nokogiri"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def section_validate(doc)
         unless %w(amendment technical-corrigendum).include? @doctype

data/lib/metanorma/iso/validate_style.rb

@@ -3,7 +3,7 @@ require "nokogiri"
 require "tokenizer"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def extract_text(node)
         node.nil? and return ""

data/lib/metanorma/iso/validate_title.rb

@@ -1,7 +1,7 @@
 require "metanorma-standoc"
 
 module Metanorma
-  module ISO
+  module Iso
     class Converter < Standoc::Converter
       def title_lang_part(doc, part, lang)
         doc.at("//bibdata/title[@type='title-#{part}' and @language='#{lang}']")

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
-  module ISO
-    VERSION = "2.8.7".freeze
+  module Iso
+    VERSION = "2.8.8".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -6,7 +6,7 @@ require "metanorma/iso/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "metanorma-iso"
-  spec.version       = Metanorma::ISO::VERSION
+  spec.version       = Metanorma::Iso::VERSION
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features|bin|.github)/}) \
     || f.match(%r{Rakefile|bin/rspec})
   end
-  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.test_files = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
   spec.add_dependency "metanorma-standoc", "~> 2.9.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iso
 version: !ruby/object:Gem::Version
-  version: 2.8.7
+  version: 2.8.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc