firefly-iii / firefly-iii

app/Import/JobConfiguration/FakeJobConfiguration.php

<?php
/**
 * FakeJobConfiguration.php
 * Copyright (c) 2019 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\Import\JobConfiguration;

use FireflyIII\Models\ImportJob;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use Illuminate\Support\MessageBag;

/**
 * Class FakeJobConfiguration
 *
 * @deprecated
 * @codeCoverageIgnore
 */
class FakeJobConfiguration implements JobConfigurationInterface

The interface FireflyIII\Import\JobConfiguration\JobConfigurationInterface has been deprecated.

{
    /** @var ImportJob The import job */
    private $importJob;

    /** @var ImportJobRepositoryInterface Import job repository */
    private $repository;

    /**
     * Returns true when the initial configuration for this job is complete.
     *  configuration array of job must have two values:
     * 'artist' must be 'david bowie', case insensitive
     * 'song' must be 'golden years', case insensitive.
     * if stage is not "new", then album must be 'station to station'
     *
     * @return bool
     *
     */
    public function configurationComplete(): bool
    {
        $config = $this->importJob->configuration;
        if ('new' === $this->importJob->stage) {
            return
                isset($config['artist'], $config['song'], $config['apply-rules'])
                && 'david bowie' === strtolower($config['artist'])
                && 'golden years' === strtolower($config['song']);
        }

        return isset($config['album']) && 'station to station' === strtolower($config['album']);


    }

    /**
     * Store any data from the $data array into the job.
     *
     * @param array $data
     *
     * @return MessageBag
     *
     */
    public function configureJob(array $data): MessageBag
    {
        $artist        = strtolower($data['artist'] ?? '');
        $song          = strtolower($data['song'] ?? '');
        $album         = strtolower($data['album'] ?? '');
        $applyRules    = isset($data['apply_rules']) ? 1 === (int) $data['apply_rules'] : null;
        $configuration = $this->importJob->configuration;
        if ('david bowie' === $artist) {
            // store artist
            $configuration['artist'] = $artist;
        }

        if ('golden years' === $song) {
            // store song
            $configuration['song'] = $song;
        }

        if ('station to station' === $album) {
            // store album
            $configuration['album'] = $album;
        }
        if (null !== $applyRules) {
            $configuration['apply-rules'] = $applyRules;
        }

        $this->repository->setConfiguration($this->importJob, $configuration);
        $messages = new MessageBag();

        if (3 !== count($configuration)) {
            $messages->add('some_key', 'Ignore this error: ' . count($configuration));
        }

        return $messages;
    }

    /**
     * Return the data required for the next step in the job configuration.
     *
     * @codeCoverageIgnore
     * @return array
     */
    public function getNextData(): array
    {
        return [
            'rulesOptions' => [
                1 => (string) trans('firefly.yes'),
                0 => (string) trans('firefly.no'),
            ],
        ];
    }

    /**
     * Returns the view of the next step in the job configuration.
     *
     * @return string
     *
     */
    public function getNextView(): string
    {
        // first configure artist:
        $config     = $this->importJob->configuration;
        $artist     = $config['artist'] ?? '';
        $song       = $config['song'] ?? '';
        $album      = $config['album'] ?? '';
        $applyRules = $config['apply-rules'] ?? null;
        if (null === $applyRules) {
            return 'import.fake.apply-rules';
        }
        if ('david bowie' !== strtolower($artist)) {
            return 'import.fake.enter-artist';
        }
        if ('golden years' !== strtolower($song)) {
            return 'import.fake.enter-song';
        }
        if ('new' !== $this->importJob->stage && 'station to station' !== strtolower($album)) {
            return 'import.fake.enter-album';
        }

        return 'impossible-view'; // @codeCoverageIgnore
    }

    /**
     * Set import job.
     *
     * @param ImportJob $importJob
     */
    public function setImportJob(ImportJob $importJob): void
    {
        $this->importJob  = $importJob;
        $this->repository = app(ImportJobRepositoryInterface::class);
        $this->repository->setUser($importJob->user);
    }
}