mn-requirements 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01bee8304acc8f185870fb5f6960e2a7393d096acc9cdf9ea4e87918baf297e0
-  data.tar.gz: 11412398e35579a0e3022250101a3629409b7f784da526d152de6a1a69c00e33
+  metadata.gz: 75b1df8d56f422dda0f7d9ad8118a4ec48dd57c2d05994b84119e5f8bbf2d5cd
+  data.tar.gz: 436b0b873cdba89c706bbd549ad4aa4bbfd23ff551a017af10b611f340f6f9af
 SHA512:
-  metadata.gz: e9d3f86cd517967140e1febd7c7852d55dd3b1b4b8c74d1159c335d42717fc51c960218caf5631d9f135701b8f812b830685ad5224ac9dbc4249ee24a0cfcda9
-  data.tar.gz: 7cc6c088de6e4ea5ae8050844ccf0d9cf49369bf63b89ffa4892316539d57d5ae89074fe184191a4e78e940d59efef1abc09e3bd88805125ff734aeb7f11f735
+  metadata.gz: 1bec02a150e493a2fa71fedeaa42c9d1167c13022a82106c6ab91974e26a0ae6e96088b879d21afc2fbc9bc83d44c88af982579ad3bc2ddfb74a56c7658a50ec
+  data.tar.gz: b508da3936b44d98d437c4c7c27b46515a55bcb01671c1040cd282f6472013b7c6426b8c0703ce476ba482671dc7222487ab12d10c5c7efc02f7372ca701dd50

data/lib/isodoc/i18n.rb

@@ -5,7 +5,7 @@ module IsoDoc
   class MnRequirementsI18n < I18n
     def load_yaml1(lang, script)
       case lang
-      when "en", "fr", "ru", "de", "es", "ar"
+      when "en", "fr", "ru", "de", "es", "ar", "ja"
         load_yaml2(lang)
       when "zh"
         if script == "Hans" then load_yaml2("zh-Hans")

data/lib/isodoc-yaml/i18n-ja.yaml

@@ -0,0 +1,31 @@
+requirements:
+  default:
+    requirement: 要求
+    recommendation: 推奨
+    permission: 許可
+    obligation: 義務
+    subject: 主題
+    inherits: 継承
+  modspec:
+    recommendationtest: 要求テスト
+    requirementtest: 要求テスト
+    permissiontest: 許可テスト
+    recommendationclass: 要求クラス
+    requirementclass: 要求クラス
+    permissionclass: 許可クラス
+    abstracttest: 抽象テスト
+    conformanceclass: 適合クラス
+    conformancetest: 適合性テスト
+    targettype: ターゲットタイプ
+    target: ターゲット
+    testpurpose: テスト目的
+    testmethod: 試験方法
+    dependency: 前提条件
+    indirectdependency: 間接的な前提条件
+    identifier: 識別子
+    included_in: 含まれる
+    statement: 声明
+    description: 説明
+    guidance: ガイダンス
+    implements: 実装
+    provision: 規範的声明

data/lib/metanorma/default/cleanup.rb

@@ -72,7 +72,7 @@ module Metanorma
       end
 
       def requirement_metadata1_attrs
-        %w(obligation model type)
+        %w(obligation model type class)
       end
 
       def requirement_metadata1_tags
@@ -112,7 +112,7 @@ module Metanorma
       def unwrap_para(ddef)
         e = ddef.elements and e.size == 1 && e.first.name == "p" and
           ddef = e.first
-        ddef.children.to_xml
+        to_xml(ddef.children)
       end
 
       def reqt_dl_to_classif(ins, reqt, dlist)

data/lib/metanorma/default/default.rb

@@ -65,6 +65,7 @@ module Metanorma
                     obligation: node.attr("obligation"),
                     filename: node.attr("filename"),
                     type: node.attr("type"),
+                    class: node.attr("class"),
                   ))
       end
 

data/lib/metanorma/default/isodoc.rb

@@ -6,13 +6,33 @@ module Metanorma
       end
 
       def recommendation_label(elem, type, xrefs)
