Handle end-of-line normalisation (#16)

* Initial implementation

* Add tests

* Improve test coverage

Author: uuf6429

README.md

@@ -331,14 +331,14 @@ final class MyFormatter extends AbstractCodecFormatter
     }
 }
 
-['formatters' => [ new MyFormatter('1.0', new PlainStringCodec()) ]]
+['formatters' => [ new MyFormatter('1.0') ]]
 ```
 
 Example with an anonymous class:
 
 ```php
 ['formatters' => [
-    new class ('1.0', new PlainStringCodec()) extends AbstractCodecFormatter
+    new class ('1.0') extends AbstractCodecFormatter
     {
         protected function formatContent(string $original): string
         {
@@ -386,7 +386,7 @@ Example:
     versionValueOrCommand: '1.0',               // Either a version as a string, or the command to get the version (as an array).
     formatCommand: ['cmd' => 'jfmt -'],         // An array defining the external command to do the formatting.
     interpolationCodec: new PlainStringCodec(), // A codec for handling interpolations; depends on the content being formatted.
-    stripLastNewLine: true,                     // Remove last line from cli output - you might need this, depending on the platform/shell.
+    lineEndingNormalizer: null,                 // A normalizer for handling end-of-line characters.
 ) ]]
 ```
 
@@ -410,7 +410,7 @@ Example:
     command: ['bin/tool', '--dry-run', '-'],    // The command to run within the container, including any arguments.
     pullMode: 'always',                         // How/when the image should be pulled: 'never', 'always' or 'missing'.
     interpolationCodec: new PlainStringCodec(), // A codec for handling interpolations; depends on the content being formatted.
-    stripLastNewLine: true,                     // Remove last line from docker output - typically needed.
+    lineEndingNormalizer: null,                 // A normalizer for handling end-of-line characters.
 ) ]]
 ```
 
@@ -425,6 +425,7 @@ Example:
     indentSize: 4,                              // The number of spaces defining one indentation level in your project.
     indentChar: "\t",                           // The actual character used for indentation (space or tab).
     interpolationCodec: new PlainStringCodec(), // A codec for handling interpolations; depends on the content being formatted.
+    lineEndingNormalizer: null,                 // A normalizer for handling end-of-line characters.
 ) ]]
 ```
 

composer.json

@@ -23,7 +23,8 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "symfony/process": "^5 || ^6 || ^7 || ^8",
-        "friendsofphp/php-cs-fixer": "^3"
+        "friendsofphp/php-cs-fixer": "^3",
+        "symfony/deprecation-contracts": "^2 || ^3"
     },
     "require-dev": {
         "ext-json": "*",

src/Formatter/AbstractCodecFormatter.php

@@ -5,6 +5,8 @@
 use uuf6429\PhpCsFixerBlockstring\BlockString\BlockString;
 use uuf6429\PhpCsFixerBlockstring\InterpolationCodec\CodecInterface;
 use uuf6429\PhpCsFixerBlockstring\InterpolationCodec\PlainStringCodec;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\DefaultNormalizer;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\NormalizerInterface;
 
 /**
  * This formatter base class is aware of string interpolation - it passes content through a codec before and after
@@ -25,14 +27,14 @@
  *     }
  * }
  *
- * ['formatters' => [ new MyFormatter('1.0', new PlainStringCodec()) ]]
+ * ['formatters' => [ new MyFormatter('1.0') ]]
  * ```
  *
  * Example with an anonymous class:
  *
  * ```php
  * ['formatters' => [
- *     new class ('1.0', new PlainStringCodec()) extends AbstractCodecFormatter
+ *     new class ('1.0') extends AbstractCodecFormatter
  *     {
  *         protected function formatContent(string $original): string
  *         {
@@ -58,12 +60,21 @@ abstract class AbstractCodecFormatter extends AbstractFormatter
 	 */
 	protected CodecInterface $interpolationCodec;
 
-	public function __construct(string $version, ?CodecInterface $interpolationCodec)
-	{
+	/**
+	 * @readonly
+	 */
+	private NormalizerInterface $lineEndingNormalizer;
+
+	public function __construct(
+		string               $version,
+		?CodecInterface      $interpolationCodec=null,
+		?NormalizerInterface $lineEndingNormalizer=null
+	) {
 		parent::__construct($version);
 
 		$this->objectIndex = self::$objectCounter++;
 		$this->interpolationCodec = $interpolationCodec ?? new PlainStringCodec();
+		$this->lineEndingNormalizer = $lineEndingNormalizer ?? new DefaultNormalizer(DefaultNormalizer::NO_CHANGE, DefaultNormalizer::NO_CHANGE);
 	}
 
 	final public function formatBlock(BlockString $blockString): BlockString
@@ -72,8 +83,10 @@ final public function formatBlock(BlockString $blockString): BlockString
 
 		$cacheKey = $this->objectIndex . ':' . md5($codecResult->content);
 		if (!isset(self::$cache[$cacheKey])) {
-			self::$cache[$cacheKey] = $this->formatContent(
-				$this->removeIndentation($codecResult->content, $blockString->indentation)
+			$content = $this->removeIndentation($codecResult->content, $blockString->indentation);
+			self::$cache[$cacheKey] = $this->lineEndingNormalizer->normalize(
+				$this->formatContent($content),
+				$content
 			);
 		}
 		$newContent = $this->applyIndentation(self::$cache[$cacheKey], $blockString->indentation);
@@ -90,11 +103,11 @@ abstract protected function formatContent(string $original): string;
 
 	private function removeIndentation(string $lines, string $indentation): string
 	{
-		return substr(str_replace("\n{$indentation}", "\n", $lines), strlen($indentation));
+		return substr(str_replace("\n{$indentation}", "\n", $lines), strlen($indentation)); // TODO feels wrong (eol)
 	}
 
 	private function applyIndentation(string $lines, string $indentation): string
 	{
-		return $indentation . str_replace("\n", "\n{$indentation}", $lines);
+		return $indentation . str_replace("\n", "\n{$indentation}", $lines); // TODO feels wrong (eol)
 	}
 }

src/Formatter/CliPipeFormatter.php

@@ -4,6 +4,8 @@
 
 use Symfony\Component\Process\Process;
 use uuf6429\PhpCsFixerBlockstring\InterpolationCodec\CodecInterface;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\DefaultNormalizer;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\NormalizerInterface;
 
 /**
  * It's no secret that the best formatting tools are not directly available in PHP. This formatter off-loads formatting
@@ -16,7 +18,7 @@
  *     versionValueOrCommand: '1.0',               // Either a version as a string, or the command to get the version (as an array).
  *     formatCommand: ['cmd' => 'jfmt -'],         // An array defining the external command to do the formatting.
  *     interpolationCodec: new PlainStringCodec(), // A codec for handling interpolations; depends on the content being formatted.
- *     stripLastNewLine: true,                     // Remove last line from cli output - you might need this, depending on the platform/shell.
+ *     lineEndingNormalizer: null,                 // A normalizer for handling end-of-line characters.
  * ) ]]
  * ```
  *
