isodoc 3.6.11 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82d4992cdf6cebe7c3abf1b624847dc08586213fa57c7ce01e98d86d721cafbf
-  data.tar.gz: 0025b823e97539b471833bef1de6424d56d6b569343b6fd414de20b575f46e11
+  metadata.gz: 1704124a224846f711e07140b38b352fe8d9548465654168467b0d892c29867d
+  data.tar.gz: eedf867e52f1ff13d2c7166a4bd9361ac432da5afc688c4d7bfa50f0f91bada5
 SHA512:
-  metadata.gz: 1da939aa2ae8858bd2731a1fdbe0ddaf77cdc7d170655502d4b110ecb1e149ce5e6e9dc8c2cbed77389f2cc8c05977f72e445d8aa28b43276b89080c3a23b8ec
-  data.tar.gz: c59cfc4210201281df2a282b7822b5aa76371855db0840defb57f2afd50b617127be738d41b10a1c0512267cf4946ba9b0180eff2437b14b63b334b6d4b93c6d
+  metadata.gz: 20ce7106f1eb73784cf58ef1ed0bf7bfc7f5bcd6c1a8495f4bec0b19326b70f7228fc2b0886abe4c98df19d2f42cc0456be55c6eba6d90c7806bbbff56bd5cd7
+  data.tar.gz: ca9607aceeafd8d263a6cc779f6311d709b1c35c6be218ec6b0dee2193e86eb1cdc1725b0457d79c8967bcb27e6c4df4b062ca972960e96690e309ab7c9e9503

data/isodoc.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "base64"
   spec.add_dependency "bigdecimal"
-  spec.add_dependency "html2doc", "~> 1.11.0"
+  spec.add_dependency "html2doc", "~> 1.12"
   # spec.add_dependency "isodoc-i18n", "~> 1.1.0" # already in relaton-render and mn-requirements
-  # spec.add_dependency "relaton-cli"
+  spec.add_dependency "relaton-cli", "~> 2.1.0"
   # spec.add_dependency "metanorma-utils", "~> 1.5.0" # already in isodoc-i18n
   spec.add_dependency "mn2pdf", ">= 2.13"
   spec.add_dependency "mn-requirements", "~> 0.5.0"

data/lib/isodoc/base_style/reset.css

@@ -143,6 +143,11 @@ a.FootnoteRef, span.FootnoteRef {
   vertical-align: super;
 }
 
+a.TableFootnoteRef, a.FootnoteRef, a.footnote-number,
+sup a, a:has(> sup) {
+  vertical-align: baseline;
+}
+
 .addition {
   color: blue;
 }

data/lib/isodoc/base_style/reset.scss

@@ -145,9 +145,21 @@ div.document-stage-band, div.document-type-band {
   background-color: #333333;
 }
 
-a.TableFootnoteRef, span.TableFootnoteRef, 
+a.TableFootnoteRef, span.TableFootnoteRef,
 a.FootnoteRef, span.FootnoteRef {
-  vertical-align: super; 
+  vertical-align: super;
+}
+
+// A footnote-style link superscripts its content through an inner <sup>, but the
+// link's underline rides up with the anchor's own `vertical-align: super`,
+// leaving a raised underline that reads as a stray dash. Keep the *anchor* on
+// the baseline (so the underline stays at the bottom of the line) and let the
+// inner <sup> alone raise the glyph. The anchor classes are named explicitly
+// because the generic `a:has(> sup)` has lower specificity than the rule above;
+// `sup a` covers the inverse nesting. https://github.com/metanorma/iso-10303/issues/717
+a.TableFootnoteRef, a.FootnoteRef, a.footnote-number,
+sup a, a:has(> sup) {
+  vertical-align: baseline;
 }
 
 .addition {

data/lib/isodoc/function/blocks_example_note.rb

@@ -61,10 +61,9 @@ module IsoDoc
 
       # HTML5 collapsible example: label in <summary>, body in the example div
       def example_collapsible_parse(node, out)
-        out.details(open: "open") do |det|
-          name = node.at(ns("./fmt-name"))
+        out.details(**example_collapsible_parse_attr) do |det|
           det.summary do |s|
-            name and children_parse(name, s)
+            name = node.at(ns("./fmt-name")) and children_parse(name, s)
           end
           det.div(**example_div_attr(node)) do |div|
             node.children.each do |n|
@@ -74,6 +73,10 @@ module IsoDoc
         end
       end
 
+      def example_collapsible_parse_attr
+        @details_open ? { open: "open" } : {}
+      end
+
       def block_body_first_elem(node)
         node.elements.each do |n|
           %w(title fmt-title fmt-xref-label fmt-name name)

data/lib/isodoc/function/setup.rb

@@ -43,6 +43,7 @@ module IsoDoc
       def info(isoxml, out)
         @meta.localdir = @localdir
         @meta.presentation isoxml, out
+        @meta.bibdata isoxml, out
         @meta.code_css isoxml, out
         @meta.title isoxml, out
         @meta.subtitle isoxml, out

data/lib/isodoc/init.rb

@@ -30,9 +30,11 @@ module IsoDoc
         .new(language: @lang, script: @script)
     end
 
-    def docxml_var_init(docxml)
-      doctype_init(docxml)
-      toc_init(docxml)
+    def docxml_var_init(xml)
+      doctype_init(xml)
+      toc_init(xml)
+      @details_open = xml.at(ns("//metanorma-extension/presentation-metadata/" \
+                                "html-details-open"))&.text != "false"
     end
 
     def doctype_init(docxml)

data/lib/isodoc/metadata.rb

@@ -1,5 +1,6 @@
 require_relative "metadata_date"
 require_relative "metadata_contributor"
+require_relative "metadata_bibdata"
 
 module IsoDoc
   class Metadata
@@ -72,15 +73,29 @@ module IsoDoc
         set(:substage_display, i1)
       (i2 = xml.at(ns("//bibdata/status/iteration"))&.text) and
         set(:iteration, i2)
-      !published && set(:stageabbr, stage_abbr(s.text))
+      # @abbreviation is authoritative (e.g. supplied by a taste through
+      # :docstage-abbrev:); read here rather than in stage_abbr, so that
+      # flavour stage_abbr overrides do not mask it
+      published or
+        set(:stageabbr, s["abbreviation"] || stage_abbr(s.text))
     end
 
     def published_default(xml)
       override = xml.at(ns("//semantic-metadata/stage-published"))&.text
-      default = override || "true"
-      ret = default == "false"
-      set(:unpublished, ret)
-      default == "true"
+      if override.nil?
+        stage = xml.at(ns("//bibdata/status/stage#{NOLANG}"))&.text
+        override = draft_stage?(stage) ? "false" : "true"
+      end
+      set(:unpublished, override == "false")
+      override == "true"
+    end
+
+    # Is the stage a draft (unpublished) stage? Overridable seam for
+    # documents whose XML does not carry semantic-metadata/
+    # stage-published (which is authoritative when present). Base
+    # default preserves historical behaviour: absent flag => published.
+    def draft_stage?(_stage)
+      false
     end
 
     def stage_abbr(docstatus)

data/lib/isodoc/metadata_bibdata.rb

@@ -0,0 +1,73 @@
+require "relaton-cli"
+
+module IsoDoc
+  class BibdataConfig < ::Lutaml::Model::Serializable
+    class Bibdata < ::Lutaml::Model::Serializable
+      model ::Relaton::Bib::ItemData
+    end
+
+    attribute :bibdata, Bibdata
+
+    xml do
+      root "metanorma"
+      map_element "bibdata", to: :bibdata, with: { from: :bibdata_from_xml,
+                                                   to: :bibdata_to_xml }
+    end
+
+    def bibdata_from_xml(model, node)
+      node or return
+      model.bibdata = Relaton::Cli.parse_xml(node.adapter_node.native)
+    end
+
+    def bibdata_to_xml(model, parent, doc); end
+  end
+
+  class Metadata
+    def bibdata(isoxml, _out)
+      set(:bibdata, bibdata_hash(isoxml))
+    end
+
+    private
+
+    def bibdata_hash(isoxml)
+      b = isoxml.at("//bibdata") || isoxml.at("//xmlns:bibdata") or return
+      key = b.to_xml
+      # memoised by content, not unconditionally: after
+      # docidentifier_boilerplate_isodoc resolves Liquid docidentifiers,
+      # refresh_isodoc_bibdata re-runs this walker on the same Metadata
+      # instance and must re-parse the changed bibdata
+      @bibdata_hash_cache ||= {}
+      @bibdata_hash_cache.key?(key) or
+        @bibdata_hash_cache[key] = bibdata_hash_parse(key)
+      @bibdata_hash_cache[key]
+    end
+
+    def bibdata_hash_parse(bibdata_xml)
+      stripped = Nokogiri::XML(bibdata_xml)
+      stripped.remove_namespaces!
+      # Drop @boilerplate="true" docidentifiers before handing the
+      # bibdata to Relaton::Cli.parse_xml: their content is an
+      # unresolved Liquid template, and recent relaton-iho /
+      # relaton-cc / etc. eagerly call pubid in their docidentifier
+      # content= setter, which crashes on raw Liquid syntax. The
+      # template variables for substitution come from other bibdata
+      # fields (seriesabbr, docnumeric, …), not from the
+      # docidentifier itself, so dropping it here does not affect
+      # what we feed back into isodoc.meta. Substitution still runs
+      # on the original xmldoc via standoc's
+      # docidentifier_boilerplate_isodoc; afterwards
+      # refresh_isodoc_bibdata re-runs this walker to seed
+      # meta[:bibdata] with the resolved docidentifier.
+      # See https://github.com/metanorma/metanorma/issues/558.
+      stripped.xpath("//docidentifier[@boilerplate = 'true']").each(&:remove)
+      bib = BibdataConfig.from_xml(
+        "<metanorma>#{stripped.root.to_xml}</metanorma>",
+      ).bibdata or return nil
+      YAML.safe_load(bib.to_yaml, permitted_classes: [Date, Symbol],
+                                  symbolize_names: true)
+    rescue StandardError => e
+      warn "Failed to parse bibdata for Liquid template use: #{e.message}"
+      nil
+    end
+  end
+end

data/lib/isodoc/presentation_function/block.rb

@@ -101,9 +101,18 @@ module IsoDoc
       labelled_autonum(lbl, elem["id"] || elem["original-id"], num)
     end
 
+    # The presentation-metadata element is named from the document
+    # attribute :presentation-metadata-admonition-icon-{type}:, whose name
+    # cannot contain spaces; so spaced admonition types ("safety
+    # precautions") address it with spaces replaced by underscores --
+    # underscore, not hyphen, to avoid collision with genuinely hyphenated
+    # type names. Interpolating the raw type made the XPath invalid and
+    # fatal (#760). The i18n lookup keeps the raw type: i18n keys may
+    # legitimately contain spaces.
     def admonition_icon(elem)
+      type = elem["type"]&.tr(" ", "_")
       icon = elem.document
-        .at(ns("//presentation-metadata/admonition-icon-#{elem['type']}"))&.text
+        .at(ns("//presentation-metadata/admonition-icon-#{type}"))&.text
       icon ||= @i18n.labels.dig("admonition-icon", elem["type"])
       icon and return "<span class='fmt-admonition-icon'>#{icon}</span>"
     end

data/lib/isodoc/presentation_function/footnotes.rb

@@ -41,9 +41,14 @@ module IsoDoc
       ins = body.at(ns(".//p")) ||
         body.at(ns("./semx")).children.first.before("<p> </p>").previous
       lbl = fn_body_label(fnote)
-      ins.children.first.previous = <<~FNOTE.strip
+      fnote = <<~FNOTE.strip
         <fmt-fn-label><span class='fmt-caption-label'>#{lbl}</span><span class="fmt-caption-delim"><tab/></fmt-fn-label>
       FNOTE
+      if ins.children.first
+        ins.children.first.previous = fnote
+      else
+        ins << fnote
+      end
     end
 
     def fn_ref_label(fnote)

data/lib/isodoc/presentation_function/index.rb

@@ -9,7 +9,7 @@ module IsoDoc
         i = xml.at(ns("//indexsect")) ||
           xml.root.add_child(
             "<indexsect #{add_id_text}>" \
-             "<fmt-title #{add_id_text}>#{@i18n.index}</fmt-title></indexsect>",
+            "<fmt-title #{add_id_text}>#{@i18n.index}</fmt-title></indexsect>",
           ).first
         index = sort_indexterms(xml.xpath(ns("//index")),
                                 xml.xpath(ns("//index-xref[@also = 'false']")),

data/lib/isodoc/presentation_function/math.rb

@@ -59,7 +59,8 @@ module IsoDoc
                              hex_capital).freeze
     NUMBERFORMAT_NULLABLE = %i(base_prefix base_suffix).freeze
     # plurimath options metanorma deliberately passes through unchanged (string)
-    NUMBERFORMAT_PASSTHROUGH = %i(fraction_group decimal group times e).freeze
+    NUMBERFORMAT_PASSTHROUGH = %i(fraction_group decimal group times e
+                                  padding).freeze
     NUMBERFORMAT_KNOWN = (NUMBERFORMAT_INTEGER + NUMBERFORMAT_SYMBOL +
                           NUMBERFORMAT_NULLABLE + NUMBERFORMAT_PASSTHROUGH).freeze
 

data/lib/isodoc/presentation_function/metadata.rb

@@ -18,14 +18,14 @@ module IsoDoc
     def logo_expand_pres_metadata(docxml)
       docxml.xpath(ns("//metanorma-extension/presentation-metadata/*"))
         .each do |x|
-          logo_size_pres_metadata_incomplete?(x) or next
-          parts = x.name.split("-")
-          @output_formats.each_key do |f|
-            tagname = "logo-#{parts[1]}-#{f}-#{parts[2..].join('-')}"
-            x.parent.next = <<~XML
-              <presentation-metadata><#{tagname}>#{x.text}</#{tagname}></presentation-metadata>
-            XML
-          end
+        logo_size_pres_metadata_incomplete?(x) or next
+        parts = x.name.split("-")
+        @output_formats.each_key do |f|
+          tagname = "logo-#{parts[1]}-#{f}-#{parts[2..].join('-')}"
+          x.parent.next = <<~XML
+            <presentation-metadata><#{tagname}>#{x.text}</#{tagname}></presentation-metadata>
+          XML
+        end
       end
     end
 
@@ -71,7 +71,7 @@ module IsoDoc
     def save_attachment(attachment, dir)
       n = File.join(dir, File.basename(attachment["name"]))
       c = attachment.text.sub(%r{^data:[^;]+;(?:charset=[^;]+;)?base64,}, "")
-      File.open(n, "wb") { |f| f.write(Base64.decode64(c)) }
+      File.binwrite(n, Base64.decode64(c))
     end
 
     def extension_insert(xml, path = [])
@@ -94,14 +94,14 @@ module IsoDoc
 
     def toc_metadata(docxml)
       @tocfigures || @toctables || @tocrecommendations || @tocexamples or return
-      ins = extension_insert(docxml)
+      ins = presmeta_insert_pt(docxml)
       @tocfigures and
         ins.add_child "<toc type='figure'><title>#{@i18n.toc_figures}</title></toc>"
       @toctables and
         ins << "<toc type='table'><title>#{@i18n.toc_tables}</title></toc>"
       @tocrecommendations and
         ins << "<toc type='recommendation'><title>#{@i18n.toc_recommendations}" \
-        "</title></toc>"
+               "</title></toc>"
       @tocexamples and
         ins << "<toc type='example'><title>#{@i18n.toc_examples}</title></toc>"
     end
@@ -158,7 +158,7 @@ module IsoDoc
             i18n_name(v1, "#{i18n_safe(k)}.#{i}", lang).each { |x| g << x }
           end
         else
-          g << i18n_tag("#{pref}#{pref.empty? ? '' : '.'}#{i18n_safe(k)}", v,
+          g << i18n_tag("#{pref}#{'.' unless pref.empty?}#{i18n_safe(k)}", v,
                         lang)
         end
       end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "3.6.11".freeze
+  VERSION = "3.7.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 3.6.11
+  version: 3.7.0
 platform: ruby
 authors:
 - Ribose Inc.
@@ -43,14 +43,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: relaton-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: mn2pdf
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +189,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".hound.yml"
 - ".oss-guides.rubocop.yml"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -252,6 +265,7 @@ files:
 - lib/isodoc/i18n.rb
 - lib/isodoc/init.rb
 - lib/isodoc/metadata.rb
+- lib/isodoc/metadata_bibdata.rb
 - lib/isodoc/metadata_contributor.rb
 - lib/isodoc/metadata_date.rb
 - lib/isodoc/pdf_convert.rb

data/.hound.yml

@@ -1,5 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-ruby:
-  enabled: true
-  config_file: .rubocop.yml