metanorma-standoc 2.2.0.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6a6d6a98133ba0cf81631287aff2157906da7d0978899abe5c00c78f0da6b2d
-  data.tar.gz: 81c33e16f952e56dcff81bd0485ead5ba998839b307e30eb8de500bf2448a600
+  metadata.gz: e1259358ae365bba52ab94c40d88b6cc9d4b1eb9b65a9f7fc8edef4bd77138e0
+  data.tar.gz: 6c348c7e3b1706287332368251d90fa277fee7e9a54a0fc0cd11e19f5464506b
 SHA512:
-  metadata.gz: b36c1f1766233c69f9b5a63298d8f7cd8745cac7f7186f210500bc23a27983b3202a724ebd799f6d305b928377ed5d2ef28dcb43aac4e9c91f65b9300a98ac19
-  data.tar.gz: e4b1be10928b81269486083791e7dd23fab26b2697d1b1a82fa607dfa4c6f46a00bdc4373403605c2807a993ab2f4015f34f643607610d10344cfbd95a6a83b3
+  metadata.gz: 602f12339e31a98c061ce7dc46d9fad6888b18e962942f110ebeea86f6739311b093578dbc8886a795bfcd01de790c40c134072449ff1e701779f2e29139a743
+  data.tar.gz: 39b93eb600aa0f18e21982174fc204eb36a9f28ae7e1e3b5a4a78ddfa9a05a440e6e3d6b94cdf7824dbd71b62880a193d5c88028ecd78d074c7c9361961966f6

data/.github/workflows/rake.yml

@@ -10,6 +10,6 @@ on:
 
 jobs:
   rake:
-    uses: metanorma/metanorma-build-scripts/.github/workflows/plantuml-rake.yml@main
+    uses: metanorma/ci/.github/workflows/plantuml-rake.yml@main
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+

data/lib/metanorma/standoc/base.rb

@@ -9,6 +9,7 @@ require "fileutils"
 require "metanorma-utils"
 require "isodoc/xslfo_convert"
 require_relative "render"
+require "mn-requirements"
 
 module Metanorma
   module Standoc
@@ -29,6 +30,7 @@ module Metanorma
         init_vars
         init_misc(node)
         init_processing(node)
+        init_reqt(node)
         init_toc(node)
         init_output(node)
         init_i18n(node)
@@ -42,7 +44,10 @@ module Metanorma
         @anchors = {}
         @internal_eref_namespaces = []
         @seen_headers = []
+        @seen_headers_canonical = []
         @embed_hdr = []
+        @reqt_model = nil
+        @preface = true
       end
 
       def init_misc(node)
@@ -63,6 +68,13 @@ module Metanorma
         @datauriimage = node.attr("data-uri-image") != "false"
       end
 
+      def init_reqt(node)
+        @default_requirement_model = (node.attr("requirements-model") ||
+                                        default_requirement_model)
+        @reqt_models = requirements_processor
+          .new({ default: @default_requirement_model })
+      end
+
       def init_toc(node)
         @htmltoclevels = node.attr("htmltoclevels")
         @doctoclevels = node.attr("doctoclevels")
@@ -100,6 +112,10 @@ module Metanorma
         init_iev_caches(node)
       end
 
+      def requirements_processor
+        Metanorma::Requirements
+      end
+
       def document(node)
         ret = document1(node)
         clean_exit

data/lib/metanorma/standoc/biblio.rng

@@ -225,9 +225,9 @@
         <zeroOrMore>
           <ref name="forename"/>
         </zeroOrMore>
-        <zeroOrMore>
-          <ref name="initial"/>
-        </zeroOrMore>
+        <optional>
+          <ref name="formatted-initials"/>
+        </optional>
         <ref name="surname"/>
         <zeroOrMore>
           <ref name="addition"/>
@@ -247,8 +247,8 @@
       <ref name="LocalizedString"/>
     </element>
   </define>
-  <define name="initial">
-    <element name="initial">
+  <define name="formatted-initials">
+    <element name="formatted-initials">
       <ref name="LocalizedString"/>
     </element>
   </define>
@@ -264,6 +264,9 @@
   </define>
   <define name="forename">
     <element name="forename">
+      <optional>
+        <attribute name="initial"/>
+      </optional>
       <ref name="LocalizedString"/>
     </element>
   </define>

data/lib/metanorma/standoc/blocks.rb

@@ -15,7 +15,8 @@ module Metanorma
         attr_code(id_attr(node).merge(
                     unnumbered: node.option?("unnumbered") ? "true" : nil,
                     number: node.attr("number"),
-                    subsequence: node.attr("subsequence")))
+                    subsequence: node.attr("subsequence"),
+                  ))
       end
 
       def formula_attrs(node)
@@ -33,7 +34,7 @@ module Metanorma
       # We append each contained block to its parent
       def open(node)
         role = node.role || node.attr("style")
-        reqt_subpart(role) and return requirement_subpart(node)
+        reqt_subpart?(role) and return requirement_subpart(node)
         role == "form" and return form(node)
         role == "definition" and return termdefinition(node)
         result = []
@@ -87,21 +88,33 @@ module Metanorma
       end
 
       def example(node)
-        return term_example(node) if in_terms? || node.option?("termexample")
-
+        (in_terms? || node.option?("termexample")) and return term_example(node)
         role = node.role || node.attr("style")
-        %w(recommendation requirement permission).include?(role) and
-          return requirement(node, role)
-        return pseudocode_example(node) if role == "pseudocode"
-        return svgmap_example(node) if role == "svgmap"
-        return form(node) if role == "form"
-        return termdefinition(node) if role == "definition"
-        return figure_example(node) if role == "figure"
-
-        reqt_subpart(role) and return requirement_subpart(node)
+        ret = example_to_requirement(node, role) ||
+          example_by_role(node, role) and return ret
+        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)
+        return unless @reqt_models.requirement_roles.key?(role&.to_sym)
+
+        # need to call here for proper recursion ordering
+        select_requirement_model(node)
+        requirement(node,
+                    @reqt_models.requirement_roles[role.to_sym], role)
+      end
+
       def svgmap_attrs(node)
         attr_code(id_attr(node)
           .merge(id: node.id, number: node.attr("number"),

data/lib/metanorma/standoc/cleanup_biblio.rb

@@ -84,8 +84,8 @@ module Metanorma
         dl = clause.at("./dl") or return
         key = ""
         bib = dl.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
-          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) or
-            add_to_hash(m, key, dd_bib_extract(dtd))
+          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) and next
+          add_to_hash(m, key, dd_bib_extract(dtd))
         end
         clause.xpath("./clause").each do |c1|
           key = c1&.at("./title")&.text&.downcase&.strip
@@ -145,7 +145,7 @@ module Metanorma
           when "publisher"
             ret[:contributor] << { role: "publisher", entity: "organization",
                                    name: s[:val] }
-          when "surname", "initials", "givenname"
+          when "surname", "initials", "givenname", "formatted-initials"
             ret[:contributor] = spans_preprocess_contrib(s, ret[:contributor])
           end
         end
@@ -153,6 +153,8 @@ module Metanorma
       end
 
       def spans_preprocess_contrib(span, contrib)
+        span[:key] = "formatted-initials" if span[:key] == "initials"
+
         spans_preprocess_new_contrib?(span, contrib) and
           contrib << { role: span[:type] || "author", entity: "person" }
         contrib[-1][span[:key].to_sym] = span[:val]
@@ -162,7 +164,7 @@ module Metanorma
       def spans_preprocess_new_contrib?(span, contrib)
         contrib.empty? ||
           (if span[:key] == "surname" then contrib[-1][:surname]
-           else (contrib[-1][:initials] || contrib[-1][:givenname])
+           else (contrib[-1][:"formatted-initials"] || contrib[-1][:givenname])
            end) ||
           contrib[-1][:role] != (span[:type] || "author")
       end
@@ -190,15 +192,19 @@ module Metanorma
       def span_to_contrib(span)
         e = if span[:entity] == "organization"
               "<organization><name>#{span[:name]}</name></organization>"
-            else
-              pre = (span[:initials] and
-                     "<initial>#{span[:initials]}</initial>") ||
-                "<forename>#{span[:givenname]}</forename>"
-              "<person><name>#{pre}<surname>#{span[:surname]}</surname></name>"\
-                "</person>"
+            else span_to_person(span)
             end
         "<contributor><role type='#{span[:role]}'/>#{e}</contributor>"
       end
