RubyGems - isodoc - Versions diffs - 1.7.1 → 1.7.2 - Mend

isodoc 1.7.1 → 1.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/isodoc.gemspec +1 -1
data/lib/isodoc.rb +1 -0
data/lib/isodoc/function/blocks.rb +180 -168
data/lib/isodoc/function/to_word_html.rb +206 -204
data/lib/isodoc/html_convert.rb +0 -4
data/lib/isodoc/version.rb +1 -1
data/lib/metanorma/output.rb +7 -0
data/lib/metanorma/output/base.rb +13 -0
data/lib/metanorma/output/utils.rb +17 -0
data/lib/metanorma/output/xslfo.rb +21 -0
data/spec/assets/outputtest/a.xml +66 -0
data/spec/assets/outputtest/iso.international-standard.xsl +3011 -0
data/spec/isodoc/blocks_spec.rb +327 -243
metadata +8 -18
data/lib/isodoc/html_function/sectionsplit.rb +0 -244
data/spec/isodoc/sectionsplit_spec.rb +0 -190

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: metanorma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -410,7 +396,6 @@ files:
 - lib/isodoc/html_function/mathvariant_to_plain.rb
 - lib/isodoc/html_function/postprocess.rb
 - lib/isodoc/html_function/postprocess_footnotes.rb
-- lib/isodoc/html_function/sectionsplit.rb
 - lib/isodoc/i18n.rb
 - lib/isodoc/metadata.rb
 - lib/isodoc/metadata_contributor.rb
@@ -440,6 +425,10 @@ files:
 - lib/isodoc/xref/xref_gen_seq.rb
 - lib/isodoc/xref/xref_sect_gen.rb
 - lib/isodoc/xslfo_convert.rb
+- lib/metanorma/output.rb
+- lib/metanorma/output/base.rb
+- lib/metanorma/output/utils.rb
+- lib/metanorma/output/xslfo.rb
 - spec/assets/header.html
 - spec/assets/html.scss
 - spec/assets/html_override.css
@@ -450,6 +439,8 @@ files:
 - spec/assets/odf.emf
 - spec/assets/odf.svg
 - spec/assets/odf1.svg
+- spec/assets/outputtest/a.xml
+- spec/assets/outputtest/iso.international-standard.xsl
 - spec/assets/rice_image1
 - spec/assets/rice_image1.png
 - spec/assets/scripts.html
@@ -471,7 +462,6 @@ files:
 - spec/isodoc/presentation_xml_spec.rb
 - spec/isodoc/ref_spec.rb
 - spec/isodoc/section_spec.rb
-- spec/isodoc/sectionsplit_spec.rb
 - spec/isodoc/table_spec.rb
 - spec/isodoc/terms_spec.rb
 - spec/isodoc/xref_spec.rb

data/lib/isodoc/html_function/sectionsplit.rb DELETED Viewed

@@ -1,244 +0,0 @@
-require "metanorma"
-require "yaml"
-module IsoDoc::HtmlFunction
-  module Html
-    # assume we pass in Presentation XML, but we want to recover Semantic XML
-    def sectionsplit_convert(input_filename, file, debug, output_filename = nil)
-      input_filename += ".xml" unless input_filename.match?(/\.xml$/)
-      File.exist?(input_filename) or
-        File.open(input_filename, "w:UTF-8") { |f| f.write(file) }
-      presxml = File.read(input_filename, encoding: "utf-8")
-      @openmathdelim, @closemathdelim = extract_delims(presxml)
-      xml, filename, dir = convert_init(presxml, input_filename, debug)
-      build_collection(xml, presxml, output_filename || filename, dir)
-    end
-    def build_collection(xml, presxml, filename, dir)
-      base = File.basename(filename)
-      collection_setup(base, dir)
-      files = sectionsplit(xml, base, dir)
-      collection_manifest(base, files, xml, presxml, dir).render(
-        format: %i(html), output_folder: "#{filename}_collection",
-        coverpage: File.join(dir, "cover.html")
-      )
-    end
-    def collection_manifest(filename, files, origxml, _presxml, dir)
-      File.open(File.join(dir, "#{filename}.html.yaml"), "w:UTF-8") do |f|
-        f.write(collectionyaml(files, origxml))
-      end
-      Metanorma::Collection.parse File.join(dir, "#{filename}.html.yaml")
-    end
-    def collection_setup(filename, dir)
-      FileUtils.mkdir_p "#{filename}_collection"
-      FileUtils.mkdir_p dir
-      File.open(File.join(dir, "cover.html"), "w:UTF-8") do |f|
-        f.write(coll_cover)
-      end
-    end
-    def coll_cover
-      <<~COVER
-        <html>
-          <head/>
-            <body>
-              <h1>{{ doctitle }}</h1>
-              <h2>{{ docnumber }}</h2>
-              <nav>{{ labels["navigation"] }}</nav>
-            </body>
-        </html>
-      COVER
-    end
-    def sectionsplit(xml, filename, dir)
-      xref_preprocess(xml)
-      out = emptydoc(xml)
-      [["//preface/*", "preface"], ["//sections/*", "sections"],
-       ["//annex", nil],
-       ["//bibliography/*[not(@hidden = 'true')]", "bibliography"],
-       ["//indexsect", nil]].each_with_object([]) do |n, ret|
-         xml.xpath(ns(n[0])).each do |s|
-           ret << sectionfile(out, dir, "#{filename}.#{ret.size}", s, n[1])
-         end
-       end
-    end
-    def emptydoc(xml)
-      out = xml.dup
-      out.xpath(
-        ns("//preface | //sections | //annex | //bibliography/clause | "\
-           "//bibliography/references[not(@hidden = 'true')] | //indexsect"),
-      ).each(&:remove)
-      out
-    end
-    def sectionfile(xml, dir, file, chunk, parentnode)
-      fname = create_sectionfile(xml.dup, dir, file, chunk, parentnode)
-      { order: chunk["displayorder"].to_i, url: fname,
-        title: titlerender(chunk) }
-    end
-    def create_sectionfile(out, dir, file, chunk, parentnode)
-      ins = out.at(ns("//misccontainer")) || out.at(ns("//bibdata"))
-      if parentnode
-        ins.next = "<#{parentnode}/>"
-        ins.next.add_child(chunk.dup)
-      else
-        ins.next = chunk.dup
-      end
-      outname = "#{file}.xml"
-      File.open(File.join(dir, outname), "w:UTF-8") { |f| f.write(out) }
-      outname
-    end
-    def xref_preprocess(xml)
-      svg_preprocess(xml)
-      key = (0...8).map { rand(65..90).chr }.join # random string
-      refs = eref_to_internal_eref(xml, key)
-      refs += xref_to_internal_eref(xml, key)
-      xml.root["type"] = key # to force recognition of internal refs
-      ins = new_hidden_ref(xml)
-      copy_repo_items_biblio(ins, xml)
-      insert_indirect_biblio(ins, refs, key)
-    end
-    def svg_preprocess(xml)
-      xml.xpath("//m:svg", "m" => "http://www.w3.org/2000/svg").each do |s|
-        m = svgmap_wrap(s)
-        s.xpath(".//m:a", "m" => "http://www.w3.org/2000/svg").each do |a|
-          next unless /^#/.match? a["href"]
-          a["href"] = a["href"].sub(/^#/, "")
-          m << "<target href='#{a['href']}'>"\
-            "<xref target='#{a['href']}'/></target>"
-        end
-      end
-    end
-    def svgmap_wrap(svg)
-      ret = svg.at("./ancestor::xmlns:svgmap") and return ret
-      ret = svg.at("./ancestor::xmlns:figure")
-      ret.wrap("<svgmap/>")
-      svg.at("./ancestor::xmlns:svgmap")
-    end
-    def make_anchor(anchor)
-      "<localityStack><locality type='anchor'><referenceFrom>"\
-        "#{anchor}</referenceFrom></locality></localityStack>"
-    end
-    def xref_to_internal_eref(xml, key)
-      xml.xpath(ns("//xref")).each_with_object({}) do |x, m|
-        x["bibitemid"] = "#{key}_#{x['target']}"
-        x << make_anchor(x["target"])
-        m[x["bibitemid"]] = true
-        x.delete("target")
-        x["type"] = key
-        x.name = "eref"
-      end.keys
-    end
-    def eref_to_internal_eref(xml, key)
-      eref_to_internal_eref_select(xml).each_with_object([]) do |x, m|
-        url = xml.at(ns("//bibitem[@id = '#{x}']/url[@type = 'citation']"))
-        xml.xpath(("//*[@bibitemid = '#{x}']")).each do |e|
-          id = eref_to_internal_eref1(e, key, url)
-          id and m << id
-        end
-      end
-    end
-    def eref_to_internal_eref1(elem, key, url)
-      if url
-        elem.name = "link"
-        elem["target"] = url
-        nil
-      else
-        elem["bibitemid"] = "#{key}_#{elem['bibitemid']}"
-        elem << make_anchor(elem["bibitemid"])
-        elem["type"] = key
-        elem["bibitemid"]
-      end
-    end
-    def eref_to_internal_eref_select(xml)
-      refs = xml.xpath(("//*/@bibitemid")).map { |x| x.text } # rubocop:disable Style/SymbolProc
-      refs.uniq.reject do |x|
-        xml.at(ns("//bibitem[@id = '#{x}'][@type = 'internal']")) ||
-          xml.at(ns("//bibitem[@id = '#{x}']"\
-                    "[docidentifier/@type = 'repository']"))
-      end
-    end
-    # from standoc
-    def new_hidden_ref(xmldoc)
-      ins = xmldoc.at("bibliography") or
-        xmldoc.root << "<bibliography/>" and ins = xmldoc.at("bibliography")
-      ins.add_child("<references hidden='true' normative='false'/>").first
-    end
-    def copy_repo_items_biblio(ins, xml)
-      xml.xpath(ns("//references/bibitem[docidentifier/@type = 'repository']"))
-        .each do |b|
-        ins << b.dup
-      end
-    end
-    def insert_indirect_biblio(ins, refs, prefix)
-      refs.each do |x|
-        ins << <<~BIBENTRY
-          <bibitem id="#{x}" type="internal">
-          <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
-          </bibitem>
-        BIBENTRY
-      end
-    end
-    def recursive_string_keys(hash)
-      case hash
-      when Hash then Hash[
-        hash.map { |k, v| [k.to_s, recursive_string_keys(v)] }
-      ]
-      when Enumerable then hash.map { |v| recursive_string_keys(v) }
-      else
-        hash
-      end
-    end
-    def titlerender(section)
-      title = section.at(ns("./title")) or return "[Untitled]"
-      t = title.dup
-      t.xpath(ns(".//tab | .//br")).each { |x| x.replace(" ") }
-      t.xpath(ns(".//strong")).each { |x| x.replace(x.children) }
-      t.children.to_xml
-    end
-    def collectionyaml(files, xml)
-      ret = {
-        directives: ["presentation-xml", "bare-after-first"],
-        bibdata: {
-          title: {
-            type: "title-main",
-            language: @lang,
-            content: xml.at(ns("//bibdata/title")).text,
-          },
-          type: "collection",
-          docid: {
-            type: xml.at(ns("//bibdata/docidentifier/@type")).text,
-            id: xml.at(ns("//bibdata/docidentifier")).text,
-          },
-        },
-        manifest: {
-          level: "collection",
-          title: "Collection",
-          docref: files.sort_by { |f| f[:order] }.each.map do |f|
-            { fileref: f[:url], identifier: f[:title] }
-          end,
-        },
-      }
-      recursive_string_keys(ret).to_yaml
-    end
-  end
-end

data/spec/isodoc/sectionsplit_spec.rb DELETED Viewed

@@ -1,190 +0,0 @@
-require "spec_helper"
-RSpec.describe IsoDoc do
-  it "processes section split HTML" do
-    FileUtils.rm_f "test.xml"
-    FileUtils.rm_f "test.html.yaml"
-    FileUtils.rm_rf "test_collection"
-    FileUtils.rm_rf "test_files"
-    input = <<~INPUT
-      <iso-standard xmlns="http://riboseinc.com/isoxml">
-      <bibdata>
-      <title>ISO Title</title>
-      <docidentifier type="ISO">ISO 1</docidentifier>
-      </bibdata>
-      <preface>
-      <abstract id="A" displayorder='1'><title>abstract</title></abstract>
-      <introduction id="B" displayorder='2'><title>introduction</title></introduction>
-      </preface>
-      <sections>
-       <clause id="M" inline-header="false" obligation="normative" displayorder='4'>
-         <title>Clause 4</title>
-         <clause id="N" inline-header="false" obligation="normative">
-         <title>Introduction</title>
-         <p><xref target="A">HE</xref></p>
-         <p><eref bibitemid="R1">SHE</xref></p>
-         <svgmap>
-         <figure>
-           <svg xmlns="http://www.w3.org/2000/svg">
-             <a href="#A">A</a>
-             <a href="#B">B</a>
-           </svg>
-           <target href="B"><eref bibitemid="R1"/></target>
-         </figure>
-         </svgmap>
-         <figure>
-         <svg xmlns="http://www.w3.org/2000/svg">
-           <a href="#P">P</a>
-         </svg>
-         </figure>
-       </clause>
-       <clause id="O" inline-header="true" obligation="normative">
-         <title>Clause 4.2</title>
-       </clause></clause>
-       <admonition id="L" type="caution"><p>admonition</p></admonition>
-       </sections>
-       <annex id="P" inline-header="false" obligation="normative" displayorder='5'>
-         <title><strong>Annex</strong><br/>(informative)</title>
-         <clause id="Q" inline-header="false" obligation="normative">
-         <title>Annex A.1</title>
-         <clause id="Q1" inline-header="false" obligation="normative">
-         <title>Annex A.1a</title>
-         </clause>
-         <references id="Q2" normative="false">
-        <title>Annex Bibliography</title>
-        </references>
-       </clause>
-       </annex>
-       <annex id="P1" inline-header="false" obligation="normative" displayorder='6'>
-       </annex>
-        <bibliography><references id="R" obligation="informative" normative="true" displayorder='3'>
-         <title>Normative References</title>
-         <bibitem id="R1"><docidentifier>R1</docidentifier><title>Hello</title></bibitem>
-       </references><clause id="S" obligation="informative" displayorder='7'>
-         <title>Bibliography</title>
-         <references id="T" obligation="informative" normative="false">
-         <title>Bibliography Subsection</title>
-       </references>
-       </clause>
-       </bibliography>
-      </iso-standard>
-    INPUT
-    mock_render
-    IsoDoc::HtmlConvert.new({ sectionsplit: "true" })
-      .convert("test", input, true)
-    expect(File.exist?("test_collection/index.html")).to be true
-    expect(File.exist?("test_collection/test.0.html")).to be true
-    expect(File.exist?("test_collection/test.1.html")).to be true
-    expect(File.exist?("test_collection/test.2.html")).to be true
-    expect(File.exist?("test_collection/test.3.html")).to be false
-    expect(File.exist?("test_collection/test.4.html")).to be true
-    expect(File.exist?("test_collection/test.5.html")).to be true
-    expect(File.exist?("test_collection/test.6.html")).to be true
-    expect(File.exist?("test_collection/test.7.html")).to be true
-    expect(File.exist?("test_collection/test.8.html")).to be false
-    expect(File.exist?("test_files/cover.html")).to be true
-    expect(File.exist?("test_files/test.0.xml")).to be true
-    expect(File.exist?("test_files/test.1.xml")).to be true
-    expect(File.exist?("test_files/test.2.xml")).to be true
-    expect(File.exist?("test_files/test.3.xml")).to be true
-    expect(File.exist?("test_files/test.4.xml")).to be true
-    expect(File.exist?("test_files/test.5.xml")).to be true
-    expect(File.exist?("test_files/test.6.xml")).to be true
-    expect(File.exist?("test_files/test.7.xml")).to be true
-    expect(File.exist?("test_files/test.8.xml")).to be false
-    expect(File.exist?("test_files/test.html.yaml")).to be true
-    m = /type="([^"]+)"/.match(File.read("test_files/test.0.xml"))
-    file2 = Nokogiri::XML(File.read("test_files/test.2.xml"))
-    expect(xmlpp(file2
-     .at("//xmlns:eref[@bibitemid = '#{m[1]}_A']").to_xml))
-      .to be_equivalent_to xmlpp(<<~OUTPUT)
-        <eref bibitemid="#{m[1]}_A" type="#{m[1]}">HE<localityStack><locality type="anchor"><referenceFrom>A</referenceFrom></locality></localityStack></eref>
-      OUTPUT
-    expect(xmlpp(file2
-     .at("//xmlns:eref[@bibitemid = '#{m[1]}_R1']").to_xml))
-      .to be_equivalent_to xmlpp(<<~OUTPUT)
-        <eref bibitemid="#{m[1]}_R1" type="#{m[1]}">SHE<localityStack><locality type="anchor"><referenceFrom>#{m[1]}_R1</referenceFrom></locality></localityStack></eref>
-      OUTPUT
-    expect(xmlpp(file2
-     .at("//xmlns:bibitem[@id = '#{m[1]}_R1']").to_xml))
-      .to be_equivalent_to xmlpp(<<~OUTPUT)
-        <bibitem id="#{m[1]}_R1" type="internal">
-        <docidentifier type="repository">#{m[1]}/R1</docidentifier>
-        </bibitem>
-      OUTPUT
-    expect(xmlpp(file2
-     .at("//xmlns:bibitem[@id = '#{m[1]}_A']").to_xml))
-      .to be_equivalent_to xmlpp(<<~OUTPUT)
-        <bibitem id="#{m[1]}_A" type="internal">
-        <docidentifier type="repository">#{m[1]}/A</docidentifier>
-        </bibitem>
-      OUTPUT
-    expect(xmlpp(file2
-     .at("//xmlns:svgmap[1]").to_xml))
-      .to be_equivalent_to xmlpp(<<~OUTPUT)
-        <svgmap>
-        <figure>
-          <svg xmlns="http://www.w3.org/2000/svg">
-            <a href="A">A</a>
-            <a href="B">B</a>
-          </svg>
-          <target href="B"><eref bibitemid="#{m[1]}_R1" type="#{m[1]}"><localityStack><locality type="anchor"><referenceFrom>#{m[1]}_R1</referenceFrom></locality></localityStack></eref></target>
-        </figure>
-        <target href="A"><eref bibitemid="#{m[1]}_A" type="#{m[1]}"><localityStack><locality type="anchor"><referenceFrom>A</referenceFrom></locality></localityStack></eref></target><target href="B"><eref bibitemid="#{m[1]}_B" type="#{m[1]}"><localityStack><locality type="anchor"><referenceFrom>B</referenceFrom></locality></localityStack></eref></target></svgmap>
-      OUTPUT
-    expect(xmlpp(file2
-     .at("//xmlns:svgmap[2]").to_xml))
-      .to be_equivalent_to xmlpp(<<~OUTPUT)
-        <svgmap><figure>
-        <svg xmlns="http://www.w3.org/2000/svg">
-          <a href="P">P</a>
-        </svg>
-        </figure><target href="P"><eref bibitemid="#{m[1]}_P" type="#{m[1]}"><localityStack><locality type="anchor"><referenceFrom>P</referenceFrom></locality></localityStack></eref></target></svgmap>
-      OUTPUT
-    expect(File.read("test_files/test.html.yaml")).to be_equivalent_to <<~OUTPUT
-      ---
-      directives:
-      - presentation-xml
-      - bare-after-first
-      bibdata:
-        title:
-          type: title-main
-          language: en
-          content: ISO Title
-        type: collection
-        docid:
-          type: ISO
-          id: ISO 1
-      manifest:
-        level: collection
-        title: Collection
-        docref:
-        - fileref: test.3.xml
-          identifier: "[Untitled]"
-        - fileref: test.0.xml
-          identifier: abstract
-        - fileref: test.1.xml
-          identifier: introduction
-        - fileref: test.6.xml
-          identifier: Normative References
-        - fileref: test.2.xml
-          identifier: Clause 4
-        - fileref: test.4.xml
-          identifier: Annex (informative)
-        - fileref: test.5.xml
-          identifier: "[Untitled]"
-        - fileref: test.7.xml
-          identifier: Bibliography
-    OUTPUT
-  end
-  private
-  def mock_render
-    original_add = ::Metanorma::CollectionRenderer.method(:render)
-    allow(::Metanorma::CollectionRenderer)
-      .to receive(:render) do |col, opts|
-      original_add.call(col, opts.merge(compile: { no_install_fonts: true }))
-    end
-  end
-end