.PHONY: clean clean_tox compile_translations coverage diff_cover docs dummy_translations \
        extract_translations fake_translations help pii_check pull_translations \
        quality requirements selfcheck test test-all upgrade compile-requirements validate install_transifex_client \
        check-constraints

.DEFAULT_GOAL := help

# For opening files in a browser. Use like: $(BROWSER)relative/path/to/file.html
BROWSER := python -m webbrowser file://$(CURDIR)/

help: ## display this help message
	@echo "Please use \`make <target>' where <target> is one of"
	@awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort

clean: ## remove generated byte code, coverage reports, and build artifacts
	find . -name '__pycache__' -exec rm -rf {} +
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +
	coverage erase
	rm -fr build/
	rm -fr dist/
	rm -fr *.egg-info

clean_tox: ## clear tox requirements cache
	rm -fr .tox

coverage: clean ## generate and view HTML coverage report
	pytest --cov-report html
	$(BROWSER)htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
	tox -e docs
	$(BROWSER)docs/_build/html/index.html

compile-requirements: ## generate the uv.lock file without upgrading packages
	uv lock

# Renovate handles routine dependency bumps now, one pull request per package.
# This target remains the way to re-resolve everything at once, and the only
# thing that regenerates [tool.uv].constraint-dependencies from edx-lint.
upgrade: ## upgrade all packages in uv.lock and sync constraints from edx-lint
	uv run --with 'edx-lint>=6.2' edx_lint write_uv_constraints pyproject.toml
	uv lock --upgrade

# Regenerates the constraints into a scratch copy and diffs, rather than
# checking `git diff`, so that it reports only this drift and not whatever else
# happens to be uncommitted in the working tree.
check-constraints: ## fail if [tool.uv].constraint-dependencies is out of date
	@cp pyproject.toml pyproject.toml.orig
	@uv run --with 'edx-lint>=6.2' edx_lint write_uv_constraints pyproject.toml >/dev/null
	@if cmp -s pyproject.toml.orig pyproject.toml; then \
	  rm -f pyproject.toml.orig; \
	else \
	  diff -u pyproject.toml.orig pyproject.toml || true; \
	  mv pyproject.toml.orig pyproject.toml; \
	  echo ""; \
	  echo "[tool.uv].constraint-dependencies is out of date with edx-lint."; \
	  echo "Run 'make upgrade' and commit the result."; \
	  exit 1; \
	fi

quality: ## check coding style with pycodestyle and pylint
	tox -e quality

pii_check: ## check for PII annotations on all Django models
	tox -e pii_check

requirements: clean_tox ## install development environment requirements
	uv sync --group dev

test: clean ## run tests in the current virtualenv
	pytest

diff_cover: test ## find diff lines that need test coverage
	diff-cover coverage.xml

test-all: quality pii_check ## run tests on every supported Python/Django combination
	tox
	tox -e docs

validate: quality pii_check test ## run tests and quality checks

selfcheck: ## check that the Makefile is well-formed
	@echo "The Makefile is well-formed."

## Localization targets

extract_translations: ## extract strings to be translated, outputting .mo files
	rm -rf docs/_build
	cd sample_plugin && i18n_tool extract --no-segment

compile_translations: ## compile translation files, outputting .po files for each supported language
	cd sample_plugin && i18n_tool generate

detect_changed_source_translations:
	cd sample_plugin && i18n_tool changed

ifeq ($(OPENEDX_ATLAS_PULL),)
pull_translations: ## Pull translations from Transifex
	tx pull -t -a -f --mode reviewed --minimum-perc=1
else
# Experimental: OEP-58 Pulls translations using atlas
pull_translations:
	find sample_plugin/conf/locale -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
	atlas pull $(OPENEDX_ATLAS_ARGS) translations/sample-plugin/sample_plugin/conf/locale:sample_plugin/conf/locale
	python manage.py compilemessages

	@echo "Translations have been pulled via Atlas and compiled."
endif

dummy_translations: ## generate dummy translation (.po) files
	cd sample_plugin && i18n_tool dummy

build_dummy_translations: extract_translations dummy_translations compile_translations ## generate and compile dummy translation files

validate_translations: build_dummy_translations detect_changed_source_translations ## validate translations

install_transifex_client: ## Install the Transifex client
	# Installing client will skip CHANGELOG and LICENSE files from git changes
	# so remind the user to commit the change first before installing client.
	git diff -s --exit-code HEAD || { echo "Please commit changes first."; exit 1; }
	curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
	git checkout -- LICENSE README.md ## overwritten by Transifex installer
