metanorma-utils 1.2.9 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d2ac1711efc0b167d21909878face2dd4787e79d9aa5141d58908c1a8904056
-  data.tar.gz: e632e154726172f7ce1d09b0450d9b0ad70274936070336e01d05baff77e21ad
+  metadata.gz: cb766833ae078338bdac8e0954736f83dfc5feee9de6cbc15c03bd1998848529
+  data.tar.gz: 93ee70fa9e268f252c5c9c3f5dd58e2859c2b794b13d50e117f374ae8e80efde
 SHA512:
-  metadata.gz: cc3c1a6c0482904f4bc9a5b94a1c8ac42e4da45961c7fc6bb4ccbe527ef51cda959707f4f4906ed6042cf30e9c1407eec071c04aa57b551a0c38a86a791a3c46
-  data.tar.gz: dc015326b8d670cddc54488b452f48c7cf922a3677520d579798c8b56497957e3d934222f3f065a4600ea7bc0dc860ae6a8fd3fd5b443f38f482a5e84a8ce6ed
+  metadata.gz: 8572ae07eb6b970d0b00c1289b0652c293690b241b4d39a91b4df235a77ef29809dba122be75795bd7f8bde1fcebd59deeee9cb4f001259675626f73e0cd5869
+  data.tar.gz: 63f761a6ada0d87f7663811b89f594eb23dafb9d9da9c130d158bd58671648fc5b6cd8a3ed9db895345b1267e3c02141937bda7141e414971dabafa9ec93bbaa

data/lib/metanorma-utils.rb

@@ -2,3 +2,4 @@ require_relative "utils/version"
 require_relative "utils/main"
 require_relative "utils/image"
 require_relative "utils/log"
+require_relative "utils/xml"

data/lib/utils/hash_transform_keys.rb

@@ -48,4 +48,20 @@ class Hash
     end
     result
   end
+
+  def deep_merge(second)
+    merger = proc { |_, v1, v2|
+      if Hash === v1 && Hash === v2
+        v1.merge(v2, &merger)
+      elsif Array === v1 && Array === v2
+        v1 | v2
+      elsif [:undefined, nil,
+             :nil].include?(v2)
+        v1
+      else
+        v2
+      end
+    }
+    merge(second.to_h, &merger)
+  end
 end

data/lib/utils/main.rb

@@ -1,34 +1,35 @@
 require "asciidoctor"
 require "tempfile"
 require "sterile"
-require "uuidtools"
 require "htmlentities"
+require "nokogiri"
 
 module Metanorma
   module Utils
-    NAMECHAR = "\u0000-\u002c\u002f\u003a-\u0040\\u005b-\u005e"\
-               "\u0060\u007b-\u00b6\u00b8-\u00bf\u00d7\u00f7\u037e"\
-               "\u2000-\u200b"\
-               "\u200e-\u203e\u2041-\u206f\u2190-\u2bff\u2ff0-\u3000".freeze
-    NAMESTARTCHAR = "\\u002d\u002e\u0030-\u0039\u00b7\u0300-\u036f"\
-                    "\u203f-\u2040".freeze
-
     class << self
