mn-requirements 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8561bbfa3412485e724742474078348fffb06c9687bcf2cb18d815027ab5df2
+  data.tar.gz: e9d8755e0ba593ca3e308e579bb0abea161ccd0bac385d4e8ef58f946b083c6a
+SHA512:
+  metadata.gz: f8a0464554be764a948a3aa9a2531dbb0959e867d28c51d5ba9e25febd1e27260d810eae70a15001bedf95bddb386c6d59c0693a2eb8e73c16018ce4bb5c93ca
+  data.tar.gz: 16afa9642145d263f50ee5e7cd62d9f27ac6ff852250785195ad32d06e6498ca865164b37637fe75ac7069656f5c6d50cf529bcf36ac14af918e06f8ed965c2e

data/.github/workflows/rake.yml

@@ -0,0 +1,15 @@
+# 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/metanorma-build-scripts/.github/workflows/graphviz-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# 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/metanorma-build-scripts/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+      event_name: ${{ github.event_name }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,13 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/MethodLength:
+  CountAsOne: ['array', 'heredoc']

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}" }
+
+gemspec
+
+if File.exist? "Gemfile.devel"
+  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
+end
+

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2022, Metanorma
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,26 @@
+= mn-requirements: Requirements processing and rendering according to different models
+
+image:https://img.shields.io/gem/v/mn-requirements.svg["Gem Version", link="https://rubygems.org/gems/mn-requirements"]
+image:https://github.com/metanorma/mn-requirements/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/mn-requirements/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/mn-requirements/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/mn-requirements"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/mn-requirements.svg["Pull Requests", link="https://github.com/metanorma/mn-requirements/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/mn-requirements/latest.svg["Commits since latest",link="https://github.com/metanorma/mn-requirements/releases"]
+
+== Functionality
+
+This gem supports the processing of Requirements models and their rendering in the https://metanorma.org[Metanorma]
+toolset, allowing various models to be processed. The gem currently supports:
+
+`metanorma`:: Default Metanorma Requiremnts model
+`ogc`:: OGC Modspec
+
+== Usage
+
+Within Metanorma, a requirement is specified as being of a particular type; e.g.
+
+[source,asciidoc]
+----
+[requirement,type=ogc]
+...
+...
+----

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,17 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/lib/metanorma/default/cleanup.rb

@@ -0,0 +1,146 @@
+module Metanorma
+  class Requirements
+    class Default
+      def requirement_type_cleanup(reqt); end
+
+      def requirement_identifier_cleanup(reqt)
+        reqt.xpath("./identifier[link] | ./inherit[link]").each do |i|
+          i.children = i.at("./link/@target").text
+        end
+      end
+
+      def requirement_inherit_cleanup(reqt)
+        ins = requirement_inherit_insert(reqt)
+        reqt.xpath("./*//inherit").each { |i| ins.previous = i }
+      end
+
+      def requirement_inherit_insert(reqt)
+        ins = reqt.at("./classification") || reqt.at(
+          "./description | ./measurementtarget | ./specification | "\
+          "./verification | ./import | ./description | ./component | "\
+          "./requirement | ./recommendation | ./permission",
+        ) and return ins
+        requirement_inherit_insert1(reqt)
+      end
+
+      def requirement_inherit_insert1(reqt)
+        if t = reqt.at("./title")
+          t.next = " "
+          t.next
+        else
+          if reqt.children.empty? then reqt.add_child(" ")
+          else reqt.children.first.previous = " "
+          end
+          reqt.children.first
+        end
+      end
+
+      def requirement_descriptions_cleanup(reqt)
+        reqt.xpath(".//p[not(./*)][normalize-space(.)='']").each(&:remove)
+        reqt.children.each do |e|
+          requirement_description_wrap(reqt, e)
+        end
+        requirement_description_cleanup1(reqt)
+      end
+
+      REQS = %w(recommendation requirement permission).freeze
+
+      def requirement_description_wrap(reqt, text)
+        return if (text.element? && (reqt_subpart?(text.name) ||
+                REQS.include?(text.name))) ||
+          (text.text.strip.empty? && !text.at(".//xref | .//eref | .//link"))
+
+        t = Nokogiri::XML::Element.new("description", reqt.document)
+        text.before(t)
+        t.children = text.remove
+      end
+
+      def requirement_description_cleanup1(reqt)
+        while d = reqt.at("./description[following-sibling::*[1]"\
+                          "[self::description]]")
+          n = d.next.remove
+          d << n.children
+        end
+        reqt.xpath("./description[normalize-space(.)='']").each do |r|
+          r.replace("\n")
+        end
+      end
+
+      def requirement_metadata_cleanup(reqt)
+        dl = reqt.at("./dl[@metadata = 'true']")&.remove or return
+        requirement_metadata1(reqt, dl, reqt.at("./title"))
+      end
+
+      def requirement_metadata1_attrs
+        %w(obligation model type)
+      end
+
+      def requirement_metadata1_tags
+        %w(identifier subject inherit)
+      end
+
+      def requirement_metadata_component_tags
+        []
+      end
+
+      def dl_to_attrs(elem, dlist, name)
+        Metanorma::Utils::dl_to_attrs(elem, dlist, name)
+      end
+
+      def dl_to_elems(ins, elem, dlist, name)
+        Metanorma::Utils::dl_to_elems(ins, elem, dlist, name)
+      end
+
+      def requirement_metadata1(reqt, dlist, ins)
+        ins = requirement_metadata1_set_insert(reqt, ins)
+        requirement_metadata1_attrs.each do |a|
+          dl_to_attrs(reqt, dlist, a)
+        end
+        requirement_metadata1_tags.each do |a|
+          ins = dl_to_elems(ins, reqt, dlist, a)
+        end
+        ins = reqt_dl_to_classif(ins, reqt, dlist)
+        reqt_dl_to_classif1(ins, reqt, dlist)
+      end
+
+      def requirement_metadata1_set_insert(reqt, ins)
+        return ins if ins
+
+        reqt.children.first.previous = " "
+        reqt.children.first
+      end
+
+      def reqt_dl_to_classif(ins, reqt, dlist)
+        if a = reqt.at("./classification[last()]") then ins = a end
+        dlist.xpath("./dt[text()='classification']").each do |e|
+          val = e.at("./following::dd/p") || e.at("./following::dd")
+          req_classif_parse(val.children.to_xml).each do |r|
+            ins.next = "<classification><tag>#{r[0]}</tag>"\
+                       "<value>#{r[1]}</value></classification>"
+            ins = ins.next
+          end
+        end
+        ins
+      end
+
+      def reqt_dl_to_classif1(ins, reqt, dlist)
+        if a = reqt.at("./classification[last()]") then ins = a end
+        dlist.xpath("./dt").each do |e|
+          next if (requirement_metadata1_attrs + requirement_metadata1_tags +
+                   requirement_metadata_component_tags + %w(classification))
+            .include?(e.text)
+
+          ins = reqt_dl_to_classif2(e, ins)
+        end
+        ins
+      end
+
+      def reqt_dl_to_classif2(term, ins)
+        val = term.at("./following::dd/p") || e.at("./following::dd")
+        ins.next = "<classification><tag>#{term.text}</tag>"\
+                   "<value>#{val.children.to_xml}</value></classification>"
+        ins.next
+      end
+    end
+  end
+end

