metanorma-standoc 2.9.2 → 2.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afbcf21ea1b8e99868178616c755a4dcef811f631326c65f6835ad491d1f2835
-  data.tar.gz: 9d3499adf6025521d2683f4456e64b1cd27dd63722c231de8fab7aa47fe79973
+  metadata.gz: e946ea4ef470077763b56b2435a231a884ddede3c32f9bd09dde4fd912b15bfc
+  data.tar.gz: 80511a11e935c1e090be377db8180907835895d5507e8b4e88df6c2dee7d4f9a
 SHA512:
-  metadata.gz: 46a8beb31cb6230dccdcdb36352dd05e705a3114d0b1b6e04b46b1a445aa1fe30249426c81be8a441f615c95fe633cc078bd70c030616cdc25ff4c50eb45ab76
-  data.tar.gz: 300aeca29fa514e88535c4f60577f9a6e83446f195b76e7e15029ae912d0beb06c0f6f028b098e4662ab53fbf83fc8e675a920ef7c3269f1e501afa835ba127f
+  metadata.gz: a72d55869cbd272db4c6818cd8aadd3057021bf4b876c595ecb6c10d98008c7da98368189df23ad25297eaa68119c2c2cdc3efeb9b573812b9a200974458d703
+  data.tar.gz: 6710ac348b46e662a77ec202ec26944c3d0956a5b984546995444f352f661fefff3995c328ee6c7b2448137d690a7091db2b873584a277279f1c01e549c8a099

data/lib/metanorma/standoc/anchor.rb

@@ -15,7 +15,7 @@ module Metanorma
       def inline_anchor_ref(node)
         noko do |xml|
           xml.bookmark nil, **attr_code(id: node.id)
-        end.join
+        end
       end
 
       def inline_anchor_xref(node)
@@ -26,7 +26,7 @@ module Metanorma
           xml.xref **attr_code(attrs) do |x|
             x << c
           end
-        end.join
+        end
       end
 
       def inline_anchor_xref_attrs(node)
@@ -83,7 +83,7 @@ module Metanorma
           xml.link **attr_code(attributes) do |l|
             l << contents
           end
-        end.join
+        end
       end
 
       def inline_anchor_link_attrs(node)
@@ -103,7 +103,7 @@ module Metanorma
           xml.ref **attr_code(id: node.target || node.id) do |r|
             r << eref_contents
           end
-        end.join
+        end
       end
 
       def inline_anchor_bibref_contents(node)
@@ -114,7 +114,7 @@ module Metanorma
       def inline_callout(node)
         noko do |xml|
           xml.callout node.text
-        end.join
+        end
       end
 
       def inline_footnote(node)
@@ -124,7 +124,7 @@ module Metanorma
           xml.fn reference: @fn_number do |fn|
             fn.p { |p| p << node.text }
           end
-        end.join
+        end
       end
     end
   end

data/lib/metanorma/standoc/blocks.rb

@@ -90,7 +90,7 @@ module Metanorma
             )) do |ex|
             wrap_in_para(node, ex)
           end
-        end.join("")
+        end
       end
 
       def example(node)
@@ -128,7 +128,7 @@ module Metanorma
             figure_title(node, ex)
             wrap_in_para(node, ex)
           end
-        end.join("")
+        end
       end
 
       def example_attrs(node)
@@ -141,7 +141,7 @@ module Metanorma
             node.title.nil? or ex.name { |name| name << node.title }
             wrap_in_para(node, ex)
           end
-        end.join("")
+        end
       end
 
       def para_attrs(node)
@@ -158,7 +158,7 @@ module Metanorma
           xml.p **para_attrs(node) do |xml_t|
             xml_t << node.content
           end
-        end.join("")
+        end
       end
 
       def quote_attrs(node)
@@ -183,7 +183,7 @@ module Metanorma
             quote_attribution(node, q)
             wrap_in_para(node, q)
           end
-        end.join("")
+        end
       end
 
       def listing_attrs(node)

data/lib/metanorma/standoc/blocks_image.rb

@@ -17,7 +17,7 @@ module Metanorma
             figure_title(node, ex)
             ex << node.content
           end
-        end.join("\n")
+        end
       end
 
       def figure_example(node)
@@ -26,7 +26,7 @@ module Metanorma
             node.title.nil? or ex.name { |name| name << node.title }
             wrap_in_para(node, ex)
           end
-        end.join("")
+        end
       end
 
       def figure_title(node, out)

data/lib/metanorma/standoc/blocks_notes.rb

@@ -32,7 +32,7 @@ module Metanorma
           xml.review **sidebar_attrs(node) do |r|
             wrap_in_para(node, r)
           end
-        end.join("")
+        end
       end
 
       def todo_attrs(node)
@@ -49,7 +49,7 @@ module Metanorma
           xml.review **todo_attrs(node) do |r|
             wrap_in_para(node, r)
           end
-        end.join("")
+        end
       end
 
       def termnote(node)
@@ -57,7 +57,7 @@ module Metanorma
           xml.termnote **termnote_attrs(node) do |ex|
             wrap_in_para(node, ex)
           end
-        end.join("")
+        end
       end
 
       def note(node)
@@ -67,7 +67,7 @@ module Metanorma
           xml.note **note_attrs(node) do |c|
             wrap_in_para(node, c)
           end
-        end.join("")
+        end
       end
 
       def boilerplate_note(node)
@@ -101,7 +101,7 @@ module Metanorma
             node.title.nil? or a.name { |name| name << node.title }
             wrap_in_para(node, a)
           end
-        end.join("")
+        end
       end
 
       def admonition_alternatives(node)

data/lib/metanorma/standoc/cleanup.rb

@@ -82,6 +82,7 @@ module Metanorma
         boilerplate_cleanup(xmldoc)
         toc_cleanup(xmldoc)
         smartquotes_cleanup(xmldoc)
+        linebreak_cleanup(xmldoc)
         variant_cleanup(xmldoc)
         para_cleanup(xmldoc)
         empty_element_cleanup(xmldoc)
@@ -137,7 +138,7 @@ module Metanorma
       end
 
       def element_name_cleanup(xmldoc)
-        xmldoc.traverse { |n| n.name = n.name.gsub("_", "-") }
+        xmldoc.traverse { |n| n.name = n.name.tr("_", "-") }
       end
 
       # allows us to deal with doc relation localities,

data/lib/metanorma/standoc/cleanup_symbols.rb

@@ -10,7 +10,7 @@ module Metanorma
       def symbol_key(sym)
         @c.decode(asciimath_key(sym).text)
           .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
-          .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub("`", "")
+          .gsub(/[[:punct:]]|[_^]/, ":\\0").delete("`")
           .gsub(/[0-9]+/, "þ\\0")
           .tr("AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz",
               "ABCFEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz")

data/lib/metanorma/standoc/cleanup_terms_designations.rb

@@ -46,7 +46,7 @@ module Metanorma
         %w(absent geographic-area).each do |a|
           dl_to_attrs(prev, dlist, a)
         end
-        %w(field-of-application usage-info).reverse.each do |a|
+        %w(field-of-application usage-info).reverse_each do |a|
           dl_to_elems(prev.at("./expression"), prev, dlist, a)
         end
       end
@@ -78,7 +78,7 @@ module Metanorma
       end
 
       def term_dl_to_expression_name_metadata(prev, dlist)
-        %w(abbreviation-type pronunciation).reverse.each do |a|
+        %w(abbreviation-type pronunciation).reverse_each do |a|
           dl_to_elems(prev.at("./expression/name"), prev, dlist, a)
         end
         g = dlist.at("./dt[text()='grammar']/following::dd//dl") and
@@ -89,7 +89,7 @@ module Metanorma
         prev.at(".//expression") or return
         prev.at(".//expression") << "<grammar><sentinel/></grammar>"
         %w(gender number isPreposition isParticiple isAdjective isAdverb isNoun
-           grammar-value).reverse.each do |a|
+           grammar-value).reverse_each do |a|
           dl_to_elems(prev.at(".//expression/grammar/*"), prev.elements.last,
                       dlist, a)
         end

data/lib/metanorma/standoc/cleanup_text.rb

@@ -11,6 +11,54 @@ module Metanorma
         text
       end
 
