Add extra php attribute to methods for 8+ Fixes #52 (#53)

* Add extra php attribute to methods for 8+

These functions are giving notices on php 8+.
The fix is adding a extra php attribute to the methods: #[ReturnTypeWillChange]

* Improve Requests v1 processing

* Fix spaces for Requests v1

* Fix escaping

Co-authored-by: Viktor Szépe <viktor@szepe.net>

Author: janw-me

generate.sh

@@ -35,3 +35,35 @@ if grep -qFx 'namespace {' "$FILE"; then
 else
     printf '\n/**\n * WordPress database abstraction object.\n * @var wpdb\n */\n$wpdb = \\null;\n' >>"$FILE"
 fi
+
+# Add ReturnTypeWillChange attribute to PHP 8-incompatible methods.
+declare -r -a REQUESTS_V1_METHODS=(
+    'Requests_Utility_FilteredIterator::unserialize'
+    'Requests_Utility_FilteredIterator::__unserialize'
+    'Requests_Utility_FilteredIterator::current'
+    'Requests_Cookie_Jar::offsetExists'
+    'Requests_Cookie_Jar::offsetGet'
+    'Requests_Cookie_Jar::offsetSet'
+    'Requests_Cookie_Jar::offsetUnset'
+    'Requests_Cookie_Jar::getIterator'
+    'Requests_Utility_CaseInsensitiveDictionary::offsetExists'
+    'Requests_Utility_CaseInsensitiveDictionary::offsetGet'
+    'Requests_Utility_CaseInsensitiveDictionary::offsetSet'
+    'Requests_Utility_CaseInsensitiveDictionary::offsetUnset'
+    'Requests_Utility_CaseInsensitiveDictionary::getIterator'
+)
+for METHOD in "${REQUESTS_V1_METHODS[@]}"; do
+    # Get the line number where the method is defined.
+    LINE="$(php -r "require 'wordpress-stubs.php'; print (new ReflectionMethod('${METHOD}'))->getStartLine();")"
+    echo "${METHOD} is defined on line ${LINE}."
+
+    # Check the previous line forr ReturnTypeWillChange attribute.
+    if sed -e "$((LINE - 1)) !d" "${FILE}" | grep -q -F '#[ReturnTypeWillChange]'; then
+        continue
+    fi
+
+    # Grab leading whitespace on the current line so we can indent ReturnTypeWillChange correctly.
+    LEADING_WHITESPACES="$(sed -e "${LINE} !d;s#^\\(\\s\\+\\).*\$#\\1#" "${FILE}")"
+    # Insert the ReturnTypeWillChange attribute.
+    sed -i -e "${LINE} i\\" -e "${LEADING_WHITESPACES}#[ReturnTypeWillChange]" "${FILE}"
+done

wordpress-stubs.php

@@ -18963,6 +18963,7 @@ public function normalizeCookie($cookie, $key = \null)
          * @param string $key Item key
          * @return boolean Does the item exist?
          */
+        #[ReturnTypeWillChange]
         public function offsetExists($key)
         {
         }
@@ -18972,6 +18973,7 @@ public function offsetExists($key)
          * @param string $key Item key
          * @return string|null Item value (null if offsetExists is false)
          */
+        #[ReturnTypeWillChange]
         public function offsetGet($key)
         {
         }
@@ -18983,6 +18985,7 @@ public function offsetGet($key)
          * @param string $key Item name
          * @param string $value Item value
          */
+        #[ReturnTypeWillChange]
         public function offsetSet($key, $value)
         {
         }
@@ -18991,6 +18994,7 @@ public function offsetSet($key, $value)
          *
          * @param string $key
          */
+        #[ReturnTypeWillChange]
         public function offsetUnset($key)
         {
         }
@@ -18999,6 +19003,7 @@ public function offsetUnset($key)
          *
          * @return ArrayIterator
          */
+        #[ReturnTypeWillChange]
         public function getIterator()
         {
         }
@@ -20954,6 +20959,7 @@ public function __construct(array $data = array())
          * @param string $key Item key
          * @return boolean Does the item exist?
          */
+        #[ReturnTypeWillChange]
         public function offsetExists($key)
         {
         }
@@ -20963,6 +20969,7 @@ public function offsetExists($key)
          * @param string $key Item key
          * @return string|null Item value (null if offsetExists is false)
          */
+        #[ReturnTypeWillChange]
         public function offsetGet($key)
         {
         }
@@ -20974,6 +20981,7 @@ public function offsetGet($key)
          * @param string $key Item name
          * @param string $value Item value
          */
+        #[ReturnTypeWillChange]
         public function offsetSet($key, $value)
         {
         }
@@ -20982,6 +20990,7 @@ public function offsetSet($key, $value)
          *
          * @param string $key
          */
+        #[ReturnTypeWillChange]
         public function offsetUnset($key)
         {
         }
@@ -20990,6 +20999,7 @@ public function offsetUnset($key)
          *
          * @return ArrayIterator
          */
+        #[ReturnTypeWillChange]
         public function getIterator()
         {
         }
@@ -21721,12 +21731,14 @@ public function __construct($data, $callback)
          *
          * @return string
          */
+        #[ReturnTypeWillChange]
         public function current()
         {
         }
         /**
          * @inheritdoc
          */
+        #[ReturnTypeWillChange]
         public function unserialize($serialized)
         {
         }
@@ -21735,6 +21747,7 @@ public function unserialize($serialized)
          *
          * @phpcs:disable PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.MethodDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
          */
+        #[ReturnTypeWillChange]
         public function __unserialize($serialized)
         {
         }