From 09c1026b82128d5596512585c11e3da6dbcdc58f Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 14:38:54 +0200
Subject: [PATCH 1/7] add phpcs workflow

---
 .github/workflows/phpcs.yml | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 .github/workflows/phpcs.yml

diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml
new file mode 100644
index 0000000..f13ce47
--- /dev/null
+++ b/.github/workflows/phpcs.yml
@@ -0,0 +1,25 @@
+name: PHP CodeSniffer
+on:
+  pull_request:
+    paths:
+      - "**.php"
+      - "phpcs.xml"
+      - ".github/workflows/phpcs.yml"
+
+jobs:
+  phpcs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Install PHP_CodeSniffer
+        run: |
+          curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+          php phpcs.phar --version
+
+      - uses: tinovyatkin/action-php-codesniffer@v1
+        with:
+          files: "**.php"
+          phpcs_path: php phpcs.phar
+          standard: phpcs.xml

From 00f76b8cd99a7fbf43aa91d809991acc9fa5a8b7 Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 14:43:11 +0200
Subject: [PATCH 2/7] test run phpcs

---
 src/Test.php | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 src/Test.php

diff --git a/src/Test.php b/src/Test.php
new file mode 100644
index 0000000..6140018
--- /dev/null
+++ b/src/Test.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Zahran\Mapper;
+
+class Test {
+
+    public function _foo ($bar) {
+
+
+
+        echo   "a" . 1 ;
+    }
+
+}
+
+

From f3ad9590b7f6bbcd41704fcef46469a1d5531b5d Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 14:45:14 +0200
Subject: [PATCH 3/7] add phpcs.xml

---
 phpcs.xml | 154 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 154 insertions(+)
 create mode 100644 phpcs.xml

diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 0000000..c9dfc72
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,154 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer" xsi:noNamespaceSchemaLocation="phpcs.xsd">
+    <description>The coding standard for PHP_CodeSniffer itself.</description>
+
+    <file>autoload.php</file>
+    <file>bin</file>
+    <file>scripts</file>
+    <file>src</file>
+    <file>tests</file>
+
+    <exclude-pattern>*/src/Standards/*/Tests/*\.(inc|css|js)$</exclude-pattern>
+    <exclude-pattern>*/tests/Core/*/*\.(inc|css|js)$</exclude-pattern>
+
+    <arg name="basepath" value="."/>
+    <arg name="colors"/>
+    <arg name="parallel" value="75"/>
+    <arg value="np"/>
+
+    <!-- Don't hide tokenizer exceptions -->
+    <rule ref="Internal.Tokenizer.Exception">
+        <type>error</type>
+    </rule>
+
+    <!-- Include the whole PEAR standard -->
+    <rule ref="PEAR">
+        <exclude name="PEAR.NamingConventions.ValidFunctionName"/>
+        <exclude name="PEAR.NamingConventions.ValidVariableName"/>
+        <exclude name="PEAR.Commenting.ClassComment"/>
+        <exclude name="PEAR.Commenting.FileComment.MissingCategoryTag"/>
+        <exclude name="PEAR.Commenting.FileComment.MissingPackageTag"/>
+        <exclude name="PEAR.Commenting.FileComment.MissingLinkTag"/>
+        <exclude name="PEAR.Commenting.FileComment.MissingVersion"/>
+        <exclude name="PEAR.Commenting.InlineComment"/>
+    </rule>
+
+    <!-- Include some sniffs from other standards that don't conflict with PEAR -->
+    <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
+    <rule ref="Squiz.Arrays.ArrayDeclaration"/>
+    <rule ref="Squiz.Commenting.ClosingDeclarationComment"/>
+    <rule ref="Squiz.ControlStructures.ControlSignature"/>
+    <rule ref="Squiz.ControlStructures.ElseIfDeclaration"/>
+    <rule ref="Squiz.Commenting.BlockComment"/>
+    <rule ref="Squiz.Commenting.DocCommentAlignment"/>
+    <rule ref="Squiz.Commenting.EmptyCatchComment"/>
+    <rule ref="Squiz.Commenting.InlineComment"/>
+    <rule ref="Squiz.Commenting.LongConditionClosingComment"/>
+    <rule ref="Squiz.Commenting.PostStatementComment"/>
+    <rule ref="Squiz.Commenting.VariableComment"/>
+    <rule ref="Squiz.Formatting.OperatorBracket"/>
+    <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing"/>
+    <rule ref="Squiz.Operators.ComparisonOperatorUsage"/>
+    <rule ref="Squiz.PHP.DisallowInlineIf"/>
+    <rule ref="Squiz.Scope.MethodScope"/>
+    <rule ref="Squiz.Strings.ConcatenationSpacing"/>
+    <rule ref="Squiz.WhiteSpace.ControlStructureSpacing"/>
+    <rule ref="Squiz.WhiteSpace.FunctionClosingBraceSpace"/>
+    <rule ref="Squiz.WhiteSpace.FunctionSpacing"/>
+    <rule ref="Squiz.WhiteSpace.MemberVarSpacing"/>
+    <rule ref="Squiz.WhiteSpace.OperatorSpacing"/>
+    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <rule ref="Generic.Commenting.Todo"/>
+    <rule ref="Generic.ControlStructures.DisallowYodaConditions"/>
+    <rule ref="Generic.ControlStructures.InlineControlStructure"/>
+    <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
+    <rule ref="Generic.Formatting.SpaceAfterCast"/>
+    <rule ref="Generic.NamingConventions.ConstructorName"/>
+    <rule ref="Generic.PHP.DeprecatedFunctions"/>
+    <rule ref="Generic.PHP.LowerCaseKeyword"/>
+    <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
+    <rule ref="Generic.WhiteSpace.IncrementDecrementSpacing"/>
+    <rule ref="PSR2.Classes.PropertyDeclaration"/>
+    <rule ref="PSR2.Methods.MethodDeclaration"/>
+    <rule ref="PSR2.Files.EndFileNewline"/>
+    <rule ref="PSR12.Files.OpenTag"/>
+    <rule ref="Zend.Files.ClosingTag"/>
+
+    <!-- PEAR uses warnings for inline control structures, so switch back to errors -->
+    <rule ref="Generic.ControlStructures.InlineControlStructure">
+        <properties>
+            <property name="error" value="true"/>
+        </properties>
+    </rule>
+
+    <!-- We use custom indent rules for arrays -->
+    <rule ref="Generic.Arrays.ArrayIndent"/>
+    <rule ref="Squiz.Arrays.ArrayDeclaration.KeyNotAligned">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Squiz.Arrays.ArrayDeclaration.ValueNotAligned">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned">
+        <severity>0</severity>
+    </rule>
+    <rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNewLine">
+        <severity>0</severity>
+    </rule>
+
+    <!-- Check var names, but we don't want leading underscores for private vars -->
+    <rule ref="Squiz.NamingConventions.ValidVariableName"/>
+    <rule ref="Squiz.NamingConventions.ValidVariableName.PrivateNoUnderscore">
+        <severity>0</severity>
+    </rule>
+
+    <!-- Only one argument per line in multi-line function calls -->
+    <rule ref="PEAR.Functions.FunctionCallSignature">
+        <properties>
+            <property name="allowMultipleArguments" value="false"/>
+        </properties>
+    </rule>
+
+    <!-- Have 12 chars padding maximum and always show as errors -->
+    <rule ref="Generic.Formatting.MultipleStatementAlignment">
+        <properties>
+            <property name="maxPadding" value="12"/>
+            <property name="error" value="true"/>
+        </properties>
+    </rule>
+
+    <!-- Ban some functions -->
+    <rule ref="Generic.PHP.ForbiddenFunctions">
+        <properties>
+            <property name="forbiddenFunctions" type="array">
+                <element key="sizeof" value="count"/>
+                <element key="delete" value="unset"/>
+                <element key="print" value="echo"/>
+                <element key="is_null" value="null"/>
+                <element key="create_function" value="null"/>
+            </property>
+        </properties>
+    </rule>
+
+    <!-- Private methods MUST not be prefixed with an underscore -->
+    <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
+        <type>error</type>
+    </rule>
+
+    <!-- Private properties MUST not be prefixed with an underscore -->
+    <rule ref="PSR2.Classes.PropertyDeclaration.Underscore">
+        <type>error</type>
+    </rule>
+
+    <!-- The testing bootstrap file uses string concats to stop IDEs seeing the class aliases -->
+    <rule ref="Generic.Strings.UnnecessaryStringConcat">
+        <exclude-pattern>tests/bootstrap\.php</exclude-pattern>
+    </rule>
+
+    <!-- This test file specifically *needs* Windows line endings for testing purposes. -->
+    <rule ref="Generic.Files.LineEndings.InvalidEOLChar">
+        <exclude-pattern>tests/Core/Tokenizer/StableCommentWhitespaceWinTest\.php</exclude-pattern>
+    </rule>
+
+</ruleset>

From ce4360d1993d53ba30023119e1f370ef5eab4b16 Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 14:56:42 +0200
Subject: [PATCH 4/7] test

---
 .github/workflows/phpcs.yml | 17 +++++++----------
 src/Test.php                |  1 +
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml
index f13ce47..25e27cd 100644
--- a/.github/workflows/phpcs.yml
+++ b/.github/workflows/phpcs.yml
@@ -1,4 +1,5 @@
 name: PHP CodeSniffer
+
 on:
   pull_request:
     paths:
@@ -13,13 +14,9 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
-      - name: Install PHP_CodeSniffer
-        run: |
-          curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
-          php phpcs.phar --version
-
-      - uses: tinovyatkin/action-php-codesniffer@v1
-        with:
-          files: "**.php"
-          phpcs_path: php phpcs.phar
-          standard: phpcs.xml
+      - name: Install PHP CodeSniffer
+        run: curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+      - name: Modified Files
+        run: git ls-files -om --exclude-standard
+      - name: Run PHPCS
+        run: php phpcs.phar ./phpcs.xml $(git ls-files -om --exclude-standard)
diff --git a/src/Test.php b/src/Test.php
index 6140018..eebcb08 100644
--- a/src/Test.php
+++ b/src/Test.php
@@ -9,6 +9,7 @@ public function _foo ($bar) {
 
 
         echo   "a" . 1 ;
+
     }
 
 }

From 82b0d13cf0f5cee2b6839c6ee3eb1b61bbde1f7d Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 15:08:12 +0200
Subject: [PATCH 5/7] test

---
 src/Test.php | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/Test.php b/src/Test.php
index eebcb08..098d026 100644
--- a/src/Test.php
+++ b/src/Test.php
@@ -8,6 +8,14 @@ public function _foo ($bar) {
 
 
 
+        echo   "a" . 1 ;
+
+    }
+
+        public function test ($bar) {
+
+
+
         echo   "a" . 1 ;
 
     }

From 4f39dd9574d54e5da59a34b79c2ee870f4a17dde Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 15:11:17 +0200
Subject: [PATCH 6/7] test

---
 .github/workflows/phpcs.yml | 2 +-
 src/Test.php                | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml
index 25e27cd..2a67c22 100644
--- a/.github/workflows/phpcs.yml
+++ b/.github/workflows/phpcs.yml
@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 0
+          fetch-depth: 2
       - name: Install PHP CodeSniffer
         run: curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
       - name: Modified Files
diff --git a/src/Test.php b/src/Test.php
index 098d026..2c69660 100644
--- a/src/Test.php
+++ b/src/Test.php
@@ -7,7 +7,7 @@ class Test {
     public function _foo ($bar) {
 
 
-
+ 
         echo   "a" . 1 ;
 
     }

From 9ebb29c59436fdb69dd2452ca8daacc0d8de918d Mon Sep 17 00:00:00 2001
From: Mohamed Zahran <m.zahran90@gmail.com>
Date: Fri, 16 Apr 2021 15:16:30 +0200
Subject: [PATCH 7/7] test

---
 .github/workflows/phpcs.yml | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml
index 2a67c22..4d1176b 100644
--- a/.github/workflows/phpcs.yml
+++ b/.github/workflows/phpcs.yml
@@ -1,4 +1,4 @@
-name: PHP CodeSniffer
+name: "CI"
 
 on:
   pull_request:
@@ -13,10 +13,17 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 2
-      - name: Install PHP CodeSniffer
-        run: curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
-      - name: Modified Files
-        run: git ls-files -om --exclude-standard
-      - name: Run PHPCS
-        run: php phpcs.phar ./phpcs.xml $(git ls-files -om --exclude-standard)
+          fetch-depth: 0 # important!
+
+      # we may use whatever way to install phpcs, just specify the path on the next step
+      # however, curl seems to be the fastest
+      - name: Install PHP_CodeSniffer
+        run: |
+          curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+          php phpcs.phar --version
+
+      - uses: tinovyatkin/action-php-codesniffer@v1
+        with:
+          files: "**.php" # you may customize glob as needed
+          phpcs_path: php phpcs.phar
+          standard: phpcs.xml