mn-requirements 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc32c6334d63f4745d279e84ea08305400eccc4f020ac410b85488e47e3c6ce
-  data.tar.gz: 57e1f8b559a619d6d01a18520d15f3de7787d0eb7fed17add4c120bc58b0d862
+  metadata.gz: ed29bf407c16d8890bb04abf9028498f568a8d42cb2d232aab1f2312ccd045c3
+  data.tar.gz: 7cb6924aa3b79542533047703be36e769b4e69b299c052868232ed81764b45c0
 SHA512:
-  metadata.gz: 817a441beba95552171c674b07c7d447808496a642c90181baf039723b7fcdef1dbb5ee23ecac9e167ffea9d09871af3bfa48dec7c40c7cc46b4fe48559e1286
-  data.tar.gz: '09ee6db13e6fc2eb7e99ec2fbeb281a6ce3a9aed08e8d41b865a1acd458c2ec9fa642325bfff50de1ec8689ba9f8e8a74f914e0c5e3759670ee85c183f787ec1'
+  metadata.gz: bb1c844f85032d0fac0c678259ca2983debbbe55f7cbf308d155aac2f7f8169142ec2f838a57c0329dd6f9aa1d007e4040c7e3cf0bdf33205b41b6cdc737e40b
+  data.tar.gz: 49b72dcb20a45e87f82fa0b64bdc7db99374f2cf2c1c0bb031543cef803306e17e240b015c9a6a120a9714d5f8064dc4d18d72adad71d27e4864f91d24f88778

data/lib/metanorma/modspec/cleanup.rb

@@ -21,7 +21,7 @@ module Metanorma
 
       def requirement_metadata_component_tags
         %w(test-purpose test-method test-method-type conditions part description
-           reference step guidance) +
+           statement reference step guidance) +
           requirement_metadata_requirement_tags
       end
 
@@ -35,6 +35,7 @@ module Metanorma
         ins1 = super
         dlist.xpath("./dt").each do |e|
           tag = e.text&.gsub(/ /, "-")&.downcase
+          tag = "description" if tag == "statement"
           next unless requirement_metadata_component_tags.include?(tag)
 
           ins1.next = requirement_metadata1_component(e, tag)
@@ -75,7 +76,7 @@ module Metanorma
 
       def requirement_target_identifiers(reqt)
         reqt.xpath("./classification[tag][value/link]").each do |c|
-          %w(target indirect-dependency implements)
+          %w(target indirect-dependency implements identifier-base)
             .include?(c.at("./tag").text.downcase) or next
           v = c.at("./value[link]")
           v.children = v.at("./link/@target").text
@@ -83,7 +84,7 @@ module Metanorma
       end
 
       def requirement_metadata_to_component(reqt)
