Merge pull request #1158 from metanorma/features/altmedia

Features/altmedia

Author: opoudjis

lib/metanorma/cleanup/image.rb

@@ -55,38 +55,95 @@ def svgmap_target(nodeset)
       end
 
       def img_cleanup(xmldoc)
-        if @datauriimage
-          xmldoc.xpath("//image").each do |i|
-            # do not datauri encode SVG, we need to deduplicate its IDs
-            unless read_in_if_svg(i, @localdir)
-              i["src"] = Vectory::Utils::datauri(i["src"], @localdir)
-            end
-          end
-        end
+        altmedia_cleanup(xmldoc)
+        @datauriimage and datauri_image(xmldoc)
         svg_cleanup(xmldoc)
         xmldoc
       end
 
+      def datauri_image(xmldoc)
+        xmldoc.xpath("//image | //altsource").each do |i|
+          # do not datauri encode SVG, we need to deduplicate its IDs
+          unless read_in_if_svg?(i, @localdir)
+            i["src"] &&= Vectory::Utils::datauri(i["src"], @localdir)
+          end
+        end
+      end
+
+      def altmedia_cleanup(xmldoc)
+        xmldoc.xpath("//image[@altmedia]").each do |i|
+          altmedia_root_cleanup(i)
+          d = altmedia_prep(i)
+          d or next
+          altsource_populate(i, d)
+        end
+      end
+
+      def altsource_populate(img, dlist)
+        dlist.each do |e|
+          e[:dd].nil? and next
+          img << "<altsource tag='#{e[:dt]}'/>"
+          image_attr_copy(e[:dd], img.elements.last)
+          altsource_attr_copy(e[:dd], img.elements.last, img)
+        end
+      end
+
+      def image_attr_copy(src, dest)
+        %w(src mimetype filename alt).each do |k|
+          src[k] and dest[k] = src[k]
+        end
+      end
+
+      def altsource_attr_copy(src, dest, img)
+        %w(media).each do |k|
+          src[k] and dest[k] = src[k]
+        end
+        %w(height width).each do |k|
+          dest[k] = img[k]
+          src[k] or next
+          src[k] == "auto" and next
+          dest[k] = src[k]
+        end
+      end
+
+      def altmedia_root_cleanup(img)
+        %w(altmedia src filename mimetype).each do |k|
+          img.delete(k)
+        end
+      end
+
+      def altmedia_prep(img)
+        dl = img.at("./dl") or return
+        d = extract_symbols_list(dl.remove).map do |e|
+          { dt: e[:dt].text, dd: e[:dd].at(".//image") }
+        end
+        unless d.detect { |e| e[:dt] == "default" }
+          d << d.first.dup
+          d[-1][:dt] = "default"
+        end
+        d
+      end
+
       def svg_cleanup(xmldoc)
         svg_uniqueids(xmldoc)
         svg_classupdate(xmldoc)
       end
 
-      def read_in_if_svg(img, localdir)
+      def read_in_if_svg?(img, localdir)
         img["src"] or return false
         path = Vectory::Utils.svgmap_rewrite0_path(img["src"], localdir)
         File.file?(path) or return false
         types = MIME::Types.type_for(path) or return false
         types.first == "image/svg+xml" or return false
         svg = File.read(path, encoding: "utf-8") or return false
-        img.children = (Nokogiri::XML(svg).root)
+        img.add_first_child Nokogiri::XML(svg).root
         true
       end
 
       def svg_classupdate(xmldoc)
         xmldoc.xpath("//m:svg[m:style]", "m" => SVG_NS)
           .each_with_index do |s, i|
-            svg_classupdate1(s, s.at("./m:style", "m" => SVG_NS), i)
+          svg_classupdate1(s, s.at("./m:style", "m" => SVG_NS), i)
         end
       end
 
@@ -101,7 +158,7 @@ def svg_classupdate1(svg, style, idx)
       end
 
       def svg_suffix_css_style(node, idx)
-        node[:node] == :style_rule && /\./.match?(node[:selector][:value]) or
+        (node[:node] == :style_rule && /\./.match?(node[:selector][:value])) or
           return
         v = node[:selector][:value]
           .gsub(/([^.\s]*\.\S+)/, "\\1_inject_#{idx}")
@@ -149,7 +206,7 @@ def svg_uniqueids1(svg, idx, ids)
         svg_uniqueids2(svg, iri_properties, idx, ids)
         new_ids = id_elems.map { |x| x["id"] }
           .map { |x| x + (ids[x] ? "_inject_#{idx}" : "") }
-        ids.merge(new_ids.each.map { |value| [value, true] }.to_h)
+        ids.merge(new_ids.each.to_h { |value| [value, true] })
       end
 
       def svg_uniqueids2(svg, iri_properties, idx, ids)

lib/metanorma/converter/blocks.rb

@@ -1,6 +1,7 @@
 require "uri"
