BUPH-146 | add support for source override behavior

src/V1/Actor/Writer.php

@@ -1,33 +1,50 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Neighborhoods\Buphalo\V1\Actor;
 
 use LogicException;
 use Neighborhoods\Buphalo\V1\Actor;
 use Symfony\Component\Filesystem\Filesystem;
+
 use function dirname;
 
 class Writer implements WriterInterface
 {
     use Actor\Template\Compiler\AwareTrait;
 
-    protected $filesystem;
+    private $filesystem;
+
+    private $source_override_behavior;
 
     public function write(): WriterInterface
     {
         $actor = $this->getActorTemplateCompiler()->getActorTemplateTokenizer()->getActor();
-        if (!is_file($actor->getSourceFilePath())) {
-            $fabricationFilePath = $actor->getFabricationFilePath();
-            $this->getFilesystem()->mkdir(dirname($fabricationFilePath));
-            if (is_file($fabricationFilePath)) {
-                $message = sprintf('Actor with fabrication file path [%s] already exists.', $fabricationFilePath);
-                throw new LogicException($message);
+        if (is_file($actor->getSourceFilePath())) {
+            switch ($this->getSourceOverrideBehavior()) {
+                case WriterInterface::SOURCE_OVERRIDE_BEHAVIOR_SKIP:
+                    return $this;
+                case WriterInterface::SOURCE_OVERRIDE_BEHAVIOR_THROW:
+                    throw new \RuntimeException(sprintf('File `%s` already exists.', $actor->getSourceFilePath()));
+                case WriterInterface::SOURCE_OVERRIDE_BEHAVIOR_WRITE:
+                    break; // continue on
+                default:
+                    throw new \LogicException(
+                        sprintf('Invalid Source-Override Behavior: `%s`', $this->getSourceOverrideBehavior())
+                    );
             }
-            $compiledContents = $this->getActorTemplateCompiler()->getCompiledContents();
-            file_put_contents($fabricationFilePath, $compiledContents);
         }
 
+        $fabricationFilePath = $actor->getFabricationFilePath();
+        $this->getFilesystem()->mkdir(dirname($fabricationFilePath));
+        if (is_file($fabricationFilePath)) {
+            $message = sprintf('Actor with fabrication file path [%s] already exists.', $fabricationFilePath);
+            throw new LogicException($message);
+        }
+        $compiledContents = $this->getActorTemplateCompiler()->getCompiledContents();
+        file_put_contents($fabricationFilePath, $compiledContents);
+
         return $this;
     }
 
@@ -51,4 +68,24 @@ public function setFilesystem(Filesystem $filesystem): WriterInterface
 
         return $this;
     }
+
+    public function setSourceOverrideBehavior($source_override_behavior): WriterInterface
+    {
+        if ($this->source_override_behavior !== null) {
+            throw new LogicException('Writer source_override_behavior is already set.');
+        }
+
+        $this->source_override_behavior = $source_override_behavior;
+
+        return $this;
+    }
+
+    private function getSourceOverrideBehavior()
+    {
+        if ($this->source_override_behavior === null) {
+            throw new \LogicException('Writer source_override_behavior has not been set.');
+        }
+
+        return $this->source_override_behavior;
+    }
 }

src/V1/Actor/Writer.service.yml

@@ -1,7 +1,11 @@
+parameters:
+  env(Neighborhoods_Buphalo_V1_Actor_WriterInterface__SourceOverrideBehavior): !php/const \Neighborhoods\Buphalo\V1\Actor\WriterInterface::SOURCE_OVERRIDE_BEHAVIOR_DEFAULT
+  Neighborhoods\Buphalo\V1\Actor\WriterInterface.SourceOverrideBehavior: '%env(Neighborhoods_Buphalo_V1_Actor_WriterInterface__SourceOverrideBehavior)%'
 services:
   Neighborhoods\Buphalo\V1\Actor\WriterInterface:
     class: Neighborhoods\Buphalo\V1\Actor\Writer
     public: false
     shared: false
     calls:
       - [setFilesystem, ['@Symfony\Component\Filesystem\Filesystem']]
+      - [setSourceOverrideBehavior, ['%Neighborhoods\Buphalo\V1\Actor\WriterInterface.SourceOverrideBehavior%']]

src/V1/Actor/WriterInterface.php

@@ -7,6 +7,12 @@
 
 interface WriterInterface
 {
+    public const SOURCE_OVERRIDE_BEHAVIOR_SKIP = 'skip';
+    public const SOURCE_OVERRIDE_BEHAVIOR_WRITE = 'write';
+    public const SOURCE_OVERRIDE_BEHAVIOR_THROW = 'throw';
+
+    public const SOURCE_OVERRIDE_BEHAVIOR_DEFAULT = self::SOURCE_OVERRIDE_BEHAVIOR_SKIP;
+
     public function setActorTemplateCompiler(CompilerInterface $Compiler);
 
     public function write(): WriterInterface;

tests/v1/SourceOverrideBehaviorDefault/.gitignore

@@ -0,0 +1 @@
+fab/*

tests/v1/SourceOverrideBehaviorDefault/control/SourceOverrideBehaviorInterface.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTest;
+
+interface SourceOverrideBehaviorInterface
+{
+}

tests/v1/SourceOverrideBehaviorDefault/run_test

@@ -0,0 +1,37 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+error_reporting(E_ALL);
+
+$PWD = __DIR__;
+
+// Must load autoloader before including any Annotation Processors
+if (file_exists($autoloaderFilePath = dirname($PWD, 5) . '/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} elseif (file_exists($autoloaderFilePath = dirname($PWD, 3) . '/vendor/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} else {
+    throw new RuntimeException('Unable to find the Composer autoloader.');
+}
+
+// Include Annotation Processors for Buphalo
+// None for this test
+
+// Add exec envs
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__SourceDirectoryPath=$PWD/src");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__FabricationDirectoryPath=$PWD/fab");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__NamespacePrefix=Neighborhoods\\BuphaloTest");
+putenv("Neighborhoods_Buphalo_V1_TemplateTree_Map_Builder_FactoryInterface__TemplateTreeDirectoryPaths=$PWD/templates");
+
+// Include Buphalo
+require_once($PWD . '/../../../bin/v1/buphalo.php');
+
+// Diff the two directories
+exec("diff -r $PWD/control/ $PWD/fab/", $output, $return);
+
+if ($return) {
+    echo(implode(PHP_EOL, $output) . PHP_EOL);
+    die(1);
+}

tests/v1/SourceOverrideBehaviorDefault/src/SourceOverrideBehavior.buphalo.v1.fabrication.yml

@@ -0,0 +1,5 @@
+actors:
+  <PrimaryActorName>.php:
+    template: PrimaryActorName.php
+  <PrimaryActorName>Interface.php:
+    template: PrimaryActorNameInterface.php

tests/v1/SourceOverrideBehaviorDefault/src/SourceOverrideBehavior.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTest;
+
+class SourceOverrideBehavior
+{
+}

tests/v1/SourceOverrideBehaviorDefault/templates/PrimaryActorName.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTemplateTree;
+
+class PrimaryActorName
+{
+}

tests/v1/SourceOverrideBehaviorDefault/templates/PrimaryActorNameInterface.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTemplateTree;
+
+interface PrimaryActorNameInterface
+{
+}

tests/v1/SourceOverrideBehaviorInvalid/.gitignore

@@ -0,0 +1 @@
+fab/*

tests/v1/SourceOverrideBehaviorInvalid/run_test

@@ -0,0 +1,37 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+error_reporting(E_ALL);
+
+$PWD = __DIR__;
+
+// Must load autoloader before including any Annotation Processors
+if (file_exists($autoloaderFilePath = dirname($PWD, 5) . '/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} elseif (file_exists($autoloaderFilePath = dirname($PWD, 3) . '/vendor/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} else {
+    throw new RuntimeException('Unable to find the Composer autoloader.');
+}
+
+// Include Annotation Processors for Buphalo
+// None for this test
+
+// Add exec envs
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__SourceDirectoryPath=$PWD/src");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__FabricationDirectoryPath=$PWD/fab");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__NamespacePrefix=Neighborhoods\\BuphaloTest");
+putenv("Neighborhoods_Buphalo_V1_TemplateTree_Map_Builder_FactoryInterface__TemplateTreeDirectoryPaths=$PWD/templates");
+putenv("Neighborhoods_Buphalo_V1_Actor_WriterInterface__SourceOverrideBehavior=invalid");
+
+// Include Buphalo
+try {
+    require_once($PWD . '/../../../bin/v1/buphalo.php');
+} catch (LogicException $e) {
+    exit;
+}
+
+echo "Failed to catch Logic Exception" . PHP_EOL;
+die(1);

tests/v1/SourceOverrideBehaviorInvalid/src/SourceOverrideBehavior.buphalo.v1.fabrication.yml

@@ -0,0 +1,3 @@
+actors:
+  <PrimaryActorName>.php:
+    template: PrimaryActorName.php

tests/v1/SourceOverrideBehaviorInvalid/src/SourceOverrideBehavior.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTest;
+
+class SourceOverrideBehavior
+{
+}

tests/v1/SourceOverrideBehaviorInvalid/templates/PrimaryActorName.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTemplateTree;
+
+class PrimaryActorName
+{
+}

tests/v1/SourceOverrideBehaviorSkip/.gitignore

@@ -0,0 +1 @@
+fab/*

tests/v1/SourceOverrideBehaviorSkip/control/SourceOverrideBehaviorInterface.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTest;
+
+interface SourceOverrideBehaviorInterface
+{
+}

tests/v1/SourceOverrideBehaviorSkip/run_test

@@ -0,0 +1,39 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+error_reporting(E_ALL);
+
+$PWD = __DIR__;
+
+// Must load autoloader before including any Annotation Processors
+if (file_exists($autoloaderFilePath = dirname($PWD, 5) . '/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} elseif (file_exists($autoloaderFilePath = dirname($PWD, 3) . '/vendor/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} else {
+    throw new RuntimeException('Unable to find the Composer autoloader.');
+}
+
+// Include Annotation Processors for Buphalo
+// None for this test
+
+// Add exec envs
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__SourceDirectoryPath=$PWD/src");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__FabricationDirectoryPath=$PWD/fab");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__NamespacePrefix=Neighborhoods\\BuphaloTest");
+putenv("Neighborhoods_Buphalo_V1_TemplateTree_Map_Builder_FactoryInterface__TemplateTreeDirectoryPaths=$PWD/templates");
+putenv("Neighborhoods_Buphalo_V1_Actor_WriterInterface__SourceOverrideBehavior=skip");
+
+
+// Include Buphalo
+require_once($PWD . '/../../../bin/v1/buphalo.php');
+
+// Diff the two directories
+exec("diff -r $PWD/control/ $PWD/fab/", $output, $return);
+
+if ($return) {
+    echo(implode(PHP_EOL, $output) . PHP_EOL);
+    die(1);
+}

tests/v1/SourceOverrideBehaviorSkip/src/SourceOverrideBehavior.buphalo.v1.fabrication.yml

@@ -0,0 +1,5 @@
+actors:
+  <PrimaryActorName>.php:
+    template: PrimaryActorName.php
+  <PrimaryActorName>Interface.php:
+    template: PrimaryActorNameInterface.php

tests/v1/SourceOverrideBehaviorSkip/src/SourceOverrideBehavior.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTest;
+
+class SourceOverrideBehavior
+{
+}

tests/v1/SourceOverrideBehaviorSkip/templates/PrimaryActorName.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTemplateTree;
+
+class PrimaryActorName
+{
+}

tests/v1/SourceOverrideBehaviorSkip/templates/PrimaryActorNameInterface.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTemplateTree;
+
+interface PrimaryActorNameInterface
+{
+}

tests/v1/SourceOverrideBehaviorThrow/.gitignore

@@ -0,0 +1 @@
+fab/*

tests/v1/SourceOverrideBehaviorThrow/control/SourceOverrideBehaviorInterface.php

@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Neighborhoods\BuphaloTest;
+
+interface SourceOverrideBehaviorInterface
+{
+}

tests/v1/SourceOverrideBehaviorThrow/run_test

@@ -0,0 +1,37 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+error_reporting(E_ALL);
+
+$PWD = __DIR__;
+
+// Must load autoloader before including any Annotation Processors
+if (file_exists($autoloaderFilePath = dirname($PWD, 5) . '/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} elseif (file_exists($autoloaderFilePath = dirname($PWD, 3) . '/vendor/autoload.php')) {
+    /** @noinspection PhpIncludeInspection */
+    require_once $autoloaderFilePath;
+} else {
+    throw new RuntimeException('Unable to find the Composer autoloader.');
+}
+
+// Include Annotation Processors for Buphalo
+// None for this test
+
+// Add exec envs
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__SourceDirectoryPath=$PWD/src");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__FabricationDirectoryPath=$PWD/fab");
+putenv("Neighborhoods_Buphalo_V1_TargetApplication_BuilderInterface__NamespacePrefix=Neighborhoods\\BuphaloTest");
+putenv("Neighborhoods_Buphalo_V1_TemplateTree_Map_Builder_FactoryInterface__TemplateTreeDirectoryPaths=$PWD/templates");
+putenv("Neighborhoods_Buphalo_V1_Actor_WriterInterface__SourceOverrideBehavior=throw");
+
+// Include Buphalo
+try {
+    require_once($PWD . '/../../../bin/v1/buphalo.php');
+} catch (RuntimeException $e) {
+    exit;
+}
+
+echo "Failed to catch Logic Exception" . PHP_EOL;
+die(1);

tests/v1/SourceOverrideBehaviorThrow/src/SourceOverrideBehavior.buphalo.v1.fabrication.yml

@@ -0,0 +1,5 @@
+actors:
+  <PrimaryActorName>.php:
+    template: PrimaryActorName.php
+  <PrimaryActorName>Interface.php:
+    template: PrimaryActorNameInterface.php