metanorma-rsd 1.3.11 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a45132215438e659d5a94aeca1b994e2866dc25e4430fc1b4a2b234223c035
-  data.tar.gz: c30c2134bef3717dbe33c25b71622478ff897f9f2d5a1b8fe5e40e03fbd6d1a2
+  metadata.gz: 101eb1fc5a1a726cefc8e12dcd570733d0cb2b800c586c4628ba4674647e671f
+  data.tar.gz: 78064e1735d8fac74138360ae08438a82447b2974d6a38f3587ce8e9b2d5c47f
 SHA512:
-  metadata.gz: db9637f124dcba7b544c9caeabade267c831b8335e3e5bf058e26be2840b314eca861398321641286809bda22acf4ccd6fc73ef60db74e2f90b4ba1bd662a400
-  data.tar.gz: 9e5837db5f2ff899ca643eb3a8b63f220b3e5836431babfd8f360fbfffa55d190a18369655d61735905c6f6ec5c6c3157c42f0ce1341415e6c496988f7c12a50
+  metadata.gz: 1311e29995441ad9c98b18cf3a280a131e3870736706369610328fc34bf673a29461777048f48fd155b9c2dfb428c72a0bd8b22bd4664847f43ed5ee74bad15a
+  data.tar.gz: 5dd2bd74300087c571aaaa77377192e4f55943df03cbc87080903812d20894a4f49359d6ab79f77f7cce3a7267ca735c83a781d06572a702cf4570df132dccd4

data/.github/workflows/macos.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: macos
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-macos:

data/.github/workflows/ubuntu.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: ubuntu
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-linux:
@@ -25,7 +24,7 @@ jobs:
           architecture: 'x64'
       - name: Update gems
         run: |
-          gem install bundler 
+          gem install bundler
           bundle install --jobs 4 --retry 3
       - name: Use Node
         uses: actions/setup-node@v1

data/.github/workflows/windows.yml

@@ -1,12 +1,11 @@
-# Auto-generated !!! Do not edit it manually
-# use ci-master https://github.com/metanorma/metanorma-build-scripts
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: windows
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '**' ]
 
 jobs:
   test-windows:
@@ -26,7 +25,7 @@ jobs:
       - name: Update gems
         shell: pwsh
         run: |
-          gem install bundler 
+          gem install bundler
           bundle config --local path vendor/bundle
           bundle update
           bundle install --jobs 4 --retry 3

data/README.adoc

@@ -1,8 +1,9 @@
 = AsciiRSD: Asciidoctor processor for Ribose Standard Documents (RSD)
 
 image:https://img.shields.io/gem/v/metanorma-rsd.svg["Gem Version", link="https://rubygems.org/gems/metanorma-rsd"]
-image:https://travis-ci.com/metanorma/metanorma-rsd.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-rsd"]
-image:https://ci.appveyor.com/api/projects/status/col74y763yt5xaka?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma-rsd"]
+image:https://github.com/metanorma/metanorma-rsd/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-rsd/actions?workflow=macos"]
+image:https://github.com/metanorma/metanorma-rsd/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-rsd/actions?workflow=ubuntu"]
+image:https://github.com/metanorma/metanorma-rsd/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-rsd/actions?workflow=windows"]
 image:https://codeclimate.com/github/metanorma/metanorma-rsd/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-rsd"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-rsd.svg["Pull Requests", link="https://github.com/metanorma/metanorma-rsd/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-rsd/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-rsd/releases"]
@@ -87,8 +88,7 @@ this general model can be found on its page. Details of the RSD modifications
 to this general model can be found on the https://github.com/metanorma/metanorma-model-rsd[RSD model]
 repository.
 
+////
 == Examples
+////
 
-* link:spec/examples/rfc6350.adoc[] is an AsciiRSD version of https://tools.ietf.org/html/rfc6350[RFC 6350].
-* link:spec/examples/rfc6350.html[] is an HTML file generated from the AsciiRSD.
-* link:spec/examples/rfc6350.doc[] is a Word document generated from the AsciiRSD.

data/lib/asciidoctor/rsd.rb

@@ -1,7 +1,4 @@
 module Asciidoctor
   module Rsd
-
-    RSD_NAMESPACE = "https://open.ribose.com/standards/rsd"
-
   end
 end

data/lib/asciidoctor/rsd/biblio.rng

@@ -703,21 +703,11 @@
   </define>
   <define name="TypedTitleString">
     <optional>
-      <attribute name="type">
-        <ref name="TitleType"/>
-      </attribute>
+      <attribute name="type"/>
     </optional>
     <ref name="FormattedString"/>
   </define>
-  <define name="TitleType">
-    <choice>
-      <value>alternative</value>
-      <value>original</value>
-      <value>unofficial</value>
-      <value>subtitle</value>
-      <value>main</value>
-    </choice>
-  </define>
+  <!-- TitleType = ( "alternative" | "original" | "unofficial" | "subtitle" | "main" ) -->
   <define name="TypedUri">
     <optional>
       <attribute name="type"/>

data/lib/asciidoctor/rsd/converter.rb

@@ -1,81 +1,17 @@
-require "asciidoctor"
-require "asciidoctor/rsd"
 require "asciidoctor/standoc/converter"
-require "isodoc/rsd/html_convert"
-require "isodoc/rsd/word_convert"
-require "fileutils"
-require_relative "validate"
+require 'asciidoctor/generic/converter'
 
 module Asciidoctor
   module Rsd
-
     # A {Converter} implementation that generates RSD output, and a document
     # schema encapsulation of the document for validation
     #
-    class Converter < Standoc::Converter
-
+    class Converter < Asciidoctor::Generic::Converter
       register_for "rsd"
 
-      def initialize(backend, opts)
-        super
-        @libdir = File.dirname(__FILE__)
-      end
-
-      def metadata_author(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "author" }
-          c.organization do |a|
-            a.name "Ribose"
-          end
-        end
-      end
-
-      def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "Ribose"
-          end
-        end
-      end
-
-      def metadata_committee(node, xml)
-        return unless node.attr("committee")
-        xml.editorialgroup do |a|
-          a.committee node.attr("committee"),
-            **attr_code(type: node.attr("committee-type"))
-          i = 2
-          while node.attr("committee_#{i}") do
-            a.committee node.attr("committee_#{i}"),
-              **attr_code(type: node.attr("committee-type_#{i}"))
-            i += 1
-          end
-        end
-      end
-
-      def metadata_id(node, xml)
-        docstatus = node.attr("status")
-        dn = node.attr("docnumber")
-        if docstatus
-          abbr = IsoDoc::Rsd::Metadata.new("en", "Latn", {}).
-            status_abbr(docstatus)
-          dn = "#{dn}(#{abbr})" unless abbr.empty?
-        end
-        node.attr("copyright-year") and dn += ":#{node.attr("copyright-year")}"
-        xml.docidentifier dn, **{type: "rsd"}
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "Ribose"
-            end
-          end
-        end
+      def metadata_recipient(node, xml)
+        recipient = node.attr("recipient") || return
+        xml.recipient recipient
       end
 
       def metadata_security(node, xml)
@@ -86,70 +22,50 @@ module Asciidoctor
       def metadata_ext(node, xml)
         super
         metadata_security(node, xml)
-      end
-
-      def title_validate(root)
-        nil
-      end
-
-      def makexml(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>\n<rsd-standard>"]
-        @draft = node.attributes.has_key?("draft")
-        result << noko { |ixml| front node, ixml }
-        result << noko { |ixml| middle node, ixml }
-        result << "</rsd-standard>"
-        result = textcleanup(result)
-        ret1 = cleanup(Nokogiri::XML(result))
-        validate(ret1) unless @novalid
-        ret1.root.add_namespace(nil, RSD_NAMESPACE)
+        metadata_recipient(node, xml)
+      end
+
+      def sectiontype(node, level = true)
+        ret = node&.attr("heading")&.downcase ||
+          node.title.gsub(/<[^>]+>/, "").downcase
+        ret1 = sectiontype_streamline(ret)
+        return ret1 if "symbols and abbreviated terms" == ret1
+        return ret1 if "executive summary" == ret1
+        return nil unless !level || node.level == 1
+        return nil if @seen_headers.include? ret
+        @seen_headers << ret
         ret1
       end
 
-      def doctype(node)
-        d = node.attr("doctype")
-        unless %w{policy-and-procedures best-practices supporting-document
-          report legal directives proposal standard}.include? d
-          warn "#{d} is not a legal document type: reverting to 'standard'"
-          d = "standard"
+      def make_preface(x, s)
+        if x.at("//foreword | //introduction | //acknowledgements | "\
+            "//clause[@preface] | //executivesummary")
+          preface = s.add_previous_sibling("<preface/>").first
+          f = x.at("//foreword") and preface.add_child f.remove
+          f = x.at("//executivesummary") and preface.add_child f.remove
+          f = x.at("//introduction") and preface.add_child f.remove
+          move_clauses_into_preface(x, preface)
+          f = x.at("//acknowledgements") and preface.add_child f.remove
         end
-        d
+        make_abstract(x, s)
       end
 
-      def document(node)
-        init(node)
-        ret1 = makexml(node)
-        ret = ret1.to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
-          filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
-            gsub(%r{^.*/}, "")
-          File.open(filename, "w") { |f| f.write(ret) }
-          html_converter(node).convert filename unless node.attr("nodoc")
-          pdf_converter(node).convert filename unless node.attr("nodoc")
-          word_converter(node).convert filename unless node.attr("nodoc")
-        end
-        @files_to_delete.each { |f| FileUtils.rm f }
-        ret
-      end
-
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "rsd.rng"))
-      end
-
-      def rsd_html_path(file)
-        File.join(File.dirname(__FILE__), File.join("html", file))
+      def clause_parse(attrs, xml, node)
+        sectiontype(node) == "executive summary" and
+          return executivesummary_parse(attrs, xml, node)
+        super
       end
 
-      def sections_cleanup(x)
-        super
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
+      def executivesummary_parse(attrs, xml, node)
+        xml.executivesummary **attr_code(attrs) do |xml_section|
+          xml_section.title { |t| t << node.title || "Executive Summary" }
+          content = node.content
+          xml_section << content
         end
       end
 
-      def style(n, t)
-        return
+      def configuration
+        Metanorma::Rsd.configuration
       end
 
       def html_converter(node)

data/lib/asciidoctor/rsd/isodoc.rng

@@ -101,9 +101,7 @@
         <ref name="structuredidentifier"/>
       </zeroOrMore>
     </define>
-    <define name="TitleType">
-      <text/>
-    </define>
+    <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
         <oneOrMore>
@@ -645,6 +643,11 @@
     <optional>
       <attribute name="script"/>
     </optional>
+    <optional>
+      <attribute name="inline-header">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <optional>
       <attribute name="obligation">
         <choice>

data/lib/asciidoctor/rsd/rsd.rng

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns="https://www.metanorma.org/ns/rsd" xmlns="http://relaxng.org/ns/structure/1.0">
   <!--
     Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
     we cannot have a new default namespace: we will end up with a grammar with two different

data/lib/asciidoctor/rsd/validate.rb

@@ -14,7 +14,7 @@ module Asciidoctor
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(proposal working-draft committee-draft draft-standard final-draft
         published withdrawn).include? stage or
-          warn "Document Attributes: #{stage} is not a recognised status"
+        @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
       end
     end
   end

data/lib/isodoc/rsd/base_convert.rb

@@ -1,56 +1,62 @@
-require_relative "metadata"
-require "fileutils"
-
 module IsoDoc
   module Rsd
-  	module BaseConvert
-      #def convert1(docxml, filename, dir)
-        #FileUtils.cp html_doc_path('logo.svg'), File.join(@localdir, "logo.svg")
-        #@files_to_delete << File.join(@localdir, "logo.svg")
-        #super
-      #end
-
+    module BaseConvert
       def metadata_init(lang, script, labels)
         @meta = Metadata.new(lang, script, labels)
       end
 
+      def info(isoxml, out)
+        @meta.security isoxml, out
+        @meta.recipient isoxml, out
+        super
+      end
+
       def annex_name(annex, name, div)
         div.h1 **{ class: "Annex" } do |t|
-          t << "#{anchor(annex['id'], :label)} "
-          t.br
-          t.b do |b|
-            name&.children&.each { |c2| parse(c2, b) }
-          end
+          t << "#{anchor(annex['id'], :label)}<br/><br/>"
+          name&.children&.each { |c2| parse(c2, t) }
         end
       end
 
-      def i18n_init(lang, script)
-        super
-        @annex_lbl = "Appendix"
+      def annex_name_lbl(clause, num)
+        obl = l10n("(#{@inform_annex_lbl})")
+        obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
+        l10n("#{@annex_lbl} #{num}<br/>#{obl}")
       end
 
-      def fileloc(loc)
-        File.join(File.dirname(__FILE__), loc)
+      def executivesummary docxml, out
+        f = docxml.at(ns("//executivesummary")) || return
+        title_attr = { class: "IntroTitle" }
+        page_break(out)
+        out.div **{ class: "Section3", id: f["id"] } do |div|
+          clause_name(nil, f&.at(ns("./title")), div, title_attr)
+          f.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
       end
 
-      def cleanup(docxml)
+      def initial_anchor_names(d)
+        preface_names(d.at(ns("//executivesummary")))
         super
-        term_cleanup(docxml)
+        sequential_asset_names(
+          d.xpath(ns("//preface/abstract | //foreword | //introduction | "\
+                     "//preface/clause | //acknowledgements | //executivesummary")))
       end
 
-      def term_cleanup(docxml)
-        docxml.xpath("//p[@class = 'Terms']").each do |d|
-          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
-          h2.add_child("&nbsp;")
-          h2.add_child(d.remove)
-        end
-        docxml
+      def clausedelim
+        ""
       end
 
-      def info(isoxml, out)
-        @meta.security isoxml, out
-        super
+      def section_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { label: num, level: level, xref: num }
+        # subclauses are not prefixed with "Clause"
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions | ./references")).
+          each_with_index do |c, i|
+          section_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
       end
-  	end
+    end
   end
 end