isodoc 2.1.4 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 214cd3cfadc0aeca476766aff0722c06a46b5410beedbb9a49fd47ed15249850
-  data.tar.gz: f0e79db9f9dd1b456da5ba4eda163e7189509236e45f688faa92fcf821c158de
+  metadata.gz: aed515059a4bfbb122ff29141ec687c3fab6fed9539fde9e2fc6d89b54ddc6ec
+  data.tar.gz: 35c681874fc12a48baa1ceffaff00680a577c90cde69c58caf896eeab8c8abb4
 SHA512:
-  metadata.gz: 2e57a7551ccebc9fedc40520a1ff96d87d25de8f4c3501400d9cfdac41d4e0014f25e9b5a7d0eb9c03c6c3cf0c0a0dd3a992327591ecfcb474c6c7c369377e15
-  data.tar.gz: 630fb8c95eccafb843d2f25459494705087dde8c4fe857be5183fdab62eb71da7fb9211d2bbe2dc30c67a87e4ce199c200c9a53eabf5ba90a74e249005f8d997
+  metadata.gz: 2313eec736db0f20d8ce87a8505e49a263d93ec67ee82d28d76f07c12388bce1ac213f380677784e1a9dacc12e78b655d39ecada99745f06e7e4a91f71124458
+  data.tar.gz: d680c24a277d386ab74cce9c87d1c0ff27087db33f4db42c973b3f51b5e098cae7a7d66aeb61dad50c36bf3ca23d7b9befe718584b3311f3f6ab971893872027

data/isodoc.gemspec

@@ -34,15 +34,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciimath"
   spec.add_dependency "html2doc", "~> 1.4.1"
   spec.add_dependency "htmlentities", "~> 4.3.4"
-  spec.add_dependency "isodoc-i18n", "~> 1.0.0"
+  spec.add_dependency "isodoc-i18n", "~> 1.0.6"
   spec.add_dependency "liquid", "~> 4"
   # spec.add_dependency "metanorma", ">= 1.2.0"
   spec.add_dependency "emf2svg"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "metanorma-utils"
-
+  spec.add_dependency "mn-requirements", "~> 0.0.1"
   spec.add_dependency "relaton-cli"
-  spec.add_dependency "relaton-render", ">= 0.3.1"
+  spec.add_dependency "relaton-render", "~> 0.4.0"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "thread_safe"
   spec.add_dependency "twitter_cldr", ">= 6.6.0"

data/lib/isodoc/class_utils.rb

@@ -13,10 +13,7 @@ module IsoDoc
     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")
+      Metanorma::Utils::ns(xpath)
     end
 
     def liquid(doc)

data/lib/isodoc/convert.rb

@@ -5,11 +5,13 @@ require "fileutils"
 require "tempfile"
 require_relative "i18n"
 require_relative "css"
+require_relative "init"
 require "securerandom"
+require "mn-requirements"
 
 module IsoDoc
   class Convert < ::IsoDoc::Common
-    attr_accessor :options, :i18n, :meta, :xrefs
+    attr_accessor :options, :i18n, :meta, :xrefs, :reqt_models
 
     # htmlstylesheet: Generic stylesheet for HTML
     # htmlstylesheet_override: Override stylesheet for HTML
@@ -45,22 +47,28 @@ module IsoDoc
     # tocrecommendations: add ToC for rcommendations
     # fonts: fontist fonts to install
     # fontlicenseagreement: fontist font license agreement
-    def initialize(options)
-      @libdir ||= File.dirname(__FILE__) # rubocop:disable Lint/DisjunctiveAssignmentInConstructor
+    def initialize(options) # rubocop:disable Lint/MissingSuper
+      @options = options_preprocess(options)
+      init_stylesheets(@options)
+      init_covers(@options)
+      init_toc(@options)
+      init_fonts(@options)
+      init_processing
+      init_locations(@options)
+      init_i18n(@options)
+      init_rendering(@options)
+    end
+
+    def options_preprocess(options)
       options.merge!(default_fonts(options)) do |_, old, new|
         old || new
       end.merge!(default_file_locations(options)) do |_, old, new|
         old || new
       end
-      @options = options
-      @files_to_delete = []
-      @tempfile_cache = []
-      @sourcefilename = options[:sourcefilename]
-      init_stylesheets(options)
-      init_covers(options)
-      init_toc(options)
-      init_fonts(options)
-      @i18nyaml = options[:i18nyaml]
+      options
+    end
+
+    def init_rendering(options)
       @ulstyle = options[:ulstyle]
       @olstyle = options[:olstyle]
       @datauriimage = options[:datauriimage]
@@ -69,6 +77,26 @@ module IsoDoc
       @sectionsplit = options[:sectionsplit] == "true"
       @suppressasciimathdup = options[:suppressasciimathdup] == "true"
       @bare = options[:bare]
+      @aligncrosselements = options[:aligncrosselements]
+    end
+
+    def init_i18n(options)
+      @i18nyaml = options[:i18nyaml]
+      @lang = options[:language] || "en"
+      @script = options[:script] || "Latn"
+    end
+
+    def init_locations(options)
+      @libdir ||= File.dirname(__FILE__)
+      @baseassetpath = options[:baseassetpath]
+      @tmpimagedir_suffix = tmpimagedir_suffix
+      @tmpfilesdir_suffix = tmpfilesdir_suffix
+      @sourcefilename = options[:sourcefilename]
+      @files_to_delete = []
+      @tempfile_cache = []
+    end
+
+    def init_processing
       @termdomain = ""
       @termexample = false
       @note = false
@@ -83,16 +111,10 @@ module IsoDoc
       @c = HTMLEntities.new
       @openmathdelim = "`"
       @closemathdelim = "`"
-      @lang = options[:language] || "en"
-      @script = options[:script] || "Latn"
       @maxwidth = 1200
       @maxheight = 800
       @bookmarks_allocated = { "X" => true }
       @fn_bookmarks = {}
-      @baseassetpath = options[:baseassetpath]
-      @aligncrosselements = options[:aligncrosselements]
-      @tmpimagedir_suffix = tmpimagedir_suffix
-      @tmpfilesdir_suffix = tmpfilesdir_suffix
     end
 
     def init_fonts(options)
@@ -171,35 +193,27 @@ module IsoDoc
       end
     end
 
-    def metadata_init(lang, script, i18n)
-      @meta = Metadata.new(lang, script, i18n)
-    end
-
-    def xref_init(lang, script, _klass, i18n, options)
-      html = HtmlConvert.new(language: @lang, script: @script)
-      @xrefs = Xref.new(lang, script, html, i18n, options)
-    end
-
-    def i18n_init(lang, script, i18nyaml = nil)
-      @i18n = I18n.new(lang, script, i18nyaml: i18nyaml || @i18nyaml)
-    end
-
-    def l10n(expr, lang = @lang, script = @script)
-      @i18n.l10n(expr, lang, script)
-    end
-
     def convert_init(file, input_filename, debug)
       docxml = Nokogiri::XML(file) { |config| config.huge }
       filename, dir = init_file(input_filename, debug)
       docxml.root.default_namespace = ""
-      lang = docxml&.at(ns("//bibdata/language"))&.text and @lang = lang
-      script = docxml&.at(ns("//bibdata/script"))&.text and @script = script
-      i18n_init(@lang, @script)
+      convert_i18n_init(docxml)
       metadata_init(@lang, @script, @i18n)
       xref_init(@lang, @script, self, @i18n, {})
       [docxml, filename, dir]
     end
 
+    def convert_i18n_init(docxml)
+      lang = docxml&.at(ns("//bibdata/language"))&.text and @lang = lang
+      script = docxml&.at(ns("//bibdata/script"))&.text and @script = script
+      i18n_init(@lang, @script)
+      @reqt_models = Metanorma::Requirements
+        .new({
+               default: "default", lang: lang, script: script,
+               labels: @i18n.get
+             })
+    end
+
     def convert(input_filename, file = nil, debug = false,
                 output_filename = nil)
       file = File.read(input_filename, encoding: "utf-8") if file.nil?
@@ -219,10 +233,8 @@ module IsoDoc
     end
 
     def target_pdf(node)
-      if /#/.match?(node["target"])
-        node["target"].sub(/#/, ".pdf#")
-      else
-        "##{node['target']}"
+      if /#/.match?(node["target"]) then node["target"].sub(/#/, ".pdf#")
+      else "##{node['target']}"
       end
     end
   end

data/lib/isodoc/function/inline.rb

@@ -17,7 +17,13 @@ module IsoDoc
       def location_parse(node, out); end
 
       def span_parse(node, out)
-        node.children.each { |n| parse(n, out) }
+        if node["style"]
+          out.span **{ style: node["style"] } do |s|
+            node.children.each { |n| parse(n, s) }
+          end
+        else
+          node.children.each { |n| parse(n, out) }
+        end
       end
 
       def callout_parse(node, out)
@@ -57,12 +63,11 @@ module IsoDoc
       def eref_url(bibitemid)
         return nil if @bibitems.nil? || @bibitems[bibitemid].nil?
 
-        if url = @bibitems[bibitemid].at(ns("./uri[@type = 'citation']"))
-          url.text
-        elsif @bibitems[bibitemid]["hidden"] == "true"
-          @bibitems[bibitemid]&.at(ns("./uri"))&.text
-        else "##{bibitemid}"
-        end
+        url = @bibitems[bibitemid].at(ns("./uri[@type = 'citation']")) and
+          return url.text
+        @bibitems[bibitemid]["hidden"] == "true" and
+          return @bibitems[bibitemid].at(ns("./uri"))&.text
+        "##{bibitemid}"
       end
 
       def eref_parse(node, out)

data/lib/isodoc/function/references.rb

@@ -120,7 +120,7 @@ module IsoDoc
       def omit_docid_prefix(prefix)
         return true if prefix.nil? || prefix.empty?
 
-        %w(ISO IEC IEV ITU W3C csd metanorma repository metanorma-ordinal)
+        %w(ISO IEC IEV ITU W3C BIPM csd metanorma repository metanorma-ordinal)
           .include? prefix
       end
 

data/lib/isodoc/function/reqt.rb

@@ -1,121 +1,50 @@
 module IsoDoc
   module Function
     module Blocks
-      def recommendation_labels(node)
-        [node.at(ns("./label")), node.at(ns("./title")), node.at(ns("./name"))]
-      end
-
-      def recommendation_name(node, out, _type)
-        label, title, lbl = recommendation_labels(node)
-        out.p **{ class: "RecommendationTitle" } do |b|
-          lbl&.children&.each { |n| parse(n, b) }
-          b << l10n(":")
-          if label || title
-            b.br
-            label&.children&.each { |n| parse(n, b) }
-            b << "#{clausedelim} " if label && title
-            title&.children&.each { |n| parse(n, b) }
-          end
-        end
-      end
-
-      def recommendation_attributes1(node)
-        out = []
-        oblig = node["obligation"] and
-          out << l10n("#{@i18n.obligation}: #{oblig}")
-        node.xpath(ns("./subject")).each do |subj|
-          out << l10n("#{@i18n.subject}: #{subj.text}")
-        end
-        node.xpath(ns("./inherit")).each do |i|
-          out << recommendation_attr_parse(i, @i18n.inherits)
-        end
-        node.xpath(ns("./classification")).each do |c|
-          line = recommendation_attr_keyvalue(c, "tag", "value") and out << line
-        end
-        out
-      end
-
-      def recommendation_attr_parse(node, label)
-        noko do |xml|
-          xml << "#{label}: "
-          node.children.each { |n| parse(n, xml) }
-        end.join
-      end
+      def recommendation_name(name, out)
+        return if name.nil?
 
-      def recommendation_attr_keyvalue(node, key, value)
-        tag = node.at(ns("./#{key}")) or return nil
-        value = node.at(ns("./#{value}")) or return nil
-        "#{tag.text.capitalize}: #{value.text}"
-      end
-
-      def recommendation_attributes(node, out)
-        ret = recommendation_attributes1(node)
-        return if ret.empty?
-
-        out.p do |p|
-          p.i do |i|
-            i << ret.join("<br/>")
-          end
+        out.p **{ class: "RecommendationTitle" } do |p|
+          name.children.each { |n| parse(n, p) }
         end
       end
 
-      def reqt_metadata_node(node)
-        %w(label title subject classification tag value
-           inherit name).include? node.name
-      end
-
       def reqt_attrs(node, klass)
         attr_code(class: klass, id: node["id"], style: keep_style(node))
       end
 
       def recommendation_parse(node, out)
         out.div **reqt_attrs(node, "recommend") do |t|
-          recommendation_name(node, t, @i18n.recommendation)
-          recommendation_attributes(node, out)
-          node.children.each do |n|
-            parse(n, t) unless reqt_metadata_node(n)
-          end
+          recommendation_parse1(node, t)
+        end
+      end
+
+      def recommendation_parse1(node, out)
+        recommendation_name(node.at(ns("./name")), out)
+        node.children.each do |n|
+          parse(n, out) unless n.name == "name"
         end
       end
 
       def requirement_parse(node, out)
         out.div **reqt_attrs(node, "require") do |t|
-          recommendation_name(node, t, @i18n.requirement)
-          recommendation_attributes(node, out)
-          node.children.each do |n|
-            parse(n, t) unless reqt_metadata_node(n)
-          end
+          recommendation_parse1(node, t)
         end
       end
 
       def permission_parse(node, out)
         out.div **reqt_attrs(node, "permission") do |t|
-          recommendation_name(node, t, @i18n.permission)
-          recommendation_attributes(node, out)
-          node.children.each do |n|
-            parse(n, t) unless reqt_metadata_node(n)
-          end
+          recommendation_parse1(node, t)
         end
       end
 
-      def reqt_component_attrs(node)
-        klass = node.name
-        klass == "component" and klass = node["class"]
-        attr_code(class: "requirement-#{klass}",
-                  style: keep_style(node))
-      end
-
-      def requirement_component_parse(node, out)
-        return if node["exclude"] == "true"
-
-        out.div **reqt_component_attrs(node) do |div|
+      def div_parse(node, out)
+        out.div **reqt_attrs(node, node["type"]) do |t|
           node.children.each do |n|
-            parse(n, div)
+            parse(n, t)
           end
         end
       end
-
-      def requirement_skip_parse(node, out); end
     end
   end
 end

data/lib/isodoc/function/section_titles.rb

@@ -5,15 +5,15 @@ module IsoDoc
         "."
       end
 
-      def clausedelimspace(out)
+      def clausedelimspace(_node, out)
         insert_tab(out, 1)
       end
 
-      def inline_header_title(out, _node, title)
+      def inline_header_title(out, node, title)
         out.span **{ class: "zzMoveToFollowing" } do |s|
           s.b do |b|
             title&.children&.each { |c2| parse(c2, b) }
-            clausedelimspace(out) if /\S/.match?(title&.text)
+            clausedelimspace(node, out) if /\S/.match?(title&.text)
           end
         end
       end

data/lib/isodoc/function/to_word_html.rb

@@ -204,11 +204,12 @@ module IsoDoc
           when "requirement" then requirement_parse(node, out)
           when "recommendation" then recommendation_parse(node, out)
           when "permission" then permission_parse(node, out)
-          when "subject", "classification"
-            requirement_skip_parse(node, out)
-          when "inherit", "description", "specification", "measurement-target",
-           "verification", "import", "component"
-            requirement_component_parse(node, out)
+          when "div" then div_parse(node, out)
+          #when "subject", "classification"
+          #  requirement_skip_parse(node, out)
+          #when "inherit", "description", "specification", "measurement-target",
+          #"verification", "import", "component"
+          # requirement_component_parse(node, out)
           when "index" then index_parse(node, out)
           when "index-xref" then index_xref_parse(node, out)
           when "termref" then termrefelem_parse(node, out)
@@ -218,7 +219,7 @@ module IsoDoc
           when "feedback-statement" then feedback_parse(node, out)
           when "passthrough" then passthrough_parse(node, out)
           when "amend" then amend_parse(node, out)
-          when "tab" then clausedelimspace(out) # in Presentation XML only
+          when "tab" then clausedelimspace(node, out) # in Presentation XML only
           when "svg" then svg_parse(node, out) # in Presentation XML only
           when "add" then add_parse(node, out)
           when "del" then del_parse(node, out)

data/lib/isodoc/function/utils.rb

@@ -222,6 +222,10 @@ module IsoDoc
            application/x-msmetafile image/x-xbitmap).include? type
       end
 
+      def eps?(type)
+        %w(application/postscript image/x-eps).include? type
+      end
+
       def cleanup_entities(text, is_xml: true)
         c = HTMLEntities.new
         if is_xml

data/lib/isodoc/init.rb

@@ -0,0 +1,20 @@
+module IsoDoc
+  class Convert < ::IsoDoc::Common
+    def metadata_init(lang, script, i18n)
+      @meta = Metadata.new(lang, script, i18n)
+    end
+
+    def xref_init(lang, script, _klass, i18n, options)
+      html = HtmlConvert.new(language: @lang, script: @script)
+      @xrefs = Xref.new(lang, script, html, i18n, options)
+    end
+
+    def i18n_init(lang, script, i18nyaml = nil)
+      @i18n = I18n.new(lang, script, i18nyaml: i18nyaml || @i18nyaml)
+    end
+
+    def l10n(expr, lang = @lang, script = @script)
+      @i18n.l10n(expr, lang, script)
+    end
+  end
+end

data/lib/isodoc/presentation_function/block.rb

@@ -45,7 +45,6 @@ module IsoDoc
       end
     end
 
-    # introduce name element
     def formula1(elem)
       lbl = @xrefs.anchor(elem["id"], :label, false)
       prefix_name(elem, "", lbl, "name")