data/lib/metanorma/default/default.rb

@@ -0,0 +1,99 @@
+require "htmlentities"
+require_relative "cleanup"
+require_relative "utils"
+require_relative "isodoc"
+require_relative "xrefs"
+
+module Metanorma
+  class Requirements
+    class Default
+      def initialize(options)
+        @c = HTMLEntities.new
+        @parent = options[:parent]
+        @i18n = @parent.i18n
+        @labels = @parent.labels
+      end
+
+      def reqt_subpart?(name)
+        %w[specification measurement-target verification import identifier title
+           description component subject inherit classification].include? name
+      end
+
+      def reqt_subpart_attrs(node, name, attrs)
+        klass = node.attr("class") || "component"
+        attr_code(attrs
+          .merge(exclude: node.option?("exclude"),
+                 type: node.attr("type"),
+                 class: name == "component" ? klass : nil))
+      end
+
+      def requirement_subpart(node, attrs)
+        name = node.role || node.attr("style")
+        noko do |xml|
+          xml.send name, **reqt_subpart_attrs(node, name, attrs) do |o|
+            o << node.content
+          end
+        end
+      end
+
+      def req_classif_parse(classif)
+        ret = []
+        @c.decode(classif).split(/;\s*/).each do |c|
+          c1 = c.split(/:\s*/)
+          next unless c1.size == 2
+
+          c1[1].split(/,\s*/).each { |v| ret << [c1[0], v] }
+        end
+        ret
+      end
+
+      def requirement_classification(classif, out)
+        req_classif_parse(classif).each do |r|
+          out.classification do |c|
+            c.tag { |t| t << r[0] }
+            c.value { |v| v << r[1] }
+          end
+        end
+      end
+
+      def reqt_attrs(node, attrs)
+        attr_code(attrs.merge(
+                    id: Metanorma::Utils.anchor_or_uuid(node),
+                    unnumbered: node.option?("unnumbered") ? "true" : nil,
+                    number: node.attr("number"),
+                    subsequence: node.attr("subsequence"),
+                    obligation: node.attr("obligation"),
+                    filename: node.attr("filename"),
+                    type: node.attr("type"),
+                  ))
+      end
+
+      def requirement_elems(node, out)
+        node.title and out.title { |t| t << node.title }
+        a = node.attr("identifier") and out.identifier do |l|
+          l << out.text(a)
+        end
+        a = node.attr("subject") and csv_split(a)&.each do |subj|
+          out.subject { |s| s << out.text(subj) }
+        end
+        a = @c.decode(node.attr("inherit")) and
+          csv_split(a)&.each do |i|
+            out.inherit do |inh|
+              inh << @c.encode(i, :hexadecimal)
+            end
+          end
+        classif = node.attr("classification") and
+          requirement_classification(classif, out)
+      end
+
+      def requirement(node, obligation, attrs)
+        noko do |xml|
+          xml.send obligation, **reqt_attrs(node, attrs) do |ex|
+            requirement_elems(node, ex)
+            wrap_in_para(node, ex)
+          end
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/metanorma/default/isodoc.rb

@@ -0,0 +1,106 @@
+module Metanorma
+  class Requirements
+    class Default
+      def l10n(text)
+        @i18n.l10n(text)
+      end
+
+      def recommendation_label(elem, type, xrefs)
+        number = xrefs.anchor(elem["id"], :label, false)
+        (number.nil? ? type : "#{type} #{number}")
+      end
+
+      def reqt_metadata_node?(node)
+        %w(identifier title subject classification tag value
+           inherit name).include? node.name
+      end
+
+      def requirement_render1(node)
+        out = recommendation_base(node, node.name)
+        ins = recommendation_header(node, out)
+        ins = recommendation_attributes(node, ins)
+        node.elements.reject do |n|
+          reqt_metadata_node?(n)
+        end.each { |n| ins = requirement_component_parse(n, ins) }
+        out
+      end
+
+      def recommendation_base(node, klass)
+        out = node.document.create_element(klass)
+        node.attributes.each do |k, v|
+          out[k] = v
+        end
+        out
+      end
+
+      def recommendation_labels(node)
+        [node.at(ns("./identifier")), node.at(ns("./title")),
+         node.at(ns("./name"))]
+          .map do |n|
+          n&.children&.to_xml
+        end
+      end
+
+      def recommendation_header(node, out)
+        label, title, name = recommendation_labels(node)
+        ret = name ? [name + l10n(":")] : []
+        if label || title
+          ret += ["<br/>", label]
+          ret << l10n(". ") if label && title
+          ret << title
+        end
+        out << "<name>#{ret.compact.join}</name>"
+        out
+      end
+
+      def recommendation_attributes1(node, out)
+        oblig = node["obligation"] and
+          out << l10n("#{@labels['obligation']}: #{oblig}")
+        node.xpath(ns("./subject")).each do |subj|
+          out << l10n("#{@labels['subject']}: #{subj.text}")
+        end
+        node.xpath(ns("./inherit")).each do |i|
+          out << recommendation_attr_parse(i, @labels["inherits"])
+        end
+        node.xpath(ns("./classification")).each do |c|
+          out << recommendation_attr_keyvalue(c, "tag", "value")
+        end
+        out
+      end
+
+      def recommendation_attr_parse(node, label)
+        "#{label}: #{node.children.to_xml}"
+      end
+
+      def recommendation_attr_keyvalue(node, key, value)
+        tag = node.at(ns("./#{key}")) or return nil
+        value = node.at(ns("./#{value}")) or return nil
+        "#{tag.text.capitalize}: #{value.children.to_xml}"
+      end
+
+      def recommendation_attributes(node, out)
+        ret = recommendation_attributes1(node, [])
+          .map { |a| "<em>#{a}</em>" }
+        ret.empty? or
+          out << "<p>#{ret.join("<br/>\n")}</p>"
+        out
+      end
+
+      def reqt_component_type(node)
+        klass = node.name
+        klass == "component" and klass = node["class"]
+        "requirement-#{klass}"
+      end
+
+      def requirement_component_parse(node, out)
+        return out if node["exclude"] == "true"
+
+        ret = node.dup
+        ret["type"] = reqt_component_type(node)
+        ret.name = "div"
+        out << ret
+        out
+      end
+    end
+  end
+end

data/lib/metanorma/default/utils.rb

@@ -0,0 +1,27 @@
+require "metanorma-utils"
+
+module Metanorma
+  class Requirements
+    class Default
+      def noko(&block)
+        Metanorma::Utils.noko(&block)
+      end
+
+      def attr_code(attributes)
+        Metanorma::Utils.attr_code(attributes)
+      end
+
+      def csv_split(text, delim = ";")
+        Metanorma::Utils.csv_split(text, delim)
+      end
+
+      def wrap_in_para(node, out)
+        Metanorma::Utils.wrap_in_para(node, out)
+      end
+
+      def ns(xpath)
+        Metanorma::Utils.ns(xpath)
+      end
+    end
+  end
+end

data/lib/metanorma/default/xrefs.rb

@@ -0,0 +1,35 @@
+module Metanorma
+  class Requirements
+    class Default
+      def permission_parts(_block, _block_id, _label, _klass)
+        []
+      end
+
+      def req_class_paths
+        [
+          { klass: "permission", label: "permission",
+            xpath: "permission" },
+          { klass: "requirement", label: "requirement",
+            xpath: "requirement" },
+          { klass: "recommendation", label: "recommendation",
+            xpath: "recommendation" },
+        ]
+      end
+
+      def req_nested_class_paths
+        [
+          { klass: "permission", label: "permission",
+            xpath: "permission" },
+          { klass: "requirement", label: "requirement",
+            xpath: "requirement" },
+          { klass: "recommendation", label: "recommendation",
+            xpath: "recommendation" },
+        ]
+      end
+
+      def postprocess_anchor_struct(_block, anchor)
+        anchor
+      end
+    end
+  end
+end