Makefile

.PHONY: help install install.dev generate-test-data check.format check.lint check.type test unittest clean bump.patch bump.minor bump.major docs docs.serve

.DEFAULT_GOAL := help

PACKAGE_NAME := whatstk
TEST_DIR := tests
REPORTS_DIR := reports
TEST_CHATS_DIR := $(TEST_DIR)/chats
export PATH := $(HOME)/.local/bin:$(PATH)

help: ## Show available commands
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}'

##################################################
## INSTALLATION / PREP
install: ## Install package in editable mode
	uv pip install -e .

install.dev: ## Install package with dev dependencies
	uv pip install -e .[dev]

.sanity-check:
	@echo '==> Checking your Python setup'
	@# Skip sanity check in CI environments (GitHub Actions, etc.)
	@if [ -z "$$CI" ]; then \
		if python -c "import sys; exit(0 if sys.platform.startswith('win32') else 1)"; then \
			echo 'ERROR: you are using a non-WSL Python interpreter, please consult the'; \
			echo '       docs on how to switch to WSL Python on windows'; \
			echo '       https://github.com/lucasrodes/whatstk/'; \
			exit 1; \
		fi; \
	fi
	@touch .sanity-check

install-uv:
	@if ! command -v uv >/dev/null 2>&1; then \
		echo '==> UV not found. Installing...'; \
		curl -LsSf https://astral.sh/uv/install.sh | sh; \
	fi

.venv: install-uv .sanity-check
	@echo '==> Installing packages'
	@if [ -n "$(PYTHON_VERSION)" ]; then \
		echo '==> Using Python version $(PYTHON_VERSION)'; \
		[ -f $$HOME/.cargo/env ] && . $$HOME/.cargo/env || true && UV_PYTHON=$(PYTHON_VERSION) uv sync --all-extras; \
	else \
		[ -f $$HOME/.cargo/env ] && . $$HOME/.cargo/env || true && uv sync --all-extras; \
	fi

install.rtd: install-uv ## Install dependencies for ReadTheDocs
	@echo '==> Installing packages for ReadTheDocs'
	@UV_PROJECT_ENVIRONMENT=$(READTHEDOCS_VIRTUALENV_PATH) uv sync --frozen --all-extras

##################################################
# TESTING
test: check.format check.lint check.type unittest  ## Run formatting, linting, type-checking, and unit tests

check.format: ## Format code with ruff
	uv run ruff format --check $(PACKAGE_NAME) $(TEST_DIR)

format: ## Format code with ruff
	uv run ruff format $(PACKAGE_NAME) $(TEST_DIR)

check.lint: ## Run ruff linting
	mkdir -p $(REPORTS_DIR)
	uv run ruff check $(PACKAGE_NAME) $(TEST_DIR)

check.type: ## Run pyright type checking
	uv run pyright $(PACKAGE_NAME)

unittest: $(TEST_CHATS_DIR) ## Run tests with coverage (use N=4 or N=auto for parallel execution)
	mkdir -p $(REPORTS_DIR)
	uv run pytest \
		--html=$(REPORTS_DIR)/testreport.html \
		--cov-report html:$(REPORTS_DIR)/htmlcov \
		--cov-report term \
		--cov-report xml:$(REPORTS_DIR)/cov.xml \
		--cov=$(PACKAGE_NAME) $(TEST_DIR)


unittest-parallel: $(TEST_CHATS_DIR) ## Run tests with coverage (use N=4 or N=auto for parallel execution)
	mkdir -p $(REPORTS_DIR)
	uv run pytest -n auto \
		--html=$(REPORTS_DIR)/testreport.html \
		--cov-report html:$(REPORTS_DIR)/htmlcov \
		--cov-report term \
		--cov-report xml:$(REPORTS_DIR)/cov.xml \
		--cov=$(PACKAGE_NAME) $(TEST_DIR)

################################################
# MAINTENANCE
clean: ## Remove build and test artifacts
	find . -type f -name '*.py[co]' -delete
	find . -type d -name '__pycache__' -delete
	rm -rf $(REPORTS_DIR) .pytest_cache .coverage htmlcov build dist *.egg-info .uv

