Files
deck/lib/Command/BoardImport.php
Vitor Mattos fd92fc3c4d 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>
2021-12-30 11:19:48 +01:00

191 lines
5.1 KiB
PHP

<?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;
use JsonSchema\Constraints\Constraint;
use JsonSchema\Validator;
use OCA\Deck\Command\ImportHelper\AImport;
use OCA\Deck\Command\ImportHelper\TrelloHelper;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ChoiceQuestion;
use Symfony\Component\Console\Question\Question;
class BoardImport extends Command {
/** @var string */
private $system;
private $allowedSystems;
/** @var TrelloHelper */
private $trelloHelper;
public function __construct(
TrelloHelper $trelloHelper
) {
parent::__construct();
$this->trelloHelper = $trelloHelper;
}
/**
* @return void
*/
protected function configure() {
$allowedSystems = glob(__DIR__ . '/ImportHelper/*Helper.php');
$this->allowedSystems = array_map(function ($name) {
preg_match('/\/(?<system>\w+)Helper\.php$/', $name, $matches);
return lcfirst($matches['system']);
}, $allowedSystems);
$this
->setName('deck:import')
->setDescription('Import data')
->addOption(
'system',
null,
InputOption::VALUE_REQUIRED,
'Source system for import. Available options: ' . implode(', ', $this->allowedSystems) . '.',
'trello'
)
->addOption(
'config',
null,
InputOption::VALUE_REQUIRED,
'Configuration json file.',
'config.json'
)
->addOption(
'data',
null,
InputOption::VALUE_REQUIRED,
'Data file to import.',
'data.json'
)
;
}
/**
* @inheritDoc
*
* @return void
*/
protected function interact(InputInterface $input, OutputInterface $output) {
$this->validateSystem($input, $output);
$this->validateConfig($input, $output);
$this->getSystemHelper()
->validate($input, $output);
}
protected function validateConfig(InputInterface $input, OutputInterface $output): void {
$configFile = $input->getOption('config');
if (!is_file($configFile)) {
$helper = $this->getHelper('question');
$question = new Question(
'Please inform a valid config json file: ',
'config.json'
);
$question->setValidator(function ($answer) {
if (!is_file($answer)) {
throw new \RuntimeException(
'config file not found'
);
}
return $answer;
});
$configFile = $helper->ask($input, $output, $question);
$input->setOption('config', $configFile);
}
$config = json_decode(file_get_contents($configFile));
$schemaPath = __DIR__ . '/ImportHelper/fixtures/config-' . $this->getSystem() . '-schema.json';
$validator = new Validator();
$validator->validate(
$config,
(object)['$ref' => 'file://' . realpath($schemaPath)],
Constraint::CHECK_MODE_APPLY_DEFAULTS
);
if (!$validator->isValid()) {
$output->writeln('<error>Invalid config file</error>');
$output->writeln(array_map(function ($v) {
return $v['message'];
}, $validator->getErrors()));
$output->writeln('Valid schema:');
$output->writeln(print_r(file_get_contents($schemaPath), true));
$input->setOption('config', null);
$this->validateConfig($input, $output);
}
$this->getSystemHelper()->setConfigInstance($config);
}
private function setSystem(string $system): void {
$this->system = $system;
}
public function getSystem() {
return $this->system;
}
/**
* @return AImport
*/
private function getSystemHelper() {
$helper = $this->{$this->system . 'Helper'};
$helper->setCommand($this);
return $helper;
}
/**
* @return void
*/
private function validateSystem(InputInterface $input, OutputInterface $output) {
$system = $input->getOption('system');
if (in_array($system, $this->allowedSystems)) {
$this->setSystem($system);
return;
}
$helper = $this->getHelper('question');
$question = new ChoiceQuestion(
'Please inform a source system',
$this->allowedSystems,
0
);
$question->setErrorMessage('System %s is invalid.');
$system = $helper->ask($input, $output, $question);
$input->setOption('system', $system);
$this->setSystem($system);
}
/**
* @param InputInterface $input
* @param OutputInterface $output
*
* @return int
*/
protected function execute(InputInterface $input, OutputInterface $output): int {
$this->getSystemHelper()
->import($input, $output);
$output->writeln('Done!');
return 0;
}
}