Shrinkalink

A WordPress plugin that creates Shlink short links for posts when they're published, and uses them as the site's shortlinks.

This file is for working on the plugin. For features, setup, filters and the FAQ, see readme.txt, which is the WordPress.org listing.

Requirements

• PHP 8.4 or later
• WordPress 7.1 or later (the API key is stored with the Secrets API from 7.2)
• Composer
• A Shlink server, for trying the plugin by hand. The tests fake Shlink's responses, so they don't need one.

Setup

Install the development dependencies:

composer install

Running the tests

The tests use the WordPress test library and need their own database, separate from the site's. These steps assume a Lando WordPress site with the plugin at wp-content/plugins/shrinkalink, and a wordpress_test database the wordpress user can access. Run them from the plugin folder.

1. Add the test library installer, answering n to every prompt to overwrite an existing file:

   lando wp scaffold plugin-tests shrinkalink

2. Install the WordPress test library. The arguments are the database name, user, password, host, WordPress version, and true to skip creating the database because it already exists. Repeat this after a lando rebuild, since the library is installed in the container's /tmp.

   lando ssh -c "cd /app/public/wp-content/plugins/shrinkalink && bash bin/install-wp-tests.sh wordpress_test wordpress wordpress database latest true"

3. Run the tests:

   lando ssh -c "cd /app/public/wp-content/plugins/shrinkalink && vendor/bin/phpunit"

   To run one file:

   lando ssh -c "cd /app/public/wp-content/plugins/shrinkalink && vendor/bin/phpunit tests/test-api.php"

The tests are in tests/, one file per area:

class-shrinkalink-testcase.php saves working settings before each test and fakes Shlink's responses through the pre_http_request filter. Queue a response with $this->queue( $status, $body ). A request with no response queued returns an error, so a test can never reach a real server.

Coding standards

The plugin follows the WordPress Coding Standards, configured in .phpcs.xml.dist. With phpcs, WPCS and PHPCompatibilityWP installed:

phpcs

Translations

Regenerate the translation template, languages/shrinkalink.pot, after changing any translatable string in PHP or JavaScript:

composer makepot

Installing with Composer

Shrinkalink is a wordpress-plugin Composer package, so a site that manages plugins with Composer can install it from this repository.

1. Tag a release whose version matches the plugin header, then push the tag:

   git tag v0.1.1
   git push origin v0.1.1

2. In the site's composer.json, add the repository, require the plugin, and set where plugins go:

   {
       "repositories": [
           { "type": "vcs", "url": "git@gitlab.com:brookedot/shrinkalink.git" }
       ],
       "require": {
           "brookedot/shrinkalink": "^0.1"
       },
       "config": {
           "allow-plugins": {
               "composer/installers": true
           }
       },
       "extra": {
           "installer-paths": {
               "plugins/{$name}/": ["type:wordpress-plugin"]
           }
       }
   }

   The installer-paths path is relative to composer.json. Use plugins/{$name}/ when composer.json is in wp-content, or wp-content/plugins/{$name}/ when it's in the site root. Without it, plugins go to wp-content/plugins/ relative to composer.json, which ends up as wp-content/wp-content/plugins/ when composer.json is already in wp-content.

3. Install it, and run composer update brookedot/shrinkalink to pick up later releases:

   composer install

If the repository is private, the server needs access to it, through an SSH key or composer config gitlab-token.gitlab.com <token>.

Don't do this on a site where plugins/shrinkalink is your working copy of this repository, since Composer would replace it.

Releasing

Files listed in .distignore are left out of the release, including the tests, Composer files, the coding standards config and this README.

License

GPLv3 or later. See readme.txt.