asciidoctor-iso 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ae350c2e4edf9c90dcba4d2ad5c318800a8d26b199c6b7c90375847f58fc46b
-  data.tar.gz: af561d03b111302e8a7dad8c714e93ae335bf7d768d67fd328a2e57282da8582
+  metadata.gz: 037ae405ca1ab7a6f18676326cb76f89f708ae1991434c91144d3e431149519d
+  data.tar.gz: 4dba9c034ef24e4595e5105c8a6c9a643924c892dd229a7682fc56cbf8bf01da
 SHA512:
-  metadata.gz: 83c629ce75f58024f2d096634cfe9111862470250500218f5face86849e8eb14567076f439f9907445880767dcd4d42bfb4c7351e437b0d56b95c057e5f0d2ff
-  data.tar.gz: 242f6a1f91a4e3b86776f60fb13ff5cc806651bd2e56ae4bd4e7e24fb84b8d120fe0ff52519ae3b8e37edf710e959c5fc7d11817be8fb30066c262c5b5a36dfa
+  metadata.gz: 30302f78ee8fc4ee5b3cd7a3f6aa3cd52dda9090844ccced275f9cc3d25af7cc6c3f871a00b20e28abf6a3eeea7d78362529efd2f13527e088c50ef1bd220417
+  data.tar.gz: 77367db460c5bc2f009a0760f18fe100ae8da27f3c22dc03a26c5397c0ee75db5012aba54eeed7a0617d08315b5433c87b2c2861042135d4686d108d675592d4

data/asciidoctor-iso.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "isodoc", ">= 0.8"
   spec.add_dependency "iev", "~> 0.2.0"
   spec.add_dependency "relaton", "~> 0.1.3"
+  spec.add_dependency "metanorma-standoc", "~> 0.0.1"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "byebug"

data/lib/asciidoctor/iso/base.rb

@@ -1,35 +1,14 @@
 require "date"
 require "nokogiri"
-require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
 require "pp"
-require "sass"
 require "isodoc"
-require "relaton"
 
 module Asciidoctor
   module ISO
-    module Base
-      Asciidoctor::Extensions.register do
-        inline_macro Asciidoctor::ISO::AltTermInlineMacro
-        inline_macro Asciidoctor::ISO::DeprecatedTermInlineMacro
-        inline_macro Asciidoctor::ISO::DomainTermInlineMacro
-        block Asciidoctor::ISO::PlantUMLBlockMacro
-      end
-
-      def content(node)
-        node.content
-      end
-
-      def skip(node, name = nil)
-        name = name || node.node_name
-        w = "converter missing for #{name} node in ISO backend"
-        Utils::warning(node, w, nil)
-        nil
-      end
-
+    class Converter < Standoc::Converter
       def html_converter(node)
         IsoDoc::Iso::HtmlConvert.new(
           script: node.attr("script"),
@@ -61,59 +40,6 @@ module Asciidoctor
         )
       end
 
-      def init(node)
-        @fn_number = 0
-        @draft = false
-        @refids = Set.new
-        @anchors = {}
-        @draft = node.attributes.has_key?("draft")
-        @novalid = node.attr("novalid")
-        @fontheader = default_fonts(node)
-        @files_to_delete = []
-        @filename = node.attr("docfile") ?
-          node.attr("docfile").gsub(/\.adoc$/, "").gsub(%r{^.*/}, "") : ""
-        @no_isobib_cache = node.attr("no-isobib-cache")
-        @no_isobib = node.attr("no-isobib")
-        @bibdb = nil
-        init_bib_caches(node)
-        init_iev_caches(node)
-      end
-
-      def init_bib_caches(node)
-        unless (@no_isobib_cache || @no_isobib)
-          globalname = bibliocache_name(true)
-          localname = bibliocache_name(false) if node.attr("local-cache")
-          if node.attr("flush-caches")
-            system("rm -f #{globalname}") unless globalname.nil?
-            system("rm -f #{localname}") unless localname.nil?
-          end
-        end        
-        @bibdb = Relaton::Db.new(globalname, localname) unless @no_isobib
-      end
-
-      def init_iev_caches(node)
-        unless (@no_isobib_cache || @no_isobib)
-          globalname = ievcache_name(true)
-          localname = ievcache_name(false) if node.attr("local-cache")
-          if node.attr("flush-caches")
-            system("rm -f #{globalname}") unless globalname.nil?
-            system("rm -f #{localname}") unless localname.nil?
-          end
-        end
-        @iev = Iev::Db.new(globalname, localname) unless @no_isobib
-      end
-
-      def default_fonts(node)
-        b = node.attr("body-font") ||
-          (node.attr("script") == "Hans" ? '"SimSun",serif' :
-           '"Cambria",serif')
-        h = node.attr("header-font") ||
-          (node.attr("script") == "Hans" ? '"SimHei",sans-serif' :
-           '"Cambria",serif')
-        m = node.attr("monospace-font") || '"Courier New",monospace'
-        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
-      end
-
       def document(node)
         init(node)
         ret = makexml(node).to_xml(indent: 2)