@@ -73,7 +72,6 @@ module IsoDoc
       end
     end
 
-    # introduce name element
     def note1(elem)
       return if elem.parent.name == "bibitem" || elem["notag"] == "true"
 
@@ -116,11 +114,10 @@ module IsoDoc
       end
     end
 
-    # introduce name element
     def recommendation1(elem, type)
-      n = @xrefs.anchor(elem["id"], :label, false)
-      lbl = (n.nil? ? type : l10n("#{type} #{n}"))
-      prefix_name(elem, "", lbl, "name")
+      lbl = @reqt_models.model(elem["model"])
+        .recommendation_label(elem, type, xrefs)
+      prefix_name(elem, "", l10n(lbl), "name")
     end
 
     def table(docxml)
@@ -175,5 +172,25 @@ module IsoDoc
     def ol1(elem)
       elem["type"] ||= ol_depth(elem).to_s
     end
+
+    def requirement_render_preprocessing(docxml); end
+
+    REQS = %w(requirement recommendation permission).freeze
+
+    def requirement_render(docxml)
+      requirement_render_preprocessing(docxml)
+      REQS.each do |x|
+        REQS.each do |y|
+          docxml.xpath(ns("//#{x}//#{y}")).each { |r| requirement_render1(r) }
+        end
+      end
+      docxml.xpath(ns("//requirement | //recommendation | //permission"))
+        .each { |r| requirement_render1(r) }
+    end
+
+    def requirement_render1(node)
+      node.replace(@reqt_models.model(node["model"])
+        .requirement_render1(node))
+    end
   end
 end

data/lib/isodoc/presentation_function/image.rb

@@ -11,7 +11,14 @@ module IsoDoc
         else s.remove
         end
       end
-      docxml.xpath(ns("//image")).each { |f| svg_emf_double(f) }
+      imageconvert(docxml)
+    end
+
+    def imageconvert(docxml)
+      docxml.xpath(ns("//image")).each do |f|
+        eps2svg(f)
+        svg_emf_double(f)
+      end
     end
 
     def svg_extract(elem)
@@ -36,6 +43,16 @@ module IsoDoc
                   l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
+    def eps2svg(img)
+      return unless eps?(img["mimetype"])
+
+      img["mimetype"] = "image/svg+xml"
+      if src = eps_to_svg(img)
+        img["src"] = src
+        img.children = ""
+      end
+    end
+
     def svg_emf_double(img)
       if emf?(img["mimetype"])
         img = emf_encode(img)
@@ -46,40 +63,59 @@ module IsoDoc
     end
 
     def emf_encode(img)
-      img["mimetype"] = "image/svg+xml"
-      unless %r{^data:image}.match?(img["src"])
-        img["src"] = Metanorma::Utils::datauri(img["src"])
-      end
+      svg_prep(img)
       img.children = "<emf src='#{img['src']}'/>"
       img["src"] = ""
       img
     end
 
+    def svg_prep(img)
+      img["mimetype"] = "image/svg+xml"
+      %r{^data:image}.match?(img["src"]) or
+        img["src"] = Metanorma::Utils::datauri(img["src"])
+    end
+
     def emf_to_svg(img)
       emf = Metanorma::Utils::save_dataimage(img.at(ns("./emf/@src")).text)
       Emf2svg.from_file(emf).sub(/<\?[^>]+>/, "")
     end
 
+    def eps_to_svg(node)
+      uri = eps_to_svg_uri(node)
+      ret = imgfile_suffix(uri, "svg")
+      File.exist?(ret) and return ret
+      inkscape_convert(uri, ret, "--export-plain-svg")
+    end
+
     def svg_to_emf(node)
       uri = svg_to_emf_uri(node)
-      ret = svg_to_emf_filename(uri)
+      ret = imgfile_suffix(uri, "emf")
       File.exist?(ret) and return ret
+      inkscape_convert(uri, ret, '--export-type="emf"')
+    end
+
+    def inkscape_convert(uri, file, option)
       exe = inkscape_installed? or raise "Inkscape missing in PATH, unable" \
-                                         "to convert EMF to SVG. Aborting."
+                                         "to convert image #{uri}. Aborting."
       uri = Metanorma::Utils::external_path uri
       exe = Metanorma::Utils::external_path exe
-      system(%(#{exe} --export-type="emf" #{uri})) and
-        return Metanorma::Utils::datauri(ret)
+      system(%(#{exe} #{option} #{uri})) and
+        return Metanorma::Utils::datauri(file)
 
-      raise %(Fail on #{exe} --export-type="emf" #{uri})
+      raise %(Fail on #{exe} #{option} #{uri})
     end
 
     def svg_to_emf_uri(node)
-      uri = if node&.elements&.first&.name == "svg"
-              a = Base64.strict_encode64(node.children.to_xml)
-              "data:image/svg+xml;base64,#{a}"
-            else node["src"]
-            end
+      uri = svg_to_emf_uri_convert(node)
+      cache_dataimage(uri)
+    end
+
+    def eps_to_svg_uri(node)
+      uri = eps_to_svg_uri_convert(node)
+      cache_dataimage(uri)
+    end
+
+    def cache_dataimage(uri)
       if %r{^data:}.match?(uri)
         uri = save_dataimage(uri)
         @tempfile_cache << uri
@@ -87,12 +123,25 @@ module IsoDoc
       uri
     end
 
-    def svg_to_emf_filename(uri)
-      "#{File.join(File.dirname(uri), File.basename(uri, '.*'))}.emf"
+    def svg_to_emf_uri_convert(node)
+      if node&.elements&.first&.name == "svg"
+        a = Base64.strict_encode64(node.children.to_xml)
+        "data:image/svg+xml;base64,#{a}"
+      else node["src"]
+      end
+    end
+
+    def eps_to_svg_uri_convert(node)
+      if node.text.strip.empty?
+        node["src"]
+      else
+        a = Base64.strict_encode64(node.children.to_xml)
+        "data:application/postscript;base64,#{a}"
+      end
     end
 
-    def emf_to_svgfilename(uri)
-      "#{File.join(File.dirname(uri), File.basename(uri, '.*'))}.svg"
+    def imgfile_suffix(uri, suffix)
+      "#{File.join(File.dirname(uri), File.basename(uri, '.*'))}.#{suffix}"
     end
 
     def inkscape_installed?