metanorma-itu 2.4.2 → 2.4.4

data/lib/metanorma/itu/cleanup_section.rb

@@ -0,0 +1,150 @@
+module Metanorma
+  module ITU
+    class Converter < Standoc::Converter
+      def sections_cleanup(xml)
+        super
+        insert_missing_sections(xml) unless @no_insert_missing_sections
+        insert_empty_clauses(xml)
+        resolution_inline_header(xml)
+      end
+
+      def resolution_inline_header(xml)
+        @doctype == "resolution" or return
+        xml.xpath("//clause//clause").each do |c|
+          (title = c.at("./title")) && !title.text&.empty? and next
+          c["inline-header"] = true
+        end
+      end
+
+      def insert_missing_sections(xml)
+        xml.at("//metanorma-extension/semantic-metadata/" \
+              "headless[text() = 'true']") and return nil
+        insert_scope(xml)
+        insert_norm_ref(xml)
+        insert_terms(xml)
+        insert_symbols(xml)
+        insert_conventions(xml)
+      end
+
+      def add_id
+        %(id="_#{UUIDTools::UUID.random_create}")
+      end
+
+      def insert_scope(xml)
+        xml.at("./*/sections") or
+          xml.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
+            "<sections><sentinel/></sections>"
+        xml.at("./*/sections/*") or xml.at("./*/sections") << "<sentinel/>"
+        ins = xml.at("//sections").elements.first
+        xml.at("//sections/clause[@type = 'scope']") or
+          ins.previous =
+            "<clause type='scope' #{add_id}><title>#{@i18n.scope}</title><p>" \
+            "#{@i18n.clause_empty}</p></clause>"
+        xml.at("//sentinel")&.remove
+      end
+
+      def insert_norm_ref(xml)
+        xml.at("//bibliography") or
+          xml.at("./*/annex[last()] | ./*/sections").next =
+            "<bibliography><sentinel/></bibliography>"
+        ins = xml.at("//bibliography").elements.first
+        xml.at("//bibliography/references[@normative = 'true']") or
+          ins.previous = "<references #{add_id} normative='true'>" \
+                         "<title>#{@i18n.normref}</title></references>"
+        xml.at("//sentinel")&.remove
+      end
+
+      def insert_terms(xml)
+        ins = xml.at("//sections/clause[@type = 'scope']")
+        xml.at("//sections//terms") or
+          ins.next = "<terms #{add_id}><title>#{@i18n.termsdef}</title></terms>"
+      end
+
+      def insert_symbols(xml)
+        ins =  xml.at("//sections/terms") ||
+          xml.at("//sections/clause[descendant::terms]")
+        unless xml.at("//sections//definitions")
+          ins.next = "<definitions #{add_id}>" \
+                     "<title>#{@i18n.symbolsabbrev}</title></definitions>"
+        end
+      end
+
+      def insert_conventions(xml)
+        ins =  xml.at("//sections//definitions") ||
+          xml.at("//sections/clause[descendant::definitions]")
+        unless xml.at("//sections/clause[@type = 'conventions']")
+          ins.next = "<clause #{add_id} type='conventions'>" \
+                     "<title>#{@i18n.conventions}</title><p>" \
+                     "#{@i18n.clause_empty}</p></clause>"
+        end
+      end
+
+      def insert_empty_clauses(xml)
+        xml.xpath("//terms[not(./term)][not(.//terms)]").each do |c|
+          insert_empty_clauses1(c, @i18n.clause_empty)
+        end
+        xml.xpath("//definitions[not(./dl)]").each do |c|
+          insert_empty_clauses1(c, @i18n.clause_empty)
+        end
+      end
+
+      def insert_empty_clauses1(clause, text)
+        clause.at("./p") and return
+        ins = clause.at("./title") or return
+        ins.next = "<p>#{text}</p>"
+      end
+
+      def termdef_boilerplate_cleanup(xmldoc); end
+
+      def terms_extract(div)
+        internal = div.at("./terms[@type = 'internal']/title")
+        external = div.at("./terms[@type = 'external']/title")
+        [internal, external]
+      end
+
+      def term_defs_boilerplate(div, _source, _term, _preface, _isodoc)
+        internal, external = terms_extract(div.parent)
+        internal&.next_element&.name == "term" and
+          internal.next = "<p>#{@i18n.internal_terms_boilerplate}</p>"
+        internal and internal&.next_element == nil and
+          internal.next = "<p>#{@i18n.no_terms_boilerplate}</p>"
+        external&.next_element&.name == "term" and
+          external.next = "<p>#{@i18n.external_terms_boilerplate}</p>"
+        external and external&.next_element == nil and
+          external.next = "<p>#{@i18n.no_terms_boilerplate}</p>"
+        !internal and !external and
+          %w(term terms).include? div&.next_element&.name and
+          div.next = "<p>#{@i18n.term_def_boilerplate}</p>"
+      end
+
+      def section_names_terms_cleanup(xml)
+        super
+        replace_title(
+          xml, "//terms[@type = 'internal'] | " \
+               "//clause[./terms[@type = 'internal']]" \
+               "[not(./terms[@type = 'external'])]",
+          @i18n&.internal_termsdef
+        )
+        replace_title(
+          xml, "//terms[@type = 'external'] | " \
+               "//clause[./terms[@type = 'external']]" \
+               "[not(./terms[@type = 'internal'])]",
+          @i18n&.external_termsdef
+        )
+      end
+
+      def symbols_cleanup(xmldoc)
+        sym = xmldoc.at("//definitions/title")
+        sym and sym&.next_element&.name == "dl" and
+          sym.next = "<p>#{@i18n.symbols_boilerplate}</p>"
+      end
+
+      def sections_names_cleanup(xml)
+        super
+        t = xml.at("//preface//abstract") or return
+        t["id"] == "_summary" and
+          replace_title(xml, "//preface//abstract", @i18n&.summary)
+      end
+    end
+  end
+end

data/lib/metanorma/itu/converter.rb

@@ -36,7 +36,8 @@ module Metanorma
       end
 
       def doctype(node)
-        ret = node.attr("doctype")&.gsub(/\s+/, "-")&.downcase || "recommendation"
+        ret = node.attr("doctype")&.gsub(/\s+/, "-")&.downcase ||
+          "recommendation"
         ret = "recommendation" if ret == "article"
         ret
       end
@@ -87,7 +88,7 @@ module Metanorma
 
       def sectiontype(node, level = true)
         ret = super
-        hdr = sectiontype_streamline(node&.attr("heading")&.downcase)
+        hdr = sectiontype_streamline(node.attr("heading")&.downcase)
         return nil if ret == "terms and definitions" &&
           hdr != "terms and definitions" && node.level > 1
         return nil if ret == "symbols and abbreviated terms" &&
@@ -120,14 +121,16 @@ module Metanorma
         node.option?("unnumbered") and attrs[:unnumbered] = true
         case sectiontype1(node)
         when "conventions" then attrs = attrs.merge(type: "conventions")
-        when "history"
-          attrs[:preface] and attrs = attrs.merge(type: "history")
-        when "source"
-          attrs[:preface] and attrs = attrs.merge(type: "source")
+        when "history", "source"
+          attrs[:preface] and attrs = attrs.merge(type: sectiontype1(node))
         end
         super
       end
 
+      def document_scheme(node)
+        super || "current"
+      end
+
       def html_extract_attributes(node)
         super.merge(hierarchicalassets:
                     node.attr("hierarchical-object-numbering"))
@@ -141,7 +144,8 @@ module Metanorma
       def presentation_xml_converter(node)
         IsoDoc::ITU::PresentationXMLConvert
           .new(html_extract_attributes(node)
-          .merge(output_formats: ::Metanorma::ITU::Processor.new.output_formats))
+          .merge(output_formats: ::Metanorma::ITU::Processor.new
+          .output_formats))
       end
 
       def html_converter(node)

data/lib/metanorma/itu/front.rb

@@ -7,7 +7,7 @@ module Metanorma
   module ITU
     class Converter < Standoc::Converter
       def metadata_status(node, xml)
-        stage = (node.attr("status") || node.attr("docstage") || "published")
+        stage = node.attr("status") || node.attr("docstage") || "published"
         stage = "draft" if node.attributes.has_key?("draft")
         xml.status do |s|
           s.stage stage
@@ -36,9 +36,8 @@ module Metanorma
 
       def title_otherlangs(node, xml)
         node.attributes.each do |k, v|
-          next unless /^(annex)?title-(?<lang>.+)$/ =~ k
-          next if lang == @lang
-
+          /^(?:annex)?title-(?<lang>.+)$/ =~ k or next
+          lang == @lang and next
           type = /^annex/.match?(k) ? "annex" : "main"
           xml.title **attr_code(title_attr(type, lang)) do |t|
             t << Metanorma::Utils::asciidoc_sub(v)
@@ -49,7 +48,8 @@ module Metanorma
       def title(node, xml)
         title_defaultlang(node, xml)
         title_otherlangs(node, xml)
