metanorma-cli 1.3.2 → 1.3.6

data/docs/installation.adoc

@@ -0,0 +1,61 @@
+= Installation
+
+You can get the `metanorma` command-line executable by installing this Ruby gem.
+
+[IMPORTANT]
+====
+To install the Metanorma toolchain we recommend to use one of the ways described in
+https://www.metanorma.com/author/topics/install/[Metanorma installation] topic.
+Installing this gem by hand may not be the easiest way.
+
+When following this installation method, to start building documents you may have to take care
+of manually installing some required third-party software as well.
+Which exactly depends on what documents you’re building, below notes cover some of that.
+====
+
+
+== Installing the Metanorma CLI gem
+
+[source,console]
+----
+gem install metanorma-cli
+----
+
+Installing the gem will also install all officially supported Metanorma flavors
+(such as ISO, CalConnect, IETF, etc).
+
+
+== Dependencies
+
+=== Java
+
+You will have to have a Java runtime installed. (Use `brew cask install java` on macOS.)
+
+=== Puppeteer
+
+*If you are going to generate PDFs from HTML* (which applies to CalConnect Standard Documents),
+you will also need to install the https://github.com/GoogleChrome/puppeteer[Puppeteer] Node library.
+
+* Ensure you have Node of at least version 7.6.0:
+** https://nodejs.org/en/download/
+** On macOS you should be able to `brew install node`
+* Ensure you have NPM: https://docs.npmjs.com/getting-started/installing-node
+* Install Puppeteer globally in your system: `npm install -g --save --save-exact puppeteer`
+
+=== PlantUML
+
+*If your documents include link:/author/topics/document-format/diagrams/[PlantUML diagrams]*,
+PlantUML will have to be installed.
+
+* `brew install plantuml` on MacOS.
+* For Linux, link the PlantUML jar file into a command line executable; see
+`.travis.yml` for an example.
+
+If PlantUML is not installed locally, the source PlantUML is incorporated into
+the output document as sourcecode.
+
+
+== Installation notes for Windows
+
+To be able to compile gem with a native extension you must have `RIDK` installed.
+If you are installing metanorma with chocolatey installation script will do this for you

data/docs/navigation.adoc

@@ -0,0 +1,7 @@
+---
+items:
+  - { title: Installation, path: installation/ }
+  - { title: Usage, path: usage/ }
+---
+
+= Navigation

data/docs/usage.adoc

@@ -0,0 +1,74 @@
+= Using the Metanorma CLI
+
+== Usage sample
+
+[source,sh]
+----
+$ metanorma --type iso -x html iso-my-standard-document.adoc
+----
+
+== Full syntax & options
+
+[source,sh]
+----
+$ metanorma --type <chosen-type> \
+  [--format input-format] \
+  [--extensions EXT1,EXT2...] \
+  iso-my-standard-document.adoc
+----
+
+`type`:: (mandatory, specified via `--type` or `-t`) takes one of the following types:
+`rfc2`, `rfc3`, `iso`, `gb`, `csd`, `csand`, `m3d`, `rsd`. Each of these corresponds to a
+standards class and a Metanorma gem; the list of standards classes supported by the script
+by default will grow (see also `require`).
+
+`extension`:: (optional) specifies the output formats to be generated. If not specified,
+all possible output formats are generated. The output formats generated are constrained by
+what has been defined for each standard type. All standards can generate Metanorma XML (`xml`),
+and at least one of HTML (`html`), DOC (`doc`), PDF (`pdf`). Some standards generate alternative
+HTML renderings (e.g. `html_alt` for ISO).
+
+`wrapper`:: create a separate folder for each instance of HTML output generated; the folder is named
+the same as the output file, without the `.html` suffix. Used to make distribution of HTML outputs
+more straightforward.
+
+`format`:: (optional, defaults to `asciidoc`, specified via `--format` or `-f`) only accepts `asciidoc` for now
+
+`require`:: If you wish to use metanorma with a document class which has not been included in the types recognised
+by the metanorma script, you will need to name the corresponding Metnorma gem explicitly with the `-r`
+option. For example:
+
+[source,sh]
+----
+$ metanorma -t mpfd mpfd-bpn.adoc
+
+[metanorma] Error: mpfd is not a supported standard type.
+
+$ metanorma -t mpfd -r metanorma-mpfd mpfd-bpn.adoc
+----
+
+== Command-line help
+
+[source,sh]
+----
+$ metanorma -h
+Usage: metanorma [options] <file>
+  -t, --type TYPE                       Type of standard to generate: rfc2, rfc3, iso, gb, csd, csand, m3d
+  -x, --extensions EXT1,EXT2,... | all  Type of extension to generate per type:
+  {
+    :rfc2=>{:xmlrfc=>"v2.xml"},
+    :rfc3=>{:xmlrfc=>"v3.xml"},
+    :iso=>{:html=>"html", :html_alt=>"alt.html", :doc=>"doc"},
+    :gb=>{:html=>"html", :doc=>"doc"},
+    :csd=>{:html=>"html", :pdf=>"pdf"},
+    :csand=>{:html=>"html"},
+    :m3d=>{:html=>"html", :doc=>"doc"},
+    :rsd=>{:html=>"html"}
+  }
+  In addition, xml (outside of rfc2, rfc3) generates IsoDoc XML. If the argument is "all" or the option is
+  missing, all available extensions are generated.
+  -f, --format FORMAT              Format of source file: asciidoc (current default, only format supported)
+  -r, --require LIBRARY            Require LIBRARY prior to execution
+  -w, --wrapper                    Create wrapper folder for HTML output
+  -h, --help                       Show this message
+----

data/lib/metanorma/cli/command.rb

@@ -54,6 +54,7 @@ module Metanorma
       option :format, aliases: "-f", default: :asciidoc, desc: "Format of source file: eg. asciidoc"
 
       def version
+        Metanorma::Cli.load_flavors
         backend_version(options[:type]) || supported_backends
       rescue NameError => error
         UI.say(error)
@@ -85,8 +86,14 @@ module Metanorma
               font: font,
               term_agreement: options[:agree_to_terms],
             )
+          rescue Fontist::Errors::LicensingError
+            UI.error(
+              "[error]: License acceptance required to install a necessary font." \
+              "Accept required licenses with: `metanorma setup --agree-to-terms`."
+            )
+            return
           rescue Fontist::Errors::NonSupportedFontError
-            UI.say("[info]: Font `#{font}` is not supported yet!")
+            UI.say("[info]: The font `#{font}` is not yet supported.")
           end
         end
       end
@@ -120,7 +127,7 @@ module Metanorma
       end
 
       def find_backend(type)
-        require "metanorma-#{type}"
+        load_flavours(type)
         Metanorma::Registry.instance.find_processor(type&.to_sym)
       end
 
@@ -161,6 +168,13 @@ module Metanorma
           end
         end.compact.flatten.uniq
       end
+
+      def load_flavours(type)
+        Metanorma::Cli.load_flavors
+        unless Metanorma::Registry.instance.find_processor(type&.to_sym)
+          require "metanorma-#{type}"
+        end
+      end
     end
   end
 end

data/lib/metanorma/cli/setup.rb

@@ -43,7 +43,7 @@ module Metanorma
         begin
           Fontist::Font.find(font_name)
         rescue Fontist::Errors::MissingFontError
-          ask_user_and_download_font(font_name)
+          process_font_installation(font_name)
         end
       end
 
@@ -54,34 +54,18 @@ module Metanorma
         end
       end
 
-      def ask_user_and_download_font(font_name)
-        response = term_agreement ? "yes" : "no"
-        formula = Fontist::Formula.find(font_name)
+      def process_font_installation(font_name)
+        accepted_agreement = term_agreement == true ? "yes" : "no"
 
-        if !term_agreement
-          response = UI.ask(message(formula.license).strip)
-        end
-
-        if response.downcase === "yes"
-          Fontist::Font.install(font_name, confirmation: response)
-        end
+        UI.say(missing_font_message) if !term_agreement
+        Fontist::Font.install(font_name, confirmation: accepted_agreement)
       end
 
-      def message(license)
+      def missing_font_message
         <<~MSG
-        Metanorma has detected that you do not have the necessary fonts installed
-        for PDF generation. The generated PDF will use generic fonts that may not
-        resemble the desired styling. Metanorma can download these files for you
-        if you accept the font licensing conditions for the font #{font_name}.
-
-        ----------
-
-        #{license}
-
-        ----------
-
-        If you want Metanorma to download these fonts for you and indicate your
-        acceptance of the font licenses, type "Yes" / "No":
+          Your system does not have the necessary fonts installed for
+          PDF generation. Without these fonts, the generated PDF will use
+          generic fonts that may not resemble the desired styling.\n
         MSG
       end
     end

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.3.2"
+    VERSION = "1.3.6"
   end
 end

