Merge pull request #543 from caesar-team/feature/CAES-1508

[Item] CAES-1508: Impelmented raws field to item.

src/Controller/Api/Item/ItemController.php

@@ -8,6 +8,7 @@
 use App\Entity\Item;
 use App\Factory\Entity\ItemFactory;
 use App\Factory\View\Item\BatchItemViewFactory;
+use App\Factory\View\Item\ItemRawsViewFactory;
 use App\Factory\View\Item\ItemViewFactory;
 use App\Form\Type\Request\Item\CreateBatchItemsRequestType;
 use App\Form\Type\Request\Item\CreateBatchKeypairsRequestType;
@@ -19,6 +20,7 @@
 use App\Model\DTO\GroupedUserItems;
 use App\Model\Query\ItemsAllQuery;
 use App\Model\View\Item\BatchItemsView;
+use App\Model\View\Item\ItemRawsView;
 use App\Model\View\Item\ItemView;
 use App\Repository\ItemRepository;
 use App\Request\Item\CreateBatchItemsRequest;
@@ -85,6 +87,32 @@ public function items(Request $request, ItemRepository $repository, BatchItemVie
         );
     }
 
+    /**
+     * Get single raws item.
+     *
+     * @SWG\Tag(name="Item")
+     * @SWG\Response(
+     *     response=200,
+     *     description="Item data",
+     *     @Model(type=ItemRawsView::class)
+     * )
+     *
+     * @SWG\Response(
+     *     response=404,
+     *     description="No such item"
+     * )
+     *
+     * @Route(
+     *     path="/{id}/raws",
+     *     name="api_show_item_raws",
+     *     methods={"GET"}
+     * )
+     */
+    public function raws(Item $item, ItemRawsViewFactory $factory): ItemRawsView
+    {
+        return $factory->createSingle($item);
+    }
+
     /**
      * Get batch items information.
      *

src/Entity/Item.php

@@ -72,6 +72,13 @@ class Item implements ChildItemAwareInterface
      */
     protected $meta;
 
+    /**
+     * @var string|null
+     *
+     * @ORM\Column(type="text", nullable=true)
+     */
+    protected $raws;
+
     /**
      * @var string
      *
@@ -239,6 +246,16 @@ public function setMeta(ItemMeta $meta): void
         $this->meta = $meta;
     }
 
+    public function setRaws(?string $raws): void
+    {
+        $this->raws = $raws;
+    }
+
+    public function getRaws(): ?string
+    {
+        return $this->raws;
+    }
+
     public function getLastUpdated(): DateTime
     {
         return $this->lastUpdated;

src/Factory/Entity/ItemFactory.php

@@ -53,6 +53,7 @@ public function createFromRequest(CreateItemRequest $request): Item
             $request->getMeta()->getAttachCount() ?: 0,
             $request->getMeta()->getWebSite()
         ));
+        $item->setRaws($request->getRaws());
 
         return $item;
     }

src/Factory/View/Item/ItemRawsViewFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Factory\View\Item;
+
+use App\Entity\Item;
+use App\Model\View\Item\ItemRawsView;
+
+class ItemRawsViewFactory
+{
+    public function createSingle(Item $item): ItemRawsView
+    {
+        $view = new ItemRawsView();
+        $view->setId($item->getId()->toString());
+        $view->setRaws($item->getRaws());
+
+        return $view;
+    }
+}

src/Form/Type/Request/Item/CreateItemRequestType.php

@@ -44,6 +44,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             ])
             ->add('title', TextType::class)
             ->add('secret', TextType::class)
+            ->add('raws', TextType::class)
             ->add('meta', ItemMetaType::class)
             ->add('favorite', CheckboxType::class)
             ->add('tags', CollectionType::class, [

src/Form/Type/Request/Item/EditItemRequestType.php

@@ -26,6 +26,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
             ])
             ->add('title', TextType::class)
             ->add('secret', TextType::class)
+            ->add('raws', TextType::class)
             ->add('meta', ItemMetaType::class)
             ->add('tags', CollectionType::class, [
                 'entry_type' => TextType::class,

src/Migrations/2020/11/Version20201118094040.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20201118094040 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $this->abortIf('postgresql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'postgresql\'.');
+
+        $this->addSql('ALTER TABLE item ADD raws TEXT DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->abortIf('postgresql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'postgresql\'.');
+
+        $this->addSql('ALTER TABLE item DROP raws');
+    }
+}

src/Model/View/Item/ItemRawsView.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Model\View\Item;
+
+use Swagger\Annotations as SWG;
+
+final class ItemRawsView
+{
+    /**
+     * @SWG\Property(type="string", example="4fcc6aef-3fd6-4c16-9e4b-5c37486c7d46")
+     */
+    private string $id;
+
+    /**
+     * @SWG\Property(type="string")
+     */
+    private ?string $raws;
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    public function setId(string $id): void
+    {
+        $this->id = $id;
+    }
+
+    public function getRaws(): ?string
+    {
+        return $this->raws;
+    }
+
+    public function setRaws(?string $raws): void
+    {
+        $this->raws = $raws;
+    }
+}

src/Modifier/ItemModifier.php

@@ -34,6 +34,7 @@ public function modifyByRequest(EditItemRequest $request): Item
             $request->getMeta()->getAttachCount() ?: 0,
             $request->getMeta()->getWebSite()
         ));
+        $item->setRaws($request->getRaws());
         $item->setTitle($request->getTitle());
         $item->setTags(new ArrayCollection($this->transformer->transform($request->getTags())));
         $this->repository->save($item);

src/Request/Item/CreateItemRequest.php

@@ -35,6 +35,8 @@ final class CreateItemRequest
      */
     private ?string $secret;
 
+    private ?string $raws;
+
     private bool $favorite;
 
     private array $tags;
@@ -50,6 +52,7 @@ public function __construct(User $user)
         $this->secret = null;
         $this->favorite = false;
         $this->meta = new ItemMetaRequest();
+        $this->raws = null;
         $this->tags = [];
     }
 
@@ -142,4 +145,14 @@ public function setMeta(ItemMetaRequest $meta): void
     {
         $this->meta = $meta;
     }
+
+    public function getRaws(): ?string
+    {
+        return $this->raws;
+    }
+
+    public function setRaws(?string $raws): void
+    {
+        $this->raws = $raws;
+    }
 }

src/Request/Item/EditItemRequest.php

@@ -27,6 +27,8 @@ final class EditItemRequest
      */
     private ItemMetaRequest $meta;
 
+    private ?string $raws;
+
     private array $tags;
 
     private Item $item;
@@ -41,6 +43,7 @@ public function __construct(Item $item)
         $this->meta = new ItemMetaRequest();
         $this->meta->setAttachCount($item->getMeta()->getAttachCount());
         $this->meta->setWebSite($item->getMeta()->getWebSite());
+        $this->raws = $item->getRaws();
     }
 
     public function getOwner(): ?User
@@ -97,4 +100,14 @@ public function setMeta(ItemMetaRequest $meta): void
     {
         $this->meta = $meta;
     }
+
+    public function getRaws(): ?string
+    {
+        return $this->raws;
+    }
+
+    public function setRaws(?string $raws): void
+    {
+        $this->raws = $raws;
+    }
 }

tests/_support/factories/item.php

@@ -12,6 +12,7 @@
     'parent_list' => 'entity|'.Directory::class,
     'secret' => Faker::word(),
     'title' => Faker::word(),
+    'raws' => Faker::word(),
     'original_item_id' => null,
     'favorite' => false,
     'type' => NodeEnumType::TYPE_CRED,

tests/_support/schemas/item/definitions.json

@@ -137,6 +137,21 @@
         "previousListId"
       ]
     },
+    "item_raw": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "raws": {
+          "type": ["null", "string"]
+        }
+      },
+      "required": [
+        "id",
+        "raws"
+      ]
+    },
     "list": {
       "type": "object",
       "properties": {

tests/_support/schemas/item/item_raw.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$ref": "schemas://item/definitions.json#/definitions/item_raw"
+}

tests/api/Item/ItemTest.php

@@ -35,6 +35,11 @@ public function getItem()
         $I->seeResponseCodeIs(HttpCode::OK);
 
         $I->seeResponseIsValidOnJsonSchemaString($I->getSchema('item/item.json'));
+
+        $I->sendGET(sprintf('/items/%s/raws', $item->getId()->toString()));
+        $I->seeResponseCodeIs(HttpCode::OK);
+
+        $I->seeResponseIsValidOnJsonSchemaString($I->getSchema('item/item_raw.json'));
     }
 
     /** @test */
@@ -210,6 +215,7 @@ public function createCredItem()
             'meta' => [
                 'attachCount' => 2,
             ],
+            'raws' => uniqid(),
             'tags' => ['tag'],
         ]);
         $I->seeResponseCodeIs(HttpCode::OK);
@@ -247,6 +253,7 @@ public function editItem()
                 'attachCount' => 3,
                 'webSite' => 'http://examle.com/login',
             ],
+            'raws' => uniqid(),
         ]);
         $I->seeResponseCodeIs(HttpCode::OK);