metanorma-cli 1.4.1 → 1.4.3pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88ec404d073b5b55e98c46ac5709db3abb0e090855abbe4e5fd37ccb1c6fe1b
-  data.tar.gz: fe29640074f35365f061b89227c11a0b4f45e47a8704244c8468bf1f8f3813c0
+  metadata.gz: 411678c2078b06cfa0528e83d9b58f5ee3511b217a26b04d0b230897cfac69d5
+  data.tar.gz: 77605993b5a0fa317db1562c836541d51f52856648188a8fb01f4e490ea0aa7c
 SHA512:
-  metadata.gz: 0d1a7bd16a4a5f94ab4a519e1e0f4e7625a553f58c16c68f5e7c09c68873d326153e13eb5ba4d34528f220301984b2cc3155426c1bc3a3476f3826adb4927902
-  data.tar.gz: adec9799ab747d3c47645ba328d301728d75dcfd714117a8a459fe08d798ae95fad8d71ac51783b294e2f800a8b0e261c760228d7a9149db42b7b819b2b8735d
+  metadata.gz: f0d041079818b8ed93add453ee9a1720a7f38b556b89db1b767dd7e1c915b878d975b14c7882bcf87aaa856ef9581c426a380fc9352a9b107e3aec0367b9a071
+  data.tar.gz: c46af918088b7b91f4645efceb7df3a0f426b939e7a8a257770416f11a725f5f0665fdbf63bafd0947a249fd5e7a225e92b7cbc73612c4acd033d6dc6631b90f

data/README.adoc

@@ -183,8 +183,6 @@ are `ietf`, `iso`, `gb`, `csd`, `csand`, `m3d` and `rsd`.
 
 === Compile a document collection (`metanorma collection`)
 
-(_This is placeholder for more complete documentation later._)
-
 This functionality compiles collections of Metanorma documents. It compiles
 the individual documents comprising the collection; then it compiles a document
 acting as a container for those collections. See 
@@ -198,7 +196,7 @@ which contains:
 * Metadata about the collection
 * A manifest listing the documents contained in the collection, in nested hierarchy
 * Content to put at the beginning of the collection container
-* Content to put at the endeginning of the collection container
+* Content to put at the ending of the collection container
 
 Documents within a collection
 may cross-reference each other using the syntax 

data/lib/metanorma/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "metanorma"
 require "metanorma/cli/version"
 require "metanorma/cli/errors"
@@ -23,6 +25,9 @@ module Metanorma
       "metanorma-itu",
     ]
 
+    CONFIG_DIRNAME = ".metanorma"
+    CONFIG_FILENAME = "config.yml"
+
     PRIVATE_SUPPORTED_GEMS = ["metanorma-ribose", "metanorma-mpfa"]
 
     def self.load_flavors(flavor_names = SUPPORTED_GEMS + PRIVATE_SUPPORTED_GEMS)
@@ -79,7 +84,21 @@ module Metanorma
     end
 
     def self.home_directory
-      Pathname.new(Dir.home).join(".metanorma")
+      Pathname.new(Dir.home).join(CONFIG_DIRNAME)
+    end
+
+    def self.global_config_path
+      home_directory.join(CONFIG_FILENAME)
+    end
+
+    def self.local_config_path
+      Pathname.new(Dir.pwd).join(CONFIG_DIRNAME, CONFIG_FILENAME)
+    end
+
+    def self.config_path(global = false)
+      return global_config_path if global
+
+      local_config_path
     end
 
     def self.writable_templates_path?

data/lib/metanorma/cli/command.rb

@@ -1,14 +1,15 @@
-require "thor"
 require "metanorma/cli/compiler"
 require "metanorma/cli/generator"
 require "metanorma/cli/git_template"
+require "metanorma/cli/thor_with_config"
+require "metanorma/cli/commands/config"
 require "metanorma/cli/commands/template_repo"
 require "metanorma/cli/commands/site"
 require "metanorma"
 
 module Metanorma
   module Cli
-    class Command < Thor
+    class Command < ThorWithConfig
       desc "new NAME", "Create new Metanorma document"
       option :type, aliases: "-t", required: true, desc: "Document type"
       option :doctype, aliases: "-d", required: true, desc: "Metanorma doctype"
@@ -16,7 +17,7 @@ module Metanorma
       option :template, aliases: "-l", desc: "Git hosted remote or local FS template skeleton"
 
       def new(name)
-        create_new_document(name, options.dup)
+        create_new_document(name, options)
       end
 
       desc "compile FILENAME", "Compile to a metanorma document"
@@ -30,16 +31,16 @@ module Metanorma
       option :relaton, aliases: "-R", desc: "Export Relaton XML for document to nominated filename"
       option :extract, aliases: "-e", 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 :"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 :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"
 
       def compile(file_name = nil)
         if file_name && !options[:version]
           Metanorma::Cli.load_flavors
-          errs = Metanorma::Cli::Compiler.compile(file_name, options.dup)
+          errs = Metanorma::Cli::Compiler.compile(file_name, options)
           errs.each { |e| Util.log e, :error }
           exit(1) if errs.any?
 
