mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-12-28 18:40:29 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3297 from nclsHart/commands-better-rendering

Browse source 
Better rendering for all core commands
This commit is contained in:
Jérémy Benoist 2017-07-30 08:31:04 +02:00 committed by GitHub
commit 882da5c5eb
8 changed files with 78 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/Wallabag/CoreBundle/Command/CleanDuplicatesCommand.php
View file

@ -7,13 +7,14 @@ use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Wallabag\CoreBundle\Entity\Entry;
use Wallabag\UserBundle\Entity\User;
class CleanDuplicatesCommand extends ContainerAwareCommand
{
/** @var OutputInterface */
protected $output;
/** @var SymfonyStyle */
protected $io;
protected $duplicates = 0;
@ -32,7 +33,7 @@ class CleanDuplicatesCommand extends ContainerAwareCommand
protected function execute(InputInterface $input, OutputInterface $output)
{
$this->output = $output;
$this->io = new SymfonyStyle($input, $output);
$username = $input->getArgument('username');
@ -41,20 +42,22 @@ class CleanDuplicatesCommand extends ContainerAwareCommand
$user = $this->getUser($username);
$this->cleanDuplicates($user);
} catch (NoResultException $e) {
$output->writeln(sprintf('<error>User "%s" not found.</error>', $username));
$this->io->error(sprintf('User "%s" not found.', $username));
return 1;
}
$this->io->success('Finished cleaning.');
} else {
$users = $this->getContainer()->get('wallabag_user.user_repository')->findAll();
$output->writeln(sprintf('Cleaning through %d user accounts', count($users)));
$this->io->text(sprintf('Cleaning through <info>%d</info> user accounts', count($users)));
foreach ($users as $user) {
$output->writeln(sprintf('Processing user %s', $user->getUsername()));
$this->io->text(sprintf('Processing user <info>%s</info>', $user->getUsername()));
$this->cleanDuplicates($user);
}
$output->writeln(sprintf('Finished cleaning. %d duplicates found in total', $this->duplicates));
$this->io->success(sprintf('Finished cleaning. %d duplicates found in total', $this->duplicates));
}
return 0;
@ -88,7 +91,7 @@ class CleanDuplicatesCommand extends ContainerAwareCommand
$this->duplicates += $duplicatesCount;
$this->output->writeln(sprintf('Cleaned %d duplicates for user %s', $duplicatesCount, $user->getUserName()));
$this->io->text(sprintf('Cleaned <info>%d</info> duplicates for user <info>%s</info>', $duplicatesCount, $user->getUserName()));
}
private function similarUrl($url)

11
src/Wallabag/CoreBundle/Command/ExportCommand.php
View file

@ -7,6 +7,7 @@ use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
class ExportCommand extends ContainerAwareCommand
{
@ -31,10 +32,12 @@ class ExportCommand extends ContainerAwareCommand
protected function execute(InputInterface $input, OutputInterface $output)
{
$io = new SymfonyStyle($input, $output);
try {
$user = $this->getContainer()->get('wallabag_user.user_repository')->findOneByUserName($input->getArgument('username'));
} catch (NoResultException $e) {
$output->writeln(sprintf('<error>User "%s" not found.</error>', $input->getArgument('username')));
$io->error(sprintf('User "%s" not found.', $input->getArgument('username')));
return 1;
}
@ -44,7 +47,7 @@ class ExportCommand extends ContainerAwareCommand
->getQuery()
->getResult();
$output->write(sprintf('Exporting %d entrie(s) for user « <comment>%s</comment> »... ', count($entries), $user->getUserName()));
$io->text(sprintf('Exporting <info>%d</info> entrie(s) for user <info>%s</info>...', count($entries), $user->getUserName()));
$filePath = $input->getArgument('filepath');
@ -60,12 +63,12 @@ class ExportCommand extends ContainerAwareCommand
->exportJsonData();
file_put_contents($filePath, $data);
} catch (\InvalidArgumentException $e) {
$output->writeln(sprintf('<error>Error: "%s"</error>', $e->getMessage()));
$io->error(sprintf('Error: "%s"', $e->getMessage()));
return 1;
}
$output->writeln('<info>Done.</info>');
$io->success('Done.');
return 0;
}

87
src/Wallabag/CoreBundle/Command/InstallCommand.php
View file

@ -6,14 +6,13 @@ use Craue\ConfigBundle\Entity\Setting;
use FOS\UserBundle\Event\UserEvent;
use FOS\UserBundle\FOSUserEvents;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Console\Style\SymfonyStyle;
class InstallCommand extends ContainerAwareCommand
{
@ -23,9 +22,9 @@ class InstallCommand extends ContainerAwareCommand
protected $defaultInput;
/**
* @var OutputInterface
* @var SymfonyStyle
*/
protected $defaultOutput;
protected $io;
/**
* @var array
@ -52,10 +51,10 @@ class InstallCommand extends ContainerAwareCommand
protected function execute(InputInterface $input, OutputInterface $output)
{
$this->defaultInput = $input;
$this->defaultOutput = $output;
$output->writeln('<info>Installing wallabag...</info>');
$output->writeln('');
$this->io = new SymfonyStyle($input, $output);
$this->io->title('Wallabag installer');
$this
->checkRequirements()
@ -65,13 +64,14 @@ class InstallCommand extends ContainerAwareCommand
->runMigrations()
;
$output->writeln('<info>wallabag has been successfully installed.</info>');
$output->writeln('<comment>Just execute `php bin/console server:run --env=prod` for using wallabag: http://localhost:8000</comment>');
$this->io->success('Wallabag has been successfully installed.');
$this->io->note('Just execute `php bin/console server:run --env=prod` for using wallabag: http://localhost:8000');
}
protected function checkRequirements()
{
$this->defaultOutput->writeln('<info><comment>Step 1 of 5.</comment> Checking system requirements.</info>');
$this->io->section('Step 1 of 5: Checking system requirements.');
$doctrineManager = $this->getContainer()->get('doctrine')->getManager();
$rows = [];
@ -156,30 +156,24 @@ class InstallCommand extends ContainerAwareCommand
$rows[] = [$label, $status, $help];
}
$table = new Table($this->defaultOutput);
$table
->setHeaders(['Checked', 'Status', 'Recommendation'])
->setRows($rows)
->render();
$this->io->table(['Checked', 'Status', 'Recommendation'], $rows);
if (!$fulfilled) {
throw new \RuntimeException('Some system requirements are not fulfilled. Please check output messages and fix them.');
}
$this->defaultOutput->writeln('<info>Success! Your system can run wallabag properly.</info>');
$this->defaultOutput->writeln('');
$this->io->success('Success! Your system can run wallabag properly.');
return $this;
}
protected function setupDatabase()
{
$this->defaultOutput->writeln('<info><comment>Step 2 of 5.</comment> Setting up database.</info>');
$this->io->section('Step 2 of 5: Setting up database.');
// user want to reset everything? Don't care about what is already here
if (true === $this->defaultInput->getOption('reset')) {
$this->defaultOutput->writeln('Dropping database, creating database and schema, clearing the cache');
$this->io->text('Dropping database, creating database and schema, clearing the cache');
$this
->runCommand('doctrine:database:drop', ['--force' => true])
@ -188,13 +182,13 @@ class InstallCommand extends ContainerAwareCommand
->runCommand('cache:clear')
;
$this->defaultOutput->writeln('');
$this->io->newLine();
return $this;
}
if (!$this->isDatabasePresent()) {
$this->defaultOutput->writeln('Creating database and schema, clearing the cache');
$this->io->text('Creating database and schema, clearing the cache');
$this
->runCommand('doctrine:database:create')
@ -202,16 +196,13 @@ class InstallCommand extends ContainerAwareCommand
->runCommand('cache:clear')
;
$this->defaultOutput->writeln('');
$this->io->newLine();
return $this;
}
$questionHelper = $this->getHelper('question');
$question = new ConfirmationQuestion('It appears that your database already exists. Would you like to reset it? (y/N)', false);
if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
$this->defaultOutput->writeln('Dropping database, creating database and schema');
if ($this->io->confirm('It appears that your database already exists. Would you like to reset it?', false)) {
$this->io->text('Dropping database, creating database and schema...');
$this
->runCommand('doctrine:database:drop', ['--force' => true])
@ -219,9 +210,8 @@ class InstallCommand extends ContainerAwareCommand
->runCommand('doctrine:schema:create')
;
} elseif ($this->isSchemaPresent()) {
$question = new ConfirmationQuestion('Seems like your database contains schema. Do you want to reset it? (y/N)', false);
if ($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
$this->defaultOutput->writeln('Dropping schema and creating schema');
if ($this->io->confirm('Seems like your database contains schema. Do you want to reset it?', false)) {
$this->io->text('Dropping schema and creating schema...');
$this
->runCommand('doctrine:schema:drop', ['--force' => true])
@ -229,29 +219,27 @@ class InstallCommand extends ContainerAwareCommand
;
}
} else {
$this->defaultOutput->writeln('Creating schema');
$this->io->text('Creating schema...');
$this
->runCommand('doctrine:schema:create')
;
}
$this->defaultOutput->writeln('Clearing the cache');
$this->io->text('Clearing the cache...');
$this->runCommand('cache:clear');
$this->defaultOutput->writeln('');
$this->io->newLine();
$this->io->text('<info>Database successfully setup.</info>');
return $this;
}
protected function setupAdmin()
{
$this->defaultOutput->writeln('<info><comment>Step 3 of 5.</comment> Administration setup.</info>');
$this->io->section('Step 3 of 5: Administration setup.');
$questionHelper = $this->getHelperSet()->get('question');
$question = new ConfirmationQuestion('Would you like to create a new admin user (recommended) ? (Y/n)', true);
if (!$questionHelper->ask($this->defaultInput, $this->defaultOutput, $question)) {
if (!$this->io->confirm('Would you like to create a new admin user (recommended)?', true)) {
return $this;
}
@ -260,14 +248,13 @@ class InstallCommand extends ContainerAwareCommand
$userManager = $this->getContainer()->get('fos_user.user_manager');
$user = $userManager->createUser();
$question = new Question('Username (default: wallabag) :', 'wallabag');
$user->setUsername($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question));
$user->setUsername($this->io->ask('Username', 'wallabag'));
$question = new Question('Password (default: wallabag) :', 'wallabag');
$user->setPlainPassword($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question));
$question = new Question('Password', 'wallabag');
$question->setHidden(true);
$user->setPlainPassword($this->io->askQuestion($question));
$question = new Question('Email:', '');
$user->setEmail($questionHelper->ask($this->defaultInput, $this->defaultOutput, $question));
$user->setEmail($this->io->ask('Email', ''));
$user->setEnabled(true);
$user->addRole('ROLE_SUPER_ADMIN');
@ -278,14 +265,14 @@ class InstallCommand extends ContainerAwareCommand
$event = new UserEvent($user);
$this->getContainer()->get('event_dispatcher')->dispatch(FOSUserEvents::USER_CREATED, $event);
$this->defaultOutput->writeln('');
$this->io->text('<info>Administration successfully setup.</info>');
return $this;
}
protected function setupConfig()
{
$this->defaultOutput->writeln('<info><comment>Step 4 of 5.</comment> Config setup.</info>');
$this->io->section('Step 4 of 5: Config setup.');
$em = $this->getContainer()->get('doctrine.orm.entity_manager');
// cleanup before insert new stuff
@ -301,18 +288,20 @@ class InstallCommand extends ContainerAwareCommand
$em->flush();
$this->defaultOutput->writeln('');
$this->io->text('<info>Config successfully setup.</info>');
return $this;
}
protected function runMigrations()
{
$this->defaultOutput->writeln('<info><comment>Step 5 of 5.</comment> Run migrations.</info>');
$this->io->section('Step 5 of 5: Run migrations.');
$this
->runCommand('doctrine:migrations:migrate', ['--no-interaction' => true]);
$this->io->text('<info>Migrations successfully executed.</info>');
return $this;
}

10
src/Wallabag/CoreBundle/Command/ShowUserCommand.php
View file

@ -52,11 +52,11 @@ class ShowUserCommand extends ContainerAwareCommand
private function showUser(User $user)
{
$this->io->listing([
sprintf('Username : %s', $user->getUsername()),
sprintf('Email : %s', $user->getEmail()),
sprintf('Display name : %s', $user->getName()),
sprintf('Creation date : %s', $user->getCreatedAt()->format('Y-m-d H:i:s')),
sprintf('Last login : %s', $user->getLastLogin() !== null ? $user->getLastLogin()->format('Y-m-d H:i:s') : 'never'),
sprintf('Username: %s', $user->getUsername()),
sprintf('Email: %s', $user->getEmail()),
sprintf('Display name: %s', $user->getName()),
sprintf('Creation date: %s', $user->getCreatedAt()->format('Y-m-d H:i:s')),
sprintf('Last login: %s', $user->getLastLogin() !== null ? $user->getLastLogin()->format('Y-m-d H:i:s') : 'never'),
sprintf('2FA activated: %s', $user->isTwoFactorAuthentication() ? 'yes' : 'no'),
]);
}

14
src/Wallabag/CoreBundle/Command/TagAllCommand.php
View file

@ -7,6 +7,7 @@ use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
class TagAllCommand extends ContainerAwareCommand
{
@ -25,21 +26,22 @@ class TagAllCommand extends ContainerAwareCommand
protected function execute(InputInterface $input, OutputInterface $output)
{
$io = new SymfonyStyle($input, $output);
try {
$user = $this->getUser($input->getArgument('username'));
} catch (NoResultException $e) {
$output->writeln(sprintf('<error>User "%s" not found.</error>', $input->getArgument('username')));
$io->error(sprintf('User "%s" not found.', $input->getArgument('username')));
return 1;
}
$tagger = $this->getContainer()->get('wallabag_core.rule_based_tagger');
$output->write(sprintf('Tagging entries for user « <comment>%s</comment> »... ', $user->getUserName()));
$io->text(sprintf('Tagging entries for user <info>%s</info>...', $user->getUserName()));
$entries = $tagger->tagAllForUser($user);
$output->writeln('<info>Done.</info>');
$output->write(sprintf('Persist entries ... ', $user->getUserName()));
$io->text('Persist entries... ');
$em = $this->getDoctrine()->getManager();
foreach ($entries as $entry) {
@ -47,7 +49,9 @@ class TagAllCommand extends ContainerAwareCommand
}
$em->flush();
$output->writeln('<info>Done.</info>');
$io->success('Done.');
return 0;
}
/**

3
tests/Wallabag/CoreBundle/Command/ExportCommandTest.php
View file

@ -55,7 +55,8 @@ class ExportCommandTest extends WallabagCoreTestCase
'username' => 'admin',
]);
$this->assertContains('Exporting 5 entrie(s) for user « admin »... Done', $tester->getDisplay());
$this->assertContains('Exporting 5 entrie(s) for user admin...', $tester->getDisplay());
$this->assertContains('Done', $tester->getDisplay());
$this->assertFileExists('admin-export.json');
}

8
tests/Wallabag/CoreBundle/Command/ShowUserCommandTest.php
View file

@ -56,9 +56,9 @@ class ShowUserCommandTest extends WallabagCoreTestCase
'username' => 'admin',
]);
$this->assertContains('Username : admin', $tester->getDisplay());
$this->assertContains('Email : bigboss@wallabag.org', $tester->getDisplay());
$this->assertContains('Display name : Big boss', $tester->getDisplay());
$this->assertContains('Username: admin', $tester->getDisplay());
$this->assertContains('Email: bigboss@wallabag.org', $tester->getDisplay());
$this->assertContains('Display name: Big boss', $tester->getDisplay());
$this->assertContains('2FA activated: no', $tester->getDisplay());
}
@ -88,6 +88,6 @@ class ShowUserCommandTest extends WallabagCoreTestCase
'username' => 'admin',
]);
$this->assertContains('Display name : Bug boss', $tester->getDisplay());
$this->assertContains('Display name: Bug boss', $tester->getDisplay());
}
}

3
tests/Wallabag/CoreBundle/Command/TagAllCommandTest.php
View file

@ -55,6 +55,7 @@ class TagAllCommandTest extends WallabagCoreTestCase
'username' => 'admin',
]);
$this->assertContains('Tagging entries for user « admin »... Done', $tester->getDisplay());
$this->assertContains('Tagging entries for user admin...', $tester->getDisplay());
$this->assertContains('Done', $tester->getDisplay());
}
}