metanorma-m3d 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6131eec8449a38233d4083a799eb00bd33ae67e90f53e5cdb8df0a7d84efcf94
-  data.tar.gz: 16b4ce44dae95a5adcb3026f31dd76a5428292bcdd2d3e0c9cb0635482676ce8
+  metadata.gz: 673148621b29be98f5e5d8abf59cf94944055ea5b54a1fa9cdbdbdb40f33e61c
+  data.tar.gz: 95613dc525098720304cdc8f535ab8c8faeb6bc8ba70389616d807626f11891e
 SHA512:
-  metadata.gz: d4e00f1260ee9ba8e3efc8f0ef6ceba2354feedf74953cde19564f15d0b67a43ce1977ecbac0af6dab2e5d7b40171cc396c75320652068c92f89999bd0f4cef1
-  data.tar.gz: 1374576732f1ca8f9db5db4df7d3083c7d95893821948acf372679285edbd938d08b8cdf69b4b07eb50a59a455400844eb1d77f9f8cadf6b6341b5262c9d87d0
+  metadata.gz: b036f5179c539616665fc8c9b2700167dc3360c370496186a82f59d15a7c7a09eee5e581dbe04e63d15557dcf88868e2836e833b82d197cb77a66218585c2018
+  data.tar.gz: b18fbdde1043a7645167eff1b09111a4ad3b307c1ccad7021bc0c70a4c698759528fc1a2863578acc3c44604e9b6be5c4fa107e8490c89dbc5f8652bc3877752

data/.travis.yml

@@ -8,9 +8,8 @@ rvm:
   - ruby-head
 before_install:
   - gem install bundler -v 2.0.1
-  - npm install -g puppeteer
-  - npm install
-  - unset _JAVA_OPTIONS
+  - travis_retry sudo apt-get update
+  - sudo bash -c "curl -L https://raw.githubusercontent.com/metanorma/metanorma-linux-setup/master/ubuntu-install-puppeteer.sh | bash"
 matrix:
   allow_failures:
     - rvm: ruby-head

data/README.adoc

@@ -1,8 +1,9 @@
 = Metanorma processor for M3AAWG documents (M3D)
 
 image:https://img.shields.io/gem/v/metanorma-m3d.svg["Gem Version", link="https://rubygems.org/gems/metanorma-m3d"]
-image:https://img.shields.io/travis/riboseinc/metanorma-m3d/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma-m3d"]
-image:https://codeclimate.com/github/riboseinc/metanorma-m3d/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma-m3d"]
+image:https://img.shields.io/travis/metanorma/metanorma-m3d/master.svg["Build Status", link="https://travis-ci.org/metanorma/metanorma-m3d"]
+image:https://ci.appveyor.com/api/projects/status/k09hlrs4njm7o2mv?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/metanorma-m3d"]
+image:https://codeclimate.com/github/metanorma/metanorma-m3d/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-m3d"]
 
 WARNING: This gem is still under development.
 
@@ -13,9 +14,9 @@ _Formerly known as_ `asciidoctor-m3d`.
 This gem processes http://asciidoctor.org/[Asciidoctor] documents following
 a template for generating M3D documents.
 
-The gem currently inherits from the https://github.com/riboseinc/metanorma-standoc
+The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
 gem, and aligns closely to it. Refer to the ISO gem documentation
-for guidance, including https://github.com/riboseinc/metanorma-iso/wiki/Guidance-for-authoring
+for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance-for-authoring
 
 The following outputs are generated.
 
@@ -64,102 +65,26 @@ $ asciidoctor -b m3d -r 'metanorma-m3d' a.adoc
 
 === Installation
 
-If you are using a Mac, the https://github.com/riboseinc/metanorma-macos-setup
+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:
 
 [source,console]
 ----
-$ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
+$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
 $ gem install metanorma-m3d
 ----
 
+== Documentation
 
