Migration from other plugins (fixes #33)

Author: GinoPane

CHANGELOG.md

@@ -16,6 +16,11 @@ Types of changes
 
 ## [Unreleased]
 
+## 1.12.0 - 2019-06-18
+
+### Added
+* Added functionality of migration from other plugins
+
 ## 1.11.1 - 2019-06-12
 
 ### Fixed

Plugin.php

@@ -16,6 +16,7 @@
 use GinoPane\BlogTaxonomy\Components\SeriesPosts;
 use GinoPane\BlogTaxonomy\Components\RelatedPosts;
 use GinoPane\BlogTaxonomy\Components\RelatedSeries;
+use GinoPane\BlogTaxonomy\Console\MigrateFromPlugin;
 use RainLab\Blog\Controllers\Posts as PostsController;
 use GinoPane\BlogTaxonomy\Components\SeriesNavigation;
 use RainLab\Blog\Controllers\Categories as CategoriesController;
@@ -45,7 +46,7 @@ class Plugin extends PluginBase
      *
      * @return  array
      */
-    public function pluginDetails()
+    public function pluginDetails(): array
     {
         return [
             'name'        => self::LOCALIZATION_KEY . 'plugin.name',
@@ -61,7 +62,7 @@ public function pluginDetails()
      *
      * @return  array
      */
-    public function registerComponents()
+    public function registerComponents(): array
     {
         return [
             TagList::class          => TagList::NAME,
@@ -74,6 +75,14 @@ public function registerComponents()
         ];
     }
 
+    /**
+     *
+     */
+    public function register()
+    {
+        $this->registerConsoleCommand(MigrateFromPlugin::NAME, MigrateFromPlugin::class);
+    }
+
     /**
      * Boot method, called right before the request route
      */

README.md

@@ -9,6 +9,7 @@ Taxonomy extension for [RainLab Blog](https://octobercms.com/plugin/rainlab-blog
 ## Table of Contents
 * [Changes to Original Blog Plugin](#changes-to-original-blog-plugin)
 * [Translate Plugin Support](#translate-plugin-support)
+* [Migration from Other Plugins](#migration-from-other-plugins)
 * [Implementing Frontend Pages](#implementing-frontend-pages)
     * [Post Series Navigation](#post-series-navigation)
     * [Posts in the Series](#posts-in-the-series)
@@ -39,6 +40,46 @@ They were also placed in a new tag-like style along with tags and series in thei
 
 Starting from 1.5.0 version Blog Taxonomy supports [RainLab Translate](https://octobercms.com/plugin/rainlab-translate) plugin when it's installed. All tag and series fields could be translated. 
 
+## Migration from Other Plugins
+
+Starting from 1.12.0 version Blog Taxonomy supports migration from other plugins. Currently supported plugins are: [BlogSeries](https://github.com/PascalKleindienst/october-blogseries-extension).
+
+The migration is done via console command:
+
+```php artisan blogtaxonomy:migrate PKleindienst.BlogSeries```
+
+Use `-h` or `--help` to get usage help.
+
+Migration example output:
+
+```bash
+**************************************************
+*     Migration from PKleindienst.BlogSeries     *
+**************************************************
+
+Migrating series
+2 series found
+Series "Series 1" => Blog Taxonomy Series "Series 1" (#3)
+Series "Series 2" => Blog Taxonomy Series "Series 2" (#4)
+All series have been migrated
+
+Migrating related series
+Relation "#4" => "#3" added
+Relation "#3" => "#4" added
+Related series have been migrated
+
+
+ Do you want to assign newly created series to posts (already assigned Blog Taxonomy series will be overwritten) (yes/no) [no]:
+ > yes
+
+Migrating series assigned to posts
+Series "#3" has been assigned to a post
+Series "#4" has been assigned to a post
+Migrated series has been assigned
+
+Migration from PKleindienst.BlogSeries finished
+```
+
 ## Implementing Frontend Pages
 
 The Blog Taxonomy plugin provides several useful components with basic markup for frontend usage. The default markup

classes/migrationcommand/MigrationFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace GinoPane\BlogTaxonomy\Classes\MigrationCommand;
+
+use GinoPane\BlogTaxonomy\Classes\MigrationCommand\Exceptions\NoPluginException;
+use GinoPane\BlogTaxonomy\Classes\MigrationCommand\Migrations\NullMigration;
+use GinoPane\BlogTaxonomy\Classes\MigrationCommand\Migrations\PkleindienstBlogSeriesMigration;
+use Illuminate\Console\Command;
+
+/**
+ * Class MigrationFactory
+ *
+ * @package GinoPane\BlogTaxonomy\Classes\MigrationCommand
+ */
+class MigrationFactory
+{
+    /**
+     * @param string $plugin
+     *
+     * @throws NoPluginException
+     *
+     * @return MigrationInterface
+     */
+    public static function resolve(string $plugin, Command $command): MigrationInterface
+    {
+        $plugin = strtolower($plugin);
+        $migration = new NullMigration($command);
+
+        switch ($plugin) {
+            case strtolower(PkleindienstBlogSeriesMigration::PLUGIN_NAME):
+                $migration = new PkleindienstBlogSeriesMigration($command);
+        }
+
+        return $migration;
+    }
+}

classes/migrationcommand/MigrationInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace GinoPane\BlogTaxonomy\Classes\MigrationCommand;
+
+/**
+ * Class MigrationInterface
+ *
+ * @package GinoPane\BlogTaxonomy\Classes\MigrationCommand
+ */
+interface MigrationInterface
+{
+    /**
+     * @return void
+     */
+    public function migrate();
+}

classes/migrationcommand/exceptions/NoDataException.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace GinoPane\BlogTaxonomy\Classes\MigrationCommand\Exceptions;
+
+use Exception;
+
+/**
+ * Class NoDataException
+ *
+ * @package GinoPane\BlogTaxonomy\Classes\MigrationCommand\Exceptions
+ */
+class NoDataException extends Exception
+{
+
+}

classes/migrationcommand/exceptions/NoPluginException.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace GinoPane\BlogTaxonomy\Classes\MigrationCommand\Exceptions;
+
+use Exception;
+
+/**
+ * Class NoPluginException
+ *
+ * @package GinoPane\BlogTaxonomy\Classes\MigrationCommand\Exceptions
+ */
+class NoPluginException extends Exception
+{
+    public function __construct(string $pluginName)
+    {
+        parent::__construct("$pluginName plugin does not exist in the system. Please check if it is installed and try again.");
+    }
+}

classes/migrationcommand/migrations/AbstractMigration.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace GinoPane\BlogTaxonomy\Classes\MigrationCommand\Migrations;
+
+use Illuminate\Console\Command;
+use System\Classes\PluginManager;
+use GinoPane\BlogTaxonomy\Classes\MigrationCommand\MigrationInterface;
+use GinoPane\BlogTaxonomy\Classes\MigrationCommand\Exceptions\NoPluginException;
+
+/**
+ * Class PkleindienstBlogSeriesMigration
+ *
+ * @package GinoPane\BlogTaxonomy\Classes\MigrationCommand\Migrations
+ */
+abstract class AbstractMigration implements MigrationInterface
+{
+    const PLUGIN_NAME = '';
+
+    /**
+     * @var Command
+     */
+    protected $command;
+
+    /**
+     * AbstractMigration constructor.
+     *
+     * @param Command $command
+     *
+     * @throws NoPluginException
+     */
+    public function __construct(Command $command)
+    {
+        $this->validate();
+
+        $this->command = $command;
+    }
+
+    /**
+     * @return void
+     */
+    public function migrate()
+    {
+        $this->command->alert('Migration from ' . static::PLUGIN_NAME);
+
+        $this->migratePlugin();
+
+        $this->command->info('Migration from ' . static::PLUGIN_NAME . ' finished');
+    }
+
+    abstract protected function migratePlugin();
+
+    /**
+     * @throws NoPluginException
+     */
+    protected function validate()
+    {
+        $pluginManager = PluginManager::instance();
+
+        if (!$pluginManager->hasPlugin(static::PLUGIN_NAME)) {
+            throw new NoPluginException(static::PLUGIN_NAME);
+        }
+    }
+}

classes/migrationcommand/migrations/NullMigration.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace GinoPane\BlogTaxonomy\Classes\MigrationCommand\Migrations;
+
+/**
+ * Class NullMigration
+ *
+ * @package GinoPane\BlogTaxonomy\Classes\MigrationCommand\Migrations
+ */
+class NullMigration extends AbstractMigration
+{
+    /**
+     * @return void
+     */
+    public function migrate()
+    {
+        $this->command->error('Found no suitable plugins for migration. Use help (-h, --help) to see available options.');
+    }
+
+    /**
+     * No validation required for this null implementation
+     */
+    protected function validate()
+    {
+        return null;
+    }
+
+    /**
+     * @return null
+     */
+    protected function migratePlugin()
+    {
+        return null;
+    }
+}