Added Code, Test and updated Readme

Signed-off-by: Muhammad Yousuf Fazal <[email protected]>

README.md

@@ -61,6 +61,7 @@ Example:
 Parameters:
 * `lang`: One of the [supported languages]
 * `line`: (Optional) show line numbers
+* `render`: (Optional) render as Markdown
 
 Examples:
 
@@ -74,6 +75,11 @@ Render PHP file with line numbers:
 {{#embed:https://example.com/fluffy/kittens.php|lang=php|line}}
 ```
 
+Render file as Markdown:
+```
+{{#embed:https://example.com/fluffy/kittens.php|render}}
+```
+
 ### Refreshing external content
 
 To refresh all the pages containing one of the parser functions added by this extension, run
@@ -113,6 +119,16 @@ You can verify the extension was enabled successfully by opening your wikis Spec
 
 Configuration can be changed via [LocalSettings.php].
 
+### Render markdown by default
+
+Render markdown files rather than showing the markdown in a codeblock, unless the file is explicitly marked as code.
+
+Variable: `$wgExternalContentRenderMarkdownByDefault`
+
+Default: `true`
+
+Example: `false` - disables the default markdown render
+
 ### Domain whitelist
 
 List of allowed domains to embed content from. Leave empty to have no restriction.

src/Domain/ContentRenderer/RendererConfig.php

@@ -9,7 +9,8 @@ class RendererConfig {
 	public function __construct(
 		public string $fileExtension,
 		public string $language,
-		public bool $showLineNumbers
+		public bool $showLineNumbers,
+		public bool $render
 	) {
 	}
 

src/Domain/WikiContentRendererFactory.php

@@ -11,22 +11,15 @@
 class WikiContentRendererFactory implements ContentRendererFactory {
 
 	public function createContentRenderer( RendererConfig $config ): ContentRenderer {
-		if ( $config->language !== '' ) {
+		if ( $config->render ) {
+			return new MarkdownRenderer();
+		}
+		else {
 			return new CodeRenderer(
-				language: $config->language,
+				language: ( $config->language !== '' ) ? $config->language : $config->fileExtension, // TODO: Use an extension-to-language map, although common extensions already work.
 				showLineNumbers: $config->showLineNumbers
 			);
 		}
-
-		// TODO: check config if this should be default behavior
-		if ( $config->fileExtension === 'md' ) {
-			return new MarkdownRenderer();
-		}
-
-		return new CodeRenderer(
-			language: $config->fileExtension, // TODO: Use an extension-to-language map, although common extensions already work.
-			showLineNumbers: $config->showLineNumbers
-		);
 	}
 
 }

src/EmbedExtensionFactory.php

@@ -25,6 +25,7 @@ class EmbedExtensionFactory {
 
 	public const DEFAULT_CONFIG = [
 		'wgLanguageCode' => 'en',
+		'wgExternalContentRenderMarkdownByDefault' => true,
 		'wgExternalContentDomainWhitelist' => [],
 		'wgExternalContentFileExtensionWhitelist' => [ 'md' ],
 		'wgExternalContentEnableEmbedFunction' => true,

src/UseCases/Embed/EmbedRequest.php

@@ -9,7 +9,8 @@ class EmbedRequest {
 	public function __construct(
 		public string $fileUrl,
 		public ?string $language,
-		public ?bool $showLineNumbers
+		public ?bool $showLineNumbers,
+		public ?bool $render
 	) {
 	}
 

src/UseCases/Embed/EmbedRequestBuilder.php

@@ -4,6 +4,7 @@
 
 namespace ProfessionalWiki\ExternalContent\UseCases\Embed;
 
+use MediaWiki\MediaWikiServices;
 class EmbedRequestBuilder {
 
 	/**
@@ -14,11 +15,15 @@ public static function argumentsToRequest( array $arguments ): EmbedRequest {
 
 		$language = $normalizedArguments['lang'] ?? null;
 		$line = $normalizedArguments['line'] ?? null;
+		$render = $normalizedArguments['render'] ?? null;
+
+		$markdownByDefault = MediaWikiServices::getInstance()->getMainConfig()->get( 'ExternalContentRenderMarkdownByDefault' );
 
 		return new EmbedRequest(
 			fileUrl: $arguments[0],
 			language: is_string( $language ) ? $language : null,
-			showLineNumbers: is_bool( $line ) ? $line : null
+			showLineNumbers: is_bool( $line ) ? $line : null,
+			render: is_bool( $markdownByDefault ) ? $markdownByDefault : ( is_bool( $render ) ? $render : null ),
 		);
 	}
 

src/UseCases/Embed/EmbedUseCase.php

@@ -75,7 +75,8 @@ private function createRendererConfig( EmbedRequest $request ): RendererConfig {
 		return new RendererConfig(
 			fileExtension: $this->extractFileExtension( $this->urlNormalizer->fullNormalize( $request->fileUrl ) ),
 			language: $request->language ?? '',
-			showLineNumbers: $request->showLineNumbers ?? false
+			showLineNumbers: $request->showLineNumbers ?? false,
+			render: $request->render ?? false
 		);
 	}
 

tests/Unit/Domain/WikiContentRendererFactoryTest.php

@@ -20,7 +20,8 @@ public function testMarkdownFileAndConfigWithoutLanguageCreatesMarkdownRenderer(
 				new RendererConfig(
 					fileExtension: 'md',
 					language: '',
-					showLineNumbers: false
+					showLineNumbers: false,
+					render: true
 				)
 			)
 		);
@@ -33,7 +34,8 @@ public function testConfigWithoutLanguageCreatesCodeRenderer(): void {
 				new RendererConfig(
 					fileExtension: 'php',
 					language: '',
-					showLineNumbers: false
+					showLineNumbers: false,
+					render: false
 				)
 			)
 		);
@@ -46,7 +48,8 @@ public function testConfigWithLanguageCreatesCodeRenderer(): void {
 				new RendererConfig(
 					fileExtension: 'php',
 					language: 'php',
-					showLineNumbers: false
+					showLineNumbers: false,
+					render: false
 				)
 			)
 		);
@@ -59,7 +62,8 @@ public function testConfigWithLanguageAndLineNumbersCreatesCodeRenderer(): void
 				new RendererConfig(
 					fileExtension: 'php',
 					language: 'php',
-					showLineNumbers: true
+					showLineNumbers: true,
+					render: false
 				)
 			)
 		);
@@ -72,7 +76,8 @@ public function testConfigWithMarkdownLanguageCreatesCodeRenderer(): void {
 				new RendererConfig(
 					fileExtension: 'md',
 					language: 'md',
-					showLineNumbers: false
+					showLineNumbers: false,
+					render: false
 				)
 			)
 		);

tests/Unit/UseCases/Embed/EmbedUseCaseTest.php

@@ -69,7 +69,8 @@ private function createRequest( string $fileUrl ): EmbedRequest {
 		return new EmbedRequest(
 			fileUrl: $fileUrl,
 			language: '',
-			showLineNumbers: false
+			showLineNumbers: false,
+			render: false
 		);
 	}