Skip to content

Commit 56c3527

Browse files
AydinHassanAydinHassan
committed
Allow runners to configure command definitions
1 parent 44afc35 commit 56c3527

File tree

11 files changed

+350
-90
lines changed

11 files changed

+350
-90
lines changed

‎app/config.php‎

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@
1919
use PhpSchool\PhpWorkshop\CodePatcher;
2020
use PhpSchool\PhpWorkshop\Event\EventDispatcher;
2121
use PhpSchool\PhpWorkshop\ExerciseDispatcher;
22+
use PhpSchool\PhpWorkshop\ExerciseRunner\Factory\CgiRunnerFactory;
23+
use PhpSchool\PhpWorkshop\ExerciseRunner\Factory\CliRunnerFactory;
24+
use PhpSchool\PhpWorkshop\ExerciseRunner\RunnerManager;
2225
use PhpSchool\PhpWorkshop\Factory\EventDispatcherFactory;
2326
use PhpSchool\PhpWorkshop\Factory\MenuFactory;
2427
use PhpSchool\PhpWorkshop\Factory\ResultRendererFactory;
25-
use PhpSchool\PhpWorkshop\Factory\RunnerFactory;
2628
use PhpSchool\PhpWorkshop\Listener\CheckExerciseAssignedListener;
2729
use PhpSchool\PhpWorkshop\Listener\CodePatchListener;
30+
use PhpSchool\PhpWorkshop\Listener\ConfigureCommandListener;
2831
use PhpSchool\PhpWorkshop\Listener\PrepareSolutionListener;
2932
use PhpSchool\PhpWorkshop\Listener\SelfCheckListener;
3033
use PhpSchool\PhpWorkshop\MenuItem\ResetProgress;
@@ -62,7 +65,7 @@
6265
WorkshopType::class => WorkshopType::STANDARD(),
6366
ExerciseDispatcher::class => function (ContainerInterface $c) {
6467
return new ExerciseDispatcher(
65-
$c->get(RunnerFactory::class),
68+
$c->get(RunnerManager::class),
6669
$c->get(ResultAggregator::class),
6770
$c->get(EventDispatcher::class),
6871
$c->get(CheckRepository::class)
@@ -85,8 +88,8 @@
8588
new CommandDefinition('menu', [], MenuCommand::class),
8689
new CommandDefinition('help', [], HelpCommand::class),
8790
new CommandDefinition('print', [], PrintCommand::class),
88-
new CommandDefinition('verify', ['program'], VerifyCommand::class),
89-
new CommandDefinition('run', ['program'], RunCommand::class),
91+
new CommandDefinition('verify', [], VerifyCommand::class),
92+
new CommandDefinition('run', [], RunCommand::class),
9093
new CommandDefinition('credits', [], CreditsCommand::class)
9194
],
9295
'menu',
@@ -116,7 +119,12 @@
116119
EventDispatcherFactory::class => object(),
117120

118121
//Exercise Runners
119-
RunnerFactory::class => object(),
122+
RunnerManager::class => function (ContainerInterface $c) {
123+
$manager = new RunnerManager;
124+
$manager->addFactory(new CliRunnerFactory($c->get(EventDispatcher::class)));
125+
$manager->addFactory(new CgiRunnerFactory($c->get(EventDispatcher::class)));
126+
return $manager;
127+
},
120128

121129
//commands
122130
MenuCommand::class => function (ContainerInterface $c) {
@@ -171,16 +179,23 @@
171179
},
172180

173181
//Listeners
174-
PrepareSolutionListener::class => object(),
175-
CodePatchListener::class => function (ContainerInterface $c) {
182+
PrepareSolutionListener::class => object(),
183+
CodePatchListener::class => function (ContainerInterface $c) {
176184
return new CodePatchListener($c->get(CodePatcher::class));
177185
},
178-
SelfCheckListener::class => function (ContainerInterface $c) {
186+
SelfCheckListener::class => function (ContainerInterface $c) {
179187
return new SelfCheckListener($c->get(ResultAggregator::class));
180188
},
181189
CheckExerciseAssignedListener::class => function (ContainerInterface $c) {
182190
return new CheckExerciseAssignedListener($c->get(UserState::class));
183191
},
192+
ConfigureCommandListener::class => function (ContainerInterface $c) {
193+
return new ConfigureCommandListener(
194+
$c->get(UserState::class),
195+
$c->get(ExerciseRepository::class),
196+
$c->get(RunnerManager::class)
197+
);
198+
},
184199

185200
//checks
186201
FileExistsCheck::class => object(),
@@ -266,7 +281,8 @@
266281
'appContributors' => [],
267282
'eventListeners' => [
268283
'route.pre.resolve.args' => [
269-
CheckExerciseAssignedListener::class
284+
CheckExerciseAssignedListener::class,
285+
ConfigureCommandListener::class,
270286
],
271287
]
272288
];

‎src/ExerciseDispatcher.php‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
use PhpSchool\PhpWorkshop\Exception\ExerciseNotConfiguredException;
1313
use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
1414
use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
15-
use PhpSchool\PhpWorkshop\Factory\RunnerFactory;
15+
use PhpSchool\PhpWorkshop\ExerciseRunner\RunnerManager;
1616
use PhpSchool\PhpWorkshop\Input\Input;
1717
use PhpSchool\PhpWorkshop\Output\OutputInterface;
1818

@@ -36,7 +36,7 @@ class ExerciseDispatcher
3636
private $checksToRunAfter = [];
3737

3838
/**
39-
* @var RunnerFactory
39+
* @var RunnerManager
4040
*/
4141
private $runnerFactory;
4242

@@ -56,18 +56,18 @@ class ExerciseDispatcher
5656
private $checkRepository;
5757

5858
/**
59-
* @param RunnerFactory $runnerFactory Factory capable of building an exercise runner based on the exercise type.
59+
* @param RunnerManager $runnerManager Factory capable of building an exercise runner based on the exercise type.
6060
* @param ResultAggregator $resultAggregator
6161
* @param EventDispatcher $eventDispatcher
6262
* @param CheckRepository $checkRepository
6363
*/
6464
public function __construct(
65-
RunnerFactory $runnerFactory,
65+
RunnerManager $runnerManager,
6666
ResultAggregator $resultAggregator,
6767
EventDispatcher $eventDispatcher,
6868
CheckRepository $checkRepository
6969
) {
70-
$this->runnerFactory = $runnerFactory;
70+
$this->runnerManager = $runnerManager;
7171
$this->results = $resultAggregator;
7272
$this->eventDispatcher = $eventDispatcher;
7373
$this->checkRepository = $checkRepository;
@@ -130,7 +130,12 @@ public function verify(ExerciseInterface $exercise, Input $input)
130130
{
131131
$exercise->configure($this);
132132

133-
$runner = $this->runnerFactory->create($exercise, $this->eventDispatcher, $this);
133+
$runner = $this->runnerManager->getRunner($exercise);
134+
135+
foreach ($runner->getRequiredChecks() as $requiredCheck) {
136+
$this->requireCheck($requiredCheck);
137+
}
138+
134139
$this->eventDispatcher->dispatch(new Event('verify.start', compact('exercise', 'input')));
135140

136141
$this->validateChecks($this->checksToRunBefore, $exercise);
@@ -179,8 +184,8 @@ public function run(ExerciseInterface $exercise, Input $input, OutputInterface $
179184
$this->eventDispatcher->dispatch(new Event('run.start', compact('exercise', 'input')));
180185

181186
try {
182-
$exitStatus = $this->runnerFactory
183-
->create($exercise, $this->eventDispatcher, $this)
187+
$exitStatus = $this->runnerManager
188+
->getRunner($exercise)
184189
->run($input, $output);
185190
} finally {
186191
$this->eventDispatcher->dispatch(new Event('run.finish', compact('exercise', 'input')));

‎src/ExerciseRunner/CgiRunner.php‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -91,19 +91,17 @@ public function getName()
9191
}
9292

9393
/**
94-
* Configure the exercise dispatcher. For example set the required checks
95-
* for this exercise type.
94+
* Get an array of the class names of the required checks this runner needs.
9695
*
97-
* @param ExerciseDispatcher $exerciseDispatcher
98-
* @return self
96+
* @return array
9997
*/
100-
public function configure(ExerciseDispatcher $exerciseDispatcher)
98+
public function getRequiredChecks()
10199
{
102-
$exerciseDispatcher->requireCheck(FileExistsCheck::class);
103-
$exerciseDispatcher->requireCheck(PhpLintCheck::class);
104-
$exerciseDispatcher->requireCheck(CodeParseCheck::class);
105-
106-
return $this;
100+
return [
101+
FileExistsCheck::class,
102+
PhpLintCheck::class,
103+
CodeParseCheck::class,
104+
];
107105
}
108106

109107
/**

‎src/ExerciseRunner/CliRunner.php‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,17 @@ public function getName()
6464
}
6565

6666
/**
67-
* Configure the exercise dispatcher. For example set the required checks
68-
* for this exercise type.
67+
* Get an array of the class names of the required checks this runner needs.
6968
*
70-
* @param ExerciseDispatcher $exerciseDispatcher
71-
* @return self
69+
* @return array
7270
*/
73-
public function configure(ExerciseDispatcher $exerciseDispatcher)
71+
public function getRequiredChecks()
7472
{
75-
$exerciseDispatcher->requireCheck(FileExistsCheck::class);
76-
$exerciseDispatcher->requireCheck(PhpLintCheck::class);
77-
$exerciseDispatcher->requireCheck(CodeParseCheck::class);
78-
79-
return $this;
73+
return [
74+
FileExistsCheck::class,
75+
PhpLintCheck::class,
76+
CodeParseCheck::class,
77+
];
8078
}
8179

8280
/**

‎src/ExerciseRunner/ExerciseRunnerInterface.php‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,11 @@ interface ExerciseRunnerInterface
2525
public function getName();
2626

2727
/**
28-
* Configure the exercise dispatcher. For example set the required checks
29-
* for this exercise type.
28+
* Get an array of the class names of the required checks this runner needs.
3029
*
31-
* @param ExerciseDispatcher $exerciseDispatcher
32-
* @return self
30+
* @return array
3331
*/
34-
public function configure(ExerciseDispatcher $exerciseDispatcher);
32+
public function getRequiredChecks();
3533

3634
/**
3735
* Verify a solution to an exercise. Verification involves executing the reference solution

‎src/ExerciseRunner/Factory/CgiRunnerFactory.php‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<?php
2+
3+
namespace PhpSchool\PhpWorkshop\ExerciseRunner\Factory;
4+
5+
use PhpSchool\PhpWorkshop\CommandArgument;
6+
use PhpSchool\PhpWorkshop\CommandDefinition;
7+
use PhpSchool\PhpWorkshop\Event\EventDispatcher;
8+
use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
9+
use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
10+
use PhpSchool\PhpWorkshop\ExerciseRunner\CgiRunner;
11+
use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
12+
13+
/**
14+
* @author Aydin Hassan <aydin@hotmail.co.uk>
15+
*/
16+
class CgiRunnerFactory implements ExerciseRunnerFactoryInterface
17+
{
18+
/**
19+
* @var string
20+
*/
21+
private static $type = ExerciseType::CGI;
22+
23+
/**
24+
* @var EventDispatcher
25+
*/
26+
private $eventDispatcher;
27+
28+
/**
29+
* @param EventDispatcher $eventDispatcher
30+
*/
31+
public function __construct(EventDispatcher $eventDispatcher)
32+
{
33+
$this->eventDispatcher = $eventDispatcher;
34+
}
35+
36+
/**
37+
* Whether the factory supports this exercise type.
38+
*
39+
* @param ExerciseInterface $exercise
40+
* @return bool
41+
*/
42+
public function supports(ExerciseInterface $exercise)
43+
{
44+
return $exercise->getType()->getValue() === self::$type;
45+
}
46+
47+
/**
48+
* Add any extra required arguments to the command.
49+
*
50+
* @param CommandDefinition $commandDefinition
51+
*/
52+
public function configureInput(CommandDefinition $commandDefinition)
53+
{
54+
$commandDefinition->addArgument(CommandArgument::required('program'));
55+
}
56+
57+
/**
58+
* Create and return an instance of the runner.
59+
*
60+
* @param ExerciseInterface $exercise
61+
* @return ExerciseRunnerInterface
62+
*/
63+
public function create(ExerciseInterface $exercise)
64+
{
65+
return new CgiRunner($exercise, $this->eventDispatcher);
66+
}
67+
}

‎src/ExerciseRunner/Factory/CliRunnerFactory.php‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<?php
2+
3+
namespace PhpSchool\PhpWorkshop\ExerciseRunner\Factory;
4+
5+
use PhpSchool\PhpWorkshop\CommandArgument;
6+
use PhpSchool\PhpWorkshop\CommandDefinition;
7+
use PhpSchool\PhpWorkshop\Event\EventDispatcher;
8+
use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
9+
use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
10+
use PhpSchool\PhpWorkshop\ExerciseRunner\CliRunner;
11+
use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
12+
13+
/**
14+
* @author Aydin Hassan <aydin@hotmail.co.uk>
15+
*/
16+
class CliRunnerFactory implements ExerciseRunnerFactoryInterface
17+
{
18+
/**
19+
* @var string
20+
*/
21+
private static $type = ExerciseType::CLI;
22+
23+
/**
24+
* @var EventDispatcher
25+
*/
26+
private $eventDispatcher;
27+
28+
/**
29+
* @param EventDispatcher $eventDispatcher
30+
*/
31+
public function __construct(EventDispatcher $eventDispatcher)
32+
{
33+
$this->eventDispatcher = $eventDispatcher;
34+
}
35+
36+
/**
37+
* Whether the factory supports this exercise type.
38+
*
39+
* @param ExerciseInterface $exercise
40+
* @return bool
41+
*/
42+
public function supports(ExerciseInterface $exercise)
43+
{
44+
return $exercise->getType()->getValue() === self::$type;
45+
}
46+
47+
/**
48+
* Add any extra required arguments to the command.
49+
*
50+
* @param CommandDefinition $commandDefinition
51+
*/
52+
public function configureInput(CommandDefinition $commandDefinition)
53+
{
54+
$commandDefinition->addArgument(CommandArgument::required('program'));
55+
}
56+
57+
/**
58+
* Create and return an instance of the runner.
59+
*
60+
* @param ExerciseInterface $exercise
61+
* @return ExerciseRunnerInterface
62+
*/
63+
public function create(ExerciseInterface $exercise)
64+
{
65+
return new CliRunner($exercise, $this->eventDispatcher);
66+
}
67+
}

‎src/ExerciseRunner/Factory/ExerciseRunnerFactoryInterface.php‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?php
2+
3+
namespace PhpSchool\PhpWorkshop\ExerciseRunner\Factory;
4+
5+
use PhpSchool\PhpWorkshop\CommandDefinition;
6+
use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
7+
use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
8+
9+
/**
10+
* @author Aydin Hassan <aydin@hotmail.co.uk>
11+
*/
12+
interface ExerciseRunnerFactoryInterface
13+
{
14+
/**
15+
* Whether the factory supports this exercise type.
16+
*
17+
* @param ExerciseInterface $exercise
18+
* @return bool
19+
*/
20+
public function supports(ExerciseInterface $exercise);
21+
22+
/**
23+
* Add any extra required arguments to the command.
24+
*
25+
* @param CommandDefinition $commandDefinition
26+
*/
27+
public function configureInput(CommandDefinition $commandDefinition);
28+
29+
/**
30+
* Create and return an instance of the runner.
31+
*
32+
* @param ExerciseInterface $exercise
33+
* @return ExerciseRunnerInterface
34+
*/
35+
public function create(ExerciseInterface $exercise);
36+
}

0 commit comments

Comments
 (0)