GenerateCommand.php 9.72 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
use Irstea\PlantUmlBundle\Doctrine\EntityFinder;
14
use Irstea\PlantUmlBundle\Doctrine\FieldDecorator;
15
16
17
use Irstea\PlantUmlBundle\Finder\ClassFinder;
use Irstea\PlantUmlBundle\Finder\FilteringFinder;
use Irstea\PlantUmlBundle\Finder\FinderInterface;
18
use Irstea\PlantUmlBundle\Model\ClassFilterInterface;
19
use Irstea\PlantUmlBundle\Model\ClassVisitor;
20
use Irstea\PlantUmlBundle\Model\Decorator\AttributeDecorator;
21
22
23
use Irstea\PlantUmlBundle\Model\Decorator\CompositeDecorator;
use Irstea\PlantUmlBundle\Model\Decorator\FilteringDecorator;
use Irstea\PlantUmlBundle\Model\Decorator\InheritanceDecorator;
24
use Irstea\PlantUmlBundle\Model\Decorator\InterfaceDecorator;
25
use Irstea\PlantUmlBundle\Model\Decorator\MethodDecorator;
26
use Irstea\PlantUmlBundle\Model\Decorator\NullDecorator;
27
use Irstea\PlantUmlBundle\Model\Decorator\TraitDecorator;
28
29
30
use Irstea\PlantUmlBundle\Model\DecoratorInterface;
use Irstea\PlantUmlBundle\Model\Filter\AcceptAllFilter;
use Irstea\PlantUmlBundle\Model\Filter\Composite\AllFilter;
31
32
use Irstea\PlantUmlBundle\Model\Filter\DirectoryFilter;
use Irstea\PlantUmlBundle\Model\Filter\NamespaceFilter;
33
use Irstea\PlantUmlBundle\Model\Graph;
34
use Irstea\PlantUmlBundle\Model\Namespace_\BundleNamespace;
35
use Irstea\PlantUmlBundle\Model\Namespace_\FlatNamespace;
36
37
use Irstea\PlantUmlBundle\Model\Namespace_\Php\RootNamespace;
use Irstea\PlantUmlBundle\Model\NamespaceInterface;
38
use Irstea\PlantUmlBundle\Writer\OutputWriter;
39
use ReflectionClass;
40
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
41
42
use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Console\Input\InputArgument;
43
44
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
45
46
47
48
49
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;
50

51

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

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

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

74
75
76
    protected function configure()
    {
        $this
77
78
79
80
81
82
83
84
85
86
87
88
89
            ->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');
90
91
92
93
94
95
96
97
98
99
100
    }

    /**
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     *
     * @SuppressWarnings(UnusedFormalParameter)
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
101
102
103
104
105
        $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.");
        }
106

107
        $config = $graphs[$name];
108

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

118
        $graph->visitAll();
119

120
        $writer = new OutputWriter($output);
121
        $graph->writeTo($writer);
122
    }
123
124

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

        $filter = $this->buildFilter($config);
140
141
        if (!$filter) {
            return $finder;
142
143
        }

144
        return new FilteringFinder($finder, $filter);
145
146
147
    }

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

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

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

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

        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;
    }

197
198
199
200
201
202
203
204
205
206
207
208
209
    /**
     * @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();
210
211
212
213
            case 'attributes':
                return new AttributeDecorator();
            case 'methods':
                return new MethodDecorator();
214
215
216
217
            case 'entity':
                return new EntityDecorator($this->entityManager->getMetadataFactory());
            case 'associations':
                return new AssociationDecorator($this->entityManager->getMetadataFactory());
218
219
            case 'fields':
                return new FieldDecorator($this->entityManager->getMetadataFactory());
220
221
            default:
                return NullDecorator::instance();
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
310
311
312
313
314
315
316
317
318
319
320
    /**
     * @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;
    }

}