metanorma-itu 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769b5dfa383417d0e825e49c1fdfc4cbf94cf3beae6664059b726f744f0ce644
-  data.tar.gz: 747f979885c03d835f9ebac18dd037e39101182ecb7d419516ea43db44cee2ef
+  metadata.gz: e0b6bcda9ee8aa042d7647e9b8865c7bac5a07943541e6278ac311ae35b7ecdb
+  data.tar.gz: 2c2916e7706336f89a13d65cd63022a0a2288a576957684856134f482ecfa7eb
 SHA512:
-  metadata.gz: '099437ac36008d722c6c6e1838f9a59e11bbff63973446b1c8259260c5785497972d92089708df367dfc3cf90eaa5faf2292f5267d38a125494114374e51e6d2'
-  data.tar.gz: 88a1bca6a28030750b72e438453c8f5aeaaafe8aaff00fef2e616f81b97fd5c7a7218e8f8e4e0a70b48c4226f4c5b99ececcfe4e261f62ea142a04ba43e47b2e
+  metadata.gz: 3905f473b483696859238779600e0074eb3fb668cef4898ce288d62be053339426afee23d8c6e32e36c8a706dbe0be0f60c5626181c45f78cea30b2baa9e7a23
+  data.tar.gz: 21907c33e9ad329cf2852b10ccce61b9ca407c9fb0e01896a69c60d380d665df3366721cd155db14c48549b1b350c6f74922fe2213f5fdef6c21468a9ad2d586

data/lib/asciidoctor/itu/cleanup.rb

@@ -6,6 +6,71 @@ module Asciidoctor
         x.xpath("//*[@inline-header]").each do |h|
           h.delete("inline-header")
         end
+        insert_missing_sections(x) unless @no_insert_missing_sections
+      end
+
+      def table_cleanup(xmldoc)
+        super
+        xmldoc.xpath("//thead/tr[1]/th | //thead/tr[1]/td").each do |t|
+          text = t.at("./descendant::text()") or next
+          text.replace(text.text.titlecase)
+        end
+      end
+
+      def insert_missing_sections(x)
+        insert_scope(x)
+        insert_norm_ref(x)
+        insert_terms(x)
+        insert_symbols(x)
+        insert_conventions(x)
+      end
+
+      def insert_scope(x)
+        x.at("./*/sections") or
+          x.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
+          "<sections><sentinel/></sections>"
+        x.at("./*/sections/*") or x.at("./*/sections") << "<sentinel/>"
+        ins = x.at("//sections").children.first
+        unless x.at("//sections/clause/title[text() = 'Scope']")
+          ins.previous = "<clause><title>Scope</title><p>"\
+            "#{@labels['clause_empty']}</p></clause>"
+        end
+        x&.at("//sentinel")&.remove
+      end
+
+      def insert_norm_ref(x)
+        x.at("//bibliography") or x.at("./*/annex[last()] | ./*/sections").next =
+          "<bibliography><sentinel/></bibliography>"
+        ins = x.at("//bibliography").children.first
+        unless x.at("//bibliography/references/title[text() = 'References']")
+          ins.previous = "<references><title>References</title><p>"\
+            "#{@labels['clause_empty']}</p></references>"
+        end
+        x&.at("//sentinel")&.remove
+      end
+
+      def insert_terms(x)
+        ins =  x.at("//sections/clause/title[text() = 'Scope']")
+        unless x.at("//sections/terms")
+          ins.next = "<terms><title>Definitions</title><p>"\
+            "#{@labels['clause_empty']}</p></terms>"
+        end
+      end
+
+      def insert_symbols(x)
+        ins =  x.at("//terms")
+        unless x.at("//sections//definitions")
+          ins.next = "<definitions><title>Definitions</title><p>"\
+            "#{@labels['clause_empty']}</p></definitions>"
+        end
+      end
+
+      def insert_conventions(x)
+        ins =  x.at("//sections//definitions")
+        unless x.at("//sections/clause/title[text() = 'Conventions']")
+          ins.next = "<clause><title>Conventions</title><p>"\
+            "#{@labels['clause_empty']}</p></clause>"
+        end
       end
 
       def cleanup(xmldoc)
@@ -19,7 +84,7 @@ module Asciidoctor
           next unless n.text?
           n.replace(HTMLEntities.new.encode(
             n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
-                    gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
+            gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
         end
         xmldoc
       end
@@ -48,7 +113,8 @@ module Asciidoctor
 
       def pub_class(bib)
         return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ITU']")
-        return 1 if bib.at("#{PUBLISHER}[name = 'International Telecommunication Union']")
+        return 1 if bib.at("#{PUBLISHER}[name = 'International "\
+                           "Telecommunication Union']")
         return 2 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
         return 2 if bib.at("#{PUBLISHER}[name = 'International Organization "\
                            "for Standardization']")
@@ -56,7 +122,8 @@ module Asciidoctor
         return 3 if bib.at("#{PUBLISHER}[name = 'International "\
                            "Electrotechnical Commission']")
         return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
-                           "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
+                           "@type = 'metanorma' or @type = 'ISSN' or @type = "\
+                           "'ISBN')]")
         5
       end
 
@@ -73,8 +140,8 @@ module Asciidoctor
       def sort_biblio_key(bib)
         pubclass = pub_class(bib)
         num = bib&.at("./docnumber")&.text
-        id = bib&.at("./docidentifier[not(@type = 'DOI' or "\
-                           "@type = 'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
+        id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
+                     "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
         metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
         abbrid = metaid unless /^\[\d+\]$/.match(metaid)
         type = id['type'] if id

data/lib/asciidoctor/itu/converter.rb

@@ -29,6 +29,8 @@ module Asciidoctor
       def init(node)
         super
         @smartquotes = node.attr("smartquotes") == "true"
+        @no_insert_missing_sections = doctype(node) != "recommendation" ||
+          node.attr("legacy-do-not-insert-missing-sections")
       end
 
       def makexml(node)
@@ -63,6 +65,7 @@ module Asciidoctor
           word_converter(node).convert filename unless node.attr("nodoc")
           pdf_converter(node).convert filename unless node.attr("nodoc")
         end
+        @log.write(@filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end
@@ -146,11 +149,11 @@ module Asciidoctor
       end
 
       def html_extract_attributes(node)
-        super.merge(hierarchical_assets: node.attr("hierarchical-assets"))
+        super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
       end
 
       def doc_extract_attributes(node)
-        super.merge(hierarchical_assets: node.attr("hierarchical-assets"))
+        super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
       end
 
       def html_converter(node)

data/lib/asciidoctor/itu/i18n-en.yaml

@@ -9,4 +9,8 @@ external_terms_boilerplate:
 no_terms_boilerplate:
   None.
 symbols_boilerplate:
-  "This Recommendation uses the following abbreviations:"
+  "This Recommendation uses the following abbreviations and acronyms:"
+norm_empty_pref:
+  None.
+clause_empty:
+  None.

data/lib/asciidoctor/itu/isodoc.rng

@@ -645,6 +645,11 @@
     <optional>
       <attribute name="script"/>
     </optional>
+    <optional>
+      <attribute name="inline-header">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <optional>
       <attribute name="obligation">
         <choice>

data/lib/asciidoctor/itu/validate.rb

@@ -12,13 +12,13 @@ module Asciidoctor
         recommendation-corrigendum recommendation-errata recommendation-annex 
         focus-group implementers-guide technical-paper technical-report 
         joint-itu-iso-iec).include? doctype or
-          warn "Document Attributes: #{doctype} is not a recognised document type"
+        @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(in-force superseded in-force-prepublished withdrawn draft).include? stage or
-          warn "Document Attributes: #{stage} is not a recognised status"
+          @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
       end
 
       def content_validate(doc)
@@ -27,38 +27,107 @@ module Asciidoctor
         itu_identifier_validate(doc)
         bibdata_validate(doc.root)
         termdef_style(doc.root)
+        title_validate1(doc.root)
+        requirement_validate(doc.root)
+        numbers_validate(doc.root)
+      end
+
+      # Editing Guidelines 6.3
+      def title_validate1(xmldoc)
+        t = xmldoc.at("//bibdata/title")&.text
+        xmldoc.xpath("//bibdata/series/title").each do |s|
+          series = s.text.sub(/^[A-Z]: /, "")
+          t.downcase.include?(series.downcase) and
+            @log.add("Document Attributes", nil, "Title includes series name #{series}")
+        end
+      end
+
+      def extract_text(node)
+        return "" if node.nil?
+        node1 = Nokogiri::XML.fragment(node.to_s)
+        node1.xpath("//link | //locality").each(&:remove)
+        ret = ""
+        node1.traverse { |x| ret += x.text if x.text? }
+        ret
+      end
+
+      # Editing Guidelines 7
+      def requirement_validate(xmldoc)
+        xmldoc.xpath("//preface/*").each do |c|
+          extract_text(c).split(/\.\s+/).each do |t|
+            /\b(shall|must)\b/i.match(t) and
+              @log.add("Style", c, "Requirement possibly in preface: #{t.strip}")
+          end
+        end
+      end
+
+      # Editing Guidelines 9.4.3
+      def numbers_validate(xmldoc)
+        xmldoc.xpath("//clause | //preface/* | //annex").each do |x|
+          xx = x.dup
+          xx.xpath("./clause").each { |c| c.remove }
+          style_two_regex_not_prev(x, extract_text(xx),
+                                   /^(?<num>-?[0-9][0-9,. ]{3,})$/,
+                                   %r{(\bISO|\bIEC|\bIEEE/)$},
+                                   "number not broken up in threes by apostrophe")
+        end
+      end
+
+      def style_two_regex_not_prev(n, text, re, re_prev, warning)
+        return if text.nil?
+        arr = text.split(/\W+/)
+        arr.each_index do |i|
+          m = re.match arr[i]
+          m_prev = i.zero? ? nil : re_prev.match(arr[i - 1])
+          if !m.nil? && m_prev.nil?
+            @log.add("Style", n, "#{warning}: #{m[:num]}")
+          end
+        end
       end
 
       def approval_validate(xmldoc)
         s = xmldoc.at("//bibdata/ext/recommendationstatus/approvalstage") || return
         process = s["process"]
         if process == "aap" and %w(determined in-force).include? s.text
-          warn "Recommendation Status #{s.text} inconsistent with AAP"
+          @log.add("Document Attributes", nil, "Recommendation Status #{s.text} inconsistent with AAP")
         end
         if process == "tap" and !%w(determined in-force).include? s.text
-          warn "Recommendation Status #{s.text} inconsistent with TAP"
+          @log.add("Document Attributes", nil, "Recommendation Status #{s.text} inconsistent with TAP")
         end
       end
 
       def itu_identifier_validate(xmldoc)
         s = xmldoc.xpath("//bibdata/docidentifier[@type = 'ITU']").each do |x|
           /^ITU-[RTF] [AD-VX-Z]\.[0-9]+$/.match(x.text) or
-            warn("#{x.text} does not match ITU document identifier conventions")
+            @log.add("Style", nil, "#{x.text} does not match ITU document identifier conventions")
         end
       end
 
+      def section_validate(doc)
+        super
+        section_check(doc.root)
+      end
+
+      # Editing Guidelines 7.2, 7.3
+      def section_check(xmldoc)
+        xmldoc.at("//bibdata/abstract") or
+          @log.add("Style", nil, "No Summary has been provided")
+        xmldoc.at("//bibdata/keywords") or
+          @log.add("Style", nil, "No Keywords have been provided")
+      end
+
       def termdef_style(xmldoc)
         xmldoc.xpath("//term").each do |t|
           para = t.at("./definition") || return
           term = t.at("./preferred").text
-          termdef_warn(term, /^[A-Z][a-z]+/, term, "term is not lowercase")
-          termdef_warn(para.text, /^[a-z]/, term, "term definition does not start with capital")
-          termdef_warn(para.text, /[^.]$/, term, "term definition does not end with period")
+          termdef_warn(term, /^[A-Z][a-z]+/, t, term, "term is not lowercase")
+          termdef_warn(para.text, /^[a-z]/, t, term, "term definition does not start with capital")
+          termdef_warn(para.text, /[^.]$/, t, term, "term definition does not end with period")
         end
       end
 
-      def termdef_warn(text, re, term, msg)
-        re.match(text) && warn("ITU style: #{term}: #{msg}")
+      def termdef_warn(text, re, t, term, msg)
+        re.match(text) && @log.add("Style", t, "#{term}: #{msg}")
       end
     end
   end

data/lib/isodoc/itu/base_convert.rb

@@ -47,12 +47,6 @@ module IsoDoc
         l10n("#{@note_lbl} #{n[:label]} – ")
       end
 
-      def formula_where(dl, out)
-        return unless dl
-        out.p { |p| p << l10n("#{@where_lbl}:") }
-        parse(dl, out)
-      end
-
       def prefix_container(container, linkend, _target)
         l10n("#{linkend} #{@labels["in"]} #{anchor(container, :xref)}")
       end

data/lib/isodoc/itu/html/html_itu_titlepage.html

@@ -1,8 +1,8 @@
-<div class="document-stage-band" id='{{ stage | downcase | replace: " ", "-" }}-band'>
+<div class="document-stage-band" id="{{ stage | downcase | replace: ' ', '-' }}-band">
   <p class="document-stage">{{ stage }}</p>
 </div>
 
-<div class="document-type-band" id='{{ doctype | downcase | replace: " ", "-" }}-band'>
+<div class="document-type-band" id="{{ doctype | downcase | replace: ' ', '-' }}-band">
   <p class="document-type">ITU {{ doctype }}</p>
 </div>
 

data/lib/isodoc/itu/html/htmlstyle.scss

@@ -465,6 +465,12 @@ a.footnote-number {
   @include formulaBlock(#f6f6f6);
 }
 
+dl.formula_dl {
+background-color: #f6f6f6;
+margin-left: 1.4cm;
+margin-right: 1.4cm;
+}
+
 
 .contact-info {
   padding: 2em;

data/lib/isodoc/itu/html/itu.scss

@@ -714,6 +714,10 @@ p.Formula, li.Formula, div.Formula
 	mso-fareast-font-family:$bodyfont;
 	mso-bidi-font-family:$bodyfont;
 	mso-ansi-language:EN-GB;}
+table.formula_dl {
+        margin-left:1.4cm;
+        margin-right:1.4cm;
+}
 /* definition list */
 p.enumlev1, li.enumlev1, div.enumlev1
 	{mso-style-name:enumlev1;

data/lib/isodoc/itu/i18n-en.yaml

@@ -11,3 +11,5 @@ formula: Equation
 inequality: Inequality
 annex_subclause: Clause
 in: in
+where: "where:"
+blankclause: This clause is intentionally left blank.

data/lib/isodoc/itu/metadata.rb

@@ -92,7 +92,7 @@ module IsoDoc
         isoxml.xpath(ns("//bibdata/keyword")).each do |kw|
           keywords << kw.text
         end
-        set(:keywords, keywords)
+        set(:keywords, keywords.sort)
       end
 
       def ip_notice_received(isoxml, _out)

data/lib/isodoc/itu/ref.rb

@@ -11,9 +11,6 @@ module IsoDoc
         out.div do |div|
           num = num + 1
           clause_name(num, @normref_lbl, div, nil)
-          f.elements.reject do |e|
-            %w(reference title bibitem note).include? e.name
-          end.each { |e| parse(e, div) }
           biblio_list(f, div, false)
         end
         num
@@ -65,13 +62,21 @@ module IsoDoc
 
       def render_identifiers(ids)
         ids.map do |id|
-          (id["type"] == "ITU" ?
-           titlecase(id.parent&.at(ns("./ext/doctype"))&.text ||
-                     "recommendation") + " " : "") +
-                    docid_prefix(id["type"], id.text.sub(/^\[/, "").sub(/\]$/, ""))
+          id["type"] == "ITU" ? doctype_title(id) : 
+            docid_prefix(id["type"], id.text.sub(/^\[/, "").sub(/\]$/, ""))
         end.join(" | ")
       end
 
+      def doctype_title(id)
+        type = id.parent&.at(ns("./ext/doctype"))&.text || "recommendation"
+        if type == "recommendation" &&
+            /^(?<prefix>ITU-[A-Z] [A-Z])[ .-]Sup[a-z]*\.[ ]?(?<num>\d+)$/ =~ id.text
+          "#{prefix}-series Recommendations – Supplement #{num}"
+        else
+          "#{titlecase(type)} #{docid_prefix(id["type"], id.text.sub(/^\[/, '').sub(/\]$/, ''))}"
+        end
+      end
+
       def reference_format_start(b, r)
         id = multi_bibitem_ref_code(b)
         r << render_identifiers(id)

data/lib/isodoc/itu/xref.rb

@@ -67,14 +67,15 @@ module IsoDoc
         "-"
       end
 
-      def middle_section_asset_names(d)
-        return super unless @hierarchical_assets
-        middle_sections = "//clause[title = 'Scope'] | "\
+      MIDDLE_SECTIONS = "//clause[title = 'Scope'] | "\
           "//foreword | //introduction | //acknowledgements | "\
           "//references[title = 'References' or title = 'references'] | "\
           "//sections/terms | //preface/clause | "\
-          "//sections/definitions | //clause[parent::sections]"
-        d.xpath(ns(middle_sections)).each do |c|
+          "//sections/definitions | //clause[parent::sections]".freeze
+
+      def middle_section_asset_names(d)
+        return super unless @hierarchical_assets
+        d.xpath(ns(MIDDLE_SECTIONS)).each do |c|
           hierarchical_asset_names(c, @anchors[c["id"]][:label])
         end
       end
@@ -111,6 +112,16 @@ module IsoDoc
                                             t["unnumbered"])
         end
       end
+
+      def sequential_formula_names(clause)
+        clause&.first&.xpath(ns(MIDDLE_SECTIONS))&.each do |c|
+          if c["id"] && @anchors[c["id"]]
+          hierarchical_formula_names(c, @anchors[c["id"]][:label] || @anchors[c["id"]][:xref] || "???")
+          else
+            hierarchical_formula_names(c, "???")
+          end
+        end
+      end
     end
   end
 end

data/lib/metanorma/itu.rb

@@ -3,10 +3,7 @@ require "metanorma/itu/processor"
 
 module Metanorma
   module ITU
-
     ORGANIZATION_NAME_SHORT = "ITU"
     ORGANIZATION_NAME_LONG = "International Telecommunication Union"
-    DOCUMENT_NAMESPACE = "https://open.ribose.com/standards/itu"
-
   end
 end

data/lib/metanorma/itu/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ITU
-    VERSION = "1.0.10"
+    VERSION = "1.0.11"
   end
 end

data/metanorma-itu.gemspec

@@ -38,7 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "= 0.54.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "metanorma", "~> 0.3.0"
   spec.add_development_dependency "vcr", "~> 5.0.0"
   spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-itu
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -192,20 +192,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: metanorma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement