isodoc 1.8.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3189a7f65994e9185f29009eb40bb6589c83f579996199d34c669b44883a6548
-  data.tar.gz: 8462af8b54793cbc7dda2e98a2005a8ec11d4d17657a3fb63b3f2865950cf8c9
+  metadata.gz: 94378642fdbff3fdfd64fc15d3f502fd3ac966926d19b060c5b7bbd4b9f9e545
+  data.tar.gz: eeb1da05b0df09ea66cd55692f3d2f706991904216c5869025b9d936dc93cf12
 SHA512:
-  metadata.gz: 4cd5b57e05c214e49e703f808799195e4b1d7b158a9e07fd4e728a369b8f1406d735eb7576e182abe28ba40529dc22a70db28f50e77f2548aed08ae0ff139d5c
-  data.tar.gz: 12eb151374efdde8fd26302aeecdde46e25a7db4147f4bbf1dd54256f460f8ef5f29880bbaa170171abb5d451bf11b1d1b29ff24bbba15746d28249f5ec283f6
+  metadata.gz: b8164bf9d471f1b409ff4c0d933f69b9f834d340548caf3b441d7ca4584460b026420bb752903121561d573f8ddc618e5796d5e22dd09c1a9f3ca429cf567df5
+  data.tar.gz: 75a73a94378f4d0fe6187b343d84961265e60d1417d23c43c38b11c819190cba0838dd0a99ba21d7e49824add339f7a6007c42748f87130a7abd2ce35d14105b

data/.github/workflows/rake.yml

@@ -10,34 +10,6 @@ on:
 
 jobs:
   rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@master
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - uses: metanorma/metanorma-build-scripts/inkscape-setup-action@master
-
-      - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: tests-passed
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+    uses: metanorma/metanorma-build-scripts/.github/workflows/inkscape-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/lib/isodoc/function/references.rb

@@ -14,27 +14,28 @@ module IsoDoc
       def nonstd_bibitem(list, bib, ordinal, biblio)
         list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
           ids = bibitem_ref_code(bib)
-          identifiers = render_identifier(ids)
-          if biblio then ref_entry_code(ref, ordinal, identifiers, ids)
+          idents = render_identifier(ids)
+          if biblio then ref_entry_code(ref, ordinal, idents, ids)
           else
-            ref << (identifiers[0] || identifiers[1]).to_s
-            ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
+            ref << (idents[:ordinal] || idents[:metanorma] || idents[:sdo]).to_s
+            ref << ", #{idents[sdo]}" if idents[:ordinal] && idents[:sdo]
           end
-          ref << ", " unless biblio && !identifiers[1]
+          ref << ", " unless biblio && !idents[:sdo]
           reference_format(bib, ref)
         end
       end
 
       def std_bibitem_entry(list, bib, ordinal, biblio)
         list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
-          identifiers = render_identifier(bibitem_ref_code(bib))
-          if biblio then ref_entry_code(ref, ordinal, identifiers, nil)
+          idents = render_identifier(bibitem_ref_code(bib))
+          if biblio then ref_entry_code(ref, ordinal, idents, nil)
           else
-            ref << (identifiers[0] || identifiers[1]).to_s
-            ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
+            ref << (idents[:ordinal] || idents[:metanorma] || idents[:sdo]).to_s
+            ref << ", #{idents[:sdo]}" if (idents[:ordinal] ||
+                                          idents[:metanorma]) && idents[:sdo]
           end
           date_note_process(bib, ref)
-          ref << ", " unless biblio && !identifiers[1]
+          ref << ", " unless biblio && !idents[:sdo]
           reference_format(bib, ref)
         end
       end
@@ -42,13 +43,15 @@ module IsoDoc
       # if ids is just a number, only use that ([1] Non-Standard)
       # else, use both ordinal, as prefix, and ids
       def ref_entry_code(ref, ordinal, ids, _id)
-        prefix_bracketed_ref(ref, ids[0] || "[#{ordinal}]")
-        ids[1] and ref << (ids[1]).to_s
+        prefix_bracketed_ref(ref, ids[:ordinal] || ids[:metanorma] ||
+                             "[#{ordinal}]")
+        ids[:sdo] and ref << (ids[:sdo]).to_s
       end
 
       def pref_ref_code(bib)
         bib.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
-                  "or @type = 'ISSN' or @type = 'ISBN' or "\
+                  "or @type = 'metanorma-ordinal' or "\
+                  "@type = 'ISSN' or @type = 'ISBN' or "\
                   "@type = 'rfc-anchor')]"))
       end
 
