metanorma-cli 1.4.0 → 1.4.1pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 612b4c15af1376248ef7a54ff2b9391644359954d06d998079955ef691946aeb
-  data.tar.gz: dd83cfa8bbeab98dd8699c90f0d7bbd65923afa6548436cfc87f5352e1df0133
+  metadata.gz: 4a910e2812c1da05b08d76dc9bd6fda1859ef59052c8c902ce11f367bf9fd137
+  data.tar.gz: 32070afaf5c7b460635ae2eb9dc1343259793df5cc6e4e3bebf285310456006f
 SHA512:
-  metadata.gz: 1ce6b2cf16551c745b456fee569ee4a58aed0c66142ee4c7b6a37cc6e57199ebf89a9fe2b725317dfd8e69e865e43e2985c87d2151fe6cd8a8fe23a85daa23b5
-  data.tar.gz: 7133934960cc61e6f41364b6001d77ff28f1f798cf558d606fbdcc17fe7755e960a82b084f929e5f0d1daf1bcefc858920ed7b55e05b20083470766ec1754383
+  metadata.gz: 4c54fa10cf2f4131490ad9e6b030c236a4df6d91972be12ad7a0ed99d49693afc49ee14b7f91f2068655e120c38c54dc699887def94d9b9223cc2ed50ef2f299
+  data.tar.gz: 9330606dcef7ee362afea8218244edc79d33820e3416d04a1b7b1b02ef9f3e3dddfcdc7eab62dffe422ac03fcb57e4df86da0910f027bc00b75a43cd718db41b

data/Gemfile

@@ -4,7 +4,6 @@ Encoding.default_internal = Encoding::UTF_8
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}" }
 
-
 gemspec
 
 if File.exist? 'Gemfile.devel'

data/README.adoc

@@ -228,6 +228,32 @@ Options:
   -c, [--coverpage=COVERPAGE]       # Cover page as Liquid template for collection (currently HTML only)
 ----
 
+=== List supported doctypes (`metanorma list-doctypes`)
+
+You want to know what are the supported doctypes and what do they support for
+input and output format? Well, the `metanorma list-doctypes` can help.
+
+
+[source,sh]
+----
+metanorma list-doctypes
+----
+
+
+To list out the details for a specific flavor run the following command:
+
+[source,sh]
+----
+metanorma list-doctypes <flavor>
+----
+
+e.g.,
+
+[source,sh]
+----
+metanorma list-doctypes iso
+----
+
 === List supported output formats (`metanorma list-extensions`)
 
 Need to know what output formats are supported for a given flavor?

data/lib/metanorma/cli/command.rb

@@ -32,9 +32,9 @@ module Metanorma
       option :version, aliases: "-v", desc: "Print version of code (accompanied with -t)"
       option "output-dir", aliases: "-o", desc: "Directory to save compiled files"
 
-      option :agree_to_terms, type: :boolean, desc: "Agree / Disagree with all third-party licensing terms presented (WARNING: do know what you are agreeing with!)"
-      option :no_install_fonts, type: :boolean, desc: "Skip the font installation process"
-      option :continue_without_fonts, type: :boolean, desc: "Continue processing even when fonts are missing"
+      option :"agree-to-terms", type: :boolean, desc: "Agree / Disagree with all third-party licensing terms presented (WARNING: do know what you are agreeing with!)"
+      option :"no-install-fonts", type: :boolean, desc: "Skip the font installation process"
+      option :"continue-without-fonts", type: :boolean, desc: "Continue processing even when fonts are missing"
 
       def compile(file_name = nil)
         if file_name && !options[:version]
@@ -58,12 +58,16 @@ module Metanorma
       option :format, aliases: "-x", type: :string, desc: "Formats to generate"
       option "output-folder", aliases: "-w", required: true, desc: "Directory to save compiled files"
       option :coverpage, aliases: "-c", desc: "Liquid template"
+      option :"agree-to-terms", type: :boolean, desc: "Agree / Disagree with all third-party licensing terms presented (WARNING: do know what you are agreeing with!)"
+      option :"no-install-fonts", type: :boolean, desc: "Skip the font installation process"
+      option :"continue-without-fonts", type: :boolean, desc: "Continue processing even when fonts are missing"
 
       def collection(filename = nil)
         if filename
           opts = options.dup
           opts[:format] &&= opts[:format].split(",").map &:to_sym
           opts[:output_folder] = opts.delete :"output-folder"
+          opts[:compile] = opts.slice("agree-to-terms", "no-install-fonts", "continue-without-fonts").map { |k, v| [k.to_sym, v] }.to_h
           coll = Metanorma::Collection.parse filename
           coll.render opts
         else UI.say("Need to specify a file to process")
@@ -90,6 +94,17 @@ module Metanorma
         UI.say("Couldn't load #{type}, please provide a valid type!")
       end
 
+      desc "list-doctypes", "List supported doctypes"
+      def list_doctypes(type = nil)
+        processors = backend_processors
+
+        if type && processors[type.to_sym]
+          processors = { type.to_sym => processors[type.to_sym] }
+        end
+
+        print_doctypes_table(processors)
+      end
+
       desc "template-repo", "Manage metanorma templates repository"
       subcommand :template_repo, Metanorma::Cli::Commands::TemplateRepo
 
@@ -124,6 +139,13 @@ module Metanorma
         end
       end
 
+      def backend_processors
+        @backend_processors ||= (
+          Metanorma::Cli.load_flavors
+          Metanorma::Registry.instance.processors
+        )
+      end
+
       def find_backend(type)
         load_flavours(type)
         Metanorma::Registry.instance.find_processor(type&.to_sym)
@@ -160,6 +182,18 @@ module Metanorma
           require "metanorma-#{type}"
         end
       end
+
+      def print_doctypes_table(processors)
+        table_data = processors.map do |type_sym, processor|
+          [
+            type_sym.to_s,
+            processor.input_format,
+            join_keys(processor.output_formats.keys),
+          ]
+        end
+
+        UI.table(["Type", "Input", "Supported output format"], table_data)
+      end
     end
   end
 end

data/lib/metanorma/cli/commands/site.rb

@@ -5,7 +5,7 @@ module Metanorma
   module Cli
     module Commands
       class Site < Thor
-        desc "site generate SOURCE_PATH", "Geneate site from collection"
+        desc "generate SOURCE_PATH", "Geneate site from collection"
         option :config, aliases: "-c", desc: "The metanorma configuration file"
         option(
           :output_dir,

data/lib/metanorma/cli/site_generator.rb

@@ -8,9 +8,9 @@ module Metanorma
       def initialize(source, options = {})
         @source = find_realpath(source)
         @site_path = options.fetch(:output_dir, "site").to_s
-        @manifest_file = find_realpath(options.fetch(:config, nil))
         @asset_folder = options.fetch(:asset_folder, "documents").to_s
         @collection_name = options.fetch(:collection_name, "documents.xml")
+        @manifest_file = find_realpath(options.fetch(:config, default_config))
 
         ensure_site_asset_directory!
       end
@@ -21,10 +21,9 @@ module Metanorma
 
       def generate
         site_directory = asset_directory.join("..")
+        select_source_files.each { |source| compile(source) }
 
         Dir.chdir(site_directory) do
-          select_source_files.each { |source| compile(source) }
-
           build_collection_file(collection_name)
           convert_to_html_page(collection_name, "index.html")
         end
@@ -41,6 +40,11 @@ module Metanorma
         source_path
       end
 
+      def default_config
+        default_file = Pathname.new(Dir.pwd).join("metanorma.yml")
+        default_file if File.exist?(default_file)
+      end
+
       def select_source_files
         files = source_from_manifest
 
@@ -67,7 +71,7 @@ module Metanorma
         UI.info("Compiling #{source} ...")
 
         Metanorma::Cli::Compiler.compile(
-          source.to_s, format: :asciidoc, "output-dir" => asset_folder
+          source.to_s, format: :asciidoc, "output-dir" => asset_directory
         )
       end
 

data/lib/metanorma/cli/ui.rb

@@ -19,6 +19,10 @@ module Metanorma
         new.error(message)
       end
 
+      def self.table(header, data)
+        new.print_table(data.unshift(header))
+      end
+
       def self.run(command)
         require "open3"
         Open3.capture3(command)

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.4.0"
+    VERSION = "1.4.1pre2"
   end
 end

data/metanorma-cli.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sassc"
 
   spec.add_runtime_dependency "thor", "~> 1.0"
-  spec.add_runtime_dependency "metanorma-iso", "~> 1.5.0"
+  spec.add_runtime_dependency "metanorma-iso", "~> 1.6.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"
@@ -46,15 +46,15 @@ Gem::Specification.new do |spec|
   #spec.add_runtime_dependency 'metanorma-ribose', "~> 1.6.0"
   spec.add_runtime_dependency "metanorma-m3aawg", "~> 1.6.0"
   spec.add_runtime_dependency "metanorma-bipm", "~> 1.0.0"
-  spec.add_runtime_dependency "metanorma-generic", "~> 1.8.0"
-  spec.add_runtime_dependency "metanorma-standoc", "~> 1.6.0"
+  spec.add_runtime_dependency "metanorma-generic", "~> 1.8.2"
+  spec.add_runtime_dependency "metanorma-standoc", "~> 1.7.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.3.0"
+  spec.add_runtime_dependency "isodoc", ">= 1.4.2"
   spec.add_runtime_dependency "metanorma", "~> 1.2.0"
   spec.add_runtime_dependency "git", "~> 1.5"
   spec.add_runtime_dependency "relaton-cli", ">= 0.8.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1pre2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf
   requirement: !ruby/object:Gem::Requirement
@@ -268,28 +268,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: metanorma-un
   requirement: !ruby/object:Gem::Requirement
@@ -366,14 +366,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -491,9 +491,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: