]> git.immae.eu Git - github/wallabag/wallabag.git/commitdiff
Merge pull request #2646 from wallabag/explain-migrations-in-doc
authorNicolas Lœuillet <nicolas@loeuillet.org>
Thu, 26 Jan 2017 12:15:06 +0000 (13:15 +0100)
committerGitHub <noreply@github.com>
Thu, 26 Jan 2017 12:15:06 +0000 (13:15 +0100)
Added explanations about migrations

app/DoctrineMigrations/Version20161214094402.php [new file with mode: 0644]
composer.json
src/Wallabag/CoreBundle/Command/ExportCommand.php [new file with mode: 0644]
src/Wallabag/CoreBundle/Helper/EntriesExport.php
tests/Wallabag/CoreBundle/Command/ExportCommandTest.php [new file with mode: 0644]

diff --git a/app/DoctrineMigrations/Version20161214094402.php b/app/DoctrineMigrations/Version20161214094402.php
new file mode 100644 (file)
index 0000000..db125f7
--- /dev/null
@@ -0,0 +1,75 @@
+<?php
+
+namespace Application\Migrations;
+
+use Doctrine\DBAL\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Renamed uuid to uid in entry table
+ */
+class Version20161214094402 extends AbstractMigration implements ContainerAwareInterface
+{
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(ContainerInterface $container = null)
+    {
+        $this->container = $container;
+    }
+
+    private function getTable($tableName)
+    {
+        return $this->container->getParameter('database_table_prefix').$tableName;
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema)
+    {
+        $entryTable = $schema->getTable($this->getTable('entry'));
+
+        $this->skipIf($entryTable->hasColumn('uid'), 'It seems that you already played this migration.');
+
+        switch ($this->connection->getDatabasePlatform()->getName()) {
+            case 'sqlite':
+                $this->addSql('CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM '.$this->getTable('entry'));
+                $this->addSql('DROP TABLE '.$this->getTable('entry'));
+                $this->addSql('CREATE TABLE '.$this->getTable('entry').' (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT "0", PRIMARY KEY(id));');
+                $this->addSql('INSERT INTO '.$this->getTable('entry').' (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry;');
+                $this->addSql('DROP TABLE __temp__wallabag_entry');
+                break;
+            case 'mysql':
+                $this->addSql('ALTER TABLE '.$this->getTable('entry').' CHANGE uuid uid VARCHAR(23)');
+                break;
+            case 'postgresql':
+                $this->addSql('ALTER TABLE '.$this->getTable('entry').' RENAME uuid TO uid');
+        }
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema)
+    {
+        $entryTable = $schema->getTable($this->getTable('entry'));
+
+        $this->skipIf($entryTable->hasColumn('uuid'), 'It seems that you already played this migration.');
+
+        switch ($this->connection->getDatabasePlatform()->getName()) {
+            case 'sqlite':
+                throw new SkipMigrationException('Too complex ...');
+                break;
+            case 'mysql':
+                $this->addSql('ALTER TABLE '.$this->getTable('entry').' CHANGE uid uuid VARCHAR(23)');
+                break;
+            case 'postgresql':
+                $this->addSql('ALTER TABLE '.$this->getTable('entry').' RENAME uid TO uuid');
+        }
+    }
+}
index b21c95388188984ebd06c72b5c00c47ab44b5f1d..767d9c82681a82e883a7a313e99796e75d486e38 100644 (file)
@@ -72,6 +72,7 @@
         "grandt/phpepub": "~4.0",
         "wallabag/php-mobi": "~1.0.0",
         "kphoen/rulerz-bundle": "~0.10",
+        "kphoen/rulerz": "0.19.1",
         "guzzlehttp/guzzle": "^5.3.1",
         "doctrine/doctrine-migrations-bundle": "^1.0",
         "paragonie/random_compat": "~1.0",
diff --git a/src/Wallabag/CoreBundle/Command/ExportCommand.php b/src/Wallabag/CoreBundle/Command/ExportCommand.php
new file mode 100644 (file)
index 0000000..e3d3b39
--- /dev/null
@@ -0,0 +1,77 @@
+<?php
+
+namespace Wallabag\CoreBundle\Command;
+
+use Doctrine\ORM\NoResultException;
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ExportCommand extends ContainerAwareCommand
+{
+    protected function configure()
+    {
+        $this
+            ->setName('wallabag:export')
+            ->setDescription('Export all entries for an user')
+            ->setHelp('This command helps you to export all entries for an user')
+            ->addArgument(
+                'username',
+                InputArgument::REQUIRED,
+                'User from which to export entries'
+            )
+            ->addArgument(
+                'filepath',
+                InputArgument::OPTIONAL,
+                'Path of the exported file'
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        try {
+            $user = $this->getDoctrine()->getRepository('WallabagUserBundle:User')->findOneByUserName($input->getArgument('username'));
+        } catch (NoResultException $e) {
+            $output->writeln(sprintf('<error>User "%s" not found.</error>', $input->getArgument('username')));
+
+            return 1;
+        }
+
+        $entries = $this->getDoctrine()
+            ->getRepository('WallabagCoreBundle:Entry')
+            ->getBuilderForAllByUser($user->getId())
+            ->getQuery()
+            ->getResult();
+
+        $output->write(sprintf('Exporting %d entrie(s) for user « <comment>%s</comment> »... ', count($entries), $user->getUserName()));
+
+        $filePath = $input->getArgument('filepath');
+
+        if (!$filePath) {
+            $filePath = $this->getContainer()->getParameter('kernel.root_dir').'/../'.sprintf('%s-export.json', $user->getUsername());
+        }
+
+        try {
+            $data = $this->getContainer()->get('wallabag_core.helper.entries_export')
+                ->setEntries($entries)
+                ->updateTitle('All')
+                ->exportJsonData();
+            file_put_contents($filePath, $data);
+        } catch (\InvalidArgumentException $e) {
+            $output->writeln(sprintf('<error>Error: "%s"</error>', $e->getMessage()));
+
+            return 1;
+        }
+
+        $output->writeln('<info>Done.</info>');
+
+        return 0;
+    }
+
+    private function getDoctrine()
+    {
+        return $this->getContainer()->get('doctrine');
+    }
+}
index 4bf292a4f815c0a32b4f26be31ea9cd76d9ce135..93c01fcb4a634127f1bb198c7db67bbf9d13ff6a 100644 (file)
@@ -89,6 +89,11 @@ class EntriesExport
         throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format));
     }
 
+    public function exportJsonData()
+    {
+        return $this->prepareSerializingContent('json');
+    }
+
     /**
      * Use PHPePub to dump a .epub file.
      *
diff --git a/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php
new file mode 100644 (file)
index 0000000..6798c5d
--- /dev/null
@@ -0,0 +1,78 @@
+<?php
+
+namespace Tests\Wallabag\CoreBundle\Command;
+
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Tester\CommandTester;
+use Wallabag\CoreBundle\Command\ExportCommand;
+use Tests\Wallabag\CoreBundle\WallabagCoreTestCase;
+
+class ExportCommandTest extends WallabagCoreTestCase
+{
+    /**
+     * @expectedException Symfony\Component\Console\Exception\RuntimeException
+     * @expectedExceptionMessage Not enough arguments (missing: "username")
+     */
+    public function testExportCommandWithoutUsername()
+    {
+        $application = new Application($this->getClient()->getKernel());
+        $application->add(new ExportCommand());
+
+        $command = $application->find('wallabag:export');
+
+        $tester = new CommandTester($command);
+        $tester->execute([
+            'command' => $command->getName(),
+        ]);
+    }
+
+    public function testExportCommandWithBadUsername()
+    {
+        $application = new Application($this->getClient()->getKernel());
+        $application->add(new ExportCommand());
+
+        $command = $application->find('wallabag:export');
+
+        $tester = new CommandTester($command);
+        $tester->execute([
+            'command' => $command->getName(),
+            'username' => 'unknown',
+        ]);
+
+        $this->assertContains('User "unknown" not found', $tester->getDisplay());
+    }
+
+    public function testExportCommand()
+    {
+        $application = new Application($this->getClient()->getKernel());
+        $application->add(new ExportCommand());
+
+        $command = $application->find('wallabag:export');
+
+        $tester = new CommandTester($command);
+        $tester->execute([
+            'command' => $command->getName(),
+            'username' => 'admin',
+        ]);
+
+        $this->assertContains('Exporting 6 entrie(s) for user « admin »... Done', $tester->getDisplay());
+        $this->assertFileExists('admin-export.json');
+    }
+
+    public function testExportCommandWithSpecialPath()
+    {
+        $application = new Application($this->getClient()->getKernel());
+        $application->add(new ExportCommand());
+
+        $command = $application->find('wallabag:export');
+
+        $tester = new CommandTester($command);
+        $tester->execute([
+            'command' => $command->getName(),
+            'username' => 'admin',
+            'filepath' => 'specialexport.json'
+        ]);
+
+        $this->assertFileExists('specialexport.json');
+    }
+}