metanorma-cli 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d56ad13dd0769d20cb8219b79864798de2036d0a31c786830ac2fb1598d2a3b3
-  data.tar.gz: bea42f15d9e357f3cf073a388f4b1b63ac6f4475770c78fc8c2d94afeb718588
+  metadata.gz: '091411b942b05ba5583d7613e800312a725fb5956fce0b96dd284759cd3a1fc8'
+  data.tar.gz: 134548ea436a6b47454312c829c604b7b58e9efe467330aef7d7c9bbc95a8021
 SHA512:
-  metadata.gz: 63945a3cc26ce7c4df4be425a1a4db795a828f76addb3f2c217864c8f302b4a4a2f60847a28b12673458a8bbe6eb61f663e165980faaf842346d99c306803a95
-  data.tar.gz: ffbd2baa2b5bd2e23c743a0f469a4742b8e00bec9e078e7306198dbaf42ab5086bd9450c1a92c17aefd1c032fdbf9d3a0d62d56da1ad7471939afe8c86f3d47b
+  metadata.gz: 5b34cd82f00fb76d19ebb57e9eab674fdabbfc1420599994ab22d8b71e9495085bbef0d2022f22e21a9c7db1adc5c292b1f27ffad4234aa811af2e294d4887f0
+  data.tar.gz: 66b0b5f550508f8e3e6085d7fe7eaadb1bc631d914421e9db26d767c15f109e810036e3b2bc59f09e4fb653aaa1bb5c057826d797118d2704ff5a605a3efa9a6

data/docs/installation.adoc

