CouscousPHP#74 Add a currentFile variable to each file

That variable contains the relative name of the current file. It can be used for example to link to the GitHub source file (to offer editing the documentation).

Because it was getting out of hand, I had to move back all the steps into the main application config. This is much simpler now, even though that means we can't dynamically add modules.

src/Application/config.php

@@ -6,27 +6,39 @@
 
 return [
 
- // Generation steps are added by modules
- 'steps.init' => [
- ],
- 'steps.before' => [
- ],
- 'steps.preprocessing' => [
- ],
- 'steps.postprocessing' => [
- ],
- 'steps.after' => [
- ],
+ 'steps' => [
+ DI\get('Couscous\Module\Config\Step\SetDefaultConfig'),
+ DI\get('Couscous\Module\Config\Step\LoadConfig'),
+ DI\get('Couscous\Module\Config\Step\OverrideBaseUrlForPreview'),
+
+ DI\get('Couscous\Module\Scripts\Step\ExecuteBeforeScripts'),
+
+ DI\get('Couscous\Module\Template\Step\UseDefaultTemplate'),
+ DI\get('Couscous\Module\Template\Step\FetchRemoteTemplate'),
+ DI\get('Couscous\Module\Template\Step\ValidateTemplateDirectory'),
 
- 'steps' => function (ContainerInterface $c) {
- return array_merge(
- $c->get('steps.init'),
- $c->get('steps.before'),
- $c->get('steps.preprocessing'),
- $c->get('steps.postprocessing'),
- $c->get('steps.after')
- );
- },
+ DI\get('Couscous\Module\Bower\Step\RunBowerInstall'),
+
+ DI\get('Couscous\Module\Markdown\Step\LoadMarkdownFiles'),
+ DI\get('Couscous\Module\Template\Step\LoadAssets'),
+ DI\get('Couscous\Module\Core\Step\AddImages'),
+
+ DI\get('Couscous\Module\Core\Step\AddFileNameToMetadata'),
+
+ DI\get('Couscous\Module\Markdown\Step\ParseMarkdownFrontMatter'),
+ DI\get('Couscous\Module\Markdown\Step\ProcessMarkdownFileName'),
+ DI\get('Couscous\Module\Markdown\Step\RewriteMarkdownLinks'),
+ DI\get('Couscous\Module\Markdown\Step\RenderMarkdown'),
+ DI\get('Couscous\Module\Markdown\Step\CreateHeadingIds'),
+
+ DI\get('Couscous\Module\Template\Step\AddPageListToLayoutVariables'),
+ DI\get('Couscous\Module\Template\Step\ProcessTwigLayouts'),
+
+ DI\get('Couscous\Module\Core\Step\ClearTargetDirectory'),
+ DI\get('Couscous\Module\Core\Step\WriteFiles'),
+
+ DI\get('Couscous\Module\Scripts\Step\ExecuteAfterScripts'),
+ ],
 
  'Couscous\Generator' => DI\object()
  ->constructorParameter('steps', DI\get('steps')),

src/Model/File.php

@@ -11,9 +11,15 @@ abstract class File
 {
  public $relativeFilename;
 
+ /**
+ * @var Metadata
+ */
+ private $metadata;
+
  public function __construct($relativeFilename)
  {
  $this->relativeFilename = $relativeFilename;
+ $this->metadata = new Metadata();
  }
 
  /**
@@ -53,5 +59,8 @@ public abstract function getContent();
  *
  * @return Metadata
  */
- public abstract function getMetadata();
+ public function getMetadata()
+ {
+ return $this->metadata;
+ }
 }

src/Model/LazyFile.php

@@ -22,9 +22,4 @@ public function getContent()
  {
  return file_get_contents($this->fullFilename);
  }
-
- public function getMetadata()
- {
- return new Metadata();
- }
 }

src/Module/Core/Step/AddFileNameToMetadata.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Couscous\Module\Core\Step;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+
+/**
+ * Add to the current file name to the metadata.
+ *
+ * @author Matthieu Napoli <[email protected]>
+ */
+class AddFileNameToMetadata implements Step
+{
+ public function __invoke(Project $project)
+ {
+ foreach ($project->getFiles() as $file) {
+ $fileMetadata = $file->getMetadata();
+ $fileMetadata['currentFile'] = $file->relativeFilename;
+ }
+ }
+}

src/Module/Markdown/Model/MarkdownFile.php

@@ -15,26 +15,15 @@ class MarkdownFile extends File
  */
  public $content;
 
- /**
- * @var Metadata
- */
- private $metadata;
-
  public function __construct($relativeFilename, $content)
  {
- parent::__construct($relativeFilename);
-
  $this->content = $content;
- $this->metadata = new Metadata();
+
+ parent::__construct($relativeFilename);
  }
 
  public function getContent()
  {
  return $this->content;
  }
-
- public function getMetadata()
- {
- return $this->metadata;
- }
 }

src/Module/Markdown/config.php

@@ -2,15 +2,6 @@
 
 return [
 
- 'steps.preprocessing' => DI\add([
- DI\get('Couscous\Module\Markdown\Step\LoadMarkdownFiles'),
- DI\get('Couscous\Module\Markdown\Step\ParseMarkdownFrontMatter'),
- DI\get('Couscous\Module\Markdown\Step\ProcessMarkdownFileName'),
- DI\get('Couscous\Module\Markdown\Step\RewriteMarkdownLinks'),
- DI\get('Couscous\Module\Markdown\Step\RenderMarkdown'),
- DI\get('Couscous\Module\Markdown\Step\CreateHeadingIds'),
- ]),
-
  'Mni\FrontYAML\Parser' => DI\object()
  ->constructorParameter('markdownParser', DI\get('Mni\FrontYAML\Markdown\MarkdownParser')),
 

src/Module/Template/Model/HtmlFile.php

@@ -35,6 +35,6 @@ public function getContent()
 
  public function getMetadata()
  {
- return $this->wrappedFile ? $this->wrappedFile->getMetadata() : new Metadata();
+ return $this->wrappedFile ? $this->wrappedFile->getMetadata() : parent::getMetadata();
  }
 }

tests/FunctionalTest/Fixture/current-file/expected/docs/foo.html

@@ -0,0 +1 @@
+docs/foo.md

tests/FunctionalTest/Fixture/current-file/expected/index.html

@@ -0,0 +1 @@
+README.md

tests/FunctionalTest/Fixture/current-file/expected/test.html

@@ -0,0 +1 @@
+test.md

tests/FunctionalTest/Fixture/current-file/source/website/default.twig

@@ -0,0 +1 @@
+{{ currentFile }}

tests/FunctionalTest/GenerationTest.php

@@ -49,4 +49,12 @@ public function testDocumentationImages()
  {
  $this->assertGeneratedWebsite('images');
  }
+
+ /**
+ * Test that the currentFile variable is available.
+ */
+ public function testCurrentFileVariable()
+ {
+ $this->assertGeneratedWebsite('current-file');
+ }
 }

tests/UnitTest/Model/FileTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Couscous\Tests\UnitTest\Model;
+
+use Couscous\Model\File;
+
+/**
+ * @covers \Couscous\Model\File
+ */
+class FileTest extends \PHPUnit_Framework_TestCase
+{
+ /**
+ * @test
+ */
+ public function it_should_have_metadata()
+ {
+ /** @var File $file */
+ $file = $this->getMock('Couscous\Model\File', array('getContent'), array('test.md'));
+
+ $file->getMetadata()['foo'] = 'test';
+ $this->assertEquals('test', $file->getMetadata()['foo']);
+ }
+}

tests/UnitTest/Module/Core/Step/AddFileNameToMetadata.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Couscous\Tests\UnitTest\Module\Template\Step;
+
+use Couscous\Module\Core\Step\AddFileNameToMetadata;
+use Couscous\Module\Template\Model\HtmlFile;
+use Couscous\Tests\UnitTest\Mock\MockProject;
+
+/**
+ * @covers \Couscous\Module\Core\Step\AddFileNameToMetadata
+ */
+class AddFileNameToMetadataTest extends \PHPUnit_Framework_TestCase
+{
+ /**
+ * @test
+ */
+ public function it_should_add_the_metadata_variable()
+ {
+ $project = new MockProject();
+ $project->addFile(new HtmlFile('foo/bar/index.html', ''));
+
+ $step = new AddFileNameToMetadata();
+ $step->__invoke($project);
+
+ $files = $project->getFiles();
+ $file = $files[0];
+
+ $this->assertEquals('foo/bar/index.html', $file->getMetadata()['currentFile']);
+ }
+}