+
+      def span_to_person(span)
+        pre = (span[:"formatted-initials"] and
+                     "<formatted-initials>"\
+                     "#{span[:"formatted-initials"]}</formatted-initials>") ||
+          "<forename>#{span[:givenname]}</forename>"
+        "<person><name>#{pre}<surname>#{span[:surname]}</surname></name>"\
+          "</person>"
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_reqt.rb

@@ -2,142 +2,9 @@ module Metanorma
   module Standoc
     module Cleanup
       def requirement_cleanup(xmldoc)
-        requirement_metadata(xmldoc)
-        requirement_inherit(xmldoc)
-        requirement_descriptions(xmldoc)
-        requirement_identifier(xmldoc)
-      end
-
-      REQRECPER = "//requirement | //recommendation | //permission".freeze
-
-      def requirement_identifier(xmldoc)
-        xmldoc.xpath(REQRECPER).each do |r|
-          r.xpath("./identifier[link] | ./inherit[link]").each do |i|
-            i.children = i.at("./link/@target").text
-          end
-        end
-      end
-
-      def requirement_inherit(xmldoc)
-        xmldoc.xpath(REQRECPER).each do |r|
-          ins = requirement_inherit_insert(r)
-          r.xpath("./*//inherit").each { |i| ins.previous = i }
-        end
-      end
-
-      def requirement_inherit_insert(reqt)
-        ins = reqt.at("./classification") || reqt.at(
-          "./description | ./measurementtarget | ./specification | "\
-          "./verification | ./import | ./description | ./component | "\
-          "./requirement | ./recommendation | ./permission",
-        ) and return ins
-        requirement_inherit_insert1(reqt)
-      end
-
-      def requirement_inherit_insert1(reqt)
-        if t = reqt.at("./title")
-          t.next = " "
-          t.next
-        else
-          if reqt.children.empty? then reqt.add_child(" ")
-          else reqt.children.first.previous = " "
-          end
-          reqt.children.first
-        end
-      end
-
-      def requirement_descriptions(xmldoc)
-        xmldoc.xpath(REQRECPER).each do |r|
-          r.xpath(".//p[not(./*)][normalize-space(.)='']").each(&:remove)
-          r.children.each do |e|
-            requirement_description_wrap(r, e)
-          end
-          requirement_description_cleanup1(r)
-        end
-      end
-
-      def requirement_description_wrap(reqt, text)
-        return if (text.element? && (reqt_subpart(text.name) ||
-                %w(requirement recommendation
-                   permission).include?(text.name))) ||
-          (text.text.strip.empty? && !text.at(".//xref | .//eref | .//link"))
-
-        t = Nokogiri::XML::Element.new("description", reqt.document)
-        text.before(t)
-        t.children = text.remove
-      end
-
-      def requirement_description_cleanup1(reqt)
-        while d = reqt.at("./description[following-sibling::*[1]"\
-                          "[self::description]]")
-          n = d.next.remove
-          d << n.children
-        end
-        reqt.xpath("./description[normalize-space(.)='']").each do |r|
-          r.replace("\n")
-        end
-      end
-
-      def requirement_metadata(xmldoc)
-        xmldoc.xpath(REQRECPER).each do |r|
-          dl = r&.at("./dl[@metadata = 'true']")&.remove or next
-          requirement_metadata1(r, dl, r.at("./title"))
-        end
-      end
-
-      def requirement_metadata1_attrs
-        %w(obligation model type)
-      end
-
-      def requirement_metadata1_tags
-        %w(identifier subject inherit)
-      end
-
-      def requirement_metadata_component_tags
-        []
-      end
-
-      def requirement_metadata1(reqt, dlist, ins)
-        unless ins
-          reqt.children.first.previous = " "
-          ins = reqt.children.first
-        end
-        requirement_metadata1_attrs.each do |a|
-          dl_to_attrs(reqt, dlist, a)
-        end
-        requirement_metadata1_tags.each do |a|
-          ins = dl_to_elems(ins, reqt, dlist, a)
-        end
-        ins = reqt_dl_to_classif(ins, reqt, dlist)
-        reqt_dl_to_classif1(ins, reqt, dlist)
-      end
-
-      def reqt_dl_to_classif(ins, reqt, dlist)
-        if a = reqt.at("./classification[last()]") then ins = a end
-        dlist.xpath("./dt[text()='classification']").each do |e|
-          val = e.at("./following::dd/p") || e.at("./following::dd")
-          req_classif_parse(val.children.to_xml).each do |r|
-            ins.next = "<classification><tag>#{r[0]}</tag>"\
-                       "<value>#{r[1]}</value></classification>"
-            ins = ins.next
-          end
-        end
-        ins
-      end
-
-      def reqt_dl_to_classif1(ins, reqt, dlist)
-        if a = reqt.at("./classification[last()]") then ins = a end
-        dlist.xpath("./dt").each do |e|
-          next if (requirement_metadata1_attrs + requirement_metadata1_tags +
-                   requirement_metadata_component_tags + %w(classification))
-            .include?(e.text)
-
-          val = e.at("./following::dd/p") || e.at("./following::dd")
-          ins.next = "<classification><tag>#{e.text}</tag>"\
-                     "<value>#{val.children.to_xml}</value></classification>"
-          ins = ins.next
-        end
-        ins
+        @reqt_models ||=
+          requirements_processor.new({ default: @default_requirement_model })
+        @reqt_models.requirement_cleanup(xmldoc)
       end
     end
   end

