metanorma-cli 1.5.9 → 1.5.11pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6282445acbd814d5fe7561a6c2f0aa79ebdc3e783c6fc18b79a3ea5b458484ac
-  data.tar.gz: 52f15df8bcb0817ab747f7224866a8099251fcf48a86c6a820558fbb567bdde5
+  metadata.gz: bb86fec8ea47b80c0d2c222cdb382a8bb3a7663a5a32f47fa1fe0bf5e2613aac
+  data.tar.gz: 6d2ec1845f64245a976ebe02f7bd9cf9f26860d83bb38474fcee2c615f61f707
 SHA512:
-  metadata.gz: 05a4a3e14905e1768ae10abdb5bf153896b55ccc73911b2b22d3013dea6d04c8719121aa4f24b315932b7522450935aa634217fd6f995b1b21356f377cdebc8a
-  data.tar.gz: 5e04c708242ce2917d62887920aa966aafa285ff7829006bef98101a49bf3321820c7db73db3a662c216aea7765231cb009c3e323ccf67b594a2933ea98acad0
+  metadata.gz: aa1e985a5d785198342198a84c246f01e3300e5e3d6a6923b145f8a85f90b632479debf269a46b57c4b3fe78036f83458e10d571c5440d2bcc06c88113201013
+  data.tar.gz: 253ff1579d0cd22278d98a9913c54877c0d7ae4d965cb6044fc297d41b7c5042763c7a59033c71cf8a74d2bc01ab13a95e15f526420233223b8832824be84c5a

data/docs/installation.adoc

@@ -4,24 +4,19 @@ The `metanorma` command-line executable is installed by this Ruby gem.
 
 [IMPORTANT]
 ====
-Users of the Metanorma suite should install Metanorma according to the steps at
-the
-https://www.metanorma.org/author/topics/install/[Metanorma installation guide].
+Users of the Metanorma suite should install Metanorma according to the steps at the https://www.metanorma.org/author/topics/install/[Metanorma installation guide].
 
 The instructions provided here are intended for Metanorma developers, since
 a number of third-party dependencies will also need to be installed manually.
 ====
 
-
 == Install Ruby
 
 == macOS
 
-While macOS provides a default installation of Ruby, it is restricted in a
-number of ways.
+While macOS provides a default installation of Ruby, it is restricted in a number of ways.
 
-We strongly recommend installing a Ruby outside of the system Ruby using
-`rbenv`.
+We strongly recommend installing a Ruby outside of the system Ruby using `rbenv`.
 
 [source,console]
 ----
@@ -47,39 +42,39 @@ $ rbenv global 2.7.4
 
 == Linux
 
-Ruby may not be pre-installed on your Linux distribution.
+Ruby is sometimes included with Linux. To see if you already have it (and check the version):
 
-Please follow the official
-https://www.ruby-lang.org/en/documentation/installation[Ruby installation guide].
+1. Open a console/terminal
+2. Type `ruby -v`
 
-== Windows
+If Ruby is installed, you'll see something like the following
+[source, console]
+----
+ruby 3.1.0p0 (2021-12-25 revision fb4df44d16) [x86_64-linux]
+----
 
-Ruby is not pre-installed on Windows.
+If not, follow the official
+https://www.ruby-lang.org/en/documentation/installation[Ruby installation guide].
 
-The easiest way to install Ruby is with `RubyInstaller`, as recommended by
-the official
-https://www.ruby-lang.org/en/documentation/installation[Ruby installation guide])
+== Windows
 
-If you prefer an automated way to install, we recommend using
-https://chocolatey.org/install[Chocolatey] with commands below:
+Ruby is not pre-installed on Windows. There are several ways to install it:
 
-[source,console]
-----
-choco install -y msys2 ruby
-refreshenv
-ridk install 3
-----
+. For an *easy* experience, use `RubyInstaller`, via the official https://www.ruby-lang.org/en/documentation/installation[Ruby installation guide])
+. For a  more *developer-friendly* experience, install Ruby via a Linux distribution (like Ubuntu) hosted in the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/). [Install WSL2]((https://docs.microsoft.com/en-us/windows/wsl/install), and then [Install Ruby](https://gorails.com/setup/ubuntu/21.04).
+. For a *simpler command-line* experience, first install the [Chocolatey](https://chocolatey.org/install) package manager, then add Ruby packaged with [the MSYS2 build tools](https://www.msys2.org/). This process is explained below:
 
-Those commands will work with both PowerShell and CMD.exe.
 
+.. Open a command prompt (`cmd.exe`) or *PowerShell* console.
+.. Type `choco install -y msys2 ruby`. (If you have a firewall, you may be prompted to allow *dirmngr.exe* and *pacman.exe*. These are part of Ruby and are safe).
+.. When the installation completes, type `refreshenv` to make Ruby available to you.
+.. Type `ridk install 3` to complete the installation of Ruby version 3. This make take a while.
 
-== Other
+== Other Ruby Resources
 
 Further details (or FAQ) on Ruby installation please visit the official
 https://www.ruby-lang.org/en/documentation/installation[Ruby installation guide].
 
-
-
 == Installing the Metanorma CLI gem
 
 Once Ruby is installed, you can install `metanorma-cli` as a gem:

data/lib/metanorma/cli/generator.rb

@@ -59,7 +59,7 @@ module Metanorma
           )
         else
           templates = base_templates.merge(type_template)
-          templates.each { |source, dest| create_file(source, dest) }
+          templates.each { |dest, source| create_file(source, dest) }
         end
       end
 
@@ -81,13 +81,17 @@ module Metanorma
 
       def base_templates
         base_template_root = Cli.base_templates_path
-        build_template_hash(dir_files(base_template_root), base_template_root)
+        build_template_hash(base_template_root)
       end
 
       def type_specific_template
-        type_template_path = custom_template || find_standard_template(type)
-        doctype_templates  = dir_files(type_template_path, doctype)
-        build_template_hash(doctype_templates, type_template_path, doctype)
+        template_path = custom_template || find_standard_template(type)
+        return {} if template_path.nil?
+
+        result = build_template_hash(template_path, doctype)
+        return result if result.empty?
+
+        result.merge(build_template_common_hash(template_path))
       end
 
       def custom_template
@@ -100,17 +104,32 @@ module Metanorma
         end
       end
 
-      def build_template_hash(elements, source_root, type = nil)
-        type_template_path = [source_root, type].join("/")
+      def build_template_common_hash(source_root)
+        common_path = Pathname.new(source_root) / "common"
+        paths = dir_files(common_path)
+
+        Hash.new.tap do |hash|
+          paths.each do |path|
+            dest = Pathname.new(path).relative_path_from(common_path).to_s
+            hash[dest] = path
+          end
+        end
+      end
 
+      def build_template_hash(source_root, doctype = nil)
+        source_path = Pathname.new(source_root)
+        source_path /= doctype unless doctype.nil?
+        paths = dir_files(source_path)
         Hash.new.tap do |hash|
-          elements.each do |element|
-            hash[element] = element.gsub(type_template_path, "")
+          paths.each do |path|
+            dest = Pathname.new(path).relative_path_from(source_path).to_s
+            hash[dest] = path
           end
         end
       end
 
       def create_file(source, destination)
+        p "source=#{source} destination=#{destination}"
         target_path = [document_path, destination].join("/")
         target_path = Pathname.new(target_path)
 

data/lib/metanorma/cli/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Cli
-    VERSION = "1.5.9".freeze
+    VERSION = "1.5.11pre".freeze
   end
 end

data/templates/base/metanorma.yml

@@ -1,4 +1,6 @@
 ---
 metanorma:
-  deploy:
-    email: "ci@metanorma.org"
+  source:
+    files:
+      - document.adoc
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-cli
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.5.11pre
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -492,8 +492,6 @@ files:
 - lib/metanorma/flavor.rb
 - metanorma-cli.gemspec
 - templates/base/Gemfile
-- templates/base/Makefile
-- templates/base/Makefile.win
 - templates/base/metanorma.yml
 homepage: https://www.metanorma.com
 licenses:
@@ -510,9 +508,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.32
 signing_key:

data/templates/base/Makefile

@@ -1,196 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-#!make
-SHELL := /bin/bash
-# Ensure the xml2rfc cache directory exists locally
-IGNORE := $(shell mkdir -p $(HOME)/.cache/xml2rfc)
-
-SRC := $(shell yq r metanorma.yml metanorma.source.files | cut -c 3-)
-
-ifeq ($(SRC),null)
-SRC :=
-endif
-ifeq ($(SRC),ll)
-SRC :=
-endif
-
-ifeq ($(SRC),)
-BUILT := $(shell yq r metanorma.yml metanorma.source.built_targets | cut -d ':' -f 1 | tr -s '\n' ' ')
-
-ifeq ($(BUILT),null)
-SRC :=
-endif
-ifeq ($(BUILT),ll)
-SRC :=
-endif
-
-ifeq ($(BUILT),)
-SRC := $(filter-out README.adoc, $(wildcard sources/*.adoc))
-else
-XML := $(patsubst sources/%,documents/%,$(BUILT))
-endif
-endif
-
-FORMATS := $(shell yq r metanorma.yml metanorma.formats | tr -d '[:space:]' | tr -s '-' ' ')
-ifeq ($(FORMATS),)
-FORMAT_MARKER := mn-output-
-FORMATS := $(shell grep "$(FORMAT_MARKER)" $(SRC) | cut -f 2 -d " " | tr "," "\\n" | sort | uniq | tr "\\n" " ")
-endif
-
-XML  ?= $(patsubst sources/%,documents/%,$(patsubst %.adoc,%.xml,$(SRC)))
-HTML := $(patsubst %.xml,%.html,$(XML))
-
-ifdef METANORMA_DOCKER
-  PREFIX_CMD := echo "Running via docker..."; docker run -v "$$(pwd)":/metanorma/ $(METANORMA_DOCKER)
-else
-  ifdef SKIP_BUNDLE
-    PREFIX_CMD := echo "Running locally...";
-  else
-    PREFIX_CMD := echo "Running locally via bundle ..."; bundle exec
-  endif
-endif
-
-_OUT_FILES := $(foreach FORMAT,$(FORMATS),$(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
-OUT_FILES  := $(foreach F,$(_OUT_FILES),$($F))
-
-define print_vars
-	$(info "src $(SRC)")
-	$(info "xml $(XML)")
-	$(info "formats $(FORMATS)")
-endef
-
-all: documents.html
-	$(call print_vars)
-
-documents:
-	mkdir -p $@
-
-documents/%.html: documents/%.xml | documents
-	${PREFIX_CMD} metanorma $<
-
-documents/%.xml: sources/%.xml | documents
-	mkdir -p $(dir $@)
-	mv $< $@
-
-# Build canonical XML output
-# If XML file is provided, copy it over
-# Otherwise, build the xml using adoc
-sources/%.xml: | bundle
-	BUILT_TARGET="$(shell yq r metanorma.yml metanorma.source.built_targets[$@])"; \
-	if [ "$$BUILT_TARGET" = "" ] || [ "$$BUILT_TARGET" = "null" ]; then \
-		BUILT_TARGET=$@; \
-		$(PREFIX_CMD) metanorma -x xml "$${BUILT_TARGET//xml/adoc}"; \
-	else \
-		if [ -f "$$BUILT_TARGET" ] && [ "$${BUILT_TARGET##*.}" == "xml" ]; then \
-			cp "$$BUILT_TARGET" $@; \
-		else \
-			$(PREFIX_CMD) metanorma -x xml $$BUILT_TARGET; \
-			cp "$${BUILT_TARGET//adoc/xml}" $@; \
-		fi \
-	fi
-
-documents.rxl: $(XML) $(HTML)
-	${PREFIX_CMD} relaton concatenate \
-	  -t "$(shell yq r metanorma.yml relaton.collection.name)" \
-		-g "$(shell yq r metanorma.yml relaton.collection.organization)" \
-		documents $@
-
-documents.html: documents.rxl
-	$(PREFIX_CMD) relaton xml2html documents.rxl
-
-%.adoc:
-
-define FORMAT_TASKS
-OUT_FILES-$(FORMAT) := $($(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
-
-open-$(FORMAT):
-	open $$(OUT_FILES-$(FORMAT))
-
-clean-$(FORMAT):
-	rm -f $$(OUT_FILES-$(FORMAT))
-
-$(FORMAT): clean-$(FORMAT) $$(OUT_FILES-$(FORMAT))
-
-.PHONY: clean-$(FORMAT)
-
-endef
-
-$(foreach FORMAT,$(FORMATS),$(eval $(FORMAT_TASKS)))
-
-open: open-html
-
-clean:
-	rm -rf documents documents.{html,rxl} published *_images $(OUT_FILES)
-
-bundle:
-ifndef METANORMA_DOCKER
-ifndef SKIP_BUNDLE
-	bundle install --jobs 4 --retry 3
-endif
-endif
-	$(call print_vars)
-
-.PHONY: bundle all open clean
-
-#
-# Watch-related jobs
-#
-
-.PHONY: watch serve watch-serve
-
-NODE_BINS          := onchange live-serve run-p
-NODE_BIN_DIR       := node_modules/.bin
-NODE_PACKAGE_PATHS := $(foreach PACKAGE_NAME,$(NODE_BINS),$(NODE_BIN_DIR)/$(PACKAGE_NAME))
-
-$(NODE_PACKAGE_PATHS): package.json
-	npm i
-
-watch: $(NODE_BIN_DIR)/onchange
-	make all
-	$< $(ALL_SRC) -- make all
-
-define WATCH_TASKS
-watch-$(FORMAT): $(NODE_BIN_DIR)/onchange
-	make $(FORMAT)
-	$$< $$(SRC_$(FORMAT)) -- make $(FORMAT)
-
-.PHONY: watch-$(FORMAT)
-endef
-
-$(foreach FORMAT,$(FORMATS),$(eval $(WATCH_TASKS)))
-
-serve: $(NODE_BIN_DIR)/live-server revealjs-css reveal.js
-	export PORT=$${PORT:-8123} ; \
-	port=$${PORT} ; \
-	for html in $(HTML); do \
-		$< --entry-file=$$html --port=$${port} --ignore="*.html,*.xml,Makefile,Gemfile.*,package.*.json" --wait=1000 & \
-		port=$$(( port++ )) ;\
-	done
-
-watch-serve: $(NODE_BIN_DIR)/run-p
-	$< watch serve
-
-#
-# Deploy jobs
-#
-
-publish: published
-
-published: documents.html
-	mkdir -p $@ && \
-	cp -a documents $@/ && \
-	cp $< $@/index.html;
-
-#
-# PDF
-#
-
-PDFTEXT := $(patsubst %.pdf,%.txt,$(subst /pdfs,/text,$(wildcard reference-docs/pdfs/*.pdf)))
-
-pdf2text: $(PDFTEXT)
-
-reference-docs/text:
-	mkdir -p $@
-
-reference-docs/text/%.txt: reference-docs/pdfs/%.pdf | reference-docs/text
-	ps2ascii "$<" "$@"

data/templates/base/Makefile.win

@@ -1,216 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-#!make
-SHELL := cmd
-# Ensure the xml2rfc cache directory exists locally
-IGNORE := $(shell md $(USERPROFILE)\.cache\xml2rfc)
-
-SRC := $(shell yq r metanorma.yml metanorma.source.files | cut -c 3-)
-
-ifeq ($(SRC),null)
-SRC :=
-endif
-ifeq ($(SRC),ll)
-SRC :=
-endif
-
-ifeq ($(SRC),)
-BUILT := $(subst ${ },${\n},$(shell yq r metanorma.yml metanorma.source.built_targets | cut -d ":" -f 1))
-
-ifeq ($(BUILT),null)
-BUILT :=
-SRC :=
-endif
-ifeq ($(BUILT),ll)
-BUILT :=
-SRC :=
-endif
-ifeq ($(BUILT),)
-SRC :=
-endif
-
-ifeq ($(BUILT),)
-SRC := $(filter-out README.adoc, $(wildcard sources/*.adoc))
-else
-XML := $(patsubst sources/%,documents/%,$(BUILT))
-endif
-endif
-
-FORMATS := $(subst -,${ },$(strip $(shell yq r metanorma.yml metanorma.formats)))
-ifeq ($(FORMATS),null)
-FORMATS :=
-endif
-ifeq ($(FORMATS),)
-FORMAT_MARKER := mn-output-
-FORMATS := $(subst ${\n},${ },$(shell grep "$(FORMAT_MARKER)" $(SRC) | cut -f 2 -d " " | tr "," "\n" | sort | uniq))
-endif
-
-XML  ?= $(patsubst sources/%,documents/%,$(patsubst %.adoc,%.xml,$(SRC)))
-HTML := $(patsubst %.xml,%.html,$(XML))
-
-ifdef METANORMA_DOCKER
-  PREFIX_CMD := echo "Running via docker..." & docker run -v "$$(pwd)":/metanorma/ $(METANORMA_DOCKER)
-else
-  ifdef SKIP_BUNDLE
-    PREFIX_CMD := echo "Running locally..." &
-  else
-    PREFIX_CMD := echo "Running locally via bundle ..." & bundle exec
-  endif
-endif
-
-_OUT_FILES := $(foreach FORMAT,$(FORMATS),$(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
-OUT_FILES  := $(foreach F,$(_OUT_FILES),$($F))
-
-define print_vars
-	$(info "src $(SRC)")
-	$(info "xml $(XML)")
-	$(info "formats $(FORMATS)")
-endef
-
-all: documents.html
-	$(call print_vars)
-
-documents:
-	setlocal enableextensions & md $@ & endlocal
-
-documents/%.html: documents/%.xml | documents
-	${PREFIX_CMD} metanorma $<
-
-documents/%.xml: sources/%.xml | documents
-	if not exist "$(subst /,\,$(dir $@))" md "$(subst /,\,$(dir $@))"
-	move "$(subst /,\,$<)" "$(subst /,\,$@)"
-
-# Build canonical XML output
-# If XML file is provided, copy it over
-# Otherwise, build the xml using adoc
-sources/%.xml: | bundle
-	$(eval BUILT_TARGET := $(subst /,\,$(shell yq r metanorma.yml metanorma.source.built_targets[$@])))
-	$(eval BUILT_TARGET_EMPTY := $(if $(filter $(or $(BUILT_TARGET),null),null ll),true,false))
-	if "$(BUILT_TARGET_EMPTY)" == "true" ( \
-		$(PREFIX_CMD) metanorma -x xml "$(subst xml,adoc,$@)" \
-	) else ( \
-		if exist "$(BUILT_TARGET)" ( \
-			if "$(suffix $(BUILT_TARGET))" == ".xml" ( \
-				copy "$(BUILT_TARGET)" "$(subst /,\,$@)" \
-			) else ( \
-				$(PREFIX_CMD) metanorma $(BUILT_TARGET) & \
-				copy "$(subst adoc,xml,$(BUILT_TARGET))" "$(subst /,\,$@)" \
-			) \
-		) else ( \
-			$(PREFIX_CMD) metanorma $(BUILT_TARGET) & \
-			copy "$(subst adoc,xml,$(BUILT_TARGET))" "$(subst /,\,$@)" \
-		) \
-	)
-
-documents.rxl: $(XML) $(HTML)
-	${PREFIX_CMD} relaton concatenate \
-		-t "$(shell yq r metanorma.yml relaton.collection.name)" \
-		-g "$(shell yq r metanorma.yml relaton.collection.organization)" \
-		documents $@
-
-documents.html: documents.rxl
-	$(PREFIX_CMD) relaton xml2html documents.rxl
-
-%.adoc:
-
-define FORMAT_TASKS
-OUT_FILES-$(FORMAT) := $($(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
-
-open-$(FORMAT):
-	"$$(OUT_FILES-$(FORMAT))"
-
-clean-$(FORMAT):
-	del /q $$(OUT_FILES-$(FORMAT))
-
-$(FORMAT): clean-$(FORMAT) $$(OUT_FILES-$(FORMAT))
-
-.PHONY: clean-$(FORMAT)
-
-endef
-
-$(foreach FORMAT,$(FORMATS),$(eval $(FORMAT_TASKS)))
-
-open: open-html
-
-clean:
-	rm -rf $(OUT_FILES)
-	del /q documents published
-	del /q *_images
-	del /q documents.*
-
-bundle:
-ifndef METANORMA_DOCKER
-ifndef SKIP_BUNDLE
-	bundle install --jobs 4 --retry 3
-endif
-endif
-	$(call print_vars)
-
-.PHONY: bundle all open clean
-
-#
-# Watch-related jobs
-#
-
-.PHONY: watch serve watch-serve
-
-NODE_BINS          := onchange live-serve run-p
-NODE_BIN_DIR       := node_modules/.bin
-NODE_PACKAGE_PATHS := $(foreach PACKAGE_NAME,$(NODE_BINS),$(NODE_BIN_DIR)/$(PACKAGE_NAME))
-
-$(NODE_PACKAGE_PATHS): package.json
-	npm i
-
-watch: $(NODE_BIN_DIR)/onchange
-	make all
-	$< $(ALL_SRC) -- make all
-
-define WATCH_TASKS
-watch-$(FORMAT): $(NODE_BIN_DIR)/onchange
-	make $(FORMAT)
-	$$< $$(SRC_$(FORMAT)) -- make $(FORMAT)
-
-.PHONY: watch-$(FORMAT)
-endef
-
-$(foreach FORMAT,$(FORMATS),$(eval $(WATCH_TASKS)))
-
-ifndef PORT
-override PORT = 8123
-endif
-
-serve: $(NODE_BIN_DIR)/live-server revealjs-css reveal.js
-	set port=$(PORT) & \
-	for /r %%html in $(HTML) do ( \
-		$< --entry-file=%%html --port=%port% --ignore="*.html,*.xml,Makefile,Gemfile.*,package.*.json" --wait=1000 & \
-		set /A port=%port%+1 \
-	)
-
-watch-serve: $(NODE_BIN_DIR)/run-p
-	$< watch serve
-
-#
-# Deploy jobs
-#
-
-publish: published
-
-published: documents.html
-	setlocal enableextensions & md $@ & endlocal
-	copy documents $@/
-	copy $< $@/index.html
-	if exist "source\images" xcopy /E source\images $@
-
-#
-# PDF
-#
-
-PDFTEXT := $(patsubst %.pdf,%.txt,$(subst /pdfs,/text,$(wildcard reference-docs/pdfs/*.pdf)))
-
-pdf2text: $(PDFTEXT)
-
-reference-docs/text:
-	md $@
-
-reference-docs/text/%.txt: reference-docs/pdfs/%.pdf | reference-docs/text
-	ps2ascii "$<" "$@"