metanorma-ribose 1.6.16 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15cc3c5ccba05fef79b07e6ccb7e83c61660ab0427c06e7a822d4cbca06a03bf
-  data.tar.gz: 30dcf9307e57ded58f56732c46928a1765e2178d21c2ecb61cd5d1bc9953e106
+  metadata.gz: 66e4c7b5455993a823218c7d987698ab20f63c1b2568a67773a9457f32de1810
+  data.tar.gz: 7eec556a3a4b21e4f5da74d97007dc6de78b678fecd5af07b844fe828b5e6d0a
 SHA512:
-  metadata.gz: 48502a8f19547c1bf522e1a5d2700ef65cbecb383a2066cd4e54048f4943d975a078170675c02e6e793ad30a2c442837f2130d81ffd0e654ba736da90a39337d
-  data.tar.gz: cbe70e64b6aeceab8dac66dcb0c5f01678406abe61e92ac5aee38a950996bd86f2f6dd183764e7ca036d66ee47cae4d7c5873391854b551391f98c10a13ed389
+  metadata.gz: 71326d6b58d81dd6dbd765db1670d47d098c532fd1f2b5cf07ca9fc739aa56fc2f438cafc53e4908222657849d87640e71c77db4441a3cc01aab98c5517e429f
+  data.tar.gz: 1496500522ee692ac096e143262e3027a28b6995c04eaefe49e9688e97aa0d28c64e25d08cd4ac76a278c6f4ff8652f7d7225c00d5b5fdbd9ed1b18cbf046e11

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

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

data/.rubocop.yml

@@ -1,14 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# 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:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
   TargetRubyVersion: 2.4
-Rails:
-  Enabled: true

data/Gemfile

@@ -6,6 +6,6 @@ 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
+if File.exist? "Gemfile.devel"
+  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
 end

data/README.adoc

@@ -1,10 +1,10 @@
-= metanorma-ribose: Asciidoctor processor for Ribose Standard Documents 
+= Metanorma processor for Ribose documents
 
-image:https://img.shields.io/gem/v/metanorma-rsd.svg["Gem Version", link="https://rubygems.org/gems/metanorma-rsd"]
-image:https://github.com/metanorma/metanorma-rsd/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-rsd/actions?workflow=rake"]
-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"]
+image:https://img.shields.io/gem/v/metanorma-ribose.svg["Gem Version", link="https://rubygems.org/gems/metanorma-ribose"]
+image:https://github.com/metanorma/metanorma-ribose/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-ribose/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/metanorma-ribose/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-ribose"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-ribose.svg["Pull Requests", link="https://github.com/metanorma/metanorma-ribose/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-ribose/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-ribose/releases"]
 
 == Functionality
 
@@ -27,7 +27,7 @@ $ metanorma --type ribose --extensions xml a.adoc  # output Metanorma XML
 ----
 
 The gem translates the document into Metanorma XML format, and then
-validates its output against the Ribopse Metanorma XML document model; errors are
+validates its output against the Ribose Metanorma XML document model; errors are
 reported to console against the XML, and are intended for users to
 check that they have provided all necessary components of the
 document.
@@ -36,16 +36,8 @@ The gem then converts the XML into output formats such as HTML and PDF.
 
 === Installation
 
-If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup
-repository has instructions on setting up your machine to run Metanorma
-scripts such as this one. You need only run the following in a Terminal console:
+See https://www.metanorma.com for installation documentation.
 
-[source,console]
-----
-$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
-$ gem install metanorma-rsd
-$ gem install metanorma-cli
-----
 
 == Documentation
 
@@ -57,7 +49,7 @@ See https://www.metanorma.com/author/ribose/[The Ribose flavor of Metanorma]
 The Ribose Standard Document format is an instance of the
 https://github.com/metanorma/metanorma-model-standoc[StandardDocument model]. Details of
 this general model can be found on its page. Details of the Ribose modifications
-to this general model can be found on the https://github.com/metanorma/metanorma-model-rsd[RSD model]
+to this general model can be found on the https://github.com/metanorma/metanorma-model-ribose[Metanorma-Ribose model]
 repository.
 
 == Examples
@@ -67,4 +59,4 @@ repository.
 
 == Notes
 
-Metanorma-Ribose was formerly published as `asciidoctor-rsd`, `metanorma-rsd`.
+Metanorma-Ribose was formerly published as `metanorma-rsd`.

data/Rakefile

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

data/bin/rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-  
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and
@@ -15,4 +15,3 @@ require "rubygems"
 require "bundler/setup"
 
 load Gem.bin_path("rspec-core", "rspec")
-

data/lib/asciidoctor/ribose/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/ribose/boilerplate.xml

@@ -1,7 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-      <p> © Ribose Group Inc. {{ docyear }}</p>
+      <p> © {{ publisher }} {{ docyear }}</p>
     </clause>
   </copyright-statement>
       {% if unpublished %}
@@ -31,15 +31,15 @@
   <feedback-statement>
     <clause>
       <p align="left" id="boilerplate-name">
-        Ribose Group Inc.
+        {% if publisher %}{{ publisher }}{% else %}Ribose Group Inc.{% endif %}
       </p>
-      <p align="left" id="boilerplate-address">Suite 1, 8/F, New Henry House<br/>
+      <p align="left" id="boilerplate-address">{% if pub_address %}{{ pub_address }}{% else %}Suite 1, 8/F, New Henry House<br/>
         10 Ice House Street<br/>
         Central<br/>
-        Hong Kong<br/>
+        Hong Kong{% endif %}<br/>
         <br />
-        <link target="mailto:copyright@ribose.com">copyright@ribose.com</link><br />
-        <link target="https://www.ribose.com">www.ribose.com</link>
+        {% if pub_email %}<link target="mailto:{{ pub_email }}">{{ pub_email }}</link>{% else %}<link target="mailto:copyright@ribose.com">copyright@ribose.com</link>{% endif %}<br />
+        {% if pub_uri %}<link target="{{ pub_uri }}">{{ pub_uri }}</link>{% else %}<link target="https://www.ribose.com">www.ribose.com</link>{% endif %}
       </p>
     </clause>
   </feedback-statement>

data/lib/asciidoctor/ribose/converter.rb

@@ -1,5 +1,5 @@
 require "asciidoctor/standoc/converter"
-require 'asciidoctor/generic/converter'
+require "asciidoctor/generic/converter"
 
 module Asciidoctor
   module Ribose
@@ -7,33 +7,34 @@ module Asciidoctor
     # schema encapsulation of the document for validation
     #
     class Converter < Asciidoctor::Generic::Converter
-      XML_ROOT_TAG = 'rsd-standard'.freeze
-      XML_NAMESPACE = 'https://www.metanorma.org/ns/rsd'.freeze
+      XML_ROOT_TAG = "rsd-standard".freeze
+      XML_NAMESPACE = "https://www.metanorma.org/ns/rsd".freeze
 
       register_for "ribose"
 
       def sectiontype(node, level = true)
         ret = sectiontype1(node)
         ret1 = sectiontype_streamline(ret)
-        return ret1 if "symbols and abbreviated terms" == ret1
-        return ret1 if "executive summary" == ret1
+        return ret1 if ret1 == "symbols and abbreviated terms"
+        return ret1 if ret1 == "executive summary"
         return nil unless !level || node.level == 1
         return nil if @seen_headers.include? ret
+
         @seen_headers << ret
         ret1
       end
 
-      def make_preface(x, s)
-        if x.at("//foreword | //introduction | //acknowledgements | "\
+      def make_preface(xml, sect)
+        if xml.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
+          preface = sect.add_previous_sibling("<preface/>").first
+          f = xml.at("//foreword") and preface.add_child f.remove
+          f = xml.at("//executivesummary") and preface.add_child f.remove
+          f = xml.at("//introduction") and preface.add_child f.remove
+          move_clauses_into_preface(xml, preface)
+          f = xml.at("//acknowledgements") and preface.add_child f.remove
         end
-        make_abstract(x, s)
+        make_abstract(xml, sect)
       end
 
       def clause_parse(attrs, xml, node)
@@ -55,7 +56,8 @@ module Asciidoctor
       end
 
       def presentation_xml_converter(node)
-        IsoDoc::Ribose::PresentationXMLConvert.new(html_extract_attributes(node))
+        IsoDoc::Ribose::PresentationXMLConvert
+          .new(html_extract_attributes(node))
       end
 
       def html_converter(node)
@@ -64,6 +66,7 @@ module Asciidoctor
 
       def pdf_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::Ribose::PdfConvert.new(html_extract_attributes(node))
       end
 

data/lib/asciidoctor/ribose/isodoc.rng

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -86,6 +91,35 @@
         <text/>
       </element>
     </define>
+    <define name="erefType">
+      <optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="citeas"/>
+      <attribute name="type">
+        <ref name="ReferenceFormat"/>
+      </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
+      <optional>
+        <attribute name="case">
+          <choice>
+            <value>capital</value>
+            <value>lowercase</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="droploc">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="CitationType"/>
+      <text/>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -514,6 +548,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -775,8 +812,100 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="em">
+      <element name="em">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strong">
+      <element name="strong">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="tt">
+      <element name="tt">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="keyword">
+      <element name="keyword">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strike">
+      <element name="strike">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="underline">
+      <element name="underline">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="smallcap">
+      <element name="smallcap">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="pagebreak">
+      <element name="pagebreak">
+        <optional>
+          <attribute name="orientation">
+            <choice>
+              <value>landscape</value>
+              <value>portrait</value>
+            </choice>
+          </attribute>
+        </optional>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="docsubtype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -793,7 +922,35 @@
     <value>internal</value>
   </define>
   <define name="TextElement" combine="choice">
-    <ref name="concept"/>
+    <choice>
+      <ref name="concept"/>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
   </define>
   <define name="concept">
     <element name="concept">
@@ -814,8 +971,170 @@
       <ref name="permission"/>
       <ref name="imagemap"/>
       <ref name="svgmap"/>
+      <ref name="inputform"/>
+    </choice>
+  </define>
+  <define name="inputform">
+    <element name="form">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="name"/>
+      <attribute name="action"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="TextElement"/>
+          <ref name="FormInput"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="FormInput">
+    <choice>
+      <ref name="input"/>
+      <ref name="formlabel"/>
+      <ref name="select"/>
+      <ref name="textarea"/>
+    </choice>
+  </define>
+  <define name="InputType">
+    <choice>
+      <value>button</value>
+      <value>checkbox</value>
+      <value>date</value>
+      <value>file</value>
+      <value>password</value>
+      <value>radio</value>
+      <value>submit</value>
+      <value>text</value>
     </choice>
   </define>
+  <define name="input">
+    <element name="input">
+      <attribute name="type">
+        <ref name="InputType"/>
+      </attribute>
+      <optional>
+        <attribute name="checked">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="readonly">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="maxlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="minlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
+  <define name="formlabel">
+    <element name="label">
+      <attribute name="for">
+        <data type="IDREF"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="select">
+    <element name="select">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="multiple">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="size">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="option"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="option">
+    <element name="option">
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="textarea">
+    <element name="textarea">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="rows">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="cols">
+          <data type="int"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
   <define name="bibliography">
     <element name="bibliography">
       <oneOrMore>
@@ -888,9 +1207,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>