metanorma-standoc 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55c699cf84e05288a133b4e0b9305cfb14809780ec379b8d617a928338f1fca
-  data.tar.gz: 772eaa9e0e09e9ad7c40b70ade1825d437ba079673767b31c3c5b493cf29af4f
+  metadata.gz: 9487b5701cc86946c27e560e244cc4f84fceb61b0a93dd271068875654eb49a0
+  data.tar.gz: c647cf6fb530aba3bc96c9087e7a9d49408ce239a6c6aa3a4a46a0e8cf1a5763
 SHA512:
-  metadata.gz: fba5328a1ebbc7d236174893d3e98ece5768c3d8935c326506692023d1254c1a2bda95f842956b4830d18c949ba817d4ca4f00548c569999ae38381c1406f02f
-  data.tar.gz: d3aed7321347c856c5f8ff600118773094ffc948a5f7b3be6655dff48749c4780a5a4048baf1a04d4aad94e22b650648c91c7ca9bc159680beb48ec4275a8904
+  metadata.gz: c8356539be6d28f5dc6d4d148cfcabb8ed7dbc033392544d382d36e1e392e33da6b29a64b535f6c24cdab85a4d17d1dc5698367f0edff8f45eb02b1f8ed97330
+  data.tar.gz: 13c49550edea0d6169fef67357a5030e146cdf62fec3cb41900db7490d95c09f9dbb1c4f4b55bea4836651ba11fcaf0714b20f37fc3a96a48dd31596cf564549

data/lib/metanorma/standoc/cleanup.rb

@@ -28,6 +28,8 @@ module Metanorma
         passthrough_cleanup(xmldoc)
         sections_cleanup(xmldoc)
         obligations_cleanup(xmldoc)
+        para_index_cleanup(xmldoc)
+        block_index_cleanup(xmldoc)
         table_cleanup(xmldoc)
         formula_cleanup(xmldoc)
         form_cleanup(xmldoc)
@@ -51,7 +53,7 @@ module Metanorma
         termdef_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
-        index_cleanup(xmldoc)
+        term_index_cleanup(xmldoc)
         bpart_cleanup(xmldoc)
         quotesource_cleanup(xmldoc)
         callout_cleanup(xmldoc)

data/lib/metanorma/standoc/cleanup_block.rb

@@ -66,7 +66,7 @@ module Metanorma
       def subfigure_cleanup(xmldoc)
         xmldoc.xpath("//example[figure]").each do |e|
           next unless e.elements.map(&:name).reject do |m|
-            %w(name figure).include? m
+            %w(name figure index).include? m
           end.empty?
 
           e.name = "figure"
@@ -178,6 +178,46 @@ module Metanorma
           end
         end
       end
+
+      def block_index_cleanup(xmldoc)
+        xmldoc.xpath("//quote | //td | //th | //formula | //li | //dt | "\
+                     "//dd | //example | //note | //figure | //sourcecode | "\
+                     "//admonition | //termnote | //termexample | //form  | "\
+                     "//requirement | //recommendation | //permission | "\
+                     "//imagemap | //svgmap").each do |b|
+          b.xpath("./p[indexterm]").each do |p|
+            indexterm_para?(p) or next
+            p.replace(p.children)
+          end
+        end
+      end
+
+      def indexterm_para?(para)
+        p = para.dup
+        p.xpath("./index").each(&:remove)
+        p.text.strip.empty?
+      end
+
+      def include_indexterm?(elem)
+        return false if elem.nil?
+
+        !%w(image literal sourcecode).include?(elem.name)
+      end
+
+      def para_index_cleanup(xmldoc)
+        xmldoc.xpath("//p[index]").select { |p| indexterm_para?(p) }
+          .each do |p|
+            para_index_cleanup1(p, p.previous_element, p.next_element)
+          end
+      end
+
+      def para_index_cleanup1(para, prev, foll)
+        if include_indexterm?(prev)
+          prev << para.remove.children
+        elsif include_indexterm?(foll) && !foll.children.empty?
+          foll.children.first.previous = para.remove.children
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_terms.rb

