metanorma-cli 1.3.9 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a03b03e99303cba8dba1f9cff78ee1e8b2398f717619b193460a58c8bbcd423d
-  data.tar.gz: 00a06a5126c12f57e1e5a7a77337a600606cd25b026439865012fb41907af664
+  metadata.gz: c88ec404d073b5b55e98c46ac5709db3abb0e090855abbe4e5fd37ccb1c6fe1b
+  data.tar.gz: fe29640074f35365f061b89227c11a0b4f45e47a8704244c8468bf1f8f3813c0
 SHA512:
-  metadata.gz: 32ae08f01d0435a30d418978eeb8baa0c482ae7e707de6bf12562dc4899c3dc37bef83b6fbdb7778899e37a659dc0bdf2d30bb8abb298c19e8bd8724eedac01a
-  data.tar.gz: 184167a6dca3dc0542e0ff1abf90c7cc96ba92135592939bc28658827e8315a0d6d932578c41a074a3075a20ad4b82593b39ce0e72ebb0093584eb0cc6f27b56
+  metadata.gz: 0d1a7bd16a4a5f94ab4a519e1e0f4e7625a553f58c16c68f5e7c09c68873d326153e13eb5ba4d34528f220301984b2cc3155426c1bc3a3476f3826adb4927902
+  data.tar.gz: adec9799ab747d3c47645ba328d301728d75dcfd714117a8a459fe08d798ae95fad8d71ac51783b294e2f800a8b0e261c760228d7a9149db42b7b819b2b8735d

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?
@@ -285,6 +311,21 @@ repository.
 metanorma template-repo add my-iso https://github.com/you/my-iso-template
 ----
 
+=== Generate metanorma minisite
+
+The `site` interface allows you to manage mini site generation using the CLI.
+To generate a mini site you need to provide the `SOURCE_PATH` and the CLI will
+take care of compiling each of those files and generate deployable site in the
+provided output directory.
+
+This interface also supports a YAML manifest file that can be used to customize
+the site generation process. You can check more details here: link:./spec/fixtures/metanorma.yml[metanorma.yml]
+
+[source, sh]
+----
+metanorma site generate SOURCE_PATH -o OUTPUT_PATH -c metanorma.yml
+----
+
 == Credits
 
 This gem is developed, maintained and funded by https://www.metanorma.com/docs/getting-started/[Ribose Inc.]

data/lib/metanorma/cli.rb

@@ -10,6 +10,7 @@ module Metanorma
       "metanorma-iec",
       "metanorma-ietf",
       #"metanorma-gb",
+      "metanorma-bipm",
       "metanorma-cc",
       "metanorma-csa",
       "metanorma-iho",

data/lib/metanorma/cli/command.rb

@@ -3,6 +3,7 @@ require "metanorma/cli/compiler"
 require "metanorma/cli/generator"
 require "metanorma/cli/git_template"
 require "metanorma/cli/commands/template_repo"
+require "metanorma/cli/commands/site"
 require "metanorma"
 
 module Metanorma
@@ -31,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]
@@ -57,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.select { |k, v| ["agree-to-terms", "no-install-fonts", "continue-without-fonts"].include?(k)}.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")
@@ -89,9 +94,23 @@ 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
 
+      desc "site", "Manage site for metanorma collections"
+      subcommand :site, Metanorma::Cli::Commands::Site
+
       private
 
       def single_type_extensions(type)
@@ -120,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)
@@ -156,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

@@ -0,0 +1,26 @@
+require "pathname"
+require "metanorma/cli/site_generator"
+
+module Metanorma
+  module Cli
+    module Commands
+      class Site < Thor
+        desc "generate SOURCE_PATH", "Geneate site from collection"
+        option :config, aliases: "-c", desc: "The metanorma configuration file"
+        option(
+          :output_dir,
+          aliases: "-o",
+          default: Pathname.new(Dir.pwd).join("site").to_s,
+          desc: "Output directory for the generated site",
+        )
+
+        def generate(source_path)
+          Cli::SiteGenerator.generate(source_path, options.dup)
+          UI.say("Site has been generated at #{options[:output_dir]}")
+        rescue Cli::Errors::InvalidManifestFileError
+          UI.error("Invalid data in: #{options[:config]}")
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/cli/errors.rb

@@ -4,6 +4,7 @@ module Metanorma
       class DuplicateTemplateError < StandardError; end
 
       class FileNotFoundError < StandardError; end
+      class InvalidManifestFileError < StandardError; end
     end
   end
 end

data/lib/metanorma/cli/site_generator.rb

@@ -0,0 +1,134 @@
+require "yaml"
+require "pathname"
+require "fileutils"
+
+module Metanorma
+  module Cli
+    class SiteGenerator
+      def initialize(source, options = {})
+        @source = find_realpath(source)
+        @site_path = options.fetch(:output_dir, "site").to_s
+        @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
+
+      def self.generate(source, options = {})
+        new(source, options).generate
+      end
+
+      def generate
+        site_directory = asset_directory.join("..")
+        select_source_files.each { |source| compile(source) }
+
+        Dir.chdir(site_directory) do
+          build_collection_file(collection_name)
+          convert_to_html_page(collection_name, "index.html")
+        end
+      end
+
+      private
+
+      attr_reader :source, :asset_folder, :asset_directory
+      attr_reader :site_path, :manifest_file, :collection_name
+
+      def find_realpath(source_path)
+        Pathname.new(source_path.to_s).realpath if source_path
+      rescue Errno::ENOENT
+        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
+
+        if files.empty?
+          files = Dir[File.join(source, "**", "*.adoc")]
+        end
+
+        files.flatten.uniq.reject { |file| File.directory?(file) }
+      end
+
+      def build_collection_file(collection_name)
+        collection_path = [site_path, collection_name].join("/")
+        UI.info("Building collection file: #{collection_path} ...")
+
+        Relaton::Cli::RelatonFile.concatenate(
+          asset_folder,
+          collection_name,
+          title: manifest[:collection_name],
+          organization: manifest[:collection_organization],
+        )
+      end
+
+      def compile(source)
+        UI.info("Compiling #{source} ...")
+
+        Metanorma::Cli::Compiler.compile(
+          source.to_s, format: :asciidoc, "output-dir" => asset_directory
+        )
+      end
+
+      def convert_to_html_page(collection, page_name)
+        UI.info("Generating html site in #{site_path} ...")
+
+        Relaton::Cli::XMLConvertor.to_html(collection)
+        File.rename(Pathname.new(collection).sub_ext(".html").to_s, page_name)
+      end
+
+      def manifest
+        @manifest ||= config_from_manifest || {
+          files: [], collection_name: "", collection_organization: ""
+        }
+      end
+
+      def config_from_manifest
+        if manifest_file
+          manifest_config(YAML.safe_load(File.read(manifest_file.to_s)))
+        end
+      end
+
+      def manifest_config(manifest)
+        {
+          files: extract_config_data(
+            manifest["metanorma"]["source"], "files"
+          ) || [],
+
+          collection_name: extract_config_data(
+            manifest["relaton"]["collection"], "name"
+          ),
+
+          collection_organization: extract_config_data(
+            manifest["relaton"]["collection"], "organization"
+          ),
+        }
+      rescue NoMethodError
+        raise Errors::InvalidManifestFileError.new("Invalid manifest file")
+      end
+
+      def extract_config_data(node, key)
+        node ? node[key] : nil
+      end
+
+      def source_from_manifest
+        @source_from_manifest ||= manifest[:files].map do |source_file|
+          file_path = source.join(source_file).to_s
+          file_path.include?("*") ? Dir.glob(file_path) : file_path
+        end.flatten
+      end
+
+      def ensure_site_asset_directory!
+        asset_path = [site_path, asset_folder].join("/")
+        @asset_directory = Pathname.new(Dir.pwd).join(asset_path)
+
+        FileUtils.mkdir_p(@asset_directory) unless @asset_directory.exist?
+      end
+    end
+  end
+end

data/lib/metanorma/cli/ui.rb

@@ -11,10 +11,18 @@ module Metanorma
         new.say(message)
       end
 
+      def self.info(message)
+        new.say(["[info]", message].join(": "))
+      end
+
       def self.error(message)
         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.3.9"
+    VERSION = "1.4.1"
   end
 end

data/metanorma-cli.gemspec

@@ -37,23 +37,24 @@ 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"
   spec.add_runtime_dependency "metanorma-cc", "~> 1.6.0"
-  spec.add_runtime_dependency "metanorma-csa", "~> 1.6.0"
+  spec.add_runtime_dependency "metanorma-csa", "~> 1.7.0"
   #spec.add_runtime_dependency 'metanorma-ribose', "~> 1.6.0"
   spec.add_runtime_dependency "metanorma-m3aawg", "~> 1.6.0"
-  spec.add_runtime_dependency "metanorma-generic", "~> 1.8.0"
-  spec.add_runtime_dependency "metanorma-standoc", "~> 1.6.0"
+  spec.add_runtime_dependency "metanorma-bipm", "~> 1.0.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.3.9
+  version: 1.4.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-04 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
@@ -226,14 +226,14 @@ dependencies:
     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-m3aawg
   requirement: !ruby/object:Gem::Requirement
@@ -248,34 +248,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: metanorma-bipm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: metanorma-generic
   requirement: !ruby/object:Gem::Requirement
     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
@@ -352,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
@@ -447,11 +461,13 @@ files:
 - lib/metanorma-cli.rb
 - lib/metanorma/cli.rb
 - lib/metanorma/cli/command.rb
+- lib/metanorma/cli/commands/site.rb
 - lib/metanorma/cli/commands/template_repo.rb
 - lib/metanorma/cli/compiler.rb
 - lib/metanorma/cli/errors.rb
 - lib/metanorma/cli/generator.rb
 - lib/metanorma/cli/git_template.rb
+- lib/metanorma/cli/site_generator.rb
 - lib/metanorma/cli/template_repo.rb
 - lib/metanorma/cli/ui.rb
 - lib/metanorma/cli/version.rb