data/lib/metanorma/standoc/converter.rb

@@ -25,9 +25,6 @@ module Metanorma
         preprocessor Metanorma::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Metanorma::Plugin::Datastruct::Json2TextPreprocessor
         preprocessor Metanorma::Plugin::Datastruct::Yaml2TextPreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
         inline_macro Metanorma::Standoc::PreferredTermInlineMacro
         inline_macro Metanorma::Standoc::SpanInlineMacro
         inline_macro Metanorma::Standoc::AltTermInlineMacro
@@ -56,15 +53,11 @@ module Metanorma
         inline_macro Metanorma::Standoc::ToCInlineMacro
         inline_macro Metanorma::Standoc::PassInlineMacro
         inline_macro Metanorma::Standoc::StdLinkInlineMacro
-        inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
-        inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
-        block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Metanorma::Standoc::ToDoAdmonitionBlock
         block Metanorma::Standoc::EditorAdmonitionBlock
         treeprocessor Metanorma::Standoc::EditorInlineAdmonitionBlock
         treeprocessor Metanorma::Standoc::ToDoInlineAdmonitionBlock
         block Metanorma::Standoc::PlantUMLBlockMacro
-        block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
         block Metanorma::Standoc::PseudocodeBlockMacro
         preprocessor Metanorma::Standoc::EmbedIncludeProcessor
         preprocessor Metanorma::Standoc::NamedEscapePreprocessor

data/lib/metanorma/standoc/front.rb

@@ -3,6 +3,7 @@ require "nokogiri"
 require "htmlentities"
 require "pathname"
 require_relative "./front_contributor"
+require "isoics"
 
 module Metanorma
   module Standoc
@@ -48,7 +49,11 @@ module Metanorma
       def metadata_ics(node, xml)
         ics = node.attr("library-ics")
         ics&.split(/,\s*/)&.each do |i|
-          xml.ics { |elem| elem.code i }
+          xml.ics do |elem|
+            elem.code i
+            icsdata = Isoics.fetch i
+            elem.text_ icsdata.description
+          end
         end
       end
 

data/lib/metanorma/standoc/front_contributor.rb

@@ -44,16 +44,6 @@ module Metanorma
         node.attr("pub-uri") and person.uri node.attr("pub-uri")
       end
 
-      # , " => ," : 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
-
       def metadata_author(node, xml)
         csv_split(node.attr("publisher") || default_publisher || "")
           &.each do |p|

data/lib/metanorma/standoc/macros_terms.rb

@@ -103,16 +103,16 @@ module Metanorma
     class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :concept
-      match /\{\{(?<content>|.*?[^\\])\}\}/
+      match /\{\{(?<content>|.*?[^\\])\}\}/m
       using_format :short
 
       def preprocess_attrs(target)
-        m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/.match(target)
+        m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/m.match(target)
         ret = { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;$/, "") }
-        if m2 = /^(?<rest>.*?)(?<opt>,opt(?:ion)?s=.+)$/
+        if m2 = /^(?<rest>.*?)(?<opt>,opt(?:ion)?s=.+)$/m
             .match(m[:rest].sub(/^,/, ""))
           ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,opt(ion)?s=/, "")
-            .sub(/^"(.+)"$/, "\\1").sub(/^'(.+)'$/, "\\1"))
+            .sub(/^"(.+)"$/m, "\\1").sub(/^'(.+)'$/m, "\\1"))
           begin
             attrs = CSV.parse_line(m2[:rest]) || []
           rescue StandardError
