Merge pull request #42 from igorhrcek/issue-37

Issue 37

Author: Igor Hrcek

.gitignore

@@ -6,3 +6,5 @@ vendor/
 nginx.conf
 .DS_Store
 wp/
+composer.lock
+wp_cli_secure.iml

composer.json

@@ -27,7 +27,9 @@
     "require-dev": {
         "guzzlehttp/guzzle": "^7.0",
         "mikey179/vfsstream": "^1.6",
+        "phpstan/phpstan": "^1.5",
         "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.6",
         "vlucas/phpdotenv": "^5.4",
         "wp-cli/wp-cli-bundle": "*",
         "wp-cli/wp-cli-tests": "^3.1"

src/Exceptions/FileDoesNotExist.php

@@ -4,9 +4,10 @@
 
 use Exception;
 
-class FileDoesNotExist extends Exception {
+class FileDoesNotExist extends Exception
+{
     /**
      * @var string
      */
     protected $message = 'File does not exist';
-}
+}

src/Exceptions/FileIsNotReadable.php

@@ -4,9 +4,10 @@
 
 use Exception;
 
-class FileIsNotReadable extends Exception {
+class FileIsNotReadable extends Exception
+{
     /**
      * @var string
      */
     protected $message = 'File does not have a correct permissions to read its content';
-}
+}

src/Exceptions/FileIsNotWritable.php

@@ -4,9 +4,10 @@
 
 use Exception;
 
-class FileIsNotWritable extends Exception {
+class FileIsNotWritable extends Exception
+{
     /**
      * @var string
      */
     protected $message = 'File does not have a correct permissions for writing';
-}
+}

src/Exceptions/RuleAlreadyExist.php

@@ -4,9 +4,10 @@
 
 use Exception;
 
-class RuleAlreadyExist extends Exception {
+class RuleAlreadyExist extends Exception
+{
     /**
      * @var string
      */
     protected $message = 'The rule already exists in the file';
-}
+}

src/FileManager.php

@@ -9,7 +9,8 @@
 use WP_CLI_Secure\Exceptions\FileIsNotWritable;
 use WP_CLI_Secure\Exceptions\RuleAlreadyExist;
 
-class FileManager {
+class FileManager
+{
     /**
      * Defines the end of each marked block
      * # END WP CLI SECURE
@@ -65,7 +66,8 @@ class FileManager {
      */
     private array $file;
 
-    public function __construct(string $path) {
+    public function __construct(string $path)
+    {
         $this->path = $path;
         $this->file = $this->setFileContent();
     }
@@ -76,12 +78,13 @@ public function __construct(string $path) {
      * @return array
      * @throws FileIsNotReadable
      */
-    private function setFileContent() : array {
-        if(!$this->fileExist()) {
+    private function setFileContent(): array
+    {
+        if (!$this->fileExist()) {
             return [];
         }
 
-        if(!$this->isReadable()) {
+        if (!$this->isReadable()) {
             throw new FileIsNotReadable();
         }
 
@@ -96,18 +99,19 @@ private function setFileContent() : array {
      *
      * @return array
      */
-    public function read(int $startLine = 0, int $lines = null) : array {
+    public function read(int $startLine = 0, int $lines = null): array
+    {
         $result = [];
         $file = new \SplFileObject($this->path);
         $file->seek($startLine);
 
-        if($lines === null) {
-            while(!$file->eof()) {
+        if ($lines === null) {
+            while (!$file->eof()) {
                 $result[] = rtrim($file->current(), "\n");
                 $file->next();
             }
         } else {
-            for($i = 0; $i < $lines; $i++) {
+            for ($i = 0; $i < $lines; $i++) {
                 if ($file->eof()) {
                     break;
                 }
@@ -127,7 +131,8 @@ public function read(int $startLine = 0, int $lines = null) : array {
      *
      * @return bool
      */
-    private function isWritable() : bool {
+    private function isWritable(): bool
+    {
         return is_writable($this->path);
     }
 
@@ -136,7 +141,8 @@ private function isWritable() : bool {
      *
      * @return bool
      */
-    private function isReadable(): bool {
+    private function isReadable(): bool
+    {
         return is_readable($this->path);
     }
 
@@ -145,20 +151,21 @@ private function isReadable(): bool {
      *
      * @return bool
      */
-    private function fileExist() : bool {
+    private function fileExist(): bool
+    {
         return file_exists($this->path);
     }
 
     /**
      * Remove ghost Unicode spaces and other unnecessary stuff (<200b><200c>)
      *
-     * @param $content
+     * @param string|array $content
      *
      * @return array|string
      */
     private static function removeZeroSpace($content)
     {
-        if(is_array($content)) {
+        if (is_array($content)) {
             return array_map([static::class, 'removeZeroSpace'], $content);
         }
 
@@ -177,20 +184,21 @@ private static function removeZeroSpace($content)
      *
      * @return array
      */
-    public function extractRuleBlock(string $marker) : array {
+    public function extractRuleBlock(string $marker): array
+    {
         $result = [];
 
         $found = false;
-        foreach($this->file as $line) {
-            if(strpos($line, $marker . self::SPACE_DELIMITER . self::MARKER_RULE_END) !== false) {
+        foreach ($this->file as $line) {
+            if (strpos($line, $marker . self::SPACE_DELIMITER . self::MARKER_RULE_END) !== false) {
                 $found = false;
             }
 
-            if($found) {
+            if ($found) {
                 $result[] = $line;
             }
 
-            if(strpos($line, $marker . self::SPACE_DELIMITER . self::MARKER_RULE_START) !== false) {
+            if (strpos($line, $marker . self::SPACE_DELIMITER . self::MARKER_RULE_START) !== false) {
                 $found = true;
             }
         }
@@ -205,7 +213,8 @@ public function extractRuleBlock(string $marker) : array {
      *
      * @return bool|int|string
      */
-    private function findInFile(string $needle) {
+    private function findInFile(string $needle)
+    {
         return array_search($needle, $this->file);
     }
 
@@ -214,22 +223,23 @@ private function findInFile(string $needle) {
      *
      * @return array|bool
      */
-    public function extractSecureBlock() {
+    public function extractSecureBlock()
+    {
         $start = $this->findInFile(self::MARKER_GLOBAL_START . self::SPACE_DELIMITER . self::MARKER_WP_CLI_SECURE);
         $end = $this->findInFile(self::MARKER_GLOBAL_END . self::SPACE_DELIMITER . self::MARKER_WP_CLI_SECURE);
 
-        if($start === false || $end === false) {
+        if ($start === false || $end === false) {
             return false;
         }
 
         $result = array_slice($this->file, $start + 1, $end - $start - 1);
 
-        if(!$result) {
+        if (!$result) {
             return false;
         }
 
-        if(count($result) === 1) {
-            return trim($result[0]);
+        if (count($result) === 1) {
+            return [trim($result[0])];
         }
 
         return array_filter($result);
@@ -242,7 +252,8 @@ public function extractSecureBlock() {
      *
      * @return bool
      */
-    public function hasRuleBlock(string $marker) : bool {
+    public function hasRuleBlock(string $marker): bool
+    {
         return count($this->extractRuleBlock($marker)) > 0;
     }
 
@@ -251,7 +262,8 @@ public function hasRuleBlock(string $marker) : bool {
      *
      * @return bool
      */
-    public function hasSecureBlock() : bool {
+    public function hasSecureBlock(): bool
+    {
         return is_array($this->extractSecureBlock()) && count($this->extractSecureBlock()) > 0;
     }
 
@@ -262,15 +274,16 @@ public function hasSecureBlock() : bool {
      *
      * @return bool
      */
-    public function createFile(int $permissions = 0644) : bool {
-        if(!$this->fileExist()) {
+    public function createFile(int $permissions = 0644): bool
+    {
+        if (!$this->fileExist()) {
             $path = explode("/", $this->path);
             $fileName = $path[count($path) - 1];
             $basePath = implode('/', array_slice($path, 0, count($path) - 1));
             $pathInfo = pathinfo($this->path);
 
             //Create a full directory path if it does not exist
-            if(!file_exists($pathInfo['dirname'])) {
+            if (!file_exists($pathInfo['dirname'])) {
                 mkdir($pathInfo['dirname'], 0755, true);
             }
 
@@ -293,11 +306,12 @@ public function createFile(int $permissions = 0644) : bool {
      *
      * @return array
      */
-    public function wrap(array $content, string $with = 'block', string $marker = '') : array {
-        if($with === 'block') {
+    public function wrap(array $content, string $with = 'block', string $marker = ''): array
+    {
+        if ($with === 'block') {
             array_unshift($content, self::MARKER_RULE . self::SPACE_DELIMITER . $marker . self::SPACE_DELIMITER . self::MARKER_RULE_START);
             array_push($content, self::MARKER_RULE . self::SPACE_DELIMITER . $marker . self::SPACE_DELIMITER . self::MARKER_RULE_END);
-        } else if($with === 'global') {
+        } elseif ($with === 'global') {
             array_unshift($content, self::MARKER_GLOBAL_START . self::SPACE_DELIMITER . self::MARKER_WP_CLI_SECURE);
             array_push($content, self::MARKER_GLOBAL_END . self::SPACE_DELIMITER . self::MARKER_WP_CLI_SECURE);
         }
@@ -310,9 +324,9 @@ public function wrap(array $content, string $with = 'block', string $marker = ''
      *
      * @return bool
      */
-    private function backup() : bool
+    private function backup(): bool
     {
-        if(file_exists($this->path . self::BACKUP_EXTENSION)) {
+        if (file_exists($this->path . self::BACKUP_EXTENSION)) {
             unlink($this->path . self::BACKUP_EXTENSION);
         }
 
@@ -327,25 +341,26 @@ private function backup() : bool
      *
      * @return bool
      */
-    public function add(array $content, string $marker = ''): bool {
+    public function add(array $content, string $marker = ''): bool
+    {
         //If the rule block already exist, there is no reason to add it again
-        if($this->hasRuleBlock($marker)) {
+        if ($this->hasRuleBlock($marker)) {
             throw new RuleAlreadyExist();
         }
 
         //Check if file exist?
-        if(!$this->fileExist()) {
+        if (!$this->fileExist()) {
             $this->createFile();
         }
 
-        if(!$this->isWritable()) {
+        if (!$this->isWritable()) {
             throw new FileIsNotWritable();
         }
 
         //Wrap the rule block with markers
         $content = $this->wrap($content, 'block', $marker);
 
-        if(!$this->hasSecureBlock()) {
+        if (!$this->hasSecureBlock()) {
             $content = $this->wrap($content, 'global');
 
             //File does not contain any of our SECURE rules, so we need to prepend our content at the beginning of the file
@@ -365,8 +380,9 @@ public function add(array $content, string $marker = ''): bool {
      *
      * @return bool
      */
-    public function clear() : bool {
-        if(!$this->hasSecureBlock()) {
+    public function clear(): bool
+    {
+        if (!$this->hasSecureBlock()) {
             return true;
         }
 
@@ -385,8 +401,9 @@ public function clear() : bool {
      *
      * @return bool
      */
-    public function remove(string $marker) : bool {
-        if(!$this->hasRuleBlock($marker)) {
+    public function remove(string $marker): bool
+    {
+        if (!$this->hasRuleBlock($marker)) {
             return true;
         }
 
@@ -403,7 +420,8 @@ public function remove(string $marker) : bool {
      *
      * @return bool
      */
-    public function write(): bool {
+    public function write(): bool
+    {
         //Flatten the array (<= PHP 8.0 compatible)
         $this->file = $this->flattenArray($this->file);
 
@@ -419,7 +437,7 @@ public function write(): bool {
         fseek($fp, 0);
         $write = fwrite($fp, $content);
 
-        if($write) {
+        if ($write) {
             ftruncate($fp, ftell($fp));
         }
         fflush($fp);
@@ -438,7 +456,8 @@ public function write(): bool {
      *
      * @return array
      */
-    private function flattenArray(array $array, int $depth = 1) : array {
+    private function flattenArray(array $array, int $depth = 1): array
+    {
         $result = [];
         foreach ($array as $key => $value) {
             if (is_array($value) && $depth) {