From 19ad2584da58b118d51c28b8a73ec373f474d315 Mon Sep 17 00:00:00 2001
From: Jan Tojnar <jtojnar@gmail.com>
Date: Tue, 7 Jun 2022 04:59:22 +0200
Subject: [PATCH] [NFLRUSBridge] Remove byte-order-mark (#2777)

With UTF-8 byte-order mark in the file, the `ListActionTest::testOutput`
would fail after converting tests to PSR-4 namespaces:

    invalid JSON output: Syntax error
    Failed asserting that null is not null.

This is because ListAction::execute tries to create the bridge objects
and, when the files containing the bridge classes are not loaded yet,
the autoloader starts including them. Since this happens after output
buffering has begun, any text in the PHP file before the `<?php` tag
such as the BOM will end up in the buffer to be parsed by `json_decode`.

Previously, it worked by chance thanks to some other test including the file
before `ListActionTest`. With the restructuring, `Actions\ListActionTest`
will run sooner and become responsible for triggering the autoloader.

To prevent this in the future, I also disallowed BOM in the coding style.
---
 bridges/NFLRUSBridge.php | 2 +-
 phpcs.xml                | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/bridges/NFLRUSBridge.php b/bridges/NFLRUSBridge.php
index 04f0644e..c9a92379 100644
--- a/bridges/NFLRUSBridge.php
+++ b/bridges/NFLRUSBridge.php
@@ -1,4 +1,4 @@
-<?php
+<?php
 
 class NFLRUSBridge extends BridgeAbstract {
 
diff --git a/phpcs.xml b/phpcs.xml
index a2cb71ae..72e4e046 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -15,6 +15,8 @@
   <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
   <!-- Do not override methods to call their parent -->
   <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
+  <!-- Do not allow UTF-8 byte-order mark -->
+  <rule ref="Generic.Files.ByteOrderMark"/>
   <!-- Make sure the concatenation operator has spaces around it -->
   <rule ref="Squiz.Strings.ConcatenationSpacing">
     <properties>