metanorma-standoc 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0296f73b69a974d8471004f27194fd72f0005a4b9b76ea99c5fc0ad8828734
-  data.tar.gz: dfdba4afa101c91c4d83697876770fd2ea26da7a197702a1a3087157e257bf66
+  metadata.gz: 2fa7cc0e4e5c2924e92c7c4dd3cf6b55a3cc5374a9a65b1fe4a6b6f25bbe4130
+  data.tar.gz: 234c872403176e8a697f7e8380be547be37e774e7ac39a28aed6fc1142d31668
 SHA512:
-  metadata.gz: 5891c907305ea29a718370385a72ae3cc8156f42562fabda70dce276d740cf20160da3d84dda0be783315b5b287bab3732bb03fb33dfdfe59587f03100347d27
-  data.tar.gz: 11a9e73079c234d6db80af6d500ce24e8847b4c5fc40cf2e4aadd08ee520462248ccd1e1ff5c77e4dd84fb241ada3821cecc70f4d610179655d55bc49e041caf
+  metadata.gz: cbef9d2a3d3f39105b100bd122153af812322aec99e4b05fc83f45579d0b1cc59d8606a860be9f3a104f3169557bf61cd5949c4424fd3cd692cbb20a5b7775c6
+  data.tar.gz: 7c73c0f914d76af8b2b4f3be93e68c49baeea4791976f423ae4198b9d99f1066ee21616edcbfba660d0a2dc91bb87f6d014e01726018468e177db8031af550a5

data/.travis.yml

@@ -4,14 +4,22 @@ os:
 - linux
 - osx
 rvm:
+- 2.6
 - 2.5
 - 2.4
 - ruby-head
 before_install:
+- nvm install 8
+- npm install -g puppeteer
+- npm install
+- curl -L https://cpanmin.us | perl - --sudo App::cpanminus
+- sudo cpanm --notest LaTeXML@0.8.4
+- curl -L https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/travis.sh | bash
+- plantuml -version
 - gem install bundler -v 2.0.1
 - bundle update
 - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo bash -c "apt-get update && curl -L https://raw.githubusercontent.com/metanorma/metanorma-linux-setup/master/ubuntu.sh | bash" ; fi
-- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install --HEAD https://raw.githubusercontent.com/metanorma/homebrew-metanorma/master/Formula/metanorma.rb ; fi
+- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then travis_wait brew install --HEAD https://raw.githubusercontent.com/metanorma/homebrew-metanorma/master/Formula/metanorma.rb ; fi
 matrix:
   allow_failures:
     - rvm: ruby-head

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    metanorma-standoc (1.2.2)
+    metanorma-standoc (1.2.3)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
       html2doc (~> 0.8.11)
       iev (~> 0.2.1)
       isodoc (~> 0.10.0)
-      relaton (~> 0.4.0)
+      relaton (~> 0.5.0)
+      relaton-iev (~> 0.1.0)
       ruby-jing
       sterile (~> 1.0.14)
       unicode2latex (~> 0.0.1)
@@ -50,7 +51,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (0.4.0)
+    hashdiff (1.0.0)
     html2doc (0.8.12)
       asciimath (~> 1.0.7)
       htmlentities (~> 4.3.4)
@@ -64,7 +65,7 @@ GEM
     iev (0.2.2)
       nokogiri
     image_size (2.0.2)
-    isodoc (0.10.2)
+    isodoc (0.10.3)
       asciimath
       html2doc (~> 0.8.11)
       htmlentities (~> 4.3.4)
@@ -91,10 +92,10 @@ GEM
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0331)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     nenv (0.3.0)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -108,44 +109,44 @@ GEM
       method_source (~> 0.9.0)
     public_suffix (3.1.1)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (12.3.3)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton (0.4.3)
+    relaton (0.5.0)
       algoliasearch
-      relaton-gb (~> 0.5.0)
-      relaton-iec (~> 0.3.0)
-      relaton-ietf (~> 0.5.0)
-      relaton-iso (~> 0.5.0)
-      relaton-iso-bib (~> 0.2.0)
-      relaton-itu (~> 0.2.0)
-      relaton-nist (~> 0.2.0)
-    relaton-bib (0.2.4)
+      relaton-gb (~> 0.6.0)
+      relaton-iec (~> 0.4.0)
+      relaton-ietf (~> 0.6.0)
+      relaton-iso (~> 0.6.0)
+      relaton-iso-bib (~> 0.3.0)
+      relaton-itu (~> 0.3.0)
+      relaton-nist (~> 0.3.0)
+    relaton-bib (0.3.1)
       addressable
-      nokogiri (~> 1.8.4)
-    relaton-gb (0.5.1)
+      nokogiri (~> 1.10)
+    relaton-gb (0.6.0)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
-      relaton-iso-bib (~> 0.2.0)
-    relaton-iec (0.3.1)
+      relaton-iso-bib (~> 0.3.0)
+    relaton-iec (0.4.1)
       addressable
-      relaton-iso-bib (~> 0.2.0)
-    relaton-ietf (0.5.4)
-      relaton-iso-bib (~> 0.2.0)
-    relaton-iso (0.5.3)
-      algoliasearch
-      relaton-iec (~> 0.3.0)
-      relaton-iso-bib (~> 0.2.0)
-    relaton-iso-bib (0.2.3)
+      relaton-iso-bib (~> 0.3.0)
+    relaton-ietf (0.6.0)
+      relaton-iso-bib (~> 0.3.0)
+    relaton-iev (0.1.1)
+      relaton (~> 0.5.0)
+    relaton-iso (0.6.1)
+      relaton-iec (~> 0.4.0)
+      relaton-iso-bib (~> 0.3.0)
+    relaton-iso-bib (0.3.1)
       isoics (~> 0.1.6)
-      nokogiri (~> 1.8.4)
-      relaton-bib (~> 0.2.0)
+      relaton-bib (~> 0.3.0)
       ruby_deep_clone (~> 0.8.0)
-    relaton-itu (0.2.2)
-      relaton-iso-bib (~> 0.2.0)
-    relaton-nist (0.2.2)
-      relaton-bib (~> 0.2.0)
+    relaton-itu (0.3.0)
+      relaton-iso-bib (~> 0.3.0)
+    relaton-nist (0.3.0)
+      relaton-bib (~> 0.3.0)
       rubyzip
     roman-numerals (0.3.0)
     rspec (3.8.0)

data/appveyor.yml

@@ -2,6 +2,7 @@ version: '{build}'
 
 environment:
   matrix:
+    - RUBY_VERSION: 26
     - RUBY_VERSION: 25
     - RUBY_VERSION: 24
     - RUBY_VERSION: _trunk
@@ -16,7 +17,6 @@ install:
   - refreshenv
   - set PATH=C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;%PATH%
   - where latexmlmath
-  - chcp 65001
 
 build_script:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%

data/lib/asciidoctor/standoc/cleanup.rb

@@ -7,6 +7,7 @@ require "pp"
 require_relative "./cleanup_block.rb"
 require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
+require "relaton_iev"
 
 module Asciidoctor
   module Standoc
@@ -42,8 +43,8 @@ module Asciidoctor
         reference_names(xmldoc)
         xref_cleanup(xmldoc)
         origin_cleanup(xmldoc)
-        iev_cleanup(xmldoc)
-        element_name_cleanup(xmldoc) # cleanup IEV
+        RelatonIev::iev_cleanup(xmldoc, @bibdb)
+        element_name_cleanup(xmldoc)
         bpart_cleanup(xmldoc)
         quotesource_cleanup(xmldoc)
         para_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -122,6 +122,7 @@ module Asciidoctor
         end
       end
 
+=begin
       # converts generic IEV citation to citation of IEC 60050-n
       # assumes IEV citations are of form
       # <eref type="inline" bibitemid="a" citeas="IEC 60050">
@@ -146,7 +147,7 @@ module Asciidoctor
         parts.sort.each do |p|
           hit = @bibdb&.fetch("IEC 60050-#{p}", nil, keep_year: true) || next
           new_iev += hit.to_xml.sub(/ id="[^"]+"/, %{ id="IEC60050-#{p}"})
-          date = hit.dates[0].on.year
+          date = hit.date[0].on.year
           xmldoc.xpath("//*[@citeas = 'IEC 60050-#{p}:2011']").each do |x|
             x["citeas"] = x["citeas"].sub(/:2011$/, ":#{date}")
           end
@@ -160,11 +161,11 @@ module Asciidoctor
         parts = linksIev2iec60050part(xmldoc)
         refsIev2iec60050part(xmldoc, parts, iev)
       end
+=end
 
       def ref_dl_cleanup(xmldoc)
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
-          #bibitemxml = Relaton::Bibdata.new(bib).to_xml or next
           bibitemxml = RelatonBib::BibliographicItem.new(
             RelatonBib::hash_to_bib(bib)).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
@@ -225,13 +226,13 @@ module Asciidoctor
         end
         c.xpath("./clause").each do |c1|
           key = c1&.at("./title")&.text&.downcase&.strip
-          next unless %w(contributors relations series).include? key
+          next unless %w(contributor relation series).include? key
           add_to_hash(bib, key, dl_bib_extract(c1, true))
         end
         if !nested and c.at("./title")
           title = c.at("./title").remove.children.to_xml
-          bib["titles"] = bib["titles"] ? Array(bib["titles"]) : []
-          bib["titles"] << title if !title.empty?
+          bib["title"] = bib["title"] ? Array(bib["title"]) : []
+          bib["title"] << title if !title.empty?
         end
         bib
       end

data/lib/asciidoctor/standoc/inline.rb

@@ -95,9 +95,9 @@ module Asciidoctor
 
       def xml_encode(text)
         HTMLEntities.new.encode(text, :basic, :hexadecimal).
-            gsub(/&amp;gt;/, ">").gsub(/\&amp;lt;/, "<").gsub(/&amp;amp;/, "&").
-            gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&").
-            gsub(/&quot;/, '"').gsub(/&#xa;/, "\n")
+          gsub(/&amp;gt;/, ">").gsub(/\&amp;lt;/, "<").gsub(/&amp;amp;/, "&").
+          gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&").
+          gsub(/&quot;/, '"').gsub(/&#xa;/, "\n")
       end
 
       def stem_parse(text, xml, style)
@@ -106,8 +106,9 @@ module Asciidoctor
           math = xml_encode(text)
           xml.stem math, **{ type: "MathML" }
         elsif style == :latexmath
+          latex_cmd = Metanorma::Standoc::Requirements[:latexml].cmd
           latexmlmath_input = Unicode2LaTeX::unicode2latex(text).gsub(/'/, '\\').gsub(/\n/, " ")
-          latex = IO.popen('latexmlmath --preload=amsmath  -- -', 'r+', :external_encoding=>'UTF-8') do |io|
+          latex = IO.popen(latex_cmd, "r+", external_encoding: "UTF-8") do |io|
             io.write(latexmlmath_input)
             io.close_write
             io.read

data/lib/asciidoctor/standoc/macros.rb

@@ -86,13 +86,15 @@ module Asciidoctor
       def self.generate_file parent, reader
         localdir = Utils::localdir(parent.document)
         fn = save_plantuml parent, reader, localdir
-        system "plantuml #{localdir}plantuml/#{fn}.pml"
+        umlfile = Pathname.new(localdir) + "plantuml" + "#{fn}.pml"
+        system "plantuml #{umlfile}"
         outfile = parent.image_uri("#{fn}.png")
         if outfile == "#{fn}.png" 
-          "plantuml/#{fn}.png" 
+          (Pathname.new("plantuml") + "#{fn}.png").to_s
         else
-          FileUtils.mv "#{localdir}plantuml/#{fn}.png", "#{localdir}#{outfile}"
-          "#{fn}.png"
+          FileUtils.mv (Pathname.new(localdir) + "plantuml" + "#{fn}.png").to_s,
+            (Pathname.new(localdir) + outfile).to_s
+          (Pathname.new("#{fn}.png")).to_s
         end
       end
 
@@ -102,8 +104,10 @@ module Asciidoctor
           src = "@startuml\n#{src}\n@enduml\n"
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
         fn ||= UUIDTools::UUID.random_create
-        FileUtils.mkdir_p "#{localdir}/plantuml"
-        File.open("#{localdir}plantuml/#{fn}.pml", "w") { |f| f.write src }
+        path = Pathname.new(localdir) + "plantuml"
+        FileUtils.mkdir_p path.to_s # "#{localdir}/plantuml"
+        #File.open("#{localdir}plantuml/#{fn}.pml", "w") { |f| f.write src }
+        File.open((path + "#{fn}.pml").to_s, "w") { |f| f.write src }
         fn
       end
 

data/lib/asciidoctor/standoc/ref.rb

@@ -109,9 +109,6 @@ module Asciidoctor
         return nil if hit.nil?
         xml.parent.add_child(Utils::smart_render_xml(hit))
         xml
-      rescue Algolia::AlgoliaProtocolError
-        warn "Could not retrieve #{code}: no access to online site"
-        nil
       rescue RelatonBib::RequestError
         warn "Could not retrieve #{code}: no access to online site"
         nil

data/lib/asciidoctor/standoc/validate.rb

@@ -40,7 +40,7 @@ module Asciidoctor
         begin
           errors = Jing.new(filename).validate(".tmp.xml")
         rescue Jing::Error => e
-          abort "what what what #{e}"
+          abort "Jing failed with error: #{e}"
         end
         warn "Valid!" if errors.none?
         errors.each do |error|

data/lib/metanorma/standoc.rb

@@ -1,7 +1,11 @@
 require_relative "./standoc/processor"
+require_relative "./standoc/requirement"
+require_relative "./standoc/latexml_requirement"
 
 module Metanorma
   module Standoc
-
+    Requirements = {
+      latexml: LatexmlRequirement.new
+    }
   end
 end

data/lib/metanorma/standoc/latexml_requirement.rb

@@ -0,0 +1,47 @@
+require_relative "./requirement"
+
+module Metanorma
+  module Standoc
+    class LatexmlRequirement < Requirement
+      def initialize
+        @recommended_version = '0.8.4'
+        @minimal_version = '0.8.0'
+        version_output, = Open3.capture2e("latexml --VERSION")
+        @actual_version = version_output&.match(%r{\d+(.\d+)*})
+      end
+
+      def satisfied
+        version = @actual_version
+
+        if version.to_s.empty?
+          abort "LaTeXML not found in PATH, please make sure that you installed LaTeXML"
+        end
+
+        if Gem::Version.new(version) < Gem::Version.new(@minimal_version)
+          abort "Minimal supported LaTeXML version is #{@minimal_version} "\
+                "found #{version}, recommended version is #{@recommended_version}"
+        end
+        
+        if Gem::Version.new(version) < Gem::Version.new(@recommended_version)
+          version = "unknown" if version.to_s.empty?
+          header_msg = "WARNING latexmlmath version #{version} below #{@recommended_version}!"
+          suggestion = if Gem.win_platform?
+                         "cmd encoding is set to UTF-8 with `chcp 65001`"
+                       else
+                         "terminal encoding is set to UTF-8 with `export LANG=en_US.UTF-8`"
+                       end
+
+          warn "#{header_msg} Please sure that #{suggestion} command"
+
+          @cmd = "latexmlmath --preload=amsmath -- -"
+        else
+          @cmd = "latexmlmath --preload=amsmath --inputencoding=UTF-8 -- -"
+        end
+      end
+
+      def cmd
+        @cmd
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/processor.rb

@@ -8,6 +8,8 @@ module Metanorma
         @short = :standoc
         @input_format = :asciidoc
         @asciidoctor_backend = :standoc
+
+        Metanorma::Standoc::Requirements[:latexml].satisfied
       end
 
       def output_formats

data/lib/metanorma/standoc/requirement.rb

@@ -0,0 +1,13 @@
+module Metanorma
+  module Standoc
+    class Requirement
+      def satisfied
+        raise NotImplementedError("abstract method")
+      end
+
+      def cmd
+        raise NotImplementedError("abstract method")
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-    VERSION = "1.2.2".freeze
+    VERSION = "1.2.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 0.10.0"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "relaton", "~> 0.4.0"
+  spec.add_dependency "relaton", "~> 0.5.0"
+  spec.add_dependency "relaton-iev", "~> 0.1.0"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "html2doc", "~> 0.8.11"

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -974,10 +974,9 @@ r = 1 %</stem>
         </term></terms></sections><bibliography><references id="_" obligation="informative">
           <title>Normative References</title>
           <bibitem type="standard" id="IEC60050-102">
-          <title type="title-main" format="text/plain" language="en" script="Latn">Part 102: Mathematics</title>
-          <title type="title-intro" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
-          <title type="title-part" format="text/plain" language="en" script="Latn">General concepts and linear algebra</title>
-          <title type="main" format="text/plain" language="en" script="Latn">Part 102: Mathematics - International Electrotechnical Vocabulary - General concepts and linear algebra</title>
+          <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
+          <title type="title-part" format="text/plain" language="en" script="Latn">Part 102: Mathematics - General concepts and linear algebra</title>
+          <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) - Part 102: Mathematics - General concepts and linear algebra</title>
           <uri type="src">https://webstore.iec.ch/publication/160</uri>
           <uri type="obp">/preview/info_iec60050-102%7Bed1.0%7Db.pdf</uri>
           <docidentifier type="IEC">IEC 60050-102:2007</docidentifier>
@@ -1011,10 +1010,9 @@ r = 1 %</stem>
             </owner>
           </copyright>
         </bibitem><bibitem type="standard" id="IEC60050-103">
-          <title type="title-main" format="text/plain" language="en" script="Latn">Part 103: Mathematics</title>        
-         <title type="title-intro" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary</title>
-        <title type="title-part" format="text/plain" language="en" script="Latn">Functions </title>
-        <title type="main" format="text/plain" language="en" script="Latn">Part 103: Mathematics - International Electrotechnical Vocabulary - Functions </title>
+         <title type="title-main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV)</title>
+        <title type="title-part" format="text/plain" language="en" script="Latn">Part 103: Mathematics - Functions</title>
+        <title type="main" format="text/plain" language="en" script="Latn">International Electrotechnical Vocabulary (IEV) - Part 103: Mathematics - Functions </title>
           <uri type="src">https://webstore.iec.ch/publication/161</uri>
           <uri type="obp">/preview/info_iec60050-103%7Bed1.0%7Db.pdf</uri>
           <docidentifier type="IEC">IEC 60050-103:2009</docidentifier>