# Build analytics DuckDB snapshot
$(TEST_CHATS_DIR):
	@make generate-test-data

generate-test-data: ## Generate test chat files
	mkdir -p $(TEST_DIR)/chats/hformats $(TEST_DIR)/chats/merge
	uv run whatstk-generate-chat --size 500 -z --output-path $(TEST_DIR)/chats/hformats/
	uv run whatstk-generate-chat --size 300 --last-timestamp 2019-09-01 \
		--hformats '%Y-%m-%d, %H:%M - %name:' \
		--output-path $(TEST_DIR)/chats/merge/ --filenames file1.txt
	uv run whatstk-generate-chat --size 300 --last-timestamp 2020-01-01 \
		--hformats '%Y-%m-%d, %H:%M - %name:' \
		--output-path $(TEST_DIR)/chats/merge/ --filenames file2.txt


##################################################
# VERSION BUMPING
# Use --pre flag for pre-release versions (e.g., make bump.minor --pre)
# Without --pre: 0.8.0 → 0.9.0 or 0.8.0.dev0 → 0.9.0
# With --pre: 0.8.0 → 0.9.0.dev0 or 0.8.0.dev0 → 0.9.0.dev0

bump.patch: ## Bump patch version (0.0.X)
	@if [ "$(filter --pre,$(MAKECMDGOALS))" = "--pre" ]; then \
		NEW_VER=$$(uv run python -c "import re; v='$$(uv run bump-my-version show current_version)'; m=re.match(r'(\d+)\.(\d+)\.(\d+)', v); print(f'{m[1]}.{m[2]}.{int(m[3])+1}.dev0')"); \
		uv run bump-my-version bump --new-version $$NEW_VER patch; \
	else \
		NEW_VER=$$(uv run python -c "import re; v='$$(uv run bump-my-version show current_version)'; m=re.match(r'(\d+)\.(\d+)\.(\d+)', v); print(f'{m[1]}.{m[2]}.{int(m[3])+1}')"); \
		uv run bump-my-version bump --new-version $$NEW_VER patch; \
	fi

bump.minor: ## Bump minor version (0.X.0)
	@if [ "$(filter --pre,$(MAKECMDGOALS))" = "--pre" ]; then \
		NEW_VER=$$(uv run python -c "import re; v='$$(uv run bump-my-version show current_version)'; m=re.match(r'(\d+)\.(\d+)\.(\d+)', v); print(f'{m[1]}.{int(m[2])+1}.0.dev0')"); \
		uv run bump-my-version bump --new-version $$NEW_VER minor; \
	else \
		NEW_VER=$$(uv run python -c "import re; v='$$(uv run bump-my-version show current_version)'; m=re.match(r'(\d+)\.(\d+)\.(\d+)', v); print(f'{m[1]}.{int(m[2])+1}.0')"); \
		uv run bump-my-version bump --new-version $$NEW_VER minor; \
	fi

bump.major: ## Bump major version (X.0.0)
	@if [ "$(filter --pre,$(MAKECMDGOALS))" = "--pre" ]; then \
		NEW_VER=$$(uv run python -c "import re; v='$$(uv run bump-my-version show current_version)'; m=re.match(r'(\d+)\.(\d+)\.(\d+)', v); print(f'{int(m[1])+1}.0.0.dev0')"); \
		uv run bump-my-version bump --new-version $$NEW_VER major; \
	else \
		NEW_VER=$$(uv run python -c "import re; v='$$(uv run bump-my-version show current_version)'; m=re.match(r'(\d+)\.(\d+)\.(\d+)', v); print(f'{int(m[1])+1}.0.0')"); \
		uv run bump-my-version bump --new-version $$NEW_VER major; \
	fi

# Dummy target to handle --pre flag
--pre:
	@:


##################################################
# DOCUMENTATION
docs: ## Build documentation
	uv run make -C docs html

docs.serve: docs ## Build and serve documentation
	cd docs/_build/html && python -m http.server