-        number = xrefs.anchor(elem["id"], :label, false)
-        (number.nil? ? type : "#{type} #{number}")
+        label, title = recommendation_labels(elem)
+        type = "<span class='fmt-element-name'>#{type}</span>"
+        num = xrefs.anchor(elem["id"], :label, false)
+        num &&= "<semx element='autonum' source='#{elem['id']}'>#{num}</semx>"
+        ret = "#{type} #{num}".strip
+        label || title and
+          ret += recommendation_label_add(elem, label, title)
+        ret
+      end
+
+      def recommendation_label_add(elem, label, title)
+        r = recommendation_label_caption_delim
+        label and
+          r += "<semx element='identifier' source='#{elem['id']}'>#{label}</semx>"
+        label && title and r += ". "
+        title and
+          r += "<semx element='title' source='#{elem['id']}'>#{title}</semx>"
+        r
+      end
+
+      def recommendation_label_caption_delim
+        "<span class='fmt-caption-delim'>:<br/></span>"
       end
 
       def reqt_metadata_node?(node)
         %w(identifier title subject classification tag value
-           inherit name).include? node.name
+           inherit name fmt-name fmt-xref-label fmt-title).include? node.name
       end
 
       def requirement_render1(node)
@@ -25,35 +45,27 @@ module Metanorma
         out
       end
 
+      def recommendation_header(_node, out)
+        out
+      end
+
       def recommendation_base(node, klass)
         out = node.document.create_element(klass)
         node.attributes.each do |k, v|
           out[k] = v
         end
+        n = node.at(ns("./fmt-name")) and out << n
+        n = node.at(ns("./fmt-xref-label")) and out << n
         out
       end
 
       def recommendation_labels(node)
-        [node.at(ns("./identifier")), node.at(ns("./title")),
-         node.at(ns("./name"))]
+        [node.at(ns("./identifier")), node.at(ns("./title"))]
           .map do |n|
-          n&.children&.to_xml
+          to_xml(n&.children)
         end
       end
 
-      def recommendation_header(node, out)
-        label, title, name = recommendation_labels(node)
-        ret = name ? [name] : []
-        if label || title
-          ret << ":" unless ret.empty?
-          ret += ["<br/>", label]
-          ret << ". " if label && title
-          ret << title
-        end
-        out << "<name>#{l10n(ret.compact.join)}</name>"
-        out
-      end
-
       def recommendation_attributes1(node, out)
         oblig = node["obligation"] and
           out << l10n("#{@labels['default']['obligation']}: #{oblig}")
@@ -70,14 +82,14 @@ module Metanorma
       end
 
       def recommendation_attr_parse(node, label)
-        l10n("#{label}: #{node.children.to_xml}")
+        l10n("#{label}: #{to_xml(node.children)}")
       end
 
       def recommendation_attr_keyvalue(node, key, value)
         tag = node.at(ns("./#{key}")) or return nil
         value = node.at(ns("./#{value}")) or return nil
         l10n("#{Metanorma::Utils.strict_capitalize_first tag.text}: " \
-             "#{value.children.to_xml}")
+             "#{to_xml(value.children)}")
       end
 
       def recommendation_attributes(node, out)

data/lib/metanorma/default/utils.rb

@@ -22,6 +22,11 @@ module Metanorma
       def ns(xpath)
         Metanorma::Utils.ns(xpath)
       end
