Makefile

SHELL:=/bin/bash 

VENV           = venv_snlp
VENV_PYTHON    = $(VENV)/bin/python
SYSTEM_PYTHON  = $(or $(shell which python3), $(shell which python))
# If virtualenv exists, use it. If not, find python using PATH
PYTHON         = $(or $(wildcard $(VENV_PYTHON)), $(SYSTEM_PYTHON))

PYTHON_VERSION = 3.10

REQUIREMENTS	=	gh
REQUIREMENTS	+=	git
REQUIREMENTS	+=	virtualenv

SRC = cnlp
TEST_DIR = tests
# W,E (ignore warning end errors). W (only warnings)
CODE_IGNORE_LEVEL = ""
INSTALL_DIR = requirements
# with '-e' enable install in edit mode
INSTALL_FLG = 
DOCS_DIR = docs
# --html, --pdf or blank for markdown
DOCS_FORMAT = "--html"
DOCS_LATEX  = True
DOCSTRINGS_FORMAT = numpydoc
LINT_FORMAT = pylint

.PHONY: tests docs build

all:
	@echo "social-network-link-prediction Makefile guide."
	@echo ""
	@echo "Install commands:"
	@echo "       make install      : Install library in the system."
	@echo ""
	@echo "       make install-dev  : Create dev environment (virtualenv) and"
	@echo "                           install dev requirements."
	@echo ""
	@echo "       make install-doc  : Insitall requirement to generate documentation."
	@echo "                           Needs the environment installed (run make install-dev)"
	@echo ""
	@echo "       make install-test : Install requirements for the testing."
	@echo "                           Needs the environment installed (run make install-dev)"
	@echo ""
	@echo "Clean commands:"
	@echo "       make clean-env        : Removes all environment files."
	@echo "       make clean-build      : Remove all build files."
	@echo "       make clean-docstrings : Remove all docstrings (.patch) files."
	@echo "       make clean-docs       : Remove all documentation files."
	@echo "       make clean            : Runs all clean commands."
	@echo ""
	@echo "Auto-generation commands:"
	@echo "   code:"
	@echo "       make code-format : Format all python files (using yapf)."
	@echo "       make code-check  : Checks for warnings and errors. (using pylama linter)."
	@echo "       make code        : Runs -format and -check."
	@echo ""
	@echo "   documentation:"
	@echo "       make docstrings     : Generate docstring for all python files (need to manually apply patches)."
	@echo "       make documentation  : Generate documentation from python docstrings."
	@echo ""
	@echo "   make build : Runs the build project process"
	@echo "   make tests : Runs the unit tests"
	@echo ""
	@echo "Publish commands:"
	@echo "       make publish-release : Publish the library into the Pypi's release repo "
	@echo "       make publish-testing : Publish the library into the Pypi's testing repo"


# -- Requirements Check --
check:
	@echo "🟡 Check Requirements ..."

	@for f in $(REQUIREMENTS); do \
		type $$f 2> /dev/null 1> /dev/null || { echo "$$f is missing ❌"; exit -1; }; \
	done
	
	@echo "Requirements Check Passed ✅"
	@echo ""


# -- Install Section --
install:
	@echo "🟡 Installing library ..."

	$(SYSTEM_PYTHON) -m pip install $(INSTALL_FLG) . 

	@echo "Library installed ✅"
	@echo ""

install-dev: check	
	@echo "🟡 Installing dev dependencies ..."

	virtualenv -p $(PYTHON_VERSION) $(VENV)
	@echo "Created env '$(VENV)' ✅"
	@echo ""
	
	$(VENV_PYTHON) -m pip install -r $(INSTALL_DIR)/requirements.txt 
	@echo "dev dependencies installed ✅"
	@echo ""

	$(VENV_PYTHON) -m pip install -e . 
	@echo "installed library in edit mode ✅"
	@echo ""

install-doc:
	@echo "🟡 Installing doc dependencies ... "
	$(VENV_PYTHON) -m pip install -r $(INSTALL_DIR)/requirements-doc.txt
	@echo "doc dependencies installed ✅"
	@echo ""

install-test:
	@echo "🟡 Installing testing dependencies ..."
	$(VENV_PYTHON) -m pip install -r $(INSTALL_DIR)/requirements-test.txt
	@echo "test dependencies installed ✅"
	@echo ""


# -- Clean Section --
clean-docs: $(DOCS_DIR)/
	@echo "🟡 Cleaning documentation files ..."
	rm -rf $(DOCS_DIR)/*
	@echo "Documentation files cleaned ✅"

clean-build:
	@echo "🟡 Cleaning build files ..."
	
	find . -iname "__pycache__" |xargs rm -rf
	find . -iname "*.egg-info" |xargs rm -rf
	rm -rf build/ dist/

	@echo "Buildfiles cleaned ✅"

clean-env: $(VENV)
	@echo "🟡 Cleaning env files ..."
	rm -rf $(VENV)
	
	@echo "Removed env $(VENV) ✅"

clean-docstrings: *.patch
	@echo "🟡 Cleaning docstrings (.patch) files ..."
	rm -rf $^
	@echo "docstrings files cleaned ✅"

# clean all !
clean: clean-env clean-build clean-docs clean-docstrings


# -- Runs Section
tests:
	@echo "🟡 Running unit tests..."
	$(VENV_PYTHON) -m unittest discover -v -s $(TEST_DIR) -t .


# Code cheking & autoformatting
# NOTA:
# per cambiare la variabile CODE_IGNORE_LEVEL
# anteporre questo al target dove si vuole cambiare
#	target: CODE_IGNORE_LEVEL="W"
code-check:
	@echo "🟡 Checking errors and warnings ..."
	pylama -f $(LINT_FORMAT) -i $(CODE_IGNORE_LEVEL) $(SRC)
	@echo "No problems found ✅"

code-format:
	@echo "🟡 Refactoring code ..."
	yapf --recursive -i $(SRC)
	@echo "Done ✅"

code: code-format code-check


# Documentation
# TODO: una gestione interattiva di quale parte della patch
#	    applicare ?
docstrings: 
	@echo "🟡 Generating docstrings ..."
	pyment -o $(DOCSTRINGS_FORMAT) $(SRC)
	@echo "Done ✅"
	@echo ""
	@echo "You have to manually apply patches."
	@echo "Try with:"
	@echo "    git apply filename.py.patch"
	@echo "or with:"
	@echo "    patch -p1 < filename.py.patch"
	
# docstrings: $(shell pyment -o numpydoc $(SRC))
# 	for p in $(shell ls *.patch) ; do \
# 		editdiff $$p && git apply $$p; \
# 	done;
# 	rm *.patch

docs:
	@echo "🟡 Generating docs from code ..."
	@$(MAKE) clean-docs
	mkdir -p $(DOCS_DIR)
	pdoc $(DOCS_FORMAT) -c latex_math=$(DOCS_LATEX) -o $(DOCS_DIR) $(SRC)
	cd $(DOCS_DIR)/ && mv $(SRC)/* ./ && rm -rf $(SRC)
	@echo "Done ✅"


build:
	@echo "🟡 Building progect ..."

	$(VENV_PYTHON) setup.py sdist

	@echo "Done ✅"


# -- Publish Section --
publish-release: dist/
	# TODO
	@echo "🟡 Pushing build to production ..."
	
	twine upload dist/*

	@echo "Done ✅"


publish-testing: dist/
	# TODO
	@echo "🟡 Pushing build to testing ..."

	twine upload --repository-url https://test.pypi.org/legacy/ dist/*

	@echo "Done ✅"