-== Approach
-
-=== Document model
-
-The Ribose Standard Document model is an instance of the
-https://github.com/riboseinc/isodoc-models[StandardDocument model].
-
-The M3D format ("M3D XML") intends to introduce rigor into the M3D
-standards authoring process, and is prescribed in a separate document.
-
-M3D XML is still under development, but it already contains all the markup
-needed to render a M3D document into HTML.
-
-=== Asciidoctor
-
-Asciidoctor has been selected as the authoring tool to generate the document
-model representation of M3D standards. It is a document formatting tool like
-Markdown and DocBook, which combines the relative ease of use of the former
-(using relatively lightweight markup), and the rigor and expressively of the
-latter (it has a well-defined syntax, and was in fact initially developed as a
-DocBook document authoring tool). Asciidoctor has built-in capability to output
-Text, DocBook and HTML; so it can be used to preview the file as it is being
-authored.
-
-Generating documents via a document model substantially automated formatting
-associated with the document, including automating numbering of headings, figures,
-tables etc, and automatically generating references and citations.
-
-== Document Attributes
-
-=== Common attributes
-
-The gem relies on Asciidoctor document attributes to provide necessary
-metadata about the document. The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
-gem documents the Asciidoctor document attributes common to all metanorma gems. These include:
-
-`:edition:`:: The document edition
-
-`:revdate:`:: The date the document was last updated
-
-`:copyright-year:`:: The year which will be claimed as when the copyright for
-the document was issued
-
-`:title:`:: The main component of the English title of the document
-(mandatory). (The first line of the AsciiDoc document, which contains the title
-introduced with `=`, is ignored)
-
-`:doctype:`:: The document type (see M3D deliverables: The different types of
-M3D publications) (mandatory). The permitted types are:
-+
---
-code:: Code Artifact
-presentation:: Presentation
-proposal:: Proposal; includes IETF DRAFT
-standard:: Recommendation; includes IETF RFC
-report:: report
---
-
-`:status:``:: The document status. The permitted types are: `proposal`,
-`working-draft`, `committee-draft`, `draft-standard`, `final-draft`,
-`published`, `withdrawn`.
-
-`:technical-committee:`:: The name of the relevant M3D technical committee
-(mandatory)
-
-`:language:` :: The language of the document (only `en` for now)  (mandatory)
-
-The attribute `:draft:`, if present, includes review notes in the XML output;
-these are otherwise suppressed.
-
-== Asciidoctor features specific to CSAND
-
-The https://github.com/riboseinc/metanorma-standoc[metanorma-standoc]
-gem documents the customisations of Asciidoctor markup common to all metanorma gems.
-The following markup is specific to this gem:
-
-* `+[keyword]#...#+`: encodes keywords, such as "MUST", "MUST NOT". (Encoded as
-`<span class="keyword">...</span>`.
+See https://www.metanorma.com/author/m3d/[Author M^3^AAWG documents with Metanorma-M3D]
 
 == Data Models
 
 The M3D Standard Document format is an instance of the
-https://github.com/riboseinc/isodoc-models[StandardDocument model]. Details of
+https://github.com/metanorma/metanorma-model-standoc[StandardDocument model]. Details of
 this general model can be found on its page. Details of the M3D modifications
-to this general model can be found on the https://github.com/riboseinc/m3d[M3D model]
+to this general model can be found on the https://github.com/metanorma/metanorma-model-m3d[M3D model]
 repository.
 
 == Examples

data/appveyor.yml

@@ -0,0 +1,30 @@
+version: '{build}'
+
+environment:
+  matrix:
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 24
+    - RUBY_VERSION: 23
+    - RUBY_VERSION: _trunk
+
+matrix:
+  allow_failures:
+    - RUBY_VERSION: _trunk
+
+install:
+  - ps: . { iwr -useb https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/appveyor.ps1 } | iex
+  - refreshenv
+
+build_script:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle update
+  - bundle install
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake
+

data/lib/asciidoctor/m3d/biblio.rng

@@ -156,9 +156,9 @@
       <zeroOrMore>
         <ref name="contact"/>
       </zeroOrMore>
-      <optional>
+      <zeroOrMore>
         <ref name="uri"/>
-      </optional>
+      </zeroOrMore>
     </element>
   </define>
   <define name="fullname">
@@ -246,9 +246,9 @@
       <optional>
         <ref name="abbreviation"/>
       </optional>
-      <optional>
+      <zeroOrMore>
         <ref name="uri"/>
-      </optional>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="org-identifier"/>
       </zeroOrMore>
@@ -469,12 +469,13 @@
       <value>film</value>
       <value>video</value>
       <value>broadcast</value>
-      <value>graphic work</value>
+      <value>graphic_work</value>
       <value>music</value>
       <value>patent</value>
       <value>inbook</value>
       <value>incollection</value>
       <value>inproceedings</value>
+      <value>journal</value>
     </choice>
   </define>
   <define name="BibliographicItem">
@@ -739,39 +740,44 @@
     <element name="series">
       <optional>
         <attribute name="type">
-          <choice>
-            <value>main</value>
-            <value>alt</value>
-          </choice>
+          <ref name="SeriesType"/>
         </attribute>
       </optional>
       <choice>
-        <ref name="btitle"/>
         <ref name="formattedref"/>
+        <group>
+          <ref name="btitle"/>
+          <optional>
+            <ref name="bplace"/>
+          </optional>
+          <optional>
+            <ref name="seriesorganization"/>
+          </optional>
+          <optional>
+            <ref name="abbreviation"/>
+          </optional>
+          <optional>
+            <ref name="seriesfrom"/>
+          </optional>
+          <optional>
+            <ref name="seriesto"/>
+          </optional>
+          <optional>
+            <ref name="seriesnumber"/>
+          </optional>
+          <optional>
+            <ref name="seriespartnumber"/>
+          </optional>
+        </group>
       </choice>
-      <optional>
-        <ref name="bplace"/>
-      </optional>
-      <optional>
-        <ref name="seriesorganization"/>
-      </optional>
-      <optional>
-        <ref name="abbreviation"/>
-      </optional>
-      <optional>
-        <ref name="seriesfrom"/>
-      </optional>
-      <optional>
-        <ref name="seriesto"/>
-      </optional>
-      <optional>
-        <ref name="seriesnumber"/>
-      </optional>
-      <optional>
-        <ref name="seriespartnumber"/>
-      </optional>
     </element>
   </define>
+  <define name="SeriesType">
+    <choice>
+      <value>main</value>
+      <value>alt</value>
+    </choice>
+  </define>
   <define name="seriesorganization">
     <element name="organization">
       <text/>
@@ -849,6 +855,7 @@
           <value>includes</value>
           <value>instance</value>
           <value>partOf</value>
+          <value>hasDraft</value>
         </choice>
       </attribute>
       <element name="bibitem">
@@ -861,9 +868,6 @@
   </define>
   <define name="version">
     <element name="version">
-      <optional>
-        <ref name="vedition"/>
-      </optional>
       <optional>
         <ref name="revision-date"/>
       </optional>

data/lib/asciidoctor/m3d/converter.rb

@@ -87,7 +87,7 @@ module Asciidoctor
         result << "</m3d-standard>"
         result = textcleanup(result)
         ret1 = cleanup(Nokogiri::XML(result))
-        validate(ret1)
+        validate(ret1) unless @novalid
         ret1.root.add_namespace(nil, M3D_NAMESPACE)
         ret1
       end

data/lib/asciidoctor/m3d/isodoc.rng

@@ -18,6 +18,7 @@
   of this.
 -->
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <include href="reqt.rng"/>
   <include href="biblio.rng">
     <define name="status">
       <element name="status">

data/lib/asciidoctor/m3d/reqt.rng

@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/metanorma/m3d/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module M3d
-    VERSION = "1.1.2"
+    VERSION = "1.1.3"
   end
 end

data/metanorma-m3d.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
     Formerly known as asciidoctor-m3d.
   DESCRIPTION
 
-  spec.homepage      = "https://github.com/riboseinc/metanorma-m3d"
+  spec.homepage      = "https://github.com/metanorma/metanorma-m3d"
   spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-m3d
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -353,6 +353,7 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
+- appveyor.yml
 - asciidoctor-m3d.gemspec.old
 - bin/console
 - bin/rspec
@@ -363,6 +364,7 @@ files:
 - lib/asciidoctor/m3d/isodoc.rng
 - lib/asciidoctor/m3d/isostandard.rng
 - lib/asciidoctor/m3d/m3d.rng
+- lib/asciidoctor/m3d/reqt.rng
 - lib/isodoc/m3d/html/dots-w@2x.png
 - lib/isodoc/m3d/html/dots@2x.png
 - lib/isodoc/m3d/html/header.html
@@ -389,7 +391,7 @@ files:
 - lib/metanorma/m3d/processor.rb
 - lib/metanorma/m3d/version.rb
 - metanorma-m3d.gemspec
-homepage: https://github.com/riboseinc/metanorma-m3d
+homepage: https://github.com/metanorma/metanorma-m3d
 licenses:
 - BSD-2-Clause
 metadata: {}