@@ -125,6 +125,7 @@ module Metanorma
             raise "error processing #{m[:rest]} as CSV"
           end
         end
+        attrs.map! { |x| x.gsub(/\s+/, " ") }
         ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
                   render: attrs[2])
       end

data/lib/metanorma/standoc/reqt.rb

@@ -1,91 +1,42 @@
-require "htmlentities"
-require "uri" if /^2\./.match?(RUBY_VERSION)
-require "mime/types"
-require "base64"
-
 module Metanorma
   module Standoc
     module Blocks
-      def reqt_subpart(name)
-        %w(specification measurement-target verification import identifier title
-           description component subject inherit classification).include? name
-      end
-
-      def reqt_subpart_attrs(node, name)
-        klass = node.attr("class") || "component"
-        attr_code(keep_attrs(node)
-          .merge(exclude: node.option?("exclude"),
-                 type: node.attr("type"),
-                 class: name == "component" ? klass : nil))
+      def reqt_subpart?(name)
+        @reqt_model&.reqt_subpart?(name)
       end
 
       def requirement_subpart(node)
-        name = node.role || node.attr("style")
-        noko do |xml|
-          xml.send name, **reqt_subpart_attrs(node, name) do |o|
-            o << node.content
-          end
-        end
+        @reqt_model.requirement_subpart(node, keep_attrs(node))
       end
 
-      def req_classif_parse(classif)
-        ret = []
-        @c.decode(classif).split(/;\s*/).each do |c|
-          c1 = c.split(/:\s*/)
-          next unless c1.size == 2
-
-          c1[1].split(/,\s*/).each { |v| ret << [c1[0], v] }
-        end
-        ret
+      def default_requirement_model
+        :default
       end
 
-      def requirement_classification(classif, out)
-        req_classif_parse(classif).each do |r|
-          out.classification do |c|
-            c.tag { |t| t << r[0] }
-            c.value { |v| v << r[1] }
-          end
-        end
-      end
+      def select_requirement_model(node)
+        return if @reqt_model
 
-      def reqt_attrs(node)
-        attr_code(keep_attrs(node).merge(id_unnum_attrs(node)).merge(
-                    id: Metanorma::Utils::anchor_or_uuid(node),
-                    unnumbered: node.option?("unnumbered") ? "true" : nil,
-                    number: node.attr("number"),
-                    subsequence: node.attr("subsequence"),
-                    obligation: node.attr("obligation"),
-                    filename: node.attr("filename"),
-                    type: node.attr("type"),
-                    model: node.attr("model"),
-                  ))
+        @reqt_model_name = node.attr("model") || @default_requirement_model
+        @reqt_model = @reqt_models.model(@reqt_model_name)
       end
 
-      def requirement_elems(node, out)
-        node.title and out.title { |t| t << node.title }
-        a = node.attr("identifier") and out.identifier do |l|
-          l << out.text(a)
-        end
-        a = node.attr("subject") and csv_split(a)&.each do |subj|
-          out.subject { |s| s << out.text(subj) }
-        end
-        a = @c.decode(node.attr("inherit")) and
-          csv_split(a)&.each do |i|
-            out.inherit do |inh|
-              inh << @c.encode(i, :hexadecimal)
-            end
-          end
-        classif = node.attr("classification") and
-          requirement_classification(classif, out)
+      def requirement(node, obligation, type)
+        nested = @reqt_model
+        !node.attr("type") &&
+          !%w(requirement recommendation permission).include?(type) and
+          node.set_attr("type", type)
+        attrs = keep_attrs(node).merge(id_unnum_attrs(node))
+          .merge(model: @reqt_model_name)
+        ret = @reqt_model.requirement(node, obligation, attrs)
+        @reqt_model = nil unless nested
+        ret
       end
 
-      def requirement(node, obligation)
-        noko do |xml|
-          xml.send obligation, **reqt_attrs(node) do |ex|
-            requirement_elems(node, ex)
-            wrap_in_para(node, ex)
-          end
-        end.join("\n")
+      def requirement_validate(docxml)
+        docxml.xpath("//requirement | //recommendation | //permission")
+          .each do |r|
+          @reqt_models.model(r["model"]).validate(r, @log)
+        end
       end
     end
   end