@@ -100,9 +100,13 @@ module Metanorma
         end
       end
 
+      def termlookup_cleanup(xmldoc)
+        Metanorma::Standoc::TermLookupCleanup.new(xmldoc, @log).call
+      end
+
       def termdef_cleanup(xmldoc)
         termdef_unnest_cleanup(xmldoc)
-        Metanorma::Standoc::TermLookupCleanup.new(xmldoc, @log).call
+        termlookup_cleanup(xmldoc)
         term_nonverbal_designations(xmldoc)
         term_dl_to_metadata(xmldoc)
         term_termsource_to_designation(xmldoc)
@@ -117,7 +121,7 @@ module Metanorma
         termdocsource_cleanup(xmldoc)
       end
 
-      def index_cleanup(xmldoc)
+      def term_index_cleanup(xmldoc)
         return unless @index_terms
 
         xmldoc.xpath("//preferred").each do |p|

data/lib/metanorma/standoc/isodoc.rng

@@ -2504,6 +2504,16 @@
           <text/>
         </element>
       </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
       <optional>
         <element name="language">
           <text/>

data/lib/metanorma/standoc/ref_utility.rb

@@ -104,9 +104,9 @@ module Metanorma
         ret = { id: code }
         return ret if code.blank?
 
-        analyse_ref_nofetch(
-          analyse_ref_hidden(
-            analyse_ref_dropid(analyse_ref_repo_path(analyse_ref_numeric(ret))),
+        analyse_ref_numeric(
+          analyse_ref_repo_path(
+            analyse_ref_dropid(analyse_ref_hidden(analyse_ref_nofetch(ret))),
           ),
         )
       end
@@ -121,8 +121,7 @@ module Metanorma
       end
 
       def ref_attributes(match)
-
-code = analyse_ref_code(match[:code])
+        code = analyse_ref_code(match[:code])
 
         { id: match[:anchor], type: "standard",
           suppress_identifier: code[:dropid] || nil }

data/lib/metanorma/standoc/section.rb

@@ -38,6 +38,8 @@ module Metanorma
         when "symbols and abbreviated terms",
           "symbols", "abbreviated terms", "abbreviations"
           "symbols and abbreviated terms"
+        when "acknowledgements", "acknowledgments"
+          "acknowledgements"
         else
           ret
         end

data/lib/metanorma/standoc/term_lookup_cleanup.rb

@@ -68,7 +68,7 @@ module Metanorma
       end
 
       def remove_missing_ref(node, target)
-        if node.at("../concept[@type = 'symbol']")
+        if node.at("./parent::concept[@type = 'symbol']")
           remove_missing_ref_symbol(node, target)
         else
           remove_missing_ref_term(node, target)

data/lib/metanorma/standoc/utils.rb

@@ -60,7 +60,7 @@ module Metanorma
                         "[not(ancestor::boilerplate)]".freeze
 
       def isodoc(lang, script, i18nyaml = nil)
-        conv = html_converter(EmptyAttr.new)
+        conv = presentation_xml_converter(EmptyAttr.new)
         i18n = conv.i18n_init(lang, script, i18nyaml)
         conv.metadata_init(lang, script, i18n)
         conv

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.1.4".freeze
+    VERSION = "2.1.5".freeze
   end
 end

data/spec/metanorma/blocks_spec.rb

@@ -1070,6 +1070,56 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "ignores index terms when processing figures marked up as examples" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      ====
+      image::spec/examples/rice_images/rice_image3_1.png[]
+      ====
+
+      ====
+      ((indexterm))
+
+      image::spec/examples/rice_images/rice_image3_3.png[]
+      ====
+
+      ====
+      (((indexterm2)))
+
+      image::spec/examples/rice_images/rice_image3_2.png[]
+      ====
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+               <sections>
+           <figure id='_'>
+             <image src='spec/examples/rice_images/rice_image3_1.png' id='_' mimetype='image/png' height='auto' width='auto'/>
+           </figure>
+           <example id='_'>
+             <p id='_'>
+               indexterm
+               <index>
+                 <primary>indexterm</primary>
+               </index>
+             </p>
+             <figure id='_'>
+               <image src='spec/examples/rice_images/rice_image3_3.png' id='_' mimetype='image/png' height='auto' width='auto'/>
+             </figure>
+           </example>
+           <figure id='_'>
+             <index>
+               <primary>indexterm2</primary>
+             </index>
+             <image src='spec/examples/rice_images/rice_image3_2.png' id='_' mimetype='image/png' height='auto' width='auto'/>
+           </figure>
+         </sections>
+       </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
   it "processes images" do
     input = <<~INPUT
       #{ASCIIDOC_BLANK_HDR}

data/spec/metanorma/cleanup_blocks_spec.rb

@@ -1184,4 +1184,87 @@ RSpec.describe Metanorma::Standoc do
       .gsub(%r{<style.*?</style>}m, "<style/>")))
       .to be_equivalent_to xmlpp(output)
   end
