metanorma-utils 1.2.8 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 292c59c5af886a4ee9c6536f299fce7f70c8ebe58009bdd317ee438411a1ea0b
-  data.tar.gz: '0593b2df3787f376b0369cadd96b277f988cab030a60f90104599ec86f9b481e'
+  metadata.gz: fd89605d15a5973a46c4fbc9b88c024191e6a809e4255f34db32d57bab198cc3
+  data.tar.gz: 167f7c09e8b6347c0f5990656775cba5ec5cdc05a2b715690451e3c02f80fb65
 SHA512:
-  metadata.gz: ea0f40979be2bde7c11bf6ee30cf02e67d924928383c6d9bbcef20d67b1db686c4528fdc4a0e8b54b019dcc988e18c405f011e282445290a3638bcfa38737fe5
-  data.tar.gz: ec2c9516dc1e4161a7c07d1d7b96cd9c826ee33fff2e1ca322c63eb7ef3163de3ce597e5d19a49eea009bff2fb81e00923e56ee74109b58ff6765b42f3114079
+  metadata.gz: 1baca64c93f1598bd4f6285ac62c912a519a36c9a9ee08dfe883fe5af0cd721983cc3be513d2dd3d8329ff9efbcc940f0f207ed40791e93556a477ac230c6bb0
+  data.tar.gz: f4a13c5846b93d6fa7262736a5e177e809ddf72340713c890a7bcddad8d2ba2526e71ee5eff0dd3900e10a6c45b0f00cf7944a30ab1343feef34d3679428e795

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/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)
@@ -136,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.8".freeze
+    VERSION = "1.3.1".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/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