metanorma 1.1.5 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42020b6888a6b5d4d11678cc5d3d217e93ced978e477d05fee31a6593722f78b
-  data.tar.gz: 4379ba9bcf18655c119598b44ead30f223d843edb33ce53205d4ad6c16826904
+  metadata.gz: 9718bdc06f44f31d38c70b61597971da40b59aec92c34803fd90dee5a9737ef3
+  data.tar.gz: b4441a0010cc32bcea52b79533649bdde985f3a18054827f039346c1db0ba296
 SHA512:
-  metadata.gz: 67525ff08b409c36a90cc8725dc150a518b2c3888f0b3518cc83113b51dcc739ba89120681fe0c2e36c4c6b8771178afe1abe25c64887aee93b29fb055c82a4e
-  data.tar.gz: c0f35a9f5f0e3b0397fb0f81eaf84b90be85f09af4cb99a25e9ac146e0b9658c0b0c26883015c0a8979d656f12d57f5dc0cb24f1af92fa1cb9c58ba7f5e13a90
+  metadata.gz: ed6c60df3dc293db574f7484e918deda0de754d23696e95834d30856bbc8c6a0917aebf15d0fad56e13bc7bfc5ef133b9554e92a679f949ac6495171bcc77025
+  data.tar.gz: 5c65c98e7194b3a366977a356d9f44fdbc3f2b2ebf4d871ee76b8f040f7ef824d540eccc82850c1e06908058210ed2cf2f58740388eee29fd63c977b6a80fa78

data/.github/workflows/notify.yml

@@ -0,0 +1,47 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: notify
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+
+jobs:
+  notify:
+    name: Notify dependent repos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger repositories
+        env:
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+        run: |
+          curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
+          [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $TEMPLATE_REPOS" $SAMPLES_REPOS"
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
+          done
+
+      - name: Trigger release repositories
+        if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')
+        env:
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+        run: |
+          curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
+          [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $DEPENDENT_REPOS
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
+          done

data/.github/workflows/rake.yml

@@ -0,0 +1,59 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Use Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Update gems
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run specs
+        run: bundle exec rake
+
+  notify:
+    name: Trigger notify workflow
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger notify workflow
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/README.adoc

@@ -1,9 +1,7 @@
 = Metanorma: the standard for standards
 
 image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
-image:https://github.com/metanorma/metanorma/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/metanorma/actions?query=workflow%3Aubuntu"]
-image:https://github.com/metanorma/metanorma/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/metanorma/actions?query=workflow%3Amacos"]
-image:https://github.com/metanorma/metanorma/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/metanorma/actions?query=workflow%3Awindows"]
+image:https://github.com/metanorma/metanorma/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma.svg["Pull Requests", link="https://github.com/metanorma/metanorma/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma/releases"]

data/lib/metanorma/collection.rb

@@ -12,10 +12,10 @@ module Metanorma
 
     # @return [Array<String>] documents-inline to inject the XML into
     #   the collection manifest; documents-external to keeps them outside
-    attr_reader :directives
+    attr_accessor :directives
 
     # @return [Hash<String, Metanorma::Document>]
-    attr_reader :documents
+    attr_accessor :documents
 
     # @param file [String] path to source file
     # @param directives [Array<String>] documents-inline to inject the XML into
@@ -47,7 +47,7 @@ module Metanorma
       Nokogiri::XML::Builder.new do |xml|
         xml.send("metanorma-collection",
                  "xmlns" => "http://metanorma.org") do |mc|
-          @bibdata.to_xml mc, bibdata: true, date_format: :full
+          mc << @bibdata.to_xml(bibdata: true, date_format: :full)
           @manifest.to_xml mc
           content_to_xml "prefatory", mc
           doccontainer mc

data/lib/metanorma/collection_renderer.rb

@@ -49,9 +49,32 @@ module Metanorma
       folder = File.dirname col.file
       cr = new(col.to_xml, folder, options)
       cr.files
+      cr.concatenate(col, options)
       cr.coverpage if options[:format]&.include?(:html)
     end
 
+    def concatenate(col, options)
+      options[:format] << :presentation if options[:format].include?(:pdf)
+      options[:format].uniq.each do |e|
+        next unless %i(presentation xml).include?(e)
+        ext = e == :presentation ? "presentation.xml" : e.to_s
+        out = col.clone
+        out.directives << "documents-inline"
+        out.documents.keys.each do |id|
+          filename = @files[id][:outputs][e]
+          out.documents[id] = Metanorma::Document.raw_file(filename)
+        end
+        File.open(File.join(@outdir, "collection.#{ext}"), "w:UTF-8") { |f| f.write(out.to_xml) }
+      end
+      options[:format].include?(:pdf) and
+        pdfconv.convert(File.join(@outdir, "collection.presentation.xml"))
+    end
+
+    def pdfconv
+      x = Asciidoctor.load nil, backend: @doctype.to_sym
+      x.converter.pdf_converter(Dummy.new)
+    end
+
     # Dummy class
     class Dummy
       def attr(_xyz); end
@@ -106,12 +129,34 @@ module Metanorma
                             end
         file, _filename = targetfile(files[identifier], true)
         xml = Nokogiri::XML(file)
+        add_document_suffix(identifier, xml)
         files[identifier][:anchors] = read_anchors(xml)
         files[identifier][:bibdata] = xml.at(ns("//bibdata"))
       end
       files
     end
 
+    def add_suffix_to_attributes(doc, suffix, tag_name, attribute_name)
+      doc.xpath(ns("//#{tag_name}[@#{attribute_name}]")).each do |elem|
+        elem.attributes[attribute_name].value =
+          "#{elem.attributes[attribute_name].value}_#{suffix}"
+      end
+    end
+
+    def add_document_suffix(identifier, doc)
+      document_suffix = Asciidoctor::Standoc::Cleanup.to_ncname(identifier)
+      [%w[* id],
+      %w[* bibitemid],
+      %w[review from],
+      %w[review to],
+      %w[index to],
+      %w[xref target],
+      %w[callout target]]
+      .each do |(tag_name, attribute_name)|
+        add_suffix_to_attributes(doc, document_suffix, tag_name, attribute_name)
+      end
+    end
+
     # map locality type and label (e.g. "clause" "1") to id = anchor for
     # a document
     def read_anchors(xml)
@@ -220,13 +265,14 @@ module Metanorma
       docid = bib&.at(ns("./docidentifier"))&.text
       unless @files[docid]
         warn "Cannot find crossreference to document #{docid} in document "\
-        "#{identifier}!"
+          "#{identifier}!"
         abort
       end
       id = bib["id"]
       newbib = bib.replace(@files[docid][:bibdata])
       newbib.name = "bibitem"
       newbib["id"] = id
+      newbib["hidden"] = "true"
       newbib&.at(ns("./ext"))&.remove
       _file, url = targetfile(@files[docid], false)
       uri_node = Nokogiri::XML::Node.new "uri", newbib
@@ -247,6 +293,7 @@ module Metanorma
     # @return [String] XML content
     def update_xrefs(file, identifier)
       docxml = Nokogiri::XML(file)
+      add_document_suffix(identifier, docxml)
       docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |b|
         docid = b&.at(ns("./docidentifier[@type = 'repository']"))&.text
         next unless docid && %r{^current-metanorma-collection/}.match(docid)
@@ -254,6 +301,9 @@ module Metanorma
         update_bibitem(b, identifier)
         update_anchors(b, docxml, docid)
       end
+      docxml.xpath(ns("//references[not(./bibitem[not(@hidden) or @hidden = 'false'])]")).each do |f|
+        f["hidden"] = "true"
+      end
       docxml.to_xml
     end
 
@@ -288,9 +338,12 @@ module Metanorma
           # warn "metanorma compile -x html #{f.path}"
           c = Compile.new
           c.compile f.path, format: :asciidoc, extension_keys: @format
-          @format.each do |ext|
+          @files[identifier][:outputs] = {}
+          @format.each do |e|
+            ext = c.processor.output_formats[e]
             fn = File.basename(filename).sub(/(?<=\.)[^\.]+$/, ext.to_s)
             FileUtils.mv f.path.sub(/\.xml$/, ".#{ext}"), File.join(@outdir, fn)
+            @files[identifier][:outputs][e] = File.join(@outdir, fn)
           end
         end
       end

data/lib/metanorma/compile.rb

@@ -5,7 +5,7 @@ require "htmlentities"
 module Metanorma
   class Compile
     # @return [Array<String>]
-    attr_reader :errors
+    attr_reader :errors, :processor
 
     def initialize
       @registry = Metanorma::Registry.instance

data/lib/metanorma/config.rb

@@ -15,7 +15,7 @@ module Metanorma
     attr_accessor :logs
 
     def initialize
-      @logs ||= [:warning, :error]
+      @logs ||= [:warning, :error, :fatal]
     end
   end
 

data/lib/metanorma/document.rb

@@ -4,9 +4,10 @@ module Metanorma
     attr_reader :file
 
     # @param bibitem [RelatonBib::BibliographicItem]
-    def initialize(bibitem, file)
+    def initialize(bibitem, file, options = {})
       @bibitem = bibitem
       @file = file
+      @raw = options[:raw]
     end
 
     class << self
@@ -22,6 +23,12 @@ module Metanorma
         new from_xml(xml)
       end
 
+      # raw XML file, can be used to put in entire file instead of just bibitem
+      def raw_file(filename)
+        doc = Nokogiri::XML(File.read(filename, encoding: "UTF-8"))
+        new(doc, filename, raw: true)
+      end
+
       private
 
       # #param xml [Nokogiri::XML::Document, Nokogiri::XML::Element]
@@ -47,7 +54,7 @@ module Metanorma
         when :xml
           from_xml Nokogiri::XML(File.read(file, encoding: "UTF-8"))
         when :yaml
-          yaml = File.read(file, ecoding: "UTF-8")
+          yaml = File.read(file, encoding: "UTF-8")
           Relaton::Cli::YAMLConvertor.convert_single_file(yaml)
         end
       end
@@ -68,15 +75,19 @@ module Metanorma
 
     # @return [String]
     def type
-      @type ||= (@bibitem.docidentifier.first&.type ||
-        @bibitem.docidentifier.first&.id&.match(/^[^\s]+/)&.to_s)&.downcase ||
-        "standoc"
+      @type ||= (@bibitem.docidentifier.first&.type&.downcase ||
+                 @bibitem.docidentifier.first&.id&.match(/^[^\s]+/)&.to_s)&.downcase ||
+      "standoc"
     end
 
     private
 
     def render_xml(builder)
-      builder.send(type + "-standard") { |b| @bibitem.to_xml b, bibdata: true }
+      if @raw
+        builder << @bibitem.root.to_xml
+      else
+        builder.send(type + "-standard") { |b| b << @bibitem.to_xml(bibdata: true) }
+      end
     end
   end
 end

data/lib/metanorma/output/xslfo.rb

@@ -4,10 +4,10 @@ require_relative "./utils.rb"
 module Metanorma
   module Output
     class XslfoPdf < Base
-      def convert(url_path, output_path, xsl_stylesheet)
+      def convert(url_path, output_path, xsl_stylesheet, options = "")
         return if url_path.nil? || output_path.nil? || xsl_stylesheet.nil?
 
-        Mn2pdf.convert(quote(url_path), quote(output_path), quote(xsl_stylesheet))
+        Mn2pdf.convert(quote(url_path), quote(output_path), quote(xsl_stylesheet), options)
       end
 
       def quote(x)

data/lib/metanorma/util.rb

@@ -6,6 +6,10 @@ module Metanorma
       if log_types.include?(type.to_s)
         puts(message)
       end
+
+      if type == :fatal
+        exit(1)
+      end
     end
   end
 end

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.1.5"
+  VERSION = "1.2.2"
 end

data/metanorma.gemspec

@@ -27,13 +27,17 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'htmlentities'
   spec.add_runtime_dependency 'nokogiri'
   spec.add_runtime_dependency 'mn2pdf', "~> 1"
-  spec.add_dependency "relaton-cli", "~> 1.3.0"
+  spec.add_runtime_dependency 'pry'
+# get relaton-cli to avoic circular reference with metanorma-standoc
+  #spec.add_dependency "relaton-cli"
+  #spec.add_dependency "metanorma-standoc", "~> 1.5.3"
 
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rspec-command", "~> 1.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "metanorma-iso", "~> 1.5"
-  spec.add_development_dependency "isodoc", "~> 1.2.1"
+  spec.add_development_dependency "metanorma-iso", "~> 1.6.0"
+  spec.add_development_dependency "sassc", "~> 2.4.0"
+  #spec.add_development_dependency "isodoc", "~> 1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: relaton-cli
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: isodoc
+  name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 2.4.0
 description: Library to process any Metanorma standard.
 email:
 - open.source@ribose.com
@@ -189,9 +189,8 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".github/workflows/dependent_repos.env"
-- ".github/workflows/macos.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
+- ".github/workflows/notify.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"

data/.github/workflows/macos.yml

@@ -1,38 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: macos
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/ubuntu.yml
-      - .github/workflows/windows.yml
-
-jobs:
-  test-macos:
-    name: Test on Ruby ${{ matrix.ruby }} macOS
-    runs-on: macos-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    steps:
-      - uses: actions/checkout@master
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        run: |
-          sudo gem install bundler --force
-          bundle install --jobs 4 --retry 3
-      - name: Run specs
-        run: |
-          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -1,56 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: ubuntu
-
-on:
-  push:
-    branches: [ master ]
-    tags:
-      - '*'
-  pull_request:
-    paths-ignore:
-      - .github/workflows/macos.yml
-      - .github/workflows/windows.yml
-
-jobs:
-  test-linux:
-    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    steps:
-      - uses: actions/checkout@master
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Run specs
-        run: |
-          bundle exec rake
-      - name: Trigger repositories
-        if: matrix.ruby == '2.6'
-        env:
-          GH_USERNAME: metanorma-ci
-          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
-        run: |
-          curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
-          [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
-          CLIENT_PAYLOAD=$(cat <<EOF
-          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
-          EOF
-          )
-          for repo in $REPOS
-          do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
-          done

data/.github/workflows/windows.yml

@@ -1,40 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-name: windows
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths-ignore:
-      - .github/workflows/macos.yml
-      - .github/workflows/ubuntu.yml
-
-jobs:
-  test-windows:
-    name: Test on Ruby ${{ matrix.ruby }} Windows
-    runs-on: windows-latest
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
-        experimental: [false]
-        include:
-          - ruby: '2.7'
-            experimental: true
-    steps:
-      - uses: actions/checkout@master
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Update gems
-        shell: pwsh
-        run: |
-          gem install bundler
-          bundle config --local path vendor/bundle
-          bundle install --jobs 4 --retry 3
-      - name: Run specs
-        run: |
-          bundle exec rake