Total Complexity | 56 |
Total Lines | 342 |
Duplicated Lines | 0 % |
Changes | 3 | ||
Bugs | 2 | Features | 2 |
Complex classes like Render often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Render, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
38 | class Render extends AbstractStep |
||
39 | { |
||
40 | public const TMP_DIR = '.cecil'; |
||
41 | |||
42 | protected $subset = []; |
||
43 | |||
44 | /** |
||
45 | * {@inheritdoc} |
||
46 | */ |
||
47 | public function getName(): string |
||
50 | } |
||
51 | |||
52 | /** |
||
53 | * {@inheritdoc} |
||
54 | */ |
||
55 | public function init(array $options): void |
||
56 | { |
||
57 | if (!is_dir($this->config->getLayoutsPath()) && !$this->config->hasTheme()) { |
||
58 | $message = \sprintf('"%s" is not a valid layouts directory', $this->config->getLayoutsPath()); |
||
59 | $this->builder->getLogger()->debug($message); |
||
60 | } |
||
61 | |||
62 | // render a subset of pages? |
||
63 | if (!empty($options['render-subset'])) { |
||
64 | $subset = \sprintf('pages.subsets.%s', (string) $options['render-subset']); |
||
65 | if (!$this->config->has($subset)) { |
||
66 | throw new ConfigException(\sprintf('Subset "%s" not found.', $subset)); |
||
67 | } |
||
68 | $this->subset = (array) $this->config->get($subset); |
||
69 | } |
||
70 | |||
71 | $this->canProcess = true; |
||
72 | } |
||
73 | |||
74 | /** |
||
75 | * {@inheritdoc} |
||
76 | * |
||
77 | * @throws RuntimeException |
||
78 | */ |
||
79 | public function process(): void |
||
80 | { |
||
81 | // prepares renderer |
||
82 | $this->builder->setRenderer(new Twig($this->builder, $this->getAllLayoutsPaths())); |
||
83 | |||
84 | // adds global variables |
||
85 | $this->addGlobals(); |
||
86 | |||
87 | $subset = $this->subset; |
||
88 | |||
89 | /** @var Collection $pages */ |
||
90 | $pages = $this->builder->getPages() |
||
91 | // published only |
||
92 | ->filter(function (Page $page) { |
||
93 | return (bool) $page->getVariable('published'); |
||
94 | }) |
||
95 | ->filter(function (Page $page) use ($subset) { |
||
96 | if (empty($subset)) { |
||
97 | return true; |
||
98 | } |
||
99 | if ( |
||
100 | !empty($subset['path']) |
||
101 | && !((bool) preg_match('/' . (string) $subset['path'] . '/i', $page->getPath())) |
||
102 | ) { |
||
103 | return false; |
||
104 | } |
||
105 | if (!empty($subset['language'])) { |
||
106 | $language = $page->getVariable('language', $this->config->getLanguageDefault()); |
||
107 | if ($language !== (string) $subset['language']) { |
||
108 | return false; |
||
109 | } |
||
110 | } |
||
111 | return true; |
||
112 | }) |
||
113 | // enrichs some variables |
||
114 | ->map(function (Page $page) { |
||
115 | $formats = $this->getOutputFormats($page); |
||
116 | // output formats |
||
117 | $page->setVariable('output', $formats); |
||
118 | // alternates formats |
||
119 | $page->setVariable('alternates', $this->getAlternates($formats)); |
||
120 | // translations |
||
121 | $page->setVariable('translations', $this->getTranslations($page)); |
||
122 | |||
123 | return $page; |
||
124 | }); |
||
125 | $total = \count($pages); |
||
126 | |||
127 | // renders each page |
||
128 | $count = 0; |
||
129 | $postprocessors = []; |
||
130 | foreach ((array) $this->config->get('output.postprocessors') as $name => $postprocessor) { |
||
131 | try { |
||
132 | if (!class_exists($postprocessor)) { |
||
133 | throw new RuntimeException(\sprintf('Class "%s" not found', $postprocessor)); |
||
134 | } |
||
135 | $postprocessors[] = new $postprocessor($this->builder); |
||
136 | $this->builder->getLogger()->debug(\sprintf('Output post processor "%s" loaded', $name)); |
||
137 | } catch (\Exception $e) { |
||
138 | $this->builder->getLogger()->error(\sprintf('Unable to load output post processor "%s": %s', $name, $e->getMessage())); |
||
139 | } |
||
140 | } |
||
141 | |||
142 | // some cache to avoid multiple calls |
||
143 | $cache = []; |
||
144 | |||
145 | /** @var Page $page */ |
||
146 | foreach ($pages as $page) { |
||
147 | $count++; |
||
148 | $rendered = []; |
||
149 | |||
150 | // l10n |
||
151 | $language = $page->getVariable('language', $this->config->getLanguageDefault()); |
||
152 | if (!isset($cache['locale'][$language])) { |
||
153 | $cache['locale'][$language] = $this->config->getLanguageProperty('locale', $language); |
||
154 | } |
||
155 | $this->builder->getRenderer()->setLocale($cache['locale'][$language]); |
||
156 | |||
157 | // global site variables |
||
158 | if (!isset($cache['site'][$language])) { |
||
159 | $cache['site'][$language] = new Site($this->builder, $language); |
||
160 | } |
||
161 | $this->builder->getRenderer()->addGlobal('site', $cache['site'][$language]); |
||
162 | |||
163 | // global config raw variables |
||
164 | if (!isset($cache['config'][$language])) { |
||
165 | $cache['config'][$language] = new Config($this->builder, $language); |
||
166 | } |
||
167 | $this->builder->getRenderer()->addGlobal('config', $cache['config'][$language]); |
||
168 | |||
169 | // excluded format(s)? |
||
170 | $formats = (array) $page->getVariable('output'); |
||
171 | foreach ($formats as $key => $format) { |
||
172 | if ($exclude = $this->config->getOutputFormatProperty($format, 'exclude')) { |
||
173 | // ie: |
||
174 | // formats: |
||
175 | // atom: |
||
176 | // [...] |
||
177 | // exclude: [paginated] |
||
178 | if (!\is_array($exclude)) { |
||
179 | $exclude = [$exclude]; |
||
180 | } |
||
181 | foreach ($exclude as $variable) { |
||
182 | if ($page->hasVariable($variable)) { |
||
183 | unset($formats[$key]); |
||
184 | } |
||
185 | } |
||
186 | } |
||
187 | } |
||
188 | |||
189 | // specific output format from subset |
||
190 | if (!empty($this->subset['output'])) { |
||
191 | $currentFormats = $formats; |
||
192 | $formats = []; |
||
193 | if (\in_array((string) $this->subset['output'], $currentFormats)) { |
||
194 | $formats = [(string) $this->subset['output']]; |
||
195 | } |
||
196 | } |
||
197 | |||
198 | // renders each output format |
||
199 | foreach ($formats as $format) { |
||
200 | // search for the template |
||
201 | $layout = Layout::finder($page, $format, $this->config); |
||
202 | // renders with Twig |
||
203 | try { |
||
204 | $deprecations = []; |
||
205 | set_error_handler(function ($type, $msg) use (&$deprecations) { |
||
206 | if (E_USER_DEPRECATED === $type) { |
||
207 | $deprecations[] = $msg; |
||
208 | } |
||
209 | }); |
||
210 | $output = $this->builder->getRenderer()->render($layout['file'], ['page' => $page]); |
||
211 | foreach ($deprecations as $value) { |
||
212 | $this->builder->getLogger()->warning($value); |
||
213 | } |
||
214 | foreach ($postprocessors as $postprocessor) { |
||
215 | $output = $postprocessor->process($page, $output, $format); |
||
216 | } |
||
217 | $rendered[$format] = [ |
||
218 | 'output' => $output, |
||
219 | 'template' => [ |
||
220 | 'scope' => $layout['scope'], |
||
221 | 'file' => $layout['file'], |
||
222 | ], |
||
223 | ]; |
||
224 | $page->addRendered($rendered); |
||
225 | } catch (\Twig\Error\Error $e) { |
||
226 | throw new RuntimeException( |
||
227 | \sprintf( |
||
228 | 'Can\'t render template "%s" for page "%s".', |
||
229 | $e->getSourceContext()->getName(), |
||
230 | $page->getFileName() ?? $page->getId() |
||
231 | ), |
||
232 | previous: $e, |
||
233 | file: $e->getSourceContext()->getPath(), |
||
234 | line: $e->getTemplateLine(), |
||
235 | ); |
||
236 | } catch (\Exception $e) { |
||
237 | throw new RuntimeException($e->getMessage(), previous: $e); |
||
238 | } |
||
239 | } |
||
240 | $this->builder->getPages()->replace($page->getId(), $page); |
||
241 | |||
242 | $templates = array_column($rendered, 'template'); |
||
243 | $message = \sprintf( |
||
244 | 'Page "%s" rendered with [%s]', |
||
245 | $page->getId() ?: 'index', |
||
246 | Util\Str::combineArrayToString($templates, 'scope', 'file') |
||
247 | ); |
||
248 | $this->builder->getLogger()->info($message, ['progress' => [$count, $total]]); |
||
249 | } |
||
250 | // profiler |
||
251 | if ($this->builder->isDebug()) { |
||
252 | try { |
||
253 | // HTML |
||
254 | $htmlDumper = new \Twig\Profiler\Dumper\HtmlDumper(); |
||
255 | $profileHtmlFile = Util::joinFile($this->config->getDestinationDir(), self::TMP_DIR, 'twig_profile.html'); |
||
256 | Util\File::getFS()->dumpFile($profileHtmlFile, $htmlDumper->dump($this->builder->getRenderer()->getDebugProfile())); |
||
257 | // TXT |
||
258 | $textDumper = new \Twig\Profiler\Dumper\TextDumper(); |
||
259 | $profileTextFile = Util::joinFile($this->config->getDestinationDir(), self::TMP_DIR, 'twig_profile.txt'); |
||
260 | Util\File::getFS()->dumpFile($profileTextFile, $textDumper->dump($this->builder->getRenderer()->getDebugProfile())); |
||
261 | // log |
||
262 | $this->builder->getLogger()->debug(\sprintf('Twig profile dumped in "%s"', Util::joinFile($this->config->getDestinationDir(), self::TMP_DIR))); |
||
263 | } catch (\Symfony\Component\Filesystem\Exception\IOException $e) { |
||
264 | throw new RuntimeException($e->getMessage()); |
||
265 | } |
||
266 | } |
||
267 | } |
||
268 | |||
269 | /** |
||
270 | * Returns an array of layouts directories. |
||
271 | */ |
||
272 | protected function getAllLayoutsPaths(): array |
||
273 | { |
||
274 | $paths = []; |
||
275 | |||
276 | // layouts/ |
||
277 | if (is_dir($this->config->getLayoutsPath())) { |
||
278 | $paths[] = $this->config->getLayoutsPath(); |
||
279 | } |
||
280 | // <theme>/layouts/ |
||
281 | if ($this->config->hasTheme()) { |
||
282 | foreach ($this->config->getTheme() ?? [] as $theme) { |
||
283 | $paths[] = $this->config->getThemeDirPath($theme); |
||
284 | } |
||
285 | } |
||
286 | // resources/layouts/ |
||
287 | if (is_dir($this->config->getLayoutsInternalPath())) { |
||
288 | $paths[] = $this->config->getLayoutsInternalPath(); |
||
289 | } |
||
290 | |||
291 | return $paths; |
||
292 | } |
||
293 | |||
294 | /** |
||
295 | * Adds global variables. |
||
296 | */ |
||
297 | protected function addGlobals() |
||
298 | { |
||
299 | $this->builder->getRenderer()->addGlobal('cecil', [ |
||
300 | 'url' => \sprintf('https://cecil.app/#%s', Builder::getVersion()), |
||
301 | 'version' => Builder::getVersion(), |
||
302 | 'poweredby' => \sprintf('Cecil v%s', Builder::getVersion()), |
||
303 | ]); |
||
304 | } |
||
305 | |||
306 | /** |
||
307 | * Get available output formats. |
||
308 | * |
||
309 | * @throws RuntimeException |
||
310 | */ |
||
311 | protected function getOutputFormats(Page $page): array |
||
312 | { |
||
313 | // Get page output format(s) if defined. |
||
314 | // ie: |
||
315 | // ```yaml |
||
316 | // output: txt |
||
317 | // ``` |
||
318 | if ($page->getVariable('output')) { |
||
319 | $formats = $page->getVariable('output'); |
||
320 | if (!\is_array($formats)) { |
||
321 | $formats = [$formats]; |
||
322 | } |
||
323 | |||
324 | return $formats; |
||
325 | } |
||
326 | |||
327 | // Get available output formats for the page type. |
||
328 | // ie: |
||
329 | // ```yaml |
||
330 | // page: [html, json] |
||
331 | // ``` |
||
332 | $formats = $this->config->get('output.pagetypeformats.' . $page->getType()); |
||
333 | if (empty($formats)) { |
||
334 | throw new RuntimeException('Configuration key "pagetypeformats" can\'t be empty.'); |
||
335 | } |
||
336 | if (!\is_array($formats)) { |
||
337 | $formats = [$formats]; |
||
338 | } |
||
339 | |||
340 | return array_unique($formats); |
||
341 | } |
||
342 | |||
343 | /** |
||
344 | * Get alternates. |
||
345 | */ |
||
346 | protected function getAlternates(array $formats): array |
||
363 | } |
||
364 | |||
365 | /** |
||
366 | * Returns the collection of translated pages for a given page. |
||
367 | */ |
||
368 | protected function getTranslations(Page $refPage): Collection |
||
380 | } |
||
381 | } |
||
382 |