Subject: [PATCH v3] userdiff: php: Add "final" and "abstract" to the list of function modifiers

From: "Javier Spagnoletti via GitGitGadget" <[email-masked]>
Date: Wed, 07 Oct 2020 18:07:49 +0000

From: Javier Spagnoletti <[email-masked]>

PHP allows some function modifiers that are not recognized in our current hunk header pattern

       final public function foo() { }
       abstract protected function bar() { }

Some context about the PHP semantics:

In PHP a class can be declared as abstract and final, while methods can be declared as final,
static and abstract, along with its visibility (public, protected and private).
Regarding classes, an abstract class can not be declared as final.
For the methods, from a strict syntax perspective, the order of the modifiers is irrelevant.

For more information, see:

* https://www.php.net/manual/en/language.oop5.abstract.php#example-213;
* https://www.php.net/manual/en/language.oop5.final.php#language.oop5.traits.static.ex1.

This commit adds "final" and "abstract" to the list of function modifiers.

Signed-off-by: Javier Spagnoletti <[email-masked]>
---
    userdiff: php: Add "final" and "abstract" to the list of function
    modifiers
    
    PHP allows some function modifiers that are not recognized in our
    current hunk header pattern
    
       final public function foo() { }
       abstract protected function bar() { }
    
    Some context about the PHP semantics:
    
    In PHP a class can be declared as abstract and final, while methods can
    be declared as final, static and abstract, along with its visibility
    (public, protected and private). Regarding classes, an abstract class
    can not be declared as final. For the methods, from a strict syntax
    perspective, the order of the modifiers is irrelevant.
    
    For more information, see:
    
     * https://www.php.net/manual/en/language.oop5.abstract.php#example-213;
     * https://www.php.net/manual/en/language.oop5.final.php#language.oop5.traits.static.ex1
       .
    
    This commit adds "final" and "abstract" to the list of function
    modifiers.
    
    Signed-off-by: Javier Spagnoletti [email-masked] [[email-masked]]

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-864%2Fphansys%2Fuserdiff_php-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-864/phansys/userdiff_php-v3
Pull-Request: https://github.com/git/git/pull/864

Range-diff vs v2:

 1:  4cb59950ff ! 1:  43acd70aba Improve diff pattern for PHP files
     @@ Metadata
      Author: Javier Spagnoletti <[email-masked]>
      
       ## Commit message ##
     -    Improve diff pattern for PHP files
     +    userdiff: php: Add "final" and "abstract" to the list of function modifiers
      
          PHP allows some function modifiers that are not recognized in our current hunk header pattern
      
                 final public function foo() { }
                 abstract protected function bar() { }
      
     -    Add "final" and "abstract" to the list of function modifiers.
     +    Some context about the PHP semantics:
     +
     +    In PHP a class can be declared as abstract and final, while methods can be declared as final,
     +    static and abstract, along with its visibility (public, protected and private).
     +    Regarding classes, an abstract class can not be declared as final.
     +    For the methods, from a strict syntax perspective, the order of the modifiers is irrelevant.
     +
     +    For more information, see:
     +
     +    * https://www.php.net/manual/en/language.oop5.abstract.php#example-213;
     +    * https://www.php.net/manual/en/language.oop5.final.php#language.oop5.traits.static.ex1.
     +
     +    This commit adds "final" and "abstract" to the list of function modifiers.
      
          Signed-off-by: Javier Spagnoletti <[email-masked]>

 t/t4018/php-abstract-method | 7 +++++++
 t/t4018/php-final-method    | 7 +++++++
 userdiff.c                  | 2 +-
 3 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 t/t4018/php-abstract-method
 create mode 100644 t/t4018/php-final-method

diff --git a/t/t4018/php-abstract-method b/t/t4018/php-abstract-method
new file mode 100644
index 0000000000..ce215df75a
--- /dev/null
+++ b/t/t4018/php-abstract-method
@@ -0,0 +1,7 @@
+abstract class Klass
+{
+    abstract public function RIGHT(): ?string
+    {
+        return 'ChangeMe';
+    }
+}
diff --git a/t/t4018/php-final-method b/t/t4018/php-final-method
new file mode 100644
index 0000000000..537fb8ad9a
--- /dev/null
+++ b/t/t4018/php-final-method
@@ -0,0 +1,7 @@
+class Klass
+{
+    final public function RIGHT(): string
+    {
+        return 'ChangeMe';
+    }
+}
diff --git a/userdiff.c b/userdiff.c
index 1df884ef0b..a99d84a7e3 100644
--- a/userdiff.c
+++ b/userdiff.c
@@ -143,7 +143,7 @@ PATTERNS("perl",
 	 "|=~|!~"
 	 "|<<|<>|<=>|>>"),
 PATTERNS("php",
-	 "^[\t ]*(((public|protected|private|static)[\t ]+)*function.*)$\n"
+	 "^[\t ]*(((public|protected|private|static|abstract|final)[\t ]+)*function.*)$\n"
 	 "^[\t ]*((((final|abstract)[\t ]+)?class|interface|trait).*)$",
 	 /* -- */
 	 "[a-zA-Z_][a-zA-Z0-9_]*"

base-commit: 47ae905ffb98cc4d4fd90083da6bc8dab55d9ecc
-- 
gitgitgadget