@@ -58,11 +61,12 @@ module IsoDoc
         id1 = pref_ref_code(bib)
         id2 = bib.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or "\
                         "@type = 'ISBN']"))
-        return [id, id1, id2] if id || id1 || id2
+        id3 = bib.at(ns("./docidentifier[@type = 'metanorma-ordinal']"))
+        return [id, id1, id2, id3] if id || id1 || id2 || id3
 
         id = Nokogiri::XML::Node.new("docidentifier", bib.document)
         id << "(NO ID)"
-        [nil, id, nil]
+        [nil, id, nil, nil]
       end
 
       def bracket_if_num(num)
@@ -74,10 +78,15 @@ module IsoDoc
         num
       end
 
+      def unbracket(ident)
+        ident&.text&.sub(/^\[/, "")&.sub(/\]$/, "")
+      end
+
       def render_identifier(ident)
-        [bracket_if_num(ident[0]),
-         ident[1].nil? ? nil : ident[1].text.sub(/^\[/, "").sub(/\]$/, ""),
-         ident[2].nil? ? nil : ident[2].text.sub(/^\[/, "").sub(/\]$/, "")]
+        { metanorma: bracket_if_num(ident[0]),
+          sdo: unbracket(ident[1]),
+          doi: unbracket(ident[2]),
+          ordinal: bracket_if_num(ident[3]) }
       end
 
       def docid_prefix(prefix, docid)
@@ -133,7 +142,7 @@ module IsoDoc
         end
       end
 
-      def is_standard(bib)
+      def standard?(bib)
         ret = false
         drop = %w(metanorma DOI ISSN ISBN)
         bib.xpath(ns("./docidentifier")).each do |id|
@@ -151,7 +160,7 @@ module IsoDoc
             next if implicit_reference(b)
 
             i += 1
-            if is_standard(b) then std_bibitem_entry(div, b, i, biblio)
+            if standard?(b) then std_bibitem_entry(div, b, i, biblio)
             else nonstd_bibitem(div, b, i, biblio)
             end
           else
@@ -166,7 +175,7 @@ module IsoDoc
       end
 
       def norm_ref(isoxml, out, num)
-        f = isoxml.at(ns(norm_ref_xpath)) and f["hidden"] != "true" or
+        (f = isoxml.at(ns(norm_ref_xpath)) and f["hidden"] != "true") or
           return num
         out.div do |div|
           num = num + 1
@@ -186,7 +195,7 @@ module IsoDoc
       end
 
       def bibliography(isoxml, out)
-        f = isoxml.at(ns(bibliography_xpath)) and f["hidden"] != "true" or
+        (f = isoxml.at(ns(bibliography_xpath)) and f["hidden"] != "true") or
           return
         page_break(out)
         out.div do |div|

data/lib/isodoc/function/section_titles.rb

@@ -76,7 +76,12 @@ module IsoDoc
         end
       end
 
-      def variant_title(_node, _out); end
+      def variant_title(node, out)
+        out.p **attr_code(style: "display:none;",
+                          class: "variant-title-#{node['type']}") do |p|
+          node.children.each { |c| parse(c, p) }
+        end
+      end
     end
   end
 end

data/lib/isodoc/function/utils.rb

@@ -129,6 +129,7 @@ module IsoDoc
 
       def header_strip(hdr)
         h1 = to_xhtml_fragment(hdr.to_s.gsub(%r{<br\s*/>}, " ")
+          .gsub(%r{</?p(\s[^>]+)?>}, "")
           .gsub(/<\/?h[123456][^>]*>/, "").gsub(/<\/?b[^>]*>/, "").dup)
         h1.traverse do |x|
           if x.name == "span" && /mso-tab-count/.match(x["style"])

data/lib/isodoc/html_function/postprocess.rb

@@ -122,8 +122,10 @@ module IsoDoc
       end
 
       def html_toc_entry(level, header)
