mn-requirements 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c327aaa54455f58c577358ea68b452942aacad9ea3f2040d112c51514a7598
-  data.tar.gz: ebb500af5264c2cdc45f378f4ffe66fef574e699e49c23a5b30b5a1a7fc7221e
+  metadata.gz: f30b7b9d9468a1d20886f1d84d6992071a95a2376a5f066bd9b455571e7e425d
+  data.tar.gz: 2888d62224f0110f4a23980042c34490f7f32889146304c56847f0d3b2d18ddc
 SHA512:
-  metadata.gz: 384444b896b5d29b91f7412ee1fae853f52f833bce68fc5df047ae96921632f0c2984827726767324706279bb93d654cec485f64dc90c2fa5cd73f9da38dc05f
-  data.tar.gz: 595eb3cafc35d0b30011edcfb905e2ba6ea23235662062d3507c22e949eb733f3beb04b2b8fff30fc4f5361bef7e837405e7678257f8861b058469b62a9caf39
+  metadata.gz: 289876376e7c00e2c120fb64f1c4be5ab19dba91db83036c6be974eadf8f6f0d291e6316219fad482f0d5df04dee9362afb15e6844ec84ae3029bbf1860242ff
+  data.tar.gz: a868912d83376103770d8602b56fa0643da967a2833e9d9df59fe72f6469d1c6901edb0ef879c78cd5eaa8577f1e6d053269a7ef8eec5c2d5d1fae604c03aab0

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

@@ -25,3 +25,4 @@ requirements:
     identifier: المعرف
     included_in: مدرج في
     statement: بيان
+    guidance: إرشاد

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

@@ -25,3 +25,5 @@ requirements:
     identifier: Kennung
     included_in: Enthalten in
     statement: Aussage
+    guidance: Anleitung
+

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

@@ -25,3 +25,5 @@ requirements:
     identifier: Identifier
     included_in: Included in
     statement: Statement
+    guidance: Guidance
+

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

@@ -25,3 +25,4 @@ requirements:
     identifier: Identificador
     included_in: Incluido en
     statement: Declaración
+    guidance: Orientación

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

@@ -25,3 +25,5 @@ requirements:
     identifier: Identifiant
     included_in: Inclus dans
     statement: Déclaration
+    guidance: Avis
+

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

@@ -25,3 +25,5 @@ requirements:
     identifier: Идентификатор
     included_in: Входит в
     statement: Утверждение
+    guidance: Руководство
+

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -25,3 +25,5 @@ requirements:
     identifier: 标识符
     included_in: 包含在
     statement: 陈述
+    guidance: 指导意见
+

data/lib/metanorma/modspec/cleanup.rb

@@ -15,7 +15,7 @@ module Metanorma
 
       def requirement_metadata_component_tags
         %w(test-purpose test-method test-method-type conditions part description
-           reference step requirement permission recommendation)
+           reference step requirement permission recommendation guidance)
       end
 
       def requirement_metadata1(reqt, dlist, ins)
@@ -59,9 +59,9 @@ module Metanorma
       end
 
       def requirement_metadata_to_component(reqt)
-        reqt.xpath(".//test-method | .//test-purpose | .//conditions | "\
-                   ".//part | .//test-method-type | .//step | .//reference")
-          .each do |c|
+        xpath = requirement_metadata_component_tags -
+          %w(description requirement permission recommendation)
+        reqt.xpath(xpath.map { |x| ".//#{x}" }.join(" | ")).each do |c|
           c["class"] = c.name
           c.name = "component"
         end

data/lib/metanorma/modspec/isodoc.rb

@@ -6,7 +6,8 @@ module Metanorma
     class Modspec < Default
       def requirement_render1(node)
         init_lookups(node.document)
-        requirement_table_cleanup(super)
+        ret = requirement_guidance_parse(node, super)
+        requirement_table_cleanup(ret)
       end
 
       def recommendation_base(node, _klass)
@@ -86,9 +87,8 @@ module Metanorma
         subj = node.at(ns("./subject"))&.children and
           head << [rec_subj(node), subj]
         node.xpath(ns("./classification[tag = 'target']/value")).each do |v|
-          xref = recommendation_id(v.text) and head << [
-            rec_target(node), xref
-          ]
+          xref = recommendation_id(v.text) and
+            head << [rec_target(node), xref]
         end
         head += recommendation_backlinks(node)
         recommendation_attributes1_dependencies(node, head)
