#171. Add Documentation abstract class + interface + refactoring

SoliDry · Jun 9, 2019 · 323b625 · 323b625
1 parent ef6ea7b
commit 323b625
Show file tree

Hide file tree

Showing 5 changed files with 114 additions and 28 deletions.
diff --git a/composer.json b/composer.json
@@ -48,11 +48,12 @@
         }
     },
     "require-dev": {
+        "codeception/codeception": "^2.4",
+        "darkaonline/l5-swagger": "5.8.*",
+        "fzaninotto/faker": "^1.7",
         "laravel/framework": ">=5.3",
-        "phpunit/phpunit": ">=6.5",
         "mockery/mockery": "~1.0",
-        "codeception/codeception": "^2.4",
-        "fzaninotto/faker": "^1.7"
+        "phpunit/phpunit": ">=6.5"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

diff --git a/src/Blocks/ContentManager.php b/src/Blocks/ContentManager.php
@@ -4,7 +4,6 @@
 
 use SoliDry\Controllers\BaseCommand;
 use SoliDry\Helpers\Console;
-use SoliDry\Helpers\Json;
 use SoliDry\Helpers\MethodOptions;
 use SoliDry\Types\DefaultInterface;
 use SoliDry\Types\PhpInterface;
@@ -212,6 +211,35 @@ protected function setComment(string $comment, int $tabs = 1): void
             . PhpInterface::SPACE . $comment . PHP_EOL;
     }
 
+    /**
+     * @param int $tabs
+     */
+    protected function openComment(int $tabs = 1): void
+    {
+        $this->sourceCode .= $this->setTabs($tabs) .  PhpInterface::SLASH
+            . PhpInterface::ASTERISK . PhpInterface::ASTERISK . PHP_EOL;
+    }
+
+    /**
+     * @param int $tabs
+     */
+    protected function closeComment(int $tabs = 1): void
+    {
+        $this->sourceCode .= $this->setTabs($tabs) . PhpInterface::ASTERISK
+            .  PhpInterface::SLASH . PHP_EOL;
+    }
+
+    /**
+     * @param string $comment
+     * @param int $tabs
+     * @param int $afterTabs
+     */
+    protected function setStarredComment(string $comment, int $tabs = 1, int $afterTabs = 0): void
+    {
+        $this->sourceCode .= $this->setTabs($tabs) . PhpInterface::ASTERISK
+            . PhpInterface::SPACE . $this->setTabs($afterTabs) . $comment . PHP_EOL;
+    }
+
     /**
      * Sets an amount of tabs to source code
      * @param int $amount
@@ -419,7 +447,7 @@ public function quoteParam(string $param): string
      *
      * @param string $entityFile
      */
-    private function setBeforeProps(string $entityFile): void
+    protected function setBeforeProps(string $entityFile): void
     {
         $this->resourceCode = file_get_contents($entityFile);
         $end = mb_strpos($this->resourceCode, DefaultInterface::PROPS_START, NULL, PhpInterface::ENCODING_UTF8) - 3;
@@ -431,7 +459,7 @@ private function setBeforeProps(string $entityFile): void
      *
      * @param string $till
      */
-    private function setAfterProps($till = NULL): void
+    protected function setAfterProps($till = NULL): void
     {
         $start = $this->setTabs() . mb_strpos($this->resourceCode, DefaultInterface::PROPS_END, NULL,
                 PhpInterface::ENCODING_UTF8) - 3;

diff --git a/src/Blocks/Controllers.php b/src/Blocks/Controllers.php
@@ -5,7 +5,6 @@
 use SoliDry\Extension\BaseController;
 use SoliDry\Helpers\Classes;
 use SoliDry\Helpers\Console;
-use SoliDry\ApiGenerator;
 use SoliDry\Types\ControllersInterface;
 use SoliDry\Types\DefaultInterface;
 use SoliDry\Types\PhpInterface;
@@ -14,26 +13,8 @@
  * Class Controllers
  * @package SoliDry\Blocks
  */
-class Controllers implements ControllersInterface
+class Controllers extends Documentation implements ControllersInterface
 {
-    use ContentManager;
-
-    /** @var ApiGenerator generator */
-    private $generator;
-    private $sourceCode = '';
-    private $className;
-
-    /**
-     * Controllers constructor.
-     *
-     * @param ApiGenerator $generator
-     */
-    public function __construct($generator)
-    {
-        $this->generator = $generator;
-        $this->className = Classes::getClassName($this->generator->objectName);
-    }
-
     /**
      * Creates the DefaultController and outputs path to the console
      */
@@ -45,14 +26,15 @@ public function createDefault(): void
             . $this->generator->defaultController
             . DefaultInterface::CONTROLLER_POSTFIX
             . PhpInterface::PHP_EXT;
+
         $isCreated = FileManager::createFile($fileController, $this->sourceCode);
         if($isCreated)
         {
             Console::out($fileController . PhpInterface::SPACE . Console::CREATED, Console::COLOR_GREEN);
         }
     }
 
-    private function resetContent()
+    protected function resetContent()
     {
         $this->setBeforeProps($this->getEntityFile($this->generator->formatControllersPath(), DefaultInterface::CONTROLLER_POSTFIX));
         $this->setComment(DefaultInterface::PROPS_START, 0);
@@ -62,7 +44,7 @@ private function resetContent()
     /**
      *  Sets *Controller content
      */
-    private function setContent()
+    protected function setContent()
     {
         $this->setTag();
         $this->setNamespace(
@@ -99,6 +81,8 @@ private function setDefaultContent()
         $this->setComment(DefaultInterface::PROPS_START);
         $this->setComment(DefaultInterface::PROPS_END);
 
+        $this->setDefaultDocs();
+
         $this->endClass();
     }
 }
diff --git a/src/Blocks/Documentation.php b/src/Blocks/Documentation.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace SoliDry\Blocks;
+
+use SoliDry\ApiGenerator;
+use SoliDry\Controllers\BaseCommand;
+use SoliDry\Helpers\Classes;
+use SoliDry\Types\DefaultInterface;
+
+/**
+ * Class Documentation
+ *
+ * @package SoliDry\Blocks
+ *
+ * @property BaseCommand generator
+ */
+abstract class Documentation
+{
+    use ContentManager;
+
+    protected $generator;
+    protected $sourceCode = '';
+    protected $className;
+
+    /**
+     * Controllers constructor.
+     *
+     * @param ApiGenerator $generator
+     */
+    public function __construct($generator)
+    {
+        $this->generator = $generator;
+        $this->className = Classes::getClassName($this->generator->objectName);
+    }
+
+    protected function setDefaultDocs()
+    {
+        $this->setComment(DefaultInterface::METHOD_START);
+
+
+
+        $this->setComment(DefaultInterface::METHOD_END);
+    }
+}
diff --git a/src/Types/DocumentationInterface.php b/src/Types/DocumentationInterface.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace SoliDry\Types;
+
+
+interface DocumentationInterface
+{
+
+    public const OA_INFO   = '@OA\Info';
+    public const OA_GET    = '@OA\Get';
+    public const OA_POST   = '@OA\Post';
+    public const OA_PATCH  = '@OA\Patch';
+    public const OA_DELETE = '@OA\Delete';
+
+
+    public const OA_PARAMETER    = '@OA\Parameter';
+    public const OA_SCHEMA       = '@OA\Schema';
+    public const OA_REQUEST_BODY = '@OA\RequestBody';
+    public const OA_RESPONSE     = '@OA\Response';
+
+    public const PATH        = 'path';
+    public const SUMMARY     = 'summary';
+    public const TAGS        = 'tags';
+    public const DESCRIPTION = 'description';
+    public const RESPONSE    = 'response';
+    public const IN          = 'in';
+    public const NAME        = 'name';
+    public const REQUIRED    = 'required';
+}