+        content = header.at("./following-sibling::p"\
+                            "[@class = 'variant-title-toc']") || header
         %(<li class="#{level}"><a href="##{header['id']}">\
-      #{header_strip(header)}</a></li>)
+      #{header_strip(content)}</a></li>)
       end
 
       def toclevel_classes
@@ -144,7 +146,7 @@ module IsoDoc
         idx = docxml.at("//div[@id = 'toc']") or return docxml
         toc = "<ul>"
         path = toclevel_classes.map do |l|
-          "//main//#{l}[not(@class = 'TermNum')][not(@class = 'noTOC')][text()]"
+          "//main//#{l}#{toc_exclude_class}"
         end
         docxml.xpath(path.join(" | ")).each_with_index do |h, tocidx|
           h["id"] ||= "toc#{tocidx}"
@@ -154,6 +156,11 @@ module IsoDoc
         docxml
       end
 
+      def toc_exclude_class
+        "[not(@class = 'TermNum')][not(@class = 'noTOC')]"\
+          "[string-length(normalize-space(.))>0]"
+      end
+
       # presupposes that the image source is local
       def move_images(docxml)
         FileUtils.rm_rf tmpimagedir

data/lib/isodoc/presentation_function/bibdata.rb

@@ -10,12 +10,6 @@ module IsoDoc
         "</localized-strings>"
     end
 
-    def docid_prefixes(docxml)
-      docxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
-        i.children = @xrefs.klass.docid_prefix(i["type"], i.text)
-      end
-    end
-
     def address_precompose(bib)
       bib.xpath(ns("//bibdata//address")).each do |b|
         next if b.at(ns("./formattedAddress"))

data/lib/isodoc/presentation_function/section.rb

@@ -29,9 +29,9 @@ module IsoDoc
     end
 
     def floattitle1(elem)
-      level = @xrefs.anchor(elem["id"], :level, false) || "1"
-      elem.xpath(ns("./p[@type = 'floating-title']")).each do |p|
-        p["depth"] = level.to_i + 1
+      elem.xpath(ns(".//floating-title")).each do |p|
+        p.name = "p"
+        p["type"] = "floating-title"
       end
     end
 
@@ -60,7 +60,29 @@ module IsoDoc
       prefix_name(elem, "", "#{lbl}#{clausedelim}", "name")
     end
 
-    def references(docxml); end
+    def references(docxml)
+      bibliography_bibitem_number(docxml)
+    end
+
+    def bibliography_bibitem_number_skip(bibitem)
+      @xrefs.klass.implicit_reference(bibitem) ||
+        bibitem.at(ns(".//docidentifier[@type = 'metanorma']")) ||
+        bibitem.at(ns(".//docidentifier[@type = 'metanorma-ordinal']"))
+      # || @xrefs.klass.standard?(bibitem)
+    end
+
+    def bibliography_bibitem_number(docxml)
+      i = 0
+      docxml.xpath(ns("//references[@normative = 'false']/bibitem")).each do |b|
+        next if bibliography_bibitem_number_skip(b)
+
+        i += 1
+        id = b.at(ns(".//docidentifier"))
+        id.previous =
+          "<docidentifier type='metanorma-ordinal'>[#{i}]</docidentifier>"
+      end
+      @xrefs.references docxml
+    end
 
     def docid_prefixes(docxml)
       docxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
@@ -102,9 +124,7 @@ module IsoDoc
       display_order_xpath(docxml, "//indexsect", i)
     end
 
-    def clausetitle(docxml)
-      docxml.xpath(ns("//variant-title[@type = 'toc']")).each(&:remove)
-    end
+    def clausetitle(docxml); end
 
     def toc(docxml)
       docxml.xpath(ns("//toc//xref[text()]")).each do |x|

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "1.8.4".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -9,6 +9,10 @@ module IsoDoc
         docxml.xpath(ns(@klass.bibliography_xpath)).each do |b|
           preface_names(b)
         end
+        references(docxml)
+      end
+
+      def references(docxml)
         docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
           reference_names(ref)
         end
@@ -148,11 +152,11 @@ module IsoDoc
         "xmlns:name = 'International Electrotechnical Commission']".freeze
 
       def reference_names(ref)
-        # isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
         ids = @klass.bibitem_ref_code(ref)
         identifiers = @klass.render_identifier(ids)
-        # date = ref.at(ns("./date[@type = 'published']"))
-        reference = @klass.docid_l10n(identifiers[0] || identifiers[1])
+        reference = @klass
+          .docid_l10n(identifiers[:metanorma] || identifiers[:sdo] ||
+                                     identifiers[:ordinal] || identifiers[:doi])
         @anchors[ref["id"]] = { xref: reference }
       end
     end

data/spec/isodoc/blocks_spec.rb

@@ -1752,7 +1752,7 @@ RSpec.describe IsoDoc do
           </foreword></preface>
           <bibliography><references id="_bibliography" obligation="informative" normative="false"  displayorder='2'>
       <title depth='1'>Bibliography</title>
-      <bibitem id="rfc2616" type="standard">  <fetched>2020-03-27</fetched>  <title format="text/plain" language="en" script="Latn">Hypertext Transfer Protocol — HTTP/1.1</title>  <uri type="xml">https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2616.xml</uri>  <uri type="src">https://www.rfc-editor.org/info/rfc2616</uri>  <docidentifier type="IETF">IETF RFC 2616</docidentifier>  <docidentifier type="rfc-anchor">RFC2616</docidentifier>  <docidentifier type="DOI">DOI 10.17487/RFC2616</docidentifier>  <date type="published">    <on>1999-06</on>  </date>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">R. Fielding</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">J. Gettys</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">J. Mogul</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">H. Frystyk</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">L. Masinter</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">P. Leach</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">T. Berners-Lee</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <language>en</language>  <script>Latn</script>  <abstract format="text/plain" language="en" script="Latn">HTTP has been in use by the World-Wide Web global information initiative since 1990. This specification defines the protocol referred to as “HTTP/1.1”, and is an update to RFC 2068.  [STANDARDS-TRACK]</abstract>  <series type="main">    <title format="text/plain" language="en" script="Latn">RFC</title>    <number>2616</number>  </series>  <place>Fremont, CA</place></bibitem>
+      <bibitem id="rfc2616" type="standard">  <fetched>2020-03-27</fetched>  <title format="text/plain" language="en" script="Latn">Hypertext Transfer Protocol — HTTP/1.1</title>  <uri type="xml">https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2616.xml</uri>  <uri type="src">https://www.rfc-editor.org/info/rfc2616</uri>   <docidentifier type='metanorma-ordinal'>[1]</docidentifier> <docidentifier type="IETF">IETF RFC 2616</docidentifier>  <docidentifier type="rfc-anchor">RFC2616</docidentifier>  <docidentifier type="DOI">DOI 10.17487/RFC2616</docidentifier>  <date type="published">    <on>1999-06</on>  </date>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">R. Fielding</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">J. Gettys</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">J. Mogul</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">H. Frystyk</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">L. Masinter</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">P. Leach</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <contributor>    <role type="author"/>    <person>      <name>        <completename language="en">T. Berners-Lee</completename>      </name>      <affiliation>        <organization>          <name>IETF</name>          <abbreviation>IETF</abbreviation>        </organization>      </affiliation>    </person>  </contributor>  <language>en</language>  <script>Latn</script>  <abstract format="text/plain" language="en" script="Latn">HTTP has been in use by the World-Wide Web global information initiative since 1990. This specification defines the protocol referred to as “HTTP/1.1”, and is an update to RFC 2068.  [STANDARDS-TRACK]</abstract>  <series type="main">    <title format="text/plain" language="en" script="Latn">RFC</title>    <number>2616</number>  </series>  <place>Fremont, CA</place></bibitem>
       </references></bibliography>
           </iso-standard>
     OUTPUT
@@ -2518,6 +2518,7 @@ RSpec.describe IsoDoc do
                <bibliography>
                  <references hidden='true' normative='false' displayorder="1">
                    <bibitem id='express_action_schema' type='internal'>
+                     <docidentifier type='metanorma-ordinal'>[1]</docidentifier>
                      <docidentifier type='repository'>express/action_schema</docidentifier>
                    </bibitem>
                  </references>

data/spec/isodoc/postproc_spec.rb

@@ -474,6 +474,33 @@ RSpec.describe IsoDoc do
     OUTPUT
   end
 
+=begin
+  it "populates HTML ToC" do
+    FileUtils.rm_f "test.doc"
+    FileUtils.rm_f "test.html"
+    IsoDoc::HtmlConvert.new({ htmltoclevels: 3 })
+      .convert("test", <<~"INPUT", false)
+            <iso-standard xmlns="http://riboseinc.com/isoxml">
+        <preface><foreword><title>Foreword</title>
+        <variant-title type="toc">FORVORT</variant-title>
+        </foreword></preface>
+        <sections>
+        <clause><title>First Clause</title>
+        <clause><title>First Subclause</title>
+        <variant-title type="toc">SUBCLOZ</variant-title>
+        </clause>
+        </clause>
+        </sections>
+        </iso-standard>
+      INPUT
+    html = Nokogiri::XML(File.read("test.html")).
+      at("//div[@id = 'toc']")
+    expect(xmlpp(html)).to be_equivalent_to xmlpp(<<~OUTPUT)
+    HAJSHJAS
+    OUTPUT
+  end
+=end
+
   it "populates Word ToC" do
     FileUtils.rm_f "test.doc"
     IsoDoc::WordConvert.new(
@@ -495,6 +522,7 @@ RSpec.describe IsoDoc do
       </fn></p>
       <clause id="P" inline-header="false" obligation="normative">
       <title>Clause 4.2.1</title>
+      <variant-title type="toc">SUBCLOZ</variant-title>
       </clause>
              </clause></clause>
               </sections>