mn-requirements 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11df2ccb8156fe400b893b0d2959de45af60e73d9d0b33cbfabcde20c7a04dc4
-  data.tar.gz: 3c4ab0473d0f09db76618311fb898797086d40efd490c964dfe8ac7e6fb441f0
+  metadata.gz: 18e898632371c762fb1fecbf11b5746233c0b0b35c04af5f41bf0b1ead898acf
+  data.tar.gz: 6174c4750e6293ed4fea72a013836dc3bc1d6170a76ff7be42f48c8dbfcc83fa
 SHA512:
-  metadata.gz: 27f1a2cd91706665d0e7152a47029a386337e1d4e81c0abb487b5b0eb7e86ed7a05b3333a525c7088229291565dbc83182bae994ba390624cb9ee22361956bfa
-  data.tar.gz: 9e00ccea27a1ca3e8268d39dc4424a73650a44364e85fa3e465e1aab74cb0ad73d4be5d68edce7229ba709bf5c8898dd5203866c90f30685df1f28d10cb1e4d5
+  metadata.gz: 37233d9b1276f585b410b32d43da5f34d8f44b70cdc82ec61f5248ce841247e2bdea820b7a1273545b71b62c72250d9fee2d3bff8eb93c582d3c9424f814643f
+  data.tar.gz: 4bd622188beef29a71f8d8071ebf8a28a94d087475b5ff46ae3c01c396f008ad9b4cba501160a6cdaf69b42d6b0bcd04fc54130dcbfcb43f492a5d67b4a9af9b

data/lib/metanorma/modspec/log.rb

@@ -0,0 +1,22 @@
+module Metanorma
+  class Requirements
+    class Modspec
+      MODSPEC_LOG_MESSAGES = {
+        # rubocop:disable Naming/VariableNumber
+        "MODSPEC_1": { category: "Requirements",
+                       error: "Requirements linkage: %s %s has no corresponding %s",
+                       severity: 2 },
+        "MODSPEC_2": { category: "Requirements",
+                       error: "Requirements linkage: %s %s points to %s %s outside this document",
+                       severity: 2 },
+        "MODSPEC_3": { category: "Requirements",
+                       error: "Modspec identifier %s is used more than once",
+                       severity: 0 },
+        "MODSPEC_4": { category: "Requirements",
+                       error: "Cycle in Modspec linkages through %s: %s",
+                       severity: 2 },
+      }.freeze
+      # rubocop:enable Naming/VariableNumber
+    end
+  end
+end

data/lib/metanorma/modspec/validate.rb

@@ -1,10 +1,12 @@
 require "tsort"
+require_relative "log"
 
 module Metanorma
   class Requirements
     class Modspec < Default
       def validate(reqt, log)
         @log ||= log
+        @log&.add_msg(MODSPEC_LOG_MESSAGES)
         @ids ||= reqt_links(reqt.document)
         reqt_cycles_validate
         reqt_link_validate(reqt)
@@ -47,17 +49,13 @@ module Metanorma
       }.freeze
 
       def log_reqt(reqt, leftclass, rightclass)
-        @log.add("Requirements", reqt[:elem], <<~MSG
-          #{CLASS2LABEL[leftclass.to_sym]} #{reqt[:label] || reqt[:id]} has no corresponding #{CLASS2LABEL[rightclass.to_sym]}
-        MSG
-        )
+        @log.add("MODSPEC_1", reqt[:elem],
+                 params: [CLASS2LABEL[leftclass.to_sym], reqt[:label] || reqt[:id], CLASS2LABEL[rightclass.to_sym]])
       end
 
       def log_reqt2(reqt, leftclass, target, rightclass)
-        @log.add("Requirements", reqt[:elem], <<~MSG
-          #{CLASS2LABEL[leftclass]} #{reqt[:label] || reqt[:id]} points to #{CLASS2LABEL[rightclass]} #{target} outside this document
-        MSG
-        )
+        @log.add("MODSPEC_2", reqt[:elem],
+                 params: [CLASS2LABEL[leftclass], reqt[:label] || reqt[:id], CLASS2LABEL[rightclass], target])
       end
 
       def reqt_to_dependency(reqt)
@@ -71,10 +69,11 @@ module Metanorma
 
       def reqt_to_conformance(reqt, reqtclass, confclass)
         return unless type2validate(reqt) == reqtclass
+
         r = @ids[:id][reqt["id"]]
-        (r[:label] && @ids[:class][confclass]&.any? do |x|
-           x[:subject].include?(r[:label])
-         end) and return
+        r[:label] && @ids[:class][confclass]&.any? do |x|
+          x[:subject].include?(r[:label])
+        end and return
         log_reqt(r, reqtclass, confclass)
       end
 
@@ -82,9 +81,9 @@ module Metanorma
         return unless type2validate(reqt) == confclass
 
         r = @ids[:id][reqt["id"]]
-        (r[:subject] && @ids[:class][reqtclass]&.any? do |x|
-           r[:subject].include?(x[:label])
-         end) and return
+        r[:subject] && @ids[:class][reqtclass]&.any? do |x|
+          r[:subject].include?(x[:label])
+        end and return
         log_reqt(r, confclass, reqtclass)
       end
 
@@ -97,12 +96,11 @@ module Metanorma
       end
 
       def children_to_class(reqt, childclass, parentclass)
-        return unless type2validate(reqt) == childclass
-
+        type2validate(reqt) == childclass or return
         r = @ids[:id][reqt["id"]]
-        (r[:label] && @ids[:class][parentclass]&.any? do |x|
-           x[:child].include?(r[:label])
-         end) and return
+        r[:label] && @ids[:class][parentclass]&.any? do |x|
+          x[:child].include?(r[:label])
+        end and return
         log_reqt(r, childclass, parentclass)
       end
 
@@ -123,11 +121,9 @@ module Metanorma
       end
 
       def reqt_links1_label(reqt, hash, struct)
-        return hash unless struct[:label]
-
+        struct[:label] or return hash
         if hash[:label][struct[:label]]
-          msg = "Modspec identifier #{struct[:label]} is used more than once"
-          @log.add("Requirements", reqt, msg, severity: 0)
+          @log.add("MODSPEC_3", reqt, params: [struct[:label]])
         end
         hash[:label][struct[:label]] = reqt["id"]
         hash
@@ -160,22 +156,21 @@ module Metanorma
       end
 
       def reqt_cycles_validate1(link)
-        arr = TSHash.new(@ids[:id].values)
-        arr.link = link
+        arr = reqt_cycles_validate1_prep(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)
+        ) do |path|
+          path.size == 1 and next
+          @log.add("MODSPEC_4", nil,
+                   params: [link, (path << path.first).join(" => ")])
         end
       end
 
-      def log_cycle(link, path)
-        @log.add("Requirements", nil, <<~MSG
-          Cycle in Modspec linkages through #{link}: #{(path << path.first).join(' => ')}
-        MSG
-        )
+      def reqt_cycles_validate1_prep(link)
+        arr = TSHash.new(@ids[:id].values)
+        arr.link = link
+        arr
       end
 
       class TSHash

data/lib/metanorma/requirements/version.rb

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

data/mn-requirements.gemspec

@@ -26,9 +26,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   # precise version is on relaton-render
-  spec.add_dependency "isodoc-i18n", ">= 1.1.0"
-  spec.add_dependency "metanorma-utils", ">= 0.10.0"
-  spec.add_dependency "relaton-render", ">= 0.9.0"
+  spec.add_dependency "isodoc-i18n", ">= 1.2.0"
+  spec.add_dependency "metanorma-utils", ">= 2.0.0"
+  spec.add_dependency "relaton-render", ">= 1.0.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
@@ -42,5 +42,5 @@ spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "sassc-embedded", "~> 1"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "canon"
+  spec.add_development_dependency "canon", "= 0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn-requirements
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc-i18n
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: metanorma-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: relaton-render
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -224,16 +224,16 @@ dependencies:
   name: canon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
 description: 'Requirements processing and rendering according to different models
 
   '
@@ -265,6 +265,7 @@ files:
 - lib/metanorma/default/xrefs.rb
 - lib/metanorma/modspec/cleanup.rb
 - lib/metanorma/modspec/isodoc.rb
+- lib/metanorma/modspec/log.rb
 - lib/metanorma/modspec/modspec.rb
 - lib/metanorma/modspec/reqt_label.rb
 - lib/metanorma/modspec/table_cleanup.rb