chore (HidePrefix): add docker-compose-ci (#2)

Author: gesinn-it-ilm

.env-39

@@ -0,0 +1,5 @@
+# docker images
+MW_VERSION?=1.39
+PHP_VERSION?=8.1
+DB_TYPE?=mysql
+DB_IMAGE?=""

.env-40

@@ -0,0 +1,5 @@
+# docker images
+MW_VERSION?=1.40
+PHP_VERSION?=8.1
+DB_TYPE?=mysql
+DB_IMAGE?=""

.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+
+  test:
+
+    runs-on: ubuntu-22.04
+    continue-on-error: ${{ matrix.experimental }}
+
+    strategy:
+      matrix:
+        include:
+          - mediawiki_version: '1.35'
+            php_version: 7.4
+            database_type: mysql
+            database_image: "mysql:5.7"
+            coverage: true
+            experimental: false
+          - mediawiki_version: '1.39'
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mysql:8"
+            coverage: false
+            experimental: false
+          - mediawiki_version: '1.40'
+            php_version: 8.1
+            database_type: mysql
+            database_image: "mysql:8"
+            coverage: false
+            experimental: false
+
+    env:
+      MW_VERSION: ${{ matrix.mediawiki_version }}
+      PHP_VERSION: ${{ matrix.php_version }}
+      DB_TYPE: ${{ matrix.database_type }}
+      DB_IMAGE: ${{ matrix.database_image }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+                   
+      - name: Update submodules
+        run: git submodule update --init --remote
+  
+      - name: Run tests
+        run: make ci
+        if: matrix.coverage == false
+
+      - name: Run tests with coverage
+        run: make ci-coverage
+        if: matrix.coverage == true
+
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage/php/coverage.xml
+        if: matrix.coverage == true

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "build"]
+	path = build
+	url = https://github.com/gesinn-it-pub/docker-compose-ci.git

Makefile

@@ -0,0 +1,35 @@
+-include .env-39
+export
+
+# setup for docker-compose-ci build directory
+# delete "build" directory to update docker-compose-ci
+
+ifeq (,$(wildcard ./build/Makefile))
+    $(shell git submodule update --init --remote)
+endif
+
+EXTENSION=hide-prefix
+
+# docker images
+MW_VERSION?=1.35
+PHP_VERSION?=7.4
+DB_TYPE?=sqlite
+DB_IMAGE?=""
+
+# extensions
+# Enables installation of apt packages for gd extension
+# OS_PACKAGES?="zlib1g-dev libpng-dev"
+
+# Enables installation of gd extension
+# PHP_EXTENSIONS?=gd
+
+# composer
+# Enables "composer update" inside of extension
+COMPOSER_EXT?=true
+
+# nodejs
+# Enables node.js related tests and "npm install"
+# NODE_JS?=true
+
+# check for build dir and git submodule init if it does not exist
+include build/Makefile

README

@@ -0,0 +1,40 @@
+<!-- README -->
+
+# HidePrefix
+
+The HidePrefix extension hides prefix in links and page titles.
+
+For example, wikitext `[[Help:FAQ]]' normally results in link `Help:FAQ'. If this extension is
+enabled, result will be just `FAQ' without the `Help:' prefix.
+
+The same is about page titles. Page `FAQ' in `Help' namespace normally has `Help:FAQ' title. If this
+extension is enabled, visible page title will be just `FAQ' without the `Help:' prefix.
+
+## Download
+
+ git clone https://github.com/gesinn-it-pub/mediawiki-extensions-HidePrefix
+
+## Installation
+
+To install this extension, add the following to LocalSettings.php:
+
+- wfLoadExtension("HidePrefix");
+
+## License
+
+GNU Affero General Public License, version 3 or any later version. See AGPL-3.0.txt file for the
+full license text.
+
+## See also
+
+*   Extension HideNamespace - This extension allows drop prefix in page title and provides control
+    (e. g. hide prefix only in pages of specific namespace, or control prefix visibility from within
+    page content), but it does not affect links.
+
+## Links
+
+* Extension page: https://www.mediawiki.org/wiki/Extension:HidePrefix
+* Author page:    https://www.mediawiki.org/wiki/User:Van_de_Bugger
+* License page:   https://www.gnu.org/licenses/agpl.html
+
+<!-- end of file -->

README.md

@@ -0,0 +1,2 @@
+fixes:
+  - "/var/www/html/extensions/HidePrefix/::"

build

@@ -1,21 +1,36 @@
 {
+	"name": "gesinn-it-pub/hide-prefix",
+  	"type": "mediawiki-extension",
+	"description": "Used to hide prefix in links and page titles",
 	"require-dev": {
 		"mediawiki/mediawiki-codesniffer": "43.0.0",
+		"mediawiki/mediawiki-phan-config": "0.14.0",
 		"mediawiki/minus-x": "1.1.3",
 		"php-parallel-lint/php-console-highlighter": "1.0.0",
 		"php-parallel-lint/php-parallel-lint": "1.4.0"
 	},
 	"scripts": {
 		"test": [
-			"parallel-lint . --exclude vendor --exclude node_modules",
-			"@phpcs",
-			"minus-x check ."
+			"@analyze",
+			"@phpunit"
+		],
+		"test-coverage": [
+			"@analyze",
+			"@phpunit-coverage"
+		],
+		"analyze": [
+			"@lint",
+			"@phpcs"
 		],
 		"fix": [
-			"minus-x fix .",
-			"phpcbf"
+			"@phpcs-fix"
 		],
-		"phpcs": "phpcs -p -s"
+		"lint": "parallel-lint . --exclude vendor --exclude node_modules",
+		"phpcs": "phpcs -ps",
+		"phpcs-fix": "phpcbf -p",
+		"phpunit": "php ../../tests/phpunit/phpunit.php -c phpunit.xml.dist --testdox",
+		"phpunit-coverage": "php ../../tests/phpunit/phpunit.php -c phpunit.xml.dist --testdox --coverage-text --coverage-html coverage/php --coverage-clover coverage/php/coverage.xml",
+		"minus-x": "minus-x check ."
 	},
 	"config": {
 		"allow-plugins": {

codecov.yml

@@ -0,0 +1,12 @@
+<phpunit colors="true">
+    <testsuites>
+        <testsuite name="tests">
+            <directory>tests/phpunit/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="false">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

composer.json

@@ -34,27 +34,25 @@ class HidePrefix {
 	 * @param string &$ret
 	 * @return bool
 	 */
-	public static function onHtmlPageLinkRendererBegin(
-		LinkRenderer $linkRenderer,
+	public static function onHtmlPageLinkRendererBegin( LinkRenderer $linkRenderer,
 		LinkTarget $target,
 		&$text,
 		&$extraAttribs,
 		&$query,
-		&$ret
-	) {
-		if ( isset( $text ) ) {
-			// Hmm... Sometimes `$text' is not a string but an object of class `Message'...
-			if ( is_string( $text ) ) {
-				$title = Title::newFromText( $text );
-				$targetTitle = Title::newFromLinkTarget( $target );
-				if ( $title !== null && $targetTitle && $title->getPrefixedText() == $targetTitle->getPrefixedText() ) {
-					$text = $target->getText();
-				}
-			}
-		} else {
+		&$ret ) {
+		if ( !isset( $text ) ) {
 			$text = $target->getText();
+			return true;
 		}
-		return true;
+
+			$html = HtmlArmor::getHtml( $text );
+			$title = Title::newFromText( $html );
+			$targetTitle = Title::newFromLinkTarget( $target );
+
+		if ( $title !== null && $targetTitle && $title->getPrefixedText() === $targetTitle->getPrefixedText() ) {
+			$text = $target->getText();
+		}
+			return true;
 	}
 
 	/**
@@ -73,7 +71,14 @@ public static function onBeforePageDisplay( &$out, &$sk ) {
 			return;
 		}
 
-		if ( $out->getPageTitle() == $title->getPrefixedText() ) {
+		// result example 'prefix:title', split it to use title
+		$titleWithPrefix = $title->getPrefixedText();
+		$titleWithoutPrefix = explode( ':', $titleWithPrefix );
+
+		// double check $pageTitle from $out -  should contains title of given page
+		$pageTitle = trim( $out->getPageTitle() );
+		if ( ( $pageTitle === trim( $titleWithoutPrefix[1] ) ) ||
+		( strpos( $pageTitle, trim( $titleWithoutPrefix[1] ) ) ) ) {
 			$out->setPageTitle( $title->getText() );
 		}
 	}