+
+      def to_xml(node)
+        node&.to_xml(encoding: "UTF-8", indent: 0,
+                   save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
+      end
     end
   end
 end

data/lib/metanorma/modspec/cleanup.rb

@@ -34,7 +34,7 @@ module Metanorma
       def requirement_metadata1(reqt, dlist, ins)
         ins1 = super
         dlist.xpath("./dt").each do |e|
-          tag = e.text&.gsub(/ /, "-")&.downcase
+          tag = e.text&.tr(" ", "-")&.downcase
           tag = "description" if tag == "statement"
           next unless requirement_metadata_component_tags.include?(tag)
 
@@ -93,7 +93,8 @@ module Metanorma
       end
 
       def requirement_metadata_to_component(reqt)
-        xpath = requirement_metadata_component_tags - %w(statement description) -
+        xpath = requirement_metadata_component_tags - %w(statement
+                                                         description) -
           requirement_metadata_requirement_tags
         reqt.xpath(xpath.map { |x| ".//#{x}" }.join(" | ")).each do |c|
           c["class"] = c.name
@@ -126,7 +127,7 @@ module Metanorma
           next if %w(p ol ul dl table component description)
             .include?(c&.elements&.first&.name)
 
-          c.children = "<p>#{c.children.to_xml}</p>"
+          c.children = "<p>#{to_xml(c.children)}</p>"
         end
       end
 

data/lib/metanorma/modspec/isodoc.rb

@@ -8,7 +8,9 @@ module Metanorma
       def requirement_render1(node)
         init_lookups(node.document)
         ret = requirement_guidance_parse(node, super)
-        requirement_table_cleanup(node, ret)
+        out = requirement_table_cleanup(node, ret)
+        out["class"] = "modspec" # deferred; node["class"] is labelling class
+        out
       end
 
       def recommendation_base(node, _klass)
@@ -17,7 +19,6 @@ module Metanorma
         %w(id keep-with-next keep-lines-together unnumbered).each do |x|
           out[x] = node[x] if node[x]
         end
-        out["class"] = "modspec"
         out["type"] = recommend_class(node)
         recommendation_component_labels(node)
         out
@@ -33,11 +34,11 @@ module Metanorma
       end
 
       def recommendation_header(reqt, out)
-        n = recommendation_name(reqt, nil)
+        n = reqt.at(ns("./fmt-name"))
         x = if reqt.ancestors("requirement, recommendation, permission").empty?
-              "<thead><tr><th scope='colgroup' colspan='2'>" \
-                "<p class='#{recommend_name_class(reqt)}'>#{n}</p>" \
-                "</th></tr></thead>"
+              <<~THEAD
+                <thead><tr><th scope='colgroup' colspan='2'><p class='#{recommend_name_class(reqt)}'>#{n}</p></th></tr></thead>
+              THEAD
             else
               "<thead><tr><th>#{recommendation_class_label(reqt)}</th>" \
                 "<td>#{n}</td></tr></thead>"
@@ -46,10 +47,11 @@ module Metanorma
         out
       end
 
+=begin
       def recommendation_name(node, _out)
         ret = ""
-        name = node.at(ns("./name")) and ret += name.children.to_xml
-        title = node.at(ns("./title"))
+        name = node.at(ns("./fmt-name")) and ret += name.children.to_xml
+        title = node.at(ns("./fmt-title"))
         return ret unless title &&
           node.ancestors("requirement, recommendation, permission").empty?
 
@@ -57,6 +59,25 @@ module Metanorma
         ret += title.children.to_xml
         l10n(ret)
       end
+=end
+
+      def recommendation_label_add(elem, _label, title)
+        title or return ""
+        r = recommendation_label_caption_delim
+        title and
+          r += "<semx element='title' source='#{elem['id']}'>#{title}</semx>"
+        r
+      end
+
+      def recommendation_label_caption_delim
+        "<span class='fmt-caption-delim'>: </span>"
+      end
+
+      def recommendation_labels(node)
+        node.ancestors("requirement, recommendation, permission").empty? or
+          return [nil, nil]
+        super
+      end
 
       def recommendation_attributes(node, out)
         ins = out.add_child("<tbody></tbody>").first
@@ -71,7 +92,7 @@ module Metanorma
         label = node.at(ns("./identifier")) or return
         ret = <<~OUTPUT
           <tr><th>#{@labels['modspec']['identifier']}</th>
-          <td><tt><modspec-ident>#{label.children.to_xml}</modspec-ident></tt></td>
+          <td><tt><modspec-ident>#{to_xml(label.children)}</modspec-ident></tt></td>
         OUTPUT
         out.add_child(ret)
       end
@@ -119,7 +140,7 @@ module Metanorma
       def recommendation_attributes1_inherit(node, head)
         node.xpath(ns("./inherit")).each do |i|
           head << [@labels["modspec"]["dependency"],
-                   recommendation_id(i.children.to_xml)]
+                   recommendation_id(to_xml(i.children))]
         end
         head
       end
