mn-requirements 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c82855931f4c0fb8b033a7fcb15583826ef041cee6ff1c4630570abd42a074
-  data.tar.gz: c3765be67270e9fdad7d61b30654ce5a7ed5a7327d3b77598170354cd930c91a
+  metadata.gz: 4f81b57e8350c7018f06bb68420de8d7b409b7f9ff4b81eb0d98d06f484e246e
+  data.tar.gz: 771ba5edb39491ad133dfc2d8cacaba2e11a0eba8b95389a2d834ddd84d0227a
 SHA512:
-  metadata.gz: '098e5bd08fdb6628f7b493e5cbdde2ff793168008837f5b0184034ed79e202a31295d29ba8e5707aa56c2abfdee7bf31c8a7677ed7deb3f7fc2732e9f731cb6e'
-  data.tar.gz: ddcd729ae096912a304b1763092c135d5967f1a21d35f5f907dc16b408c75e8c64c3ba1864fd5941d08b36e77e6051e339353b6f19e92244e700f775c4dd5c21
+  metadata.gz: 38d500ecb762b731b2ef373c55c67b0cfef8e4a93bfcf4619d629c6fe69fae635c4362502bf3235a94f3b5cfbab7248fcd5e7110c42640916bd4e3b3b33e21dc
+  data.tar.gz: 8d5c5b770acd55b9b0006345f3c743e863239257c353626e4f56f0cb50dc218f9512338080e30bec75160e89b61bf85b747296ead049480812625799cc3fc74e

data/lib/metanorma/default/default.rb

@@ -95,7 +95,9 @@ module Metanorma
         end.join("\n")
       end
 
-      def validate(reqt, log); end
+      def validate(_reqt, _log)
+        []
+      end
     end
   end
 end

data/lib/metanorma/modspec/isodoc.rb

@@ -197,9 +197,9 @@ module Metanorma
       end
 
       def requirement_description_parse(node, out)
-        lbl = "statement"
-        recommend_class(node.parent) == "recommendclass" and
-          lbl = "description"
+        lbl = "description"
+        recommend_class(node.parent) == "recommend" and
+          lbl = "statement"
         out << "<tr><th>#{@labels['modspec'][lbl]}</th>" \
                "<td>#{node.children.to_xml}</td></tr>"
         out

data/lib/metanorma/modspec/reqt_label.rb

@@ -1,3 +1,10 @@
+class Nokogiri::XML::Document
+  def reqt_iter(&block)
+    xpath("//xmlns:requirement | //xmlns:recommendation | //xmlns:permission")
+      .each_with_object({}, &block)
+  end
+end
+
 module Metanorma
   class Requirements
     class Modspec < Default
@@ -36,10 +43,9 @@ module Metanorma
       end
 
       def reqtlabels(doc)
-        doc.xpath(ns("//requirement | //recommendation | //permission"))
-          .each_with_object({}) do |r, m|
-            l = r.at(ns("./identifier"))&.text and m[l] = r["id"]
-          end
+        doc.reqt_iter do |r, m|
+          l = r.at(ns("./identifier"))&.text and m[l] = r["id"]
+        end
       end
 
       # embedded reqts xref to reqts via label lookup
@@ -64,30 +70,23 @@ module Metanorma
       end
 
       def reqt_ids(docxml)
-        docxml.xpath(ns("//requirement | //recommendation | //permission"))
-          .each_with_object({}) do |r, m|
-            id = r.at(ns("./identifier")) or next
-            m[id.text] =
-              { id: r["id"], lbl: @xrefs.anchor(r["id"], :xref, false) }
-          end
+        docxml.reqt_iter do |r, m|
+          id = r.at(ns("./identifier")) or next
+          m[id.text] =
+            { id: r["id"], lbl: @xrefs.anchor(r["id"], :xref, false) }
+        end
       end
 
       def reqt_links_test(docxml)
-        docxml.xpath(ns("//requirement | //recommendation | //permission"))
-          .each_with_object({}) do |r, m|
-            reqt_links_test1(r, m)
-          end
+        docxml.reqt_iter { |r, m| reqt_links_test1(r, m) }
       end
 
       def reqt_links_test1(reqt, acc)
-        return unless %w(conformanceclass
-                         verification).include?(reqt["type"])
-
+        %w(conformanceclass verification).include?(reqt["type"]) or return
         subj = reqt_extract_target(reqt)
         id = reqt.at(ns("./identifier")) or return
         lbl = @xrefs.anchor(@reqt_ids[id.text.strip][:id], :xref, false)
-        return unless subj && lbl
-
+        (subj && lbl) or return
         acc[subj.text] = { lbl: lbl, id: reqt["id"] }
       end
 
@@ -110,23 +109,20 @@ module Metanorma
 
       # we have not implemented multiple levels of nesting of classes
       def reqt_links_class(docxml)
-        docxml.xpath(ns("//requirement | //recommendation | //permission"))
-          .each_with_object({}) do |r, m|
-            next unless %w(class conformanceclass).include?(r["type"])
-
-            id = r.at(ns("./identifier")) or next
-            r.xpath(ns("./requirement | ./recommendation | ./permission"))
-              .each do |r1|
-              m = reqt_links_class1(id, r, r1, m)
-            end
+        docxml.reqt_iter do |r, m|
+          %w(class conformanceclass).include?(r["type"]) or next
+          id = r.at(ns("./identifier")) or next
+          r.xpath(ns("./requirement | ./recommendation | ./permission"))
+            .each do |r1|
+            m = reqt_links_class1(id, r, r1, m)
           end
+        end
       end
 
       def reqt_links_class1(id, parent_reqt, reqt, acc)
         id1 = reqt.at(ns("./identifier")) or return acc
         lbl = @xrefs.anchor(@reqt_ids[id.text.strip][:id], :xref, false)
-        return acc unless lbl
-
+        lbl or return acc
         acc[id1.text] = { lbl: lbl, id: parent_reqt["id"] }
         acc
       end
@@ -139,10 +135,7 @@ module Metanorma
       end
 
       def reqt_id_base_init(docxml)
-        docxml.xpath(ns("//requirement | //recommendation | //permission"))
-          .each_with_object({}) do |r, m|
-            m[r["id"]] = reqt_extract_id_base(r)&.text
-          end
+        docxml.reqt_iter { |r, m| m[r["id"]] = reqt_extract_id_base(r)&.text }
       end
 
       def reqt_id_base_inherit(ret, class2reqt)

data/lib/metanorma/modspec/validate.rb

@@ -1,10 +1,15 @@
+require "tsort"
+
 module Metanorma
   class Requirements
     class Modspec < Default
       def validate(reqt, log)
+        @fatalerrors = []
         @log ||= log
         @ids ||= reqt_links(reqt.document)
+        reqt_cycles_validate
         reqt_link_validate(reqt)
+        @fatalerrors
       end
 
       def nested_reqt?(reqt)
@@ -109,17 +114,26 @@ module Metanorma
           .each_with_object({ id: {}, class: {}, label: {} }) do |r, m|
             next if nested_reqt?(r)
 
-            reqt_links1(r, m)
+            reqt_links1(r, m, type2validate(r), reqt_links_struct(r))
           end
       end
 
-      def reqt_links1(reqt, hash)
-        type = type2validate(reqt)
-        a = reqt_links_struct(reqt)
-        hash[:id][reqt["id"]] = a
+      def reqt_links1(reqt, hash, type, struct)
+        hash[:id][reqt["id"]] = struct
         hash[:class][type] ||= []
-        hash[:class][type] << a
-        hash[:label][a[:label]] = reqt["id"]
+        hash[:class][type] << struct
+        reqt_links1_label(reqt, hash, struct)
+      end
+
+      def reqt_links1_label(reqt, hash, struct)
+        return hash unless struct[:label]
+
+        if hash[:label][struct[:label]]
+          msg = "Modspec identifier #{struct[:label]} is used more than once"
+          @log.add("Requirements", reqt, msg)
+          @fatalerrors << msg
+        end
+        hash[:label][struct[:label]] = reqt["id"]
         hash
       end
 
@@ -140,6 +154,54 @@ module Metanorma
           indirect_dependency: classif_tag(reqt, "indirect-dependency"),
           implements: classif_tag(reqt, "implements") }
       end
+
+      def reqt_cycles_validate
+        @cycles_validated and return
+        @cycles_validated = true
+        %i(child dependency indirect_dependency implements).each do |x|
+          reqt_cycles_validate1(x)
+        end
+      end
+
+      def reqt_cycles_validate1(link)
+        arr = TSHash.new(@ids[:id].values)
+        arr.link = link
+        TSort.each_strongly_connected_component(
+          lambda { |&b| arr.tsort_each_node(&b) },
+          lambda { |n, &b| arr.tsort_each_child(n, &b) },
+        ) do |c|
+          c.size == 1 and next
+          log_cycle(link, c)
+        end
+      end
+
+      def log_cycle(link, path)
+        @log.add("Requirements", nil, <<~MSG
+          Cycle in Modspec linkages through #{link}: #{(path << path.first).join(' => ')}
+        MSG
+        )
+      end
+
+      class TSHash
+        include TSort
+        attr_accessor :link
+
+        def initialize(arr)
+          @hash = arr.each_with_object({}) do |v, m|
+            m[v[:label]] = v
+          end
+        end
+
+        def tsort_each_node(&block)
+          @hash.keys.each(&block)
+        end
+
+        def tsort_each_child(node, &block)
+          (@hash[node] || {})[@link]&.each(&block)
+        end
+      end
+
+      def reqt_cycles_validate_dependency; end
     end
   end
 end

data/lib/metanorma/requirements/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn-requirements
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc-i18n