-        xpath = requirement_metadata_component_tags - %w(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
@@ -119,6 +120,40 @@ module Metanorma
           c.children = "<p>#{c.children.to_xml}</p>"
         end
       end
+
+      def add_misc_container(xmldoc)
+        unless ins = xmldoc.at("//misc-container")
+          a = xmldoc.at("//termdocsource") || xmldoc.at("//bibdata")
+          a.next = "<misc-container/>"
+          ins = xmldoc.at("//misc-container")
+        end
+        ins
+      end
+
+      def add_misccontainer_anchor_aliases(xmldoc)
+        m = add_misc_container(xmldoc)
+        x = ".//table[@id = '_misccontainer_anchor_aliases']/tbody"
+        unless ins = m.at(x)
+          m << "<table id = '_misccontainer_anchor_aliases'><tbody/></table>"
+          ins = m.at(x)
+        end
+        ins
+      end
+
+      def requirement_anchor_aliases(reqt)
+        x = reqt.xpath("./identifier")
+        x.empty? and return
+        table = add_misccontainer_anchor_aliases(reqt.document)
+        ids = x.each_with_object([]) do |i, m|
+          m << "<td>#{i.text}</td>"
+        end
+        table << "<tr><th>#{reqt['id']}</th>#{ids.join}</tr>"
+      end
+
+      def requirement_identifier_cleanup(reqt)
+        super
+        requirement_anchor_aliases(reqt)
+      end
     end
   end
 end

data/lib/metanorma/modspec/isodoc.rb

@@ -69,8 +69,11 @@ module Metanorma
 
       def recommend_title(node, out)
         label = node.at(ns("./identifier")) or return
-        out.add_child("<tr><th>#{@labels['modspec']['identifier']}</th>" \
-                      "<td><tt>#{label.children.to_xml}</tt></td>")
+        ret = <<~OUTPUT
+          <tr><th>#{@labels['modspec']['identifier']}</th>
+          <td><tt><modspec-ident>#{label.children.to_xml}</modspec-ident></tt></td>
+        OUTPUT
+        out.add_child(ret)
       end
 
       def recommendation_attributes1(node)
@@ -162,7 +165,7 @@ module Metanorma
       def recommendation_attr_keyvalue(node, key, value)
         tag = node.at(ns("./#{key}")) or return nil
         value = node.at(ns("./#{value}")) or return nil
-        !%w(target indirect-dependency
+        !%w(target indirect-dependency identifier-base
             implements).include?(tag.text.downcase) or
           return nil
         [Metanorma::Utils.strict_capitalize_first(tag.text), value.children]
@@ -194,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/modspec.rb

@@ -5,6 +5,10 @@ require_relative "isodoc"
 module Metanorma
   class Requirements
     class Modspec < Default
+      def initialize(options)
+        super
+        @modspecidentifierbase = @parent.modspecidentifierbase
+      end
     end
   end
 end

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
@@ -31,13 +38,14 @@ module Metanorma
         @reqt_ids = reqt_ids(doc)
         @reqt_links_class = reqt_links_class(doc)
         @reqt_links_test = reqt_links_test(doc)
+        @reqt_id_base = reqt_id_base(doc)
+        truncate_id_base_outside_reqts(doc)
       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
@@ -62,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
 
@@ -95,26 +96,62 @@ module Metanorma
         end&.at(ns("./value"))
       end
 
+      def reqt_extract_id_base(reqt)
+        reqt.xpath(ns("./classification[tag][value]")).detect do |x|
+          x.at(ns("./tag")).text.casecmp("identifier-base").zero?
+        end&.at(ns("./value"))
+      end
+
       def recommendation_link_test(ident)
         test = @reqt_links_test[ident&.strip] or return nil
         "<xref target='#{test[:id]}'>#{test[:lbl]}</xref>"
       end
 
+      # 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|
-              id1 = r1.at(ns("./identifier")) or next
-              lbl = @xrefs.anchor(@reqt_ids[id.text.strip][:id], :xref, false)
-              next unless lbl
-
-              m[id1.text] = { lbl: lbl, id: r["id"] }
-            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)
+        lbl or return acc
+        acc[id1.text] = { lbl: lbl, id: parent_reqt["id"] }
+        acc
+      end
+
+      def reqt_hierarchy_extract
+        @reqt_links_class.each_with_object({}) do |(k, v), m|
+          m[v[:id]] ||= []
+          m[v[:id]] << @reqt_ids[k][:id]
+        end
+      end
+
+      def reqt_id_base_init(docxml)
+        docxml.reqt_iter { |r, m| m[r["id"]] = reqt_extract_id_base(r)&.text }
+      end
+
+      def reqt_id_base_inherit(ret, class2reqt)
+        ret.each_key do |k|
+          class2reqt[k]&.each do |k1|
+            ret[k1] ||= ret[k]
+          end
+        end
+        ret
+      end
+
+      def reqt_id_base(docxml)
+        ret = reqt_id_base_init(docxml)
+        ret = reqt_id_base_inherit(ret, reqt_hierarchy_extract)
+        @modspecidentifierbase or return ret
+        ret.each_key { |k| ret[k] ||= @modspecidentifierbase }
       end
 
       def recommendation_link_class(ident)
@@ -143,6 +180,17 @@ module Metanorma
         ret
       end
 
+      def truncate_id_base_outside_reqts(docxml)
+        @modspecidentifierbase or return
+
+        (docxml.xpath(ns("//xref[@style = 'id']")) - docxml
+          .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)
+        end
+      end
+
       def rec_subj(node)
         case node["type"]
         when "class" then @labels["modspec"]["targettype"]

data/lib/metanorma/modspec/table_cleanup.rb

@@ -4,6 +4,8 @@ module Metanorma
       def requirement_table_cleanup(node, table)
         table = requirement_table_nested_cleanup(node, table)
         requirement_table_consec_rows_cleanup(node, table)
+        node.ancestors("requirement, recommendation, permission").empty? and
+          truncate_id_base_in_reqt(table)
         table
       end
 
@@ -57,6 +59,37 @@ module Metanorma
         node["type"] == "conformanceclass" and label = "conformancetest"
         @i18n.get["requirements"]["modspec"][label]
       end
+
+      def strip_id_base(elem, base)
+        return elem.children if base.nil?
+
+        elem.children.to_xml.delete_prefix(base)
+      end
+
+      def truncate_id_base_in_reqt1(table, base)
+        table.xpath(ns(".//xref[@style = 'id']")).each do |x|
+          @reqt_id_base[x["target"]] or next # is a modspec requirement
+          x.children = strip_id_base(x, base)
+        end
+        table.xpath(ns(".//modspec-ident")).each do |x|
+          x.replace(strip_id_base(x, base))
+        end
+      end
+
+      # 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()) = '']"))
+          .each do |x|
+          x << @xrefs.anchor(x["target"], :xref, false)
+        end
+      end
+
+      def truncate_id_base_in_reqt(table)
+        base = @reqt_id_base[table["id"]]
+        expand_xrefs_in_reqt(table)
+        truncate_id_base_in_reqt1(table, base)
+      end
     end
   end
 end

data/lib/metanorma/modspec/validate.rb

@@ -1,9 +1,12 @@
+require "tsort"
+
 module Metanorma
   class Requirements
     class Modspec < Default
       def validate(reqt, log)
         @log ||= log
         @ids ||= reqt_links(reqt.document)
+        reqt_cycles_validate
         reqt_link_validate(reqt)
       end
 
@@ -140,6 +143,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/modspec/xrefs.rb

@@ -73,7 +73,8 @@ module Metanorma
         super
         anchor[:xref_bare] = anchor[:xref]
         if l = block.at(ns("./identifier"))&.text
-          anchor[:xref] += l10n(": ") + "<tt>#{l}</tt>"
+          anchor[:xref] += l10n(": ") +
+            "<tt><xref style='id' target='#{block['id']}'>#{l}</xref></tt>"
         end
         anchor
       end

data/lib/metanorma/requirements/selector.rb

@@ -5,7 +5,7 @@ require "metanorma-utils"
 
 module Metanorma
   class Requirements
-    attr_accessor :i18n, :labels
+    attr_accessor :i18n, :labels, :modspecidentifierbase
 
     Hash.include Metanorma::Utils::Hash
 
@@ -17,6 +17,7 @@ module Metanorma
                          options[:labels])
       # @labels = @i18n.get.deep_merge(options[:labels] || {})["requirements"]
       @labels = @i18n.get["requirements"]
+      @modspecidentifierbase = options[:modspecidentifierbase]
       @models =
         model_names.each_with_object({}) { |k, m| m[k] = create(k) }
     end

data/lib/metanorma/requirements/version.rb

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

data/mn-requirements.gemspec

@@ -17,12 +17,13 @@ Gem::Specification.new do |spec|
   spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|bin|.github)/}) \
+    || f.match(%r{Rakefile|bin/rspec})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "isodoc-i18n", "~> 1.1.2"
   spec.add_dependency "metanorma-utils", "~> 1.4.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn-requirements
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isodoc-i18n
@@ -201,18 +201,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/rake.yml"
-- ".github/workflows/release.yml"
 - ".hound.yml"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.adoc
-- Rakefile
-- bin/console
-- bin/rspec
-- bin/setup
 - lib/isodoc-yaml/i18n-ar.yaml
 - lib/isodoc-yaml/i18n-de.yaml
 - lib/isodoc-yaml/i18n-en.yaml
@@ -249,14 +243,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Requirements processing and rendering according to different models

data/.github/workflows/rake.yml

@@ -1,15 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: rake
-
-on:
-  push:
-    branches: [ master, main ]
-    tags: [ v* ]
-  pull_request:
-
-jobs:
-  rake:
-    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
-    secrets:
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -1,27 +0,0 @@
-# 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 }}
-      release_command: rake release
-      bundler_cache: false
-      post_install: gem install bundler rake rspec
-    secrets:
-      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
-

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "metanorma/ogc"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/rspec

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
-  "../../Gemfile", Pathname.new(__FILE__).realpath
-)
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here