@@ -56,18 +57,18 @@ module Metanorma
 
       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", required: true, desc: "Directory to save compiled files"
+      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"
+      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 = options
           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
+          opts[:compile] = filter_compile_options(opts)
           coll = Metanorma::Collection.parse filename
           coll.render opts
         else UI.say("Need to specify a file to process")
@@ -111,6 +112,9 @@ module Metanorma
       desc "site", "Manage site for metanorma collections"
       subcommand :site, Metanorma::Cli::Commands::Site
 
+      desc "config", "Manage configuration file"
+      subcommand :config, Metanorma::Cli::Commands::Config
+
       private
 
       def single_type_extensions(type)

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

@@ -0,0 +1,118 @@
+require "pathname"
+
+require "metanorma/cli/stringify_all_keys"
+
+module Metanorma
+  module Cli
+    module Commands
+      class Config < Thor
+        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)
+
+          if name.nil?
+            UI.say File.read(config_path, encoding: "utf-8")
+          else
+            UI.say(config.dig(*dig_path(name)) || "nil")
+          end
+        end
+
+        desc "set NAME VALUE", "Set config value"
+        def set(name, value = nil)
+          config, config_path = load_config(options.global)
+
+          value = try_convert_to_bool(value)
+          ypath = dig_path(name)
+          deep_set(config, value, *ypath)
+
+          save_config(config, config_path)
+        end
+
+        desc "unset [name]", "Set config [value] for [name]"
+        def unset(name)
+          config, config_path = load_config(options.global)
+
+          ypath = dig_path(name)
+          deep_unset(config, *ypath)
+
+          save_config(config, config_path)
+        end
+
+        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
+        # - 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])
+          result = options.dup
+          configs.each do |config_path|
+            next unless File.exists?(config_path)
+
+            config_values = ::YAML::load_file(config_path).symbolize_all_keys[:cli] || {}
+            result.merge!(config_values)
+          end
+
+          result
+        end
+
+        private
+
+        def save_config(config, path)
+          shash = config.stringify_all_keys
+          File.write(path, shash.to_yaml, encoding: "utf-8")
+        end
+
+        def save_default_config(config_path)
+          unless config_path.exist?
+            unless config_path.dirname.exist?
+              FileUtils.mkdir_p(config_path.dirname)
+            end
+            save_config({ cli: nil }, config_path)
+          end
+        end
+
+        def load_config(global_config)
+          config_path = Metanorma::Cli.config_path(global_config)
+          save_default_config(config_path) unless File.exists?(config_path)
+
+          [::YAML::load_file(config_path).symbolize_all_keys || {}, config_path]
+        end
+
+        def dig_path(str)
+          str.split(".").map(&:to_sym)
+        end
+
+        def deep_set(hash, value, *keys)
+          keys[0...-1].reduce(hash) do |acc, h|
+            tmp = acc.public_send(:[], h)
+            if tmp.nil?
+              acc[h] = tmp = Hash.new
+            end
+            tmp
+          end.public_send(:[]=, keys.last, value)
+        end
+
+        def deep_unset(hash, *keys)
+          keys[0...-1].reduce(hash) do |acc, h|
+            acc.public_send(:[], h)
+          end.delete(keys.last)
+        end
+
+        def try_convert_to_bool(value)
+          case value
+          when "true"
+            true
+          when "false"
+            false
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,21 +1,26 @@
 require "pathname"
 require "metanorma/cli/site_generator"
+require "metanorma/cli/thor_with_config"
 
 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"
+      class Site < ThorWithConfig
+        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").to_s,
-          desc: "Output directory for the generated site",
+          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 :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 generate(source_path)
-          Cli::SiteGenerator.generate(source_path, options.dup)
+          Cli::SiteGenerator.generate(source_path, options, filter_compile_options(options))
           UI.say("Site has been generated at #{options[:output_dir]}")
         rescue Cli::Errors::InvalidManifestFileError
           UI.error("Invalid data in: #{options[:config]}")

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

@@ -1,9 +1,10 @@
 require "metanorma/cli/template_repo"
+require "metanorma/cli/thor_with_config"
 
 module Metanorma
   module Cli
     module Commands
-      class TemplateRepo < Thor
+      class TemplateRepo < ThorWithConfig
         desc "add NAME SOURCE", "Add new metanorma templates repository"
         option :overwrite, aliases: "-y", type: :boolean, desc: "Overwrite existing template"
 

data/lib/metanorma/cli/site_generator.rb

@@ -5,18 +5,18 @@ require "fileutils"
 module Metanorma
   module Cli
     class SiteGenerator
-      def initialize(source, options = {})
+      def initialize(source, options = {}, compile_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))
-
+        @compile_options = compile_options
         ensure_site_asset_directory!
       end
 
-      def self.generate(source, options = {})
-        new(source, options).generate
+      def self.generate(source, options = {}, compile_options = {})
+        new(source, options, compile_options).generate
       end
 
       def generate
@@ -70,9 +70,9 @@ module Metanorma
       def compile(source)
         UI.info("Compiling #{source} ...")
 
-        Metanorma::Cli::Compiler.compile(
-          source.to_s, format: :asciidoc, "output-dir" => asset_directory
-        )
+        opts = @compile_options.merge(format: :asciidoc, output_dir: asset_directory)
+
+        Metanorma::Cli::Compiler.compile(source.to_s, opts)
       end
 
       def convert_to_html_page(collection, page_name)
@@ -101,11 +101,11 @@ module Metanorma
           ) || [],
 
           collection_name: extract_config_data(
-            manifest["relaton"]["collection"], "name"
+            manifest["metanorma"]["collection"], "name"
           ),
 
           collection_organization: extract_config_data(
-            manifest["relaton"]["collection"], "organization"
+            manifest["metanorma"]["collection"], "organization"
           ),
         }
       rescue NoMethodError

data/lib/metanorma/cli/stringify_all_keys.rb

@@ -0,0 +1,51 @@
+class Array
+  def stringify_all_keys
+    map do |v|
+      case v
+      when Hash, Array
+        v.stringify_all_keys
+      else
+        v
+      end
+    end
+  end
+
+  def symbolize_all_keys
+    map do |v|
+      case v
+      when Hash, Array
+        v.symbolize_all_keys
+      else
+        v
+      end
+    end
+  end
+end
+
+class Hash
+  def stringify_all_keys
+    result = {}
+    each do |k, v|
+      result[k.to_s] = case v
+                       when Hash, Array
+                         v.stringify_all_keys
+                       else
+                         v
+                       end
+    end
+    result
+  end
+
+  def symbolize_all_keys
+    result = {}
+    each do |k, v|
+      result[k.to_sym] = case v
+                         when Hash, Array
+                           v.symbolize_all_keys
+                         else
+                           v
+                         end
+    end
+    result
+  end
+end

data/lib/metanorma/cli/template_repo.rb

@@ -1,5 +1,7 @@
 require "yaml"
 
+require "metanorma/cli/stringify_all_keys"
+
 module Metanorma
   module Cli
     class TemplateRepo
@@ -27,11 +29,11 @@ module Metanorma
       attr_reader :name, :source, :type, :overwrite
 
       def templates
-        @templates ||= YAML.load(template_config_file.read)
+        @templates ||= YAML.load_file(template_config_file).symbolize_all_keys
       end
 
       def template_config_file
-        @template_config_file ||= Cli.home_directory.join("config.yml")
+        @template_config_file ||= Cli.config_path(true)
       end
 
       def create_template_config
@@ -40,12 +42,13 @@ module Metanorma
             FileUtils.mkdir_p(template_config_file.dirname)
           end
 
-          write_to_template_config({templates: []})
+          write_to_template_config(templates: [])
         end
       end
 
       def write_to_template_config(templates)
-        File.write(template_config_file, templates.to_yaml)
+        shash = templates.stringify_all_keys
+        File.write(template_config_file, shash.to_yaml)
       end
 
       def add_new_template(name, source, type)

data/lib/metanorma/cli/thor_with_config.rb

@@ -0,0 +1,23 @@
+require "thor"
+
+require_relative "stringify_all_keys"
+
+module Metanorma
+  module Cli
+    class ThorWithConfig < Thor
+      no_commands do
+        def options
+          @options_cache
+          original_options = super.to_hash.symbolize_all_keys
+          @options_cache = Metanorma::Cli::Commands::Config.load_configs(original_options)
+        end
+
+        def filter_compile_options(options)
+          options.select do |k, _|
+            %i[agree_to_terms no_install_fonts continue_without_fonts].include?(k)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.4.1"
+    VERSION = "1.4.3pre"
   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.6.0"
+  spec.add_runtime_dependency "metanorma-iso", "~> 1.7.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.2"
-  spec.add_runtime_dependency "metanorma-standoc", "~> 1.7.0"
+  spec.add_runtime_dependency "metanorma-generic", "~> 1.9.0"
+  spec.add_runtime_dependency "metanorma-standoc", "~> 1.8.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.4.2"
+  spec.add_runtime_dependency "isodoc", ">= 1.5.0"
   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.1
+  version: 1.4.3pre
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -170,14 +170,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-ietf
   requirement: !ruby/object:Gem::Requirement
@@ -268,28 +268,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.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.4.2
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -461,6 +461,7 @@ files:
 - lib/metanorma-cli.rb
 - lib/metanorma/cli.rb
 - lib/metanorma/cli/command.rb
+- lib/metanorma/cli/commands/config.rb
 - lib/metanorma/cli/commands/site.rb
 - lib/metanorma/cli/commands/template_repo.rb
 - lib/metanorma/cli/compiler.rb
@@ -468,7 +469,9 @@ files:
 - lib/metanorma/cli/generator.rb
 - lib/metanorma/cli/git_template.rb
 - lib/metanorma/cli/site_generator.rb
+- lib/metanorma/cli/stringify_all_keys.rb
 - lib/metanorma/cli/template_repo.rb
+- lib/metanorma/cli/thor_with_config.rb
 - lib/metanorma/cli/ui.rb
 - lib/metanorma/cli/version.rb
 - metanorma-cli.gemspec
@@ -491,9 +494,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: