metanorma-cli 1.3.8.1pre → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93a7bec949aa815fdeceb45ee6bbcb4e2f0d15590801122a45c27965295f7add
-  data.tar.gz: 9e878d05171e287f968b0276f817c447db831fda158c48d8d9f47a21fc7c36b9
+  metadata.gz: 612b4c15af1376248ef7a54ff2b9391644359954d06d998079955ef691946aeb
+  data.tar.gz: dd83cfa8bbeab98dd8699c90f0d7bbd65923afa6548436cfc87f5352e1df0133
 SHA512:
-  metadata.gz: bb8131a26ec352775675ec11a8672f5eed4781fbb2f61953de654e87e1d902446aac690da849de73a5ebe44074991389811118ef794bd4fc1428b58e40f745ea
-  data.tar.gz: fd06fc9bf029476d4c7ce552bbfae6a9c9ae618b8fd59ae9692f136994044660e0a930de6f303d5cf4251d3b1423f9f73cf9de7c72dff5c13b56b6f7f9399f43
+  metadata.gz: 1ce6b2cf16551c745b456fee569ee4a58aed0c66142ee4c7b6a37cc6e57199ebf89a9fe2b725317dfd8e69e865e43e2985c87d2151fe6cd8a8fe23a85daa23b5
+  data.tar.gz: 7133934960cc61e6f41364b6001d77ff28f1f798cf558d606fbdcc17fe7755e960a82b084f929e5f0d1daf1bcefc858920ed7b55e05b20083470766ec1754383

data/Gemfile

@@ -4,6 +4,7 @@ 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

@@ -285,6 +285,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

@@ -9,7 +9,8 @@ module Metanorma
       "metanorma-iso",
       "metanorma-iec",
       "metanorma-ietf",
-      "metanorma-gb",
+      #"metanorma-gb",
+      "metanorma-bipm",
       "metanorma-cc",
       "metanorma-csa",
       "metanorma-iho",
@@ -81,14 +82,6 @@ module Metanorma
       Pathname.new(Dir.home).join(".metanorma")
     end
 
-    def self.fonts_directory
-      Metanorma::Cli.home_directory.join("fonts")
-    end
-
-    def self.fonts
-      Dir.glob(Metanorma::Cli.fonts_directory.join("**"))
-    end
-
     def self.writable_templates_path?
       parent_directory = templates_path.join("..", "..")
 

data/lib/metanorma/cli/command.rb

@@ -1,9 +1,9 @@
 require "thor"
-require "metanorma/cli/setup"
 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
@@ -32,6 +32,10 @@ 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"
+
       def compile(file_name = nil)
         if file_name && !options[:version]
           Metanorma::Cli.load_flavors
@@ -89,33 +93,8 @@ module Metanorma
       desc "template-repo", "Manage metanorma templates repository"
       subcommand :template_repo, Metanorma::Cli::Commands::TemplateRepo
 
-      desc "setup", "Initial necessary setup"
-      option(
-        :agree_to_terms,
-        type: :boolean,
-        required: false,
-        default: false,
-        desc: "Agree / Disagree with all third-party licensing terms presented (WARNING: do know what you are agreeing with!)",
-      )
-
-      def setup
-        list_required_fonts.each do |font|
-          begin
-            Metanorma::Cli::Setup.run(
-              font: font,
-              term_agreement: options[:agree_to_terms],
-            )
-          rescue Fontist::Errors::LicensingError
-            UI.error(
-              "[error]: License acceptance required to install a necessary font." \
-              "Accept required licenses with: `metanorma setup --agree-to-terms`."
-            )
-            return
-          rescue Fontist::Errors::NonSupportedFontError
-            UI.say("[info]: The font `#{font}` is not yet supported.")
-          end
-        end
-      end
+      desc "site", "Manage site for metanorma collections"
+      subcommand :site, Metanorma::Cli::Commands::Site
 
       private
 
@@ -175,19 +154,6 @@ module Metanorma
         )
       end
 
-      def list_required_fonts
-        Metanorma::Cli.load_flavors
-
-        Metanorma::Registry.instance.processors.map do |_key, processor|
-          flavour = processor.class.to_s.gsub("::Processor", "")
-          flavour_module = Object.const_get(flavour)
-
-          if flavour_module.respond_to?(:fonts_used)
-            flavour_module.fonts_used.map { |_, value| value }.flatten
-          end
-        end.compact.flatten.uniq
-      end
-
       def load_flavours(type)
         Metanorma::Cli.load_flavors
         unless Metanorma::Registry.instance.find_processor(type&.to_sym)

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 "site 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,130 @@
+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
+        @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")
+
+        ensure_site_asset_directory!
+      end
+
+      def self.generate(source, options = {})
+        new(source, options).generate
+      end
+
+      def generate
+        site_directory = asset_directory.join("..")
+
+        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
+      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 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_folder
+        )
+      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,6 +11,10 @@ module Metanorma
         new.say(message)
       end
 
+      def self.info(message)
+        new.say(["[info]", message].join(": "))
+      end
+
       def self.error(message)
         new.error(message)
       end

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.3.8.1pre"
+    VERSION = "1.4.0"
   end
 end

data/metanorma-cli.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rspec-command", "~> 1.0.3"
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "rspec-core", "~> 3.4"
   spec.add_development_dependency "vcr", "~> 5.0.0"
   spec.add_development_dependency "webmock"
@@ -39,24 +38,24 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "thor", "~> 1.0"
   spec.add_runtime_dependency "metanorma-iso", "~> 1.5.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-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.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.7.0"
-  spec.add_runtime_dependency 'metanorma-standoc', "~> 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-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.2.0"
-  spec.add_runtime_dependency 'metanorma', "~> 1.2.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 "metanorma", "~> 1.2.0"
   spec.add_runtime_dependency "git", "~> 1.5"
   spec.add_runtime_dependency "relaton-cli", ">= 0.8.2"
-  spec.add_runtime_dependency "fontist", "~> 1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.8.1pre
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -207,49 +193,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: metanorma-gb
+  name: metanorma-iec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: metanorma-iec
+  name: metanorma-cc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: metanorma-cc
+  name: metanorma-csa
   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-csa
+  name: metanorma-m3aawg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -263,33 +249,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: metanorma-m3aawg
+  name: metanorma-bipm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: metanorma-generic
   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-standoc
   requirement: !ruby/object:Gem::Requirement
@@ -380,14 +366,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -430,20 +416,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
-- !ruby/object:Gem::Dependency
-  name: fontist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 description: Executable to process any Metanorma standard.
 email:
 - open.source@ribose.com
@@ -489,12 +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/setup.rb
+- lib/metanorma/cli/site_generator.rb
 - lib/metanorma/cli/template_repo.rb
 - lib/metanorma/cli/ui.rb
 - lib/metanorma/cli/version.rb
@@ -518,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key:

data/lib/metanorma/cli/setup.rb

@@ -1,73 +0,0 @@
-require "fontist"
-require "fileutils"
-
-module Metanorma
-  module Cli
-    class Setup
-      def initialize(options)
-        @options = options
-        @font_name = options.fetch(:font)
-        @term_agreement = options.fetch(:term_agreement, false)
-
-        create_metanorma_fonts_directory
-      end
-
-      def self.run(options = {})
-        new(options).run
-      end
-
-      def run
-        font = Metanorma::Cli.fonts.grep(/#{font_name}/i)
-
-        if font.empty?
-          font_paths = download_font
-          copy_to_fonts(font_paths)
-        end
-      end
-
-      private
-
-      attr_reader :font_name, :options, :term_agreement
-
-      def create_metanorma_fonts_directory
-        unless Metanorma::Cli.fonts_directory.exist?
-          FileUtils.mkdir_p(Metanorma::Cli.fonts_directory)
-        end
-      end
-
-      def metanorma_fonts_path
-        @metanorma_fonts_path ||= Metanorma::Cli.fonts_directory
-      end
-
-      def download_font
-        begin
-          Fontist::Font.find(font_name)
-        rescue Fontist::Errors::MissingFontError
-          process_font_installation(font_name)
-        end
-      end
-
-      def copy_to_fonts(fonts_path)
-        fonts_path.each do |font_path|
-          font_name = File.basename(font_path)
-          FileUtils.copy_file(font_path, metanorma_fonts_path.join(font_name))
-        end
-      end
-
-      def process_font_installation(font_name)
-        accepted_agreement = term_agreement == true ? "yes" : "no"
-
-        UI.say(missing_font_message) if !term_agreement
-        Fontist::Font.install(font_name, confirmation: accepted_agreement)
-      end
-
-      def missing_font_message
-        <<~MSG
-          Your system does not have the necessary fonts installed for
-          PDF generation. Without these fonts, the generated PDF will use
-          generic fonts that may not resemble the desired styling.\n
-        MSG
-      end
-    end
-  end
-end