@@ -37,30 +39,39 @@ class CliPipeFormatter extends AbstractCodecFormatter
 	 */
 	private array $formatter;
 
-	/**
-	 * @readonly
-	 */
-	private bool $stripLastNewLine;
-
 	/**
 	 * @param TVersion|TCommand $versionValueOrCommand Either the version (as a string) or a command to retrieve the
 	 * version (as an array).
 	 * @param TCommand $formatCommand A command, as an array, to perform the formatting.
+	 * @param null|bool|NormalizerInterface $lineEndingNormalizer
 	 */
 	public function __construct(
 		$versionValueOrCommand,
 		array $formatCommand,
 		?CodecInterface $interpolationCodec = null,
-		bool $stripLastNewLine = false
+		$lineEndingNormalizer = false
 	) {
 		$this->formatter = $formatCommand;
-		$this->stripLastNewLine = $stripLastNewLine;
+
+		if (is_bool($lineEndingNormalizer)) {
+			trigger_deprecation(
+				'uuf6429/php-cs-fixer-blockstring',
+				'1.0.4',
+				'Passing a bool for argument $lineEndingNormalizer to %s is deprecated',
+				__METHOD__
+			);
+			$lineEndingNormalizer = new DefaultNormalizer(
+				DefaultNormalizer::LF,
+				$lineEndingNormalizer ? DefaultNormalizer::STRIP : DefaultNormalizer::NO_CHANGE
+			);
+		}
 
 		parent::__construct(
 			is_string($versionValueOrCommand)
 				? $versionValueOrCommand
 				: $this->exec($versionValueOrCommand, null),
-			$interpolationCodec
+			$interpolationCodec,
+			$lineEndingNormalizer
 		);
 	}
 
@@ -90,10 +101,6 @@ protected function exec(array $spec, ?string $input): string
 
 	protected function formatContent(string $original): string
 	{
-		$output = $this->exec($this->formatter, $original);
-
-		return ($this->stripLastNewLine && substr($output, -1) === "\n")
-			? substr($output, 0, -1)
-			: $output;
+		return $this->exec($this->formatter, $original);
 	}
 }

src/Formatter/DockerPipeFormatter.php

@@ -7,6 +7,8 @@
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
 use uuf6429\PhpCsFixerBlockstring\InterpolationCodec\CodecInterface;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\DefaultNormalizer;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\NormalizerInterface;
 
 /**
  * The minimal setup, stable repeatability, and a rich ecosystem makes Docker images an ideal source of formatting
@@ -21,7 +23,7 @@
  *     command: ['bin/tool', '--dry-run', '-'],    // The command to run within the container, including any arguments.
  *     pullMode: 'always',                         // How/when the image should be pulled: 'never', 'always' or 'missing'.
  *     interpolationCodec: new PlainStringCodec(), // A codec for handling interpolations; depends on the content being formatted.
- *     stripLastNewLine: true,                     // Remove last line from docker output - typically needed.
+ *     lineEndingNormalizer: null,                 // A normalizer for handling end-of-line characters.
  * ) ]]
  * ```
  *
@@ -58,34 +60,43 @@ class DockerPipeFormatter extends AbstractCodecFormatter
 	 */
 	private array $imageDetails;
 
-	/**
-	 * @readonly
-	 */
-	private bool $stripLastNewLine;
-
 	/**
 	 * @param list<string> $options
 	 * @param list<string> $command
 	 * @param 'never'|'missing'|'always' $pullMode
+	 * @param null|bool|NormalizerInterface $lineEndingNormalizer
 	 */
 	public function __construct(
 		string          $image,
 		array           $options = [],
 		array           $command = [],
 		string          $pullMode = 'never',
 		?CodecInterface $interpolationCodec = null,
-		bool            $stripLastNewLine = true
+		                $lineEndingNormalizer = true
 	) {
 		$this->image = $image;
 		$this->options = $options;
 		$this->command = $command;
 		$this->pullMode = $pullMode;
 		$this->imageDetails = $this->resolveImageDetails();
-		$this->stripLastNewLine = $stripLastNewLine;
+
+		if (is_bool($lineEndingNormalizer)) {
+			trigger_deprecation(
+				'uuf6429/php-cs-fixer-blockstring',
+				'1.0.4',
+				'Passing a bool for argument $lineEndingNormalizer to %s is deprecated',
+				__METHOD__
+			);
+			$lineEndingNormalizer = new DefaultNormalizer(
+				DefaultNormalizer::LF,
+				$lineEndingNormalizer ? DefaultNormalizer::STRIP : DefaultNormalizer::NO_CHANGE
+			);
+		}
 
 		parent::__construct(
 			"{$this->imageDetails['platform']};{$this->imageDetails['digest']}",
-			$interpolationCodec
+			$interpolationCodec,
+			$lineEndingNormalizer
 		);
 	}
 
@@ -172,10 +183,6 @@ protected function formatContent(string $original): string
 			null
 		);
 
-		$output = $process->mustRun()->getOutput();
-
-		return ($this->stripLastNewLine && substr($output, -1) === "\n")
-			? substr($output, 0, -1)
-			: $output;
+		return $process->mustRun()->getOutput();
 	}
 }

src/Formatter/SimpleLineFormatter.php

@@ -3,6 +3,8 @@
 namespace uuf6429\PhpCsFixerBlockstring\Formatter;
 
 use uuf6429\PhpCsFixerBlockstring\InterpolationCodec\CodecInterface;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\DefaultNormalizer;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\NormalizerInterface;
 
 /**
  * A formatter that normalizes indentation and removes any trailing whitespace at the end of lines.
@@ -14,6 +16,7 @@
  *     indentSize: 4,                              // The number of spaces defining one indentation level in your project.
  *     indentChar: "\t",                           // The actual character used for indentation (space or tab).
  *     interpolationCodec: new PlainStringCodec(), // A codec for handling interpolations; depends on the content being formatted.
+ *     lineEndingNormalizer: null,                 // A normalizer for handling end-of-line characters.
  * ) ]]
  * ```
  */
@@ -34,16 +37,31 @@ class SimpleLineFormatter extends AbstractCodecFormatter
 	/**
 	 * @param positive-int $indentSize
 	 * @param "\t"|' ' $indentChar
+	 * @param null|bool|NormalizerInterface $lineEndingNormalizer
 	 */
 	public function __construct(
 		int             $indentSize = 4,
 		string          $indentChar = "\t",
-		?CodecInterface $interpolationCodec = null
+		?CodecInterface $interpolationCodec = null,
+		                $lineEndingNormalizer = false
 	) {
-		parent::__construct('1', $interpolationCodec);
-
 		$this->indentSize = $indentSize;
 		$this->indentChar = $indentChar;
+
+		if (is_bool($lineEndingNormalizer)) {
+			trigger_deprecation(
+				'uuf6429/php-cs-fixer-blockstring',
+				'1.0.4',
+				'Passing a bool for argument $lineEndingNormalizer to %s is deprecated',
+				__METHOD__
+			);
+			$lineEndingNormalizer = new DefaultNormalizer(
+				DefaultNormalizer::LF,
+				$lineEndingNormalizer ? DefaultNormalizer::STRIP : DefaultNormalizer::NO_CHANGE
+			);
+		}
+
+		parent::__construct('1', $interpolationCodec, $lineEndingNormalizer);
 	}
 
 	protected function formatContent(string $original): string

src/Formatter/WslPipeFormatter.php

@@ -1,8 +1,10 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace uuf6429\PhpCsFixerBlockstring\Formatter;
 
 use uuf6429\PhpCsFixerBlockstring\InterpolationCodec\CodecInterface;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\DefaultNormalizer;
+use uuf6429\PhpCsFixerBlockstring\LineEndingNormalizer\NormalizerInterface;
 
 /**
  * A formatter making use of Windows Subsystem for Linux (WSL). Of course you will need to be running on Windows and WSL
@@ -18,17 +20,31 @@ class WslPipeFormatter extends CliPipeFormatter
 
 	/**
 	 * @param 'standard'|'login'|'none' $shellType
+	 * @param null|bool|NormalizerInterface $lineEndingNormalizer
 	 */
 	public function __construct(
 		$versionValueOrCommand,
 		array $formatCommand,
 		?CodecInterface $interpolationCodec = null,
 		string $shellType = 'login',
-		bool $stripLastNewLine = true
+		$lineEndingNormalizer = true
 	) {
 		$this->shellType = $shellType;
 
-		parent::__construct($versionValueOrCommand, $formatCommand, $interpolationCodec, $stripLastNewLine);
+		if (is_bool($lineEndingNormalizer)) {
+			trigger_deprecation(
+				'uuf6429/php-cs-fixer-blockstring',
+				'1.0.4',
+				'Passing a bool for argument $lineEndingNormalizer to %s is deprecated',
+				__METHOD__
+			);
+			$lineEndingNormalizer = new DefaultNormalizer(
+				DefaultNormalizer::LF,
+				$lineEndingNormalizer ? DefaultNormalizer::STRIP : DefaultNormalizer::NO_CHANGE
+			);
+		}
+
+		parent::__construct($versionValueOrCommand, $formatCommand, $interpolationCodec, $lineEndingNormalizer);
 	}
 
 	protected function exec(array $spec, ?string $input): string