@@ -0,0 +1,22 @@
+= Installation
+
+The `metanorma` command-line executable gets installed via a Ruby gem.
+Depending on your use case, you may need to install Puppeteer Node package.
+
+== Installing the Metanorma CLI gem
+
+[source,console]
+----
+gem install metanorma-cli
+----
+
+== Installing 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 at least 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`

data/docs/navigation.adoc

@@ -0,0 +1,9 @@
+---
+sections:
+- name: Introduction
+  items:
+    - installation
+    - usage
+---
+
+= Navigation

data/docs/usage.adoc

@@ -0,0 +1,74 @@
+= Usage
+
+Help command:
+
+[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
+----
+
+Basically it is used like this:
+
+[source,sh]
+----
+$ 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
+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, 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
+----
+
+`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.
+
+[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
+----

data/exe/metanorma

@@ -2,6 +2,8 @@
 
 require "optparse"
 require "metanorma"
+require "fileutils"
+require "nokogiri"
 
 registry = Metanorma::Registry.instance
 
@@ -20,13 +22,13 @@ supported_gem_paths = [
 puts "[metanorma] detecting backends:"
 supported_gem_paths.each do |backend|
   begin
-    puts backend
+    # puts backend
     require backend
   rescue LoadError
-    puts "[metanorma] backend #{backend} not present"
+    puts "[metanorma] Error: backend #{backend} not present"
   end
 end
-puts
+# puts
 
 options = {
   format: :asciidoc
@@ -67,6 +69,24 @@ opt_parser = OptionParser.new do |opts|
     "Print version of code (accompanied with -t)",
   ) { options[:version] = true }
 
+  opts.on(
+    '-w',
+    '--wrapper',
+    'Create wrapper folder for HTML output'
+  ) { options[:wrapper] = true }
+
+  opts.on(
+    '-d',
+    '--data-uri-image',
+    'Encode HTML output images as data URIs'
+  ) { options[:datauriimage] = true }
+
+  opts.on(
+    '-R',
+    '--relaton FILENAME',
+    'Export Relaton XML for document to nominated filename'
+  ) { |v| options[:relaton] = v }
+
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -93,15 +113,29 @@ end
 
 options[:filename] = ARGV.pop
 
-unless options[:type]
+standard_type = options[:type]
+unless standard_type
   puts "[metanorma] Error: Please specify a standard type."
   puts opt_parser.help
   exit 0
 end
 
-unless registry.supported_backends.include? options[:type]
-  puts "[metanorma] Error: #{options[:type]} is not a supported standard type."
-  exit 0
+unless registry.supported_backends.include? standard_type
+  puts "[metanorma] Warning: #{standard_type} is not a default standard type."
+  puts "[metanorma] Info: Attempting to load `metanorma-#{standard_type}` gem for standard type `#{standard_type}`."
+
+  begin
+    require "metanorma-#{standard_type}"
+    puts "[metanorma] Info: gem `metanorma-#{standard_type}` loaded."
+  rescue LoadError
+    puts "[metanorma] Error: loading gem `metanorma-#{standard_type}` failed. Exiting."
+    exit 0
+  end
+
+  unless registry.supported_backends.include? standard_type
+    puts "[metanorma] Error: The `metanorma-#{standard_type}` gem still doesn't support `#{standard_type}`. Exiting."
+    exit 0
+  end
 end
 
 unless options[:format] == :asciidoc
@@ -134,11 +168,28 @@ when :asciidoc
 
   file = File.read(options[:filename], encoding: "utf-8")
   isodoc = processor.input_to_isodoc(file)
+
+  if options[:relaton]
+    xml = Nokogiri::XML(isodoc)
+    bibdata = xml.at("//xmlns:bibdata")
+    # require "byebug"; byebug
+    #docid = bibdata&.at("./xmlns:docidentifier")&.text || options[:filename]
+    #outname = docid.sub(/^\s+/, "").sub(/\s+$/, "").gsub(/\s+/, "-") + ".xml"
+    File.open(options[:relaton], "w:UTF-8") { |f| f.write bibdata.to_xml }
+  end
+
   isodoc_options = processor.extract_options(file)
+  isodoc_options[:datauriimage] = true if options[:datauriimage]
   extensions.each do |ext|
     file_extension = processor.output_formats[ext]
     outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
     processor.output(isodoc, outfilename, ext, isodoc_options)
+    if options[:wrapper] and /html$/.match file_extension
+      outfilename = outfilename.sub(/\.html$/, "")
+      FileUtils.mkdir_p outfilename
+      FileUtils.mv "#{outfilename}.html", outfilename
+      FileUtils.mv "#{outfilename}_images", outfilename
+    end
   end
 end
 

data/exe/metanorma-manifest

@@ -0,0 +1,177 @@
+#!/usr/bin/env ruby
+
+require "yaml"
+require "optparse"
+require "metanorma"
+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|
+  begin
+    puts backend
+    require backend
+  rescue LoadError
+    puts "[metanorma] backend #{backend} not present"
+  end
+end
+puts
+
+options = {}
+
+def uuid()
+  UUIDTools::UUID.random_create
+end
+
+def extract_documents(m)
+  return [] unless m and m["sections"]
+  ret = []
+  m["sections"].each do |s|
+    ret << s if s["file"]
+    ret << extract_documents(s) if s["sections"]
+  end
+  ret.flatten
+end
+
+def hyperlink(link, suffix)
+  return unless link
+  link.sub(/\.adoc(?=$|#)/, ".#{suffix}")
+end
+
+def iterate(sections, options)
+  return "" unless sections
+  ret = ""
+  Array(sections).each do |m|
+    ret+= "<clause id='#{uuid}'>\n"
+    title = m["title"] && m["number"] ? "#{m['number']}. #{m['title']}" : ( m["number"] || m["title"] || "&mdash;" )
+    ret+= "<title>#{title}</title>\n"
+    ret+= "<p>#{m["type"]}</p>\n" if m["type"]
+    if m["file"]
+      ret += "<p>"
+      file = hyperlink(m["file"], "html")
+      ret += "<link target='#{file}'>HTML</link> |" if file
+      file = hyperlink(m["file"], "pdf")
+      ret += "<link target='#{file}'>PDF</link> |" if file
+      file = hyperlink(m["file"], "xml")
+      ret += "<link target='#{file}'>XML</link> " if file
+      if options[:relaton]
+        file = URI.escape("#{options[:relaton]}/id/#{m['number']}.xml")
+        ret += "| <link target='#{file}'>Relaton XML</link> "
+      end
+      ret += "</p>\n"
+    end
+    ret+= "<p>#{m['description']}</p>\n" if m["description"]
+    if m["revdate"]
+      if m["status"]
+        ret+= "<p>STAGE: #{m["status"]} (#{m['revdate']})</p>\n"
+      else
+        ret+= "<p align='right'>#{m['revdate']}</p>\n"
+      end
+    else
+      if m["status"]
+        ret+= "<p>STAGE: #{m["status"]}</p>\n"
+      end
+    end
+    ret += iterate(m["sections"], options)
+    ret+= "</clause>\n"
+  end
+  ret
+end
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner += " <file>"
+  opts.on(
+    '-t',
+    '--type TYPE',
+    "Type of standard to generate"
+  ) { |v| options[:type] = v.to_sym }
+
+  opts.on(
+    '-r',
+    '--require LIBRARY',
+    'Require LIBRARY prior to execution'
+  ) { |v|
+    options[:require] ||= []
+    options[:require] << v
+  }
+
+  opts.on(
+    '-R dir',
+    '--relaton',
+    "Insert links to relaton XML, generated by relaton-server-csd, with root directory dir (/id/xxxx is supplied)"
+  ) { |v| options[:relaton] = v }
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+opt_parser.parse!(ARGV)
+options[:filename] = ARGV.pop
+
+if options[:require]
+  options[:require].each do |r|
+    require r
+  end
+end
+
+manifest = YAML.load_file(options[:filename])
+
+documents = extract_documents(manifest)
+
+# TODO real lookup of namespaces and root elements
+
+out = <<~END
+<#{options[:type]}-standard xmlns="http://riboseinc.com/isoxml">
+<bibdata type="standard">
+  <title>#{manifest["title"]}</title>
+END
+
+# TODO leave in anchor references?
+#
+documents.each do |d|
+  out += <<~END
+  <relation type="partOf">
+    <bibdata type="standard">
+      <title>#{d['title']}</title>
+      <docidentifier>#{d['number']}</docidentifier>
+      <abstract>#{d['description']}</abstract>
+    </bibdata>
+  </relation>
+  END
+end
+
+out += <<~END
+</bibdata>
+<sections>
+END
+
+out+=iterate(manifest["sections"], options)
+
+out+= <<~END
+</sections>
+<#{options[:type]}-standard>
+END
+outfilename = options[:filename].sub(/\.[^.]+$/, ".xml")
+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] 
+outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
+isodoc_options = { suppressheadingnumbers: true }
+isodoc_options[:htmlstylesheet] = manifest["htmlstylesheet"] if manifest["htmlstylesheet"]
+processor.output(out, outfilename, ext, isodoc_options)

data/lib/metanorma-cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module CLI
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end
 end

data/metanorma-cli.gemspec

@@ -33,15 +33,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-core', "~> 3.4"
 
 
-  spec.add_runtime_dependency 'metanorma-iso', "~> 1.0.1"
+  spec.add_runtime_dependency 'metanorma-iso', "~> 1.0.6"
   spec.add_runtime_dependency 'asciidoctor-rfc', "~> 0.9.0"
-  spec.add_runtime_dependency 'metanorma-gb', "~> 1.0.1"
-  spec.add_runtime_dependency 'metanorma-csd', "~> 1.0.1"
-  spec.add_runtime_dependency 'metanorma-csand', "~> 1.0.1"
-  spec.add_runtime_dependency 'metanorma-rsd', "~> 1.0.1"
-  spec.add_runtime_dependency 'metanorma-m3d', "~> 1.0.1"
-  spec.add_runtime_dependency 'metanorma-acme', "~> 1.0.0"
-  spec.add_runtime_dependency 'metanorma-standoc', "~> 1.0.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"
+  spec.add_runtime_dependency 'metanorma-rsd', "~> 1.0.5"
+  spec.add_runtime_dependency 'metanorma-m3d', "~> 1.0.6"
+  spec.add_runtime_dependency 'metanorma-acme', "~> 1.0.1"
+  spec.add_runtime_dependency 'metanorma-standoc', "~> 1.0.6"
   spec.add_runtime_dependency 'isodoc', "~> 0.9.0"
   spec.add_runtime_dependency 'metanorma', "~> 0.2.6"
+  spec.add_runtime_dependency 'nokogiri'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: asciidoctor-rfc
   requirement: !ruby/object:Gem::Requirement
@@ -142,98 +142,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: metanorma-csd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: metanorma-csand
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: metanorma-rsd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: metanorma-m3d
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: metanorma-acme
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
@@ -262,11 +262,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Executable to process any Metanorma standard.
 email:
 - open.source@ribose.com
 executables:
 - metanorma
+- metanorma-manifest
 extensions: []
 extra_rdoc_files:
 - README.adoc
@@ -280,7 +295,11 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
+- docs/installation.adoc
+- docs/navigation.adoc
+- docs/usage.adoc
 - exe/metanorma
+- exe/metanorma-manifest
 - i18n.yaml
 - lib/metanorma-cli.rb
 - lib/metanorma-cli/version.rb