GenerateCommand.php 9.23 KB
Newer Older
1
2
3
4
5
6
7
8
9
<?php

/*
 * Copyright (C) 2015 IRSTEA
 * All rights reserved.
 */
namespace Irstea\PlantUmlBundle\Command;

use Doctrine\ORM\EntityManagerInterface;
10
use Irstea\PlantUmlBundle\Doctrine\AssociationDecorator;
11
use Irstea\PlantUmlBundle\Doctrine\DoctrineNamespace;
12
use Irstea\PlantUmlBundle\Doctrine\EntityDecorator;
13
14
15
16
use Irstea\PlantUmlBundle\Doctrine\EntityFinder;
use Irstea\PlantUmlBundle\Finder\ClassFinder;
use Irstea\PlantUmlBundle\Finder\FilteringFinder;
use Irstea\PlantUmlBundle\Finder\FinderInterface;
17
use Irstea\PlantUmlBundle\Model\ClassFilterInterface;
18
19
20
21
use Irstea\PlantUmlBundle\Model\ClassVisitor;
use Irstea\PlantUmlBundle\Model\Decorator\CompositeDecorator;
use Irstea\PlantUmlBundle\Model\Decorator\FilteringDecorator;
use Irstea\PlantUmlBundle\Model\Decorator\InheritanceDecorator;
22
use Irstea\PlantUmlBundle\Model\Decorator\InterfaceDecorator;
23
use Irstea\PlantUmlBundle\Model\Decorator\NullDecorator;
24
use Irstea\PlantUmlBundle\Model\Decorator\TraitDecorator;
25
26
27
use Irstea\PlantUmlBundle\Model\DecoratorInterface;
use Irstea\PlantUmlBundle\Model\Filter\AcceptAllFilter;
use Irstea\PlantUmlBundle\Model\Filter\Composite\AllFilter;
28
29
use Irstea\PlantUmlBundle\Model\Filter\DirectoryFilter;
use Irstea\PlantUmlBundle\Model\Filter\NamespaceFilter;
30
use Irstea\PlantUmlBundle\Model\Graph;
31
use Irstea\PlantUmlBundle\Model\Namespace_\BundleNamespace;
32
use Irstea\PlantUmlBundle\Model\Namespace_\FlatNamespace;
33
34
use Irstea\PlantUmlBundle\Model\Namespace_\Php\RootNamespace;
use Irstea\PlantUmlBundle\Model\NamespaceInterface;
35
use Irstea\PlantUmlBundle\Writer\OutputWriter;
36
use ReflectionClass;
37
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
38
39
use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Console\Input\InputArgument;
40
41
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
42
43
44
45
46
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Security\Core\Exception\InvalidArgumentException;
use Symfony\Component\Security\Core\Exception\RuntimeException;
47

48

49
50
51
52
53
/**
 * Description of ImportAffiliationCommand
 *
 * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
 */
54
class GenerateCommand extends ContainerAwareCommand
55
{
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
    /**
     * @var string[]
     */
    private $bundles;

    /**
     * @var KernelInterface
     */
    private $kernel;

    /**
     * @var EntityManagerInterface
     */
    private $entityManager;

71
72
73
    protected function configure()
    {
        $this
74
75
76
77
78
79
80
81
82
83
84
85
86
            ->setName('irstea:plantuml:generate')
            ->setDescription("Génère un graphe en PlantUML.")
            ->addArgument('graph', InputArgument::REQUIRED, 'Nom du graphe à générer');
    }

    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        parent::initialize($input, $output);

        // @todo: DI
        $this->bundles = $this->getContainer()->getParameter('kernel.bundles');
        $this->kernel =  $this->getContainer()->get('kernel');
        $this->entityManager =  $this->getContainer()->get('doctrine.orm.entity_manager');
87
88
89
90
91
92
93
94
95
96
97
    }

    /**
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     *
     * @SuppressWarnings(UnusedFormalParameter)
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
98
99
100
101
102
        $name = $input->getArgument('graph');
        $graphs = $this->getContainer()->getParameter('irstea_plant_uml.graphs');
        if (!isset($graphs[$name])) {
            throw new InvalidArgumentException("Le graphe '$name' n'est pas défini.");
        }
103

104
        $config = $graphs[$name];
105

106
107
108
109
110
111
112
113
        $graph = new Graph(
            new ClassVisitor(
                $this->buildDecorator($config['decoration']),
                $this->buildFilter($config['layout']),
                $this->buildNamespace($config['layout']['namespaces'])
            ),
            $this->buildFinder($config['sources'])
        );
114

115
        $graph->visitAll();
116

117
        $writer = new OutputWriter($output);
118
        $graph->outputTo($writer);
119
    }
120
121

    /**
122
123
     * @param array $config
     * @return FinderInterface
124
     */
125
    protected function buildFinder(array $config)
126
127
128
    {
        switch($config['type']) {
            case 'entities':
129
                $finder = $this->buildEntityFinder($config['entity_manager']);
130
131
                break;
            case 'classes':
132
                $finder = $this->buildClassFinder($config['directories']);
133
134
135
136
                break;
        }

        $filter = $this->buildFilter($config);
137
138
        if (!$filter) {
            return $finder;
139
140
        }

141
        return new FilteringFinder($finder, $filter);
142
143
144
    }

    /**
145
146
     * @param array $directories
     * @return FinderInterface
147
     */
148
    protected function buildClassFinder(array $directories)
149
    {
150
        return new ClassFinder($this->parseDirectories($directories));
151
152
153
    }

    /**
154
155
     * @param string $managerName
     * @return FinderInterface
156
     */
157
    protected function buildEntityFinder($managerName)
158
    {
159
160
161
        return new EntityFinder(
            $this->getContainer()->get('doctrine')->getManager($managerName)
        );
162
163
164
165
166
167
168
169
170
    }

    /**
     * @param array $config
     * @return DecoratorInterface
     * @throws RuntimeException
     */
    protected function buildDecorator(array $config)
    {
171
172
        if (empty($config['decorators'])) {
            return NullDecorator::instance();
173
174
        }

175
176
177
        $decorators = [];
        foreach($config['decorators'] as $type) {
            $decorators[] = $this->buildTypedDecorator($type);
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
        }

        if (count($decorators) === 1) {
            $decorator = $decorators[0];
        } else {
            $decorator = new CompositeDecorator($decorators);
        }

        $filter = $this->buildFilter($config);
        if ($filter) {
            $decorator = new FilteringDecorator($decorator, $filter);
        }

        return $decorator;
    }

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
    /**
     * @param type $type
     * @return DecoratorInterface
     */
    protected function buildTypedDecorator($type)
    {
        switch($type) {
            case 'inheritance':
                return new InheritanceDecorator();
            case 'interfaces':
                return new InterfaceDecorator();
            case 'traits':
                return new TraitDecorator();
            case 'entity':
                return new EntityDecorator($this->entityManager->getMetadataFactory());
            case 'associations':
                return new AssociationDecorator($this->entityManager->getMetadataFactory());
        }
    }

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
    /**
     * @param string $config
     * @return NamespaceInterface
     */
    protected function buildNamespace($config)
    {
        switch($config) {
            case 'php':
                return new RootNamespace();
            case 'flat':
                return new FlatNamespace();
            case 'entities':
                return new DoctrineNamespace($this->entityManager->getConfiguration()->getEntityNamespaces());
            case 'bundles':
                return new BundleNamespace($this->bundles);
        }
    }

    /**
     * @param array $config
     * @return ClassFilterInterface|null
     */
    protected function buildFilter(array $config)
    {
        $filters = array_merge(
            isset($config['include']) ? $this->buildSubFilters($config['include'], false) : [],
            isset($config['exclude']) ? $this->buildSubFilters($config['exclude'], true) : []
        );

        switch(count($filters)) {
            case 0:
                return null;
            case 1:
                return $filters[0];
            default:
                return new AllFilter($filters);
        }
    }

    /**
     * @param array $config
     * @param boolean $notFound
     * @return ClassFilterInterface|null
     */
    protected function buildSubFilters(array $config, $notFound)
    {
        $filters = [];

        if (!empty($config['directories'])) {
            $paths = $this->parseDirectories($config['directories']);
            $filters[] = new DirectoryFilter($paths, $notFound);
        }

        if (!empty($config['namespaces'])) {
            $namespaces = $this->parseNamespaces($config['namespaces']);
            $filters[] = new NamespaceFilter($namespaces, $notFound);
        }

        return $filters;
    }

    /**
     * @param array $paths
     * @return array
     */
    protected function parseDirectories(array $paths)
    {
        $actualPaths = [];
        foreach($paths as $path) {
            if (preg_match('/^@(\w+)(.*)$/', $path, $groups)) {
                $bundle = $this->kernel->getBundle($groups[1]);
                $path = $bundle->getPath() . $groups[2];
            }
            $actualPaths[] = realpath($path);
        }
        return $actualPaths;
    }

    /**
     * @param array $paths
     * @return array
     */
    protected function parseNamespaces(array $namespaces)
    {
        $actualNamespaces = [];
        foreach($namespaces as $namespace) {
            if (preg_match('/^@(\w+)(.*)$/', $namespace, $groups)) {
                $bundle = $this->kernel->getBundle($groups[1]);
                $namespace = $bundle->getNamespace() . $groups[2];
            }
            $actualNamespaces[] = $namespace;
        }
        return $actualNamespaces;
    }

}