+      def ancestor_include?(elem, ancestors)
+        path = elem.path.gsub(/\[\d+\]/, "").split(%r{/})[1..-2]
+        !path.intersection(ancestors).empty?
+      end
+
+      def linebreak_cleanup(xmldoc)
+        xmldoc.traverse do |x|
+          x.text? && x.text.include?("\n") or next
+          ancestor_include?(x, PRESERVE_LINEBREAK_ELEMENTS) and next
+          ancestor_include?(x, STRIP_LINEBREAK_ELEMENTS) or next
+          x.replace(Metanorma::Utils
+            .line_sanitise(x.text.lines.map(&:rstrip)).join)
+        end
+      end
+
+      # process example/p, example/sourcecode, not example on its own:
+      # this is about stripping lines for blocks containing inline elems & text
+      def linebreak_cleanup(xmldoc)
+        xmldoc.xpath(STRIP_LINEBREAK_ELEMENTS.map { |e| "//#{e}" }.join(" | "))
+          .each do |b|
+            b.xpath(STRIP_LINEBREAK_ELEMENTS.map { |e| ".//#{e}" }.join(" | "))
+              .empty? or next
+            linebreak_cleanup_block(gather_text_for_linebreak_cleanup(b))
+          end
+      end
+
+      def linebreak_cleanup_block(block)
+        block.each_with_index do |e, i|
+          e[:skip] and next
+          lines = e[:text].lines.map(&:rstrip)
+          e[:last] or lines << block[i + 1][:text].lines.first # next token context
+          out = Metanorma::Utils.line_sanitise(lines)
+          e[:last] or out.pop
+          e[:elem].replace(out.join)
+        end
+      end
+
+      def gather_text_for_linebreak_cleanup(block)
+        x = block.xpath(".//text()").map do |e|
+          { elem: e, text: e.text,
+            skip: ancestor_include?(e, PRESERVE_LINEBREAK_ELEMENTS) }
+        end
+        x.empty? and return x
+        x.each { |e| e[:skip] ||= !e[:text].include?("\n") }
+        x[-1][:last] = true
+        x
+      end
+
       def smartquotes_cleanup(xmldoc)
         xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
         if @smartquotes then smartquotes_cleanup1(xmldoc)
@@ -37,10 +85,20 @@ module Metanorma
         %w(pre tt sourcecode stem asciimath figure bibdata passthrough
            identifier metanorma-extension).freeze
 
+      PRESERVE_LINEBREAK_ELEMENTS =
+        %w(pre sourcecode passthrough metanorma-extension).freeze
+
+      STRIP_LINEBREAK_ELEMENTS =
+        %w(title name variant-title figure example review admonition
+           note li th td dt dd p quote label annotation
+           preferred admitted related deprecates field-of-application
+           usage-info expression pronunciation grammar-value domain
+           definition termnote termexample modification description
+           newcontent floating-title).freeze
+
       def uninterrupt_quotes_around_xml_skip(elem)
         !(/\A['"]/.match?(elem.text) &&
-          elem.previous.path.gsub(/\[\d+\]/, "").split(%r{/})[1..-2]
-          .intersection(IGNORE_QUOTES_ELEMENTS).empty? &&
+        !ancestor_include?(elem.previous, IGNORE_QUOTES_ELEMENTS) &&
           ((elem.previous.text.strip.empty? &&
             !empty_tag_with_text_content?(elem.previous)) ||
            ignoretext?(elem.previous)))
@@ -69,7 +127,7 @@ module Metanorma
            abstract preferred admitted related deprecates field-of-application
            usage-info expression pronunciation grammar-value domain
            definition termnote termexample modification description
-           newcontent floating-title tab).include? elem.name
+           newcontent floating-title tab review admonition annotation).include? elem.name
       end
 
       def empty_tag_with_text_content?(elem)
@@ -83,8 +141,9 @@ module Metanorma
           empty_tag_with_text_content?(x) and prev = "dummy"
           x.text? or next
 
-          ancestors = x.path.gsub(/\[\d+\]/, "").split(%r{/})[1..-2]
-          ancestors.intersection(IGNORE_QUOTES_ELEMENTS).empty? or next
+          # ancestors = x.path.gsub(/\[\d+\]/, "").split(%r{/})[1..-2]
+          # ancestors.intersection(IGNORE_QUOTES_ELEMENTS).empty? or next
+          ancestor_include?(x, IGNORE_QUOTES_ELEMENTS) and next
           dumb2smart_quotes1(x, prev)
           prev = x.text
         end

data/lib/metanorma/standoc/inline.rb

@@ -11,19 +11,19 @@ module Metanorma
         noko do |xml|
           xml << node.text
           xml.br
-        end.join
+        end
       end
 
       def page_break(node)
         attrs = {}
         node.option?("landscape") and attrs[:orientation] = "landscape"
         node.option?("portrait") and attrs[:orientation] = "portrait"
