metanorma-standoc 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683c26774d9f30458126ef60b1ffc391dd7b51ae3826d4a4095720a55791226e
-  data.tar.gz: 540787307ebd521e3a7f506d91b75cad96436fb5c2d5bc308fe86bc52d91f540
+  metadata.gz: 8ebe9c752511841d783fa0d9820ee7bd26448703e6990bbd406ae0d92ab35417
+  data.tar.gz: b6e82ef1d270969216902f745314145917cbdc376fe92fe11b76964cdd8bb6f1
 SHA512:
-  metadata.gz: d07b8c8f23671182a89408e152a09d5c57b94df538b94f03fa155198547d8ff5b901081e0cf2f29a184de87f20527a042d91194e864b217f20673163a7de2568
-  data.tar.gz: e388042127a3618b54c45ab1d064db00f0b1e4c824266eefeaa0d8837ea9ca858f094c3a633b79f8ea12103ab8ac125b5be1327f47e6759fe4e1cd69853b9881
+  metadata.gz: 7b35e03b90cf332d1c100003d1e5bd72a524ffb085eb3b85428ebaac975f51d69562404e31f761894b22d51a9245be804f27a6e230299ed904ab497ebfc1d3c5
+  data.tar.gz: 29a42e39bbc67f18b07d557f32da4dbd3a6747f913108b4cfa2a74f610484cfd114d127e78fe8b21e4bf45ef255de955947967402f78d4f4cf3bfb07b77a6694

data/lib/isodoc/html/htmlstyle.css

@@ -624,7 +624,7 @@ body pre * {
   }
 }
 