+
+  it "removes paras with indexterms" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Clause 1
+
+      Paragraph
+
+      (((index)))
+
+      [NOTE]
+      --
+
+      (((index)))
+
+      Note
+      --
+
+      [NOTE]
+      --
+
+      (((index)))
+
+      --
+
+      == Clause 2
+
+      Paragraph
+
+      ((index))
+
+    INPUT
+
+    output = <<~OUTPUT
+       #{BLANK_HDR}
+               <sections>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause 1</title>
+             <p id='_'>
+               Paragraph
+               <index>
+                 <primary>index</primary>
+               </index>
+             </p>
+             <note id='_'>
+               <p id='_'>
+                 <index>
+                   <primary>index</primary>
+                 </index>
+                 Note
+               </p>
+             </note>
+             <note id='_'>
+               <p id='_'>
+                 <index>
+                   <primary>index</primary>
+                 </index>
+               </p>
+             </note>
+           </clause>
+           <clause id='_' inline-header='false' obligation='normative'>
+              <title>Clause 2</title>
+              <p id='_'>Paragraph</p>
+              <p id='_'>
+                index
+                <index>
+                  <primary>index</primary>
+                </index>
+              </p>
+            </clause>
+         </sections>
+       </standard-document>
+    OUTPUT
+    xml = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
+    xml.xpath("//*[local-name() = 'image']").each do |x|
+      x.replace("<image/>")
+    end
+    expect(xmlpp(strip_guid(xml.to_xml)
+      .gsub(%r{<style.*?</style>}m, "<style/>")))
+      .to be_equivalent_to xmlpp(output)
+  end
+
 end

data/spec/metanorma/isobib_cache_spec.rb

@@ -50,7 +50,7 @@ ISO_124_DATED = <<~XML.freeze
          <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:61884:en</uri>
          <uri type="rss">https://www.iso.org/contents/data/standard/06/18/61884.detail.rss</uri>
          <docidentifier type="ISO" primary="true">ISO 124:2014</docidentifier>
-         <docidentifier type='URN'>urn:iso:std:iso:124:stage-90.93:ed-7:en</docidentifier>
+         <docidentifier type='URN'>urn:iso:std:iso:124:stage-90.93:ed-7</docidentifier>
          <docnumber>124</docnumber>
          <date type="published">
            <on>2014-03</on>
@@ -82,6 +82,7 @@ ISO_124_DATED = <<~XML.freeze
          <relation type="obsoletes">
            <bibitem type="standard">
              <formattedref format="text/plain">ISO 124:2011</formattedref>
+             <docidentifier type='ISO' primary='true'>ISO 124:2011</docidentifier>
            </bibitem>
          </relation>
          <place>Geneva</place>
@@ -95,7 +96,7 @@ ISO_124_DATED = <<~XML.freeze
              <text>Latex and raw rubber</text>
            </ics>
            <structuredidentifier type="ISO">
-             <project-number part="">ISO 124</project-number>
+             <project-number>ISO 124</project-number>
            </structuredidentifier>
          </ext>
        </bibdata>
@@ -209,7 +210,7 @@ ISO_123_DATED = <<~XML.freeze
            <uri type="obp">https://www.iso.org/obp/ui/#!iso:std:23281:en</uri>
            <uri type="rss">https://www.iso.org/contents/data/standard/02/32/23281.detail.rss</uri>
            <docidentifier type="ISO" primary="true">ISO 123:2001</docidentifier>
-           <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3:en</docidentifier>
+           <docidentifier type='URN'>urn:iso:std:iso:123:stage-90.93:ed-3</docidentifier>
            <docnumber>123</docnumber>
            <date type="published">
              <on>2001-05</on>
@@ -247,6 +248,7 @@ ISO_123_DATED = <<~XML.freeze
            <relation type="obsoletes">
              <bibitem type="standard">
                <formattedref format="text/plain">ISO 123:1985</formattedref>
+               <docidentifier type='ISO' primary='true'>ISO 123:1985</docidentifier>
              </bibitem>
            </relation>
            <place>Geneva</place>
@@ -260,7 +262,7 @@ ISO_123_DATED = <<~XML.freeze
                <text>Latex and raw rubber</text>
              </ics>
              <structuredidentifier type="ISO">
-               <project-number part="">ISO 123</project-number>
+               <project-number>ISO 123</project-number>
              </structuredidentifier>
            </ext>
          </bibdata>

data/spec/metanorma/macros_spec.rb

@@ -1706,7 +1706,7 @@ RSpec.describe Metanorma::Standoc do
                 <uri type='src'>https://www.iso.org/standard/3944.html</uri>
                 <uri type='rss'>https://www.iso.org/contents/data/standard/00/39/3944.detail.rss</uri>
                 <docidentifier type='ISO' primary='true'>ISO 131</docidentifier>
-                <docidentifier type='URN'>urn:iso:std:iso:131:stage-95.99:ed-1:en</docidentifier>
+                <docidentifier type='URN'>urn:iso:std:iso:131:stage-95.99:ed-1</docidentifier>
                 <docnumber>131</docnumber>
                 <contributor>
                   <role type='publisher'/>
@@ -1734,6 +1734,7 @@ RSpec.describe Metanorma::Standoc do
                 <relation type='obsoletes'>
                   <bibitem type='standard'>
                     <formattedref format='text/plain'>ISO/R 357:1963</formattedref>
+                    <docidentifier type='ISO' primary='true'>ISO/R 357:1963</docidentifier>
                   </bibitem>
                 </relation>
                 <relation type='instance'>
@@ -1748,7 +1749,7 @@ RSpec.describe Metanorma::Standoc do
                     <uri type='src'>https://www.iso.org/standard/3944.html</uri>
                     <uri type='rss'>https://www.iso.org/contents/data/standard/00/39/3944.detail.rss</uri>
                     <docidentifier type='ISO' primary='true'>ISO 131:1979</docidentifier>
-                    <docidentifier type='URN'>urn:iso:std:iso:131:stage-95.99:ed-1:en</docidentifier>
+                    <docidentifier type='URN'>urn:iso:std:iso:131:stage-95.99:ed-1</docidentifier>
                     <docnumber>131</docnumber>
                     <date type='published'>
                       <on>1979-11</on>
@@ -1779,6 +1780,7 @@ RSpec.describe Metanorma::Standoc do
                     <relation type='obsoletes'>
                       <bibitem type='standard'>
                         <formattedref format='text/plain'>ISO/R 357:1963</formattedref>
+                        <docidentifier type='ISO' primary='true'>ISO/R 357:1963</docidentifier>
                       </bibitem>
                     </relation>
                     <place>Geneva</place>