metanorma-utils 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43530083e199af0abeff8df1b697507ed4f08f5039de4acba24409008c51e534
-  data.tar.gz: 19a237c0c4134abbf35daeeff19e0aeea715a528c9f55cd6150908460f21bed1
+  metadata.gz: 06b8911f4c03cb97f4a358a3d5bfeb3931f49bf205a06ff486f1897cf4413ab7
+  data.tar.gz: a1d15ab7db12270bec314abff49b6cd16e6150c13142e6ac338df19f46c5e2a1
 SHA512:
-  metadata.gz: a910ee73c2ee55d26cae92489643cd41b6de237f663910030475f4de1e295b45e6199f0722bc1dd8665007ccb0a3fdd1117fdb6dcb9a1dada1afc3998cd8e346
-  data.tar.gz: 8942457b7b8a19372a9a559c7db552e5c63675d2f26f24a17d47962c65c4cddd491eadfc56223533b8412f34c52cafbb3f818f16246c24ce76ed8b62810206d9
+  metadata.gz: 0b69767957d3f54acd8f85b023d876097561f83e6c606051dbde0889ff7e37cf368839424576164a7fe81698eef0417cfe2a6ea019ee04f591e8e10295c00d7f
+  data.tar.gz: c3203ed0411f37c048c558777d51955866e507c79454d686a80f4d9ab392e11f6f5332e03541d5d34cba77f779ad01275102a52127f517f4dd8eb06e626e501b

data/.github/workflows/rake.yml

@@ -10,23 +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@v2
-        with:
-          submodules: true
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake
+    uses: metanorma/metanorma-build-scripts/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

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/image.rb

@@ -115,8 +115,10 @@ module Metanorma
         svg.xpath("//m:style", "m" => SVG_NS).each do |s|
           c = s.children.to_xml
           ids.each do |i|
-            c = c.gsub(%r[##{i}\b], sprintf("#%s_%09d", i, idx))
-              .gsub(%r(\[id\s*=\s*['"]?#{i}['"]?\]), sprintf("[id='%s_%09d']", i, idx))
+            c = c.gsub(%r[##{i}\b],
+                       sprintf("#%<id>s_%<idx>09d", id: i, idx: idx))
+              .gsub(%r(\[id\s*=\s*['"]?#{i}['"]?\]),
+                    sprintf("[id='%<id>s_%<idx>09d']", id: i, idx: idx))
           end
           s.children = c
         end

data/lib/utils/log.rb

@@ -29,7 +29,7 @@ module Metanorma
               (!node.respond_to?(:level) || node.level.positive?) &&
               (!node.respond_to?(:context) || node.context != :section)
             node = node.parent
-            return "Section: #{node.title}" if node&.respond_to?(:context) &&
+            return "Section: #{node.title}" if node.respond_to?(:context) &&
               node&.context == :section
           end
           "??"
@@ -50,13 +50,19 @@ module Metanorma
           @log.each_key do |key|
             f.puts "\n\n== #{key}\n\n"
             @log[key].sort_by { |a| a[:location] }.each do |n|
-              loc = n[:location] ? "(#{n[:location]}): " : ""
-              f.puts "#{loc}#{n[:message]}"
-              n[:context]&.split(/\n/)&.first(5)&.each { |l| f.puts "\t#{l}" }
+              write1(f, n)
             end
           end
         end
       end
+
+      def write1(file, entry)
+        loc = entry[:location] ? "(#{entry[:location]}): " : ""
+        file.puts "#{loc}#{entry[:message]}"
+        entry[:context]&.split(/\n/)&.first(5)&.each do |l|
+          file.puts "\t#{l}"
+        end
+      end
     end
   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)
@@ -50,9 +51,13 @@ module Metanorma
 
       # TODO needs internationalisation
       def smartformat(text)
-        text.gsub(/ --? /, "&#8201;&#8212;&#8201;")
-          .gsub(/--/, "&#8212;").smart_format.gsub(/</, "&lt;")
-          .gsub(/>/, "&gt;")
+        HTMLEntities.new.encode(
+          HTMLEntities.new.decode(
+            text.gsub(/ --? /, "&#8201;&#8212;&#8201;")
+            .gsub(/--/, "&#8212;"),
+          )
+            .smart_format, :basic
+        )
       end
 
       def endash_date(elem)
@@ -68,10 +73,8 @@ module Metanorma
       def set_nested_value(hash, keys, new_val)
         key = keys[0]
         if keys.length == 1
-          hash[key] = if hash[key].is_a?(Array)
-                        (hash[key] << new_val)
-                      else
-                        hash[key].nil? ? new_val : [hash[key], new_val]
+          hash[key] = if hash[key].is_a?(Array) then (hash[key] << new_val)
+                      else hash[key].nil? ? new_val : [hash[key], new_val]
                       end
         elsif hash[key].is_a?(Array)
           hash[key][-1] = {} if !hash[key].empty? && hash[key][-1].nil?
@@ -118,35 +121,49 @@ module Metanorma
         end
       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(/<[^>]*>+/, "")
+      def default_script(lang)
+        case lang
+        when "ar", "fa" then "Arab"
+        when "ur" then "Aran"
+        when "ru", "bg" then "Cyrl"
+        when "hi" then "Deva"
+        when "el" then "Grek"
+        when "zh" then "Hans"
+        when "ko" then "Kore"
+        when "he" then "Hebr"
+        when "ja" then "Jpan"
         else
-          result << node.content.gsub(/<[^>]*>+/, "")
+          "Latn"
         end
-        result.reject(&:empty?)
+      end
+
+      def rtl_script?(script)
+        %w(Arab Aran Hebr).include? script
+      end
+
+      # 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
+        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.7".freeze
+    VERSION = "1.3.0".freeze
   end
 end

data/lib/utils/xml.rb

@@ -0,0 +1,59 @@
+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
+    end
+  end
+end

data/metanorma-utils.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.add_dependency "asciidoctor", "~> 2.0.0"
+  spec.add_dependency "asciidoctor", ">= 2"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "htmlentities", "~> 4.3.4"
   spec.add_dependency "marcel", "~> 1.0.0"
   spec.add_dependency "mime-types"
-  spec.add_dependency "nokogiri", "~> 1.11"
+  spec.add_dependency "nokogiri", ">= 1.11"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "uuidtools"
 
@@ -37,12 +37,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
-  spec.add_development_dependency "metanorma-standoc", "~> 1.10"
+  spec.add_development_dependency "metanorma-standoc", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "vcr", "~> 5.0.0"
+  spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
 end