@@ -121,35 +121,37 @@ module Metanorma
         head
       end
 
+      def id_attr(node)
+        node["id"] ? " id='#{node['id']}'" : ""
+      end
+
       def recommendation_steps(node)
         node.elements.each { |e| recommendation_steps(e) }
         return node unless node.at(ns("./component[@class = 'step']"))
 
         d = node.at(ns("./component[@class = 'step']"))
-        id = d["id"] ? " id='#{d['id']}'" : ""
-        d = d.replace("<ol class='steps'><li#{id}>#{d.children.to_xml}</li></ol>")
-          .first
+        d = d.replace("<ol class='steps'><li#{id_attr(d)}>"\
+                      "#{d.children.to_xml}</li></ol>").first
         node.xpath(ns("./component[@class = 'step']")).each do |f|
-          id = f["id"] ? " id='#{f['id']}'" : ""
-          f = f.replace("<li#{id}>#{f.children.to_xml}</li>").first
+          f = f.replace("<li#{id_attr(f)}>#{f.children.to_xml}</li>").first
           d << f
         end
         node
       end
 
       def recommendation_attributes1_component(node, out)
+        return out if node["class"] == "guidance"
+
         node = recommendation_steps(node)
-        id = node["id"] ? " id='#{node['id']}'" : ""
-        out << "<tr#{id}><td>#{node['label']}</td><td>#{node.children}</td></tr>"
+        out << "<tr#{id_attr(node)}><td>#{node['label']}</td>"\
+               "<td>#{node.children}</td></tr>"
         out
       end
 
       def recommendation_attr_keyvalue(node, key, value)
-        tag = node.at(ns("./#{key}"))
-        value = node.at(ns("./#{value}"))
-        (tag && value && !%w(target
-                             indirect-dependency).include?(tag.text)) or
-          return nil
+        tag = node.at(ns("./#{key}")) or return nil
+        value = node.at(ns("./#{value}")) or return nil
+        !%w(target indirect-dependency).include?(tag.text) or return nil
         [tag.text.capitalize, value.children]
       end
 
@@ -165,19 +167,26 @@ module Metanorma
       end
 
       def requirement_component_parse(node, out)
-        return out if node["exclude"] == "true"
-
+        node["exclude"] == "true" and return out
         node.elements.size == 1 && node.first_element_child.name == "dl" and
           return reqt_dl(node.first_element_child, out)
         node.name == "component" and
           return recommendation_attributes1_component(node, out)
-        id = node["id"] ? " id='#{node['id']}'" : ""
-        out.add_child("<tr#{id}><td colspan='2'></td></tr>").first
+        out.add_child("<tr#{id_attr(node)}><td colspan='2'></td></tr>").first
           .at(ns(".//td")) <<
           (preserve_in_nested_table?(node) ? node : node.children)
         out
       end
 
+      def requirement_guidance_parse(node, out)
+        ins = out.at(ns("./tbody"))
+        node.xpath(ns("./component[@class = 'guidance']")).each do |f|
+          ins << "<tr#{id_attr(f)}><td>#{@labels['modspec']['guidance']}</td>"\
+                 "<td>#{f.children}</td></tr>"
+        end
+        out
+      end
+
       def reqt_dl(node, out)
         node.xpath(ns("./dt")).each do |dt|
           dd = dt.next_element
@@ -189,8 +198,6 @@ module Metanorma
       end
 
       def requirement_table_cleanup(table)
-        return table unless table["type"] == "recommendclass"
-
         table.xpath(ns("./tbody/tr/td/table")).each do |t|
           x = t.at(ns("./thead/tr")) or next
           t.parent.parent.replace(x)

data/lib/metanorma/modspec/reqt_label.rb

@@ -7,14 +7,14 @@ module Metanorma
 
         label = elem.at(ns("./identifier"))&.text
         if inject_crossreference_reqt?(elem, label)
-          recommendation_label_xref(elem, label, xrefs)
+          recommendation_label_xref(elem, label, xrefs, type)
         else
           type = recommendation_class_label(elem)
           super
         end
       end
 
-      def recommendation_label_xref(elem, label, xrefs)
+      def recommendation_label_xref(elem, label, xrefs, type)
         id = @reqtlabels[label]
         number = xrefs.anchor(id, :xref, false)
         number.nil? and return type

data/lib/metanorma/requirements/version.rb

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

data/mn-requirements.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "metanorma-standoc"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1.5.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn-requirements
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc-i18n
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: metanorma-standoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement