metanorma-cli 1.3.3 → 1.3.7

data/templates/base/.github/workflows/windows.yml

@@ -0,0 +1,42 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/test.yml
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/docker.yml
+      - Makefile
+
+jobs:
+  test-windows:
+    name: Test on Windows
+    runs-on: windows-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || github.token }}
+          submodules: true
+      - name: Cache xml2rfc
+        id: cache-xml2rfc
+        uses: actions/cache@v1
+        with:
+          path: ~/.cache/xml2rfc
+          key: xml2rfc
+          restore-key: xml2rfc
+      - name: Install Metanorma & yq
+        shell: pwsh
+        run: |
+          cinst --no-progress -y metanorma yq
+      - name: Install bundler
+        run: |
+          gem install bundler
+      - name: Metanorma compile
+        run: |
+          make -f Makefile.win clean all SHELL=cmd

data/templates/base/.gitlab-ci.yml

@@ -1,15 +1,45 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 image:
-  name: ribose/metanorma
+  name: metanorma/mn
   entrypoint: [""]
 
 cache:
   paths:
 
+stages:
+  - build
+  - deploy
+
+
 build:
   stage: build
   script:
-    - bundle
-    - make clean all publish
+    # We need to do this to install mscorefonts
+    - curl -Ls -o yq https://github.com/mikefarah/yq/releases/download/3.3.0/yq_linux_amd64
+    - chmod +x yq && mv yq /usr/bin
+    - yq
+    - apt-add-repository -y contrib && apt-get update
+    - echo ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true | debconf-set-selections
+    - apt-get install -y ttf-mscorefonts-installer
+    - curl -Ls https://raw.githubusercontent.com/metanorma/vista-fonts-installer/master/vista-fonts-installer.sh | bash
+    - curl -L --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/gemfile-to-bundle-add.sh | bash
+    - bundle install
+    - make clean all
+    - make published
+    - mv published public
+  artifacts:
+    paths:
+      - public
+
+pages:
+  dependencies:
+    - build
+  stage: deploy
+  script:
+    - 'curl --location --output artifacts.zip --header "JOB-TOKEN: $CI_JOB_TOKEN" "https://gitlab.com/api/v4/projects/$CI_PROJECT_ID/jobs/artifacts/master/download?job=build"'
   artifacts:
     paths:
-      - published
+      - public
+  only:
+    - master

data/templates/base/Makefile

@@ -1,65 +1,104 @@
+# 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-999)
+SRC := $(shell yq r metanorma.yml metanorma.source.files | cut -c 3-)
+
+ifeq ($(SRC),null)
+SRC :=
+endif
 ifeq ($(SRC),ll)
-SRC := $(filter-out README.adoc, $(wildcard *.adoc))
+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' ' ')
-
-XML  := $(patsubst %.adoc,%.xml,$(SRC))
-XMLRFC3  := $(patsubst %.adoc,%.v3.xml,$(SRC))
-HTML := $(patsubst %.adoc,%.html,$(SRC))
-DOC  := $(patsubst %.adoc,%.doc,$(SRC))
-PDF  := $(patsubst %.adoc,%.pdf,$(SRC))
-TXT  := $(patsubst %.adoc,%.txt,$(SRC))
-NITS := $(patsubst %.adoc,%.nits,$(wildcard draft-*.adoc))
-WSD  := $(wildcard models/*.wsd)
-XMI	 := $(patsubst models/%,xmi/%,$(patsubst %.wsd,%.xmi,$(WSD)))
-PNG	 := $(patsubst models/%,images/%,$(patsubst %.wsd,%.png,$(WSD)))
-
-COMPILE_CMD_LOCAL := bundle exec metanorma $$FILENAME
-COMPILE_CMD_DOCKER := docker run -v "$$(pwd)":/metanorma/ ribose/metanorma "metanorma $$FILENAME"
+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
-  COMPILE_CMD := echo "Compiling via docker..."; $(COMPILE_CMD_DOCKER)
+  PREFIX_CMD := echo "Running via docker..."; docker run -v "$$(pwd)":/metanorma/ $(METANORMA_DOCKER)
 else
-  COMPILE_CMD := echo "Compiling locally..."; $(COMPILE_CMD_LOCAL)
+  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))
 
-all: images $(OUT_FILES)
-
-%.v3.xml %.xml %.html %.doc %.pdf %.txt:	%.adoc | bundle
-	FILENAME=$^; \
-	${COMPILE_CMD}
-
-draft-%.nits:	draft-%.txt
-	VERSIONED_NAME=`grep :name: draft-$*.adoc | cut -f 2 -d ' '`; \
-	cp $^ $${VERSIONED_NAME}.txt && \
-	idnits --verbose $${VERSIONED_NAME}.txt > $@ && \
-	cp $@ $${VERSIONED_NAME}.nits && \
-	cat $${VERSIONED_NAME}.nits
-
-%.nits:
-
-nits: $(NITS)
-
-images: $(PNG)
-
-images/%.png: models/%.wsd
-	plantuml -tpng -o ../images/ $<
-
-xmi: $(XMI)
+define print_vars
+	$(info "src $(SRC)")
+	$(info "xml $(XML)")
+	$(info "formats $(FORMATS)")
+endef
 
-xmi/%.xmi: models/%.wsd
-	plantuml -xmi:star -o ../xmi/ $<
+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:]'))
@@ -81,10 +120,15 @@ $(foreach FORMAT,$(FORMATS),$(eval $(FORMAT_TASKS)))
 open: open-html
 
 clean:
-	rm -f $(OUT_FILES) && rm -rf published
+	rm -rf documents documents.{html,rxl} published *_images $(OUT_FILES)
 
 bundle:
-	if [ "x" == "${METANORMA_DOCKER}x" ]; then bundle; fi
+ifndef METANORMA_DOCKER
+ifndef SKIP_BUNDLE
+	bundle install --jobs 4 --retry 3
+endif
+endif
+	$(call print_vars)
 
 .PHONY: bundle all open clean
 
@@ -102,20 +146,20 @@ $(NODE_PACKAGE_PATHS): package.json
 	npm i
 
 watch: $(NODE_BIN_DIR)/onchange
-	$(MAKE) all
-	$< $(ALL_SRC) -- $(MAKE) all
+	make all
+	$< $(ALL_SRC) -- make all
 
 define WATCH_TASKS
 watch-$(FORMAT): $(NODE_BIN_DIR)/onchange
-	$(MAKE) $(FORMAT)
-	$$< $$(SRC_$(FORMAT)) -- $(MAKE) $(FORMAT)
+	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 images
+serve: $(NODE_BIN_DIR)/live-server revealjs-css reveal.js
 	export PORT=$${PORT:-8123} ; \
 	port=$${PORT} ; \
 	for html in $(HTML); do \
@@ -130,15 +174,23 @@ watch-serve: $(NODE_BIN_DIR)/run-p
 # Deploy jobs
 #
 
-publish:
-	$(MAKE) published
+publish: published
 
-published:
+published: documents.html
 	mkdir -p $@ && \
-	export GLOBIGNORE=$(SRC); \
-	cp -a $(addsuffix .*,$(basename $(SRC))) $@/; \
-	unset GLOBIGNORE; \
-	cp $(firstword $(HTML)) $@/index.html
+	cp -a documents $@/ && \
+	cp $< $@/index.html;
+
+#
+# PDF
+#
+
+PDFTEXT := $(patsubst %.pdf,%.txt,$(subst /pdfs,/text,$(wildcard reference-docs/pdfs/*.pdf)))
+
+pdf2text: $(PDFTEXT)
 
-.PHONY: publish
+reference-docs/text:
+	mkdir -p $@
 
+reference-docs/text/%.txt: reference-docs/pdfs/%.pdf | reference-docs/text
+	ps2ascii "$<" "$@"

data/templates/base/Makefile.win

@@ -1,53 +1,126 @@
+# 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)
 
-FORMAT_MARKER := mn-output-
-FORMATS := $(shell grep "$(FORMAT_MARKER)" *.adoc | cut -f 2 -d ' ' | tr ',' '\n' | sort | uniq | tr '\n' ' ')
+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
 
-SRC  := $(filter-out README.adoc, $(wildcard *.adoc))
-XML  := $(patsubst %.adoc,%.xml,$(SRC))
-HTML := $(patsubst %.adoc,%.html,$(SRC))
-DOC  := $(patsubst %.adoc,%.doc,$(SRC))
-PDF  := $(patsubst %.adoc,%.pdf,$(SRC))
-WSD  := $(wildcard models/*.wsd)
-XMI	 := $(patsubst models/%,xmi/%,$(patsubst %.wsd,%.xmi,$(WSD)))
-PNG	 := $(patsubst models/%,images/%,$(patsubst %.wsd,%.png,$(WSD)))
+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
 
-HOST_SHARE_DIR=$(USERPROFILE)\$(shell for %%I in (.) do echo %%~nxI)
-COMPILE_CMD_LOCAL := bundle exec metanorma $(SRC)
-COMPILE_CMD_DOCKER := docker run --rm -it -v $(CURDIR):/metanorma/ ribose/metanorma "metanorma $(SRC)"
+XML  ?= $(patsubst sources/%,documents/%,$(patsubst %.adoc,%.xml,$(SRC)))
+HTML := $(patsubst %.xml,%.html,$(XML))
 
 ifdef METANORMA_DOCKER
-  COMPILE_CMD := echo "Compiling via docker..." & $(COMPILE_CMD_DOCKER)
+  PREFIX_CMD := echo "Running via docker..." & docker run -v "$$(pwd)":/metanorma/ $(METANORMA_DOCKER)
 else
-  COMPILE_CMD := echo "Compiling locally..." & $(COMPILE_CMD_LOCAL)
+  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))
 
-all: $(OUT_FILES)
-
-%.xml %.html %.doc %.pdf:	%.adoc | bundle
-	${COMPILE_CMD}
+define print_vars
+	$(info "src $(SRC)")
+	$(info "xml $(XML)")
+	$(info "formats $(FORMATS)")
+endef
 
-images: $(PNG)
+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 /,\,$@)" \
+		) \
+	)
 
-images/%.png: models/%.wsd
-	plantuml -tpng -o ../images/ $<
+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 $@
 
-xmi: $(XMI)
+documents.html: documents.rxl
+	$(PREFIX_CMD) relaton xml2html documents.rxl
 
-xmi/%.xmi: models/%.wsd
-	plantuml -xmi:star -o ../xmi/ $<
+%.adoc:
 
 define FORMAT_TASKS
 OUT_FILES-$(FORMAT) := $($(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
 
 open-$(FORMAT):
-	$$(OUT_FILES-$(FORMAT))
+	"$$(OUT_FILES-$(FORMAT))"
 
 clean-$(FORMAT):
-	rm $$(OUT_FILES-$(FORMAT))
+	del /q $$(OUT_FILES-$(FORMAT))
 
 $(FORMAT): clean-$(FORMAT) $$(OUT_FILES-$(FORMAT))
 
@@ -61,9 +134,17 @@ open: open-html
 
 clean:
 	rm -rf $(OUT_FILES)
+	del /q documents published
+	del /q *_images
+	del /q documents.*
 
 bundle:
-	IF "" == "${METANORMA_DOCKER}" bundle
+ifndef METANORMA_DOCKER
+ifndef SKIP_BUNDLE
+	bundle install --jobs 4 --retry 3
+endif
+endif
+	$(call print_vars)
 
 .PHONY: bundle all open clean
 
@@ -94,9 +175,12 @@ endef
 
 $(foreach FORMAT,$(FORMATS),$(eval $(WATCH_TASKS)))
 
-serve: $(NODE_BIN_DIR)/live-server revealjs-css reveal.js images
-	set PORT=$${PORT:-8123} & \
-	set port=$${PORT} & \
+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 \
@@ -109,8 +193,24 @@ watch-serve: $(NODE_BIN_DIR)/run-p
 # Deploy jobs
 #
 
-publish:
-	mkdir -p published
-	xcopy $(basename $(SRC)).* published
-	copy $(firstword $(HTML)) published\index.html
-	IF EXIST "images" xcopy /E images published
+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 "$<" "$@"