metanorma-cli 1.1.6 → 1.1.7

data/templates/base/Makefile.win

@@ -0,0 +1,63 @@
+#!make
+
+include metanorma.env
+export $(shell sed 's/=.*//' metanorma.env)
+
+FORMATS := $(METANORMA_FORMATS)
+comma := ,
+empty :=
+space := $(empty) $(empty)
+
+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))
+RXL  := $(patsubst %.adoc,%.rxl,$(SRC))
+
+HOST_SHARE_DIR=$(USERPROFILE)\$(shell for %%I in (.) do echo %%~nxI)
+COMPILE_CMD_LOCAL := bundle exec metanorma -R $(RXL) $(SRC)
+COMPILE_CMD_DOCKER := C:/ProgramData/chocolatey/bin/docker run --rm -it -v $(CURDIR):/metanorma/ ribose/metanorma "metanorma -R $(RXL) $(SRC)"
+
+ifdef METANORMA_DOCKER
+  COMPILE_CMD := echo "Compiling via docker..." & $(COMPILE_CMD_DOCKER)
+else
+  COMPILE_CMD := echo "Compiling locally..." & $(COMPILE_CMD_LOCAL)
+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 FORMAT_TASKS
+OUT_FILES-$(FORMAT) := $($(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
+
+open-$(FORMAT):
+	$$(OUT_FILES-$(FORMAT))
+
+clean-$(FORMAT):
+	rm $$(OUT_FILES-$(FORMAT))
+
+$(FORMAT): clean-$(FORMAT) $$(OUT_FILES-$(FORMAT))
+
+.PHONY: clean-$(FORMAT)
+
+endef
+
+$(foreach FORMAT,$(FORMATS),$(eval $(FORMAT_TASKS)))
+
+# open: $(foreach FORMAT,$(FORMATS),open-$(FORMAT))
+
+open: open-html
+
+clean:
+	rm -rf $(OUT_FILES)
+
+bundle:
+	IF "" == "${METANORMA_DOCKER}" bundle
+
+.PHONY: bundle all open clean

data/templates/base/appveyor.yml

@@ -0,0 +1,29 @@
+version: '{build}'
+
+environment:
+  matrix:
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 24
+    - RUBY_VERSION: _trunk
+
+matrix:
+  allow_failures:
+    - RUBY_VERSION: _trunk
+
+install:
+  - ps: . { iwr -useb https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/appveyor.ps1 } | iex
+  - refreshenv
+
+build_script:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle update
+  - bundle install
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - plantuml -testdot
+  - make -f Makefile.win clean all publish SHELL=cmd

data/templates/base/deploy.sh

@@ -0,0 +1,78 @@
+#!/bin/bash
+# TODO: replace this script when https://github.com/travis-ci/dpl/issues/694 is fixed
+# Taken from https://raw.githubusercontent.com/w3c/permissions/master/deploy.sh
+set -e # Exit with nonzero exit code if anything fails
+
+errx() {
+  readonly __progname=$(basename ${BASH_SOURCE})
+  echo -e "[${__progname}] $@" >&2
+  exit 1
+}
+
+SOURCE_BRANCH="master"
+TARGET_BRANCH="gh-pages"
+KEY_NAME=$(pwd)/deploy_key
+
+main() {
+
+  # Pull requests and commits to other branches shouldn't try to deploy, just build to verify
+  if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "$SOURCE_BRANCH" ]; then
+    echo "Not a Travis PR or not matching branch ($SOURCE_BRANCH); skipping deploy."
+    exit 0
+  fi
+
+  [ -z "$COMMIT_AUTHOR_EMAIL" ] && \
+    errx "No COMMIT_AUTHOR_EMAIL provided; it must be set."
+
+  if [ ! -f ${KEY_NAME} ]; then
+    errx "No ${KEY_NAME} file detected; is ${KEY_NAME}.enc decrypted?"
+  fi
+
+  # Save some useful information
+  REPO=`git config remote.origin.url`
+  SSH_REPO=${REPO/https:\/\/github.com\//git@github.com:}
+  SHA=`git rev-parse --verify HEAD`
+  DEST_DIR=out
+
+  # Clone the existing $TARGET_BRANCH for this repo into $DEST_DIR/
+  # Create a new empty branch if gh-pages doesn't exist yet (should only happen on first deploy)
+  #  git clone $REPO $DEST_DIR
+  git clone $REPO $DEST_DIR || errx "Unable to clone Git."
+  pushd $DEST_DIR
+  git checkout $TARGET_BRANCH || git checkout --orphan $TARGET_BRANCH || errx "Unable to checkout git."
+  popd
+
+  # Clean out existing contents in $TARGET_BRANCH clone
+  rm -rf $DEST_DIR/* || exit 0
+
+  # Adding contents within published/ to $DEST_DIR.
+  cp -a published/* $DEST_DIR/ || exit 0
+
+  # Now let's go have some fun with the cloned repo
+  pushd $DEST_DIR
+  git config user.name "Travis CI"
+  git config user.email "$COMMIT_AUTHOR_EMAIL"
+
+  # If there are no changes to the compiled out (e.g. this is a README update) then just bail.
+  if [[ -z $(git status -s) ]]; then
+    echo "No changes to the output on this push; exiting."
+    exit 0
+  fi
+
+  git status
+
+  # Commit the "changes", i.e. the new version.
+  # The delta will show diffs between new and old versions.
+  git add .
+  git commit -m "Deploy to GitHub Pages: ${SHA}"
+
+  eval `ssh-agent -s`
+  ssh-add ${KEY_NAME}
+
+  # Now that we're all set up, we can push.
+  git push $SSH_REPO $TARGET_BRANCH || errx "Unable to push to git."
+}
+
+main "$@"
+
+exit 0

data/templates/csd/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/templates/csd/collection/Makefile

@@ -0,0 +1,139 @@
+#!make
+SHELL := /bin/bash
+
+include metanorma.env
+export $(shell sed 's/=.*//' metanorma.env)
+
+RELATON_COLLECTION_ORG  := "CalConnect : The Calendaring and Scheduling Consortium"
+RELATON_COLLECTION_NAME := "CalConnect Conference and IOP Testing Reports"
+
+comma := ,
+empty :=
+space := $(empty) $(empty)
+
+SRC  := $(wildcard sources/*.adoc)
+INPUT_XML  := $(patsubst %.adoc,%.xml,$(SRC))
+OUTPUT_XML  := $(patsubst sources/%,documents/%,$(patsubst %.adoc,%.xml,$(SRC)))
+OUTPUT_HTML := $(patsubst %.xml,%.html,$(OUTPUT_XML))
+FORMATS := xml html
+
+COMPILE_CMD_LOCAL := bundle exec metanorma -R $${FILENAME//adoc/rxl} $$FILENAME
+COMPILE_CMD_DOCKER := docker run -v "$$(pwd)":/metanorma/ ribose/metanorma "metanorma $${FILENAME//adoc/rxl}  $$FILENAME"
+
+ifdef METANORMA_DOCKER
+  COMPILE_CMD := echo "Compiling via docker..."; $(COMPILE_CMD_DOCKER)
+else
+  COMPILE_CMD := echo "Compiling locally..."; $(COMPILE_CMD_LOCAL)
+endif
+
+_OUT_FILES := $(foreach FORMAT,$(FORMATS),$(shell echo $(FORMAT) | tr '[:lower:]' '[:upper:]'))
+OUT_FILES  := $(foreach F,$(_OUT_FILES),$($F))
+
+all: documents.html
+
+documents:
+	mkdir -p $@
+
+documents/%.xml: documents sources/%.xml
+	mv sources/$*.{xml,html,pdf,rxl} documents
+
+%.xml %.html:	%.adoc | bundle
+	FILENAME=$^; \
+	${COMPILE_CMD}
+
+documents.rxl: $(OUTPUT_XML)
+	bundle exec relaton concatenate \
+	  -t $(RELATON_COLLECTION_NAME) \
+		-g $(RELATON_COLLECTION_ORG) \
+		documents $@
+
+documents.html: documents.rxl
+	bundle exec 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 published *_images sources/*.{rxl,xml,html,pdf}
+
+bundle:
+	if [ "x" == "${METANORMA_DOCKER}x" ]; then bundle; fi
+
+.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 images
+	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 published && \
+	cp -a documents $@/ && \
+	cp $< published/index.html; \
+	if [ -d "images" ]; then cp -a images published; fi
+
+deploy_key:
+	openssl aes-256-cbc -K $(encrypted_$(ENCRYPTION_LABEL)_key) \
+		-iv $(encrypted_$(ENCRYPTION_LABEL)_iv) -in $@.enc -out $@ -d && \
+	chmod 600 $@
+
+deploy: deploy_key
+	export COMMIT_AUTHOR_EMAIL=$(COMMIT_AUTHOR_EMAIL); \
+	./deploy.sh
+
+.PHONY: publish deploy