data/metanorma-cli.gemspec

@@ -14,8 +14,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://www.metanorma.com"
   spec.license       = "BSD-2-Clause"
 
+=begin
   spec.files         = Dir['**/*'].reject { |f| f.match(%r{^(test|spec|features|templates|.git)/|.(gem|gif|png|jpg|jpeg|xml|html|doc|pdf|dtd|ent)$}) }
   spec.files        += Dir.glob("templates/base/**", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+=end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
   spec.extra_rdoc_files = %w[README.adoc LICENSE]
   spec.bindir        = "exe"
@@ -32,26 +38,26 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-core", "~> 3.4"
 
   spec.add_runtime_dependency "thor", "~> 1.0"
-  spec.add_runtime_dependency "metanorma-iso", "~> 1.4.0"
-  spec.add_runtime_dependency 'metanorma-ietf', "~> 2.1.0"
-  spec.add_runtime_dependency 'metanorma-gb', "~> 1.4.0"
-  spec.add_runtime_dependency 'metanorma-iec', "~> 1.1.0"
-  spec.add_runtime_dependency 'metanorma-cc', "~> 1.4.0"
-  spec.add_runtime_dependency 'metanorma-csa', "~> 1.5.0"
-  #spec.add_runtime_dependency 'metanorma-ribose', "~> 1.5.0"
-  spec.add_runtime_dependency 'metanorma-m3aawg', "~> 1.4.0"
-  spec.add_runtime_dependency 'metanorma-generic', "~> 1.5.0"
-  spec.add_runtime_dependency 'metanorma-standoc', "~> 1.4.0"
-  #spec.add_runtime_dependency 'metanorma-mpfa', "~> 0.4.0"
-  spec.add_runtime_dependency 'metanorma-un', "~> 0.4.0"
-  spec.add_runtime_dependency 'metanorma-ogc', "~> 1.1.0"
-  spec.add_runtime_dependency 'metanorma-nist', "~> 1.1.0"
-  spec.add_runtime_dependency 'metanorma-itu', "~> 1.1.0"
-  spec.add_runtime_dependency 'metanorma-iho', "~> 0.1.0"
-  spec.add_runtime_dependency 'isodoc', "~> 1.1.0"
+  spec.add_runtime_dependency "metanorma-iso", "~> 1.5.0"
+  spec.add_runtime_dependency 'metanorma-ietf', "~> 2.2.0"
+  spec.add_runtime_dependency 'metanorma-gb', "~> 1.5.0"
+  spec.add_runtime_dependency 'metanorma-iec', "~> 1.2.0"
+  spec.add_runtime_dependency 'metanorma-cc', "~> 1.5.0"
+  spec.add_runtime_dependency 'metanorma-csa', "~> 1.6.0"
+  #spec.add_runtime_dependency 'metanorma-ribose', "~> 1.6.0"
+  spec.add_runtime_dependency 'metanorma-m3aawg', "~> 1.5.0"
+  spec.add_runtime_dependency 'metanorma-generic', "~> 1.6.0"
+  spec.add_runtime_dependency 'metanorma-standoc', "~> 1.5.0"
+  #spec.add_runtime_dependency 'metanorma-mpfa', "~> 0.5.0"
+  spec.add_runtime_dependency 'metanorma-un', "~> 0.5.0"
+  spec.add_runtime_dependency 'metanorma-ogc', "~> 1.2.0"
+  spec.add_runtime_dependency 'metanorma-nist', "~> 1.2.0"
+  spec.add_runtime_dependency 'metanorma-itu', "~> 1.2.0"
+  spec.add_runtime_dependency 'metanorma-iho', "~> 0.2.0"
+  spec.add_runtime_dependency 'isodoc', "~> 1.2.0"
   spec.add_runtime_dependency 'metanorma', "~> 1.1.0"
   #spec.add_runtime_dependency 'nokogiri', ">= 1"
   spec.add_runtime_dependency "git", "~> 1.5"
   spec.add_runtime_dependency "relaton-cli", ">= 0.8.2"
-  spec.add_runtime_dependency "fontist", "~> 1.0"
+  spec.add_runtime_dependency "fontist", "~> 1.3.0"
 end

data/templates/base/.github/workflows/docker.yml

@@ -0,0 +1,74 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: docker
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/test.yml
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
+      - Makefile.win
+  repository_dispatch:
+    types: [ metanorma/metanorma-docker ]
+
+jobs:
+  test-docker:
+    runs-on: ubuntu-latest
+    container: docker://metanorma/mn
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || github.token }}
+          submodules: true
+      - name: Setup fonts
+        run: |
+          metanorma setup --agree-to-terms
+      - uses: actions/setup-go@v2-beta
+        with:
+          go-version: '^1.13.1'
+      - name: Install yq
+        run: |
+          GO111MODULE=on go get github.com/mikefarah/yq/v3
+          ln -s $GOPATH/bin/yq /usr/local/bin/yq
+      - name: Instal gems from local Gemfile
+        run: |
+          curl -L --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/gemfile-to-bundle-add.sh | bash
+      - name: Build document in the Metanorma container
+        env:
+          LC_ALL: C.UTF-8
+          LANG: C.UTF-8
+          LANGUAGE: C.UTF-8
+        run: |
+          make clean all publish
+      - uses: actions/upload-artifact@master
+        with:
+          name: published
+          path: published
+
+  deploy-gh-pages:
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    needs: test-docker
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/download-artifact@v1
+      with:
+        name: published
+    - name: Deploy to GH Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        deploy_key: ${{ secrets.GH_DEPLOY_KEY }}
+        publish_dir: ./published
+        force_orphan: true
+        user_name: ${{ github.actor }}
+        user_email: ${{ format('{0}@users.noreply.github.com', github.actor) }}
+        commit_message: "${{ format('Deploy to GitHub Pages: {0}', github.sha) }}"
+    - uses: kolpav/purge-artifacts-action@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        expire-in: 0

data/templates/base/.github/workflows/macos.yml

@@ -0,0 +1,50 @@
+# 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/test.yml
+      - .github/workflows/docker.yml
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
+      - Makefile.win
+
+jobs:
+  test-macos:
+    name: Test on macOS
+    runs-on: macos-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || github.token }}
+          submodules: true
+      - name: Cache xml2rfc
+        id: cache-xml2rfc
+        uses: actions/cache@v1
+        with:
+          path: ~/.cache/xml2rfc
+          key: xml2rfc
+          restore-key: xml2rfc
+      - name: Use Metanorma
+        run: |
+          brew update
+          brew install yq
+          brew install https://raw.githubusercontent.com/metanorma/homebrew-metanorma/master/Formula/metanorma.rb
+          metanorma version
+      - name: Setup Fonts
+        run: |
+          metanorma setup --agree-to-terms
+      - name: Install bundler
+        run: |
+          sudo gem install bundler
+      - name: Metanorma compile
+        env:
+          JAVA_OPTS: "java.awt.headless=true"
+        run: |
+          source $(brew --prefix metanorma)/libexec/venv/bin/activate
+          make clean all

data/templates/base/.github/workflows/ubuntu.yml

@@ -0,0 +1,55 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/test.yml
+      - .github/workflows/macos.yml
+      - .github/workflows/docker.yml
+      - .github/workflows/windows.yml
+      - Makefile.win
+
+jobs:
+  test-linux:
+    name: Test on Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || github.token }}
+          submodules: true
+      - name: Cache xml2rfc
+        id: cache-xml2rfc
+        uses: actions/cache@v1
+        with:
+          path: ~/.cache/xml2rfc
+          key: xml2rfc
+          restore-key: xml2rfc
+      - name: Use Metanorma
+        run: |
+          sudo apt-get update
+          curl -L https://raw.githubusercontent.com/metanorma/metanorma-linux-setup/master/ubuntu.sh | sudo bash
+          sudo chown -R $USER:$(id -gn $USER) $HOME/.config
+      - name: Setup Fonts
+        run: |
+          sudo gem install rake metanorma-cli
+          sudo metanorma setup --agree-to-terms
+      - name: Install yq
+        run: |
+          sudo snap install yq
+          echo "::add-path::/snap/bin"
+      - name: Install bundler
+        run: |
+          sudo gem install bundler
+      - name: Metanorma compile
+        env:
+          JAVA_OPTS: "java.awt.headless=true"
+        run: |
+          source $HOME/.nvm/nvm.sh
+          nvm use mn-node
+          make clean all publish