metanorma-cli 1.3.9 → 1.4.0pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a03b03e99303cba8dba1f9cff78ee1e8b2398f717619b193460a58c8bbcd423d
-  data.tar.gz: 00a06a5126c12f57e1e5a7a77337a600606cd25b026439865012fb41907af664
+  metadata.gz: 88924f3243331ffe69a875d04a60ba95b22a7dc2a580b3d7019f919a4b930da7
+  data.tar.gz: 238e5f13c374e907ab8d4245e1ac3794891c6cb24b9da0e3c4abd66c982e9c33
 SHA512:
-  metadata.gz: 32ae08f01d0435a30d418978eeb8baa0c482ae7e707de6bf12562dc4899c3dc37bef83b6fbdb7778899e37a659dc0bdf2d30bb8abb298c19e8bd8724eedac01a
-  data.tar.gz: 184167a6dca3dc0542e0ff1abf90c7cc96ba92135592939bc28658827e8315a0d6d932578c41a074a3075a20ad4b82593b39ce0e72ebb0093584eb0cc6f27b56
+  metadata.gz: e45a497c87d344efae6f3c5783ad3d1508ef405dba142adf8044d1fc77c733e2c334091bb263389d9ce4e61398ecb3ac3d3f759f4f81887293beff5e6ccf8c61
+  data.tar.gz: 77e5b0b96d5e7ebcb549c3f018f794998c3512165aa13ddc64974ea5ce163b32b919b593206849180a0d22d104d1a275af2be37696f21a49edeb3fec624b8d36

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

@@ -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
@@ -92,6 +93,9 @@ module Metanorma
       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)

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.9"
+    VERSION = "1.4.0pre"
   end
 end

data/metanorma-cli.gemspec

@@ -42,9 +42,10 @@ Gem::Specification.new do |spec|
   #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-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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.0pre
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -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,6 +248,20 @@ 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
@@ -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
@@ -475,9 +491,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: