$ show antonkomarev/github-profile-views-counter
This repository implements a lightweight, self-hostable web service that serves SVG badges displaying GitHub profile view counts. The core logic is a single PHP entry point (`public/index.php`) that parses query parameters (username, label, color, style, base count, abbreviation flag), increments a view counter via a repository abstraction, and renders a badge image using the Poser library. The architecture follows a clean separation of concerns: value objects (`Username`, `Count`) enforce validation, a repository interface (`CounterRepositoryInterface`) abstracts storage, and a factory (`CounterRepositoryFactory`) selects between file-based or PDO-based persistence based on environment configuration. The file repository includes careful file locking to handle concurrent requests safely. The service is designed to be deployed via Docker with Nginx and PostgreSQL, but can also run with simple file storage for minimal setups. External dependencies are minimal and pinned via Composer. The code is well-structured, uses strict types, and demonstrates solid PHP engineering practices for a small service.
The LLM identified 3 files worth highlighting for reuse:
A value object encapsulating a non-negative integer count with a maximum bound. Provides a static factory `ofString` for safe parsing, a `plus` method for addition with overflow protection, and uses Webmozart Assert for validation. This component is self-contained and could be reused in any PHP project requiring a validated numeric count, such as metrics, scores, or inventory quantities.
A value object that validates GitHub usernames according to the official rules (alphanumeric, hyphens allowed but not at start/end, length 1-39). Uses a regex adapted from the `github-username-regex` library and Webmozart Assert for validation. The `__toString` method returns the lowercase version. This is a self-contained, reusable component for any PHP application that needs to validate or normalize GitHub usernames.
A file-based implementation of the counter repository that persists view counts and raw view timestamps to flat files. It demonstrates careful concurrency handling by using `flock` with exclusive locks to prevent race conditions during counter increments. The constructor validates that the storage path is a writable directory. This component is a reusable pattern for any PHP application needing a simple, file-backed counter with safe concurrent access, and can be extracted with minimal changes.