@@ -135,77 +61,6 @@ module Asciidoctor
         result << "</iso-standard>"
         textcleanup(result.flatten * "\n")
       end
-
-      def makexml(node)
-        result = makexml1(node)
-        ret1 = cleanup(Nokogiri::XML(result))
-        ret1.root.add_namespace(nil, "http://riboseinc.com/isoxml")
-        validate(ret1) unless @novalid
-        ret1
-      end
-
-      def draft?
-        @draft
-      end
-
-      def doctype(node)
-        node.attr("doctype")
-      end
-
-      def front(node, xml)
-        xml.bibdata **attr_code(type: doctype(node)) do |b|
-          metadata node, b
-        end
-        metadata_version(node, xml)
-      end
-
-      def middle(node, xml)
-        xml.sections do |s|
-          s << node.content if node.blocks?
-        end
-      end
-
-      def term_source_attr(seen_xref)
-        { bibitemid: seen_xref.children[0]["target"],
-          format: seen_xref.children[0]["format"],
-          type: "inline" }
-      end
-
-      def add_term_source(xml_t, seen_xref, m)
-        xml_t.origin seen_xref.children[0].content,
-          **attr_code(term_source_attr(seen_xref))
-        m[:text] && xml_t.modification do |mod|
-          mod.p { |p| p << m[:text].sub(/^\s+/, "") }
-        end
-      end
-
-      TERM_REFERENCE_RE_STR = <<~REGEXP.freeze
-        ^(?<xref><xref[^>]+>([^<]*</xref>)?)
-               (,\s(?<text>.*))?
-        $
-      REGEXP
-      TERM_REFERENCE_RE =
-        Regexp.new(TERM_REFERENCE_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
-                   Regexp::IGNORECASE | Regexp::MULTILINE)
-
-      def extract_termsource_refs(text, node)
-        matched = TERM_REFERENCE_RE.match text
-        if matched.nil?
-          Utils::warning(node, "term reference not in expected format", text)
-        end
-        matched
-      end
-
-      def termsource(node)
-        matched = extract_termsource_refs(node.content, node) || return
-        noko do |xml|
-          attrs = { status: matched[:text] ? "modified" : "identical" }
-          xml.termsource **attrs do |xml_t|
-            seen_xref = Nokogiri::XML.fragment(matched[:xref])
-            add_term_source(xml_t, seen_xref, matched)
-          end
-        end.join("\n")
-      end
     end
   end
 end

data/lib/asciidoctor/iso/cleanup.rb

@@ -1,244 +1,37 @@
 require "date"
 require "nokogiri"
+require "htmlentities"
+require "json"
 require "pathname"
 require "open-uri"
 require "pp"
-require_relative "./cleanup_block.rb"
-require_relative "./cleanup_footnotes.rb"
-require_relative "./cleanup_ref.rb"
 
 module Asciidoctor
   module ISO
-    module Cleanup
-      def textcleanup(text)
-        text.gsub(/\s+<fn /, "<fn ")
-      end
-
-      def cleanup(xmldoc)
-        termdef_cleanup(xmldoc)
-        sections_cleanup(xmldoc)
-        obligations_cleanup(xmldoc)
-        table_cleanup(xmldoc)
-        formula_cleanup(xmldoc)
-        figure_cleanup(xmldoc)
-        ref_cleanup(xmldoc)
-        note_cleanup(xmldoc)
-        normref_cleanup(xmldoc)
-        biblio_cleanup(xmldoc)
-        reference_names(xmldoc)
-        xref_cleanup(xmldoc)
-        bpart_cleanup(xmldoc)
-        quotesource_cleanup(xmldoc)
-        para_cleanup(xmldoc)
-        callout_cleanup(xmldoc)
-        origin_cleanup(xmldoc)
-        element_name_cleanup(xmldoc)
-        footnote_renumber(xmldoc)
-        empty_element_cleanup(xmldoc)
-        mathml_cleanup(xmldoc)
-        script_cleanup(xmldoc)
-        docidentifier_cleanup(xmldoc)
-        bookmark_cleanup(xmldoc)
-        xmldoc
-      end
-
-      def docidentifier_cleanup(xmldoc)
-        id = xmldoc.at("//bibdata/docidentifier/project-number")
-        return unless id
-
-        prefix = []
-        xmldoc.xpath("//bibdata/contributor[role/@type = 'publisher']"\
-                     "/organization").each do |x|
-          x1 = x.at("abbreviation")&.text || x.at("name")&.text
-          x1 == "ISO" and prefix.unshift("ISO") or prefix << x1
-        end
-
-        id.content = prefix.join("/") + " " + id.text
-      end
-
-      TEXT_ELEMS =
-        %w{status language script version author name callout phone
-           email street city state country postcode identifier referenceFrom
-           referenceTo docidentifier prefix initial addition surname forename
-           title draft secretariat title-main title-intro title-part}.freeze
-
-      # it seems Nokogiri::XML is treating the content of <script> as cdata,
-      # because of its use in HTML. Bad nokogiri. Undoing that, since we use
-      # script as a normal tag
-      def script_cleanup(xmldoc)
-        xmldoc.xpath("//script").each do |x|
-          x.content = x.to_str
-        end
-      end
-
-      def empty_element_cleanup(xmldoc)
-        xmldoc.xpath("//" + TEXT_ELEMS.join(" | //")).each do |x|
-          x.remove if x.children.empty?
-        end
-      end
-
-      def element_name_cleanup(xmldoc)
-        xmldoc.traverse { |n| n.name = n.name.gsub(/_/, "-") }
-      end
-
-      def link_callouts_to_annotations(callouts, annotations)
-        callouts.each_with_index do |c, i|
-          c["target"] = "_" + UUIDTools::UUID.random_create
-          annotations[i]["id"] = c["target"]
-        end
-      end
-
-      def align_callouts_to_annotations(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
-          if callouts.size == annotations.size
-            link_callouts_to_annotations(callouts, annotations)
-          end
-        end
-      end
-
-      def merge_annotations_into_sourcecode(xmldoc)
-        xmldoc.xpath("//sourcecode").each do |x|
-          while x&.next_element&.name == "annotation"
-            x.next_element.parent = x
-          end
-        end
-      end
-
-      def callout_cleanup(xmldoc)
-        merge_annotations_into_sourcecode(xmldoc)
-        align_callouts_to_annotations(xmldoc)
-      end
-
-      def termdef_stem_cleanup(xmldoc)
-        xmldoc.xpath("//term/p/stem").each do |a|
-          if a.parent.elements.size == 1
-            # para containing just a stem expression
-            t = Nokogiri::XML::Element.new("admitted", xmldoc)
-            parent = a.parent
-            t.children = a.remove
-            parent.replace(t)
-          end
-        end
-      end
-
-      def termdomain_cleanup(xmldoc)
-        xmldoc.xpath("//p/domain").each do |a|
-          prev = a.parent.previous
-          prev.next = a.remove
-        end
-      end
-
-      def termdefinition_cleanup(xmldoc)
-        xmldoc.xpath("//term").each do |d|
-          first_child = d.at("./p | ./figure | ./formula") || return
-          t = Nokogiri::XML::Element.new("definition", xmldoc)
-          first_child.replace(t)
-          t << first_child.remove
-          d.xpath("./p | ./figure | ./formula").each { |n| t << n.remove }
-        end
-      end
-
-      def termdef_unnest_cleanup(xmldoc)
-        # release termdef tags from surrounding paras
-        nodes = xmldoc.xpath("//p/admitted | //p/deprecates")
-        while !nodes.empty?
-          nodes[0].parent.replace(nodes[0].parent.children)
-          nodes = xmldoc.xpath("//p/admitted | //p/deprecates")
-        end
-      end
-
-      def termdef_boilerplate_cleanup(xmldoc)
-        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
-      end
-
-      def termdef_subclause_cleanup(xmldoc)
-        xmldoc.xpath("//terms[terms]").each do |t|
-          t.name = "clause"
-        end
-      end
-
-      def termdocsource_cleanup(xmldoc)
-        f = xmldoc.at("//preface | //sections")
-        xmldoc.xpath("//terms/termdocsource | "\
-                     "//clause/termdocsource").each do |s|
-          f.previous = s.remove
-        end
-      end
-
-      def termdef_cleanup(xmldoc)
-        termdef_unnest_cleanup(xmldoc)
-        termdef_stem_cleanup(xmldoc)
-        termdomain_cleanup(xmldoc)
-        termdefinition_cleanup(xmldoc)
-        termdef_boilerplate_cleanup(xmldoc)
-        termdef_subclause_cleanup(xmldoc)
-        termdocsource_cleanup(xmldoc)
-      end
-
-      def biblio_cleanup(xmldoc)
-        xmldoc.xpath("//references[references]").each do |t|
-          t.name = "clause"
-        end
-      end
-
-      ELEMS_ALLOW_NOTES =
-        # %w[p formula quote sourcecode example admonition ul ol dl figure]
-        %w[p formula ul ol dl figure].freeze
-
-      # if a note is at the end of a section, it is left alone
-      # if a note is followed by a non-note block,
-      # it is moved inside its preceding block if it is not delimited
-      # (so there was no way of making that block include the note)
-      def note_cleanup(xmldoc)
-        q = "//note[following-sibling::*[not(local-name() = 'note')]]"
-        xmldoc.xpath(q).each do |n|
-          next unless n.ancestors("table").empty?
-          prev = n.previous_element || next
-          n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
-        end
-      end
-
-      def empty_text_before_first_element(x)
-        x.children.each do |c|
-          if c.text?
-            return false if /\S/.match(c.text)
-          end
-          return true if c.element?
-        end
-        true
-      end
-
-      def strip_initial_space(x)
-        if x.children[0].text?
-          if !/\S/.match(x.children[0].text)
-            x.children[0].remove
-          else
-            x.children[0].content = x.children[0].text.gsub(/^ /, "")
-          end
-        end
-      end
-
-      def bookmark_cleanup(xmldoc)
-        xmldoc.xpath("//li[descendant::bookmark]").each do |x|
-          if x&.elements&.first&.name == "p" &&
-              x&.elements&.first&.elements&.first&.name == "bookmark"
-            if empty_text_before_first_element(x.elements[0])
-              x["id"] = x.elements[0].elements[0].remove["id"]
-              strip_initial_space(x.elements[0])
-            end
-          end
-        end
-      end
-
-      def mathml_cleanup(xmldoc)
-        xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
-          math = x.text.gsub(/&lt;/, "<").gsub(/&gt;/, ">").gsub(/&quot;/, '"').
-            gsub(/&amp;/, "&").gsub(/<[^:\/]+:/, "<").gsub(/<\/[^:]+:/, "</").
-            gsub(/ xmlns[^>]+/, "").
-            gsub(/<math>/, '<math xmlns="http://www.w3.org/1998/Math/MathML">')
-          x.children = math
+    class Converter < Standoc::Converter
+      PRE_NORMREF_FOOTNOTES = "//foreword//fn | //introduction//fn |"\
+        "//clause[title = 'Scope']//fn" .freeze
+
+      NORMREF_FOOTNOTES =
+        "//references[title = 'Normative References']//fn |"\
+        "//references[title = 'Normative References']//bibitem/note".freeze
+
+      POST_NORMREF_FOOTNOTES =
+        "//clause[not(title = 'Scope')]//fn | "\
+        "//references[title = 'Bibliography']//fn | "\
+        "//references[title = 'Bibliography']//bibitem/note".freeze
+
+      def other_footnote_renumber(xmldoc)
+        seen = {}
+        i = 0
+        xmldoc.xpath(PRE_NORMREF_FOOTNOTES).each do |fn|
+          i, seen = other_footnote_renumber1(fn, i, seen)
+        end
+        xmldoc.xpath(NORMREF_FOOTNOTES).each do |fn|
+          i, seen = other_footnote_renumber1(fn, i, seen)
+        end
+        xmldoc.xpath(POST_NORMREF_FOOTNOTES).each do |fn|
+          i, seen = other_footnote_renumber1(fn, i, seen)
         end
       end
     end