-require_relative "./blocks_notes_examples"
-require_relative "./blocks_image"
+require_relative "blocks_notes"
+require_relative "blocks_examples"
+require_relative "blocks_image"
 
 module Metanorma
   module Standoc
@@ -42,6 +43,7 @@ def open(node)
         role == "definition" and return termdefinition(node)
         role == "boilerplate" and return boilerplate_note(node)
         role == "key" and return key_block(node)
+        role == "altmedia" and return altmedia_block(node)
         open1(node)
       end
 

lib/metanorma/converter/blocks_image.rb

@@ -28,6 +28,7 @@ def figure_example(node)
       def figure_attrs(node)
         attr_code(id_unnum_attrs(node).merge(keep_attrs(node))
           .merge(class: node.attr("class"),
+                 height: node.attr("height"),
                  width: node.attr("width")))
       end
 
@@ -39,6 +40,17 @@ def image(node)
           end
         end
       end
+
+      def altmedia_block(node)
+        noko do |xml|
+          xml.figure **figure_attrs(node) do |f|
+            block_title(node, f)
+            f.image **image_attributes(node, src: false, altmedia: true) do |i|
+              i << node.content
+            end
+          end
+        end
+      end
     end
   end
 end

…norma/converter/blocks_notes_examples.rb lib/metanorma/converter/blocks_notes.rblib/metanorma/converter/blocks_notes_examples.rb renamed to lib/metanorma/converter/blocks_notes.rb lib/metanorma/converter/blocks_notes_examples.rb renamed to lib/metanorma/converter/blocks_notes.rb

@@ -120,66 +120,6 @@ def admonition_alternatives(node)
         node.attr("name") == "todo" and return todo(node)
         nil
       end
-
-      def term_example(node)
-        noko do |xml|
-          xml.termexample **attr_code(id_attr(node)
-            .merge(keepasterm: node.option?("termexample") || nil)) do |ex|
-            wrap_in_para(node, ex)
-          end
-        end
-      end
-
-      def example(node)
-        role = node.role || node.attr("style")
-        ret = example_to_requirement(node, role) ||
-          example_by_role(node, role) and return ret
-        (in_terms? || node.option?("termexample")) and return term_example(node)
-        reqt_subpart?(role) and return requirement_subpart(node)
-        example_proper(node)
-      end
-
-      def example_by_role(node, role)
-        case role
-        when "pseudocode" then pseudocode_example(node)
-        when "svgmap" then svgmap_example(node)
-        when "form" then form(node)
-        when "definition" then termdefinition(node)
-        when "figure" then figure_example(node)
-        end
-      end
-
-      def example_to_requirement(node, role)
-        @reqt_models.requirement_roles.key?(role&.to_sym) or return
-        # need to call here for proper recursion ordering
-        select_requirement_model(node)
-        requirement(node,
-                    @reqt_models.requirement_roles[role.to_sym], role)
-      end
-
-      # prevent A's and other subs inappropriate for pseudocode
-      def pseudocode_example(node)
-        node.blocks.each { |b| b.remove_sub(:replacements) }
-        noko do |xml|
-          xml.figure **example_attrs(node).merge(class: "pseudocode") do |ex|
-            block_title(node, ex)
-            wrap_in_para(node, ex)
-          end
-        end
-      end
-
-      def example_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
-      end
-
-      def example_proper(node)
-        noko do |xml|
-          xml.example **example_attrs(node) do |ex|
-            block_title(node, xml)
-            wrap_in_para(node, ex)
-          end
-        end
-      end
     end
   end
 end

lib/metanorma/converter/inline.rb

@@ -44,13 +44,13 @@ def stem_parse(text, xml, style, node)
         attrs, text = stem_attrs(node, text)
         if /<([^:>&]+:)?math(\s+[^>&]+)?> |
           <([^:>&]+:)?math(\s+[^>&]+)?>/x.match? text
-          xml.stem **attrs.merge(type: "MathML") do |s|
+          xml.stem **attrs, type: "MathML" do |s|
             s << xml_encode(text)
           end
         elsif style == :latexmath then latex_parse(text, xml, attrs)
         else
           xml.stem text&.gsub("&amp;#", "&#") || "",
-                   **attrs.merge(type: "AsciiMath")
+                   **attrs, type: "AsciiMath"
         end
       end
 
@@ -69,8 +69,8 @@ def stem_attrs(node, text)
 
       def latex_parse(text, xml, attr)
         latex = latex_parse1(text, attr[:block]) or
-          return xml.stem **attr.merge(type: "MathML")
-        xml.stem **attr.merge(type: "MathML") do |s|
+          return xml.stem **attr, type: "MathML"
+        xml.stem **attr, type: "MathML" do |s|
           math = Nokogiri::XML.fragment(latex.sub(/<\?[^>]+>/, ""))
             .elements[0]
           math.delete("alttext")
@@ -138,12 +138,14 @@ def image_mimetype(uri)
         types.first.to_s
       end
 
-      def image_attributes(node)
-        sourceuri = image_src_uri(node)
-        uri = sourceuri
-        type = image_mimetype(uri)
-        uri = uri.sub(%r{^data:image/\*;}, "data:#{type};")
-        image_attributes1(node, uri, sourceuri, type)
+      def image_attributes(node, src: true, altmedia: nil)
+        if src
+          sourceuri = image_src_uri(node)
+          uri = sourceuri
+          type = image_mimetype(uri)
+          uri = uri.sub(%r{^data:image/\*;}, "data:#{type};")
+        end
+        image_attributes1(node, uri, sourceuri, type, altmedia)
       end
 
       def image_src_uri(node)
@@ -158,14 +160,16 @@ def image_src_uri(node)
         uri
       end
 
-      def image_attributes1(node, uri, sourceuri, type)
+      def image_attributes1(node, uri, sourceuri, type, altmedia)
         /^data:/.match?(sourceuri) and sourceuri = nil
         attr_code(id_attr(node)
           .merge(src: uri, mimetype: type,
                  height: node.attr("height") || "auto",
                  width: node.attr("width") || "auto",
                  filename: node.attr("filename") || sourceuri,
                  title: node.attr("titleattr"),
+                 media: node.attr("media"),
+                 altmedia: altmedia,
                  alt: node.alt == node.attr("default-alt") ? nil : node.alt))
       end
 

spec/assets/odf.svg

@@ -2,6 +2,58 @@
 require "fileutils"
 
 RSpec.describe Metanorma::Standoc do
+  it "expands svg" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR.sub(':data-uri-image: false', ':data-uri-image: true')}
+
+      [altmedia]
+      --
+      doc:: image:spec/assets/odf.svg[]
+      html:: image:spec/assets/odf.svg[]
+      --
+
+      image::spec/assets/odf.svg[]
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+          <sections>
+             <figure id="_">
+                <image id="_" height="auto" width="auto" alt="">
+                   <altsource tag="doc" src="spec/assets/odf.svg" mimetype="image/svg+xml" height="auto" width="auto" filename="spec/assets/odf.svg">
+                      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+                         <circle fill="#009" r="45" cx="50" cy="50"/>
+                         <path d="M33,26H78A37,37,0,0,1,33,83V57H59V43H33Z" fill="#FFF"/>
+                      </svg>
+                   </altsource>
+                   <altsource tag="html" src="spec/assets/odf.svg" mimetype="image/svg+xml" height="auto" width="auto" filename="spec/assets/odf.svg">
+                      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+                         <circle fill="#009" r="45" cx="50" cy="50"/>
+                         <path d="M33,26H78A37,37,0,0,1,33,83V57H59V43H33Z" fill="#FFF"/>
+                      </svg>
+                   </altsource>
+                   <altsource tag="default" src="spec/assets/odf.svg" mimetype="image/svg+xml" height="auto" width="auto" filename="spec/assets/odf.svg">
+                      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+                         <circle fill="#009" r="45" cx="50" cy="50"/>
+                         <path d="M33,26H78A37,37,0,0,1,33,83V57H59V43H33Z" fill="#FFF"/>
+                      </svg>
+                   </altsource>
+                </image>
+             </figure>
+             <figure id="_">
+                <image id="_" src="spec/assets/odf.svg" mimetype="image/svg+xml" height="auto" width="auto" filename="spec/assets/odf.svg">
+                   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
+                      <circle fill="#009" r="45" cx="50" cy="50"/>
+                      <path d="M33,26H78A37,37,0,0,1,33,83V57H59V43H33Z" fill="#FFF"/>
+                   </svg>
+                </image>
+             </figure>
+          </sections>
+       </metanorma>
+    OUTPUT
+    expect(strip_guid(Canon.format_xml(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to Canon.format_xml(output)
+  end
+
   it "processes svgmap" do
     FileUtils.cp "spec/fixtures/action_schemaexpg1.svg",
                  "action_schemaexpg1.svg"
@@ -1008,7 +1060,7 @@
 
   it "deduplicates identifiers in embedded SVGs" do
     input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR.sub(/:data-uri-image: false/, ':data-uri-image: true')}
+      #{ASCIIDOC_BLANK_HDR.sub(':data-uri-image: false', ':data-uri-image: true')}
 
       [height=100,width=100]
       image::spec/fixtures/action_schemaexpg1.svg[]
@@ -1021,7 +1073,7 @@
     output = <<~OUTPUT
         #{BLANK_HDR}
               <sections>
-          <figure id="_" width="100">
+          <figure id="_" height="100" width="100">
             <image src="spec/fixtures/action_schemaexpg1.svg" filename="spec/fixtures/action_schemaexpg1.svg" mimetype="image/svg+xml" id="_" height="100" width="100">
               <svg xmlns="http://www.w3.org/2000/svg" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 595.28 841.89" style="enable-background:new 0 0 595.28 841.89;" xml:space="preserve">
                 <style/>
@@ -1659,5 +1711,4 @@
     expect(strip_guid(Canon.format_xml(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to Canon.format_xml(output)
   end
-
 end