metanorma-cli 1.12.1 → 1.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87232f90b1180fb05c76e0dac99cd341fc2c8cd69b94f9b38c439c44a6fb10bc
-  data.tar.gz: b847705bc7050d05d9c6807ed9633582c856a250143cd818d6515891c6cd5b05
+  metadata.gz: 83127d9943ff11c57968eba5da57a1506bab8cdbe1e035e055c382b5a70ba8d9
+  data.tar.gz: 76a08db2cd6f26d9f82a795fd2075eabe1f4ec7b1789bb56d6fccd49deaf188d
 SHA512:
-  metadata.gz: de0c04dc41203bed1bda8b1b896ce07645a1bbd1f982c0c396f3a14909901d868d564498db27e592c4c24bbde0e963819d3a95d5490ac72c0da649ecf750af0b
-  data.tar.gz: 46cb9e77c5e29a3e64c3878290e4f63c246e5d04f57c4ae86d36544360c0691c2a514b4700204c5eee83ff42174c4a47f19629b6cccdc5e8a0b104ff7df24db5
+  metadata.gz: 3e43bd5b2d5a3cb5bea64d82109963de633ab0c3e139ae36283cf4cbc0756a54e7952157c37e20c2bf0ee1c6edb09245671b77a5b1054a5073d13794063557e0
+  data.tar.gz: ac22976c0ee80b29e48ba6559230c742f97d86bbc2243cd51a4657833dc54ffb6b60b5a9919c8bbfc6be7404e9d6c4593fe8e5028ceb8cd45213d64b6b6f6ed9

data/Gemfile

@@ -10,4 +10,25 @@ end
 
 gemspec
 
-eval_gemfile("Gemfile.devel") rescue nil
+group :development do
+  gem "debug"
+  gem "pry"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rspec-command", "~> 1.0.3"
+  gem "rspec-core", "~> 3.4"
+  gem "rubocop", "~> 1"
+  gem "rubocop-performance"
+  # need for dev because locally compiled metanorma-iso does not have css
+  gem "sassc-embedded"
+  gem "simplecov", "~> 0.15"
+  gem "vcr", "~> 6.1.0"
+  gem "webmock"
+  gem "xml-c14n"
+end
+
+begin
+  eval_gemfile("Gemfile.devel")
+rescue StandardError
+  nil
+end

data/bin/font-test

@@ -1,56 +1,58 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require "fontist"
 require "rubygems"
 require "yaml"
 
 flavors = ARGV
 
+def die(message)
+  warn message
+  warn "Aborting..."
+  exit(1)
+end
+
 Fontist::Formula.update_formulas_repo
 
 flavors.each do |flavor|
-  begin
-    gem_name = "metanorma-#{flavor}"
-    require gem_name
-
-    submodule = case flavor
-                when "jcgm"
-                  "Bipm"
-                else
-                  flavor.capitalize
-                end
-    processor_class = "Metanorma::#{submodule}::Processor"
-
-    processor = Object
-      .const_get(processor_class)
-      .new
-
-    unless processor.respond_to?(:fonts_manifest)
-      puts "#{flavor} don't require any fonts"
-      exit(0)
-    end
-
-    manifest = processor.fonts_manifest
-
-    Fontist::Manifest::Install.from_hash(
-      manifest,
-      confirmation: "yes",
-    )
-
-    puts "#{flavor}-related fonts:"
-    puts Fontist::Manifest::Locations.from_hash(manifest).to_yaml
-  rescue LoadError => e
-    STDERR.puts "Could not load gem '#{gem_name}': #{e.message}"
-    exit(1)
-  rescue NameError => e
-    STDERR.puts "Could not find class '#{processor_class}': #{e.message}"
-    exit(1)
-  rescue => e
-    if e.class.to_s.start_with?("Fontist::Errors::")
-      STDERR.puts "Fontist failed with: #{e.message}"
-    else
-      STDERR.puts "Unknown error: #{e.message}"
-    end
-    exit(1)
+  gem_name = "metanorma-#{flavor}"
+  require gem_name
+
+  submodule = case flavor
+              when "jcgm"
+                "Bipm"
+              else
+                flavor.capitalize
+              end
+  processor_class = "Metanorma::#{submodule}::Processor"
+
+  processor = Object
+    .const_get(processor_class)
+    .new
+
+  unless processor.respond_to?(:fonts_manifest)
+    puts "#{flavor} does not require any fonts.  Skipping."
+    exit(0)
+  end
+
+  manifest = processor.fonts_manifest
+
+  Fontist::Manifest::Install.from_hash(
+    manifest,
+    confirmation: "yes",
+  )
+
+  puts "#{flavor}-related fonts:"
+  puts Fontist::Manifest::Locations.from_hash(manifest).to_yaml
+rescue LoadError => e
+  die "Could not load gem '#{gem_name}': #{e.message}"
+rescue NameError => e
+  die "Could not find class '#{processor_class}': #{e.message}"
+rescue StandardError => e
+  if e.class.to_s.start_with?("Fontist::Errors::")
+    die "Fontist failed with: #{e.message}"
+  else
+    die "Unknown error: #{e.message}"
   end
 end

data/bin/rspec

@@ -10,12 +10,12 @@
 
 require "pathname"
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+                                           Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path("../bundle", __FILE__)
+bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/exe/metanorma-manifest

@@ -92,7 +92,8 @@ opt_parser = OptionParser.new do |opts|
   opts.on(
     "-R dir",
     "--relaton",
-    "Insert links to relaton XML, generated by relaton-server-csd, with root directory dir (/id/xxxx is supplied)",
+    "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
@@ -103,10 +104,8 @@ end
 opt_parser.parse!(ARGV)
 options[:filename] = ARGV.pop
 
-if options[:require]
-  options[:require].each do |r|
-    require r
-  end
+options[:require]&.each do |r|
+  require r
 end
 
 manifest = YAML.load_file(options[:filename])
@@ -115,16 +114,16 @@ documents = extract_documents(manifest)
 
 # TODO real lookup of namespaces and root elements
 
-out = <<~END
+out = <<~EOXML
   <#{options[:type]}-standard xmlns="http://riboseinc.com/isoxml">
   <bibdata type="standard">
     <title>#{manifest['title']}</title>
-END
+EOXML
 
 # TODO leave in anchor references?
 #
 documents.each do |d|
-  out += <<~END
+  out += <<~EOXML
     <relation type="partOf">
       <bibdata type="standard">
         <title>#{d['title']}</title>
@@ -132,20 +131,20 @@ documents.each do |d|
         <abstract>#{d['description']}</abstract>
       </bibdata>
     </relation>
-  END
+  EOXML
 end
 
-out += <<~END
+out += <<~EOXML
   </bibdata>
   <sections>
-END
+EOXML
 
 out += iterate(manifest["sections"], options)
 
-out += <<~END
+out += <<~EOXML
   </sections>
   <#{options[:type]}-standard>
-END
+EOXML
 outfilename = options[:filename].sub(/\.[^.]+$/, ".xml")
 File.open(outfilename, "w") { |f| f.write out }
 

data/lib/metanorma/cli/collection.rb

@@ -37,6 +37,7 @@ module Metanorma
           output_folder: build_output_folder,
           coverpage: @options.fetch(:coverpage, nil),
           format: collection_output_formats(@options.fetch(:format, "")),
+          site_generate: @options["site_generate"],
         }
       end
 
@@ -73,7 +74,7 @@ module Metanorma
       end
 
       def xml_extract_options_from_file
-        xml = Nokogiri::XML File.read(@file.to_s, encoding: "UTF-8") { |c| c.huge }
+        xml = Nokogiri::XML File.read(@file.to_s, encoding: "UTF-8", &:huge)
         { "coverpage" => xml.at("//coverpage"),
           "format" => xml.at("//format"),
           "output_folder" => xml.at("//output_folder") }.compact

data/lib/metanorma/cli/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "metanorma/cli/compiler"
 require "metanorma/cli/generator"
 require "metanorma/cli/collection"
@@ -12,7 +14,8 @@ module Metanorma
   module Cli
     class Command < ThorWithConfig
       class_option :progress, aliases: "-s", type: :boolean, default: false,
-                              desc: "Show progress for long running tasks (like download)"
+                              desc: "Show progress for long running tasks" \
+                                    " (like download)"
 
       desc "new NAME", "Create new Metanorma document"
       option :type, aliases: "-t", required: true, desc: "Document type"
@@ -36,26 +39,34 @@ module Metanorma
       option :wrapper, aliases: "-w", type: :boolean,
                        desc: "Create wrapper folder for HTML output"
       option :asciimath, aliases: "-a", type: :boolean,
-                         desc: "Keep Asciimath in XML output instead of converting it to MathM"
+                         desc: "Keep Asciimath in XML output instead of" \
+                               " converting it to MathM"
       option :datauriimage, aliases: "-d", type: :boolean,
                             desc: "Encode HTML output images as data URIs"
       option :relaton, aliases: "-R",
-                       desc: "Export Relaton XML for document to nominated filename"
+                       desc: "Export Relaton XML for document to nominated" \
+                             " filename"
       option :extract, aliases: "-e",
-                       desc: "Export sourcecode fragments from this document to nominated directory"
+                       desc: "Export sourcecode fragments from this document" \
+                             " to nominated directory"
       option :version, aliases: "-v",
                        desc: "Print version of code (accompanied with -t)"
       option :output_dir, aliases: "-o",
                           desc: "Directory to save compiled files"
       option :strict, aliases: "-S", type: :boolean,
                       desc: "Strict compilation: abort if there are any errors"
-      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 :agree_to_terms,
+             type: :boolean,
+             desc: "Agree / Disagree with all third-party licensing terms "\
+                   "presented (WARNING: do know what you are agreeing with!)"
       option :install_fonts, type: :boolean, default: true,
                              desc: "Install required fonts"
-      option :continue_without_fonts, type: :boolean,
-                                      desc: "Continue processing even when fonts are missing"
+      option :continue_without_fonts,
+             type: :boolean,
+             desc: "Continue processing even when fonts are missing"
 
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/AbcSize
       def compile(file_name = nil)
         if file_name && !options[:version]
           documents = select_wildcard_documents(file_name) || [file_name]
@@ -71,18 +82,23 @@ module Metanorma
           invoke :help
         end
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/PerceivedComplexity
 
       desc "collection FILENAME", "Render HTML pages from XML/YAML colection"
       option :format, aliases: "-x", type: :string, desc: "Formats to generate"
       option :output_folder, aliases: "-w",
                              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 :agree_to_terms,
+             type: :boolean,
+             desc: "Agree / Disagree with all third-party licensing terms "\
+                   "presented (WARNING: do know what you are agreeing with!)"
       option :install_fonts, type: :boolean, default: true,
                              desc: "Install required fonts"
-      option :continue_without_fonts, type: :boolean,
-                                      desc: "Continue processing even when fonts are missing"
+      option :continue_without_fonts,
+             type: :boolean,
+             desc: "Continue processing even when fonts are missing"
       option :strict, aliases: "-S", type: :boolean, \
                       desc: "Strict compilation: abort if there are any errors"
 

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

@@ -1,20 +1,22 @@
 require "pathname"
 require "metanorma-utils"
 
-#require "metanorma/cli/stringify_all_keys"
+# require "metanorma/cli/stringify_all_keys"
 
 module Metanorma
   module Cli
     module Commands
       class Config < Thor
-             Hash.include Metanorma::Utils::Hash
-      Array.include Metanorma::Utils::Array
+        Hash.include Metanorma::Utils::Hash
+        Array.include Metanorma::Utils::Array
 
-        class_option :global, aliases: "-g", type: :boolean, default: false, desc: "Use global config"
+        class_option :global, aliases: "-g", type: :boolean, default: false,
+                              desc: "Use global config"
 
         desc "get NAME", "Get config value"
         def get(name = nil)
-          config, config_path = load_config(options[:global], create_default_config: false)
+          config, config_path = load_config(options[:global],
+                                            create_default_config: false)
 
           if name.nil? && File.exist?(config_path)
             UI.say File.read(config_path, encoding: "utf-8")
@@ -47,16 +49,25 @@ module Metanorma
         def self.exit_on_failure?() true end
 
         # priority:
-        # IDEAL: thor defaults -> global conf -> local conf -> env vars -> passed arguments
-        # ACTUAL: all arguments -> global conf -> local conf
-        # - thor doesn't provide to differentiate default values against passed args
+        # IDEAL:
+        # thor defaults -> global conf -> local conf
+        #   -> env vars -> passed arguments
+        #
+        # ACTUAL:
+        # all arguments -> global conf -> local conf
+        #
+        # - thor doesn't provide to differentiate default values against passed
+        #   args
         # - thor doesn't allow to get all args available for current command
-        def self.load_configs(options, configs = [Metanorma::Cli.global_config_path, Metanorma::Cli.local_config_path])
+        def self.load_configs(options, configs = [
+          Metanorma::Cli.global_config_path, Metanorma::Cli.local_config_path
+        ])
           result = options.dup
           configs.each do |config_path|
             next unless File.exist?(config_path)
 
-            config_values = ::YAML::load_file(config_path).symbolize_all_keys[:cli] || {}
+            config_values = ::YAML::load_file(config_path)
+              .symbolize_all_keys[:cli] || {}
             result.merge!(config_values)
           end
 
@@ -80,15 +91,16 @@ module Metanorma
         end
 
         def load_config(global_config, create_default_config: true)
-          config_path = Metanorma::Cli.config_path(global_config)
+          config_path = Metanorma::Cli.config_path(global: global_config)
 
           unless File.exist?(config_path) || create_default_config
-            config_path = Metanorma::Cli.config_path(true)
+            config_path = Metanorma::Cli.config_path(global: true)
           end
 
           save_default_config(config_path)
 
-          [::YAML::load_file(config_path).symbolize_all_keys || {}, config_path]
+          [::YAML::load_file(config_path).symbolize_all_keys || {},
+           config_path]
         end
 
         def dig_path(str)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 require "metanorma/cli/site_generator"
 require "metanorma/cli/thor_with_config"
@@ -6,31 +8,52 @@ module Metanorma
   module Cli
     module Commands
       class Site < ThorWithConfig
-        SITE_OUTPUT_DIRNAME = "_site".freeze
+        SITE_OUTPUT_DIRNAME = "_site"
 
         desc "generate [SOURCE_PATH]", "Generate site from collection"
-        option :config, aliases: "-c", desc: "Metanorma configuration file"
-        option(
-          :output_dir,
-          aliases: "-o",
-          default: Pathname.new(Dir.pwd).join(SITE_OUTPUT_DIRNAME).to_s,
-          desc: "Output directory for generated site",
-        )
-        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 :install_fonts, type: :boolean, default: true, desc: "Install required fonts"
-        option :continue_without_fonts, type: :boolean, desc: "Continue processing even when fonts are missing"
-        option :stylesheet, aliases: "-s", desc: "Stylesheet file path for rendering HTML page"
-        option :template_dir, aliases: "-t", desc: "Liquid template directory to render site design"
-        option(
-          :strict,
-          aliases: "-S",
-          type: :boolean,
-          desc: "Strict compilation: abort if there are any errors",
-        )
+        option :config,
+               aliases: "-c",
+               desc: "Metanorma configuration file"
+
+        option :output_dir,
+               aliases: "-o",
+               default: Pathname.new(Dir.pwd).join(SITE_OUTPUT_DIRNAME).to_s,
+               desc: "Output directory for generated site"
+
+        option :output_filename_template,
+               default: nil,
+               desc: "Liquid template to generate output filenames" \
+                     " (using Relaton model)"
+
+        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 :install_fonts,
+               type: :boolean,
+               default: true,
+               desc: "Install required fonts"
+
+        option :continue_without_fonts,
+               type: :boolean,
+               desc: "Continue processing even when fonts are missing"
+
+        option :stylesheet,
+               aliases: "-s",
+               desc: "Stylesheet file path for rendering HTML page"
+
+        option :template_dir,
+               aliases: "-t",
+               desc: "Liquid template directory to render site design"
+
+        option :strict,
+               aliases: "-S",
+               type: :boolean,
+               desc: "Strict compilation: abort if there are any errors"
 
         def generate(source_path = Dir.pwd)
-          Cli::SiteGenerator.generate(
+          Cli::SiteGenerator.generate!(
             source_path,
             options,
             filter_compile_options(options),

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

@@ -6,12 +6,13 @@ module Metanorma
     module Commands
       class TemplateRepo < ThorWithConfig
         desc "add NAME SOURCE", "Add new metanorma templates repository"
-        option :overwrite, aliases: "-y", type: :boolean, desc: "Overwrite existing template"
+        option :overwrite, aliases: "-y",
+                           type: :boolean,
+                           desc: "Overwrite existing template"
 
         def add(name, source)
           Metanorma::Cli::TemplateRepo.add(name, source, options)
           UI.say("Template repo: #{name} has been added successfully")
-
         rescue Errors::DuplicateTemplateError
           UI.error("Duplicate metanorma template")
         end

data/lib/metanorma/cli/compiler.rb

@@ -4,7 +4,6 @@ require "metanorma/cli/errors"
 module Metanorma
   module Cli
     class Compiler
-
       def initialize(file, options)
         validate_file_path(file)
         @file = file
@@ -16,12 +15,16 @@ module Metanorma
         path = Pathname.new(file)
         # Check if provided file path exists
         unless path.exist?
-          raise ::Metanorma::Cli::Errors::FileNotFoundError.new("Specified input file '#{file}' does not exist")
+          raise ::Metanorma::Cli::Errors::FileNotFoundError.new(
+            "Specified input file '#{file}' does not exist",
+          )
         end
 
         # Check if provided file is really a file
         unless path.file?
-          raise ::Metanorma::Cli::Errors::FileNotFoundError.new("Specified input file '#{file}' is not a file")
+          raise ::Metanorma::Cli::Errors::FileNotFoundError.new(
+            "Specified input file '#{file}' is not a file",
+          )
         end
       end
 
@@ -58,12 +61,12 @@ module Metanorma
         Hash.new.tap do |hash|
           hash[:extract] = extract[0]
           hash[:extract_type] =
-            extract.size > 0 ? extract[0..-1].map(&:to_sym) : []
+            extract.empty? ? [] : extract.map(&:to_sym)
         end
       end
 
       def extension_option
-        !extensions.empty? ? { extension_keys: extensions.map(&:to_sym) } : {}
+        extensions.empty? ? {} : { extension_keys: extensions.map(&:to_sym) }
       end
 
       def serialize(options)

data/lib/metanorma/cli/site_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 require "pathname"
 require "fileutils"
@@ -5,48 +7,74 @@ require "fileutils"
 module Metanorma
   module Cli
     class SiteGenerator
+      DEFAULT_RELATON_COLLECTION_INDEX = "documents.xml"
+      DEFAULT_ASSET_FOLDER = "documents"
+      DEFAULT_SITE_INDEX = "index.html"
+      DEFAULT_CONFIG_FILE = "metanorma.yml"
+
+      # rubocop:disable Metrics/AbcSize
       def initialize(source, options = {}, compile_options = {})
         @collection_queue = []
         @source = find_realpath(source)
         @site_path = options.fetch(
           :output_dir, Commands::Site::SITE_OUTPUT_DIRNAME
         ).to_s
-        @asset_folder = options.fetch(:asset_folder, "documents").to_s
-        @collection_name = options.fetch(:collection_name, "documents.xml")
+
+        @asset_folder = options.fetch(:asset_folder, DEFAULT_ASSET_FOLDER).to_s
+        @relaton_collection_index = options.fetch(
+          :collection_name,
+          DEFAULT_RELATON_COLLECTION_INDEX,
+        )
 
         @manifest_file = find_realpath(options.fetch(:config, default_config))
         @template_dir = options.fetch(:template_dir, template_data("path"))
         @stylesheet = options.fetch(:stylesheet, template_data("stylesheet"))
+        @output_filename_template = options.fetch(
+          :output_filename_template,
+          template_data("output_filename"),
+        )
+
+        # Determine base path for template files
+        # If template_dir is not absolute, then it is relative to the manifest
+        # file.
+        # If manifest file is not provided, then it is relative to the current
+        # directory.
+        @base_path = if manifest_file.nil?
+                       Pathname.pwd
+                     else
+                       Pathname.new(manifest_file).parent
+                     end
 
         @compile_options = compile_options
-        ensure_site_asset_directory!
       end
+      # rubocop:enable Metrics/AbcSize
 
-      def self.generate(source, options = {}, compile_options = {})
-        new(source, options, compile_options).generate
+      def self.generate!(source, options = {}, compile_options = {})
+        new(source, options, compile_options).generate!
       end
 
-      def generate
-        site_directory = asset_directory.join("..")
+      def generate!
+        ensure_site_asset_directory!
 
-        fatals = select_source_files.map { |source| compile(source) }
-          .flatten
-          .compact
+        compile_files!(select_source_files)
 
-        raise Errors::FatalCompilationError, fatals unless fatals.empty?
+        site_directory = asset_directory.parent
 
         Dir.chdir(site_directory) do
-          build_collection_file(collection_name)
-          convert_to_html_page(collection_name, "index.html")
+          build_collection_file!(relaton_collection_index)
+          convert_to_html_page!(relaton_collection_index, DEFAULT_SITE_INDEX)
         end
 
-        dequeue_jobs
+        dequeue_jobs!
       end
 
       private
 
-      attr_reader :source, :asset_folder, :asset_directory, :site_path
-      attr_reader :manifest_file, :collection_name, :stylesheet, :template_dir
+      attr_reader :source, :asset_folder, :asset_directory, :site_path,
+                  :manifest_file, :relaton_collection_index, :stylesheet,
+                  :template_dir,
+                  :output_filename_template,
+                  :base_path
 
       def find_realpath(source_path)
         Pathname.new(source_path.to_s).realpath if source_path
@@ -55,7 +83,7 @@ module Metanorma
       end
 
       def default_config
-        default_file = Pathname.new(Dir.pwd).join("metanorma.yml")
+        default_file = Pathname.new(Dir.pwd).join(DEFAULT_CONFIG_FILE)
         default_file if File.exist?(default_file)
       end
 
@@ -66,90 +94,133 @@ module Metanorma
           files = Dir[File.join(source, "**", "*.adoc")]
         end
 
-        files.flatten.uniq.reject { |file| File.directory?(file) }
+        result = files.flatten
+        result.uniq!
+        result.reject! { |file| File.directory?(file) }
+        result
       end
 
-      def build_collection_file(collection_name)
-        collection_path = [site_path, collection_name].join("/")
+      def build_collection_file!(relaton_collection_index_filename)
+        collection_path = [site_path,
+                           relaton_collection_index_filename].join("/")
         UI.info("Building collection file: #{collection_path} ...")
 
         Relaton::Cli::RelatonFile.concatenate(
           asset_folder,
-          collection_name,
+          relaton_collection_index_filename,
           title: manifest[:collection_name],
           organization: manifest[:collection_organization],
         )
       end
 
-      def compile(source)
+      def compile_file!(source)
         if collection_file?(source)
           return
         end
 
         UI.info("Compiling #{source} ...")
 
+        # Incorporate output_filename_template so the output file
+        # can be named as desired, using liquid template and Relaton LiquidDrop
         options = @compile_options.merge(
-          format: :asciidoc, output_dir: build_asset_output_directory(source),
-          site_generate: true
+          output_filename_template: output_filename_template,
+          format: :asciidoc,
+          output_dir: build_asset_output_directory!(source),
+          site_generate: true,
         )
 
         options[:baseassetpath] = Pathname.new(source.to_s).dirname.to_s
         Metanorma::Cli::Compiler.compile(source.to_s, options)
       end
 
-      def convert_to_html_page(collection, page_name)
+      def compile_files!(files)
+        fatals = files.map { |source| compile_file!(source) }
+        fatals.flatten!
+        fatals.compact!
+
+        raise Errors::FatalCompilationError, fatals unless fatals.empty?
+      end
+
+      # Given a path, return the full path if it is not nil.
+      # If the path is absolute, return the path as is.
+      # If the path is relative, return the path relative to the base path.
+      # @param some_path [String, nil] the path to be converted to full path
+      # @return [String, nil] the full path
+      def full_path_for(some_path)
+        if some_path.nil?
+          nil
+        elsif Pathname.new(some_path).absolute?
+          some_path
+        elsif !base_path.nil?
+          base_path.join(some_path)
+        end
+      end
+
+      def convert_to_html_page!(
+        relaton_index_filename, page_name
+      )
         UI.info("Generating html site in #{site_path} ...")
 
-        Relaton::Cli::XMLConvertor.to_html(collection, stylesheet, template_dir)
-        File.rename(Pathname.new(collection).sub_ext(".html").to_s, page_name)
+        Relaton::Cli::XMLConvertor.to_html(
+          relaton_index_filename,
+          full_path_for(stylesheet),
+          full_path_for(template_dir),
+        )
+
+        File.rename(
+          Pathname.new(relaton_index_filename).sub_ext(".html").to_s,
+          page_name,
+        )
       end
 
       def template_data(node)
-        template_node = manifest[:template]
-        template_node&.fetch(node.to_s, nil)
+        manifest[:template]&.public_send(node.to_s)
       end
 
       def manifest
         @manifest ||= config_from_manifest || {
-          files: [], collection_name: "", collection_organization: ""
+          files: [],
+          collection_name: "",
+          collection_organization: "",
         }
       end
 
       def config_from_manifest
         if manifest_file
-          manifest_config(YAML.safe_load(File.read(manifest_file.to_s)))
+          manifest_config(
+            Metanorma::SiteManifest::Base.from_yaml(
+              File.read(manifest_file.to_s),
+            ),
+          )
         end
       end
 
-      def manifest_config(manifest)
+      def manifest_config(manifest_model)
         {
-          files: extract_config_data(
-            manifest["metanorma"]["source"], "files"
-          ) || [],
-
-          collection_name: extract_config_data(
-            manifest["metanorma"]["collection"], "name"
-          ),
-
-          collection_organization: extract_config_data(
-            manifest["metanorma"]["collection"], "organization"
-          ),
-
-          template: extract_config_data(manifest["metanorma"], "template"),
+          files: manifest_model&.metanorma&.source&.files || [],
+          template: manifest_model&.metanorma&.template,
+          collection_name: manifest_model
+            .metanorma
+            .collection
+            .name,
+          collection_organization: manifest_model
+            .metanorma
+            .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
+        @source_from_manifest ||= begin
+          result = manifest[:files].map do |source_file|
+            file_path = source.join(source_file).to_s
+            file_path.include?("*") ? Dir.glob(file_path) : file_path
+          end
+          result.flatten!
+          result
+        end
       end
 
       def ensure_site_asset_directory!
@@ -163,7 +234,7 @@ module Metanorma
         FileUtils.mkdir_p(directory) unless directory.exist?
       end
 
-      def build_asset_output_directory(source)
+      def build_asset_output_directory!(source)
         sub_directory = Pathname.new(source.gsub(@source.to_s, "")).dirname.to_s
         sub_directory.gsub!("/sources", "")
         sub_directory.slice!(0)
@@ -182,7 +253,7 @@ module Metanorma
         end
       end
 
-      def dequeue_jobs
+      def dequeue_jobs!
         job = @collection_queue.pop
 
         if job
@@ -190,6 +261,7 @@ module Metanorma
             job,
             compile: @compile_options,
             output_dir: @asset_directory.join(".."),
+            site_generate: true,
           )
         end
       end

data/lib/metanorma/cli/template_repo.rb

@@ -1,12 +1,11 @@
 require "yaml"
 require "metanorma-utils"
 
-#require "metanorma/cli/stringify_all_keys"
+# require "metanorma/cli/stringify_all_keys"
 
 module Metanorma
   module Cli
     class TemplateRepo
-
       Hash.include Metanorma::Utils::Hash
       Array.include Metanorma::Utils::Array
 
@@ -38,7 +37,7 @@ module Metanorma
       end
 
       def template_config_file
-        @template_config_file ||= Cli.config_path(true)
+        @template_config_file ||= Cli.config_path(global: true)
       end
 
       def create_template_config
@@ -60,7 +59,9 @@ module Metanorma
         names = templates[:templates].map { |template| template[:name].to_s }
 
         if names.include?(name.to_s) && overwrite == false
-          raise Errors::DuplicateTemplateError.new("Duplicate metanorma template")
+          raise Errors::DuplicateTemplateError.new(
+            "Duplicate metanorma template",
+          )
         end
 
         templates[:templates].push({ name: name, source: source, type: type })

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.12.1".freeze
+    VERSION = "1.12.4".freeze
   end
 end

data/lib/metanorma/cli.rb

@@ -3,13 +3,14 @@
 require "metanorma"
 require "metanorma/flavor"
 
+require "metanorma/site_manifest"
+
 require "metanorma/cli/version"
 require "metanorma/cli/errors"
 require "metanorma/cli/command"
 
 module Metanorma
   module Cli
-
     CONFIG_DIRNAME = ".metanorma"
     CONFIG_FILENAME = "config.yml"
 
@@ -32,7 +33,7 @@ module Metanorma
       end
 
       Metanorma::Cli::Command.start(arguments)
-    rescue Interrupt, SignalException => _e
+    rescue SignalException # `Interrupt` inherits from this
       UI.say("Process cancelled, exiting.")
     rescue Errors::FileNotFoundError => e
       UI.say("Error: #{e}. \nNot sure what to run? try: metanorma help")
@@ -65,7 +66,7 @@ module Metanorma
       Pathname.new(Dir.pwd).join(CONFIG_DIRNAME, CONFIG_FILENAME)
     end
 
-    def self.config_path(global = false)
+    def self.config_path(global: false)
       return global_config_path if global
 
       local_config_path
@@ -91,7 +92,7 @@ module Metanorma
 
     def self.find_command(arguments)
       commands = Metanorma::Cli::Command.all_commands.keys
-      commands.select { |cmd| arguments.include?(cmd.gsub("_", "-")) == true }
+      commands.select { |cmd| arguments.include?(cmd.tr("_", "-")) == true }
     end
 
     def self.print_fatal_summary(error)

data/lib/metanorma/flavor.rb

@@ -14,7 +14,7 @@ module Metanorma
       "metanorma-csa",
       "metanorma-iho",
       "metanorma-jis",
-      # "metanorma-m3aawg", 
+      # "metanorma-m3aawg",
       "metanorma-generic",
       "metanorma-standoc",
       # "metanorma-un",
@@ -56,7 +56,11 @@ module Metanorma
     private
 
     def flavors
-      @flavors ||= [SUPPORTED_GEMS + PRIVATE_SUPPORTED_GEMS].flatten.uniq
+      @flavors ||= begin
+        result = [SUPPORTED_GEMS + PRIVATE_SUPPORTED_GEMS].flatten
+        result.uniq!
+        result
+      end
     end
 
     def gem_loading_error(flavor_name)

data/lib/metanorma/site_manifest.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Metanorma
+  module SiteManifest
+    class SourceEntries < Lutaml::Model::Serializable
+      attribute :files, :string, collection: true
+    end
+
+    class SiteMetadata < Lutaml::Model::Serializable
+      attribute :organization, :string
+      attribute :name, :string
+    end
+
+    class SiteTemplate < Lutaml::Model::Serializable
+      attribute :path, :string
+      attribute :stylesheet, :string
+      attribute :output_filename, :string
+    end
+
+    class Manifest < Lutaml::Model::Serializable
+      attribute :source, SourceEntries
+      attribute :collection, SiteMetadata
+      attribute :template, SiteTemplate
+    end
+
+    class Base < Lutaml::Model::Serializable
+      attribute :metanorma, Manifest
+    end
+  end
+end

data/metanorma-cli.gemspec

@@ -25,45 +25,33 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 3.1.0"
 
-  spec.add_development_dependency "debug"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-command", "~> 1.0.3"
-  spec.add_development_dependency "rspec-core", "~> 3.4"
-  spec.add_development_dependency "simplecov", "~> 0.15"
-  spec.add_development_dependency "vcr", "~> 6.1.0"
-  spec.add_development_dependency "webmock"
-  # need for dev because locally compiled metanorma-iso does not have css
-  spec.add_development_dependency "rubocop", "~> 1"
-spec.add_development_dependency "rubocop-performance"
-  spec.add_development_dependency "sassc-embedded"
-  spec.add_development_dependency "xml-c14n"
+  spec.add_dependency "metanorma-ietf", "~> 3.5.0"
+  spec.add_dependency "metanorma-iso", "~> 3.0.0"
+  spec.add_dependency "mnconvert"
+  # spec.add_dependency "thor", "~> 1.0" # inherited from vectory
+  # spec.add_dependency "metanorma-gb", "~> 1.5.0"
+  spec.add_dependency "metanorma-cc", "~> 2.6.0"
+  spec.add_dependency "metanorma-csa", "~> 2.6.0"
+  spec.add_dependency "metanorma-iec", "~> 2.6.0"
+  # spec.add_dependency 'metanorma-ribose', "~> 2.3.0"
+  spec.add_dependency "metanorma-bipm", "~> 2.6.0"
+  spec.add_dependency "metanorma-generic", "~> 3.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.0.0"
+  # spec.add_dependency 'metanorma-mpfa', "~> 0.9.0"
+  spec.add_dependency "git", "~> 1.5"
+  spec.add_dependency "lutaml-model"
+  spec.add_dependency "metanorma", "~> 2.1.0"
+  spec.add_dependency "metanorma-iho", "~> 1.1.0"
+  spec.add_dependency "metanorma-itu", "~> 2.6.0"
+  # spec.add_dependency "metanorma-nist", "~> 2.6.0"
+  spec.add_dependency "liquid", "~> 5"
+  spec.add_dependency "metanorma-ieee", "~> 1.4.0"
+  spec.add_dependency "metanorma-jis", "~> 0.5.0"
+  spec.add_dependency "metanorma-ogc", "~> 2.7.0"
+  spec.add_dependency "metanorma-plateau", "~> 1.0.0"
+  spec.add_dependency "relaton-cli", ">= 0.8.2"
 
-  spec.add_runtime_dependency "metanorma-ietf", "~> 3.5.0"
-  spec.add_runtime_dependency "metanorma-iso", "~> 3.0.0"
-  spec.add_runtime_dependency "mnconvert"
-  # spec.add_runtime_dependency "thor", "~> 1.0" # inherited from vectory
-  # spec.add_runtime_dependency "metanorma-gb", "~> 1.5.0"
-  spec.add_runtime_dependency "metanorma-cc", "~> 2.6.0"
-  spec.add_runtime_dependency "metanorma-csa", "~> 2.6.0"
-  spec.add_runtime_dependency "metanorma-iec", "~> 2.6.0"
-  # spec.add_runtime_dependency 'metanorma-ribose', "~> 2.3.0"
-  spec.add_runtime_dependency "metanorma-bipm", "~> 2.6.0"
-  spec.add_runtime_dependency "metanorma-generic", "~> 3.0.0"
-  spec.add_runtime_dependency "metanorma-standoc", "~> 3.0.0"
-  # spec.add_runtime_dependency 'metanorma-mpfa', "~> 0.9.0"
-  spec.add_runtime_dependency "git", "~> 1.5"
-  spec.add_runtime_dependency "metanorma", "~> 2.1.0"
-  spec.add_runtime_dependency "metanorma-iho", "~> 1.1.0"
-  spec.add_runtime_dependency "metanorma-itu", "~> 2.6.0"
-  # spec.add_runtime_dependency "metanorma-nist", "~> 2.6.0"
-  spec.add_runtime_dependency "metanorma-ieee", "~> 1.4.0"
-  spec.add_runtime_dependency "metanorma-jis", "~> 0.5.0"
-  spec.add_runtime_dependency "metanorma-ogc", "~> 2.7.0"
-  spec.add_runtime_dependency "metanorma-plateau", "~> 0.2.0"
-  spec.add_runtime_dependency "relaton-cli", ">= 0.8.2"
-
-  spec.add_runtime_dependency "socksify"
+  spec.add_dependency "socksify"
   # spec.metadata["rubygems_mfa_required"] = "true"
   # NOBODY UNCOMMENTS THIS WITHOUT EXPLAINING TO ME HOW TO USE MFA
 end

metadata

@@ -1,183 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.12.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-command
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sassc-embedded
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: xml-c14n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf
   requirement: !ruby/object:Gem::Requirement
@@ -318,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  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'
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -360,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: metanorma-ieee
   requirement: !ruby/object:Gem::Requirement
@@ -408,14 +268,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: relaton-cli
   requirement: !ruby/object:Gem::Requirement
@@ -489,6 +349,7 @@ files:
 - lib/metanorma/cli/ui.rb
 - lib/metanorma/cli/version.rb
 - lib/metanorma/flavor.rb
+- lib/metanorma/site_manifest.rb
 - metanorma-cli.gemspec
 - templates/base/Gemfile
 - templates/base/metanorma.yml