Refactor and renam commands.

app/Console/Commands/Upgrade/UpgradesRecurrenceMetaData.php

@@ -0,0 +1,128 @@
+<?php
+
+/**
+ * MigrateRecurrenceMeta.php
+ * Copyright (c) 2020 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Console\Commands\Upgrade;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Models\RecurrenceMeta;
+use FireflyIII\Models\RecurrenceTransactionMeta;
+use Illuminate\Console\Command;
+
+/**
+ * Class MigrateRecurrenceMeta
+ */
+class UpgradesRecurrenceMetaData extends Command
+{
+    use ShowsFriendlyMessages;
+
+    public const string CONFIG_NAME = '481_migrate_recurrence_meta';
+
+    protected $description          = 'Migrate recurrence meta data';
+
+    protected $signature            = 'upgrade:481-recurrence-meta {--F|force : Force the execution of this command.}';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): int
+    {
+        if ($this->isExecuted() && true !== $this->option('force')) {
+            $this->friendlyInfo('This command has already been executed.');
+
+            return 0;
+        }
+        $count = $this->migrateMetaData();
+
+        if (0 === $count) {
+            $this->friendlyPositive('No recurrence meta data migrated.');
+        }
+        if ($count > 0) {
+            $this->friendlyInfo(sprintf('Migrated %d meta data entries', $count));
+        }
+
+        $this->markAsExecuted();
+
+        return 0;
+    }
+
+    private function isExecuted(): bool
+    {
+        $configVar = app('fireflyconfig')->get(self::CONFIG_NAME, false);
+        if (null !== $configVar) {
+            return (bool) $configVar->data;
+        }
+
+        return false;
+    }
+
+    private function migrateMetaData(): int
+    {
+        $count      = 0;
+        // get all recurrence meta data:
+        $collection = RecurrenceMeta::with('recurrence')->get();
+
+        /** @var RecurrenceMeta $meta */
+        foreach ($collection as $meta) {
+            $count += $this->migrateEntry($meta);
+        }
+
+        return $count;
+    }
+
+    private function migrateEntry(RecurrenceMeta $meta): int
+    {
+        /** @var null|Recurrence $recurrence */
+        $recurrence       = $meta->recurrence;
+        if (null === $recurrence) {
+            return 0;
+        }
+        $firstTransaction = $recurrence->recurrenceTransactions()->first();
+        if (null === $firstTransaction) {
+            return 0;
+        }
+        $value            = $meta->value;
+
+        if ('tags' === $meta->name) {
+            $array = explode(',', $meta->value);
+            $value = json_encode($array, JSON_THROW_ON_ERROR);
+        }
+
+        RecurrenceTransactionMeta::create(
+            [
+                'rt_id' => $firstTransaction->id,
+                'name'  => $meta->name,
+                'value' => $value,
+            ]
+        );
+        $meta->forceDelete();
+
+        return 1;
+    }
+
+    private function markAsExecuted(): void
+    {
+        app('fireflyconfig')->set(self::CONFIG_NAME, true);
+    }
+}