@@ -128,8 +149,8 @@ module Metanorma
         %w(indirect-dependency implements).each do |x|
           node.xpath(ns("./classification[tag][value]")).each do |c|
             c.at(ns("./tag")).text.casecmp(x).zero? or next
-            xref = recommendation_id(c.at(ns("./value")).children.to_xml) and
-              head << [@labels["modspec"][x.gsub(/-/, "")], xref]
+            xref = recommendation_id(to_xml(c.at(ns("./value")).children)) and
+              head << [@labels["modspec"][x.delete("-")], xref]
           end
         end
         head
@@ -145,9 +166,9 @@ module Metanorma
 
         d = node.at(ns("./component[@class = 'step']"))
         d = d.replace("<ol class='steps'><li#{id_attr(d)}>" \
-                      "#{d.children.to_xml}</li></ol>").first
+                      "#{to_xml(d.children)}</li></ol>").first
         node.xpath(ns("./component[@class = 'step']")).each do |f|
-          f = f.replace("<li#{id_attr(f)}>#{f.children.to_xml}</li>").first
+          f = f.replace("<li#{id_attr(f)}>#{to_xml(f.children)}</li>").first
           d << f
         end
         node
@@ -202,7 +223,7 @@ module Metanorma
         recommend_class(node.parent) == "recommend" and
           lbl = "statement"
         out << "<tr><th>#{@labels['modspec'][lbl]}</th>" \
-               "<td>#{node.children.to_xml}</td></tr>"
+               "<td>#{to_xml(node.children)}</td></tr>"
         out
       end
 
@@ -219,8 +240,8 @@ module Metanorma
         node.xpath(ns("./dt")).each do |dt|
           dd = dt.next_element
           dd&.name == "dd" or next
-          out.add_child("<tr><th>#{dt.children.to_xml}</th>" \
-                        "<td>#{dd.children.to_xml}</td></tr>")
+          out.add_child("<tr><th>#{to_xml(dt.children)}</th>" \
+                        "<td>#{to_xml(dd.children)}</td></tr>")
         end
         out
       end

data/lib/metanorma/modspec/reqt_label.rb

@@ -1,7 +1,11 @@
-class Nokogiri::XML::Document
-  def reqt_iter(&block)
-    xpath("//xmlns:requirement | //xmlns:recommendation | //xmlns:permission")
-      .each_with_object({}, &block)
+module Nokogiri
+  module XML
+    class Document
+      def reqt_iter(&block)
+        xpath("//xmlns:requirement | //xmlns:recommendation | //xmlns:permission")
+          .each_with_object({}, &block)
+      end
+    end
   end
 end
 
@@ -23,10 +27,11 @@ module Metanorma
       def recommendation_label_xref(elem, label, xrefs, type)
         id = @reqtlabels[label]
         number = xrefs.anchor(id, :modspec, false)
-        number.nil? and return type
+        number.nil? and return "<span class='fmt-element-name'>#{type}</span>"
         elem.ancestors("requirement, recommendation, permission").empty? and
           return number
-        "<xref target='#{id}'>#{number}</xref>"
+        #"<xref target='#{id}'>#{number}</xref>"
+        number
       end
 
       def init_lookups(doc)
@@ -54,17 +59,13 @@ module Metanorma
       end
 
       def recommendation_class_label(node)
+        node["class"] and return node["class"]
         case node["type"]
-        when "verification" then @labels["modspec"]["conformancetest"]
         when "class" then @labels["modspec"]["#{node.name}class"]
-        when "abstracttest" then @labels["modspec"]["abstracttest"]
-        when "conformanceclass" then @labels["modspec"]["conformanceclass"]
-        else
-          case node.name
-          when "recommendation" then @labels["default"]["recommendation"]
-          when "requirement" then @labels["default"]["requirement"]
-          when "permission" then @labels["default"]["permission"]
-          end
+        when "verification" then @labels["modspec"]["conformancetest"]
+        when "abstracttest", "conformanceclass"
+          @labels["modspec"][node["type"]]
+        else @labels["default"][node.name]
         end
       end
 
