Sandbox task loading

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 
 - [#244] Fix AppVeyor CI
+- [#243] Sandbox task loading
 
 ## [v1.12.1] - 2019-05-01
 
@@ -184,8 +185,8 @@ In `v2` this will result in exception.
 
 - [#77] Fix high cpu usage
 
-
 [#244]: https://github.com/lavary/crunz/pull/244
+[#243]: https://github.com/lavary/crunz/pull/243
 [#229]: https://github.com/lavary/crunz/pull/229
 [#217]: https://github.com/lavary/crunz/pull/217
 [#210]: https://github.com/lavary/crunz/pull/210

config/services.php

@@ -28,6 +28,8 @@
 use Crunz\Output\OutputFactory;
 use Crunz\Schedule\ScheduleFactory;
 use Crunz\Task\Collection;
+use Crunz\Task\Loader;
+use Crunz\Task\LoaderInterface;
 use Crunz\Task\Timezone;
 use Crunz\Timezone\Provider;
 use Crunz\Timezone\ProviderInterface;
@@ -53,6 +55,7 @@
     CurlHttpClient::class,
     FilesystemInterface::class => CrunzFilesystem::class,
     FinderInterface::class => Finder::class,
+    LoaderInterface::class => Loader::class,
 ];
 
 $container
@@ -65,6 +68,7 @@
             new Reference(EventRunner::class),
             new Reference(Timezone::class),
             new Reference(ScheduleFactory::class),
+            new Reference(LoaderInterface::class),
         ]
     )
 ;
@@ -90,6 +94,7 @@
         [
             new Reference(Configuration::class),
             new Reference(Collection::class),
+            new Reference(LoaderInterface::class),
         ]
     )
 ;

src/Console/Command/ScheduleListCommand.php

@@ -3,8 +3,8 @@
 namespace Crunz\Console\Command;
 
 use Crunz\Configuration\Configuration;
-use Crunz\Schedule;
 use Crunz\Task\Collection;
+use Crunz\Task\LoaderInterface;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -16,11 +16,17 @@ class ScheduleListCommand extends Command
     private $configuration;
     /** @var Collection */
     private $taskCollection;
-
-    public function __construct(Configuration $configuration, Collection $taskCollection)
-    {
+    /** @var LoaderInterface */
+    private $taskLoader;
+
+    public function __construct(
+        Configuration $configuration,
+        Collection $taskCollection,
+        LoaderInterface $taskLoader
+    ) {
         $this->configuration = $configuration;
         $this->taskCollection = $taskCollection;
+        $this->taskLoader = $taskLoader;
 
         parent::__construct();
     }
@@ -73,18 +79,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
         );
         $row = 0;
 
-        foreach ($tasks as $taskFile) {
-            $schedule = require $taskFile->getRealPath();
-            if (!$schedule instanceof Schedule) {
-                // @TODO throw exception in v2
-                @\trigger_error(
-                    "File '{$taskFile->getRealPath()}' didn't return '\Crunz\Schedule' instance, this behavior is deprecated since v1.12 and will result in exception in v2.0+",
-                    E_USER_DEPRECATED
-                );
-
-                continue;
-            }
+        $schedules = $this->taskLoader
+            ->load(...\array_values($tasks))
+        ;
 
+        foreach ($schedules as $schedule) {
             $events = $schedule->events();
             foreach ($events as $event) {
                 $table->addRow(

src/Console/Command/ScheduleRunCommand.php

@@ -6,6 +6,7 @@
 use Crunz\EventRunner;
 use Crunz\Schedule;
 use Crunz\Task\Collection;
+use Crunz\Task\LoaderInterface;
 use Crunz\Task\TaskNumber;
 use Crunz\Task\Timezone;
 use Symfony\Component\Console\Input\InputArgument;
@@ -15,12 +16,6 @@
 
 class ScheduleRunCommand extends Command
 {
-    /**
-     * Running tasks.
-     *
-     * @var array
-     */
-    protected $runningEvents = [];
     /** @var Collection */
     private $taskCollection;
     /** @var Configuration */
@@ -31,19 +26,23 @@ class ScheduleRunCommand extends Command
     private $taskTimezone;
     /** @var Schedule\ScheduleFactory */
     private $scheduleFactory;
+    /** @var LoaderInterface */
+    private $taskLoader;
 
     public function __construct(
         Collection $taskCollection,
         Configuration $configuration,
         EventRunner $eventRunner,
         Timezone $taskTimezone,
-        Schedule\ScheduleFactory $scheduleFactory
+        Schedule\ScheduleFactory $scheduleFactory,
+        LoaderInterface $taskLoader
     ) {
         $this->taskCollection = $taskCollection;
         $this->configuration = $configuration;
         $this->eventRunner = $eventRunner;
         $this->taskTimezone = $taskTimezone;
         $this->scheduleFactory = $scheduleFactory;
+        $this->taskLoader = $taskLoader;
 
         parent::__construct();
     }
@@ -102,28 +101,13 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
 
         // List of schedules
-        $schedules = [];
+        $schedules = $this->taskLoader
+            ->load(...\array_values($files))
+        ;
         $tasksTimezone = $this->taskTimezone
             ->timezoneForComparisons()
         ;
 
-        foreach ($files as $file) {
-            $schedule = require $file->getRealPath();
-            if (!$schedule instanceof Schedule) {
-                // @TODO throw exception in v2
-                @\trigger_error(
-                    "File '{$file->getRealPath()}' didn't return '\Crunz\Schedule' instance, this behavior is deprecated since v1.12 and will result in exception in v2.0+",
-                    E_USER_DEPRECATED
-                );
-
-                continue;
-            }
-
-            if (\count($schedule->events())) {
-                $schedules[] = $schedule;
-            }
-        }
-
         // Is specified task should be invoked?
         if (\is_string($task)) {
             $schedules = $this->scheduleFactory

src/Task/Loader.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Crunz\Task;
+
+use Crunz\Schedule;
+
+final class Loader implements LoaderInterface
+{
+    /** @return Schedule[] */
+    public function load(\SplFileInfo ...$files)
+    {
+        $schedules = [];
+        foreach ($files as $file) {
+            /**
+             * Actual "require" is in separated method to make sure
+             * local variables are not overwritten by required file
+             * See: https://github.com/lavary/crunz/issues/242 for more information.
+             */
+            $schedule = $this->loadSchedule($file);
+            if (!$schedule instanceof Schedule) {
+                // @TODO throw exception in v2
+                @\trigger_error(
+                    "File '{$file->getRealPath()}' didn't return '\Crunz\Schedule' instance, this behavior is deprecated since v1.12 and will result in exception in v2.0+",
+                    E_USER_DEPRECATED
+                );
+
+                continue;
+            }
+
+            $schedules[] = $schedule;
+        }
+
+        return $schedules;
+    }
+
+    /** @return Schedule */
+    private function loadSchedule(\SplFileInfo $file)
+    {
+        return require $file->getRealPath();
+    }
+}

src/Task/LoaderInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Crunz\Task;
+
+use Crunz\Schedule;
+
+interface LoaderInterface
+{
+    /** @return Schedule[] */
+    public function load(\SplFileInfo ...$files);
+}

tests/Unit/Console/Command/ScheduleRunCommandTest.php

@@ -8,6 +8,7 @@
 use Crunz\EventRunner;
 use Crunz\Schedule;
 use Crunz\Task\Collection;
+use Crunz\Task\Loader;
 use Crunz\Task\Timezone;
 use Crunz\Tests\TestCase\TemporaryFile;
 use PHPUnit\Framework\TestCase;
@@ -33,7 +34,8 @@ public function forceRunAllTasks()
             $this->createMock(Configuration::class),
             $mockEventRunner,
             $this->createMock(Timezone::class),
-            $this->createMock(Schedule\ScheduleFactory::class)
+            $this->createMock(Schedule\ScheduleFactory::class),
+            $this->createTaskLoader()
         );
 
         $command->run(
@@ -60,7 +62,8 @@ public function runSpecificTask()
             $this->createMock(Configuration::class),
             $mockEventRunner,
             $this->mockTimezoneProvider(),
-            $this->mockScheduleFactory()
+            $this->mockScheduleFactory(),
+            $this->createTaskLoader()
         );
 
         $command->run(
@@ -199,4 +202,9 @@ private function phpVersionTaskContent()
 return $schedule;
 PHP;
     }
+
+    private function createTaskLoader()
+    {
+        return new Loader();
+    }
 }