Cron::autoBudgetCronJob() - Code Metrics - firefly-iii/firefly-iii - Measure and Improve Code Quality continuously with Scrutinizer

Cron::autoBudgetCronJob() A
last analyzed 2020-04-14 19:36 UTC

↳ Parent: Cron

Complexity

Conditions	4
Paths	8

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	9
dl	0
loc	16
rs	9.9666
c	0
b	0
f	0
cc	4
nc	8
nop	2

<?php

/**
 * Cron.php
 * Copyright (c) 2020 [email protected]
 *
 * 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\Tools;

use Carbon\Carbon;
use Exception;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Support\Cronjobs\AutoBudgetCronjob;
use FireflyIII\Support\Cronjobs\RecurringCronjob;
use FireflyIII\Support\Cronjobs\TelemetryCronjob;
use Illuminate\Console\Command;
use InvalidArgumentException;
use Log;

/**
 * Class Cron
 *
 * @codeCoverageIgnore
 */
class Cron extends Command
{
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Runs all Firefly III cron-job related commands. Configure a cron job according to the official Firefly III documentation.';
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'firefly-iii:cron
        {--F|force : Force the cron job(s) to execute.}
        {--date= : Set the date in YYYY-MM-DD to make Firefly III think that\'s the current date.}
        ';

    /**
     * @return int
     */
    public function handle(): int
    {
        $date = null;

        try {
            $date = new Carbon($this->option('date'));
        } catch (InvalidArgumentException|Exception $e) {
            $this->error(sprintf('"%s" is not a valid date', $this->option('date')));
            $e->getMessage();
        }
        $force = (bool) $this->option('force');

        /*
         * Fire recurring transaction cron job.
         */
        try {
            $this->recurringCronJob($force, $date);
        } catch (FireflyException $e) {
            Log::error($e->getMessage());
            Log::error($e->getTraceAsString());
            $this->error($e->getMessage());
        }

        /*
         * Fire auto-budget cron job:
         */
        try {
            $this->autoBudgetCronJob($force, $date);
        } catch (FireflyException $e) {
            Log::error($e->getMessage());
            Log::error($e->getTraceAsString());
            $this->error($e->getMessage());
        }

        /*
         * Fire telemetry cron job (disabled):
         */
        try {
            //$this->telemetryCronJob($force, $date);
        } catch (FireflyException $e) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
            Log::error($e->getMessage());
            Log::error($e->getTraceAsString());
            $this->error($e->getMessage());
        }

        $this->info('More feedback on the cron jobs can be found in the log files.');

        // app('telemetry')->feature('executed-command', $this->signature);
        return 0;
    }

    /**
     * @param bool        $force
     * @param Carbon|null $date
     *
     * @throws FireflyException
     * @throws Exception
     */
    private function autoBudgetCronJob(bool $force, ?Carbon $date): void
    {
        $autoBudget = new AutoBudgetCronjob;
        $autoBudget->setForce($force);
        // set date in cron job:
        if (null !== $date) {
            $autoBudget->setDate($date);
        }

        $result = $autoBudget->fire();

        if (false === $result) {
            $this->line('The auto budget cron job did not fire.');
        }
        if (true === $result) {
            $this->line('The auto budget cron job fired successfully.');
        }

    }

    /**
     * @param bool        $force
     * @param Carbon|null $date
     *
     * @throws FireflyException
     */
    private function recurringCronJob(bool $force, ?Carbon $date): void
    {
        $recurring = new RecurringCronjob;
        $recurring->setForce($force);

        // set date in cron job:
        if (null !== $date) {
            $recurring->setDate($date);
        }

        $result = $recurring->fire();

        if (false === $result) {
            $this->line('The recurring transaction cron job did not fire.');
        }
        if (true === $result) {
            $this->line('The recurring transaction cron job fired successfully.');
        }
    }

    /**
     * @param bool        $force
     * @param Carbon|null $date
     */
    private function telemetryCronJob(bool $force, ?Carbon $date): void

    {
        if (false === config('firefly.send_telemetry') || false === config('firefly.feature_flags.telemetry')) {
            // if not configured to do anything with telemetry, do nothing.
            return;
        }
        $telemetry = new TelemetryCronJob;
        $telemetry->setForce($force);

        // set date in cron job:
        if (null !== $date) {
            $telemetry->setDate($date);
        }

        $result = $telemetry->fire();

        if (false === $result) {
            $this->line('The telemetry cron job did not fire.');
        }
        if (true === $result) {
            $this->line('The telemetry cron job fired successfully.');
        }

    }

}


1			<?php
2
3			/**
4			* Cron.php
5			* Copyright (c) 2020 [email protected]
6			*
7			* This file is part of Firefly III (https://github.com/firefly-iii).
8			*
9			* This program is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License as
11			* published by the Free Software Foundation, either version 3 of the
12			* License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License
20			* along with this program. If not, see <https://www.gnu.org/licenses/>.
21			*/
22
23			declare(strict_types=1);
24
25			namespace FireflyIII\Console\Commands\Tools;
26
27			use Carbon\Carbon;
28			use Exception;
29			use FireflyIII\Exceptions\FireflyException;
30			use FireflyIII\Support\Cronjobs\AutoBudgetCronjob;
31			use FireflyIII\Support\Cronjobs\RecurringCronjob;
32			use FireflyIII\Support\Cronjobs\TelemetryCronjob;
33			use Illuminate\Console\Command;
34			use InvalidArgumentException;
35			use Log;
36
37			/**
38			* Class Cron
39			*
40			* @codeCoverageIgnore
41			*/
42			class Cron extends Command
43			{
44			/**
45			* The console command description.
46			*
47			* @var string
48			*/
49			protected $description = 'Runs all Firefly III cron-job related commands. Configure a cron job according to the official Firefly III documentation.';
50			/**
51			* The name and signature of the console command.
52			*
53			* @var string
54			*/
55			protected $signature = 'firefly-iii:cron
56			{--F\|force : Force the cron job(s) to execute.}
57			{--date= : Set the date in YYYY-MM-DD to make Firefly III think that\'s the current date.}
58			';
59
60			/**
61			* @return int
62			*/
63			public function handle(): int
64			{
65			$date = null;
			0 ignored issues – show Unused Code introduced 2019-07-02 04:20 UTC by Report Bug Copy Issue Report The assignment to `$date` is dead and can be removed. Loading history...
66			try {
67			$date = new Carbon($this->option('date'));
68			} catch (InvalidArgumentException\|Exception $e) {
69			$this->error(sprintf('"%s" is not a valid date', $this->option('date')));
70			$e->getMessage();
71			}
72			$force = (bool) $this->option('force');
73
74			/*
75			* Fire recurring transaction cron job.
76			*/
77			try {
78			$this->recurringCronJob($force, $date);
79			} catch (FireflyException $e) {
80			Log::error($e->getMessage());
81			Log::error($e->getTraceAsString());
82			$this->error($e->getMessage());
83			}
84
85			/*
86			* Fire auto-budget cron job:
87			*/
88			try {
89			$this->autoBudgetCronJob($force, $date);
90			} catch (FireflyException $e) {
91			Log::error($e->getMessage());
92			Log::error($e->getTraceAsString());
93			$this->error($e->getMessage());
94			}
95
96			/*
97			* Fire telemetry cron job (disabled):
98			*/
99			try {
100			//$this->telemetryCronJob($force, $date);
101			} catch (FireflyException $e) {
			0 ignored issues – show Unused Code introduced 2020-03-21 20:42 UTC by Report Bug Copy Issue Report `catch (\FireflyIII\Exceptions\FireflyException $e)` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
102			Log::error($e->getMessage());
103			Log::error($e->getTraceAsString());
104			$this->error($e->getMessage());
105			}
106
107			$this->info('More feedback on the cron jobs can be found in the log files.');
108
109			// app('telemetry')->feature('executed-command', $this->signature);
110			return 0;
111			}
112
113			/**
114			* @param bool $force
115			* @param Carbon\|null $date
116			*
117			* @throws FireflyException
118			* @throws Exception
119			*/
120			private function autoBudgetCronJob(bool $force, ?Carbon $date): void
121			{
122			$autoBudget = new AutoBudgetCronjob;
123			$autoBudget->setForce($force);
124			// set date in cron job:
125			if (null !== $date) {
126			$autoBudget->setDate($date);
127			}
128
129			$result = $autoBudget->fire();
130
131			if (false === $result) {
132			$this->line('The auto budget cron job did not fire.');
133			}
134			if (true === $result) {
135			$this->line('The auto budget cron job fired successfully.');
136			}
137
138			}
139
140			/**
141			* @param bool $force
142			* @param Carbon\|null $date
143			*
144			* @throws FireflyException
145			*/
146			private function recurringCronJob(bool $force, ?Carbon $date): void
147			{
148			$recurring = new RecurringCronjob;
149			$recurring->setForce($force);
150
151			// set date in cron job:
152			if (null !== $date) {
153			$recurring->setDate($date);
154			}
155
156			$result = $recurring->fire();
157
158			if (false === $result) {
159			$this->line('The recurring transaction cron job did not fire.');
160			}
161			if (true === $result) {
162			$this->line('The recurring transaction cron job fired successfully.');
163			}
164			}
165
166			/**
167			* @param bool $force
168			* @param Carbon\|null $date
169			*/
170			private function telemetryCronJob(bool $force, ?Carbon $date): void
			0 ignored issues – show Unused Code introduced 2020-03-21 20:42 UTC by Report Bug Copy Issue Report The method `telemetryCronJob()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
171			{
172			if (false === config('firefly.send_telemetry') \|\| false === config('firefly.feature_flags.telemetry')) {
173			// if not configured to do anything with telemetry, do nothing.
174			return;
175			}
176			$telemetry = new TelemetryCronJob;
177			$telemetry->setForce($force);
178
179			// set date in cron job:
180			if (null !== $date) {
181			$telemetry->setDate($date);
182			}
183
184			$result = $telemetry->fire();
185
186			if (false === $result) {
187			$this->line('The telemetry cron job did not fire.');
188			}
189			if (true === $result) {
190			$this->line('The telemetry cron job fired successfully.');
191			}
192
193			}
194
195			}
196

firefly-iii / firefly-iii

GitHub Access Token became invalid

Cron::autoBudgetCronJob() A last analyzed 2020-04-14 19:36 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Cron::autoBudgetCronJob() A
last analyzed 2020-04-14 19:36 UTC