Refactor and improvements on command
Check available helpers Default permission: view only Moved validate setting from helper to command Turn more easy create a importer Docblock and improvements on interface lcfirst on system property Helper moved to ImporHelper folder Moved fixtures to ImportHelper Rename settings to config Big refactor to move import methods to service Signed-off-by: Vitor Mattos <vitor@php.rio>
This commit is contained in:
Vitor Mattos
committed by
Julius Härtl
Julius Härtl
parent
eb8bf3f22b
commit
fd92fc3c4d
75
lib/Command/ImportHelper/AImport.php
Normal file
75
lib/Command/ImportHelper/AImport.php
Normal file
@@ -0,0 +1,75 @@
|
||||
<?php
|
||||
|
||||
namespace OCA\Deck\Command\ImportHelper;
|
||||
|
||||
use OCA\Deck\Command\BoardImport;
|
||||
use OCA\Deck\Service\AImportService;
|
||||
use OCA\Deck\Service\TrelloImportService;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
abstract class AImport extends AImportService {
|
||||
/** @var TrelloImportService */
|
||||
protected $trelloImportService;
|
||||
/** @var Command */
|
||||
private $command;
|
||||
/**
|
||||
* Data object created from config JSON
|
||||
*
|
||||
* @var \StdClass
|
||||
*/
|
||||
public $config;
|
||||
|
||||
public function __construct(
|
||||
TrelloImportService $trelloImportService
|
||||
) {
|
||||
$this->trelloImportService = $trelloImportService;
|
||||
}
|
||||
|
||||
abstract public function validate(InputInterface $input, OutputInterface $output): void;
|
||||
|
||||
abstract public function import(InputInterface $input, OutputInterface $output): void;
|
||||
|
||||
/**
|
||||
* Define Command instance
|
||||
*
|
||||
* @param Command $command
|
||||
* @return void
|
||||
*/
|
||||
public function setCommand(Command $command): void {
|
||||
$this->command = $command;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return BoardImport
|
||||
*/
|
||||
public function getCommand() {
|
||||
return $this->command;
|
||||
}
|
||||
|
||||
public function setConfigInstance(\stdClass $config) {
|
||||
$this->trelloImportService->setConfigInstance($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* Define a config
|
||||
*
|
||||
* @param string $configName
|
||||
* @param mixed $value
|
||||
* @return void
|
||||
*/
|
||||
public function setConfig(string $configName, $value): void {
|
||||
$this->trelloImportService->setConfig($configName, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a config
|
||||
*
|
||||
* @param string $configName config name
|
||||
* @return mixed
|
||||
*/
|
||||
public function getConfig(string $configName = null) {
|
||||
return $this->trelloImportService->getConfig($configName);
|
||||
}
|
||||
}
|
||||
79
lib/Command/ImportHelper/ImportInterface.php
Normal file
79
lib/Command/ImportHelper/ImportInterface.php
Normal file
@@ -0,0 +1,79 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2021 Vitor Mattos <vitor@php.rio>
|
||||
*
|
||||
* @author Vitor Mattos <vitor@php.rio>
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OCA\Deck\Command\ImportHelper;
|
||||
|
||||
use OCA\Deck\Command\BoardImport;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
interface ImportInterface {
|
||||
/**
|
||||
* Validate data before run execute method
|
||||
*
|
||||
* @param InputInterface $input
|
||||
* @param OutputInterface $output
|
||||
* @return void
|
||||
*/
|
||||
public function validate(InputInterface $input, OutputInterface $output): void;
|
||||
|
||||
/**
|
||||
* Run import
|
||||
*
|
||||
* @param InputInterface $input
|
||||
* @param OutputInterface $output
|
||||
* @return void
|
||||
*/
|
||||
public function import(InputInterface $input, OutputInterface $output): void;
|
||||
|
||||
/**
|
||||
* Define Command instance
|
||||
*
|
||||
* @param Command $command
|
||||
* @return void
|
||||
*/
|
||||
public function setCommand(Command $command): void;
|
||||
|
||||
/**
|
||||
* @return BoardImport
|
||||
*/
|
||||
public function getCommand();
|
||||
|
||||
/**
|
||||
* Define a config
|
||||
*
|
||||
* @param string $configName
|
||||
* @param mixed $value
|
||||
* @return void
|
||||
*/
|
||||
public function setConfig(string $configName, $value): void;
|
||||
|
||||
/**
|
||||
* Get a config
|
||||
*
|
||||
* @param string $configName config name
|
||||
* @return mixed
|
||||
*/
|
||||
public function getConfig($configName);
|
||||
}
|
||||
76
lib/Command/ImportHelper/TrelloHelper.php
Normal file
76
lib/Command/ImportHelper/TrelloHelper.php
Normal file
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2021 Vitor Mattos <vitor@php.rio>
|
||||
*
|
||||
* @author Vitor Mattos <vitor@php.rio>
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OCA\Deck\Command\ImportHelper;
|
||||
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Question\Question;
|
||||
|
||||
class TrelloHelper extends AImport {
|
||||
public function validate(InputInterface $input, OutputInterface $output): void {
|
||||
$this->validateData($input, $output);
|
||||
$this->trelloImportService->validateOwner();
|
||||
$this->trelloImportService->validateUsers();
|
||||
}
|
||||
|
||||
public function import(InputInterface $input, OutputInterface $output): void {
|
||||
$this->trelloImportService->setUserId();
|
||||
$output->writeln('Importing board...');
|
||||
$this->trelloImportService->importBoard();
|
||||
$output->writeln('Assign users to board...');
|
||||
$this->trelloImportService->assignUsersToBoard();
|
||||
$output->writeln('Importing labels...');
|
||||
$this->trelloImportService->importLabels();
|
||||
$output->writeln('Importing stacks...');
|
||||
$this->trelloImportService->importStacks();
|
||||
$output->writeln('Importing cards...');
|
||||
$this->trelloImportService->importCards();
|
||||
}
|
||||
|
||||
private function validateData(InputInterface $input, OutputInterface $output): void {
|
||||
$filename = $input->getOption('data');
|
||||
if (!is_file($filename)) {
|
||||
$helper = $this->getCommand()->getHelper('question');
|
||||
$question = new Question(
|
||||
'Please inform a valid data json file: ',
|
||||
'data.json'
|
||||
);
|
||||
$question->setValidator(function ($answer) {
|
||||
if (!is_file($answer)) {
|
||||
throw new \RuntimeException(
|
||||
'Data file not found'
|
||||
);
|
||||
}
|
||||
return $answer;
|
||||
});
|
||||
$data = $helper->ask($input, $output, $question);
|
||||
$input->setOption('data', $data);
|
||||
}
|
||||
$this->trelloImportService->setData(json_decode(file_get_contents($filename)));
|
||||
if (!$this->trelloImportService->getData()) {
|
||||
$output->writeln('<error>Is not a json file: ' . $filename . '</error>');
|
||||
$this->validateData($input, $output);
|
||||
}
|
||||
}
|
||||
}
|
||||
24
lib/Command/ImportHelper/fixtures/config-trello-schema.json
Normal file
24
lib/Command/ImportHelper/fixtures/config-trello-schema.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"uidRelation": {
|
||||
"type": "object",
|
||||
"comment": "Relationship between Trello and Nextcloud usernames",
|
||||
"example": {
|
||||
"johndoe": "admin"
|
||||
}
|
||||
},
|
||||
"owner": {
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"comment": "Nextcloud owner username"
|
||||
},
|
||||
"color": {
|
||||
"type": "string",
|
||||
"required": true,
|
||||
"pattern": "^[0-9a-fA-F]{6}$",
|
||||
"comment": "Default color for the board. If you don't inform, the default color will be used.",
|
||||
"default": "0800fd"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user