-        noko { |xml| xml.pagebreak **attr_code(attrs) }.join
+        noko { |xml| xml.pagebreak **attr_code(attrs) }
       end
 
       def thematic_break(_node)
         # noko(&:hr).join # Do not do this, noko blows up
-        noko { |xml| xml.hr }.join # rubocop:disable Style/SymbolProc
+        noko { |xml| xml.hr } # rubocop:disable Style/SymbolProc
       end
 
       def latex_parse1(text, block)
@@ -102,7 +102,7 @@ module Metanorma
               xml << node.text
             end
           end
-        end.join
+        end
       end
 
       def hash2styles(role)
@@ -146,7 +146,7 @@ module Metanorma
       def inline_image(node)
         noko do |xml|
           xml.image **image_attributes(node)
-        end.join
+        end
       end
 
       def inline_indexterm(node)
@@ -154,7 +154,7 @@ module Metanorma
           node.type == :visible and xml << node.text
           terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
           inline_indexterm1(xml, terms)
-        end.join
+        end
       end
 
       def inline_indexterm1(xml, terms)

data/lib/metanorma/standoc/lists.rb

@@ -41,7 +41,7 @@ module Metanorma
             list_caption(node, xml_ul)
             node.items.each { |item| ul_li(xml_ul, item) }
           end
-        end.join("")
+        end
       end
 
       def olist_style(style)
@@ -67,7 +67,7 @@ module Metanorma
             list_caption(node, xml_ol)
             node.items.each { |item| li(xml_ol, item) }
           end
-        end.join("")
+        end
       end
 
       def dt(terms, xml_dl)
@@ -107,7 +107,7 @@ module Metanorma
               dd(dd, xml_dl)
             end
           end
-        end.join("")
+        end
       end
 
       def colist(node)
@@ -117,7 +117,7 @@ module Metanorma
               xml_li.p { |p| p << item.text }
             end
           end
-        end.join("")
+        end
       end
 
       def list_caption(node, out)

data/lib/metanorma/standoc/ref_queue.rb

@@ -24,7 +24,7 @@ module Metanorma
 
       def references2xml(ret)
         out = ret.map do |b|
-          b.nil? ? nil : noko { |xml| reference1out(b, xml) }.join
+          b.nil? ? nil : noko { |xml| reference1out(b, xml) }
         end
         out.map { |x| x.nil? ? nil : Nokogiri::XML(x).root }
       end

data/lib/metanorma/standoc/section.rb

@@ -141,7 +141,7 @@ module Metanorma
               clause_parse(a, xml, node)
             end
           end
-        end.join("\n")
+        end
       end
 
       def set_obligation(attrs, node)
@@ -162,7 +162,7 @@ module Metanorma
             end
             xml_abstract << node.content
           end
-        end.join("\n")
+        end
       end
 
       def misccontainer_parse(_attrs, xml, node)
@@ -243,7 +243,7 @@ module Metanorma
           xml.floating_title **floating_title_attrs(node) do |xml_t|
             xml_t << node.title
           end
-        end.join("\n")
+        end
       end
     end
   end

data/lib/metanorma/standoc/spans_to_bibitem.rb

@@ -131,7 +131,7 @@ module Metanorma
           span[:surname] and return
           msg = "Missing surname: issue with bibliographic markup " \
                 "in \"#{title}\": #{span}"
-          @err << { msg: msg, fatal: true }
+          @err << { msg:, fatal: true }
         end
 
         def span_to_person(span, title)

data/lib/metanorma/standoc/terms.rb

@@ -170,7 +170,7 @@ module Metanorma
             seen_xref = Nokogiri::XML.fragment(matched[:xref])
             add_term_source(node, xml_t, seen_xref, matched)
           end
-        end.join("")
+        end
       end
 
       def termdefinition(node)
@@ -178,7 +178,7 @@ module Metanorma
           xml.definition **attr_code(type: node.attr("type")) do |d|
             d << node.content
           end
-        end.join("")
+        end
       end
     end
   end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.9.2".freeze
+    VERSION = "2.9.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -32,12 +32,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "crass", "~> 1.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 2.10.5"
+  spec.add_dependency "isodoc", "~> 2.11.0"
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.3.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.7.0"
-  spec.add_dependency "metanorma-utils", "~> 1.9.0"
+  spec.add_dependency "metanorma-utils", "~> 1.10.0"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma
   spec.add_dependency "asciimath2unitsml", "~> 0.4.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 2.9.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.5
+        version: 2.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.5
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: ruby-jing
   requirement: !ruby/object:Gem::Requirement