-div.figure .FigureTitle, div.figure .figure-title {
+div.figure figcaption {
   font-weight: 700;
   font-size: 1em;
   text-align: center;
@@ -1071,7 +1071,7 @@ table table.plain, table table.plain th, table table.plain td {
   font-size: 0.95em;
 }
 
-p.TableTitle {
+table > caption {
   text-align: center;
   margin-top: 2.5em;
   font-weight: 400;

data/lib/isodoc/html/htmlstyle.scss

@@ -368,7 +368,7 @@ table {
   @include table(1px solid black);
 }
 
-p.TableTitle {
+table > caption {
   text-align: center;
   margin-top: 2.5em;
   font-weight: 400;

data/lib/metanorma/{standoc/cleanup_amend.rb → cleanup/amend.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Amend
       def change_clauses(docxml)
         docxml.xpath("//clause[@change]").each do |c|
           create_amend(c)

data/lib/metanorma/{standoc/cleanup_asciibib.rb → cleanup/asciibib.rb}

@@ -2,7 +2,7 @@ require "relaton_bib"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Asciibib
       def ref_dl_cleanup(xmldoc)
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next

data/lib/metanorma/{standoc/cleanup_attachment.rb → cleanup/attachment.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Attachment
       def attachment_cleanup(xmldoc)
         xmldoc.xpath("//bibitem[uri/@type = 'attachment']").each do |b|
           b["hidden"] = "true"

data/lib/metanorma/{standoc/cleanup_bibdata.rb → cleanup/bibdata.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Bibdata
       def bibdata_cleanup(xmldoc)
         bibdata_anchor_cleanup(xmldoc)
         bibdata_docidentifier_cleanup(xmldoc)
@@ -120,7 +120,7 @@ module Metanorma
       end
 
       def hdr2bibitem(hdr)
-        xml = isolated_asciidoctor_convert(hdr[:text],
+        xml = @conv.isolated_asciidoctor_convert(hdr[:text],
                                            backend: hdr2bibitem_type(hdr),
                                            header_footer: true)
         b = Nokogiri::XML(xml).at("//xmlns:bibdata")
@@ -222,6 +222,8 @@ module Metanorma
           p.nil? || p.text.strip.empty? and c.remove
         end
       end
+
+      def docidentifier_cleanup(xmldoc); end
     end
   end
 end

data/lib/metanorma/{standoc/cleanup_bibitem.rb → cleanup/bibitem.rb}

@@ -1,8 +1,10 @@
-require_relative "cleanup_attachment"
+require_relative "attachment"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Bibitem
+      include Attachment
+
       def formattedref_spans(xmldoc)
         xmldoc.xpath("//bibitem[formattedref//span]").each do |b|
           ret = new_bibitem_from_formattedref_spans(b)
@@ -14,7 +16,7 @@ module Metanorma
       end
 
       def new_bibitem_from_formattedref_spans(bib)
-        ret = SpansToBibitem.new(bib).convert
+        ret = Metanorma::Standoc::Cleanup::SpansToBibitem.new(bib).convert
         ret.err.each do |e|
           @log.add(e[:fatal] ? "STANDOC_52" : "STANDOC_53",
                    bib, params: [e[:msg]])
@@ -26,7 +28,7 @@ module Metanorma
         merge_bibitem_from_formattedref_span_attrs(bib, new)
         if bib.at("./title") && bib["amend"]
           # there already is a fetched record here: merge
-          bib.children = MergeBibitems
+          bib.children = Metanorma::Standoc::Cleanup::MergeBibitems
             .new(bib.to_xml, new.to_xml).merge.to_noko.children
         elsif bib.at("./title") # replace record
           bib.children = new.children.to_xml
@@ -135,11 +137,11 @@ module Metanorma
       def fetch_local_bibitem(xmldoc)
         xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]")
           .each do |b|
-          uri = b&.at("./uri[@type = 'citation']")&.text
-          bibitem = read_local_bibitem(uri) or next
-          bibitem["id"] = b["id"]
-          bibitem["anchor"] = b["anchor"]
-          b.replace(bibitem)
+            uri = b&.at("./uri[@type = 'citation']")&.text
+            bibitem = read_local_bibitem(uri) or next
+            bibitem["id"] = b["id"]
+            bibitem["anchor"] = b["anchor"]
+            b.replace(bibitem)
         end
       end
 

data/lib/metanorma/{standoc/cleanup_block.rb → cleanup/block.rb}

@@ -3,7 +3,7 @@ require "htmlentities"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Block
       def para_cleanup(xmldoc)
         ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
          "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
@@ -187,9 +187,9 @@ module Metanorma
         source_markup_prep(node).each_slice(4).map.with_object([]) do |a, acc|
           acc << safe_noko(a[0], node.document)
           a.size == 4 or next
-          acc << isolated_asciidoctor_convert(
+          acc << @conv.isolated_asciidoctor_convert(
             "{blank} #{a[2]}", doctype: :inline,
-                               backend: backend&.to_sym || :standoc
+                               backend: @conv.backend&.to_sym || :standoc
           ).strip
         end.join
       end

data/lib/metanorma/{standoc/cleanup_boilerplate.rb → cleanup/boilerplate.rb}

@@ -1,9 +1,9 @@
-require_relative "cleanup_terms_boilerplate"
-require_relative "cleanup_boilerplate_liquid"
+require_relative "terms_boilerplate"
+require_relative "boilerplate_liquid"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Boilerplate
       def norm_ref_preface(ref, isodoc)
         ins = norm_ref_boilerplate_insert_location(ref)
         ins2 = norm_ref_process_boilerplate_note(ref)
@@ -37,13 +37,9 @@ module Metanorma
         ref.at("./title")
       end
 
-      NORM_REF =
-        "//bibliography/references[@normative = 'true'][not(@hidden)] | " \
-        "//bibliography/clause[.//references[@normative = 'true']]".freeze
-
       def dup_with_namespace(elem)
         ret = elem.dup
-        ret.add_namespace(nil, xml_namespace)
+        ret.add_namespace(nil, @conv.xml_namespace)
         ret
       end
 
@@ -52,7 +48,8 @@ module Metanorma
         # in termdef_boilerplate_insert and initial_boilerplate
         xmldoc.at("//metanorma-extension/semantic-metadata/" \
                   "headless[text() = 'true']") and return nil
-        @isodoc ||= isodoc(@lang, @script, @locale)
+        @isodoc ||= @conv.isodoc(@lang, @script, @locale)
+        @i18n = @isodoc.i18n
         isodoc_bibdata_parse(xmldoc)
         @isodoc
       end
@@ -189,7 +186,7 @@ module Metanorma
       end
 
       def boilerplate_file_restructure(file)
-        ret = adoc2xml(file, backend.to_sym)
+        ret = adoc2xml(file, @conv.backend.to_sym)
         boilerplate_xml_cleanup(ret)
         ret.name = "boilerplate"
         boilerplate_top_elements(ret)
@@ -198,7 +195,7 @@ module Metanorma
 
       def boilerplate_snippet_convert(adoc, isodoc)
         b = isodoc.populate_template(adoc, nil)
-        ret = boilerplate_xml_cleanup(adoc2xml(b, backend.to_sym))
+        ret = boilerplate_xml_cleanup(adoc2xml(b, @conv.backend.to_sym))
         @i18n.l10n(ret.children.to_xml, @lang, @script).strip
       end
 

data/lib/metanorma/{standoc/cleanup_boilerplate_liquid.rb → cleanup/boilerplate_liquid.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Boilerplate
       # The boilerplate file is in Liquid AsciiDoc format
       # (technically, `boilerplate.adoc.liquid`).
       #

data/lib/metanorma/{standoc → cleanup}/cleanup.rb

@@ -1,32 +1,139 @@
 require "nokogiri"
 require "pathname"
 require "html2doc"
-require_relative "cleanup_block"
-require_relative "cleanup_table"
-require_relative "cleanup_footnotes"
-require_relative "cleanup_ref"
-require_relative "cleanup_asciibib"
-require_relative "cleanup_boilerplate"
-require_relative "cleanup_bibdata"
-require_relative "cleanup_section"
-require_relative "cleanup_index"
-require_relative "cleanup_terms"
-require_relative "cleanup_symbols"
-require_relative "cleanup_xref"
-require_relative "cleanup_inline"
-require_relative "cleanup_amend"
-require_relative "cleanup_maths"
-require_relative "cleanup_image"
-require_relative "cleanup_reqt"
-require_relative "cleanup_text"
-require_relative "cleanup_toc"
-require_relative "cleanup_review"
-require_relative "cleanup_dochistory"
 require "relaton_iev"
+require "forwardable"
+require_relative "attachment"
+require_relative "block"
+require_relative "table"
+require_relative "footnotes"
+require_relative "ref"
+require_relative "asciibib"
+require_relative "boilerplate"
+require_relative "bibdata"
+require_relative "bibitem"
+require_relative "section"
+require_relative "section_names"
+require_relative "index"
+require_relative "terms"
+require_relative "symbols"
+require_relative "xref"
+require_relative "inline"
+require_relative "amend"
+require_relative "maths"
+require_relative "metadata"
+require_relative "image"
+require_relative "reqt"
+require_relative "text"
+require_relative "toc"
+require_relative "review"
+require_relative "dochistory"
+require_relative "terms_designations"
+require_relative "merge_bibitems"
+require_relative "spans_to_bibitem"
+require_relative "spans_to_bibitem_preprocessing"
+require_relative "log"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    class Cleanup
+      extend Forwardable
+
+      attr_reader :log, :files_to_delete
+
+      # XPath expressions for boilerplate insertion
+      NORM_REF =
+        "//bibliography/references[@normative = 'true'][not(@hidden)] | " \
+        "//bibliography/clause[.//references[@normative = 'true']]".freeze
+
+      TERM_CLAUSE =
+        "//sections//terms[not(.//ancestor::clause[@type = 'terms'])] | " \
+        "//sections/clause[descendant::terms][@type = 'terms'] | " \
+        "//sections/clause[not(@type = 'terms')]//terms".freeze
+
+      # Use metaprogramming to copy instance variables from converter
+      def copied_instance_variables
+        %i[
+          datauriattachment datauriimage local_log isodoc anchors localdir c
+          refids sourcecode_markup_start sourcecode_markup_end smartquotes
+          toclevels htmltoclevels doctoclevels pdftoclevels stage_published
+          numberfmt_default svg_conform_profile dataurimaxsize index_terms
+          boilerplateauthority embed_hdr embed_id erefstyle originstyle
+          xrefstyle blockunnumbered keepasciimath numberfmt_formula
+          numberfmt_prof sort_biblio reqt_models default_requirement_model
+          document_scheme
+        ]
+      end
+
+      def initialize(converter)
+        @conv= converter
+        @anchor_alias = {}
+        @internal_eref_namespaces = []
+
+        # Shadow instance variables from converter (attributes/accessors)
+        @log = converter.log
+        @bibdb = converter.bibdb
+        @lang = converter.lang
+        @script = converter.script
+        @libdir = converter.libdir
+        @locale = converter.locale
+        @novalid = converter.novalid
+        @output_dir = converter.output_dir
+        @filename = converter.filename
+        @files_to_delete = converter.files_to_delete
+
+        copied_instance_variables.each do |var|
+          instance_variable_set("@#{var}",
+                                converter.instance_variable_get("@#{var}"))
+        end
+
+        # Special handling for derived values
+        @i18n = @isodoc&.i18n
+
+        # Reuse converter's relaton_log instead of creating a new one
+        @relaton_log = converter.relaton_log
+      end
+
+      def to_xml(xml)
+        @conv.to_xml(xml)
+      end
+
+      class << self
+        attr_accessor :_file
+      end
+
+      def self.inherited(konv) # rubocop:disable Lint/MissingSuper
+        konv._file = caller_locations(1..1).first.absolute_path
+      end
+
+      # Include all cleanup modules
+      include Attachment
+      include Block
+      include Table
+      include Footnotes
+      include Ref
+      include Asciibib
+      include Boilerplate
+      include Bibdata
+      include Bibitem
+      include Section
+      include SectionNames
+      include Index
+      include Terms
+      include Symbols
+      include Xref
+      include Inline
+      include Amend
+      include Maths
+      include Image
+      include Reqt
+      include Text
+      include Toc
+      include Review
+      include Dochistory
+      include TermsDesignations
+      include Metadata
+
       def cleanup(xmldoc)
         @doctype = xmldoc.at("//bibdata/ext/doctype")&.text
         element_name_cleanup(xmldoc)
@@ -58,7 +165,7 @@ module Metanorma
         clausebefore_cleanup(xmldoc) # feeeds: floatingtitle_cleanup
         floatingtitle_cleanup(xmldoc)
         bibitem_cleanup(xmldoc) # feeds: normref_cleanup, biblio_cleanup,
-        # reference_names, bpart_cleanup
+        # reference_names, bpart_cleanup, attachment_cleanup
         normref_cleanup(xmldoc)
         biblio_cleanup(xmldoc)
         reference_names(xmldoc)
@@ -108,46 +215,6 @@ module Metanorma
         xmldoc
       end
 
-      def relaton_iev_cleanup(xmldoc)
-        _, err = RelatonIev::iev_cleanup(xmldoc, @bibdb)
-        err.each do |e|
-          @log.add("RELATON_5", nil, params: e)
-        end
-      end
-
-      RELATON_SEVERITIES =
-        { "INFO": "RELATON_4", "WARN":  "RELATON_3", "ERROR":  "RELATON_2",
-          "FATAL": "RELATON_1", "UNKNOWN":  "RELATON_4" }.freeze
-
-      def relaton_log_cleanup(_xmldoc)
-        @relaton_log or return
-        @relaton_log.rewind
-        @relaton_log.string.split(/(?<=})\n(?={)/).each do |l|
-          e = JSON.parse(l)
-          relaton_log_add?(e) and
-            @log.add(RELATON_SEVERITIES[e["severity"].to_sym], e["key"],
-                     params: [e["message"]])
-        end
-      end
-
-      def relaton_log_add?(entry)
-        entry["message"].include?("Fetching from") and return false
-        entry["message"].include?("Downloaded index from") and return false
-        entry["message"].start_with?("Found:") or return true
-        id = /^Found: `(.+)`$/.match(entry["message"]) or return true
-        #entry["key"].end_with?(id[1]) and return false
-        #true
-        !relaton_key_eqv?(entry["key"], id[1])
-      end
-
-      def relaton_key_eqv?(sought, found)
-        sought = sought.sub(" (all parts)", "").sub(/:(19|20)\d\d$/, "")
-        found = found.sub(" (all parts)", "").sub(/:(19|20)\d\d$/, "")
-        sought.end_with?(found)
-      end
-
-      def docidentifier_cleanup(xmldoc); end
-
       TEXT_ELEMS =
         %w{status language script version author name callout phone email
            street city state country postcode identifier referenceFrom surname
@@ -172,48 +239,6 @@ module Metanorma
       def element_name_cleanup(xmldoc)
         xmldoc.traverse { |n| n.name = n.name.tr("_", "-") }
       end
-
-      def metadata_cleanup(xmldoc)
-        bibdata_published(xmldoc) # feeds: bibdata_cleanup,
-        # docidentifier_cleanup (in generic: template)
-        (@metadata_attrs.nil? || @metadata_attrs.empty?) and return
-        ins = add_misc_container(xmldoc)
-        ins << @metadata_attrs
-      end
-
-      def pres_metadata_cleanup(xmldoc)
-        @isodoc ||= isodoc(@lang, @script, @locale)
-        isodoc_bibdata_parse(xmldoc)
-        xmldoc.xpath("//presentation-metadata/* | //semantic-metadata/*")
-          .each do |x|
-          /\{\{|\{%/.match?(x) or next
-          x.children = @isodoc.populate_template(to_xml(x.children), nil)
-        end
-      end
-
-      def metadata_cleanup_final(xmldoc)
-        root = nil
-        %w(semantic presentation).each do |k|
-          xmldoc.xpath("//#{k}-metadata").each_with_index do |x, i|
-            if i.zero? then root = x
-            else
-              root << x.remove.elements
-            end
-          end
-        end
-      end
-
-      def annotation_cleanup(xmldoc)
-        ret = xmldoc.xpath("//annotation[@type = 'ignore-log']")
-          .each_with_object([]) do |ann, m|
-          error_ids = Array(csv_split(ann.text || "", ","))
-          m << { from: ann["from"], to: ann["to"], error_ids: error_ids }
-          ann
-        end
-        config = @log.suppress_log
-        config[:locations] += ret
-        @log.suppress_log = config
-      end
     end
   end
 end

data/lib/metanorma/{standoc/cleanup_dochistory.rb → cleanup/dochistory.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Dochistory
       def bib_relation_insert_pt(xmldoc)
         ins = nil
         %w(relation copyright status abstract script language note version
@@ -81,7 +81,7 @@ module Metanorma
 
       def amend_description(yaml)
         a = yaml["description"] or return ""
-        out = adoc2xml(a, backend.to_sym)
+        out = adoc2xml(a, @conv.backend.to_sym)
         "<description>#{out.children.to_xml}</description>"
       end
 

data/lib/metanorma/{standoc/cleanup_footnotes.rb → cleanup/footnotes.rb}

@@ -2,7 +2,7 @@ require "json"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Footnotes
       def footnote_content(fnote)
         c = if fnote.children.respond_to?(:to_xml)
               fnote.children.to_xml

data/lib/metanorma/{standoc/cleanup_image.rb → cleanup/image.rb}

@@ -3,7 +3,7 @@ require "crass"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Image
       def svgmap_cleanup(xmldoc)
         svgmap_moveattrs(xmldoc)
         svgmap_populate(xmldoc)
@@ -86,7 +86,7 @@ module Metanorma
       def svg_classupdate(xmldoc)
         xmldoc.xpath("//m:svg[m:style]", "m" => SVG_NS)
           .each_with_index do |s, i|
-          svg_classupdate1(s, s.at("./m:style", "m" => SVG_NS), i)
+            svg_classupdate1(s, s.at("./m:style", "m" => SVG_NS), i)
         end
       end
 

data/lib/metanorma/{standoc/cleanup_index.rb → cleanup/index.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Index
       def block_index_cleanup(xmldoc)
         xmldoc.xpath("//quote | //td | //th | //formula | //li | //dt | " \
                      "//dd | //example | //note | //figure | //sourcecode | " \

data/lib/metanorma/{standoc/cleanup_inline.rb → cleanup/inline.rb}

@@ -4,7 +4,7 @@ require "addressable/uri"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Inline
       def empty_text_before_first_element(elem)
         elem.children.each do |c|
           return false if c.text? && /\S/.match(c.text)

data/lib/metanorma/cleanup/log.rb

@@ -0,0 +1,41 @@
+module Metanorma
+  module Standoc
+    class Cleanup
+      def relaton_iev_cleanup(xmldoc)
+        _, err = RelatonIev::iev_cleanup(xmldoc, @bibdb)
+        err.each do |e|
+          @log.add("RELATON_5", nil, params: e)
+        end
+      end
+
+      RELATON_SEVERITIES =
+        { "INFO": "RELATON_4", "WARN":  "RELATON_3", "ERROR":  "RELATON_2",
+          "FATAL": "RELATON_1", "UNKNOWN":  "RELATON_4" }.freeze
+
+      def relaton_log_cleanup(_xmldoc)
+        @relaton_log or return
+        @relaton_log.rewind
+        @relaton_log.string.split(/(?<=})\n(?={)/).each do |l|
+          e = JSON.parse(l)
+          relaton_log_add?(e) and
+            @log.add(RELATON_SEVERITIES[e["severity"].to_sym], e["key"],
+                     params: [e["message"]])
+        end
+      end
+
+      def relaton_log_add?(entry)
+        entry["message"].include?("Fetching from") and return false
+        entry["message"].include?("Downloaded index from") and return false
+        entry["message"].start_with?("Found:") or return true
+        id = /^Found: `(.+)`$/.match(entry["message"]) or return true
+        !relaton_key_eqv?(entry["key"], id[1])
+      end
+
+      def relaton_key_eqv?(sought, found)
+        sought = sought.sub(" (all parts)", "").sub(/:(19|20)\d\d$/, "")
+        found = found.sub(" (all parts)", "").sub(/:(19|20)\d\d$/, "")
+        sought.end_with?(found)
+      end
+    end
+  end
+end

data/lib/metanorma/{standoc/cleanup_maths.rb → cleanup/maths.rb}

@@ -1,8 +1,8 @@
-require_relative "cleanup_mathvariant"
+require_relative "mathvariant"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    module Maths
       def asciimath_cleanup(xml)
         !@keepasciimath and asciimath2mathml(xml)
       end

data/lib/metanorma/{standoc/cleanup_mathvariant.rb → cleanup/mathvariant.rb}

@@ -1,6 +1,6 @@
 module Metanorma
   module Standoc
-    module Cleanup
+    module Maths
       def mathml_mi_italics
         { uppergreek: true, upperroman: true,
           lowergreek: true, lowerroman: true }

data/lib/metanorma/{standoc → cleanup}/merge_bibitems.rb

@@ -2,7 +2,7 @@ require "metanorma-utils"
 
 module Metanorma
   module Standoc
-    module Cleanup
+    class Cleanup
       class MergeBibitems
         Hash.include Metanorma::Utils::Hash
         Array.include Metanorma::Utils::Array