This repo primarily provides a Wordpress plugin that automatically generates the cricket stats tables published at https://ploughmanscc.com/.
- Each week the club enters scorecard data from its matches on the ECB Play-Cricket site: https://ploughmans.play-cricket.com/
- The Wordpress plugin triggers a regular Cron job to check for new matches that have been published since the last update and consumes any new matches it finds:
- Cron job configuration: stats/init.php
- Stats update entry point: stats/updater.php
- The Play-Cricket API is used to list matches played by the club and fetch all scorecard details:
- The details of each match are consumed and stored in a SQLite DB:
- DB schema: stats/db.php
- Match detail consumption: stats/match-consumer.php
- The static career stats for the club, which were calculated outside Play-Cricket up till the end of 2017, are loaded into the DB:
- Career summary generator: stats/career-summary-generator.php - see "load base" functions
- Static career summary base data: stats/static
- For each season since 2017, a season summary is calculated for each player (using the consumed scorecard data for that season) and stored in the DB:
- Season summary generator: stats/season-summary-generator.php
- As each set of season summaries are completed, they are added to the current career summaries for each player to give a new set of career stats up to that point in time:
- Career summary generator: stats/career-summary-generator.php - see "add season to career summary" functions
- Once all seasons of scorecards have been processed and summarised, the DB contains:
- Summary stats for matches / batting / bowling / fielding for each player for the season
- The latest overall career stats for each player for these categories
- We also calculate any milestones that an "active" player may be approaching or has already passed for each season:
- Milestone generator: stats/milestone-generator.php
- We export the summary data from the DB to a set of CSV files for each season and for the latest career summaries:
- CSV generator: stats/csv-generator.php
- The Tablepress plugin on the Wordpress installation is configured to populate a set of tables from the generated CSV files. This Cron job runs periodically as well.
- When all relevant Tablepress tables have been updated, the latest stats pages on the website are now up to date, e.g.
The end result is that both season and career stats are automatically updated and visible on the club website within ~15-30 minutes of scorecards being entered each weekend.
The SQLite DB can be wiped and rebuilt from scratch at any point. We persist it for efficiency but it is wiped each time a new version of the plugin is deployed.
stats/config contains a couple of configuration files to control operation of the updater:
- default - the configuration used in production on the Wordpress deployment
- local-test - the configuration used when running the updater locally with stats/local-update.php
The configs allow you to choose between sourcing match data from the web or from file (InputMapperName). Match data can also be fetched from the web and dumped to file (InputDumpDir) and then used as the input for the next run by setting InputMapperName to file and InputMapperDir to the dump directory.
stats/test.php runs a suite of regression tests defined in stats/test/input. Each test runs the updater against a set of dumped input data (captured at some point in the past), generates the output CSVs and compares them to a set of baseline output CSVs. Tests fail if the CSV results are not identical.
Individual tests can be run with php test.php <test-name>, whereas php test.php runs the full suite.
The plugin is packaged for deployment to the Wordpress site using package.php - php package.php. The resultant plugin zip can be found in the dist directory.
The version of PHP that the plugin runs on in production is managed by SiteGround where the site is hosted. Currently it uses PHP 7.4.
There is a plan to set up automated testing and packaging on circleci at some point in the future. Currently tests are run locally whenever changes are made, and packaging is done locally as well. Plugin deployment is done via the WP Admin UI.
- Update stats/config/default.xml and stats/config/local-test.xml to have CurrentSeason = .
- Update helpers.php to have an entry for the new season year, depending on what divisions the club is playing that year.
- Update LEAGUE_TABLE_DIVISON_ID_MAP in data-mapper.php to have the league table ids for the new season.
- On Macbook, downloaded latest cacert.pem from https://curl.se/docs/caextract.html and put it in /usr/local/php5/ssl/cert.pem