metanorma-cli 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e411380736fee742c26d90327890a42550014248b05591221cb176dabe401a12
-  data.tar.gz: 57ecf918537b0632be30d5b8dc2dfc5cee5e66a3879d519095d97cbd2cd8ef8e
+  metadata.gz: 25ce6e4380b3fe1815535001fbb516485891df3b9af58cc0a50e9e8738313b2f
+  data.tar.gz: 97f5d36918af22e7c3eb08fce6fd2e5d5cc5fe2febf83c0c23e7466f1463ddd3
 SHA512:
-  metadata.gz: 465dd38bd86b4052bb8b696006cb22d0df13f0b567528ca374c520b523927b118bdca8a597afd526ac34b3122d30f1c31d6d6b63a968ba18030044b375ba3fd7
-  data.tar.gz: cbbb08fa9bf2aa18d1221d82cc9534c6c989de532f838cb79d00ebdba7761dd003b3530a58d13ce4e16f42567dd09e379ac906101b8e9251b0a271c67114dd7e
+  metadata.gz: d1a274bb3d3734045b77835cb06b3b2c480ba5000e88b168845e1f4b3f5f0f2aa473cc11bf1d7e329908f4a2fa5851f639e81dcacdd2e3932e9d1602e7e52c9b
+  data.tar.gz: 2644de8545d160098b858b122c932a5e656cf9f897dfe63e81233652240a8876a0ca0d072c06e2088cb7249c52a0652845822999a6f0dc242104bc7edcbb50f7

data/docs/usage.adoc

@@ -1,40 +1,22 @@
-= Usage
+= Using the Metanorma CLI
 
-Help command:
+== Usage sample
 
 [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
+$ metanorma --type iso -x html iso-my-standard-document.adoc
 ----
 
-Basically it is used like this:
+== Full syntax & options
 
 [source,sh]
 ----
-$ metanorma --type <chosen-type> [--format input-format] [--extensions EXT1,EXT2...] iso-my-standard-document.adoc
+$ metanorma --type <chosen-type> \
+  [--format input-format] \
+  [--extensions EXT1,EXT2...] \
+  iso-my-standard-document.adoc
 ----
 
-Options:
-
 `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
@@ -50,19 +32,11 @@ HTML renderings (e.g. `html_alt` for ISO).
 the same as the output file, without the `.html` suffix. Used to make distribution of HTML outputs
 more straightforward.
 
-`format`:: (optional, specified via `--format` or `-f`) only accepts `asciidoc` for now,
-defaults to `asciidoc`
-
-As the `--format` argument is (currently) optional, so:
-
-[source,sh]
-----
-$ metanorma --type iso -x html iso-my-standard-document.adoc
-----
+`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; e.g.
+option. For example:
 
 [source,sh]
 ----
@@ -72,3 +46,29 @@ $ metanorma -t mpfd mpfd-bpn.adoc
 
 $ 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/exe/metanorma

@@ -4,25 +4,12 @@ require "optparse"
 require "metanorma"
 require "fileutils"
 require "nokogiri"
+require "metanorma-cli"
 
 registry = Metanorma::Registry.instance
 
-supported_gem_paths = [
-  "asciidoctor-rfc",
-  "metanorma-iso",
-  "metanorma-gb",
-  "metanorma-csd",
-  "metanorma-csand",
-  "metanorma-m3d",
-  "metanorma-rsd",
-  "metanorma-acme",
-  "metanorma-standoc",
-  "metanorma-unece",
-  "metanorma-mpfd",
-]
-
 puts "[metanorma] detecting backends:"
-supported_gem_paths.each do |backend|
+Metanorma::CLI::SUPPORTED_GEMS.each do |backend|
   begin
     # puts backend
     require backend
@@ -40,20 +27,36 @@ opt_parser = OptionParser.new do |opts|
   opts.on(
     '-t',
     '--type TYPE',
-    "Type of standard to generate: #{registry.supported_backends.join(", ")}"
+    String,
+    "Type of standard to generate",
+    "#{registry.supported_backends}"
   ) { |v| options[:type] = v.to_sym }
 
+  output_formats = registry.output_formats.inject([]) do |acc, (processor, formats)|
+    str = "* #{processor.to_s}: "
+
+    formats.each_pair do |type, ext|
+      str << "['#{type.to_s}': #{ext.to_s}] "
+    end
+
+    acc << str
+  end
+
   opts.on(
     '-x',
-    '--extensions EXT1,EXT2,... | all',
+    "--extensions all | EXT,...",
     Array,
-    "Type of extension to generate per type: #{registry.output_formats}\n"
+    "Document extensions available per type (type, ['filetype': ext])",
+    *output_formats
   ) { |v| options[:extension_keys] = v.map(&:to_sym) }
 
+  input_formats = [:asciidoc]
   opts.on(
     '-f',
     '--format FORMAT',
-    'Format of source file: asciidoc (current default, only format supported)'
+    String,
+    'Format of source file',
+    "#{input_formats}",
   ) { |v| options[:format] = v.to_sym }
 
   opts.on(

data/exe/metanorma-manifest

@@ -7,20 +7,9 @@ require "uuidtools"
 require "uri"
 
 registry = Metanorma::Registry.instance
-supported_gem_paths = [
-  "asciidoctor-rfc",
-  "metanorma-iso",
-  "metanorma-gb",
-  "metanorma-csd",
-  "metanorma-csand",
-  "metanorma-m3d",
-  "metanorma-rsd",
-  "metanorma-acme",
-  "metanorma-standoc",
-]
 
 puts "[metanorma] detecting backends:"
-supported_gem_paths.each do |backend|
+Metanorma::CLI::SUPPORTED_GEMS.each do |backend|
   begin
     puts backend
     require backend
@@ -170,7 +159,7 @@ File.open(outfilename, "w") { |f| f.write out }
 
 processor = registry.find_processor(options[:type].to_sym)
 ext = :html
-file_extension = "html" || processor.output_formats[ext] 
+file_extension = "html" || processor.output_formats[ext]
 outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
 isodoc_options = { suppressheadingnumbers: true }
 isodoc_options[:htmlstylesheet] = manifest["htmlstylesheet"] if manifest["htmlstylesheet"]

data/lib/metanorma-cli.rb

@@ -2,5 +2,20 @@ require "metanorma-cli/version"
 
 module Metanorma
   module CLI
+
+    SUPPORTED_GEMS = [
+      "metanorma-iso",
+      "metanorma-ietf",
+      "metanorma-gb",
+      "metanorma-csd",
+      "metanorma-csand",
+      "metanorma-m3d",
+      "metanorma-rsd",
+      "metanorma-acme",
+      "metanorma-standoc",
+      "metanorma-unece",
+      "metanorma-mpfd"
+    ]
+
   end
 end

data/lib/metanorma-cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module CLI
-  VERSION = "1.0.8"
-end
+    VERSION = "1.0.9"
+  end
 end

data/metanorma-cli.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
 
 
   spec.add_runtime_dependency 'metanorma-iso', "~> 1.0.6"
-  spec.add_runtime_dependency 'asciidoctor-rfc', "~> 0.9.0"
+  spec.add_runtime_dependency 'metanorma-ietf', "~> 1.0"
   spec.add_runtime_dependency 'metanorma-gb', "~> 1.0.5"
   spec.add_runtime_dependency 'metanorma-csd', "~> 1.0.5"
   spec.add_runtime_dependency 'metanorma-csand', "~> 1.0.5"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.6
 - !ruby/object:Gem::Dependency
-  name: asciidoctor-rfc
+  name: metanorma-ietf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: metanorma-gb
   requirement: !ruby/object:Gem::Requirement