@@ -103,7 +104,8 @@ module Metanorma
 
       def recommendation_link_test(ident)
         test = @reqt_links_test[ident&.strip] or return nil
-        "<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
+        #"<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
+        test[:lbl]
       end
 
       # we have not implemented multiple levels of nesting of classes
@@ -155,12 +157,15 @@ module Metanorma
 
       def recommendation_link_class(ident)
         test = @reqt_links_class[ident&.strip] or return nil
-        "<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
+        #"<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
+        test[:lbl]
       end
 
       def recommendation_id(ident)
         test = @reqt_ids[ident&.strip] or return ident&.strip
-        "<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
+        #require "debug"; binding.b if test.include?("<xref")
+        #"<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
+        test[:lbl]
       end
 
       def recommendation_backlinks_test(node, id, ret)
@@ -185,7 +190,7 @@ module Metanorma
           .xpath(ns("//requirement//xref | //permission//xref | " \
                     "//recommendation//xref"))).each do |x|
           @reqt_id_base[x["target"]] or next # is a modspec requirement
-          x.children = x.children.to_xml.delete_prefix(@modspecidentifierbase)
+          x.children = to_xml(x.children).delete_prefix(@modspecidentifierbase)
         end
       end
 

data/lib/metanorma/modspec/table_cleanup.rb

@@ -46,7 +46,7 @@ module Metanorma
         hdr = th.text
         th.children = @i18n.inflect(hdr, number: "pl")
         td = th.next_element
-        res = [td.children.to_xml]
+        res = [to_xml(td.children)]
         res += gather_consec_table_rows(trow, hdr)
         td.children = res.join("<br/>")
       end
@@ -55,7 +55,7 @@ module Metanorma
         ret = []
         trow.xpath("./following-sibling::xmlns:tr").each do |r|
           r.at(ns("./th[text() = '#{hdr}']")) or break
-          ret << r.remove.at(ns("./td")).children.to_xml
+          ret << to_xml(r.remove.at(ns("./td")).children)
         end
         ret
       end
@@ -65,6 +65,8 @@ module Metanorma
           x = t.at(ns("./thead/tr")) or next
           x.at(ns("./th")).children =
             requirement_table_nested_cleanup_hdr(node)
+          f = x.at(ns("./td/fmt-name")) and
+            f.replace(f.children)
           t.parent.parent.replace(x)
         end
         table
@@ -78,7 +80,7 @@ module Metanorma
 
       def strip_id_base(elem, base)
         base.nil? and return elem.children
-        elem.children.to_xml.delete_prefix(base)
+        to_xml(elem.children).delete_prefix(base)
       end
 
       def truncate_id_base_in_reqt1(table, base)
@@ -94,7 +96,7 @@ module Metanorma
       # any xrefs not yet expanded out to rendering need to be expanded out,
       # so that the identifier instances they contain can be truncated
       def expand_xrefs_in_reqt(table)
-        table.xpath(ns(".//xref[not(@style)][normalize-space(text()) = '']"))
+        table.xpath(ns(".//xref[not(@style)][string-length() = 0]"))
           .each do |x|
           ref = @xrefs.anchor(x["target"], :xref, false) or next
           x << ref

data/lib/metanorma/requirements/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   class Requirements
-    VERSION = "0.4.0".freeze
+    VERSION = "0.4.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn-requirements
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc-i18n
@@ -226,6 +226,7 @@ files:
 - lib/isodoc-yaml/i18n-en.yaml
 - lib/isodoc-yaml/i18n-es.yaml
 - lib/isodoc-yaml/i18n-fr.yaml
+- lib/isodoc-yaml/i18n-ja.yaml
 - lib/isodoc-yaml/i18n-ru.yaml
 - lib/isodoc-yaml/i18n-zh-Hans.yaml
 - lib/isodoc/i18n.rb