-      def to_ncname(tag, asciionly: true)
-        asciionly and tag = HTMLEntities.new.encode(tag, :basic, :hexadecimal)
-        start = tag[0]
-        ret1 = if %r([#{NAMECHAR}#])o.match?(start)
-                 "_"
-               else
-                 (%r([#{NAMESTARTCHAR}#])o.match?(start) ? "_#{start}" : start)
-               end
-        ret2 = tag[1..-1] || ""
-        (ret1 || "") + ret2.gsub(%r([#{NAMECHAR}#])o, "_")
+      def attr_code(attributes)
+        attributes.compact.transform_values do |v|
+          v.is_a?(String) ? HTMLEntities.new.decode(v) : v
+        end
       end
 
-      def anchor_or_uuid(node = nil)
-        uuid = UUIDTools::UUID.random_create
-        node.nil? || node.id.nil? || node.id.empty? ? "_#{uuid}" : node.id
+      # , " => ," : CSV definition does not deal with space followed by quote
+      # at start of field
+      def csv_split(text, delim = ";")
+        return if text.nil?
+
+        CSV.parse_line(text&.gsub(/#{delim} "(?!")/, "#{delim}\""),
+                       liberal_parsing: true,
+                       col_sep: delim)&.compact&.map(&:strip)
+      end
+
+      # if the contents of node are blocks, output them to out;
+      # else, wrap them in <p>
+      def wrap_in_para(node, out)
+        if node.blocks? then out << node.content
+        else
+          out.p { |p| p << node.content }
+        end
       end
 
       def asciidoc_sub(text, flavour = :standoc)
@@ -140,35 +141,29 @@ module Metanorma
         %w(Arab Aran Hebr).include? script
       end
 
-      # not currently used
-      def flatten_rawtext_lines(node, result)
-        node.lines.each do |x|
-          result << if node.respond_to?(:context) &&
-              (node.context == :literal || node.context == :listing)
-                      x.gsub(/</, "&lt;").gsub(/>/, "&gt;")
-                    else
-                      # strip not only HTML <tag>, and Asciidoc xrefs <<xref>>
-                      x.gsub(/<[^>]*>+/, "")
-                    end
-        end
-        result
-      end
-
-      # not currently used
-      # if node contains blocks, flatten them into a single line;
-      # and extract only raw text
-      def flatten_rawtext(node)
-        result = []
-        if node.respond_to?(:blocks) && node.blocks?
-          node.blocks.each { |b| result << flatten_rawtext(b) }
-        elsif node.respond_to?(:lines)
-          result = flatten_rawtext_lines(node, result)
-        elsif node.respond_to?(:text)
-          result << node.text.gsub(/<[^>]*>+/, "")
-        else
-          result << node.content.gsub(/<[^>]*>+/, "")
+      # convert definition list term/value pair into Nokogiri XML attribute
+      def dl_to_attrs(elem, dlist, name)
+        e = dlist.at("./dt[text()='#{name}']") or return
+        val = e.at("./following::dd/p") || e.at("./following::dd") or return
+        elem[name] = val.text
+      end
+
+      # convert definition list term/value pairs into Nokogiri XML elements
+      def dl_to_elems(ins, elem, dlist, name)
+        a = elem.at("./#{name}[last()]")
+        ins = a if a
+        dlist.xpath("./dt[text()='#{name}']").each do |e|
+          ins = dl_to_elems1(e, name, ins)
         end
-        result.reject(&:empty?)
+        ins
+      end
+
+      def dl_to_elems1(term, name, ins)
+        v = term.at("./following::dd")
+        e = v.elements and e.size == 1 && e.first.name == "p" and v = e.first
+        v.name = name
+        ins.next = v
+        ins.next
       end
     end
   end

data/lib/utils/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Utils
-    VERSION = "1.2.9".freeze
+    VERSION = "1.3.2".freeze
   end
 end

data/lib/utils/xml.rb

@@ -0,0 +1,66 @@
+require "asciidoctor"
+require "tempfile"
+require "uuidtools"
+require "htmlentities"
+require "nokogiri"
+
+module Metanorma
+  module Utils
+    NAMECHAR = "\u0000-\u002c\u002f\u003a-\u0040\\u005b-\u005e"\
+               "\u0060\u007b-\u00b6\u00b8-\u00bf\u00d7\u00f7\u037e"\
+               "\u2000-\u200b"\
+               "\u200e-\u203e\u2041-\u206f\u2190-\u2bff\u2ff0-\u3000".freeze
+    NAMESTARTCHAR = "\\u002d\u002e\u0030-\u0039\u00b7\u0300-\u036f"\
+                    "\u203f-\u2040".freeze
+
+    class << self
+      def to_ncname(tag, asciionly: true)
+        asciionly and tag = HTMLEntities.new.encode(tag, :basic, :hexadecimal)
+        start = tag[0]
+        ret1 = if %r([#{NAMECHAR}#])o.match?(start)
+                 "_"
+               else
+                 (%r([#{NAMESTARTCHAR}#])o.match?(start) ? "_#{start}" : start)
+               end
+        ret2 = tag[1..-1] || ""
+        (ret1 || "") + ret2.gsub(%r([#{NAMECHAR}#])o, "_")
+      end
+
+      def anchor_or_uuid(node = nil)
+        uuid = UUIDTools::UUID.random_create
+        node.nil? || node.id.nil? || node.id.empty? ? "_#{uuid}" : node.id
+      end
+
+      NOKOHEAD = <<~HERE.freeze
+        <!DOCTYPE html SYSTEM
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+        <head> <title></title> <meta charset="UTF-8" /> </head>
+        <body> </body> </html>
+      HERE
+
+      # block for processing XML document fragments as XHTML,
+      # to allow for HTMLentities
+      # Unescape special chars used in Asciidoctor substitution processing
+      def noko(&block)
+        doc = ::Nokogiri::XML.parse(NOKOHEAD)
+        fragment = doc.fragment("")
+        ::Nokogiri::XML::Builder.with fragment, &block
+        fragment.to_xml(encoding: "US-ASCII", indent: 0,
+                        save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
+          .lines.map do |l|
+          l.gsub(/>\n$/, ">").gsub(/\s*\n$/m, " ").gsub("&#150;", "\u0096")
+            .gsub("&#151;", "\u0097").gsub("&#x96;", "\u0096")
+            .gsub("&#x97;", "\u0097")
+        end
+      end
+
+      def ns(xpath)
+        xpath.gsub(%r{/([a-zA-z])}, "/xmlns:\\1")
+          .gsub(%r{::([a-zA-z])}, "::xmlns:\\1")
+          .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/-]* ?=)}, "[xmlns:\\1")
+          .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/-]*[/\[\]])}, "[xmlns:\\1")
+      end
+    end
+  end
+end

data/spec/hash_transform_keys_spec.rb

@@ -49,4 +49,11 @@ RSpec.describe Metanorma::Utils do
     expect(result[:test4][0]).to include(:test41)
     expect(result[:test4][0][:test41]).to eq("test41")
   end
+
+  it "deep merges hashes" do
+    hash1 = { a: [1, 2], b: "c", c: 4, e: { f: { g: "1" } } }
+    hash2 = { a: [3], b: "d", d: 5, e: { f: { h: "2" } } }
+    expect(hash1.deep_merge(hash2)).to eq({ a: [1, 2, 3], b: "d", c: 4,
+                                            d: 5, e: { f: { g: "1", h: "2" } } })
+  end
 end