-        %w(subtitle amendment-title corrigendum-title).each do |t|
+        %w(subtitle amendment-title corrigendum-title collection-title
+           slogan-title).each do |t|
           other_title_defaultlang(node, xml, t)
           other_title_otherlangs(node, xml, t)
         end
@@ -64,9 +64,8 @@ module Metanorma
 
       def other_title_otherlangs(node, xml, type)
         node.attributes.each do |k, v|
-          next unless m = /^#{type}-(?<lang>.+)$/.match(k)
-          next if m[:lang] == @lang
-
+          m = /^#{type}-(?<lang>.+)$/.match(k) or next
+          m[:lang] == @lang and next
           xml.title **attr_code(title_attr(type.sub(/-title/, ""),
                                            m[:lang])) do |t|
             t << Metanorma::Utils::asciidoc_sub(v)
@@ -87,6 +86,7 @@ module Metanorma
       end
 
       def metadata_committee(node, xml)
+        metadata_sector(node, xml)
         metadata_committee1(node, xml, "")
         suffix = 2
         while node.attr("bureau_#{suffix}")
@@ -95,6 +95,13 @@ module Metanorma
         end
       end
 
+      def metadata_sector(node, xml)
+        s = node.attr("sector") or return
+        xml.editorialgroup do |a|
+          a.sector { |x| x << s }
+        end
+      end
+
       def metadata_committee1(node, xml, suffix)
         xml.editorialgroup do |a|
           a.bureau ( node.attr("bureau#{suffix}") || "T")
@@ -123,23 +130,17 @@ module Metanorma
       end
 
       def metadata_series(node, xml)
-        node.attr("series") and
-          xml.series **{ type: "main" } do |s|
-            s.title node.attr("series")
-          end
-        node.attr("series1") and
-          xml.series **{ type: "secondary" } do |s|
-            s.title node.attr("series1")
-          end
-        node.attr("series2") and
-          xml.series **{ type: "tertiary" } do |s|
-            s.title node.attr("series2")
-          end
+        { series: "main", series1: "secondary", series2: "tertiary" }
+          .each do |k, v|
+          node.attr(k.to_s) and
+            xml.series **{ type: v } do |s|
+              s.title node.attr(k.to_s)
+            end
+        end
       end
 
       def metadata_recommendationstatus(node, xml)
-        return unless node.attr("recommendation-from")
-
+        node.attr("recommendation-from") or return
         xml.recommendationstatus do |s|
           s.from node.attr("recommendation-from")
           s.to node.attr("recommendation-to") if node.attr("recommendation-to")
@@ -190,6 +191,18 @@ module Metanorma
         end
       end
 
+      def metadata_coverpage_images(node, xml)
+        %w(coverpage-image).each do |n|
+          if a = node.attr(n)
+            xml.send n do |c|
+              a.split(",").each do |x|
+                c.image src: x
+              end
+            end
+          end
+        end
+      end
+
       def metadata_ext(node, xml)
         metadata_doctype(node, xml)
         metadata_subdoctype(node, xml)
@@ -199,6 +212,7 @@ module Metanorma
         metadata_ip_notice(node, xml)
         metadata_techreport(node, xml)
         structured_id(node, xml)
+        metadata_coverpage_images(node, xml)
       end
     end
   end

data/lib/metanorma/itu/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ITU
-    VERSION = "2.4.2".freeze
+    VERSION = "2.4.4".freeze
   end
 end

data/metanorma-itu.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 2.8.2"
+  spec.add_dependency "metanorma-standoc", "~> 2.8.4"
+  spec.add_dependency "pubid-itu"
   spec.add_dependency "twitter_cldr", ">= 3.0.0"
   spec.add_dependency "tzinfo-data" # we need this for windows only
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-itu
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.2
+        version: 2.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.2
+        version: 2.8.4
+- !ruby/object:Gem::Dependency
+  name: pubid-itu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: twitter_cldr
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +296,7 @@ files:
 - lib/isodoc/itu/pdf_convert.rb
 - lib/isodoc/itu/presentation_bibdata.rb
 - lib/isodoc/itu/presentation_preface.rb
+- lib/isodoc/itu/presentation_ref.rb
 - lib/isodoc/itu/presentation_xml_convert.rb
 - lib/isodoc/itu/ref.rb
 - lib/isodoc/itu/terms.rb
@@ -296,6 +311,7 @@ files:
 - lib/metanorma/itu/biblio.rng
 - lib/metanorma/itu/boilerplate.adoc
 - lib/metanorma/itu/cleanup.rb
+- lib/metanorma/itu/cleanup_section.rb
 - lib/metanorma/itu/converter.rb
 - lib/metanorma/itu/front.rb
 - lib/metanorma/itu/front_id.rb